]> git.mxchange.org Git - friendica.git/commitdiff
Install Class to methods
authorPhilipp Holzer <admin@philipp.info>
Mon, 8 Oct 2018 00:15:27 +0000 (02:15 +0200)
committerPhilipp Holzer <admin@philipp.info>
Sat, 13 Oct 2018 16:09:53 +0000 (18:09 +0200)
- Bugfixing Install checks (worked not as expected)
- Changed static methods from Install to class functions
- Added tests

mod/install.php
src/Core/Console/AutomaticInstallation.php
src/Core/Install.php
tests/src/Core/Console/AutomaticInstallationConsoleTest.php
tests/src/Core/Console/ConsoleTest.php
tests/src/Core/InstallTest.php [new file with mode: 0644]

index 97677344a04e27bad4d52c08185d4198ebb6add5..5a0794b354696978d08164ecf8584964050745ec 100644 (file)
@@ -8,6 +8,7 @@ use Friendica\Core\Install;
 use Friendica\Core\L10n;
 use Friendica\Core\System;
 use Friendica\Database\DBA;
+use Friendica\Database\DBStructure;
 use Friendica\Util\Temporal;
 
 $install_wizard_pass = 1;
@@ -69,14 +70,16 @@ function install_post(App $a) {
                        // connect to db
                        DBA::connect($dbhost, $dbuser, $dbpass, $dbdata);
 
-                       $errors = Install::createConfig($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail);
+                       $install = new Install();
 
-                       if ($errors) {
-                               $a->data['db_failed'] = $errors;
+                       $errors = $install->createConfig($phpath, $urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $timezone, $language, $adminmail, $a->getBasePath());
+
+                       if ($errors !== true) {
+                               $a->data['data'] = $errors;
                                return;
                        }
 
-                       $errors = Install::installDatabaseStructure();
+                       $errors = DBStructure::update(false, true, true);
 
                        if ($errors) {
                                $a->data['db_failed'] = $errors;
@@ -145,19 +148,21 @@ function install_content(App $a) {
 
                        $phpath = defaults($_POST, 'phpath', 'php');
 
-                       list($checks, $checkspassed) = Install::check($phpath);
+                       $install = new Install($phpath);
+
+                       $status = $install->checkAll($a->getBasePath(), $a->getBaseURL());
 
                        $tpl = get_markup_template('install_checks.tpl');
                        $o .= replace_macros($tpl, [
                                '$title' => $install_title,
                                '$pass' => L10n::t('System check'),
-                               '$checks' => $checks,
-                               '$passed' => $checkspassed,
+                               '$checks' => $install->getChecks(),
+                               '$passed' => $status,
                                '$see_install' => L10n::t('Please see the file "INSTALL.txt".'),
                                '$next' => L10n::t('Next'),
                                '$reload' => L10n::t('Check again'),
                                '$phpath' => $phpath,
-                               '$baseurl' => System::baseUrl(),
+                               '$baseurl' => $a->getBaseURL(),
                        ]);
                        return $o;
                }; break;
@@ -189,7 +194,7 @@ function install_content(App $a) {
 
                                '$lbl_10' => L10n::t('Please select a default timezone for your website'),
 
-                               '$baseurl' => System::baseUrl(),
+                               '$baseurl' => $a->getBaseURL(),
 
                                '$phpath' => $phpath,
 
@@ -227,9 +232,7 @@ function install_content(App $a) {
 
                                '$timezone' => Temporal::getTimezoneField('timezone', L10n::t('Please select a default timezone for your website'), $timezone, ''),
                                '$language' => ['language', L10n::t('System Language:'), 'en', L10n::t('Set the default language for your Friendica installation interface and to send emails.'), $lang_choices],
-                               '$baseurl' => System::baseUrl(),
-
-
+                               '$baseurl' => $a->getBaseURL(),
 
                                '$submit' => L10n::t('Submit'),
 
index 9cdb8a0ae233187c34c6dbed173e4ba681aa6977..2bfd1a7be1f81d0ff9b41e45afe7da9670476e43 100644 (file)
@@ -3,15 +3,14 @@
 namespace Friendica\Core\Console;
 
 use Asika\SimpleConsole\Console;
-use Friendica\App;
 use Friendica\BaseObject;
 use Friendica\Core\Config;
 use Friendica\Core\Install;
 use Friendica\Core\Theme;
 use Friendica\Database\DBA;
+use Friendica\Database\DBStructure;
 use RuntimeException;
 
-require_once 'mod/install.php';
 require_once 'include/dba.php';
 
 class AutomaticInstallation extends Console
@@ -77,6 +76,8 @@ HELP;
 
                $a = BaseObject::getApp();
 
+               $install = new Install();
+
                // if a config file is set,
                $config_file = $this->getOption(['f', 'file']);
 
@@ -105,21 +106,22 @@ HELP;
                        $db_user = $this->getOption(['U', 'dbuser'], ($save_db) ? getenv('MYSQL_USER') . getenv('MYSQL_USERNAME') : '');
                        $db_pass = $this->getOption(['P', 'dbpass'], ($save_db) ? getenv('MYSQL_PASSWORD') : '');
                        $url_path = $this->getOption(['u', 'urlpath'], (!empty('FRIENDICA_URL_PATH')) ? getenv('FRIENDICA_URL_PATH') : null);
-                       $php_path = $this->getOption(['b', 'phppath'], (!empty('FRIENDICA_PHP_PATH')) ? getenv('FRIENDICA_PHP_PATH') : '');
+                       $php_path = $this->getOption(['b', 'phppath'], (!empty('FRIENDICA_PHP_PATH')) ? getenv('FRIENDICA_PHP_PATH') : null);
                        $admin_mail = $this->getOption(['A', 'admin'], (!empty('FRIENDICA_ADMIN_MAIL')) ? getenv('FRIENDICA_ADMIN_MAIL') : '');
                        $tz = $this->getOption(['T', 'tz'], (!empty('FRIENDICA_TZ')) ? getenv('FRIENDICA_TZ') : '');
                        $lang = $this->getOption(['L', 'lang'], (!empty('FRIENDICA_LANG')) ? getenv('FRIENDICA_LANG') : '');
 
-                       Install::createConfig(
+                       $install->createConfig(
+                               $php_path,
                                $url_path,
                                ((!empty($db_port)) ? $db_host . ':' . $db_port : $db_host),
                                $db_user,
                                $db_pass,
                                $db_data,
-                               $php_path,
                                $tz,
                                $lang,
-                               $admin_mail
+                               $admin_mail,
+                               $a->getBasePath()
                        );
                }
 
@@ -129,7 +131,10 @@ HELP;
                $this->out("Checking basic setup...\n");
 
                $checkResults = [];
-               $checkResults['basic'] = $this->runBasicChecks($a);
+
+               $this->runBasicChecks($install);
+
+               $checkResults['basic'] = $install->getChecks();
                $errorMessage = $this->extractErrors($checkResults['basic']);
 
                if ($errorMessage !== '') {
@@ -154,7 +159,7 @@ HELP;
                // Install database
                $this->out("Inserting data into database...\n");
 
-               $checkResults['data'] = Install::installDatabaseStructure();
+               $checkResults['data'] = DBStructure::update(false, true, true);
 
                if ($checkResults['data'] !== '') {
                        throw new RuntimeException("ERROR: DB Database creation error. Is the DB empty?\n");
@@ -177,28 +182,26 @@ HELP;
        }
 
        /**
-        * @param App $app
-        * @return array
+        * @param Install $install the Installer instance
         */
-       private function runBasicChecks($app)
+       private function runBasicChecks($install)
        {
-               $checks = [];
-
-               Install::checkFunctions($checks);
-               Install::checkImagick($checks);
-               Install::checkLocalIni($checks);
-               Install::checkSmarty3($checks);
-               Install::checkKeys($checks);
+               $install->resetChecks();
+               $install->checkFunctions();
+               $install->checkImagick();
+               $install->checkLocalIni();
+               $install->checkSmarty3();
+               $install->checkKeys();
 
                if (!empty(Config::get('config', 'php_path'))) {
-                       Install::checkPHP(Config::get('config', 'php_path'), $checks);
+                       if (!$install->checkPHP(Config::get('config', 'php_path'), true)) {
+                               throw new RuntimeException(" ERROR: The php_path is not valid in the config.\n");
+                       }
                } else {
                        throw new RuntimeException(" ERROR: The php_path is not set in the config.\n");
                }
 
                $this->out(" NOTICE: Not checking .htaccess/URL-Rewrite during CLI installation.\n");
-
-               return $checks;
        }
 
        /**
@@ -206,6 +209,7 @@ HELP;
         * @param $db_user
         * @param $db_pass
         * @param $db_data
+        *
         * @return array
         */
        private function runDatabaseCheck($db_host, $db_user, $db_pass, $db_data)
index 3ba683a56fb4540a4cc11e06ee09bb5a6225abaa..15983b719f38c0ecb243efcf674918cab4655d64 100644 (file)
@@ -6,52 +6,90 @@ namespace Friendica\Core;
 
 use DOMDocument;
 use Exception;
-use Friendica\BaseObject;
-use Friendica\Database\DBStructure;
 use Friendica\Object\Image;
 use Friendica\Util\Network;
 
 /**
  * Contains methods for installation purpose of Friendica
  */
-class Install extends BaseObject
+class Install
 {
        /**
-        * Checks the current installation environment. There are optional and mandatory checks.
+        * @var array the check outcomes
+        */
+       private $checks;
+
+       /**
+        * Returns all checks made
         *
-        * @param string $phpath Optional path to the PHP binary (Default is 'php')
+        * @return array the checks
+        */
+       public function getChecks()
+       {
+               return $this->checks;
+       }
+
+       /**
+        * Resets all checks
+        */
+       public function resetChecks()
+       {
+               $this->checks = [];
+       }
+
+       /**
+        * Install constructor.
         *
-        * @return array First element is a list of all checks and their results,
-        *               the second element is a list of passed checks
         */
-       public static function check($phpath = 'php')
+       public function __construct()
        {
-               $checks = [];
+               $this->checks = [];
+       }
 
-               self::checkFunctions($checks);
+       /**
+        * Checks the current installation environment. There are optional and mandatory checks.
+        *
+        * @param string $basepath    The basepath of Friendica
+        * @param string $baseurl     The baseurl of Friendica
+        * @param string $phpath      Optional path to the PHP binary
+        *
+        * @return bool if the check succeed
+        */
+       public function checkAll($basepath, $baseurl, $phpath = null)
+       {
+               $returnVal = true;
 
-               self::checkImagick($checks);
+               if (isset($phpath)) {
+                       if (!$this->checkPHP($phpath)) {
+                               $returnVal = false;
+                       }
+               }
 
-               self::checkLocalIni($checks);
+               if (!$this->checkFunctions()) {
+                       $returnVal = false;
+               }
 
-               self::checkSmarty3($checks);
+               if (!$this->checkImagick()) {
+                       $returnVal = false;
+               }
 
-               self::checkKeys($checks);
+               if (!$this->checkLocalIni()) {
+                       $returnVal = false;
+               }
 
-               self::checkPHP($phpath, $checks);
+               if (!$this->checkSmarty3()) {
+                       $returnVal = false;
+               }
 
-               self::checkHtAccess($checks);
+               if (!$this->checkKeys()) {
+                       $returnVal = false;
+               }
 
-               $checkspassed = array_reduce($checks,
-                       function ($v, $c) {
-                               if (!empty($c['require'])) {
-                                       $v = $v && $c['status'];
-                               }
-                               return $v;
-                       },
-                       true);
+               if (!$this->checkHtAccess($basepath, $baseurl)) {
+                       $returnVal = false;
+               }
 
-               return array($checks, $checkspassed);
+               return $returnVal;
        }
 
        /**
@@ -64,15 +102,19 @@ class Install extends BaseObject
         * @param string        $dbuser         Username of the Database connection credentials
         * @param string        $dbpass         Password of the Database connection credentials
         * @param string        $dbdata         Name of the Database
-        * @param string        $phpath         Path to the PHP-Binary (e.g. 'php' or '/usr/bin/php')
         * @param string        $timezone       Timezone of the Friendica Installaton (e.g. 'Europe/Berlin')
         * @param string        $language       2-letter ISO 639-1 code (eg. 'en')
         * @param string        $adminmail      Mail-Adress of the administrator
+        * @param string        $basepath   The basepath of Friendica
+        * @param string        $phpath         Path to the PHP-Binary (optional, if not set e.g. 'php' or '/usr/bin/php')
+        *
+        * @return bool|string true if the config was created, the text if something went wrong
         */
-       public static function createConfig($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail)
+       public function createConfig($phppath, $urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $timezone, $language, $adminmail, $basepath)
        {
                $tpl = get_markup_template('local.ini.tpl');
                $txt = replace_macros($tpl,[
+                       '$phpath' => $phppath,
                        '$dbhost' => $dbhost,
                        '$dbuser' => $dbuser,
                        '$dbpass' => $dbpass,
@@ -80,37 +122,36 @@ class Install extends BaseObject
                        '$timezone' => $timezone,
                        '$language' => $language,
                        '$urlpath' => $urlpath,
-                       '$phpath' => $phpath,
                        '$adminmail' => $adminmail,
                ]);
 
-               $app = self::getApp();
+               $result = file_put_contents($basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php', $txt);
 
-               $result = file_put_contents($app->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php', $txt);
                if (!$result) {
-                       $app->data['txt'] = $txt;
+                       return $txt;
+               } else {
+                       return true;
                }
        }
 
        /**
         * Adds new checks to the array $checks
         *
-        * @param array $checks The list of all checks (by-ref parameter!)
         * @param string $title The title of the current check
         * @param bool $status 1 = check passed, 0 = check not passed
         * @param bool $required 1 = check is mandatory, 0 = check is optional
         * @param string $help A help-string for the current check
         * @param string $error_msg Optional. A error message, if the current check failed
         */
-       private static function addCheck(&$checks, $title, $status, $required, $help, $error_msg = "")
+       private function addCheck($title, $status, $required, $help, $error_msg = "")
        {
-               $checks[] = [
+               array_push($this->checks, [
                        'title' => $title,
                        'status' => $status,
                        'required' => $required,
                        'help' => $help,
                        'error_msg' => $error_msg,
-               ];
+               ]);
        }
 
        /**
@@ -122,18 +163,21 @@ class Install extends BaseObject
         * - Checks if it is the CLI version
         * - Checks if "register_argc_argv" is enabled
         *
-        * @param string $phpath Optional. The Path to the PHP-Binary
-        * @param array $checks The list of all checks (by-ref parameter!)
+        * @param string $phppath Optional. The Path to the PHP-Binary
+        * @param bool   $required Optional. If set to true, the PHP-Binary has to exist (Default false)
+        *
+        * @return bool false if something required failed
         */
-       public static function checkPHP($phpath, &$checks)
+       public function checkPHP($phppath = null, $required = false)
        {
                $passed = $passed2 = $passed3 = false;
-               if (strlen($phpath)) {
-                       $passed = file_exists($phpath);
+               if (isset($phppath)) {
+                       $passed = file_exists($phppath);
                } else {
-                       $phpath = trim(shell_exec('which php'));
-                       $passed = strlen($phpath);
+                       $phppath = trim(shell_exec('which php'));
+                       $passed = strlen($phppath);
                }
+
                $help = "";
                if (!$passed) {
                        $help .= L10n::t('Could not find a command line version of PHP in the web server PATH.') . EOL;
@@ -141,15 +185,15 @@ class Install extends BaseObject
                        $help .= EOL . EOL;
                        $tpl = get_markup_template('field_input.tpl');
                        $help .= replace_macros($tpl, [
-                               '$field' => ['phpath', L10n::t('PHP executable path'), $phpath, L10n::t('Enter full path to php executable. You can leave this blank to continue the installation.')],
+                               '$field' => ['phpath', L10n::t('PHP executable path'), $phppath, L10n::t('Enter full path to php executable. You can leave this blank to continue the installation.')],
                        ]);
-                       $phpath = "";
+                       $phppath = "";
                }
 
-               self::addCheck($checks, L10n::t('Command line PHP').($passed?" (<tt>$phpath</tt>)":""), $passed, false, $help);
+               self::addCheck(L10n::t('Command line PHP') . ($passed ? " (<tt>$phppath</tt>)" : ""), $passed, false, $help);
 
                if ($passed) {
-                       $cmd = "$phpath -v";
+                       $cmd = "$phppath -v";
                        $result = trim(shell_exec($cmd));
                        $passed2 = (strpos($result, "(cli)") !== false);
                        list($result) = explode("\n", $result);
@@ -158,21 +202,30 @@ class Install extends BaseObject
                                $help .= L10n::t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29") . EOL;
                                $help .= L10n::t('Found PHP version: ') . "<tt>$result</tt>";
                        }
-                       self::addCheck($checks, L10n::t('PHP cli binary'), $passed2, true, $help);
+                       self::addCheck(L10n::t('PHP cli binary'), $passed2, true, $help);
+               } else {
+                       // return if it was required
+                       return $required;
                }
 
                if ($passed2) {
                        $str = autoname(8);
-                       $cmd = "$phpath testargs.php $str";
+                       $cmd = "$phppath testargs.php $str";
                        $result = trim(shell_exec($cmd));
                        $passed3 = $result == $str;
                        $help = "";
                        if (!$passed3) {
                                $help .= L10n::t('The command line version of PHP on your system does not have "register_argc_argv" enabled.') . EOL;
                                $help .= L10n::t('This is required for message delivery to work.');
+                       } else {
+                               $this->phppath = $phppath;
                        }
-                       self::addCheck($checks, L10n::t('PHP register_argc_argv'), $passed3, true, $help);
+
+                       self::addCheck(L10n::t('PHP register_argc_argv'), $passed3, true, $help);
                }
+
+               // passed2 & passed3 are required if first check passed
+               return $passed2 && $passed3;
        }
 
        /**
@@ -182,12 +235,13 @@ class Install extends BaseObject
         *
         * - Checks, if the command "openssl_pkey_new" is available
         *
-        * @param array $checks The list of all checks (by-ref parameter!)
+        * @return bool false if something required failed
         */
-       public static function checkKeys(&$checks)
+       public function checkKeys()
        {
                $help = '';
                $res = false;
+               $status = true;
 
                if (function_exists('openssl_pkey_new')) {
                        $res = openssl_pkey_new([
@@ -201,8 +255,34 @@ class Install extends BaseObject
                if (!$res) {
                        $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys') . EOL;
                        $help .= L10n::t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');
+                       $status = false;
+               }
+               $this->addCheck(L10n::t('Generate encryption keys'), $res, true, $help);
+
+               return $status;
+       }
+
+       /**
+        * PHP basic function check
+        *
+        * @param string $name The name of the function
+        * @param string $title The (localized) title of the function
+        * @param string $help The (localized) help of the function
+        * @param boolean $required If true, this check is required
+        *
+        * @return bool false, if the check failed
+        */
+       private function checkFunction($name, $title, $help, $required)
+       {
+               $currHelp = '';
+               $status = true;
+               if (!function_exists($name)) {
+                       $currHelp = $help;
+                       $status = false;
                }
-               self::addCheck($checks, L10n::t('Generate encryption keys'), $res, true, $help);
+               $this->addCheck($title, $status, $required, $currHelp);
+
+               return $status || (!$status && !$required);
        }
 
        /**
@@ -218,70 +298,93 @@ class Install extends BaseObject
         * - iconv
         * - POSIX
         *
-        * @param array $checks The list of all checks (by-ref parameter!)
+        * @return bool false if something required failed
         */
-       public static function checkFunctions(&$checks)
+       public function checkFunctions()
        {
-               $ck_funcs = [];
-               self::addCheck($ck_funcs, L10n::t('libCurl PHP module'), true, true, "");
-               self::addCheck($ck_funcs, L10n::t('GD graphics PHP module'), true, true, "");
-               self::addCheck($ck_funcs, L10n::t('OpenSSL PHP module'), true, true, "");
-               self::addCheck($ck_funcs, L10n::t('PDO or MySQLi PHP module'), true, true, "");
-               self::addCheck($ck_funcs, L10n::t('mb_string PHP module'), true, true, "");
-               self::addCheck($ck_funcs, L10n::t('XML PHP module'), true, true, "");
-               self::addCheck($ck_funcs, L10n::t('iconv PHP module'), true, true, "");
-               self::addCheck($ck_funcs, L10n::t('POSIX PHP module'), true, true, "");
+               $returnVal = true;
 
+               $help = '';
+               $status = true;
                if (function_exists('apache_get_modules')) {
-                       if (! in_array('mod_rewrite',apache_get_modules())) {
-                               self::addCheck($ck_funcs, L10n::t('Apache mod_rewrite module'), false, true, L10n::t('Error: Apache webserver mod-rewrite module is required but not installed.'));
-                       } else {
-                               self::addCheck($ck_funcs, L10n::t('Apache mod_rewrite module'), true, true, "");
+                       if (!in_array('mod_rewrite', apache_get_modules())) {
+                               $help = L10n::t('Error: Apache webserver mod-rewrite module is required but not installed.');
+                               $status = false;
+                               $returnVal = false;
                        }
                }
+               $this->addCheck(L10n::t('Apache mod_rewrite module'), $status, true, $help);
 
-               if (!function_exists('curl_init')) {
-                       $ck_funcs[0]['status'] = false;
-                       $ck_funcs[0]['help'] = L10n::t('Error: libCURL PHP module required but not installed.');
-               }
-               if (!function_exists('imagecreatefromjpeg')) {
-                       $ck_funcs[1]['status'] = false;
-                       $ck_funcs[1]['help'] = L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.');
-               }
-               if (!function_exists('openssl_public_encrypt')) {
-                       $ck_funcs[2]['status'] = false;
-                       $ck_funcs[2]['help'] = L10n::t('Error: openssl PHP module required but not installed.');
-               }
+               $help = '';
+               $status = true;
                if (!function_exists('mysqli_connect') && !class_exists('pdo')) {
-                       $ck_funcs[3]['status'] = false;
-                       $ck_funcs[3]['help'] = L10n::t('Error: PDO or MySQLi PHP module required but not installed.');
-               }
-               if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', \PDO::getAvailableDrivers())) {
-                       $ck_funcs[3]['status'] = false;
-                       $ck_funcs[3]['help'] = L10n::t('Error: The MySQL driver for PDO is not installed.');
-               }
-               if (!function_exists('mb_strlen')) {
-                       $ck_funcs[4]['status'] = false;
-                       $ck_funcs[4]['help'] = L10n::t('Error: mb_string PHP module required but not installed.');
-               }
-               if (!function_exists('iconv_strlen')) {
-                       $ck_funcs[6]['status'] = false;
-                       $ck_funcs[6]['help'] = L10n::t('Error: iconv PHP module required but not installed.');
-               }
-               if (!function_exists('posix_kill')) {
-                       $ck_funcs[7]['status'] = false;
-                       $ck_funcs[7]['help'] = L10n::t('Error: POSIX PHP module required but not installed.');
+                       $status = false;
+                       $help = L10n::t('Error: PDO or MySQLi PHP module required but not installed.');
+                       $returnVal = false;
+               } else {
+                       if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', \PDO::getAvailableDrivers())) {
+                               $status = false;
+                               $help = L10n::t('Error: The MySQL driver for PDO is not installed.');
+                               $returnVal = false;
+                       }
                }
-
-               $checks = array_merge($checks, $ck_funcs);
+               $this->addCheck(L10n::t('PDO or MySQLi PHP module'), $status, true, $help);
 
                // check for XML DOM Documents being able to be generated
+               $help = '';
+               $status = true;
                try {
                        $xml = new DOMDocument();
                } catch (Exception $e) {
-                       $ck_funcs[5]['status'] = false;
-                       $ck_funcs[5]['help'] = L10n::t('Error, XML PHP module required but not installed.');
+                       $help = L10n::t('Error, XML PHP module required but not installed.');
+                       $status = false;
+                       $returnVal = false;
                }
+               $this->addCheck(L10n::t('XML PHP module'), $status, true, $help);
+
+               $status = $this->checkFunction('curl_init',
+                       L10n::t('libCurl PHP module'),
+                       L10n::t('Error: libCURL PHP module required but not installed.'),
+                       true
+               );
+               $returnVal = $returnVal ? $status : false;
+
+               $status = $this->checkFunction('imagecreatefromjpeg',
+                       L10n::t('GD graphics PHP module'),
+                       L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.'),
+                       true
+               );
+               $returnVal = $returnVal ? $status : false;
+
+               $status = $this->checkFunction('openssl_public_encrypt',
+                       L10n::t('OpenSSL PHP module'),
+                       L10n::t('Error: openssl PHP module required but not installed.'),
+                       true
+               );
+               $returnVal = $returnVal ? $status : false;
+
+               $status = $this->checkFunction('mb_strlen',
+                       L10n::t('mb_string PHP module'),
+                       L10n::t('Error: mb_string PHP module required but not installed.'),
+                       true
+               );
+               $returnVal = $returnVal ? $status : false;
+
+               $status = $this->checkFunction('iconv_strlen',
+                       L10n::t('iconv PHP module'),
+                       L10n::t('Error: iconv PHP module required but not installed.'),
+                       true
+               );
+               $returnVal = $returnVal ? $status : false;
+
+               $status = $this->checkFunction('posix_kill',
+                       L10n::t('POSIX PHP module'),
+                       L10n::t('Error: POSIX PHP module required but not installed.'),
+                       true
+               );
+               $returnVal = $returnVal ? $status : false;
+
+               return $returnVal;
        }
 
        /**
@@ -289,9 +392,9 @@ class Install extends BaseObject
         *
         * Checks if it's possible to create the "config/local.ini.php"
         *
-        * @param array $checks The list of all checks (by-ref parameter!)
+        * @return bool false if something required failed
         */
-       public static function checkLocalIni(&$checks)
+       public function checkLocalIni()
        {
                $status = true;
                $help = "";
@@ -305,8 +408,10 @@ class Install extends BaseObject
                        $help .= L10n::t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.') . EOL;
                }
 
-               self::addCheck($checks, L10n::t('config/local.ini.php is writable'), $status, false, $help);
+               self::addCheck(L10n::t('config/local.ini.php is writable'), $status, false, $help);
 
+               // Local INI File is not required
+               return true;
        }
 
        /**
@@ -314,9 +419,9 @@ class Install extends BaseObject
         *
         * Checks, if the directory of Smarty3 is writable
         *
-        * @param array $checks The list of all checks (by-ref parameter!)
+        * @return bool false if something required failed
         */
-       public static function checkSmarty3(&$checks)
+       public function checkSmarty3()
        {
                $status = true;
                $help = "";
@@ -329,7 +434,9 @@ class Install extends BaseObject
                        $help .= L10n::t("Note: as a security measure, you should give the web server write access to view/smarty3/ only--not the template files \x28.tpl\x29 that it contains.") . EOL;
                }
 
-               self::addCheck($checks, L10n::t('view/smarty3 is writable'), $status, true, $help);
+               $this->addCheck(L10n::t('view/smarty3 is writable'), $status, true, $help);
+
+               return $status;
        }
 
        /**
@@ -337,17 +444,19 @@ class Install extends BaseObject
         *
         * Checks, if "url_rewrite" is enabled in the ".htaccess" file
         *
-        * @param array $checks The list of all checks (by-ref parameter!)
+        * @param string $basepath   The basepath of the app
+        * @param string $baseurl    The baseurl of the app
+        * @return bool false if something required failed
         */
-       public static function checkHtAccess(&$checks)
+       public function checkHtAccess($basepath, $baseurl)
        {
                $status = true;
                $help = "";
                $error_msg = "";
                if (function_exists('curl_init')) {
-                       $fetchResult = Network::fetchUrlFull(System::baseUrl() . "/install/testrewrite");
+                       $fetchResult = Network::fetchUrlFull($basepath . "/install/testrewrite");
 
-                       $url = normalise_link(System::baseUrl() . "/install/testrewrite");
+                       $url = normalise_link($baseurl . "/install/testrewrite");
                        if ($fetchResult->getBody() != "ok") {
                                $fetchResult = Network::fetchUrlFull($url);
                        }
@@ -360,11 +469,14 @@ class Install extends BaseObject
                                $error_msg['url'] = $fetchResult->getRedirectUrl();
                                $error_msg['msg'] = $fetchResult->getError();
                        }
-                       self::addCheck($checks, L10n::t('Url rewrite is working'), $status, true, $help, $error_msg);
+
+                       $this->addCheck(L10n::t('Url rewrite is working'), $status, true, $help, $error_msg);
                } else {
                        // cannot check modrewrite if libcurl is not installed
                        /// @TODO Maybe issue warning here?
                }
+
+               return $status;
        }
 
        /**
@@ -372,9 +484,9 @@ class Install extends BaseObject
         *
         * Checks, if the imagick module is available
         *
-        * @param array $checks The list of all checks (by-ref parameter!)
+        * @return bool false if something required failed
         */
-       public static function checkImagick(&$checks)
+       public function checkImagick()
        {
                $imagick = false;
                $gif = false;
@@ -386,25 +498,16 @@ class Install extends BaseObject
                                $gif = true;
                        }
                }
-               if ($imagick == false) {
-                       self::addCheck($checks, L10n::t('ImageMagick PHP extension is not installed'), $imagick, false, "");
+               if (!$imagick) {
+                       $this->addCheck(L10n::t('ImageMagick PHP extension is not installed'), $imagick, false, "");
                } else {
-                       self::addCheck($checks, L10n::t('ImageMagick PHP extension is installed'), $imagick, false, "");
+                       $this->addCheck(L10n::t('ImageMagick PHP extension is installed'), $imagick, false, "");
                        if ($imagick) {
-                               self::addCheck($checks, L10n::t('ImageMagick supports GIF'), $gif, false, "");
+                               $this->addCheck(L10n::t('ImageMagick supports GIF'), $gif, false, "");
                        }
                }
-       }
-
-       /**
-        * Installs the Database structure
-        *
-        * @return string A possible error
-        */
-       public static function installDatabaseStructure()
-       {
-               $errors = DBStructure::update(false, true, true);
 
-               return $errors;
+               // Imagick is not required
+               return true;
        }
 }
index f83edd88daf7a5555899b6e922cbfe764a0fd070..290d3ed0428dce6fe98f3725387441cc51d66560 100644 (file)
@@ -219,7 +219,7 @@ CONF;
                $this->assertConfig('config', 'admin_email', 'admin@friendica.local');
                $this->assertConfig('system', 'default_timezone', 'Europe/Berlin');
                $this->assertConfig('system', 'language', 'de');
-               $this->assertConfig('system', 'url_path', '/friendica');
+               $this->assertConfig('system', 'urlpath', '/friendica');
        }
 
        /**
@@ -265,14 +265,18 @@ CONF;
                $this->assertConfig('config', 'admin_email', 'admin@friendica.local');
                $this->assertConfig('system', 'default_timezone', 'Europe/Berlin');
                $this->assertConfig('system', 'language', 'de');
-               $this->assertConfig('system', 'url_path', '/friendica');
+               $this->assertConfig('system', 'urlpath', '/friendica');
        }
 
+       /**
+        * @runTestsInSeparateProcesses
+        */
        public function testNoDatabaseConnection()
        {
-               $this->assertTrue(putenv('MYSQL_USERNAME='));
-               $this->assertTrue(putenv('MYSQL_PASSWORD='));
-               $this->assertTrue(putenv('MYSQL_DATABASE='));
+               $dbaMock = \Mockery::mock('alias:Friendica\Database\DBA');
+               $dbaMock
+                       ->shouldReceive('connected')
+                       ->andReturn(false);
 
                $txt = $this->execute(['autoinstall']);
 
@@ -304,7 +308,7 @@ Options
     -d|--dbdata <database>  The name of the mysql/mariadb database (env MYSQL_DATABASE)
     -U|--dbuser <username>  The username of the mysql/mariadb database login (env MYSQL_USER or MYSQL_USERNAME)
     -P|--dbpass <password>  The password of the mysql/mariadb database login (env MYSQL_PASSWORD)
-    -b|--urlpath <url_path> The URL path of Friendica - f.e. '/friendica' (env FRIENDICA_URL_PATH) 
+    -u|--urlpath <url_path> The URL path of Friendica - f.e. '/friendica' (env FRIENDICA_URL_PATH) 
     -b|--phppath <php_path> The path of the PHP binary (env FRIENDICA_PHP_PATH) 
     -A|--admin <mail>       The admin email address of Friendica (env FRIENDICA_ADMIN_MAIL)
     -T|--tz <timezone>      The timezone of Friendica (env FRIENDICA_TZ)
index 40f864e3b97114e653abdaec17ff6c962bbfd1cd..75f339e8f5ddba2ae15148bbf1a9c7be00c6b536 100644 (file)
@@ -50,7 +50,6 @@ abstract class ConsoleTest extends TestCase
        }
 
        public function execute($args) {
-               DBA::disconnect();
                $this->app->reload();
 
                array_unshift($args, $this->getExecutablePath());
diff --git a/tests/src/Core/InstallTest.php b/tests/src/Core/InstallTest.php
new file mode 100644 (file)
index 0000000..da92a0e
--- /dev/null
@@ -0,0 +1,306 @@
+<?php
+
+// this is in the same namespace as Install for mocking 'function_exists'
+namespace Friendica\Core;
+
+use Friendica\Test\Util\VFSTrait;
+use PHPUnit\Framework\TestCase;
+
+class InstallTest extends TestCase
+{
+       use VFSTrait;
+
+       public function setUp()
+       {
+               parent::setUp(); // TODO: Change the autogenerated stub
+
+               $this->setUpVfsDir();
+       }
+
+       private function assertCheckExist($position, $title, $help, $status, $required, $assertionArray)
+       {
+               $this->assertArraySubset([$position => [
+                       'title' => $title,
+                       'status' => $status,
+                       'required' => $required,
+                       'error_msg' => null,
+                       'help' => $help]
+               ], $assertionArray);
+       }
+
+       /**
+        * Replaces function_exists results with given mocks
+        *
+        * @param array $functions a list from function names and their result
+        */
+       private function setFunctions($functions)
+       {
+               global $phpMock;
+               $phpMock['function_exists'] = function($function) use ($functions) {
+                       foreach ($functions as $name => $value) {
+                               if ($function == $name) {
+                                       return $value;
+                               }
+                       }
+                       return '__phpunit_continue__';
+               };
+       }
+
+       /**
+        * @small
+        * @runInSeparateProcess
+        */
+       public function testCheckKeys()
+       {
+               $this->setFunctions(['openssl_pkey_new' => false]);
+               $install = new Install();
+               $this->assertFalse($install->checkKeys());
+
+               $this->setFunctions(['openssl_pkey_new' => true]);
+               $install = new Install();
+               $this->assertTrue($install->checkKeys());
+       }
+
+       /**
+        * @small
+        * @runInSeparateProcess
+        */
+       public function testCheckFunctions()
+       {
+               $this->setFunctions(['curl_init' => false]);
+               $install = new Install();
+               $this->assertFalse($install->checkFunctions());
+               $this->assertCheckExist(3,
+                       L10n::t('libCurl PHP module'),
+                       L10n::t('Error: libCURL PHP module required but not installed.'),
+                       false,
+                       true,
+                       $install->getChecks());
+
+               $this->setFunctions(['imagecreatefromjpeg' => false]);
+               $install = new Install();
+               $this->assertFalse($install->checkFunctions());
+               $this->assertCheckExist(4,
+                       L10n::t('GD graphics PHP module'),
+                       L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.'),
+                       false,
+                       true,
+                       $install->getChecks());
+
+               $this->setFunctions(['openssl_public_encrypt' => false]);
+               $install = new Install();
+               $this->assertFalse($install->checkFunctions());
+               $this->assertCheckExist(5,
+                       L10n::t('OpenSSL PHP module'),
+                       L10n::t('Error: openssl PHP module required but not installed.'),
+                       false,
+                       true,
+                       $install->getChecks());
+
+               $this->setFunctions(['mb_strlen' => false]);
+               $install = new Install();
+               $this->assertFalse($install->checkFunctions());
+               $this->assertCheckExist(6,
+                       L10n::t('mb_string PHP module'),
+                       L10n::t('Error: mb_string PHP module required but not installed.'),
+                       false,
+                       true,
+                       $install->getChecks());
+
+               $this->setFunctions(['iconv_strlen' => false]);
+               $install = new Install();
+               $this->assertFalse($install->checkFunctions());
+               $this->assertCheckExist(7,
+                       L10n::t('iconv PHP module'),
+                       L10n::t('Error: iconv PHP module required but not installed.'),
+                       false,
+                       true,
+                       $install->getChecks());
+
+               $this->setFunctions(['posix_kill' => false]);
+               $install = new Install();
+               $this->assertFalse($install->checkFunctions());
+               $this->assertCheckExist(8,
+                       L10n::t('POSIX PHP module'),
+                       L10n::t('Error: POSIX PHP module required but not installed.'),
+                       false,
+                       true,
+                       $install->getChecks());
+
+               $this->setFunctions([
+                       'curl_init' => true,
+                       'imagecreatefromjpeg' => true,
+                       'openssl_public_encrypt' => true,
+                       'mb_strlen' => true,
+                       'iconv_strlen' => true,
+                       'posix_kill' => true
+               ]);
+               $install = new Install();
+               $this->assertTrue($install->checkFunctions());
+       }
+
+       /**
+        * @small
+        * @runInSeparateProcess
+        */
+       public function testCheckLocalIni()
+       {
+               $this->assertTrue($this->root->hasChild('config/local.ini.php'));
+
+               $install = new Install();
+               $this->assertTrue($install->checkLocalIni());
+
+               $this->delConfigFile('local.ini.php');
+
+               $this->assertFalse($this->root->hasChild('config/local.ini.php'));
+
+               $install = new Install();
+               $this->assertTrue($install->checkLocalIni());
+       }
+
+       /**
+        * @small
+        * @runInSeparateProcess
+        */
+       public function testCheckHtAccessFail()
+       {
+               // Mocking the CURL Response
+               $curlResult = \Mockery::mock('Friendica\Network\CurlResult');
+               $curlResult
+                       ->shouldReceive('getBody')
+                       ->andReturn('not ok');
+               $curlResult
+                       ->shouldReceive('getRedirectUrl')
+                       ->andReturn('');
+               $curlResult
+                       ->shouldReceive('getError')
+                       ->andReturn('test Error');
+
+               // Mocking the CURL Request
+               $networkMock = \Mockery::mock('alias:Friendica\Util\Network');
+               $networkMock
+                       ->shouldReceive('fetchUrlFull')
+                       ->with('https://test/install/testrewrite')
+                       ->andReturn($curlResult);
+               $networkMock
+                       ->shouldReceive('fetchUrlFull')
+                       ->with('http://test/install/testrewrite')
+                       ->andReturn($curlResult);
+
+               // Mocking that we can use CURL
+               $this->setFunctions(['curl_init' => true]);
+
+               // needed because of "normalise_link"
+               require_once __DIR__ . '/../../../include/text.php';
+
+               $install = new Install();
+
+               $this->assertFalse($install->checkHtAccess('https://test', 'https://test'));
+               $this->assertSame('test Error', $install->getChecks()[0]['error_msg']['msg']);
+       }
+
+       /**
+        * @small
+        * @runInSeparateProcess
+        */
+       public function testCheckHtAccessWork()
+       {
+               // Mocking the failed CURL Response
+               $curlResultF = \Mockery::mock('Friendica\Network\CurlResult');
+               $curlResultF
+                       ->shouldReceive('getBody')
+                       ->andReturn('not ok');
+
+               // Mocking the working CURL Response
+               $curlResultW = \Mockery::mock('Friendica\Network\CurlResult');
+               $curlResultW
+                       ->shouldReceive('getBody')
+                       ->andReturn('ok');
+
+               // Mocking the CURL Request
+               $networkMock = \Mockery::mock('alias:Friendica\Util\Network');
+               $networkMock
+                       ->shouldReceive('fetchUrlFull')
+                       ->with('https://test/install/testrewrite')
+                       ->andReturn($curlResultF);
+               $networkMock
+                       ->shouldReceive('fetchUrlFull')
+                       ->with('http://test/install/testrewrite')
+                       ->andReturn($curlResultW);
+
+               // Mocking that we can use CURL
+               $this->setFunctions(['curl_init' => true]);
+
+               // needed because of "normalise_link"
+               require_once __DIR__ . '/../../../include/text.php';
+
+               $install = new Install();
+
+               $this->assertTrue($install->checkHtAccess('https://test', 'https://test'));
+       }
+
+       /**
+        * @small
+        * @runInSeparateProcess
+        */
+       public function testImagick()
+       {
+               $imageMock = \Mockery::mock('alias:Friendica\Object\Image');
+               $imageMock
+                       ->shouldReceive('supportedTypes')
+                       ->andReturn(['image/gif' => 'gif']);
+
+               $install = new Install();
+
+               // even there is no supported type, Imagick should return true (because it is not required)
+               $this->assertTrue($install->checkImagick());
+               $this->assertCheckExist(1,
+                       L10n::t('ImageMagick supports GIF'),
+                       '',
+                       true,
+                       false,
+                       $install->getChecks());
+       }
+
+       /**
+        * @small
+        * @runInSeparateProcess
+        */
+       public function testImagickNotFound()
+       {
+               $imageMock = \Mockery::mock('alias:Friendica\Object\Image');
+               $imageMock
+                       ->shouldReceive('supportedTypes')
+                       ->andReturn([]);
+
+               $install = new Install();
+
+               // even there is no supported type, Imagick should return true (because it is not required)
+               $this->assertTrue($install->checkImagick());
+               $this->assertCheckExist(1,
+                       L10n::t('ImageMagick supports GIF'),
+                       '',
+                       false,
+                       false,
+                       $install->getChecks());
+       }
+}
+
+/**
+ * A workaround to replace the PHP native function_exists with a mocked function
+ *
+ * @param string $function_name the Name of the function
+ *
+ * @return bool true or false
+ */
+function function_exists($function_name)
+{
+       global $phpMock;
+       if (isset($phpMock['function_exists'])) {
+               $result = call_user_func_array($phpMock['function_exists'], func_get_args());
+               if ($result !== '__phpunit_continue__') {
+                       return $result;
+               }
+       }
+       return call_user_func_array('\function_exists', func_get_args());
+}