Add more details about upload error

[jirafeau.git] / lib / functions.php

diff --git a/lib/functions.php b/lib/functions.php
index 3c432b6f2e6ca7771d4c0665c41f0b495b299c83..46c004a101606e77623e07b860e6fa01bd8d35f2 100644 (file)
--- a/lib/functions.php
+++ b/lib/functions.php
@@ -20,7 +20,7 @@
  */
 
 /**
  */
 
 /**

- * Transform a string in a path by seperating each letters by a '/'.
+ * Transform a string in a path by separating each letters by a '/'.

  * @return path finishing with a '/'
  */
 function s2p($s)
  * @return path finishing with a '/'
  */
 function s2p($s)


@@ -28,7 +28,7 @@ function s2p($s)
     $block_size = 8;
     $p = '';
     for ($i = 0; $i < strlen($s); $i++) {
     $block_size = 8;
     $p = '';
     for ($i = 0; $i < strlen($s); $i++) {

-        $p .= $s{$i};
+        $p .= $s[$i];

         if (($i + 1) % $block_size == 0) {
             $p .= '/';
         }
         if (($i + 1) % $block_size == 0) {
             $p .= '/';
         }


@@ -68,16 +68,16 @@ function base_16_to_64($num)
     # Convert long hex string to bin.
     $size = strlen($num);
     for ($i = 0; $i < $size; $i++) {
     # Convert long hex string to bin.
     $size = strlen($num);
     for ($i = 0; $i < $size; $i++) {

-        $b .= $hex2bin{hexdec($num{$i})};
+        $b .= $hex2bin[hexdec($num[$i])];

     }
     # Convert long bin to base 64.
     $size *= 4;
     for ($i = $size - 6; $i >= 0; $i -= 6) {
     }
     # Convert long bin to base 64.
     $size *= 4;
     for ($i = $size - 6; $i >= 0; $i -= 6) {

-        $o = $m{bindec(substr($b, $i, 6))} . $o;
+        $o = $m[bindec(substr($b, $i, 6))] . $o;

     }
     # Some few bits remaining ?
     if ($i < 0 && $i > -6) {
     }
     # Some few bits remaining ?
     if ($i < 0 && $i > -6) {

-        $o = $m{bindec(substr($b, 0, $i + 6))} . $o;
+        $o = $m[bindec(substr($b, 0, $i + 6))] . $o;

     }
     return $o;
 }
     }
     return $o;
 }


@@ -418,7 +418,7 @@ function jirafeau_upload($file, $one_time_download, $key, $time, $ip, $crypt, $l
         }
     }
 
         }
     }
 

-    /* file informations */
+    /* file information */

     $hash = jirafeau_hash_file($file_hash_method, $file['tmp_name']);
     $name = str_replace(NL, '', trim($file['name']));
     $mime_type = $file['type'];
     $hash = jirafeau_hash_file($file_hash_method, $file['tmp_name']);
     $name = str_replace(NL, '', trim($file['name']));
     $mime_type = $file['type'];


@@ -509,10 +509,15 @@ function jirafeau_upload($file, $one_time_download, $key, $time, $ip, $crypt, $l
 function jirafeau_is_viewable($mime)
 {
     if (!empty($mime)) {
 function jirafeau_is_viewable($mime)
 {
     if (!empty($mime)) {

-        /* Actually, verify if mime-type is an image or a text. */
-        $viewable = array('image', 'text', 'video', 'audio');
+        $viewable = array('image', 'video', 'audio');

         $decomposed = explode('/', $mime);
         $decomposed = explode('/', $mime);

-        return in_array($decomposed[0], $viewable);
+        if (in_array($decomposed[0], $viewable) && strpos($mime, 'image/svg+xml') === false) {
+            return true;
+        }
+        $viewable = array('text/plain');
+        if (in_array($mime, $viewable)) {
+            return true;
+        }

     }
     return false;
 }
     }
     return false;
 }


@@ -588,8 +593,8 @@ function check_errors($cfg)
 }
 
 /**
 }
 
 /**

- * Read link informations
- * @return array containing informations.
+ * Read link information
+ * @return array containing information.

  */
 function jirafeau_get_link($hash)
 {
  */
 function jirafeau_get_link($hash)
 {


@@ -654,7 +659,7 @@ function jirafeau_admin_list($name, $file_hash, $link_hash)
                 /* Push new found directory. */
                 $stack[] = $d . $node . '/';
             } elseif (is_file($d . $node)) {
                 /* Push new found directory. */
                 $stack[] = $d . $node . '/';
             } elseif (is_file($d . $node)) {

-                /* Read link informations. */
+                /* Read link information. */

                 $l = jirafeau_get_link($node);
                 if (!count($l)) {
                     continue;
                 $l = jirafeau_get_link($node);
                 if (!count($l)) {
                     continue;


@@ -670,7 +675,7 @@ function jirafeau_admin_list($name, $file_hash, $link_hash)
                 if (!empty($link_hash) && $link_hash != $node) {
                     continue;
                 }
                 if (!empty($link_hash) && $link_hash != $node) {
                     continue;
                 }

-                /* Print link informations. */
+                /* Print link information. */

                 echo '<tr>';
                 echo '<td>' .
                 '<strong><a id="upload_link" href="f.php?h='. jirafeau_escape($node) .'" title="' .
                 echo '<tr>';
                 echo '<td>' .
                 '<strong><a id="upload_link" href="f.php?h='. jirafeau_escape($node) .'" title="' .


@@ -680,7 +685,9 @@ function jirafeau_admin_list($name, $file_hash, $link_hash)
                 echo t('EXPIRE') . ': ' . ($l['time'] == -1 ? '∞' : jirafeau_get_datetimefield($l['time'])) . '<br/>';
                 echo t('ONETIME') . ': ' . ($l['onetime'] == 'O' ? 'Yes' : 'No') . '<br/>';
                 echo t('UPLOAD_DATE') . ': ' . jirafeau_get_datetimefield($l['upload_date']) . '<br/>';
                 echo t('EXPIRE') . ': ' . ($l['time'] == -1 ? '∞' : jirafeau_get_datetimefield($l['time'])) . '<br/>';
                 echo t('ONETIME') . ': ' . ($l['onetime'] == 'O' ? 'Yes' : 'No') . '<br/>';
                 echo t('UPLOAD_DATE') . ': ' . jirafeau_get_datetimefield($l['upload_date']) . '<br/>';

-                echo t('ORIGIN') . ': ' . $l['ip'] . '<br/>';
+                if (strlen($l['ip']) > 0) {
+                    echo t('ORIGIN') . ': ' . $l['ip'] . '<br/>';
+                }

                 echo '</td><td>';
                 echo '<form method="post">' .
                 '<input type = "hidden" name = "action" value = "download"/>' .
                 echo '</td><td>';
                 echo '<form method="post">' .
                 '<input type = "hidden" name = "action" value = "download"/>' .


@@ -730,7 +737,7 @@ function jirafeau_admin_clean()
                 /* Push new found directory. */
                 $stack[] = $d . $node . '/';
             } elseif (is_file($d . $node)) {
                 /* Push new found directory. */
                 $stack[] = $d . $node . '/';
             } elseif (is_file($d . $node)) {

-                /* Read link informations. */
+                /* Read link information. */

                 $l = jirafeau_get_link(basename($node));
                 if (!count($l)) {
                     continue;
                 $l = jirafeau_get_link(basename($node));
                 if (!count($l)) {
                     continue;


@@ -750,7 +757,7 @@ function jirafeau_admin_clean()
 
 
 /**
 
 
 /**

- * Clean old async transferts.
+ * Clean old async transfers.

  * @return number of cleaned files.
  */
 function jirafeau_admin_clean_async()
  * @return number of cleaned files.
  */
 function jirafeau_admin_clean_async()


@@ -771,12 +778,12 @@ function jirafeau_admin_clean_async()
                 /* Push new found directory. */
                 $stack[] = $d . $node . '/';
             } elseif (is_file($d . $node)) {
                 /* Push new found directory. */
                 $stack[] = $d . $node . '/';
             } elseif (is_file($d . $node)) {

-                /* Read async informations. */
+                /* Read async information. */

                 $a = jirafeau_get_async_ref(basename($node));
                 if (!count($a)) {
                     continue;
                 }
                 $a = jirafeau_get_async_ref(basename($node));
                 if (!count($a)) {
                     continue;
                 }

-                /* Delete transferts older than 1 hour. */
+                /* Delete transfers older than 1 hour. */

                 if (time() - $a['last_edited'] > 3600) {
                     jirafeau_async_delete(basename($node));
                     $count++;
                 if (time() - $a['last_edited'] > 3600) {
                     jirafeau_async_delete(basename($node));
                     $count++;


@@ -786,9 +793,107 @@ function jirafeau_admin_clean_async()
     }
     return $count;
 }
     }
     return $count;
 }

+
+/**
+ * Better strval function for debug purposes
+ */
+function jirafeau_strval($value)
+{
+    if (gettype($value) == "boolean") {
+        return $value ? 'true' : 'false';
+    }
+    return strval($value);
+}
+

 /**
 /**

- * Read async transfert informations
- * @return array containing informations.
+ * Show file/folder permissions
+ */
+function jirafeau_fileperms($path)
+{
+    $out = substr(sprintf("%o", @fileperms($path)), -4) . ", ";
+    $out .= "read " . (is_readable($path) ? "OK" : "KO") . ", ";
+    $out .= "write " . (is_writable($path) ? "OK" : "KO");
+    return $out;
+}
+
+/**
+ * Show some useful informations for bug reporting.
+ */
+function jirafeau_admin_bug_report($cfg)
+{
+    $out = "<fieldset><legend>" . t('REPORTING_AN_ISSUE') . "</legend>";
+    $out .= "If you have a problem related to Jirafeau, please <a href='https://gitlab.com/mojo42/Jirafeau/-/issues'>open an issue</a>, explain your problem in english and copy-paste the following content:<br/><br/><code>";
+
+    $out .= "# Jirafeau<br/>";
+    $out .= "- version: " . JIRAFEAU_VERSION . "<br/>";
+    $jirafeau_options = [
+        'debug',
+        'file_hash',
+        'litespeed_workaround',
+        'store_uploader_ip',
+        'installation_done',
+        'enable_crypt',
+        'preview',
+        'maximal_upload_size',
+        'store_uploader_ip'
+    ];
+    foreach ($jirafeau_options as &$o) {
+        $v = $cfg[$o];
+        $out .= "- $o: " . jirafeau_strval($v) . " (" . gettype($v) . ")<br/>";
+    }
+    $out .= "<br/>";
+
+    $out .= "# PHP options<br/>";
+    $out .= "- php version: " . phpversion() . "<br/>";
+    $out .= "- mcrypt version: " . phpversion('mcrypt') . "<br/>";
+    $php_options =  [
+        'post_max_size',
+        'upload_max_filesize',
+        'safe_mode',
+        'max_execution_time',
+        'max_input_time'
+    ];
+    foreach ($php_options as &$o) {
+        $v = ini_get($o);
+        $out .= "- $o: " . jirafeau_strval($v) . " (" . gettype($v). ")<br/>";
+    }
+    $out .= "- can set_time_limit: " . (set_time_limit(0) ? "yes" : "no") . "<br/>";
+    $out .= "<br/>";
+
+    $out .= "# File permissions<br/>";
+    $out .= "- 'var' folder permissions: " . jirafeau_fileperms($cfg['var_root']) . "<br/>";
+    $out .= "- 'file' folder permissions: " . jirafeau_fileperms(VAR_FILES) . "<br/>";
+    $out .= "- 'links' folder permissions: " . jirafeau_fileperms(VAR_LINKS) . "<br/>";
+    $out .= "- 'async' folder permissions: " . jirafeau_fileperms(VAR_ASYNC) . "<br/>";
+    $out .= "<br/>";
+
+    $out .= "# Server details<br/>";
+    $out .= "- server software: " . $_SERVER["SERVER_SOFTWARE"] . "<br/>";
+    $out .= "<br/>";
+
+    $out .= "# OS details<br/>";
+    $out .= "- OS: " . php_uname() . "<br/>";
+    $out .= "<br/>";
+
+    $out .= "# Browser details<br/>";
+    $out .= "<script type='text/javascript' lang='Javascript'>
+        // @license magnet:?xt=urn:btih:0b31508aeb0634b347b8270c7bee4d411b5d4109&dn=agpl-3.0.txt AGPL-v3-or-Later
+        document.write('- html5 support: ' + (check_html5_file_api() ? 'yes' : 'no') + '<br/>');
+        document.write('- user agent: ' + navigator.userAgent + '<br/>');
+        // @license-end
+        </script>";
+    $out .= "<br/>";
+
+    $out .= "# Memory<br/>";
+    $out .= "- memory_get_peak_usage: " . jirafeau_human_size(memory_get_peak_usage()) . "<br/>";
+
+    $out .= "</code></fieldset>";
+    return $out;
+}
+
+/**
+ * Read async transfer information
+ * @return array containing information.

  */
 function jirafeau_get_async_ref($ref)
 {
  */
 function jirafeau_get_async_ref($ref)
 {


@@ -812,7 +917,7 @@ function jirafeau_get_async_ref($ref)
 }
 
 /**
 }
 
 /**

- * Delete async transfert informations
+ * Delete async transfer information

  */
 function jirafeau_async_delete($ref)
 {
  */
 function jirafeau_async_delete($ref)
 {


@@ -836,17 +941,15 @@ function jirafeau_async_delete($ref)
 
 /**
   * Init a new asynchronous upload.
 
 /**
   * Init a new asynchronous upload.

-  * @param $finename Name of the file to send
+  * @param $filename Name of the file to send

   * @param $one_time One time upload parameter
   * @param $key eventual password (or blank)
   * @param $time time limit
   * @param $ip ip address of the client
   * @param $one_time One time upload parameter
   * @param $key eventual password (or blank)
   * @param $time time limit
   * @param $ip ip address of the client

-  * @return a string containing a temporary reference followed by a code or the string 'Error'
+  * @return a string containing a temporary reference followed by a code or a string starting with 'Error'

   */
 function jirafeau_async_init($filename, $type, $one_time, $key, $time, $ip)
 {
   */
 function jirafeau_async_init($filename, $type, $one_time, $key, $time, $ip)
 {

-    $res = 'Error';
-

     /* Create temporary folder. */
     $ref;
     $p;
     /* Create temporary folder. */
     $ref;
     $p;


@@ -857,8 +960,7 @@ function jirafeau_async_init($filename, $type, $one_time, $key, $time, $ip)
     } while (file_exists($p));
     @mkdir($p, 0755, true);
     if (!file_exists($p)) {
     } while (file_exists($p));
     @mkdir($p, 0755, true);
     if (!file_exists($p)) {

-        echo 'Error';
-        return;
+        return 'Error: cannot create async folder.';

     }
 
     /* touch empty data file */
     }
 
     /* touch empty data file */


@@ -871,7 +973,7 @@ function jirafeau_async_init($filename, $type, $one_time, $key, $time, $ip)
         $password = md5($key);
     }
 
         $password = md5($key);
     }
 

-    /* Store informations. */
+    /* Store information. */

     $p .= $ref;
     $handle = fopen($p, 'w');
     fwrite(
     $p .= $ref;
     $handle = fopen($p, 'w');
     fwrite(


@@ -892,7 +994,7 @@ function jirafeau_async_init($filename, $type, $one_time, $key, $time, $ip)
   * @param $file piece of data
   * @param $code client code for this operation
   * @param $max_file_size maximum allowed file size
   * @param $file piece of data
   * @param $code client code for this operation
   * @param $max_file_size maximum allowed file size

-  * @return a string containing a next code to use or the string "Error"
+  * @return a string containing a next code to use or a string starting with 'Error'

   */
 function jirafeau_async_push($ref, $data, $code, $max_file_size)
 {
   */
 function jirafeau_async_push($ref, $data, $code, $max_file_size)
 {


@@ -900,11 +1002,22 @@ function jirafeau_async_push($ref, $data, $code, $max_file_size)
     $a = jirafeau_get_async_ref($ref);
 
     /* Check some errors. */
     $a = jirafeau_get_async_ref($ref);
 
     /* Check some errors. */

-    if (count($a) == 0
-        || $a['next_code'] != "$code"
-        || empty($data['tmp_name'])
-        || !is_uploaded_file($data['tmp_name'])) {
-        return 'Error';
+    if (count($a) == 0) {
+        return "Error: cannot find transfer";
+    }
+    if ($a['next_code'] != "$code") {
+        return "Error: bad transfer code";
+    }
+    if ($data['error'] != UPLOAD_ERR_OK) {
+        // Check error code in https://www.php.net/manual/en/features.file-upload.errors.php
+        $data_details = print_r($data, true);
+        return "Error: upload error: {$data_details}";
+    }
+    if (empty($data['tmp_name'])) {
+        return "Error: missing tmp_name";
+    }
+    if (!is_uploaded_file($data['tmp_name'])) {
+        return "Error: tmp_name may not be uploaded";

     }
 
     $p = s2p($ref);
     }
 
     $p = s2p($ref);


@@ -917,7 +1030,7 @@ function jirafeau_async_push($ref, $data, $code, $max_file_size)
     if ($max_file_size > 0 &&
         filesize($r_path) + filesize($w_path) > $max_file_size * 1024 * 1024) {
         jirafeau_async_delete($ref);
     if ($max_file_size > 0 &&
         filesize($r_path) + filesize($w_path) > $max_file_size * 1024 * 1024) {
         jirafeau_async_delete($ref);

-        return 'Error';
+        return "Error: file size is above upload limit";

     }
 
     /* Concatenate data. */
     }
 
     /* Concatenate data. */


@@ -928,7 +1041,7 @@ function jirafeau_async_push($ref, $data, $code, $max_file_size)
             fclose($r);
             fclose($w);
             jirafeau_async_delete($ref);
             fclose($r);
             fclose($w);
             jirafeau_async_delete($ref);

-            return 'Error';
+            return "Error: cannot write file";

         }
     }
     fclose($r);
         }
     }
     fclose($r);


@@ -949,12 +1062,12 @@ function jirafeau_async_push($ref, $data, $code, $max_file_size)
 }
 
 /**
 }
 
 /**

-  * Finalyze an asynchronous upload.
+  * Finalize an asynchronous upload.

   * @param $ref asynchronous upload reference
   * @param $code client code for this operation
   * @param $crypt boolean asking to crypt or not
   * @param $link_name_length link name length
   * @param $ref asynchronous upload reference
   * @param $code client code for this operation
   * @param $crypt boolean asking to crypt or not
   * @param $link_name_length link name length

-  * @return a string containing the download reference followed by a delete code or the string 'Error'
+  * @return a string containing the download reference followed by a delete code or a string starting with 'Error'

   */
 function jirafeau_async_end($ref, $code, $crypt, $link_name_length, $file_hash_method)
 {
   */
 function jirafeau_async_end($ref, $code, $crypt, $link_name_length, $file_hash_method)
 {


@@ -962,13 +1075,13 @@ function jirafeau_async_end($ref, $code, $crypt, $link_name_length, $file_hash_m
     $a = jirafeau_get_async_ref($ref);
     if (count($a) == 0
         || $a['next_code'] != "$code") {
     $a = jirafeau_get_async_ref($ref);
     if (count($a) == 0
         || $a['next_code'] != "$code") {

-        return "Error";
+        return "Error: bad code for ending transfer";

     }
 
     /* Generate link infos. */
     $p = VAR_ASYNC . s2p($ref) . $ref . "_data";
     if (!file_exists($p)) {
     }
 
     /* Generate link infos. */
     $p = VAR_ASYNC . s2p($ref) . $ref . "_data";
     if (!file_exists($p)) {

-        return 'Error';
+        return "Error: referenced file does not exist";

     }
 
     $crypted = false;
     }
 
     $crypted = false;


@@ -1016,9 +1129,11 @@ function jirafeau_async_end($ref, $code, $crypt, $link_name_length, $file_hash_m
     fclose($handle);
     $hash_link = substr(base_16_to_64(md5_file($link_tmp_name)), 0, $link_name_length);
     $l = s2p("$hash_link");
     fclose($handle);
     $hash_link = substr(base_16_to_64(md5_file($link_tmp_name)), 0, $link_name_length);
     $l = s2p("$hash_link");

-    if (!@mkdir(VAR_LINKS . $l, 0755, true) ||
-        !rename($link_tmp_name, VAR_LINKS . $l . $hash_link)) {
-        return 'Error';
+    if (!@mkdir(VAR_LINKS . $l, 0755, true)) {
+        return "Error: cannot create folder in LINKS";
+    }
+    if (!rename($link_tmp_name, VAR_LINKS . $l . $hash_link)) {
+        return "Error: cannot rename file in LINKS";

     }
 
     /* Clean async upload. */
     }
 
     /* Clean async upload. */


@@ -1359,3 +1474,75 @@ function jirafeau_dir_size($dir)
     }
     return $size;
 }
     }
     return $size;
 }

+
+function jirafeau_export_cfg($cfg)
+{
+    $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'));
+    }
+}
+
+function jirafeau_mkdir($path)
+{
+    return !(!file_exists($path) && !@mkdir($path, 0755));
+}
+
+/**
+ * Returns true whether the path is writable or we manage to make it
+ * so, which essentially is the same thing.
+ * @param $path is the file or directory to be tested.
+ * @return true if $path is writable.
+ */
+function jirafeau_is_writable($path)
+{
+    /* "@" gets rid of error messages. */
+    return is_writable($path) || @chmod($path, 0777);
+}
+
+function jirafeau_check_var_dir($path)
+{
+    $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.');
+    $solution_str = t('HERE_SOLUTION') . ':';
+
+    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);
+    }
+
+    foreach (array('files', 'links', 'async') as $subdir) {
+        $subpath = $path.$subdir;
+
+        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);
+        }
+    }
+
+    return array('has_error' => false, 'why' => '');
+}
+
+function jirafeau_add_ending_slash($path)
+{
+    return $path . ((substr($path, -1) == '/') ? '' : '/');
+}
+
+function jirafeau_default_web_root()
+{
+    return $_SERVER['HTTP_HOST'] . str_replace(basename(__FILE__), '', $_SERVER['REQUEST_URI']);
+}