[FEATURE] Docs: Explain how to obey the AGPLv3 license

[jirafeau_mojo42.git] / install.php

diff --git a/install.php b/install.php
old mode 100755 (executable)
new mode 100644 (file)
index ff4f1e2..df4f106
--- 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,17 +15,21 @@
  *  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 ('NL', "\n");
 define ('QUOTE', "'");

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

 define ('JIRAFEAU_VAR_RAND_LENGTH', 15);
 
 define ('JIRAFEAU_VAR_RAND_LENGTH', 15);
 

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

 require (JIRAFEAU_ROOT . 'lib/lang.php');
 require (JIRAFEAU_ROOT . 'lib/lang.php');

-require (JIRAFEAU_ROOT . 'lib/config.php');
+
+/**
+ * Prepend used functions
+ **/

 
 function
 jirafeau_quoted ($str)
 
 function
 jirafeau_quoted ($str)


@@ -35,35 +40,23 @@ jirafeau_quoted ($str)
 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 .= '/* ' . t ('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));

 }
 
 /**
 }
 
 /**


@@ -82,12 +75,12 @@ jirafeau_is_writable ($path)
 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('The following directory could not be created') . ':';
+    $mkdir_str2 = t('You should create this directory manually.');
+    $write_str1 = t('The following directory is not writable') . ':';
+    $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 is a 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,


@@ -95,7 +88,7 @@ jirafeau_check_var_dir ($path)
                                $path . '</code><br />' . $solution_str .
                                '<br />' . $mkdir_str2);
 
                                $path . '</code><br />' . $solution_str .
                                '<br />' . $mkdir_str2);
 

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

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


@@ -115,36 +108,62 @@ jirafeau_add_ending_slash ($path)
     return $path . ((substr ($path, -1) == '/') ? '' : '/');
 }
 
     return $path . ((substr ($path, -1) == '/') ? '' : '/');
 }
 

+function
+jirafeau_fatal_error($errorText)
+{
+    echo '<div class="error"><h2>Error</h2><p>' . $errorText . '</p></div>';
+    require (JIRAFEAU_ROOT . 'lib/template/footer.php');
+    exit;
+}
+
+/**
+ * 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))
 {
 if (!file_exists (JIRAFEAU_CFG))
 {

-    /* We try to create an empty one. */
+    // show an error if it is not possible to create the file

     if (!@touch (JIRAFEAU_CFG))
     {
     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 ' .
+        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.')
+        );

     }
 }
 
     }
 }
 

+// is the local configuration writable?

 if (!is_writable (JIRAFEAU_CFG) && !@chmod (JIRAFEAU_CFG, '0666'))
 {
 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;
+    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.')
+    );

 }
 
 }
 

+/**
+ * Run trough each installation step
+ **/
+

 if (isset ($_POST['step']) && isset ($_POST['next']))
 {
     switch ($_POST['step'])
 if (isset ($_POST['step']) && isset ($_POST['next']))
 {
     switch ($_POST['step'])


@@ -155,19 +174,25 @@ if (isset ($_POST['step']) && isset ($_POST['next']))
         break;
 
     case 2:
         break;
 
     case 2:

+        $cfg['admin_password'] = hash('sha256', $_POST['admin_password']);
+        jirafeau_export_cfg ($cfg);
+        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;
 
         $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;
 

-    default: break;
+    case 4:
+        $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;
 if (isset ($_POST['next']))
     $current = $_POST['step'] + 1;
 $current = 1;
 if (isset ($_POST['next']))
     $current = $_POST['step'] + 1;


@@ -178,122 +203,172 @@ else if (isset ($_POST['retry']))
 
 switch ($current)
 {
 
 switch ($current)
 {

-case 3:
-    ?><h2><?php printf (_('Installation of Jirafeau') . ' - ' . _('step') .
-    ' %d ' . _('out of') . ' %d', 3, 3);
+case 1:
+default:
+    ?><h2><?php printf (t('Installation of Jirafeau') . ' - ' . t('step') .
+    ' %d ' . t('out of') . ' %d', 1, 4);

     ?></h2> <div id = "install"> <form action =
         "<?php echo basename(__FILE__); ?>" method = "post"> <input type =
         "hidden" name = "jirafeau" value =
         "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
     ?></h2> <div id = "install"> <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" /><fieldset> <legend><?php echo _('Finalisation');
+        "step" value = "1" /><fieldset> <legend><?php echo t('Language');

     ?></legend> <table> <tr> <td class = "info" colspan =
         "2"><?php echo
     ?></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
+        t
+        ('Jirafeau is internationalised. Choose a specific langage or ' .
+         'choose Automatic (langage is provided by user\'s browser).');
+    ?></td> </tr> <tr> <td class = "label"><label for = "select_lang"
+       ><?php echo t('Choose the default language') . ':';
+    ?></label></td>
+        <td class = "field">
+        <select name = "lang" id = "select_lang">
+        <?php foreach ($languages_list as $key => $item)

     {
     {

-        echo '<div class="message"><p>' .
-             _('Jirafeau is now fully operational') . ':' .
-             '<br /><a href="' . $cfg['web_root'] . '">' .
-             $cfg['web_root'].'</a></p></div>';
+        echo '<option value="'.$key.'"'.($key ==
+                      $cfg['lang'] ? ' selected="selected"'
+                      : '').'>'.$item.'</option>'.NL;

     }
     }

-    break;
+    ?></select>
+        </td>
+        </tr>
+        <tr class = "nav">
+        <td></td>
+        <td class = "nav next"><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><?php printf (t('Installation of Jirafeau') . ' - ' . t('step') .
+    ' %d ' . t('out of') . ' %d', 2, 4);
+    ?></h2> <div id = "install"> <form action =
+        "<?php echo basename(__FILE__); ?>" method = "post"> <input type =
+        "hidden" name = "jirafeau" value =
+        "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
+        "step" value = "2" /><fieldset> <legend><?php
+        echo t('Administration password');
+    ?></legend> <table> <tr> <td class = "info" colspan =
+        "2"><?php echo
+        t
+        ('Jirafeau has an administration interface (through admin.php). ' .
+        'You can set a password to access the interface or leave it empty ' .
+        'to disable the interface.');
+    ?></td> </tr> <tr> <td class = "label"><label for = "select_password"
+       ><?php echo t('Administration password') . ':';
+    ?></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('Previous step'); ?>" />
+        <input type = "submit" name = "next" value =
+        "<?php echo t('Next step'); ?>" /></td> </tr> </table>
+        </fieldset> </form> </div> <?php
+break;
+
+case 3:
+    ?><h2><?php printf (t('Installation of Jirafeau') . ' - ' . t('step') .
+    ' %d ' . t('out of') . ' %d', 3, 4);

     ?></h2> <div id = "install"> <form action =
         "<?php echo basename(__FILE__); ?>" method = "post"> <input type =
         "hidden" name = "jirafeau" value =
         "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
         "step" value =
     ?></h2> <div id = "install"> <form action =
         "<?php echo basename(__FILE__); ?>" method = "post"> <input type =
         "hidden" name = "jirafeau" value =
         "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
         "step" value =

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

     ?></legend> <table> <tr> <td class = "info" colspan =
         "2"><?php echo
     ?></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!');
+        t
+        ('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 trailing slash!');

     ?></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 address') . ':';

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

-        <td class = "field"><input type = "text" name = "web_root" id = "input_web_root" value = "<?php
+        <td class = "field"><input type = "text" name = "web_root"
+        id = "input_web_root" value = "<?php

         echo (empty($cfg['web_root']) ?
         echo (empty($cfg['web_root']) ?

-          'http://' . $_SERVER['HTTP_HOST'] . str_replace(basename(__FILE__), '', $_SERVER['REQUEST_URI']) :
-          $cfg['web_root']);
+          'http://' . $_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('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 to this directory. Do not ' .
+        'forget the trailing slash!');

     ?></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 directory') . ':';

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

-        <td class = "field"><input type = "text" name = "var_root" id = "input_var_root" value = "<?php
+        <td class = "field"><input type = "text" name = "var_root"
+        id = "input_var_root" value = "<?php

         if(empty($cfg['var_root'])) {
         if(empty($cfg['var_root'])) {

-          $alphanum = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+          $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 . '/';
           $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('Previous 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:
-    ?><h2><?php printf (_('Installation of Jirafeau') . ' - ' . _('step') .
-    ' %d ' . _('out of') . ' %d', 1, 3);
+case 4:
+    ?><h2><?php printf (t('Installation of Jirafeau') . ' - ' . t('step') .
+    ' %d ' . t('out of') . ' %d', 4, 4);

     ?></h2> <div id = "install"> <form action =
         "<?php echo basename(__FILE__); ?>" method = "post"> <input type =
         "hidden" name = "jirafeau" value =
         "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
     ?></h2> <div id = "install"> <form action =
         "<?php echo basename(__FILE__); ?>" method = "post"> <input type =
         "hidden" name = "jirafeau" value =
         "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =

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

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

-        _
-        ('Jirafeau is internationalised. Choose a specific langage or choose Automatic (langage is provided by user\'s browser).');
-    ?></td> </tr> <tr> <td class = "label"><label for = "select_lang"
-       ><?php echo _('Choose the default language') . ':';
-    ?></label></td>
-        <td class = "field">
-        <select name = "lang" id = "select_lang">
-        <?php foreach ($languages_list as $key => $item)
+        t ('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 t('Previous step');
+    ?>" /></td> <td></td> </tr>
+        </table> </fieldset> </form> </div>
+    <?php
+    $err = jirafeau_check_var_dir ($cfg['var_root']);
+    if ($err['has_error'])

     {
     {

-        echo '<option value="'.$key.'"'.($key ==
-                                         $cfg['lang'] ? ' selected="selected"'
-                                         : '').'>'.$item.'</option>'.NL;
+        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 = "4" /><input type = "submit" name =
+            "retry" value =
+            "<?php echo t('Retry this step'); ?>" /></form>
+            <?php echo '</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;
+    else
+    {
+        $cfg['installation_done'] = true;
+        jirafeau_export_cfg ($cfg);
+        echo '<div class="message"><p>' .
+             t('Jirafeau is now fully operational') . ':' .
+             '<br /><a href="' . $cfg['web_root'] . '">' .
+             $cfg['web_root'].'</a></p></div>';
+    }
+break;

 }
 
 }
 

-

 require (JIRAFEAU_ROOT . 'lib/template/footer.php');
 require (JIRAFEAU_ROOT . 'lib/template/footer.php');

-?>