+++ /dev/null
-# Friendica Installation
-
-We've tried very hard to ensure that Friendica will run on commodity hosting
-platforms - such as those used to host Wordpress blogs and Drupal websites.
-But be aware that Friendica is more than a simple web application. It is a
-complex communications system which more closely resembles an email server than
-a web server. For reliability and performance, messages are delivered in the
-background and are queued for later delivery when sites are down. This kind of
-functionality requires a bit more of the host system than the typical blog.
-Not every PHP/MySQL hosting provider will be able to support Friendica. Many will.
-But please review the requirements and confirm these with your hosting provider
-prior to installation.
-
-Before you begin: Choose a domain name or subdomain name for your server.
-Put some thought into this - because changing it is currently not-supported.
-Things will break, and some of your friends may have difficulty communicating with you.
-We plan to address this limitation in a future release. Also decide if you wish
-to connect with members of the Diaspora network, as this will impact the
-installation requirements.
-
-Decide if you will use SSL and obtain an SSL cert. Communications with the
-Diaspora network MAY require both SSL AND an SSL cert signed by a CA which is
-recognized by major browsers. Friendica will work with self-signed certs but
-Diaspora communication may not. For best results, install your cert PRIOR to
-installing Friendica and when visiting your site for the initial installation in
-step 5, please use the https: link. (Use the http: or non-SSL link if your cert
-is self-signed).
-
-## 1. Requirements
-
-- Apache with mod-rewrite enabled and "Options All" so you can use a local .htaccess file
-- PHP 7+ (PHP 7.1+ recommended for performance and official support).
- - PHP *command line* with `register_argc_argv = true` in php.ini
- - curl, gd (with at least jpeg support), mysql, mbstring, xml, zip and openssl extensions
- - Some form of email server or email gateway such that PHP mail() works
- - The POSIX module of PHP needs to be activated (e.g. RHEL, CentOS have disabled it)
- - Composer for a Git install
-
-- Mysql 5.6+ or an equivalent alternative for MySQL (MariaDB 10.0.5+, Percona Server etc.)
-- Ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks (Windows)
-- Installation into a top-level domain or sub-domain (without a directory/path
- component in the URL) is preferred. This is REQUIRED if you wish to communicate
- with the Diaspora network.
-- For alternative server configurations (such as Nginx server and MariaDB database
- engine), refer to the [Friendica wiki](https://github.com/friendica/friendica/wiki).
-
-This guide will walk you through the manual installation process of Friendica.
-If this is nothing for you, you might be interested in:
-* the Friendica Docker image (https://github.com/friendica/docker) or
-* how install Friendica with YunoHost (https://github.com/YunoHost-Apps/friendica_ynh).
-
-## 2. Install Friendica sources
-
-Unpack the Friendica files into the root of your web server document area.
-
-If you copy the directory tree to your webserver, make sure that you also copy
-`.htaccess-dist` - as "dot" files are often hidden and aren't normally copied.
-
-OR
-
-Clone the friendica/friendica GitHub repository and import dependencies
-
- git clone https://github.com/friendica/friendica -b master [web server folder]
- cd [web server folder]
- bin/composer.phar install --no-dev
-
-Make sure the folder view/smarty3 exists and is writable by the webserver user,
-in this case `www-data`
-
- mkdir view/smarty3
- chown www-data:www-data view/smarty3
- chmod 775 view/smarty3
-
-Get the addons by going into your website folder.
-
- cd mywebsite
-
-Clone the addon repository (separately):
-
- git clone https://github.com/friendica/friendica-addons.git -b master addon
-
-If you want to use the development version of Friendica you can switch to the
-develop branch in the repository by running
-
- git checkout develop
- bin/composer.phar install
- cd addon
- git checkout develop
-
-Please be aware that the develop branch is unstable.
-Exercise caution when pulling.
-If you encounter a bug, please let us know.
-
-Either way, if you use Apache, copy `.htaccess-dist` to `.htaccess` to enable
-URL rewriting.
-
-## 3. Database
-
-Create an empty database and note the access details (hostname, username, password,
-database name).
-
-- Friendica needs the permission to create and delete fields and tables in its
- own database.
-- Please check the additional notes if running on MySQ 5.7.17 or newer
-
-## 4. Config
-
-If you know in advance that it will be impossible for the web server to write or
-create files in the `config/` directory, please create an empty file called
-`local.config.php` in it and make it writable by the web server.
-
-## 5a. Install Wizard
-
-Visit your website with a web browser and follow the instructions.
-Please note any error messages and correct these before continuing.
-
-If you are using SSL with a known signature authority (recommended), use the
-https: link to your website. If you are using a self-signed cert or no cert,
-use the http: link.
-
-If you need to specify a port for the connection to the database, you can do so
-in the host name setting for the database.
-
-## 5b. Manual install
-
-*If* the automated installation fails for any reason, please check the following:
-
-- `config/local.config.php` exists
- - If not, copy `config/local-sample.config.php` to `config/local.config.php`
- and edit it with your settings.
-- Database is populated.
- - If not, import the contents of `database.sql` with phpMyAdmin or the mysql
- command line tool.
-
-## 6. Register the admin account
-
-At this point visit your website again, and register your personal account with
-the same email as in the `config.admin_email` config value.
-Registration errors should all be recoverable automatically.
-
-If you get any *critical* failure at this point, it generally indicates the
-database was not installed correctly. You might wish to delete/rename
-`config/local.config.php` to another name and drop all the database tables so
-that you can start fresh.
-
-## 7. Background tasks (IMPORTANT)
-
-Set up a cron job or scheduled task to run the worker once every 5-10 minutes to
-pick up the recent "public" postings of your friends. Example:
-
- cd /base/directory; /path/to/php bin/worker.php
-
-Change "/base/directory", and "/path/to/php" as appropriate for your situation.
-
-If you are using a Linux server, run "crontab -e" and add a line like the one
-shown, substituting for your unique paths and settings:
-
- */10 * * * * cd /home/myname/mywebsite; /usr/bin/php bin/worker.php
-
-You can generally find the location of PHP by executing "which php".
-If you have troubles with this section please contact your hosting provider for assistance.
-Friendica will not work correctly if you cannot perform this step.
-
-You should also be sure that `config.php_path` is set correctly, it should look
-like this: (changing it to the correct PHP location)
-
- 'config' => [
- 'php_path' => '/usr/local/php56/bin/php',
- ]
-
-Alternative: If you cannot use a cron job as described above, you can use the
-frontend worker and an external cron service to trigger the execution of the worker script.
-You can enable the frontend worker after the installation from the admin panel
-of your node and call:
-
- https://example.com/worker
-
-with the service of your choice.
-
-## 8. (Recommended) Set up a backup plan
-
-Bad things will happen.
-Let there be a hardware failure, a corrupted database or whatever you can think of.
-So once the installation of your Friendica node is done, you should make yourself
-a backup plan.
-
-The most important file is the `config/local.config.php` file in the base directory.
-As it stores all your data, you should also have a recent dump of your Friendica
-database at hand, should you have to recover your node.
-
-## 9. (Optional) Reverse-proxying and HTTPS
-
-Friendica looks for some well-known HTTP headers indicating a reverse-proxy
-terminating an HTTPS connection.
-While the standard from RFC 7239 specifies the use of the `Forwaded` header.
-
- Forwarded: for=192.0.2.1; proto=https; by=192.0.2.2
-
-Friendica also supports a number on non-standard headers in common use.
-
- X-Forwarded-Proto: https
-
- Front-End-Https: on
-
- X-Forwarded-Ssl: on
-
-It is however preferable to use the standard approach if configuring a new server.
-
-## Troubleshooting
-
-### "System is currently unavailable. Please try again later"
-
-Check your database settings.
-It usually means your database could not be opened or accessed.
-If the database resides on the same machine, check that the database server name
-is "localhost".
-
-### 500 Internal Error
-
-This could be the result of one of our Apache directives not being supported by
-your version of Apache. Examine your apache server logs.
-You might remove the line "Options -Indexes" from the .htaccess file if you are
-using a Windows server as this has been known to cause problems.
-Also check your file permissions. Your website and all contents must generally
-be world-readable.
-
-It is likely that your web server reported the source of the problem in its error log files.
-Please review these system error logs to determine what caused the problem.
-Often this will need to be resolved with your hosting provider or (if self-hosted)
-your web server configuration.
-
-### 400 and 4xx "File not found" errors
-
-First check your file permissions.
-Your website and all contents must generally be world-readable.
-
-Ensure that mod-rewite is installed and working, and that your `.htaccess` file
-is being used. To verify the latter, create a file `test.out` containing the
-word "test" in the top directory of Friendica, make it world readable and point
-your web browser to
-
- http://yoursitenamehere.com/test.out
-
-This file should be blocked. You should get a permission denied message.
-
-If you see the word "test" your Apache configuration is not allowing your
-`.htaccess` file to be used (there are rules in this file to block access to any
-file with .out at the end, as these are typically used for system logs).
-
-Make certain the `.htaccess` file exists and is readable by everybody, then look
-for the existence of "AllowOverride None" in the Apache server configuration for your site.
-This will need to be changed to "AllowOverride All".
-
-If you do not see the word "test", your `.htaccess` is working, but it is likely
-that mod-rewrite is not installed in your web server or is not working.
-
-On most Linux flavors:
-
- % a2enmod rewrite
- % /etc/init.d/apache2 restart
-
-Consult your hosting provider, experts on your particular Linux distribution or
-(if Windows) the provider of your Apache server software if you need to change
-either of these and can not figure out how. There is a lot of help available on
-the web. Search "mod-rewrite" along with the name of your operating system
-distribution or Apache package (if using Windows).
-
-### Unable to write the file config/local.config.php due to permissions issues
-
-Create an empty `config/local.config.php`file with that name and give it
-world-write permission.
-
-On Linux:
-
- % touch config/local.config.php
- % chmod 664 config/local.config.php
-
-Retry the installation. As soon as the database has been created,
-
-******* this is important *********
-
- % chmod 644 config/local.config.php
-
-### Suhosin issues
-
-Some configurations with "suhosin" security are configured without an ability to
-run external processes. Friendica requires this ability. Following are some notes
-provided by one of our members.
-
-> On my server I use the php protection system Suhosin [http://www.hardened-php.net/suhosin/].
-> One of the things it does is to block certain functions like proc_open, as
-> configured in `/etc/php5/conf.d/suhosin.ini`:
->
-> suhosin.executor.func.blacklist = proc_open, ...
->
-> For those sites like Friendica that really need these functions they can be
-> enabled, e.g. in `/etc/apache2/sites-available/friendica`:
->
-> <Directory /var/www/friendica/>
-> php_admin_value suhosin.executor.func.blacklist none
-> php_admin_value suhosin.executor.eval.blacklist none
-> </Directory>
->
-> This enables every function for Friendica if accessed via browser, but not for
-> the cronjob that is called via php command line. I attempted to enable it for
-> cron by using something like:
->
-> */10 * * * * cd /var/www/friendica/friendica/ && sudo -u www-data /usr/bin/php \
-> -d suhosin.executor.func.blacklist=none \
-> -d suhosin.executor.eval.blacklist=none -f bin/worker.php
->
-> This worked well for simple test cases, but the friendica-cron still failed
-> with a fatal error:
->
-> suhosin[22962]: ALERT - function within blacklist called: proc_open()
-> (attacker 'REMOTE_ADDR not set', file '/var/www/friendica/friendica/boot.php',
-> line 1341)
->
-> After a while I noticed, that `bin/worker.php` calls further PHP script via `proc_open`.
-> These scripts themselves also use `proc_open` and fail, because they are NOT
-> called with `-d suhosin.executor.func.blacklist=none`.
->
-> So the simple solution is to put the correct parameters into `config/local.config.php`:
->
-> 'config' => [
-> //Location of PHP command line processor
-> 'php_path' => '/usr/bin/php -d suhosin.executor.func.blacklist=none \
-> -d suhosin.executor.eval.blacklist=none',
-> ],
->
-> This is obvious as soon as you notice that the friendica-cron uses `proc_open`
-> to execute PHP scripts that also use `proc_open`, but it took me quite some time to find that out.
-> I hope this saves some time for other people using suhosin with function blacklists.
-
-### Unable to create all mysql tables on MySQL 5.7.17 or newer
-
-If the setup fails to create all the database tables and/or manual creation from
-the command line fails, with this error:
-
- ERROR 1067 (42000) at line XX: Invalid default value for 'created'
-
-You need to adjust your my.cnf and add the following setting under the [mysqld]
-section:
-
- sql_mode = '';
-
-After that, restart mysql and try again.
Join today and [get your Friendica profile!](https://dir.friendica.social/servers 'Join Friendica today!')
+Have a look at the [installation documentation](doc/Install.md) for further information about installing and using Friendica.
### Friendica Screenshots
-Friendica Installation
-===============
+# Friendica Installation
+
We've tried very hard to ensure that Friendica will run on commodity hosting platforms - such as those used to host Wordpress blogs and Drupal websites.
We offer a manual and an automatic installation.
But be aware that Friendica is more than a simple web application.
+
It is a complex communications system which more closely resembles an email server than a web server.
For reliability and performance, messages are delivered in the background and are queued for later delivery when sites are down.
This kind of functionality requires a bit more of the host system than the typical blog.
+
Not every PHP/MySQL hosting provider will be able to support Friendica.
Many will.
-But **please** review the requirements and confirm these with your hosting provider prior to installation.
-Also if you encounter installation issues, please let us know via the [helper](http://forum.friendi.ca/profile/helpers) or the [developer](https://forum.friendi.ca/profile/developers) forum or [file an issue](https://github.com/friendica/friendica/issues).
+But **please** review the [requirements](#1_2_1) and confirm these with your hosting provider prior to installation.
+
+## Support
+If you encounter installation issues, please let us know via the [helper](http://forum.friendi.ca/profile/helpers) or the [developer](https://forum.friendi.ca/profile/developers) forum or [file an issue](https://github.com/friendica/friendica/issues).
+
Please be as clear as you can about your operating environment and provide as much detail as possible about any error messages you may see, so that we can prevent it from happening in the future.
Due to the large variety of operating systems and PHP platforms in existence we may have only limited ability to debug your PHP installation or acquire any missing modules - but we will do our best to solve any general code issues.
+
If you do not have a Friendica account yet, you can register a temporary one at [tryfriendica.de](https://tryfriendica.de) and join the forums mentioned above from there.
The account will expire after 7 days, but you can ask the server admin to keep your account longer, should the problem not be resolved after that.
-Before you begin: Choose a domain name or subdomain name for your server.
-Put some thought into this.
-While changing it after installation is supported, things still might break.
+## Prerequisites
-Requirements
----
+* Choose a domain name or subdomain name for your server. Put some thought into this. While changing it after installation is supported, things still might break.
+* Setup HTTPS on your domain.
+
+### Requirements
* Apache with mod-rewrite enabled and "Options All" so you can use a local .htaccess file
* PHP 7+ (PHP 7.1+ is recommended for performance and official support)
* Curl, GD, PDO, MySQLi, hash, xml, zip and OpenSSL extensions
* The POSIX module of PHP needs to be activated (e.g. [RHEL, CentOS](http://www.bigsoft.co.uk/blog/index.php/2014/12/08/posix-php-commands-not-working-under-centos-7) have disabled it)
* some form of email server or email gateway such that PHP mail() works
-* Mysql 5.6+ or an equivalent alternative for MySQL (MariaDB, Percona Server etc.)
-* the ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks (Windows) (Note: other options are presented in Section 7 of this document.)
-* Installation into a top-level domain or sub-domain (without a directory/path component in the URL) is preferred. Directory paths will not be as convenient to use and have not been thoroughly tested.
-* If your hosting provider doesn't allow Unix shell access, you might have trouble getting everything to work.
+* MySQL 5.6+ or an equivalent alternative for MySQL (MariaDB, Percona Server etc.)
+* ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks (Windows)
+* installation into a top-level domain or sub-domain (without a directory/path component in the URL) is RECOMMENDED. Directory paths will not be as convenient to use and have not been thoroughly tested. This is REQUIRED if you wish to communicate with the Diaspora network.
+
+**If your hosting provider doesn't allow Unix shell access, you might have trouble getting everything to work.**
-Optional
----
+For alternative server configurations (such as Nginx server and MariaDB database engine), refer to the [Friendica wiki](https://github.com/friendica/friendica/wiki).
+
+### Optional
* PHP ImageMagick extension (php-imagick) for animated GIF support.
+* [Composer](https://getcomposer.org/) for a git install
-Installation procedure
----
+## Installation procedure
### Alternative Installation Methods
If this is nothing for you, you might be interested in
* the [Friendica Docker image](https://github.com/friendica/docker) or
-* how [install Friendica with YunoHost](https://github.com/YunoHost-Apps/friendica_ynh).
+* how to [install Friendica with YunoHost](https://github.com/YunoHost-Apps/friendica_ynh).
### Get Friendica
Unpack the Friendica files into the root of your web server document area.
-If you are able to do so, we recommend using git to clone the source repository rather than to use a packaged tar or zip file.
+
+If you copy the directory tree to your webserver, make sure that you also copy
+`.htaccess-dist` - as "dot" files are often hidden and aren't normally copied.
+
+**OR**
+
+Clone the [friendica/friendica GitHub repository](https://github.com/friendica/friendica) and import dependencies.
This makes the software much easier to update.
+
The Linux commands to clone the repository into a directory "mywebsite" would be
git clone https://github.com/friendica/friendica.git -b master mywebsite
cd mywebsite
bin/composer.phar install --no-dev
-Make sure the folder *view/smarty3* exists and is writable by the webserver user, in this case `www-data`
+Make sure the folder *view/smarty3* exists and is writable by the webserver user, in this case *www-data*
mkdir view/smarty3
chown www-data:www-data view/smarty3
git clone https://github.com/friendica/friendica-addons.git -b master addon
-If you copy the directory tree to your webserver, make sure that you also copy .htaccess - as "dot" files are often hidden and aren't normally copied.
-
If you want to use the development version of Friendica you can switch to the develop branch in the repository by running
git checkout develop
cd addon
git checkout develop
-please be aware that the develop branch may break your Friendica node at any time.
+**Be aware that the develop branch is unstable and may break your Friendica node at any time.**
+You should have a recent backup before updating.
If you encounter a bug, please let us know.
### Create a database
Friendica needs the permission to create and delete fields and tables in its own database.
-With newer releases of MySQL (5.7.17 or newer), you might need to set the sql_mode to '' (blank).
-Use this setting when the installer is unable to create all the needed tables due to a timestamp format problem.
-In this case find the [mysqld] section in your my.cnf file and add the line :
-
- sql_mode = ''
-
-Restart mysql and you should be fine.
+Please check the [troubleshooting](#1_6) section if running on MySQ 5.7.17 or newer.
-### Option A: Run the manual installer
+### Option A: Run the installer
Point your web browser to the new site and follow the instructions.
Please note any error messages and correct these before continuing.
*If* the manual installation fails for any reason, check the following:
-* Does "config/local.config.php" exist? If not, edit config/local-sample.config.php and change the system settings.
+* Does `config/local.config.php` exist? If not, edit `config/local-sample.config.php` and change the system settings.
* Rename to `config/local.config.php`.
-* Is the database is populated? If not, import the contents of `database.sql` with phpmyadmin or the mysql command line.
+* Is the database populated? If not, import the contents of `database.sql` with phpmyadmin or the mysql command line.
At this point visit your website again, and register your personal account.
Registration errors should all be recoverable automatically.
### Prepare .htaccess file
-Copy .htaccess-dist to .htaccess (be careful under Windows) to have working mod-rewrite again. If you have installed Friendica into a sub directory, like /friendica/ set this path in RewriteBase accordingly.
+Copy `.htaccess-dist` to `.htaccess` (be careful under Windows) to have working mod-rewrite again. If you have installed Friendica into a sub directory, like */friendica/* set this path in `RewriteBase` accordingly.
Example:
cp .htacces-dist .htaccess
-*Note*: Do **not** rename the .htaccess-dist file as it is tracked by GIT and renaming will cause a dirty working directory.
+*Note*: Do **not** rename the `.htaccess-dist` file as it is tracked by GIT and renaming will cause a dirty working directory.
### Verify the "host-meta" page is working
-Friendica should respond automatically to important addresses under the /.well-known/ rewrite path.
-One critical URL would look like, for example, https://example.com/.well-known/host-meta
+Friendica should respond automatically to important addresses under the */.well-known/* rewrite path.
+One critical URL would look like, for example: https://example.com/.well-known/host-meta
It must be visible to the public and must respond with an XML file that is automatically customized to your site.
If that URL is not working, it is possible that some other software is using the /.well-known/ path.
This is a severe configuration issue that prevents server to server communication."
Another common error related to host-meta is the "Invalid profile URL."
-Check for a .well-known directory that did not come with Friendica.
+Check for a `.well-known` directory that did not come with Friendica.
The preferred configuration is to remove the directory, however this is not always possible.
If there is any /.well-known/.htaccess file, it could interfere with this Friendica core requirement.
You should remove any RewriteRules from that file, or remove that whole file if appropriate.
It may be necessary to chmod the /.well-known/.htaccess file if you were not given write permissions by default.
-### Set up the worker
+## Register the admin account
+
+At this point visit your website again, and register your personal account with the same email as in the `config.admin_email` config value.
+Registration errors should all be recoverable automatically.
+
+If you get any *critical* failure at this point, it generally indicates the database was not installed correctly.
+You might wish to delete/rename `config/local.config.php` to another name and drop all the database tables so that you can start fresh.
+
+## Post Install Configuration
+
+### (REQUIRED) Background tasks
Set up a cron job or scheduled task to run the worker once every 5-10 minutes in order to perform background processing.
Example:
Change "/base/directory", and "/path/to/php" as appropriate for your situation.
+#### cron job for worker
+
If you are using a Linux server, run "crontab -e" and add a line like the
one shown, substituting for your unique paths and settings:
Once you have installed Friendica and created an admin account as part of the process, you can access the admin panel of your installation and do most of the server wide configuration from there.
+#### worker alternative: daemon
+Otherwise, you’ll need to use the command line on your remote server and start the Friendica daemon (background task) using the following command:
+
+ cd /path/to/friendica; php bin/daemon.php start
+
+Once started, you can check the daemon status using the following command:
+
+ cd /path/to/friendica; php bin/daemon.php status
+
+After a server restart or any other failure, the daemon needs to be restarted.
+This could be achieved by a cronjob.
+
+### (RECOMMENDED) Logging & Log Rotation
+
At this point it is recommended that you set up logging and logrotation.
To do so please visit [Settings](help/Settings) and search the 'Logs' section for more information.
-### Set up a backup plan
+### (RECOMMENDED) Set up a backup plan
Bad things will happen.
Let there be a hardware failure, a corrupted database or whatever you can think of.
The most important file is the `config/local.config.php` file.
As it stores all your data, you should also have a recent dump of your Friendica database at hand, should you have to recover your node.
+
+### (OPTIONAL) Reverse-proxying and HTTPS
+
+Friendica looks for some well-known HTTP headers indicating a reverse-proxy
+terminating an HTTPS connection.
+While the standard from RFC 7239 specifies the use of the `Forwarded` header.
+
+ Forwarded: for=192.0.2.1; proto=https; by=192.0.2.2
+
+Friendica also supports a number on non-standard headers in common use.
+
+ X-Forwarded-Proto: https
+
+ Front-End-Https: on
+
+ X-Forwarded-Ssl: on
+
+It is however preferable to use the standard approach if configuring a new server.
+
+## Troubleshooting
+
+### "System is currently unavailable. Please try again later"
+
+Check your database settings.
+It usually means your database could not be opened or accessed.
+If the database resides on the same machine, check that the database server name is "localhost".
+
+### 500 Internal Error
+
+This could be the result of one of our Apache directives not being supported by your version of Apache. Examine your apache server logs.
+You might remove the line "Options -Indexes" from the .htaccess file if you are using a Windows server as this has been known to cause problems.
+Also check your file permissions. Your website and all contents must generally be world-readable.
+
+It is likely that your web server reported the source of the problem in its error log files.
+Please review these system error logs to determine what caused the problem.
+Often this will need to be resolved with your hosting provider or (if self-hosted) your web server configuration.
+
+### 400 and 4xx "File not found" errors
+
+First check your file permissions.
+Your website and all contents must generally be world-readable.
+
+Ensure that mod-rewite is installed and working, and that your `.htaccess` file
+is being used. To verify the latter, create a file `test.out` containing the
+word "test" in the top directory of Friendica, make it world readable and point
+your web browser to
+
+ http://yoursitenamehere.com/test.out
+
+This file should be blocked. You should get a permission denied message.
+
+If you see the word "test" your Apache configuration is not allowing your
+`.htaccess` file to be used (there are rules in this file to block access to any
+file with .out at the end, as these are typically used for system logs).
+
+Make certain the `.htaccess` file exists and is readable by everybody, then look
+for the existence of "AllowOverride None" in the Apache server configuration for your site.
+This will need to be changed to "AllowOverride All".
+
+If you do not see the word "test", your `.htaccess` is working, but it is likely
+that mod-rewrite is not installed in your web server or is not working.
+
+On most Linux flavors:
+
+ % a2enmod rewrite
+ % /etc/init.d/apache2 restart
+
+Consult your hosting provider, experts on your particular Linux distribution or
+(if Windows) the provider of your Apache server software if you need to change
+either of these and can not figure out how. There is a lot of help available on
+the web. Search "mod-rewrite" along with the name of your operating system
+distribution or Apache package (if using Windows).
+
+### Unable to write the file config/local.config.php due to permissions issues
+
+Create an empty `config/local.config.php`file and apply world-write permission.
+
+On Linux:
+
+ % touch config/local.config.php
+ % chmod 664 config/local.config.php
+
+Retry the installation. As soon as the database has been created,
+
+******* this is important *********
+
+ % chmod 644 config/local.config.php
+
+### Suhosin issues
+
+Some configurations with "suhosin" security are configured without an ability to
+run external processes. Friendica requires this ability. Following are some notes
+provided by one of our members.
+
+> On my server I use the php protection system Suhosin [http://www.hardened-php.net/suhosin/].
+> One of the things it does is to block certain functions like proc_open, as
+> configured in `/etc/php5/conf.d/suhosin.ini`:
+>
+> suhosin.executor.func.blacklist = proc_open, ...
+>
+> For those sites like Friendica that really need these functions they can be
+> enabled, e.g. in `/etc/apache2/sites-available/friendica`:
+>
+> <Directory /var/www/friendica/>
+> php_admin_value suhosin.executor.func.blacklist none
+> php_admin_value suhosin.executor.eval.blacklist none
+> </Directory>
+>
+> This enables every function for Friendica if accessed via browser, but not for
+> the cronjob that is called via php command line. I attempted to enable it for
+> cron by using something like:
+>
+> */10 * * * * cd /var/www/friendica/friendica/ && sudo -u www-data /usr/bin/php \
+> -d suhosin.executor.func.blacklist=none \
+> -d suhosin.executor.eval.blacklist=none -f bin/worker.php
+>
+> This worked well for simple test cases, but the friendica-cron still failed
+> with a fatal error:
+>
+> suhosin[22962]: ALERT - function within blacklist called: proc_open()
+> (attacker 'REMOTE_ADDR not set', file '/var/www/friendica/friendica/boot.php',
+> line 1341)
+>
+> After a while I noticed, that `bin/worker.php` calls further PHP script via `proc_open`.
+> These scripts themselves also use `proc_open` and fail, because they are NOT
+> called with `-d suhosin.executor.func.blacklist=none`.
+>
+> So the simple solution is to put the correct parameters into `config/local.config.php`:
+>
+> 'config' => [
+> //Location of PHP command line processor
+> 'php_path' => '/usr/bin/php -d suhosin.executor.func.blacklist=none \
+> -d suhosin.executor.eval.blacklist=none',
+> ],
+>
+> This is obvious as soon as you notice that the friendica-cron uses `proc_open`
+> to execute PHP scripts that also use `proc_open`, but it took me quite some time to find that out.
+> I hope this saves some time for other people using suhosin with function blacklists.
+
+### Unable to create all mysql tables on MySQL 5.7.17 or newer
+
+If the setup fails to create all the database tables and/or manual creation from
+the command line fails, with this error:
+
+ ERROR 1067 (42000) at line XX: Invalid default value for 'created'
+
+You need to adjust your my.cnf and add the following setting under the [mysqld]
+section:
+
+ sql_mode = '';
+
+After that, restart mysql and try again.
## Using a Friendica archive
If you installed Friendica in the ``path/to/friendica`` folder:
+
1. Unpack the new Friendica archive in ``path/to/friendica_new``.
2. Copy ``config/local.config.php``, ``photo/`` and ``proxy/`` from ``path/to/friendica`` to ``path/to/friendica_new``.
3. Rename the ``path/to/friendica`` folder to ``path/to/friendica_old``.
use DOMDocument;
use DOMXPath;
use Exception;
-use Friendica\Core\Config\Cache\IConfigCache;
+use Friendica\Core\Config\Cache\ConfigCache;
use Friendica\Core\Config\Configuration;
use Friendica\Core\Hook;
use Friendica\Core\Theme;
/**
* Returns the current config cache of this node
*
- * @return IConfigCache
+ * @return ConfigCache
*/
public function getConfigCache()
{
/**
* @param Installer $installer The Installer instance
- * @param Config\Cache\IConfigCache $configCache The config cache
+ * @param Config\Cache\ConfigCache $configCache The config cache
*
* @return bool true if checks were successfully, otherwise false
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- private function runBasicChecks(Installer $installer, Config\Cache\IConfigCache $configCache)
+ private function runBasicChecks(Installer $installer, Config\Cache\ConfigCache $configCache)
{
$checked = true;
* Initial, all *.config.php files are loaded into this cache with the
* ConfigFileLoader ( @see ConfigFileLoader )
*/
-class ConfigCache implements IConfigCache, IPConfigCache
+class ConfigCache
{
/**
* @var array
private $hidePasswordOutput;
/**
- * @param array $config A initial config array
+ * @param array $config A initial config array
* @param bool $hidePasswordOutput True, if cache variables should take extra care of password values
*/
public function __construct(array $config = [], $hidePasswordOutput = true)
}
/**
- * {@inheritdoc}
+ * Tries to load the specified configuration array into the config array.
+ * Doesn't overwrite previously set values by default to prevent default config files to supersede DB Config.
+ *
+ * @param array $config
+ * @param bool $overwrite Force value overwrite if the config key already exists
*/
public function load(array $config, $overwrite = false)
{
}
/**
- * {@inheritdoc}
+ * Gets a value from the config cache.
+ *
+ * @param string $cat Config category
+ * @param string $key Config key
+ *
+ * @return null|mixed Returns the value of the Config entry or null if not set
*/
public function get($cat, $key = null)
{
}
/**
- * {@inheritdoc}
+ * Sets a value in the config cache. Accepts raw output from the config table
+ *
+ * @param string $cat Config category
+ * @param string $key Config key
+ * @param mixed $value Value to set
+ *
+ * @return bool True, if the value is set
*/
public function set($cat, $key, $value)
{
}
/**
- * {@inheritdoc}
+ * Deletes a value from the config cache.
+ *
+ * @param string $cat Config category
+ * @param string $key Config key
+ *
+ * @return bool true, if deleted
*/
public function delete($cat, $key)
{
}
}
- /**
- * {@inheritdoc}
- */
- public function loadP($uid, array $config)
- {
- $categories = array_keys($config);
-
- foreach ($categories as $category) {
- if (isset($config[$category]) && is_array($config[$category])) {
-
- $keys = array_keys($config[$category]);
-
- foreach ($keys as $key) {
- $value = $config[$category][$key];
- if (isset($value)) {
- $this->setP($uid, $category, $key, $value);
- }
- }
- }
- }
- }
-
- /**
- * {@inheritdoc}
- */
- public function getP($uid, $cat, $key = null)
- {
- if (isset($this->config[$uid][$cat][$key])) {
- return $this->config[$uid][$cat][$key];
- } elseif (!isset($key) && isset($this->config[$uid][$cat])) {
- return $this->config[$uid][$cat];
- } else {
- return null;
- }
- }
-
- /**
- * {@inheritdoc}
- */
- public function setP($uid, $cat, $key, $value)
- {
- if (!isset($this->config[$uid]) || !is_array($this->config[$uid])) {
- $this->config[$uid] = [];
- }
-
- if (!isset($this->config[$uid][$cat])) {
- $this->config[$uid][$cat] = [];
- }
-
- $this->config[$uid][$cat][$key] = $value;
-
- return true;
- }
-
- /**
- * {@inheritdoc}
- */
- public function deleteP($uid, $cat, $key)
- {
- if (isset($this->config[$uid][$cat][$key])) {
- unset($this->config[$uid][$cat][$key]);
- if (count($this->config[$uid][$cat]) == 0) {
- unset($this->config[$uid][$cat]);
- if (count($this->config[$uid]) == 0) {
- unset($this->config[$uid]);
- }
- }
-
- return true;
- } else {
- return false;
- }
- }
-
/**
* Returns the whole configuration
*
+++ /dev/null
-<?php
-
-namespace Friendica\Core\Config\Cache;
-
-/**
- * The interface for a system-wide ConfigCache
- */
-interface IConfigCache
-{
- /**
- * Tries to load the specified configuration array into the config array.
- * Doesn't overwrite previously set values by default to prevent default config files to supersede DB Config.
- *
- * @param array $config
- * @param bool $overwrite Force value overwrite if the config key already exists
- */
- function load(array $config, $overwrite = false);
-
- /**
- * Gets a value from the config cache.
- *
- * @param string $cat Config category
- * @param string $key Config key
- *
- * @return null|mixed Returns the value of the Config entry or null if not set
- */
- function get($cat, $key = null);
-
- /**
- * Sets a value in the config cache. Accepts raw output from the config table
- *
- * @param string $cat Config category
- * @param string $key Config key
- * @param mixed $value Value to set
- *
- * @return bool True, if the value is set
- */
- function set($cat, $key, $value);
-
- /**
- * Deletes a value from the config cache.
- *
- * @param string $cat Config category
- * @param string $key Config key
- *
- * @return bool true, if deleted
- */
- function delete($cat, $key);
-
- /**
- * Returns the whole configuration cache
- *
- * @return array
- */
- function getAll();
-}
+++ /dev/null
-<?php
-
-namespace Friendica\Core\Config\Cache;
-
-/**
- * The interface for a user-specific config cache
- */
-interface IPConfigCache
-{
- /**
- * Tries to load the specified configuration array into the user specific config array.
- * Doesn't overwrite previously set values by default to prevent default config files to supersede DB Config.
- *
- * @param int $uid
- * @param array $config
- */
- function loadP($uid, array $config);
-
- /**
- * Retrieves a value from the user config cache
- *
- * @param int $uid User Id
- * @param string $cat Config category
- * @param string $key Config key
- *
- * @return null|string The value of the config entry or null if not set
- */
- function getP($uid, $cat, $key = null);
-
- /**
- * Sets a value in the user config cache
- *
- * Accepts raw output from the pconfig table
- *
- * @param int $uid User Id
- * @param string $cat Config category
- * @param string $key Config key
- * @param mixed $value Value to set
- */
- function setP($uid, $cat, $key, $value);
-
- /**
- * Deletes a value from the user config cache
- *
- * @param int $uid User Id
- * @param string $cat Config category
- * @param string $key Config key
- *
- * @return bool true, if deleted
- */
- function deleteP($uid, $cat, $key);
-
- /**
- * Returns the whole configuration cache
- *
- * @return array
- */
- function getAll();
-}
--- /dev/null
+<?php
+
+namespace Friendica\Core\Config\Cache;
+
+use ParagonIE\HiddenString\HiddenString;
+
+/**
+ * The Friendica config cache for users
+ */
+class PConfigCache
+{
+ /**
+ * @var array
+ */
+ private $config;
+
+ /**
+ * @var bool
+ */
+ private $hidePasswordOutput;
+
+ /**
+ * @param bool $hidePasswordOutput True, if cache variables should take extra care of password values
+ */
+ public function __construct($hidePasswordOutput = true)
+ {
+ $this->hidePasswordOutput = $hidePasswordOutput;
+ }
+
+ /**
+ * Tries to load the specified configuration array into the user specific config array.
+ * Doesn't overwrite previously set values by default to prevent default config files to supersede DB Config.
+ *
+ * @param int $uid
+ * @param array $config
+ */
+ public function load($uid, array $config)
+ {
+ $categories = array_keys($config);
+
+ foreach ($categories as $category) {
+ if (isset($config[$category]) && is_array($config[$category])) {
+
+ $keys = array_keys($config[$category]);
+
+ foreach ($keys as $key) {
+ $value = $config[$category][$key];
+ if (isset($value)) {
+ $this->set($uid, $category, $key, $value);
+ }
+ }
+ }
+ }
+ }
+
+ /**
+ * Retrieves a value from the user config cache
+ *
+ * @param int $uid User Id
+ * @param string $cat Config category
+ * @param string $key Config key
+ *
+ * @return null|string The value of the config entry or null if not set
+ */
+ public function get($uid, $cat, $key = null)
+ {
+ if (isset($this->config[$uid][$cat][$key])) {
+ return $this->config[$uid][$cat][$key];
+ } elseif (!isset($key) && isset($this->config[$uid][$cat])) {
+ return $this->config[$uid][$cat];
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * Sets a value in the user config cache
+ *
+ * Accepts raw output from the pconfig table
+ *
+ * @param int $uid User Id
+ * @param string $cat Config category
+ * @param string $key Config key
+ * @param mixed $value Value to set
+ *
+ * @return bool Set successful
+ */
+ public function set($uid, $cat, $key, $value)
+ {
+ if (!isset($this->config[$uid]) || !is_array($this->config[$uid])) {
+ $this->config[$uid] = [];
+ }
+
+ if (!isset($this->config[$uid][$cat])) {
+ $this->config[$uid][$cat] = [];
+ }
+
+ if ($this->hidePasswordOutput &&
+ $key == 'password' &&
+ !empty($value) && is_string($value)) {
+ $this->config[$uid][$cat][$key] = new HiddenString((string) $value);
+ } else {
+ $this->config[$uid][$cat][$key] = $value;
+ }
+
+
+ return true;
+ }
+
+ /**
+ * Deletes a value from the user config cache
+ *
+ * @param int $uid User Id
+ * @param string $cat Config category
+ * @param string $key Config key
+ *
+ * @return bool true, if deleted
+ */
+ public function delete($uid, $cat, $key)
+ {
+ if (isset($this->config[$uid][$cat][$key])) {
+ unset($this->config[$uid][$cat][$key]);
+ if (count($this->config[$uid][$cat]) == 0) {
+ unset($this->config[$uid][$cat]);
+ if (count($this->config[$uid]) == 0) {
+ unset($this->config[$uid]);
+ }
+ }
+
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Returns the whole configuration
+ *
+ * @return array The configuration
+ */
+ public function getAll()
+ {
+ return $this->config;
+ }
+
+ /**
+ * Returns an array with missing categories/Keys
+ *
+ * @param array $config The array to check
+ *
+ * @return array
+ */
+ public function keyDiff(array $config)
+ {
+ $return = [];
+
+ $categories = array_keys($config);
+
+ foreach ($categories as $category) {
+ if (is_array($config[$category])) {
+ $keys = array_keys($config[$category]);
+
+ foreach ($keys as $key) {
+ if (!isset($this->config[$category][$key])) {
+ $return[$category][$key] = $config[$category][$key];
+ }
+ }
+ }
+ }
+
+ return $return;
+ }
+}
class Configuration
{
/**
- * @var Cache\IConfigCache
+ * @var Cache\ConfigCache
*/
private $configCache;
private $configAdapter;
/**
- * @param Cache\IConfigCache $configCache The configuration cache (based on the config-files)
+ * @param Cache\ConfigCache $configCache The configuration cache (based on the config-files)
* @param Adapter\IConfigAdapter $configAdapter The configuration DB-backend
*/
- public function __construct(Cache\IConfigCache $configCache, Adapter\IConfigAdapter $configAdapter)
+ public function __construct(Cache\ConfigCache $configCache, Adapter\IConfigAdapter $configAdapter)
{
$this->configCache = $configCache;
$this->configAdapter = $configAdapter;
/**
* Returns the Config Cache
*
- * @return Cache\IConfigCache
+ * @return Cache\ConfigCache
*/
public function getCache()
{
class PConfiguration
{
/**
- * @var Cache\IPConfigCache
+ * @var Cache\PConfigCache
*/
private $configCache;
private $configAdapter;
/**
- * @param Cache\IPConfigCache $configCache The configuration cache
+ * @param Cache\PConfigCache $configCache The configuration cache
* @param Adapter\IPConfigAdapter $configAdapter The configuration DB-backend
*/
- public function __construct(Cache\IPConfigCache $configCache, Adapter\IPConfigAdapter $configAdapter)
+ public function __construct(Cache\PConfigCache $configCache, Adapter\IPConfigAdapter $configAdapter)
{
$this->configCache = $configCache;
$this->configAdapter = $configAdapter;
}
// load the whole category out of the DB into the cache
- $this->configCache->loadP($uid, $this->configAdapter->load($uid, $cat));
+ $this->configCache->load($uid, $this->configAdapter->load($uid, $cat));
}
/**
$dbValue = $this->configAdapter->get($uid, $cat, $key);
if (isset($dbValue)) {
- $this->configCache->setP($uid, $cat, $key, $dbValue);
+ $this->configCache->set($uid, $cat, $key, $dbValue);
return $dbValue;
}
}
// use the config cache for return
- $result = $this->configCache->getP($uid, $cat, $key);
+ $result = $this->configCache->get($uid, $cat, $key);
return (isset($result)) ? $result : $default_value;
}
public function set($uid, $cat, $key, $value)
{
// set the cache first
- $cached = $this->configCache->setP($uid, $cat, $key, $value);
+ $cached = $this->configCache->set($uid, $cat, $key, $value);
// If there is no connected adapter, we're finished
if (!$this->configAdapter->isConnected()) {
*/
public function delete($uid, $cat, $key)
{
- $cacheRemoved = $this->configCache->deleteP($uid, $cat, $key);
+ $cacheRemoved = $this->configCache->delete($uid, $cat, $key);
if (!$this->configAdapter->isConnected()) {
return $cacheRemoved;
use DOMDocument;
use Exception;
-use Friendica\Core\Config\Cache\IConfigCache;
+use Friendica\Core\Config\Cache\ConfigCache;
use Friendica\Database\DBStructure;
use Friendica\Factory\DBFactory;
use Friendica\Object\Image;
* - Creates `config/local.config.php`
* - Installs Database Structure
*
- * @param IConfigCache $configCache The config cache with all config relevant information
+ * @param ConfigCache $configCache The config cache with all config relevant information
*
* @return bool true if the config was created, otherwise false
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public function createConfig(IConfigCache $configCache)
+ public function createConfig(ConfigCache $configCache)
{
$basepath = $configCache->get('system', 'basepath');
/**
* Checking the Database connection and if it is available for the current installation
*
- * @param IConfigCache $configCache The configuration cache
+ * @param ConfigCache $configCache The configuration cache
* @param Profiler $profiler The profiler of this app
*
* @return bool true if the check was successful, otherwise false
* @throws Exception
*/
- public function checkDB(IConfigCache $configCache, Profiler $profiler)
+ public function checkDB(ConfigCache $configCache, Profiler $profiler)
{
$database = DBFactory::init($configCache, $profiler, [], new VoidLogger());
/**
* Setup the default cache for a new installation
*
- * @param IConfigCache $configCache The configuration cache
+ * @param ConfigCache $configCache The configuration cache
* @param string $basePath The determined basepath
*
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public function setUpCache(IConfigCache $configCache, $basePath)
+ public function setUpCache(ConfigCache $configCache, $basePath)
{
$configCache->set('config', 'php_path' , $this->getPHPPath());
$configCache->set('system', 'basepath' , $basePath);
namespace Friendica\Database;
-use Friendica\Core\Config\Cache\IConfigCache;
+use Friendica\Core\Config\Cache\ConfigCache;
use Friendica\Core\System;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\Profiler;
private $connected = false;
/**
- * @var IConfigCache
+ * @var ConfigCache
*/
private $configCache;
/**
private $db_name;
private $db_charset;
- public function __construct(IConfigCache $configCache, Profiler $profiler, LoggerInterface $logger, $serveraddr, $user, HiddenString $pass, $db, $charset = null)
+ public function __construct(ConfigCache $configCache, Profiler $profiler, LoggerInterface $logger, $serveraddr, $user, HiddenString $pass, $db, $charset = null)
{
// We are storing these values for being able to perform a reconnect
$this->configCache = $configCache;
}
/**
- * @param Cache\ConfigCache $configCache The config cache of this adapter
+ * @param Cache\ConfigCache $configCache The config cache
*
* @return Config\Configuration
*/
}
/**
- * @param Cache\ConfigCache $configCache The config cache of this adapter
+ * @param Cache\ConfigCache $configCache The config cache
+ * @param Cache\PConfigCache $pConfigCache The personal config cache
* @param int $uid The UID of the current user
*
* @return Config\PConfiguration
*/
- public static function createPConfig(Cache\ConfigCache $configCache, $uid = null)
+ public static function createPConfig(Cache\ConfigCache $configCache, Cache\PConfigCache $pConfigCache, $uid = null)
{
if ($configCache->get('system', 'config_adapter') === 'preload') {
$configAdapter = new Adapter\PreloadPConfigAdapter($uid);
$configAdapter = new Adapter\JITPConfigAdapter();
}
- $configuration = new Config\PConfiguration($configCache, $configAdapter);
+ $configuration = new Config\PConfiguration($pConfigCache, $configAdapter);
// Set the config in the static container for legacy usage
Core\PConfig::init($configuration);
/**
* Initialize the DBA connection
*
- * @param Cache\IConfigCache $configCache The configuration cache
- * @param Profiler $profiler The profiler
- * @param array $server The $_SERVER variables
+ * @param Cache\ConfigCache $configCache The configuration cache
+ * @param Profiler $profiler The profiler
+ * @param array $server The $_SERVER variables
*
* @return Database\Database
* @throws \Exception if connection went bad
*/
- public static function init(Cache\IConfigCache $configCache, Profiler $profiler, array $server)
+ public static function init(Cache\ConfigCache $configCache, Profiler $profiler, array $server)
{
$db_host = $configCache->get('database', 'hostname');
$db_user = $configCache->get('database', 'username');
namespace Friendica\Factory;
use Friendica\App;
+use Friendica\Core\Config\Cache\PConfigCache;
use Friendica\Factory;
use Friendica\Util\BasePath;
use Friendica\Util\BaseURL;
$database = Factory\DBFactory::init($configCache, $profiler, $_SERVER);
$config = Factory\ConfigFactory::createConfig($configCache);
// needed to call PConfig::init()
- Factory\ConfigFactory::createPConfig($configCache);
+ Factory\ConfigFactory::createPConfig($configCache, new PConfigCache());
$logger = Factory\LoggerFactory::create($channel, $database, $config, $profiler);
Factory\LoggerFactory::createDev($channel, $config, $profiler);
$baseURL = new BaseURL($config, $_SERVER);
namespace Friendica\Factory;
-use Friendica\Core\Config\Cache\IConfigCache;
+use Friendica\Core\Config\Cache\ConfigCache;
use Friendica\Util\Profiler;
class ProfilerFactory
/**
* Creates a Profiler for the current execution
*
- * @param IConfigCache $configCache The configuration cache
+ * @param ConfigCache $configCache The configuration cache
*
* @return Profiler
*/
- public static function create(IConfigCache $configCache)
+ public static function create(ConfigCache $configCache)
{
$enabled = $configCache->get('system', 'profiler');
$enabled = isset($enabled) && $enabled !== '0';
use Friendica\App;
use Friendica\BaseModule;
use Friendica\Core;
-use Friendica\Core\Config\Cache\IConfigCache;
+use Friendica\Core\Config\Cache\ConfigCache;
use Friendica\Core\L10n;
use Friendica\Core\Renderer;
+use Friendica\Network\HTTPException;
use Friendica\Util\BasePath;
use Friendica\Util\BaseURL;
use Friendica\Util\Strings;
$a = self::getApp();
if (!$a->getMode()->isInstall()) {
- throw new \Friendica\Network\HTTPException\ForbiddenException();
+ throw new HTTPException\ForbiddenException();
}
// route: install/testrwrite
// @TODO: Replace with parameter from router
if ($a->getArgumentValue(1, '') == 'testrewrite') {
// Status Code 204 means that it worked without content
- throw new \Friendica\Network\HTTPException\NoContentException();
+ throw new HTTPException\NoContentException();
}
self::$installer = new Core\Installer();
public static function post()
{
- $a = self::getApp();
+ $a = self::getApp();
$configCache = $a->getConfigCache();
switch (self::$currentWizardStep) {
public static function content()
{
- $a = self::getApp();
+ $a = self::getApp();
$configCache = $a->getConfigCache();
$output = '';
$status = self::$installer->checkEnvironment($a->getBaseURL(), $php_path);
- $tpl = Renderer::getMarkupTemplate('install_checks.tpl');
+ $tpl = Renderer::getMarkupTemplate('install_checks.tpl');
$output .= Renderer::replaceMacros($tpl, [
'$title' => $install_title,
'$pass' => L10n::t('System check'),
BaseURL::SSL_POLICY_SELFSIGN => L10n::t("Self-signed certificate, use SSL for local links only \x28discouraged\x29")
];
- $tpl = Renderer::getMarkupTemplate('install_base.tpl');
+ $tpl = Renderer::getMarkupTemplate('install_base.tpl');
$output .= Renderer::replaceMacros($tpl, [
'$title' => $install_title,
'$pass' => L10n::t('Base settings'),
break;
case self::DATABASE_CONFIG:
- $tpl = Renderer::getMarkupTemplate('install_db.tpl');
+ $tpl = Renderer::getMarkupTemplate('install_db.tpl');
$output .= Renderer::replaceMacros($tpl, [
'$title' => $install_title,
'$pass' => L10n::t('Database connection'),
/* Installed langs */
$lang_choices = L10n::getAvailableLanguages();
- $tpl = Renderer::getMarkupTemplate('install_settings.tpl');
+ $tpl = Renderer::getMarkupTemplate('install_settings.tpl');
$output .= Renderer::replaceMacros($tpl, [
'$title' => $install_title,
'$checks' => self::$installer->getChecks(),
$db_return_text = "";
if (count(self::$installer->getChecks()) == 0) {
- $txt = '<p style="font-size: 130%;">';
- $txt .= L10n::t('Your Friendica site database has been installed.') . EOL;
+ $txt
= '<p style="font-size: 130%;">';
+ $txt .= L10n::t('Your Friendica site database has been installed.') . EOL;
$db_return_text .= $txt;
}
- $tpl = Renderer::getMarkupTemplate('install_finished.tpl');
+ $tpl = Renderer::getMarkupTemplate('install_finished.tpl');
$output .= Renderer::replaceMacros($tpl, [
'$title' => $install_title,
'$checks' => self::$installer->getChecks(),
$baseurl = $a->getBaseUrl();
return
L10n::t('<h1>What next</h1>')
- . "<p>".L10n::t('IMPORTANT: You will need to [manually] setup a scheduled task for the worker.')
+ . "<p>" . L10n::t('IMPORTANT: You will need to [manually] setup a scheduled task for the worker.')
. L10n::t('Please see the file "INSTALL.txt".')
. "</p><p>"
. L10n::t('Go to your new Friendica node <a href="%s/register">registration page</a> and register as new user. Remember to use the same email you have entered as administrator email. This will allow you to enter the site admin panel.', $baseurl)
/**
* Checks the $_POST settings and updates the config Cache for it
*
- * @param IConfigCache $configCache The current config cache
- * @param array $post The $_POST data
- * @param string $cat The category of the setting
- * @param string $key The key of the setting
- * @param null|string $default The default value
+ * @param ConfigCache $configCache The current config cache
+ * @param array $post The $_POST data
+ * @param string $cat The category of the setting
+ * @param string $key The key of the setting
+ * @param null|string $default The default value
*/
- private static function checkSetting(IConfigCache $configCache, array $post, $cat, $key, $default = null)
+ private static function checkSetting(ConfigCache $configCache, array $post, $cat, $key, $default = null)
{
$configCache->set($cat, $key,
Strings::escapeTags(
use Friendica\App;
use Friendica\Core\Addon;
-use Friendica\Core\Config\Cache\IConfigCache;
+use Friendica\Core\Config\Cache\ConfigCache;
/**
- * The ConfigFileLoader loads config-files and stores them in a IConfigCache ( @see IConfigCache )
+ * The ConfigFileLoader loads config-files and stores them in a ConfigCache ( @see ConfigCache )
*
* It is capable of loading the following config files:
* - *.config.php (current)
* First loads the default value for all the configuration keys, then the legacy configuration files, then the
* expected local.config.php
*
- * @param IConfigCache $config The config cache to load to
- * @param bool $raw Setup the raw config format
+ * @param ConfigCache $config The config cache to load to
+ * @param bool $raw Setup the raw config format
*
* @throws \Exception
*/
- public function setupCache(IConfigCache $config, $raw = false)
+ public function setupCache(ConfigCache $config, $raw = false)
{
$config->load($this->loadCoreConfig('defaults'));
$config->load($this->loadCoreConfig('settings'));
*/
public function mockApp(vfsStreamDirectory $root, $raw = false)
{
- $this->configMock = \Mockery::mock(Config\Cache\IConfigCache::class);
+ $this->configMock = \Mockery::mock(Config\Cache\ConfigCache::class);
$this->mode = \Mockery::mock(App\Mode::class);
$configAdapterMock = \Mockery::mock(Config\Adapter\IConfigAdapter::class);
// Disable the adapter
$profiler = Factory\ProfilerFactory::create($configCache);
$database = Factory\DBFactory::init($configCache, $profiler, $_SERVER);
$config = Factory\ConfigFactory::createConfig($configCache);
- Factory\ConfigFactory::createPConfig($configCache);
+ Factory\ConfigFactory::createPConfig($configCache, new Config\Cache\PConfigCache());
$logger = Factory\LoggerFactory::create('test', $database, $config, $profiler);
$baseUrl = new BaseURL($config, $_SERVER);
$this->app = new App($database, $config, $mode, $router, $baseUrl, $logger, $profiler, false);
namespace Friendica\Test\src\Core\Cache;
use Friendica\Core\Cache\IMemoryCacheDriver;
+use Friendica\Core\Logger;
+use Psr\Log\NullLogger;
abstract class MemoryCacheTest extends CacheTest
{
protected function setUp()
{
+ Logger::init(new NullLogger());
+
parent::setUp();
if (!($this->instance instanceof IMemoryCacheDriver)) {
throw new \Exception('MemoryCacheTest unsupported');
];
}
- private function assertConfigValues($data, ConfigCache $configCache, $uid = null)
+ private function assertConfigValues($data, ConfigCache $configCache)
{
foreach ($data as $cat => $values) {
foreach ($values as $key => $value) {
- if (isset($uid)) {
- $this->assertEquals($data[$cat][$key], $configCache->getP($uid, $cat, $key));
- } else {
- $this->assertEquals($data[$cat][$key], $configCache->get($cat, $key));
- }
+ $this->assertEquals($data[$cat][$key], $configCache->get($cat, $key));
}
}
}
$this->assertEmpty($configCache->getAll());
}
- /**
- * Test the setP() and getP() methods
- * @dataProvider dataTests
- */
- public function testSetGetP($data)
- {
- $configCache = new ConfigCache();
- $uid = 345;
-
- foreach ($data as $cat => $values) {
- foreach ($values as $key => $value) {
- $configCache->setP($uid, $cat, $key, $value);
- }
- }
-
- $this->assertConfigValues($data, $configCache, $uid);
- }
-
-
- /**
- * Test the getP() method with a category
- */
- public function testGetPCat()
- {
- $configCache = new ConfigCache();
- $uid = 345;
-
- $configCache->loadP($uid, [
- 'system' => [
- 'key1' => 'value1',
- 'key2' => 'value2',
- ],
- 'config' => [
- 'key3' => 'value3',
- ],
- ]);
-
- $this->assertEquals([
- 'key1' => 'value1',
- 'key2' => 'value2',
- ], $configCache->get($uid, 'system'));
- }
-
- /**
- * Test the deleteP() method
- * @dataProvider dataTests
- */
- public function testDeleteP($data)
- {
- $configCache = new ConfigCache();
- $uid = 345;
-
- foreach ($data as $cat => $values) {
- foreach ($values as $key => $value) {
- $configCache->setP($uid, $cat, $key, $value);
- }
- }
-
- foreach ($data as $cat => $values) {
- foreach ($values as $key => $value) {
- $configCache->deleteP($uid, $cat, $key);
- }
- }
-
- $this->assertEmpty($configCache->getAll());
- }
-
/**
* Test the keyDiff() method with result
* @dataProvider dataTests
--- /dev/null
+<?php
+
+namespace Friendica\Test\src\Core\Config\Cache;
+
+use Friendica\Core\Config\Cache\PConfigCache;
+use Friendica\Test\MockedTest;
+
+class PConfigCacheTest extends MockedTest
+{
+ public function dataTests()
+ {
+ return [
+ 'normal' => [
+ 'data' => [
+ 'system' => [
+ 'test' => 'it',
+ 'boolTrue' => true,
+ 'boolFalse' => false,
+ 'int' => 235,
+ 'dec' => 2.456,
+ 'array' => ['1', 2, '3', true, false],
+ ],
+ 'config' => [
+ 'a' => 'value',
+ ],
+ ]
+ ]
+ ];
+ }
+
+ private function assertConfigValues($data, PConfigCache $configCache, $uid)
+ {
+ foreach ($data as $cat => $values) {
+ foreach ($values as $key => $value) {
+ $this->assertEquals($data[$cat][$key], $configCache->get($uid, $cat, $key));
+ }
+ }
+ }
+
+ /**
+ * Test the setP() and getP() methods
+ *
+ * @dataProvider dataTests
+ */
+ public function testSetGet($data)
+ {
+ $configCache = new PConfigCache();
+ $uid = 345;
+
+ foreach ($data as $cat => $values) {
+ foreach ($values as $key => $value) {
+ $configCache->set($uid, $cat, $key, $value);
+ }
+ }
+
+ $this->assertConfigValues($data, $configCache, $uid);
+ }
+
+
+ /**
+ * Test the getP() method with a category
+ */
+ public function testGetCat()
+ {
+ $configCache = new PConfigCache();
+ $uid = 345;
+
+ $configCache->load($uid, [
+ 'system' => [
+ 'key1' => 'value1',
+ 'key2' => 'value2',
+ ],
+ 'config' => [
+ 'key3' => 'value3',
+ ],
+ ]);
+
+ $this->assertEquals([
+ 'key1' => 'value1',
+ 'key2' => 'value2',
+ ], $configCache->get($uid, 'system'));
+ }
+
+ /**
+ * Test the deleteP() method
+ *
+ * @dataProvider dataTests
+ */
+ public function testDelete($data)
+ {
+ $configCache = new PConfigCache();
+ $uid = 345;
+
+ foreach ($data as $cat => $values) {
+ foreach ($values as $key => $value) {
+ $configCache->set($uid, $cat, $key, $value);
+ }
+ }
+
+ foreach ($data as $cat => $values) {
+ foreach ($values as $key => $value) {
+ $configCache->delete($uid, $cat, $key);
+ }
+ }
+
+ $this->assertEmpty($configCache->getAll());
+ }
+
+ /**
+ * Test the keyDiff() method with result
+ *
+ * @dataProvider dataTests
+ */
+ public function testKeyDiffWithResult($data)
+ {
+ $configCache = new PConfigCache($data);
+
+ $diffConfig = [
+ 'fakeCat' => [
+ 'fakeKey' => 'value',
+ ]
+ ];
+
+ $this->assertEquals($diffConfig, $configCache->keyDiff($diffConfig));
+ }
+
+ /**
+ * Test the keyDiff() method without result
+ *
+ * @dataProvider dataTests
+ */
+ public function testKeyDiffWithoutResult($data)
+ {
+ $configCache = new PConfigCache();
+
+ $configCache->load(1, $data);
+
+ $diffConfig = $configCache->getAll();
+
+ $this->assertEmpty($configCache->keyDiff($diffConfig));
+ }
+
+ /**
+ * Test the default hiding of passwords inside the cache
+ */
+ public function testPasswordHide()
+ {
+ $configCache = new PConfigCache();
+
+ $configCache->load(1, [
+ 'database' => [
+ 'password' => 'supersecure',
+ 'username' => 'notsecured',
+ ]
+ ]);
+
+ $this->assertEquals('supersecure', $configCache->get(1, 'database', 'password'));
+ $this->assertNotEquals('supersecure', print_r($configCache->get(1, 'database', 'password'), true));
+ $this->assertEquals('notsecured', print_r($configCache->get(1, 'database', 'username'), true));
+ }
+
+ /**
+ * Test disabling the hiding of passwords inside the cache
+ */
+ public function testPasswordShow()
+ {
+ $configCache = new PConfigCache(false);
+
+ $configCache->load(1, [
+ 'database' => [
+ 'password' => 'supersecure',
+ 'username' => 'notsecured',
+ ]
+ ]);
+
+ $this->assertEquals('supersecure', $configCache->get(1, 'database', 'password'));
+ $this->assertEquals('supersecure', print_r($configCache->get(1, 'database', 'password'), true));
+ $this->assertEquals('notsecured', print_r($configCache->get(1, 'database', 'username'), true));
+ }
+
+ /**
+ * Test a empty password
+ */
+ public function testEmptyPassword()
+ {
+ $configCache = new PConfigCache();
+
+ $configCache->load(1, [
+ 'database' => [
+ 'password' => '',
+ 'username' => '',
+ ]
+ ]);
+
+ $this->assertEmpty($configCache->get(1, 'database', 'password'));
+ $this->assertEmpty($configCache->get(1, 'database', 'username'));
+ }
+
+ public function testWrongTypePassword()
+ {
+ $configCache = new PConfigCache();
+
+ $configCache->load(1, [
+ 'database' => [
+ 'password' => new \stdClass(),
+ 'username' => '',
+ ]
+ ]);
+
+ $this->assertNotEmpty($configCache->get(1, 'database', 'password'));
+ $this->assertEmpty($configCache->get(1, 'database', 'username'));
+
+ $configCache = new PConfigCache();
+
+ $configCache->load(1, [
+ 'database' => [
+ 'password' => 23,
+ 'username' => '',
+ ],
+ ]);
+
+ $this->assertEquals(23, $configCache->get(1, 'database', 'password'));
+ $this->assertEmpty($configCache->get(1, 'database', 'username'));
+ }
+
+ /**
+ * Test two different UID configs and make sure that there is no overlapping possible
+ */
+ public function testTwoUid()
+ {
+ $configCache = new PConfigCache();
+
+ $configCache->load(1, [
+ 'cat1' => [
+ 'key1' => 'value1',
+ ],
+ ]);
+
+
+ $configCache->load(2, [
+ 'cat2' => [
+ 'key2' => 'value2',
+ ],
+ ]);
+
+ $this->assertEquals('value1', $configCache->get(1, 'cat1', 'key1'));
+ $this->assertEquals('value2', $configCache->get(2, 'cat2', 'key2'));
+
+ $this->assertNull($configCache->get(1, 'cat2', 'key2'));
+ $this->assertNull($configCache->get(2, 'cat1', 'key1'));
+ }
+}
use Friendica\Core\Config\Adapter\IConfigAdapter;
use Friendica\Core\Config\Cache\ConfigCache;
-use Friendica\Core\Config\Cache\IConfigCache;
use Friendica\Core\Config\Configuration;
use Friendica\Test\MockedTest;
$configuration = new Configuration($configCache, $configAdapter);
- $this->assertInstanceOf(IConfigCache::class, $configuration->getCache());
+ $this->assertInstanceOf(ConfigCache::class, $configuration->getCache());
}
/**
namespace Friendica\Test\src\Core\Config;
use Friendica\Core\Config\Adapter\IPConfigAdapter;
-use Friendica\Core\Config\Cache\ConfigCache;
+use Friendica\Core\Config\Cache\PConfigCache;
use Friendica\Core\Config\PConfiguration;
use Friendica\Test\MockedTest;
public function testCacheLoad()
{
$uid = 234;
- $configCache = new ConfigCache();
+ $configCache = new PConfigCache();
$configAdapter = \Mockery::mock(IPConfigAdapter::class);
$configAdapter->shouldReceive('isConnected')->andReturn(true)->twice();
// expected loading
public function testCacheLoadDouble()
{
$uid = 234;
- $configCache = new ConfigCache();
+ $configCache = new PConfigCache();
$configAdapter = \Mockery::mock(IPConfigAdapter::class);
$configAdapter->shouldReceive('isConnected')->andReturn(true)->times(4);
// expected loading
public function testSetGetWithoutDB($data)
{
$uid = 234;
- $configCache = new ConfigCache();
+ $configCache = new PConfigCache();
$configAdapter = \Mockery::mock(IPConfigAdapter::class);
$configAdapter->shouldReceive('isConnected')->andReturn(false)->times(2);
public function testSetGetWithDB($data)
{
$uid = 234;
- $configCache = new ConfigCache();
+ $configCache = new PConfigCache();
$configAdapter = \Mockery::mock(IPConfigAdapter::class);
$configAdapter->shouldReceive('isConnected')->andReturn(true)->times(2);
$configAdapter->shouldReceive('isLoaded')->with($uid, 'test', 'it')->andReturn(true)->once();
public function testGetWrongWithoutDB()
{
$uid = 234;
- $configCache = new ConfigCache();
+ $configCache = new PConfigCache();
$configAdapter = \Mockery::mock(IPConfigAdapter::class);
$configAdapter->shouldReceive('isConnected')->andReturn(false)->times(3);
public function testGetWithRefresh($data)
{
$uid = 234;
- $configCache = new ConfigCache();
+ $configCache = new PConfigCache();
$configAdapter = \Mockery::mock(IPConfigAdapter::class);
$configAdapter->shouldReceive('isConnected')->andReturn(true)->times(4);
$configAdapter->shouldReceive('isLoaded')->with($uid, 'test', 'it')->andReturn(false)->once();
public function testGetWithoutLoaded($data)
{
$uid = 234;
- $configCache = new ConfigCache();
+ $configCache = new PConfigCache();
$configAdapter = \Mockery::mock(IPConfigAdapter::class);
$configAdapter->shouldReceive('isConnected')->andReturn(true)->times(3);
public function testDeleteWithoutDB($data)
{
$uid = 234;
- $configCache = new ConfigCache();
+ $configCache = new PConfigCache();
$configAdapter = \Mockery::mock(IPConfigAdapter::class);
$configAdapter->shouldReceive('isConnected')->andReturn(false)->times(4);
public function testDeleteWithDB()
{
$uid = 234;
- $configCache = new ConfigCache();
+ $configCache = new PConfigCache();
$configAdapter = \Mockery::mock(IPConfigAdapter::class);
$configAdapter->shouldReceive('isConnected')->andReturn(true)->times(6);
$configAdapter->shouldReceive('set')->with($uid, 'test', 'it', 'now')->andReturn(false)->once();
// this is in the same namespace as Install for mocking 'function_exists'
namespace Friendica\Core;
-use Friendica\Core\Config\Cache\IConfigCache;
+use Friendica\Core\Config\Cache\ConfigCache;
use Friendica\Network\CurlResult;
use Friendica\Object\Image;
use Friendica\Test\MockedTest;
$this->mockL10nT();
$install = new Installer();
- $configCache = \Mockery::mock(IConfigCache::class);
+ $configCache = \Mockery::mock(ConfigCache::class);
$configCache->shouldReceive('set')->with('config', 'php_path', \Mockery::any())->once();
$configCache->shouldReceive('set')->with('system', 'basepath', '/test/')->once();
namespace Friendica\Test\src\Core\Lock;
+use Friendica\Core\Logger;
use Friendica\Test\MockedTest;
use Friendica\Test\Util\AppMockTrait;
use Friendica\Test\Util\VFSTrait;
+use Psr\Log\NullLogger;
abstract class LockTest extends MockedTest
{
->shouldReceive('getHostname')
->andReturn('friendica.local');
+ Logger::init(new NullLogger());
+
parent::setUp();
$this->instance = $this->getInstance();
$this->instance->releaseAll();
$profiler = Factory\ProfilerFactory::create($configCache);
$database = Factory\DBFactory::init($configCache, $profiler, $_SERVER);
$config = Factory\ConfigFactory::createConfig($configCache);
- Factory\ConfigFactory::createPConfig($configCache);
+ Factory\ConfigFactory::createPConfig($configCache, new Config\Cache\PConfigCache());
$logger = Factory\LoggerFactory::create('test', $database, $config, $profiler);
$baseUrl = new BaseURL($config, $_SERVER);
$this->app = new App($database, $config, $mode, $router, $baseUrl, $logger, $profiler, false);
namespace Friendica\Test\src\Database;
use Friendica\App;
+use Friendica\Core\Config\Cache\PConfigCache;
use Friendica\Database\DBStructure;
use Friendica\Factory;
use Friendica\Test\DatabaseTest;
$profiler = Factory\ProfilerFactory::create($configCache);
$database = Factory\DBFactory::init($configCache, $profiler, $_SERVER);
$config = Factory\ConfigFactory::createConfig($configCache);
- Factory\ConfigFactory::createPConfig($configCache);
+ Factory\ConfigFactory::createPConfig($configCache, new PConfigCache());
$logger = Factory\LoggerFactory::create('test', $database, $config, $profiler);
$baseUrl = new BaseURL($config, $_SERVER);
$this->app = new App($database, $config, $mode, $router, $baseUrl, $logger, $profiler, false);
{{if $profile.marital}}
<dl id="aprofile-marital" class="aprofile">
<dt><span class="heart">♥</span> {{$profile.marital.0}}</dt>
- <dd>{{$profile.marital.1}}{{if $profile.marital.with}} ({{$profile.marital.with}}){{/if}}{{if $profile.howlong}} {{$profile.howlong}}{{/if}}</dd>
+ <dd>{{$profile.marital.1}}{{if $profile.marital.with}} ({{$profile.marital.with nofilter}}){{/if}}{{if $profile.howlong}} {{$profile.howlong}}{{/if}}</dd>
</dl>
{{/if}}
<div id="aprofile-marital" class="col-lg-12 col-md-12 col-sm-12 col-xs-12 aprofile">
<hr class="profile-separator">
<div class="col-lg-4 col-md-4 col-sm-4 col-xs-12 profile-label-name text-muted"><span class="heart">♥</span> {{$profile.marital.0}}</div>
- <div class="col-lg-8 col-md-8 col-sm-8 col-xs-12 profile-entry">{{$profile.marital.1}}{{if $profile.marital.with}} ({{$profile.marital.with}}){{/if}}{{if $profile.howlong}} {{$profile.howlong}}{{/if}}</div>
+ <div class="col-lg-8 col-md-8 col-sm-8 col-xs-12 profile-entry">{{$profile.marital.1}}{{if $profile.marital.with}} ({{$profile.marital.with nofilter}}){{/if}}{{if $profile.howlong}} {{$profile.howlong}}{{/if}}</div>
</div>
{{/if}}
projects / friendica.git / commitdiff