[FEATURE] Contribution guide: Revise structure

[jirafeau_project.git] / install.php

diff --git a/install.php b/install.php
old mode 100755 (executable)
new mode 100644 (file)
index ca626ab..fbd3667
--- 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,18 +15,20 @@
  *  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 ('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/functions.php');
 require (JIRAFEAU_ROOT . 'lib/lang.php');

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

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


@@ -36,37 +39,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,
-            '/* ' .
-            t ('This file was generated by the install process. ' .
+    $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 ' .
                'You can edit it. Please see config.original.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 if (is_int ($item))
-            fwrite ($handle, $item);
-        else
-            fwrite ($handle, 'null');
-        fwrite ($handle, ';'.NL);
+               '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));

 }
 
 /**
 }
 
 /**


@@ -86,9 +75,9 @@ function
 jirafeau_check_var_dir ($path)
 {
     $mkdir_str1 = t('The following directory could not be created') . ':';
 jirafeau_check_var_dir ($path)
 {
     $mkdir_str1 = t('The following directory could not be created') . ':';

-    $mkdir_str2 = t('You should create this directory by hand.');
+    $mkdir_str2 = t('You should create this directory manually.');

     $write_str1 = t('The following directory is not writable') . ':';
     $write_str1 = t('The following directory is not writable') . ':';

-    $write_str2 = t('You should give the write right to the web server on ' .
+    $write_str2 = t('You should give the write permission to the web server on ' .

                     'this directory.');
     $solution_str = t('Here is a solution') . ':';
 
                     'this directory.');
     $solution_str = t('Here is a solution') . ':';
 


@@ -98,7 +87,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', 'async', 'block') as $subdir)
+    foreach (array ('files', 'links', 'async', 'alias') as $subdir)

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


@@ -118,42 +107,62 @@ jirafeau_add_ending_slash ($path)
     return $path . ((substr ($path, -1) == '/') ? '' : '/');
 }
 
     return $path . ((substr ($path, -1) == '/') ? '' : '/');
 }
 

-if ($cfg['installation_done'] === true)
+function
+jirafeau_fatal_error($errorText)

 {
 {

-    header('Location: index.php');
+    echo '<div class="error"><h2>Error</h2><p>' . $errorText . '</p></div>';
+    require (JIRAFEAU_ROOT . 'lib/template/footer.php');

     exit;
 }
 
     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>' .
-             t('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>' .
-         t('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'])


@@ -164,14 +173,13 @@ if (isset ($_POST['step']) && isset ($_POST['next']))
         break;
 
     case 2:
         break;
 
     case 2:

-        $cfg['admin_password'] = $_POST['admin_password'];
+        $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;
 
     case 3:
         $cfg['web_root'] = jirafeau_add_ending_slash ($_POST['web_root']);
         $cfg['var_root'] = jirafeau_add_ending_slash ($_POST['var_root']);

-        $cfg['installation_done'] = true;

         jirafeau_export_cfg ($cfg);
         break;
 
         jirafeau_export_cfg ($cfg);
         break;
 


@@ -180,15 +188,10 @@ if (isset ($_POST['step']) && isset ($_POST['next']))
         $cfg['var_root'] = jirafeau_add_ending_slash ($_POST['var_root']);
         jirafeau_export_cfg ($cfg);
         break;
         $cfg['var_root'] = jirafeau_add_ending_slash ($_POST['var_root']);
         jirafeau_export_cfg ($cfg);
         break;

-
-    default: 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;


@@ -203,8 +206,7 @@ case 1:
 default:
     ?><h2><?php printf (t('Installation of Jirafeau') . ' - ' . t('step') .
     ' %d ' . t('out of') . ' %d', 1, 4);
 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 =
+    ?></h2> <div id = "install"> <form method="post"> <input type =

         "hidden" name = "jirafeau" value =
         "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
         "step" value = "1" /><fieldset> <legend><?php echo t('Language');
         "hidden" name = "jirafeau" value =
         "<?php echo JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
         "step" value = "1" /><fieldset> <legend><?php echo t('Language');


@@ -233,12 +235,11 @@ default:
         "<?php echo t('Next step'); ?>" /></td> </tr> </table>
         </fieldset> </form> </div> <?php
 break;
         "<?php echo t('Next step'); ?>" /></td> </tr> </table>
         </fieldset> </form> </div> <?php
 break;

-    
+

 case 2:
     ?><h2><?php printf (t('Installation of Jirafeau') . ' - ' . t('step') .
     ' %d ' . t('out of') . ' %d', 2, 4);
 case 2:
     ?><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 =
+    ?></h2> <div id = "install"> <form method="post"> <input type =

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


@@ -247,7 +248,7 @@ case 2:
         "2"><?php echo
         t
         ('Jirafeau has an administration interface (through admin.php). ' .
         "2"><?php echo
         t
         ('Jirafeau has an administration interface (through admin.php). ' .

-        'You can set a password to access the intercace or let it be empty ' .
+        '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') . ':';
         'to disable the interface.');
     ?></td> </tr> <tr> <td class = "label"><label for = "select_password"
        ><?php echo t('Administration password') . ':';


@@ -269,8 +270,7 @@ break;
 case 3:
     ?><h2><?php printf (t('Installation of Jirafeau') . ' - ' . t('step') .
     ' %d ' . t('out of') . ' %d', 3, 4);
 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 =
+    ?></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 =


@@ -280,7 +280,7 @@ case 3:
         t
         ('The base address of Jirafeau is the first part of the URL, until ' .
          '(and including) the last slash. For example: ' .
         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 ending slash!');
+         '"http://www.example.com/". Do not forget the trailing slash!');

     ?></td> </tr> <tr> <td class = "label"><label for = "input_web_root"
        ><?php echo t('Base address') . ':';
     ?></label></td>
     ?></td> </tr> <tr> <td class = "label"><label for = "input_web_root"
        ><?php echo t('Base address') . ':';
     ?></label></td>


@@ -293,8 +293,8 @@ case 3:
         </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 ' .
         </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 of this directory. Do not ' .
-        'forget the ending slash!');
+        '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"
        ><?php echo t('Data directory') . ':';
     ?></label></td>
     ?></td> </tr> <tr> <td class = "label"><label for = "input_var_root"
        ><?php echo t('Data directory') . ':';
     ?></label></td>


@@ -325,8 +325,7 @@ break;
 case 4:
     ?><h2><?php printf (t('Installation of Jirafeau') . ' - ' . t('step') .
     ' %d ' . t('out of') . ' %d', 4, 4);
 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 =
+    ?></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 =


@@ -347,8 +346,7 @@ case 4:
     if ($err['has_error'])
     {
         echo '<div class="error"><p>'.$err['why'].'<br />'.NL;
     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 =
+        ?><form 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 JIRAFEAU_VERSION; ?>" /><input type = "hidden" name =
             "step" value = "4" /><input type = "submit" name =
             "retry" value =


@@ -357,6 +355,8 @@ case 4:
     }
     else
     {
     }
     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'] . '">' .
         echo '<div class="message"><p>' .
              t('Jirafeau is now fully operational') . ':' .
              '<br /><a href="' . $cfg['web_root'] . '">' .


@@ -366,4 +366,3 @@ break;
 }
 
 require (JIRAFEAU_ROOT . 'lib/template/footer.php');
 }
 
 require (JIRAFEAU_ROOT . 'lib/template/footer.php');

-?>