[TASK] re-arrange Docker overlays to speedup image creation

[jirafeau_project.git] / lib / functions.php

diff --git a/lib/functions.php b/lib/functions.php
index 27265bddf084970b11b8133297523579146d808a..1e084fbe33d9064f7153fc366af43a66831910d8 100644 (file)
--- a/lib/functions.php
+++ b/lib/functions.php
@@ -190,6 +190,9 @@ function jirafeau_ini_to_bytes($value)
     $modifier = substr($value, -1);
     $bytes = substr($value, 0, -1);
     switch (strtoupper($modifier)) {
     $modifier = substr($value, -1);
     $bytes = substr($value, 0, -1);
     switch (strtoupper($modifier)) {

+    default:
+        return intval($value);
+        break;

     case 'P':
         $bytes *= 1024;
         // no break
     case 'P':
         $bytes *= 1024;
         // no break


@@ -229,6 +232,30 @@ function jirafeau_get_max_upload_size()
     return jirafeau_human_size(jirafeau_get_max_upload_size_bytes());
 }
 
     return jirafeau_human_size(jirafeau_get_max_upload_size_bytes());
 }
 

+/**
+ * get the maximal upload size for a data chunk in async uploads
+ * @param max_upload_chunk_size_bytes
+ */
+function jirafeau_get_max_upload_chunk_size_bytes($max_upload_chunk_size_bytes = 0)
+{
+    if ($max_upload_chunk_size_bytes == 0) {
+        $size = jirafeau_get_max_upload_size_bytes();
+        // Jirafeau must choose an arbitrary number as PHP config does not give any limit nor $max_upload_chunk_size_bytes
+        if ($size == 0) {
+            return 10000000; // 10MB
+        }
+        return $size;
+    }
+    $size = min(
+        jirafeau_get_max_upload_size_bytes(),
+        $max_upload_chunk_size_bytes
+    );
+    if ($size == 0) {
+        return $max_upload_chunk_size_bytes;
+    }
+    return $size;
+}
+

 /**
  * gets a string explaining the error
  * @param $code the error code
 /**
  * gets a string explaining the error
  * @param $code the error code


@@ -564,13 +591,15 @@ function show_errors()
 
 function check_errors($cfg)
 {
 
 function check_errors($cfg)
 {

-    if (file_exists(JIRAFEAU_ROOT . 'install.php')
-        && !($cfg['installation_done'] === true)) {
-        header('Location: install.php');
-        exit;
+    if (!($cfg['installation_done'] === true)) {
+        if (file_exists(JIRAFEAU_ROOT . 'install.php')) {
+            header('Location: install.php');
+            exit;
+        } else {
+            add_error(t('INSTALL_FILE_NOT_FOUND_TITLE'), t('INSTALL_FILE_NOT_FOUND_DESC'));
+        }

     }
 
     }
 

-    /* Checking for errors. */

     if (!is_writable(VAR_FILES)) {
         add_error(t('FILE_DIR_W'), VAR_FILES);
     }
     if (!is_writable(VAR_FILES)) {
         add_error(t('FILE_DIR_W'), VAR_FILES);
     }


@@ -835,7 +864,8 @@ function jirafeau_admin_bug_report($cfg)
         'enable_crypt',
         'preview',
         'maximal_upload_size',
         'enable_crypt',
         'preview',
         'maximal_upload_size',

-        'store_uploader_ip'
+        'store_uploader_ip',
+        'max_upload_chunk_size_bytes'

     ];
     foreach ($jirafeau_options as &$o) {
         $v = $cfg[$o];
     ];
     foreach ($jirafeau_options as &$o) {
         $v = $cfg[$o];


@@ -946,12 +976,10 @@ function jirafeau_async_delete($ref)
   * @param $key eventual password (or blank)
   * @param $time time limit
   * @param $ip ip address of the client
   * @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;


@@ -962,8 +990,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 */


@@ -997,7 +1024,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)
 {


@@ -1005,11 +1032,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);


@@ -1022,7 +1060,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. */


@@ -1033,7 +1071,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);


@@ -1059,7 +1097,7 @@ function jirafeau_async_push($ref, $data, $code, $max_file_size)
   * @param $code client code for this operation
   * @param $crypt boolean asking to crypt or not
   * @param $link_name_length link name length
   * @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)
 {


@@ -1067,13 +1105,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;


@@ -1121,9 +1159,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. */


@@ -1534,5 +1574,5 @@ function jirafeau_add_ending_slash($path)
 
 function jirafeau_default_web_root()
 {
 
 function jirafeau_default_web_root()
 {

-    return $_SERVER['HTTP_HOST'] . str_replace(basename(__FILE__), '', $_SERVER['REQUEST_URI']);
+    return $_SERVER['HTTP_HOST'] . str_replace('install.php', '', $_SERVER['REQUEST_URI']);

 }
 }