Add Install Mode

- added PHP docBlock to methods
- increased code quality

diff --git a/src/Core/Console/AutomaticInstallation.php b/src/Core/Console/AutomaticInstallation.php
index e08491b805fd4c1fe3bb641bed14ddd403adf77d..e888d5a4908cded5b7d018271d24457868329dd5 100644 (file)
--- a/src/Core/Console/AutomaticInstallation.php
+++ b/src/Core/Console/AutomaticInstallation.php
@@ -8,6 +8,7 @@ use Friendica\App;
 use Friendica\Core\Install;
 
 require_once 'mod/install.php';
+require_once 'include/dba.php';
 
 class AutomaticInstallation extends Console
 {
@@ -76,7 +77,7 @@ HELP;
                // Install database
                $this->out("Inserting data into database...\n");
 
-               $checkResults['data'] = Install::loadDatabase();
+               $checkResults['data'] = Install::installDatabaseStructure();
 
                if ($checkResults['data'] !== '') {
                        throw new \RuntimeException("ERROR: DB Database creation error. Is the DB empty?\n");
@@ -104,7 +105,7 @@ HELP;
                $checks = [];
 
                Install::checkFunctions($checks);
-               Install::checkImagik($checks);
+               Install::checkImagick($checks);
                Install::checkHtConfig($checks);
                Install::checkSmarty3($checks);
                Install::checkKeys($checks);

diff --git a/src/Core/Install.php b/src/Core/Install.php
index 8dd354eb91b291da750531b70110a23cc601127c..f23254f465bc3b802e3c591f37c258dea3782a05 100644 (file)
--- a/src/Core/Install.php
+++ b/src/Core/Install.php
@@ -14,22 +14,33 @@ use Exception;
 use DOMDocument;\r
 \r
 /**\r
- * @brief Contains the class with install relevant stuff *\r
+ * Contains methods for installation purpose of Friendica\r
  */\r
 class Install extends BaseObject\r
 {\r
+       /**\r
+        * Sets the install-mode for further methods\r
+        */\r
        public static function setInstallMode()\r
        {\r
                self::getApp()->mode = App::MODE_INSTALL;\r
        }\r
 \r
+       /**\r
+        * Checks the current installation environment. There are optional and mandatory checks.\r
+        *\r
+        * @param string $phpath Optional path to the PHP binary (Default is 'php')\r
+        *\r
+        * @return array First element is a list of all checks and their results,\r
+        *               the second element is a list of passed checks\r
+        */\r
        public static function check($phpath = 'php')\r
        {\r
                $checks = [];\r
 \r
                self::checkFunctions($checks);\r
 \r
-               self::checkImagik($checks);\r
+               self::checkImagick($checks);\r
 \r
                self::checkHtConfig($checks);\r
 \r
@@ -53,6 +64,22 @@ class Install extends BaseObject
                return array($checks, $checkspassed);\r
        }\r
 \r
+       /**\r
+        * Executes the installation of Friendica in the given environment.\r
+        * - Creates `.htconfig.php`\r
+        * - Installs Database Structure\r
+        *\r
+        * @param string        $urlpath        Path based on the URL of Friendica (e.g. '/friendica')\r
+        * @param string        $dbhost         Hostname/IP of the Friendica Database\r
+        * @param string        $dbuser         Username of the Database connection credentials\r
+        * @param string        $dbpass         Password of the Database connection credentials\r
+        * @param string        $dbdata         Name of the Database\r
+        * @param string        $phpath         Path to the PHP-Binary (e.g. 'php' or '/usr/bin/php')\r
+        * @param string        $timezone       Timezone of the Friendica Installaton (e.g. 'Europe/Berlin')\r
+        * @param string        $language       2-letter ISO 639-1 code (eg. 'en')\r
+        * @param string        $adminmail      Mail-Adress of the administrator\r
+        * @param int           $rino           Rino-enabled (1 = true, 0 = false)\r
+        */\r
        public static function install($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail, $rino = 1)\r
        {\r
                $tpl = get_markup_template('htconfig.tpl');\r
@@ -69,13 +96,12 @@ class Install extends BaseObject
                        '$rino' => $rino\r
                ]);\r
 \r
-\r
                $result = file_put_contents('.htconfig.php', $txt);\r
                if (! $result) {\r
                        self::getApp()->data['txt'] = $txt;\r
                }\r
 \r
-               $errors = self::loadDatabase();\r
+               $errors = self::installDatabaseStructure();\r
 \r
                if ($errors) {\r
                        self::getApp()->data['db_failed'] = $errors;\r
@@ -85,13 +111,16 @@ class Install extends BaseObject
        }\r
 \r
        /**\r
-        * checks   : array passed to template\r
-        * title    : string\r
-        * status   : boolean\r
-        * required : boolean\r
-        * help         : string optional\r
+        * Adds new checks to the array $checks\r
+        *\r
+        * @param array $checks The list of all checks (by-ref parameter!)\r
+        * @param string $title The title of the current check\r
+        * @param bool $status 1 = check passed, 0 = check not passed\r
+        * @param bool $required 1 = check is mandatory, 0 = check is optional\r
+        * @param string $help A help-string for the current check\r
+        * @param string $error_msg Optional. A error message, if the current check failed\r
         */\r
-       private static function addCheck(&$checks, $title, $status, $required, $help)\r
+       private static function addCheck(&$checks, $title, $status, $required, $help, $error_msg = "")\r
        {\r
                $checks[] = [\r
                        'title' => $title,\r
@@ -102,6 +131,18 @@ class Install extends BaseObject
                ];\r
        }\r
 \r
+       /**\r
+        * PHP Check\r
+        *\r
+        * Checks the PHP environment.\r
+        *\r
+        * - Checks if a PHP binary is available\r
+        * - Checks if it is the CLI version\r
+        * - Checks if "register_argc_argv" is enabled\r
+        *\r
+        * @param string $phpath Optional. The Path to the PHP-Binary\r
+        * @param array $checks The list of all checks (by-ref parameter!)\r
+        */\r
        public static function checkPHP(&$phpath, &$checks)\r
        {\r
                $passed = $passed2 = $passed3 = false;\r
@@ -138,7 +179,6 @@ class Install extends BaseObject
                        self::addCheck($checks, L10n::t('PHP cli binary'), $passed2, true, $help);\r
                }\r
 \r
-\r
                if ($passed2) {\r
                        $str = autoname(8);\r
                        $cmd = "$phpath testargs.php $str";\r
@@ -151,15 +191,20 @@ class Install extends BaseObject
                        }\r
                        self::addCheck($checks, L10n::t('PHP register_argc_argv'), $passed3, true, $help);\r
                }\r
-\r
-\r
        }\r
 \r
+       /**\r
+        * OpenSSL Check\r
+        *\r
+        * Checks the OpenSSL Environment\r
+        *\r
+        * - Checks, if the command "openssl_pkey_new" is available\r
+        *\r
+        * @param array $checks The list of all checks (by-ref parameter!)\r
+        */\r
        public static function checkKeys(&$checks)\r
        {\r
-\r
                $help = '';\r
-\r
                $res = false;\r
 \r
                if (function_exists('openssl_pkey_new')) {\r
@@ -171,16 +216,28 @@ class Install extends BaseObject
                }\r
 \r
                // Get private key\r
-\r
                if (!$res) {\r
                        $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys') . EOL;\r
                        $help .= L10n::t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');\r
                }\r
                self::addCheck($checks, L10n::t('Generate encryption keys'), $res, true, $help);\r
-\r
        }\r
 \r
-\r
+       /**\r
+        * PHP functions Check\r
+        *\r
+        * Checks the following PHP functions\r
+        * - libCurl\r
+        * - GD Graphics\r
+        * - OpenSSL\r
+        * - PDO or MySQLi\r
+        * - mb_string\r
+        * - XML\r
+        * - iconv\r
+        * - POSIX\r
+        *\r
+        * @param array $checks The list of all checks (by-ref parameter!)\r
+        */\r
        public static function checkFunctions(&$checks)\r
        {\r
                $ck_funcs = [];\r
@@ -245,7 +302,13 @@ class Install extends BaseObject
                }\r
        }\r
 \r
-\r
+       /**\r
+        * ".htconfig.php" - Check\r
+        *\r
+        * Checks if it's possible to create the ".htconfig.php"\r
+        *\r
+        * @param array $checks The list of all checks (by-ref parameter!)\r
+        */\r
        public static function checkHtConfig(&$checks)\r
        {\r
                $status = true;\r
@@ -264,6 +327,13 @@ class Install extends BaseObject
 \r
        }\r
 \r
+       /**\r
+        * Smarty3 Template Check\r
+        *\r
+        * Checks, if the directory of Smarty3 is writable\r
+        *\r
+        * @param array $checks The list of all checks (by-ref parameter!)\r
+        */\r
        public static function checkSmarty3(&$checks)\r
        {\r
                $status = true;\r
@@ -281,6 +351,13 @@ class Install extends BaseObject
 \r
        }\r
 \r
+       /**\r
+        * ".htaccess" - Check\r
+        *\r
+        * Checks, if "url_rewrite" is enabled in the ".htaccess" file\r
+        *\r
+        * @param array $checks The list of all checks (by-ref parameter!)\r
+        */\r
        public static function checkHtAccess(&$checks)\r
        {\r
                $status = true;\r
@@ -302,14 +379,21 @@ class Install extends BaseObject
                                $error_msg['url'] = $test['redirect_url'];\r
                                $error_msg['msg'] = $test['error'];\r
                        }\r
-                       self::addCheck($checks, L10n::t('Url rewrite is working'), $status, true, $help);\r
+                       self::addCheck($checks, L10n::t('Url rewrite is working'), $status, true, $help, $error_msg);\r
                } else {\r
                        // cannot check modrewrite if libcurl is not installed\r
                        /// @TODO Maybe issue warning here?\r
                }\r
        }\r
 \r
-       public static function checkImagik(&$checks)\r
+       /**\r
+        * Imagick Check\r
+        *\r
+        * Checks, if the imagick module is available\r
+        *\r
+        * @param array $checks The list of all checks (by-ref parameter!)\r
+        */\r
+       public static function checkImagick(&$checks)\r
        {\r
                $imagick = false;\r
                $gif = false;\r
@@ -331,7 +415,12 @@ class Install extends BaseObject
                }\r
        }\r
 \r
-       public static function loadDatabase()\r
+       /**\r
+        * Installs the Database structure\r
+        *\r
+        * @return string A possible error\r
+        */\r
+       public static function installDatabaseStructure()\r
        {\r
                $errors = DBStructure::update(false, true, true);\r
 \r