[TASK] centralize error reporting config

[jirafeau_mojo42.git] / install.php

diff --git a/install.php b/install.php
old mode 100755 (executable)
new mode 100644 (file)
index 1d052c1..8d5f6fb
--- a/install.php
+++ b/install.php
@@ -2,6 +2,7 @@
 /*
  *  Jirafeau, your web file repository
  *  Copyright (C) 2008  Julien "axolotl" BERNARD <axolotl@magieeternelle.org>
 /*
  *  Jirafeau, your web file repository
  *  Copyright (C) 2008  Julien "axolotl" BERNARD <axolotl@magieeternelle.org>

+ *  Copyright (C) 2015  Nicola Spanti (RyDroid) <dev@nicola-spanti.info>

  *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU Affero General Public License as
  *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU Affero General Public License as


@@ -14,56 +15,44 @@
  *  GNU Affero General Public License for more details.
  *
  *  You should have received a copy of the GNU Affero General Public License
  *  GNU Affero General Public License for more details.
  *
  *  You should have received a copy of the GNU Affero General Public License

- *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.

  */
  */

-define ('JIRAFEAU_ROOT', dirname (__FILE__) . '/');
-define ('NL', "\n");
-define ('QUOTE', "'");
+define('JIRAFEAU_ROOT', dirname(__FILE__) . '/');

 
 

-define ('JIRAFEAU_CFG', JIRAFEAU_ROOT.'lib/config.local.php');
-define ('JIRAFEAU_VAR_RAND_LENGTH', 15);
+define('JIRAFEAU_CFG', JIRAFEAU_ROOT . 'lib/config.local.php');
+define('JIRAFEAU_VAR_RAND_LENGTH', 15);

 
 

-require (JIRAFEAU_ROOT . 'lib/lang.php');
-require (JIRAFEAU_ROOT . 'lib/config.php');
+require(JIRAFEAU_ROOT . 'lib/settings.php');
+require(JIRAFEAU_ROOT . 'lib/functions.php');
+require(JIRAFEAU_ROOT . 'lib/lang.php');

 
 

-function
-jirafeau_quoted ($str)
+/**
+ * Prepend used functions
+ **/
+
+function jirafeau_quoted($str)

 {
 {

-    return QUOTE . str_replace (QUOTE, "\'", $str) . QUOTE;
+    return QUOTE . str_replace(QUOTE, "\'", $str) . QUOTE;

 }
 
 }
 

-function
-jirafeau_export_cfg ($cfg)
+function jirafeau_export_cfg($cfg)

 {
 {

-    $handle = fopen (JIRAFEAU_CFG, 'w');
-    fwrite ($handle, '<?php' . NL);
-    fwrite ($handle,
-            '/* ' .
-            _ ('This file was generated by the install process. ' .
-               'You can edit it. Please see config.php to understand the ' .
-               'configuration items.') . ' */' . NL);
-    foreach ($cfg as $key => $item)
-    {
-        fwrite ($handle, '$cfg[' . jirafeau_quoted ($key) . '] = ');
-        if (is_bool ($item))
-            fwrite ($handle, ($item ? 'true' : 'false'));
-        else if (is_string ($item))
-            fwrite ($handle, jirafeau_quoted ($item));
-        else
-            fwrite ($handle, 'null');
-        fwrite ($handle, ';'.NL);
+    $content = '<?php' . NL;
+    $content .= '/* This file was generated by the install process. ' .
+               'You can edit it. Please see config.original.php to understand the ' .
+               'configuration items. */' . NL;
+    $content .= '$cfg = ' . var_export($cfg, true) . ';';
+
+    $fileWrite = file_put_contents(JIRAFEAU_CFG, $content);
+
+    if (false === $fileWrite) {
+        jirafeau_fatal_error(t('Can not write local configuration file'));

     }
     }

-    /* No newline at the end of the file to be able to send headers. */
-    fwrite ($handle, '?>');
-    fclose ($handle);

 }
 
 }
 

-function
-jirafeau_mkdir ($path)
+function jirafeau_mkdir($path)

 {
 {

-    if (!file_exists ($path) &&  !@mkdir ($path, 0755))
-        return false;
-    return true;
+    return !(!file_exists($path) && !@mkdir($path, 0755));

 }
 
 /**
 }
 
 /**


@@ -72,229 +61,234 @@ jirafeau_mkdir ($path)
  * @param $path is the file or directory to be tested.
  * @return true if $path is writable.
  */
  * @param $path is the file or directory to be tested.
  * @return true if $path is writable.
  */

-function
-jirafeau_is_writable ($path)
+function jirafeau_is_writable($path)

 {
     /* "@" gets rid of error messages. */
 {
     /* "@" gets rid of error messages. */

-    return is_writable ($path) || @chmod ($path, 0777);
+    return is_writable($path) || @chmod($path, 0777);

 }
 
 }
 

-function
-jirafeau_check_var_dir ($path)
+function jirafeau_check_var_dir($path)

 {
 {

-    $mkdir_str1 = _('The following directory could not be created:');
-    $mkdir_str2 = _('You should create this directory by hand.');
-    $write_str1 = _('The following directory is not writable:');
-    $write_str2 = _('You should give the write right to the web server on ' .
+    $mkdir_str1 = t('CANNOT_CREATE_DIR') . ':';
+    $mkdir_str2 = t('MANUAL_CREATE');
+    $write_str1 = t('DIR_NOT_W') . ':';
+    $write_str2 = t('You should give the write permission to the web server on ' .

                     'this directory.');
                     'this directory.');

-    $solution_str = _('Here is a solution:');
+    $solution_str = t('HERE_SOLUTION') . ':';

 
 

-    if (!jirafeau_mkdir ($path) || !jirafeau_is_writable ($path))
-        return array ('has_error' => true,
+    if (!jirafeau_mkdir($path) || !jirafeau_is_writable($path)) {
+        return array('has_error' => true,

                       'why' => $mkdir_str1 . '<br /><code>' .
                                $path . '</code><br />' . $solution_str .
                                '<br />' . $mkdir_str2);
                       'why' => $mkdir_str1 . '<br /><code>' .
                                $path . '</code><br />' . $solution_str .
                                '<br />' . $mkdir_str2);

+    }

 
 

-    foreach (array ('files', 'links') as $subdir)
-    {
+    foreach (array('files', 'links', 'async') as $subdir) {

         $subpath = $path.$subdir;
 
         $subpath = $path.$subdir;
 

-        if (!jirafeau_mkdir ($subpath) || !jirafeau_is_writable ($subpath))
-            return array ('has_error' => true,
+        if (!jirafeau_mkdir($subpath) || !jirafeau_is_writable($subpath)) {
+            return array('has_error' => true,

                           'why' => $mkdir_str1 . '<br /><code>' .
                                    $subpath . '</code><br />' . $solution_str .
                                    '<br />' . $mkdir_str2);
                           'why' => $mkdir_str1 . '<br /><code>' .
                                    $subpath . '</code><br />' . $solution_str .
                                    '<br />' . $mkdir_str2);

+        }

     }
 
     }
 

-    return array ('has_error' => false, 'why' => '');
+    return array('has_error' => false, 'why' => '');

 }
 
 }
 

-function
-jirafeau_add_ending_slash ($path)
+function jirafeau_add_ending_slash($path)

 {
 {

-    return $path . ((substr ($path, -1) == '/') ? '' : '/');
+    return $path . ((substr($path, -1) == '/') ? '' : '/');

 }
 
 }
 

-if (!file_exists (JIRAFEAU_CFG))
-{
-    /* We try to create an empty one. */
-    if (!@touch (JIRAFEAU_CFG))
-    {
-        require (JIRAFEAU_ROOT . 'lib/template/header.php');
-        echo '<div class="error"><p>' .
-             _('The local configuration file could not be created. Create a ' .
+/**
+ * Check installation
+ **/
+
+// Is the installation process done already?
+// Then there is nothing to do here → redirect to the main page.
+if ($cfg['installation_done'] === true) {
+    header('Location: index.php');
+    exit;
+}
+
+/**
+ * Prepare installation process
+ **/
+
+require(JIRAFEAU_ROOT . 'lib/template/header.php');
+
+// does the local configuration file exist?
+if (!file_exists(JIRAFEAU_CFG)) {
+    // show an error if it is not possible to create the file
+    if (!@touch(JIRAFEAU_CFG)) {
+        jirafeau_fatal_error(
+            t('The local configuration file could not be created. Create a ' .

                '<code>lib/config.local.php</code> file and give the write ' .
                '<code>lib/config.local.php</code> file and give the write ' .

-               'right to the web server (preferred solution), or give the ' .
-               'write right to the web server on the <code>lib</code> ' .
-               'directory.') .
-             '</p></div>';
-        require (JIRAFEAU_ROOT . 'lib/template/footer.php');
-        exit;
+               'permission to the web server (preferred solution), or give the ' .
+               'write permission to the web server on the <code>lib</code> ' .
+               'directory.')
+        );

     }
 }
 
     }
 }
 

-if (!is_writable (JIRAFEAU_CFG) && !@chmod (JIRAFEAU_CFG, '0666'))
-{
-    require (JIRAFEAU_ROOT . 'lib/template/header.php');
-    echo '<div class="error"><p>' .
-         _('The local configuration is not writable by the web server. ' .
-           'Give the write right to the web server on the ' .
-           '<code>lib/config.local.php</code> file.') .
-         '</p></div>';
-    require (JIRAFEAU_ROOT . 'lib/template/footer.php');
-    exit;
+// is the local configuration writable?
+if (!is_writable(JIRAFEAU_CFG) && !@chmod(JIRAFEAU_CFG, '0666')) {
+    jirafeau_fatal_error(
+        t('The local configuration is not writable by the web server. ' .
+            'Give the write permission to the web server on the ' .
+            '<code>lib/config.local.php</code> file.')
+    );

 }
 
 }
 

-if (isset ($_POST['step']) && isset ($_POST['next']))
-{
-    switch ($_POST['step'])
-    {
+/**
+ * Run trough each installation step
+ **/
+
+if (isset($_POST['step']) && isset($_POST['next'])) {
+    switch ($_POST['step']) {

     case 1:
     case 1:

-        $cfg['lang'] = $_POST['lang'];
-        jirafeau_export_cfg ($cfg);
+        if (strlen($_POST['admin_password'])) {
+            $cfg['admin_password'] = hash('sha256', $_POST['admin_password']);
+        } else {
+            $cfg['admin_password'] = '';
+        }
+        jirafeau_export_cfg($cfg);

         break;
 
     case 2:
         break;
 
     case 2:

-        $cfg['web_root'] = jirafeau_add_ending_slash ($_POST['web_root']);
-        $cfg['var_root'] = jirafeau_add_ending_slash ($_POST['var_root']);
-        jirafeau_export_cfg ($cfg);
+        $cfg['web_root'] = jirafeau_add_ending_slash($_POST['web_root']);
+        $cfg['var_root'] = jirafeau_add_ending_slash($_POST['var_root']);
+        jirafeau_export_cfg($cfg);

         break;
 
         break;
 

-    default: break;
+    case 3:
+        $cfg['web_root'] = jirafeau_add_ending_slash($_POST['web_root']);
+        $cfg['var_root'] = jirafeau_add_ending_slash($_POST['var_root']);
+        jirafeau_export_cfg($cfg);
+        break;

     }
     }

-

 }
 
 }
 

-require (JIRAFEAU_ROOT . 'lib/settings.php');
-require (JIRAFEAU_ROOT . 'lib/template/header.php');
-

 $current = 1;
 $current = 1;

-if (isset ($_POST['next']))
+if (isset($_POST['next'])) {

     $current = $_POST['step'] + 1;
     $current = $_POST['step'] + 1;

-else if (isset ($_POST['previous']))
+} elseif (isset($_POST['previous'])) {

     $current = $_POST['step'] - 1;
     $current = $_POST['step'] - 1;

-else if (isset ($_POST['retry']))
+} elseif (isset($_POST['retry'])) {

     $current = $_POST['step'];
     $current = $_POST['step'];

+}

 
 

-switch ($current)
-{
-case 3:
-    ?><h2><?php printf (_('Installation of Jirafeau - step %d out of %d'),
-                         3, 3);
-    ?></h2> <div id = "install"> <form action =
-        "<?php echo basename(__FILE__); ?>" method = "post"> <input type =
+switch ($current) {
+case 1:
+default:
+    ?><h2><?php printf(t('JI_INSTALL') . ' - ' . t('STEP') .
+    ' %d ' . t('OUT_OF') . ' %d', 1, 3);
+    ?></h2> <div id = "install"> <form method="post"> <input type =

         "hidden" name = "jirafeau" value =
         "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
         "hidden" name = "jirafeau" value =
         "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =

-        "step" value =
-        "3" /><fieldset> <legend><?php echo _('Finalisation');
+        "step" value = "1" /><fieldset> <legend><?php
+        echo t('ADMIN_PSW');

     ?></legend> <table> <tr> <td class = "info" colspan =
     ?></legend> <table> <tr> <td class = "info" colspan =

-        "2"><?php echo
-        _
-        ('Jirafeau is setting the website according to the configuration you provided.');
-    ?></td> </tr> <tr> <td class = "nav previous"><input type =
-        "submit" name = "previous" value =
-        "
-    <?php
-    echo _('Previous step');
-    ?>" /></td> <td></td> </tr>
-        </table> </fieldset> </form> </div>
-    <?php
-    $err = jirafeau_check_var_dir ($cfg['var_root']);
-    if ($err['has_error'])
-    {
-        echo '<div class="error"><p>'.$err['why'].'<br />'.NL;
-        ?><form action = "<?php echo basename(__FILE__); ?>" method =
-            "post"> <input type = "hidden" name = "jirafeau" value =
-            "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
-            "step" value = "3" /><input type = "submit" name =
-            "retry" value =
-            "<?php echo _('Retry this step'); ?>" /></form>
-            <?php echo '</p></div>';
-    }
-    else
-    {
-        echo '<div class="message"><p>' .
-             _('Your website is now fully operational:') .
-             '<br /><a href="' . $cfg['web_root'] . '">' .
-             $cfg['web_root'].'</a></p></div>';
-    }
-    break;
+        "2"><?php echo t('ADMIN_INTERFACE_INFO');
+    ?></td> </tr> <tr> <td class = "label"><label for = "select_password"
+       ><?php echo t('ADMIN_PSW') . ':';
+    ?></label></td>
+        <td class = "field"><input type = "password" name = "admin_password"
+        id = "admin_password" size = "40" /></td>
+        </tr>
+        <tr class = "nav">
+        <td></td>
+        <td class = "nav next">
+        <input type = "submit"
+        class = "navleft" name = "previous" value = "<?php
+        echo t('PREV_STEP'); ?>" />
+        <input type = "submit" name = "next" value =
+        "<?php echo t('NEXT_STEP'); ?>" /></td> </tr> </table>
+        </fieldset> </form> </div> <?php
+break;

 
 case 2:
 
 case 2:

-    ?><h2><?php printf (_('Installation of Jirafeau - step %d out of %d'),
-                            2, 3);
-    ?></h2> <div id = "install"> <form action =
-        "<?php echo basename(__FILE__); ?>" method = "post"> <input type =
+    ?><h2><?php printf(t('JI_INSTALL') . ' - ' . t('STEP') .
+    ' %d ' . t('OUT_OF') . ' %d', 2, 3);
+    ?></h2> <div id = "install"> <form method="post"> <input type =

         "hidden" name = "jirafeau" value =
         "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
         "step" value =
         "hidden" name = "jirafeau" value =
         "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
         "step" value =

-        "2" /><fieldset> <legend><?php echo _('Information');
+        "2" /><fieldset> <legend><?php echo t('INFO');

     ?></legend> <table> <tr> <td class = "info" colspan =
     ?></legend> <table> <tr> <td class = "info" colspan =

-        "2"><?php echo
-        _
-        ('The base address of Jirafeau is the first part of the URL, until (and including) the last slash. For example: "http://www.example.com/". Do not forget the ending slash!');
+        "2"><?php echo t('BASE_ADDR_INFO');

     ?></td> </tr> <tr> <td class = "label"><label for = "input_web_root"
     ?></td> </tr> <tr> <td class = "label"><label for = "input_web_root"

-       ><?php echo _('Base address:');
+       ><?php echo t('BASE_ADDR') . ':';

     ?></label></td>
     ?></label></td>

-        <td class = "field"><input type = "text" name = "web_root" id = "input_web_root" value = "<?php
-        echo (empty($cfg['web_root']) ?
-          'http://' . $_SERVER['HTTP_HOST'] . str_replace(basename(__FILE__), '', $_SERVER['REQUEST_URI']) :
-          $cfg['web_root']);
+        <td class = "field"><input type = "text" name = "web_root"
+        id = "input_web_root" value = "<?php
+        echo(empty($cfg['web_root']) ?
+          $_SERVER['HTTP_HOST'] . str_replace(basename(__FILE__),
+          '', $_SERVER['REQUEST_URI']) : $cfg['web_root']);

       ?>" size = "40" /></td>
       ?>" size = "40" /></td>

-        </tr> <tr> <td class = "info" colspan = "2"><?php echo _('The data directory is where your files and information about your files will be stored. You should put it outside your web site, or at least restrict the access of this directory. Do not forget the ending slash!');
+        </tr> <tr> <td class = "info" colspan = "2"><?php
+        echo t('DATA_DIR_EXPLAINATION');

     ?></td> </tr> <tr> <td class = "label"><label for = "input_var_root"
     ?></td> </tr> <tr> <td class = "label"><label for = "input_var_root"

-       ><?php echo _('Data directory:');
+       ><?php echo t('DATA_DIR') . ':';

     ?></label></td>
     ?></label></td>

-        <td class = "field"><input type = "text" name = "var_root" id = "input_var_root" value = "<?php
-        if(empty($cfg['var_root'])) {
-          $alphanum = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
-          $len_alphanum = strlen($alphanum);
-          $var = 'var-';
-          for($i = 0; $i <JIRAFEAU_VAR_RAND_LENGTH; $i++) {
-            $var .= substr($alphanum, mt_rand(0, $len_alphanum - 1), 1);
-          }
-          echo JIRAFEAU_ROOT . $var . '/';
+        <td class = "field"><input type = "text" name = "var_root"
+        id = "input_var_root" value = "<?php
+        if (empty($cfg['var_root'])) {
+            $alphanum = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' .
+          'abcdefghijklmnopqrstuvwxyz' . '0123456789';
+            $len_alphanum = strlen($alphanum);
+            $var = 'var-';
+            for ($i = 0; $i <JIRAFEAU_VAR_RAND_LENGTH; $i++) {
+                $var .= substr($alphanum, mt_rand(0, $len_alphanum - 1), 1);
+            }
+            echo JIRAFEAU_ROOT . $var . '/';

         } else {
         } else {

-          echo $cfg['var_root'];
-        } 
+            echo $cfg['var_root'];
+        }

       ?>" size = "40" /></td>
       ?>" size = "40" /></td>

-        </tr> <tr> <td colspan = "2"> <input type = "submit" class = "navright" name = "next" value = "<?php echo _('Next step'); ?>" /><input type = "submit" class = "navleft" name = "previous" value = "<?php echo _('Previous step'); ?>" /></td> </tr> </table> </fieldset> </form> </div> <?php break;
+        </tr> <tr> <td colspan = "2"><input type = "submit"
+        class = "navleft" name = "previous" value = "<?php
+        echo t('PREV_STEP'); ?>" />
+         <input type = "submit" class = "navright" name = "next" value = 
+        "<?php echo t('NEXT_STEP'); ?>" />
+        </td> </tr> </table> </fieldset>
+        </form> </div> <?php
+break;

 
 

-case 1:
-default:
-    $languages = array ('' => 'English', 'fr_FR.UTF-8' => 'Français');
-    ?><h2><?php printf (_('Installation of Jirafeau - step %d out of %d'),
-                            1, 3);
-    ?></h2> <div id = "install"> <form action =
-        "<?php echo basename(__FILE__); ?>" method = "post"> <input type =
+case 3:
+    ?><h2><?php printf(t('JI_INSTALL') . ' - ' . t('STEP') .
+    ' %d ' . t('OUT_OF') . ' %d', 3, 3);
+    ?></h2> <div id = "install"> <form method="post"> <input type =

         "hidden" name = "jirafeau" value =
         "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
         "hidden" name = "jirafeau" value =
         "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =

-        "step" value = "1" /><fieldset> <legend><?php echo _('Language');
+        "step" value =
+        "3" /><fieldset> <legend><?php echo t('FINALIZATION');

     ?></legend> <table> <tr> <td class = "info" colspan =
     ?></legend> <table> <tr> <td class = "info" colspan =

-        "2"><?php echo
-        _
-        ('The installation of Jirafeau is internationalised, so you can have it in your own language if the translation is available.');
-    ?></td> </tr> <tr> <td class = "label"><label for = "select_lang"
-       ><?php echo _('Choose your language:');
-    ?></label></td>
-        <td class = "field">
-        <select name = "lang" id = "select_lang">
-        <?php foreach ($languages as $key => $item)
-    {
-        echo '<option value="'.$key.'"'.($key ==
-                                         $cfg['lang'] ? ' selected="selected"'
-                                         : '').'>'.$item.'</option>'.NL;
+        "2"><?php echo t('SETTING_UP');
+    ?></td> </tr> <tr> <td class = "nav previous"><input type =
+        "submit" name = "previous" value = " <?php echo t('PREV_STEP');
+    ?>" /></td> <td></td> </tr>
+        </table> </fieldset> </form> </div>
+    <?php
+    $err = jirafeau_check_var_dir($cfg['var_root']);
+    if ($err['has_error']) {
+        echo '<div class="error"><p>'.$err['why'].'<br />'.NL; ?><form method="post"> <input type = "hidden" name = "jirafeau" value =
+            "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
+            "step" value = "3" /><input type = "submit" name =
+            "retry" value =
+            "<?php echo t('RETRY_STEP'); ?>" /></form>
+            <?php echo '</p></div>';
+    } else {
+        $cfg['installation_done'] = true;
+        jirafeau_export_cfg($cfg);
+        echo '<div class="message"><p>' .
+             t('JI_FONCTIONAL') . ':' .
+             '<br /><a href="./">' .
+             $cfg['web_root'].'</a></p></div>';

     }
     }

-    ?></select>
-        </td>
-        </tr>
-        <tr class = "nav">
-        <td></td>
-        <td class = "nav next"><input type = "submit" name = "next" value =
-        "<?php echo _('Next step'); ?>" /></td> </tr> </table>
-        </fieldset> </form> </div> <?php break;
+break;

 }
 
 }
 

-
-require (JIRAFEAU_ROOT . 'lib/template/footer.php');
-?>
+require(JIRAFEAU_ROOT . 'lib/template/footer.php');