lib/functions.php

   1 <?php
   2 /*
   3  *  Jirafeau, your web file repository
   4  *  Copyright (C) 2008  Julien "axolotl" BERNARD <axolotl@magieeternelle.org>
   5  *  Copyright (C) 2015  Jerome Jutteau <jerome@jutteau.fr>
   6  *  Copyright (C) 2024  Jirafeau project <https://gitlab.com/jirafeau> (see AUTHORS.md)
   7  *
   8  *  This program is free software: you can redistribute it and/or modify
   9  *  it under the terms of the GNU Affero General Public License as
  10  *  published by the Free Software Foundation, either version 3 of the
  11  *  License, or (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU Affero General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU Affero General Public License
  19  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  20  */
  21
  22 /**
  23  * Transform a string in a path by separating each letters by a '/'.
  24  * @return path finishing with a '/'
  25  */
  26 function s2p($s)
  27 {
  28     $block_size = 8;
  29     $p = '';
  30     for ($i = 0; $i < strlen($s); $i++) {
  31         $p .= $s[$i];
  32         if (($i + 1) % $block_size == 0) {
  33             $p .= '/';
  34         }
  35     }
  36     if (strlen($s) % $block_size != 0) {
  37         $p .= '/';
  38     }
  39     return $p;
  40 }
  41
  42 /**
  43  * Convert base 16 to base 64
  44  * @returns A string based on 64 characters (0-9, a-z, A-Z, "-" and "_")
  45  */
  46 function base_16_to_64($num)
  47 {
  48     $m = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-_';
  49     $hex2bin = array('0000',  # 0
  50                       '0001',  # 1
  51                       '0010',  # 2
  52                       '0011',  # 3
  53                       '0100',  # 4
  54                       '0101',  # 5
  55                       '0110',  # 6
  56                       '0111',  # 7
  57                       '1000',  # 8
  58                       '1001',  # 9
  59                       '1010',  # a
  60                       '1011',  # b
  61                       '1100',  # c
  62                       '1101',  # d
  63                       '1110',  # e
  64                       '1111'); # f
  65     $o = '';
  66     $b = '';
  67     $i = 0;
  68     # Convert long hex string to bin.
  69     $size = strlen($num);
  70     for ($i = 0; $i < $size; $i++) {
  71         $b .= $hex2bin[hexdec($num[$i])];
  72     }
  73     # Convert long bin to base 64.
  74     $size *= 4;
  75     for ($i = $size - 6; $i >= 0; $i -= 6) {
  76         $o = $m[bindec(substr($b, $i, 6))] . $o;
  77     }
  78     # Some few bits remaining ?
  79     if ($i < 0 && $i > -6) {
  80         $o = $m[bindec(substr($b, 0, $i + 6))] . $o;
  81     }
  82     return $o;
  83 }
  84
  85 /**
  86   * Generate a random code.
  87   * @param $l code length
  88   * @return  random code.
  89   */
  90 function jirafeau_gen_random($l)
  91 {
  92     if ($l <= 0) {
  93         return 42;
  94     }
  95
  96     $code="";
  97     for ($i = 0; $i < $l; $i++) {
  98         $code .= dechex(rand(0, 15));
  99     }
 100
 101     return $code;
 102 }
 103
 104 function jirafeau_gen_download_pass($length, $allowed_chars)
 105 {
 106     if ($length <= 0) {
 107         return false;
 108     }
 109     $pass="";
 110     for ($i = 0; $i < $length; $i++) {
 111         $pass .= $allowed_chars[rand(0, strlen($allowed_chars) - 1)];
 112     }
 113
 114     return $pass;
 115 }
 116
 117 function is_ssl()
 118 {
 119     if (isset($_SERVER['HTTPS'])) {
 120         if ('on' == strtolower($_SERVER['HTTPS']) ||
 121              '1' == $_SERVER['HTTPS']) {
 122             return true;
 123         }
 124     } elseif (isset($_SERVER['SERVER_PORT']) && ('443' == $_SERVER['SERVER_PORT'])) {
 125         return true;
 126     } elseif (isset($_SERVER['HTTP_X_FORWARDED_PROTO'])) {
 127         if ($_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') {
 128             return true;
 129         }
 130     }
 131     return false;
 132 }
 133
 134 function jirafeau_human_size($octets)
 135 {
 136     $u = array('B', 'KB', 'MB', 'GB', 'TB');
 137     $o = max($octets, 0);
 138     $p = min(floor(($o ? log($o) : 0) / log(1024)), count($u) - 1);
 139     $o /= pow(1024, $p);
 140     return round($o, 1) . $u[$p];
 141 }
 142
 143 // Convert UTC timestamp to a datetime field
 144 function jirafeau_get_datetimefield($timestamp)
 145 {
 146     $ts = date_create("@" . $timestamp);
 147     $content = '<span class="datetime" data-datetime="' . date_format($ts, 'Y-m-d H:i') . '">'
 148         . date_format($ts, 'Y-m-d H:i') . ' (GMT)</span>';
 149
 150     return $content;
 151 }
 152
 153 function jirafeau_fatal_error($errorText, $cfg = array())
 154 {
 155     echo '<div class="error"><h2>Error</h2><p>' . $errorText . '</p></div>';
 156     require(JIRAFEAU_ROOT . 'lib/template/footer.php');
 157     exit;
 158 }
 159
 160 function jirafeau_clean_rm_link($link)
 161 {
 162     $p = s2p("$link");
 163     if (file_exists(VAR_LINKS . $p . $link)) {
 164         unlink(VAR_LINKS . $p . $link);
 165     }
 166     if (file_exists(VAR_LINKS . $p . $link . '_download')) {
 167         unlink(VAR_LINKS . $p . $link . '_download');
 168     }
 169     $parse = VAR_LINKS . $p;
 170     $scan = array();
 171     while (file_exists($parse)
 172            && ($scan = scandir($parse))
 173            && count($scan) == 2 // '.' and '..' folders => empty.
 174            && basename($parse) != basename(VAR_LINKS)) {
 175         rmdir($parse);
 176         $parse = substr($parse, 0, strlen($parse) - strlen(basename($parse)) - 1);
 177     }
 178 }
 179
 180 function jirafeau_clean_rm_file($hash)
 181 {
 182     $p = s2p("$hash");
 183     $f = VAR_FILES . $p . $hash;
 184     if (file_exists($f) && is_file($f)) {
 185         unlink($f);
 186     }
 187     if (file_exists($f . '_count') && is_file($f . '_count')) {
 188         unlink($f . '_count');
 189     }
 190     $parse = VAR_FILES . $p;
 191     $scan = array();
 192     while (file_exists($parse)
 193            && ($scan = scandir($parse))
 194            && count($scan) == 2 // '.' and '..' folders => empty.
 195            && basename($parse) != basename(VAR_FILES)) {
 196         rmdir($parse);
 197         $parse = substr($parse, 0, strlen($parse) - strlen(basename($parse)) - 1);
 198     }
 199 }
 200
 201 /**
 202  * transforms a php.ini string representing a value in an integer
 203  * @param $value the value from php.ini
 204  * @returns an integer for this value
 205  */
 206 function jirafeau_ini_to_bytes($value)
 207 {
 208     $modifier = substr($value, -1);
 209     $bytes = substr($value, 0, -1);
 210     switch (strtoupper($modifier)) {
 211         default:
 212             return intval($value);
 213             break;
 214         case 'P':
 215             $bytes *= 1024;
 216             // no break
 217         case 'T':
 218             $bytes *= 1024;
 219             // no break
 220         case 'G':
 221             $bytes *= 1024;
 222             // no break
 223         case 'M':
 224             $bytes *= 1024;
 225             // no break
 226         case 'K':
 227             $bytes *= 1024;
 228     }
 229     return $bytes;
 230 }
 231
 232 /**
 233  * gets the maximum upload size according to php.ini
 234  * @returns the maximum upload size in bytes
 235  */
 236 function jirafeau_get_max_upload_size_bytes()
 237 {
 238     return min(
 239         jirafeau_ini_to_bytes(ini_get('post_max_size')),
 240         jirafeau_ini_to_bytes(ini_get('upload_max_filesize'))
 241     );
 242 }
 243
 244 /**
 245  * gets the maximum upload size according to php.ini
 246  * @returns the maximum upload size string
 247  */
 248 function jirafeau_get_max_upload_size()
 249 {
 250     return jirafeau_human_size(jirafeau_get_max_upload_size_bytes());
 251 }
 252
 253 /**
 254  * get the maximal upload size for a data chunk in async uploads
 255  * @param max_upload_chunk_size_bytes
 256  */
 257 function jirafeau_get_max_upload_chunk_size_bytes($max_upload_chunk_size_bytes = 0)
 258 {
 259     if ($max_upload_chunk_size_bytes == 0) {
 260         $size = jirafeau_get_max_upload_size_bytes();
 261         // Jirafeau must choose an arbitrary number as PHP config does not give any limit nor $max_upload_chunk_size_bytes
 262         if ($size == 0) {
 263             return 10000000; // 10MB
 264         }
 265         return $size;
 266     }
 267     $size = min(
 268         jirafeau_get_max_upload_size_bytes(),
 269         $max_upload_chunk_size_bytes
 270     );
 271     if ($size == 0) {
 272         return $max_upload_chunk_size_bytes;
 273     }
 274     return $size;
 275 }
 276
 277 /**
 278  * gets a string explaining the error
 279  * @param $code the error code
 280  * @returns a string explaining the error
 281  */
 282 function jirafeau_upload_errstr($code)
 283 {
 284     switch ($code) {
 285         case UPLOAD_ERR_INI_SIZE:
 286         case UPLOAD_ERR_FORM_SIZE:
 287             return t('Your file exceeds the maximum authorized file size. ');
 288
 289         case UPLOAD_ERR_PARTIAL:
 290         case UPLOAD_ERR_NO_FILE:
 291             return
 292                 t('Your file was not uploaded correctly. You may succeed in retrying. ');
 293
 294         case UPLOAD_ERR_NO_TMP_DIR:
 295         case UPLOAD_ERR_CANT_WRITE:
 296         case UPLOAD_ERR_EXTENSION:
 297             return t('Internal error. You may not succeed in retrying. ');
 298     }
 299     return t('Unknown error. ');
 300 }
 301
 302 /** Remove link and it's file
 303  * @param $link the link's name (hash)
 304  */
 305
 306 function jirafeau_delete_link($link)
 307 {
 308     $l = jirafeau_get_link($link);
 309     if (!count($l)) {
 310         return;
 311     }
 312
 313     jirafeau_clean_rm_link($link);
 314
 315     $hash = $l['hash'];
 316     $p = s2p("$hash");
 317
 318     $counter = 1;
 319     if (file_exists(VAR_FILES . $p . $hash. '_count')) {
 320         $content = file(VAR_FILES . $p . $hash. '_count');
 321         $counter = trim($content[0]);
 322     }
 323     $counter--;
 324
 325     if ($counter >= 1) {
 326         $handle = fopen(VAR_FILES . $p . $hash. '_count', 'w');
 327         fwrite($handle, $counter);
 328         fclose($handle);
 329     }
 330
 331     if ($counter == 0) {
 332         jirafeau_clean_rm_file($hash);
 333     }
 334 }
 335
 336 /**
 337  * Delete a file and it's links.
 338  */
 339 function jirafeau_delete_file($hash)
 340 {
 341     $count = 0;
 342     /* Get all links files. */
 343     $stack = array(VAR_LINKS);
 344     while (($d = array_shift($stack)) && $d != null) {
 345         $dir = scandir($d);
 346
 347         foreach ($dir as $node) {
 348             if (strcmp($node, '.') == 0 || strcmp($node, '..') == 0 ||
 349                 preg_match('/\.tmp/i', "$node")) {
 350                 continue;
 351             }
 352
 353             if (is_dir($d . $node)) {
 354                 /* Push new found directory. */
 355                 $stack[] = $d . $node . '/';
 356             } elseif (is_file($d . $node)) {
 357                 /* Read link informations. */
 358                 $l = jirafeau_get_link(basename($node));
 359                 if (!count($l)) {
 360                     continue;
 361                 }
 362                 if ($l['hash'] == $hash) {
 363                     $count++;
 364                     jirafeau_delete_link($node);
 365                 }
 366             }
 367         }
 368     }
 369     jirafeau_clean_rm_file($hash);
 370     return $count;
 371 }
 372
 373
 374 /** hash file's content
 375  * @param $method hash method, see 'file_hash' option. Valid methods are 'md5', 'md5_outside' or 'random'
 376  * @param $file_path file to hash
 377  * @returns hash string
 378  */
 379 function jirafeau_hash_file($method, $file_path)
 380 {
 381     switch ($method) {
 382         case 'md5_outside':
 383             return jirafeau_md5_outside($file_path);
 384         case 'md5':
 385             return md5_file($file_path);
 386         case 'random':
 387             return jirafeau_gen_random(32);
 388     }
 389     return md5_file($file_path);
 390 }
 391
 392 /** hash part of file: start, end and size.
 393  * This is a partial file hash, faster but weaker.
 394  * @param $file_path file to hash
 395  * @returns hash string
 396  */
 397 function jirafeau_md5_outside($file_path)
 398 {
 399     $out = false;
 400     $handle = fopen($file_path, "r");
 401     if ($handle === false) {
 402         return false;
 403     }
 404     $size = filesize($file_path);
 405     if ($size === false) {
 406         goto err;
 407     }
 408     $first = fread($handle, 64);
 409     if ($first === false) {
 410         goto err;
 411     }
 412     if (fseek($handle, $size < 64 ? 0 : $size - 64) == -1) {
 413         goto err;
 414     }
 415     $last = fread($handle, 64);
 416     if ($last === false) {
 417         goto err;
 418     }
 419     $out = md5($first . $last . $size);
 420     err:
 421     fclose($handle);
 422     return $out;
 423 }
 424
 425 /**
 426  * handles an uploaded file
 427  * @param $file the file struct given by $_FILE[]
 428  * @param $one_time_download is the file a one time download ?
 429  * @param $key if not empty, protect the file with this key
 430  * @param $time the time of validity of the file
 431  * @param $ip uploader's ip
 432  * @param $crypt boolean asking to crypt or not
 433  * @param $link_name_length size of the link name
 434  * @returns an array containing some information
 435  *   'error' => information on possible errors
 436  *   'link' => the link name of the uploaded file
 437  *   'delete_link' => the link code to delete file
 438  */
 439 function jirafeau_upload($file, $one_time_download, $key, $time, $ip, $crypt, $link_name_length, $file_hash_method)
 440 {
 441     if (empty($file['tmp_name']) || !is_uploaded_file($file['tmp_name'])) {
 442         return (array(
 443                  'error' =>
 444                    array('has_error' => true,
 445                           'why' => jirafeau_upload_errstr($file['error'])),
 446                  'link' => '',
 447                  'delete_link' => ''));
 448     }
 449     jirafeau_add_file($file, $one_time_download, $key, $time, $ip, $crypt, $link_name_length, $file_hash_method);
 450 }
 451
 452 /**
 453  *
 454  * @param bool $crypt_module_enabled
 455  * @param string $file_path
 456  * @return array [bool, string]
 457  */
 458 function jirafeau_handle_add_file_encryption($crypt_module_enabled, $file_path) {
 459     /* Crypt file if option is enabled. */
 460     $crypted = false;
 461     $crypt_key = '';
 462     if ($crypt_module_enabled == true && !(extension_loaded('sodium') == true)) {
 463         error_log("PHP extension sodium not loaded, won't encrypt in Jirafeau");
 464     }
 465     if ($crypt_module_enabled == true && extension_loaded('sodium') == true) {
 466         $crypt_key = jirafeau_encrypt_file($file_path, $file_path.'crypt');
 467         if (strlen($crypt_key) > 0) {
 468             if (rename($file_path.'crypt', $file_path) === true) {
 469                 $crypted = true;
 470             }
 471         }
 472     }
 473
 474     return [$crypted, $crypt_key];
 475 }
 476
 477 /**
 478  * adds an uploaded or copy/linked local file
 479  * @param $file the file struct given by $_FILE[]
 480  * @param $one_time_download is the file a one time download ?
 481  * @param $key if not empty, protect the file with this key
 482  * @param $time the time of validity of the file
 483  * @param $ip uploader's ip
 484  * @param $crypt boolean asking to crypt or not
 485  * @param $link_name_length size of the link name
 486  * @param $is_upload, determines if the file is uploaded or local - it controls which file-functions are used
 487  * @return array  an array containing some information
 488  *   'error' => information on possible errors
 489  *   'link' => the link name of the uploaded file
 490  *   'delete_link' => the link code to delete file
 491  */
 492 function jirafeau_add_file($file, $one_time_download, $key, $time, $ip, $crypt, $link_name_length, $file_hash_method, $is_upload = true)
 493 {
 494     // TODO needs to be adapted
 495     $move_operation = $is_upload ? 'move_uploaded_file' : 'symlink';
 496
 497     /* array representing no error */
 498     $noerr = array('has_error' => false, 'why' => '');
 499
 500     $crypted = false;
 501     $crypt_key = '';
 502     list($crypted, $crypt_key) = jirafeau_handle_add_file_encryption($crypt, $file['tmp_name']);
 503
 504
 505     /* file information */
 506     $hash = jirafeau_hash_file($file_hash_method, $file['tmp_name']);
 507     $name = str_replace(NL, '', trim($file['name']));
 508     $mime_type = $file['type'];
 509     $size = $file['size'];
 510
 511     /* does file already exist ? */
 512     $rc = false;
 513     $p = s2p("$hash");
 514     if (file_exists(VAR_FILES . $p .  $hash)) {
 515         $rc = unlink($file['tmp_name']);
 516     } elseif ((file_exists(VAR_FILES . $p) || @mkdir(VAR_FILES . $p, 0755, true))
 517             &&
 518             //move_uploaded_file($file['tmp_name'], VAR_FILES . $p . $hash))
 519             $move_operation($file['tmp_name'], VAR_FILES . $p . $hash))
 520             {
 521
 522         $rc = true;
 523     }
 524     if (!$rc) {
 525         return (array(
 526                  'error' =>
 527                    array('has_error' => true,
 528                           'why' => t('INTERNAL_ERROR_DEL')),
 529                  'link' =>'',
 530                  'delete_link' => ''));
 531     }
 532
 533     /* Increment or create count file. */
 534     $counter = 0;
 535     if (file_exists(VAR_FILES . $p . $hash . '_count')) {
 536         $content = file(VAR_FILES . $p . $hash. '_count');
 537         $counter = trim($content[0]);
 538     }
 539     $counter++;
 540     $handle = fopen(VAR_FILES . $p . $hash. '_count', 'w');
 541     fwrite($handle, $counter);
 542     fclose($handle);
 543
 544     /* Create delete code. */
 545     $delete_link_code = jirafeau_gen_random(5);
 546
 547     /* hash password or empty. */
 548     $password = '';
 549     if (!empty($key)) {
 550         $password = md5($key);
 551     }
 552
 553     /* create link file */
 554     $link_tmp_name =  VAR_LINKS . $hash . rand(0, 10000) . '.tmp';
 555     $handle = fopen($link_tmp_name, 'w');
 556     fwrite(
 557         $handle,
 558         $name . NL. $mime_type . NL. $size . NL. $password . NL. $time .
 559             NL . $hash. NL . ($one_time_download ? 'O' : 'R') . NL . time() .
 560             NL . $ip . NL. $delete_link_code . NL . ($crypted ? 'C' : 'O')
 561     );
 562     fclose($handle);
 563     $hash_link = substr(base_16_to_64(md5_file($link_tmp_name)), 0, $link_name_length);
 564     $l = s2p("$hash_link");
 565     if (!@mkdir(VAR_LINKS . $l, 0755, true) ||
 566         !rename($link_tmp_name, VAR_LINKS . $l . $hash_link)) {
 567         if (file_exists($link_tmp_name)) {
 568             unlink($link_tmp_name);
 569         }
 570
 571         $counter--;
 572         if ($counter >= 1) {
 573             $handle = fopen(VAR_FILES . $p . $hash. '_count', 'w');
 574             fwrite($handle, $counter);
 575             fclose($handle);
 576         } else {
 577             jirafeau_clean_rm_file($hash_link);
 578         }
 579         return array(
 580                  'error' =>
 581                    array('has_error' => true,
 582                           'why' => t('Internal error during file creation. ')),
 583                  'link' =>'',
 584                  'delete_link' => '');
 585     }
 586     return array( 'error' => $noerr,
 587                   'link' => $hash_link,
 588                   'delete_link' => $delete_link_code,
 589                   'crypt_key' => $crypt_key);
 590 }
 591
 592
 593 function jirafeau_admin_list_table ($name, $file_hash, $link_hash, $visitor_function = null) {
 594     echo '<fieldset><legend>';
 595     if (!empty($name)) {
 596         echo t('FILENAME') . ": " . jirafeau_escape($name);
 597     }
 598     if (!empty($file_hash)) {
 599         echo t('FILE') . ": " . jirafeau_escape($file_hash);
 600     }
 601     if (!empty($link_hash)) {
 602         echo t('LINK') . ": " . jirafeau_escape($link_hash);
 603     }
 604     if (empty($name) && empty($file_hash) && empty($link_hash)) {
 605         echo t('LS_FILES');
 606     }
 607     echo '</legend>';
 608     echo '<table>';
 609     echo '<tr>';
 610     echo '<th></th>';
 611     echo '<th>' . t('ACTION') . '</th>';
 612     echo '</tr>';
 613     if ($visitor_function != null) {
 614         $visitor_function($name, $file_hash, $link_hash);
 615     }
 616     echo '</table></fieldset>';
 617 }
 618
 619
 620
 621
 622
 623 /**
 624  * Tells if a mime-type is viewable in a browser
 625  * @param $mime the mime type
 626  * @returns a boolean telling if a mime type is viewable
 627  */
 628 function jirafeau_is_viewable($mime)
 629 {
 630     if (!empty($mime)) {
 631         $viewable = array('image', 'video', 'audio');
 632         $decomposed = explode('/', $mime);
 633         if (in_array($decomposed[0], $viewable) && strpos($mime, 'image/svg+xml') === false) {
 634             return true;
 635         }
 636         $viewable = array('text/plain');
 637         if (in_array($mime, $viewable)) {
 638             return true;
 639         }
 640     }
 641     return false;
 642 }
 643
 644 // Error handling functions.
 645 //! Global array that contains all registered errors.
 646 $error_list = array();
 647
 648 /**
 649  * Adds an error to the list of errors.
 650  * @param $title the error's title
 651  * @param $description is a human-friendly description of the problem.
 652  */
 653 function add_error($title, $description)
 654 {
 655     global $error_list;
 656     $error_list[] = '<p>' . $title. '<br />' . $description. '</p>';
 657 }
 658
 659 /**
 660  * Informs whether any error has been registered yet.
 661  * @return true if there are errors.
 662  */
 663 function has_error()
 664 {
 665     global $error_list;
 666     return !empty($error_list);
 667 }
 668
 669 /**
 670  * Displays all the errors.
 671  */
 672 function show_errors()
 673 {
 674     if (has_error()) {
 675         global $error_list;
 676         echo '<div class="error">';
 677         foreach ($error_list as $error) {
 678             echo $error;
 679         }
 680         echo '</div>';
 681     }
 682 }
 683
 684 function check_errors($cfg)
 685 {
 686     if (!($cfg['installation_done'] === true)) {
 687         if (file_exists(JIRAFEAU_ROOT . 'install.php')) {
 688             header('Location: install.php');
 689             exit;
 690         } else {
 691             add_error(t('INSTALL_FILE_NOT_FOUND_TITLE'), t('INSTALL_FILE_NOT_FOUND_DESC'));
 692         }
 693     }
 694
 695     if (!is_writable(VAR_FILES)) {
 696         add_error(t('FILE_DIR_W'), VAR_FILES);
 697     }
 698
 699     if (!is_writable(VAR_LINKS)) {
 700         add_error(t('LINK_DIR_W'), VAR_LINKS);
 701     }
 702
 703     if (!is_writable(VAR_ASYNC)) {
 704         add_error(t('ASYNC_DIR_W'), VAR_ASYNC);
 705     }
 706
 707     if ($cfg['enable_crypt'] && $cfg['litespeed_workaround']) {
 708         add_error(t('INCOMPATIBLE_OPTIONS_W'), 'enable_crypt=true<br>litespeed_workaround=true');
 709     }
 710
 711     if ($cfg['one_time_download'] && $cfg['litespeed_workaround']) {
 712         add_error(t('INCOMPATIBLE_OPTIONS_W'), 'one_time_download=true<br>litespeed_workaround=true');
 713     }
 714 }
 715
 716 /**
 717  * Read link information
 718  * @return array containing information.
 719  */
 720 function jirafeau_get_link($hash)
 721 {
 722     $out = array();
 723     $link = VAR_LINKS . s2p("$hash") . $hash;
 724
 725     if (!file_exists($link)) {
 726         return $out;
 727     }
 728
 729     $c = file($link);
 730     $out['file_name'] = trim($c[0]);
 731     $out['mime_type'] = trim($c[1]);
 732     $out['file_size'] = trim($c[2]);
 733     $out['key'] = trim($c[3], NL);
 734     $out['time'] = trim($c[4]);
 735     $out['hash'] = trim($c[5]);
 736     $out['onetime'] = trim($c[6]);
 737     $out['upload_date'] = trim($c[7]);
 738     $out['ip'] = trim($c[8]);
 739     $out['link_code'] = trim($c[9]);
 740     $out['crypted'] = trim($c[10]) == 'C2';
 741     $out['crypted_legacy'] = trim($c[10]) == 'C';
 742
 743     return $out;
 744 }
 745
 746 /**
 747  * List files ii folder in admin interface.
 748  */
 749 function jirafeau_admin_list($name, $file_hash, $link_hash)
 750 {
 751     $function = function($name, $file_hash, $link_hash) {
 752          /* Get all links files. */
 753         $stack = array(VAR_LINKS);
 754         while (($d = array_shift($stack)) && $d != null) {
 755             $dir = scandir($d);
 756             foreach ($dir as $node) {
 757                 if (strcmp($node, '.') == 0 || strcmp($node, '..') == 0 ||
 758                     preg_match('/\.tmp/i', "$node")) {
 759                     continue;
 760                 }
 761                 if (is_dir($d . $node)) {
 762                     /* Push new found directory. */
 763                     $stack[] = $d . $node . '/';
 764                 } elseif (is_file($d . $node)) {
 765                     /* Read link information. */
 766                     $l = jirafeau_get_link($node);
 767                     if (!count($l)) {
 768                         continue;
 769                     }
 770
 771                     /* Filter. */
 772                     if (!empty($name) && !@preg_match("/$name/i", jirafeau_escape($l['file_name']))) {
 773                         continue;
 774                     }
 775                     if (!empty($file_hash) && $file_hash != $l['hash']) {
 776                         continue;
 777                     }
 778                     if (!empty($link_hash) && $link_hash != $node) {
 779                         continue;
 780                     }
 781                     /* Print link information. */
 782                     echo '<tr>';
 783                     echo '<td>' .
 784                     '<strong><a id="upload_link" href="f.php?h='. jirafeau_escape($node) .'" title="' .
 785                         t('DL_PAGE') . '">' . jirafeau_escape($l['file_name']) . '</a></strong><br/>';
 786                     echo t('TYPE') . ': ' . jirafeau_escape($l['mime_type']) . '<br/>';
 787                     echo t('SIZE') . ': ' . jirafeau_human_size($l['file_size']) . '<br>';
 788                     echo t('EXPIRE') . ': ' . ($l['time'] == -1 ? '∞' : jirafeau_get_datetimefield($l['time'])) . '<br/>';
 789                     echo t('ONETIME') . ': ' . ($l['onetime'] == 'O' ? 'Yes' : 'No') . '<br/>';
 790                     echo t('UPLOAD_DATE') . ': ' . jirafeau_get_datetimefield($l['upload_date']) . '<br/>';
 791                     if (strlen($l['ip']) > 0) {
 792                         echo t('ORIGIN') . ': ' . $l['ip'] . '<br/>';
 793                     }
 794                     echo '</td><td>';
 795                     echo '<form method="post">' .
 796                     '<input type = "hidden" name = "action" value = "download"/>' .
 797                     '<input type = "hidden" name = "link" value = "' . $node . '"/>' .
 798                     jirafeau_admin_csrf_field() .
 799                     '<input type = "submit" value = "' . t('DL') . '" />' .
 800                     '</form>' .
 801                     '<form method="post">' .
 802                     '<input type = "hidden" name = "action" value = "delete_link"/>' .
 803                     '<input type = "hidden" name = "link" value = "' . $node . '"/>' .
 804                     jirafeau_admin_csrf_field() .
 805                     '<input type = "submit" value = "' . t('DEL_LINK') . '" />' .
 806                     '</form>' .
 807                     '<form method="post">' .
 808                     '<input type = "hidden" name = "action" value = "delete_file"/>' .
 809                     '<input type = "hidden" name = "hash" value = "' . $l['hash'] . '"/>' .
 810                     jirafeau_admin_csrf_field() .
 811                     '<input type = "submit" value = "' . t('DEL_FILE_LINKS') . '" />' .
 812                     '</form>' .
 813                     '</td>';
 814                     echo '</tr>';
 815                 }
 816             }
 817         }
 818         };
 819         jirafeau_admin_list_table($name, $file_hash, $link_hash, $function);
 820 }
 821
 822 /**
 823  * Clean expired files.
 824  * @return number of cleaned files.
 825  */
 826 function jirafeau_admin_clean()
 827 {
 828     $count = 0;
 829     /* Get all links files. */
 830     $stack = array(VAR_LINKS);
 831     while (($d = array_shift($stack)) && $d != null) {
 832         $dir = scandir($d);
 833
 834         foreach ($dir as $node) {
 835             if (strcmp($node, '.') == 0 || strcmp($node, '..') == 0 ||
 836                 preg_match('/\.tmp/i', "$node")) {
 837                 continue;
 838             }
 839
 840             if (is_dir($d . $node)) {
 841                 /* Push new found directory. */
 842                 $stack[] = $d . $node . '/';
 843             } elseif (is_file($d . $node)) {
 844                 /* Read link information. */
 845                 $l = jirafeau_get_link(basename($node));
 846                 if (!count($l)) {
 847                     continue;
 848                 }
 849                 $p = s2p($l['hash']);
 850                 if ($l['time'] > 0 && $l['time'] < time() || // expired
 851                     !file_exists(VAR_FILES . $p . $l['hash']) || // invalid
 852                     !file_exists(VAR_FILES . $p . $l['hash'] . '_count')) { // invalid
 853                     jirafeau_delete_link($node);
 854                     $count++;
 855                 }
 856             }
 857         }
 858     }
 859     return $count;
 860 }
 861
 862
 863 /**
 864  * Clean old async transfers.
 865  * @return number of cleaned files.
 866  */
 867 function jirafeau_admin_clean_async()
 868 {
 869     $count = 0;
 870     /* Get all links files. */
 871     $stack = array(VAR_ASYNC);
 872     while (($d = array_shift($stack)) && $d != null) {
 873         $dir = scandir($d);
 874
 875         foreach ($dir as $node) {
 876             if (strcmp($node, '.') == 0 || strcmp($node, '..') == 0 ||
 877                 preg_match('/\.tmp/i', "$node")) {
 878                 continue;
 879             }
 880
 881             if (is_dir($d . $node)) {
 882                 /* Push new found directory. */
 883                 $stack[] = $d . $node . '/';
 884             } elseif (is_file($d . $node)) {
 885                 /* Read async information. */
 886                 $a = jirafeau_get_async_ref(basename($node));
 887                 if (!count($a)) {
 888                     continue;
 889                 }
 890                 /* Delete transfers older than 1 hour. */
 891                 if (time() - $a['last_edited'] > 3600) {
 892                     jirafeau_async_delete(basename($node));
 893                     $count++;
 894                 }
 895             }
 896         }
 897     }
 898     return $count;
 899 }
 900
 901 /**
 902  * Better strval function for debug purposes
 903  */
 904 function jirafeau_strval($value)
 905 {
 906     if (gettype($value) == "boolean") {
 907         return $value ? 'true' : 'false';
 908     }
 909     return strval($value);
 910 }
 911
 912 /**
 913  * Show file/folder permissions
 914  */
 915 function jirafeau_fileperms($path)
 916 {
 917     $out = substr(sprintf("%o", @fileperms($path)), -4) . ", ";
 918     $out .= "read " . (is_readable($path) ? "OK" : "KO") . ", ";
 919     $out .= "write " . (is_writable($path) ? "OK" : "KO");
 920     return $out;
 921 }
 922
 923 /**
 924  * Show some useful informations for bug reporting.
 925  */
 926 function jirafeau_admin_bug_report($cfg)
 927 {
 928     $out = "<fieldset><legend>" . t('REPORTING_AN_ISSUE') . "</legend>";
 929     $out .= "If you have a problem related to Jirafeau, please <a href='" . JIRAFEAU_WEBSITE . "/-/issues'>open an issue</a>, explain your problem in english and copy-paste the following content:<br/><br/><code>";
 930
 931     $out .= "# Jirafeau<br/>";
 932     $out .= "- version: " . JIRAFEAU_VERSION . "<br/>";
 933     $jirafeau_options = [
 934         'debug',
 935         'file_hash',
 936         'litespeed_workaround',
 937         'store_uploader_ip',
 938         'installation_done',
 939         'enable_crypt',
 940         'preview',
 941         'maximal_upload_size',
 942         'store_uploader_ip',
 943         'max_upload_chunk_size_bytes'
 944     ];
 945     foreach ($jirafeau_options as &$o) {
 946         $v = $cfg[$o];
 947         $out .= "- $o: " . jirafeau_strval($v) . " (" . gettype($v) . ")<br/>";
 948     }
 949     $out .= "<br/>";
 950
 951     $out .= "# PHP options<br/>";
 952     $out .= "- php version: " . phpversion() . "<br/>";
 953     $out .= "- sodium version: " . phpversion('sodium') . "<br/>";
 954     $out .= "- mcrypt version: " . phpversion('mcrypt') . "<br/>";
 955     $php_options =  [
 956         'post_max_size',
 957         'upload_max_filesize',
 958         'safe_mode',
 959         'max_execution_time',
 960         'max_input_time'
 961     ];
 962     foreach ($php_options as &$o) {
 963         $v = ini_get($o);
 964         $out .= "- $o: " . jirafeau_strval($v) . " (" . gettype($v). ")<br/>";
 965     }
 966     $out .= "- can set_time_limit: " . (set_time_limit(0) ? "yes" : "no") . "<br/>";
 967     $out .= "<br/>";
 968
 969     $out .= "# File permissions<br/>";
 970     $out .= "- 'var' folder permissions: " . jirafeau_fileperms($cfg['var_root']) . "<br/>";
 971     $out .= "- 'file' folder permissions: " . jirafeau_fileperms(VAR_FILES) . "<br/>";
 972     $out .= "- 'links' folder permissions: " . jirafeau_fileperms(VAR_LINKS) . "<br/>";
 973     $out .= "- 'async' folder permissions: " . jirafeau_fileperms(VAR_ASYNC) . "<br/>";
 974     $out .= "<br/>";
 975
 976     $out .= "# Server details<br/>";
 977     $out .= "- server software: " . $_SERVER["SERVER_SOFTWARE"] . "<br/>";
 978     $out .= "<br/>";
 979
 980     $out .= "# OS details<br/>";
 981     $out .= "- OS: " . php_uname() . "<br/>";
 982     $out .= "<br/>";
 983
 984     $out .= "# Browser details<br/>";
 985     $out .= "<script type='text/javascript' lang='Javascript'>
 986         // @license magnet:?xt=urn:btih:0b31508aeb0634b347b8270c7bee4d411b5d4109&dn=agpl-3.0.txt AGPL-v3-or-Later
 987         document.write('- html5 support: ' + (check_html5_file_api() ? 'yes' : 'no') + '<br/>');
 988         document.write('- user agent: ' + navigator.userAgent + '<br/>');
 989         // @license-end
 990         </script>";
 991     $out .= "<br/>";
 992
 993     $out .= "# Memory<br/>";
 994     $out .= "- memory_get_peak_usage: " . jirafeau_human_size(memory_get_peak_usage()) . "<br/>";
 995
 996     $out .= "</code></fieldset>";
 997     return $out;
 998 }
 999
1000 /**
1001  * Read async transfer information
1002  * @return array containing information.
1003  */
1004 function jirafeau_get_async_ref($ref)
1005 {
1006     $out = array();
1007     $refinfos = VAR_ASYNC . s2p("$ref") . "$ref";
1008
1009     if (!file_exists($refinfos)) {
1010         return $out;
1011     }
1012
1013     $c = file($refinfos);
1014     $out['file_name'] = trim($c[0]);
1015     $out['mime_type'] = trim($c[1]);
1016     $out['key'] = trim($c[2], NL);
1017     $out['time'] = trim($c[3]);
1018     $out['onetime'] = trim($c[4]);
1019     $out['ip'] = trim($c[5]);
1020     $out['last_edited'] = trim($c[6]);
1021     $out['next_code'] = trim($c[7]);
1022     return $out;
1023 }
1024
1025 /**
1026  * Delete async transfer information
1027  */
1028 function jirafeau_async_delete($ref)
1029 {
1030     $p = s2p("$ref");
1031     if (file_exists(VAR_ASYNC . $p . $ref)) {
1032         unlink(VAR_ASYNC . $p . $ref);
1033     }
1034     if (file_exists(VAR_ASYNC . $p . $ref . '_data')) {
1035         unlink(VAR_ASYNC . $p . $ref . '_data');
1036     }
1037     $parse = VAR_ASYNC . $p;
1038     $scan = array();
1039     while (file_exists($parse)
1040            && ($scan = scandir($parse))
1041            && count($scan) == 2 // '.' and '..' folders => empty.
1042            && basename($parse) != basename(VAR_ASYNC)) {
1043         rmdir($parse);
1044         $parse = substr($parse, 0, strlen($parse) - strlen(basename($parse)) - 1);
1045     }
1046 }
1047
1048 /**
1049   * Init a new asynchronous upload.
1050   * @param $filename Name of the file to send
1051   * @param $one_time One time upload parameter
1052   * @param $key eventual password (or blank)
1053   * @param $time time limit
1054   * @param $ip ip address of the client
1055   * @return a string containing a temporary reference followed by a code or a string starting with 'Error'
1056   */
1057 function jirafeau_async_init($filename, $type, $one_time, $key, $time, $ip)
1058 {
1059     /* Create temporary folder. */
1060     $ref = '';
1061     $p = '';
1062     $code = jirafeau_gen_random(4);
1063     do {
1064         $ref = jirafeau_gen_random(32);
1065         $p = VAR_ASYNC . s2p($ref);
1066     } while (file_exists($p));
1067     @mkdir($p, 0755, true);
1068     if (!file_exists($p)) {
1069         return 'Error: cannot create async folder.';
1070     }
1071
1072     /* touch empty data file */
1073     $w_path = $p . $ref . '_data';
1074     touch($w_path);
1075
1076     /* md5 password or empty */
1077     $password = '';
1078     if (!empty($key)) {
1079         $password = md5($key);
1080     }
1081
1082     /* Store information. */
1083     $p .= $ref;
1084     $handle = fopen($p, 'w');
1085     fwrite(
1086         $handle,
1087         str_replace(NL, '', trim($filename)) . NL .
1088             str_replace(NL, '', trim($type)) . NL . $password . NL .
1089             $time . NL . ($one_time ? 'O' : 'R') . NL . $ip . NL .
1090             time() . NL . $code . NL
1091     );
1092     fclose($handle);
1093
1094     return $ref . NL . $code ;
1095 }
1096
1097 /**
1098   * Append a piece of file on the asynchronous upload.
1099   * @param $ref asynchronous upload reference
1100   * @param $file piece of data
1101   * @param $code client code for this operation
1102   * @param $max_file_size maximum allowed file size
1103   * @return a string containing a next code to use or a string starting with 'Error'
1104   */
1105 function jirafeau_async_push($ref, $data, $code, $max_file_size)
1106 {
1107     /* Get async infos. */
1108     $a = jirafeau_get_async_ref($ref);
1109
1110     /* Check some errors. */
1111     if (count($a) == 0) {
1112         return "Error: cannot find transfer";
1113     }
1114     if ($a['next_code'] != "$code") {
1115         return "Error: bad transfer code";
1116     }
1117     if ($data['error'] != UPLOAD_ERR_OK) {
1118         // Check error code in https://www.php.net/manual/en/features.file-upload.errors.php
1119         $data_details = print_r($data, true);
1120         return "Error: upload error: {$data_details}";
1121     }
1122     if (empty($data['tmp_name'])) {
1123         return "Error: missing tmp_name";
1124     }
1125     if (!is_uploaded_file($data['tmp_name'])) {
1126         return "Error: tmp_name may not be uploaded";
1127     }
1128
1129     $p = s2p($ref);
1130
1131     /* File path. */
1132     $r_path = $data['tmp_name'];
1133     $w_path = VAR_ASYNC . $p . $ref . '_data';
1134
1135     /* Check that file size is not above upload limit. */
1136     if ($max_file_size > 0 &&
1137         filesize($r_path) + filesize($w_path) > $max_file_size * 1024 * 1024) {
1138         jirafeau_async_delete($ref);
1139         return "Error: file size is above upload limit";
1140     }
1141
1142     /* Concatenate data. */
1143     $r = fopen($r_path, 'r');
1144     $w = fopen($w_path, 'a');
1145     while (!feof($r)) {
1146         if (fwrite($w, fread($r, 1024)) === false) {
1147             fclose($r);
1148             fclose($w);
1149             jirafeau_async_delete($ref);
1150             return "Error: cannot write file";
1151         }
1152     }
1153     fclose($r);
1154     fclose($w);
1155     unlink($r_path);
1156
1157     /* Update async file. */
1158     $code = jirafeau_gen_random(4);
1159     $handle = fopen(VAR_ASYNC . $p . $ref, 'w');
1160     fwrite(
1161         $handle,
1162         $a['file_name'] . NL. $a['mime_type'] . NL. $a['key'] . NL .
1163             $a['time'] . NL . $a['onetime'] . NL . $a['ip'] . NL .
1164             time() . NL . $code . NL
1165     );
1166     fclose($handle);
1167     return $code;
1168 }
1169
1170 /**
1171   * Finalize an asynchronous upload.
1172   * @param $ref asynchronous upload reference
1173   * @param $code client code for this operation
1174   * @param $crypt boolean asking to crypt or not
1175   * @param $link_name_length link name length
1176   * @return a string containing the download reference followed by a delete code or a string starting with 'Error'
1177   */
1178 function jirafeau_async_end($ref, $code, $crypt, $link_name_length, $file_hash_method)
1179 {
1180     /* Get async infos. */
1181     $a = jirafeau_get_async_ref($ref);
1182     if (count($a) == 0
1183         || $a['next_code'] != "$code") {
1184         return "Error: bad code for ending transfer";
1185     }
1186
1187     /* Generate link infos. */
1188     $p = VAR_ASYNC . s2p($ref) . $ref . "_data";
1189     if (!file_exists($p)) {
1190         return "Error: referenced file does not exist";
1191     }
1192
1193     $crypted = false;
1194     $crypt_key = '';
1195     if ($crypt == true && extension_loaded('sodium') == true) {
1196         $crypt_key = jirafeau_encrypt_file($p, $p.'.crypt');
1197         if (strlen($crypt_key) > 0) {
1198             if (rename($p.'.crypt', $p) === true) {
1199                 $crypted = true;
1200             }
1201         }
1202     }
1203
1204     $hash = jirafeau_hash_file($file_hash_method, $p);
1205     $size = filesize($p);
1206     $np = s2p($hash);
1207     $delete_link_code = jirafeau_gen_random(5);
1208
1209     /* File already exist ? */
1210     if (!file_exists(VAR_FILES . $np)) {
1211         @mkdir(VAR_FILES . $np, 0755, true);
1212     }
1213     if (!file_exists(VAR_FILES . $np . $hash)) {
1214         rename($p, VAR_FILES . $np . $hash);
1215     }
1216
1217     /* Increment or create count file. */
1218     $counter = 0;
1219     if (file_exists(VAR_FILES . $np . $hash . '_count')) {
1220         $content = file(VAR_FILES . $np . $hash. '_count');
1221         $counter = trim($content[0]);
1222     }
1223     $counter++;
1224     $handle = fopen(VAR_FILES . $np . $hash. '_count', 'w');
1225     fwrite($handle, $counter);
1226     fclose($handle);
1227
1228     /* Create link. */
1229     $link_tmp_name =  VAR_LINKS . $hash . rand(0, 10000) . '.tmp';
1230     $handle = fopen($link_tmp_name, 'w');
1231     fwrite(
1232         $handle,
1233         $a['file_name'] . NL . $a['mime_type'] . NL . $size . NL .
1234             $a['key'] . NL . $a['time'] . NL . $hash . NL . $a['onetime'] . NL .
1235             time() . NL . $a['ip'] . NL . $delete_link_code . NL . ($crypted ? 'C2' : 'O')
1236     );
1237     fclose($handle);
1238     $hash_link = substr(base_16_to_64(md5_file($link_tmp_name)), 0, $link_name_length);
1239     $l = s2p("$hash_link");
1240     if (!@mkdir(VAR_LINKS . $l, 0755, true)) {
1241         return "Error: cannot create folder in LINKS";
1242     }
1243     if (!rename($link_tmp_name, VAR_LINKS . $l . $hash_link)) {
1244         return "Error: cannot rename file in LINKS";
1245     }
1246
1247     /* Clean async upload. */
1248     jirafeau_async_delete($ref);
1249     return $hash_link . NL . $delete_link_code . NL . urlencode($crypt_key);
1250 }
1251
1252 function jirafeau_crypt_create_iv($base, $size)
1253 {
1254     $iv = '';
1255     while (strlen($iv) < $size) {
1256         $iv = $iv . $base;
1257     }
1258     $iv = substr($iv, 0, $size);
1259     return $iv;
1260 }
1261
1262 /**
1263  * Crypt file using Sodium and returns decrypt key.
1264  * @param $fp_src file path to the file to crypt.
1265  * @param $fp_dst file path to the file to write crypted file (must not be the same).
1266  * @return key used to encrypt the file
1267  */
1268 function jirafeau_encrypt_file($fp_src, $fp_dst)
1269 {
1270     $fs = filesize($fp_src);
1271     if ($fs === false || $fs == 0 || extension_loaded('sodium') == false || $fp_src == $fp_dst) {
1272         return '';
1273     }
1274
1275     /* Generate key. */
1276     $crypt_key = bin2hex(random_bytes(SODIUM_CRYPTO_STREAM_XCHACHA20_KEYBYTES / 2));
1277     /* Init module. */
1278     [$crypt_state, $crypt_header] = sodium_crypto_secretstream_xchacha20poly1305_init_push($crypt_key);
1279     /* Crypt file. */
1280     $r = fopen($fp_src, 'rb');
1281     $w = fopen($fp_dst, 'wb');
1282     fwrite($w, $crypt_header);
1283
1284     for ($i = 0; $i < $fs; $i += JIRAFEAU_SODIUM_CHUNKSIZE) {
1285         $to_enc = fread($r, JIRAFEAU_SODIUM_CHUNKSIZE);
1286         $enc = sodium_crypto_secretstream_xchacha20poly1305_push($crypt_state, $to_enc);
1287
1288         if (fwrite($w, $enc) === false) {
1289             return '';
1290         }
1291     }
1292
1293     fclose($r);
1294     fclose($w);
1295
1296     /* Cleanup. */
1297     sodium_memzero($crypt_state);
1298
1299     return $crypt_key;
1300 }
1301
1302 /**
1303  * Decrypt file using Sodium.
1304  * @param $fp_src file path to the file to decrypt.
1305  * @param $fp_dst file path to the file to write decrypted file (must not be the same).
1306  * @param $k decryption key
1307  * @return true if decryption succeeded, false otherwise
1308  */
1309 function jirafeau_decrypt_file($fp_src, $fp_dst, $k)
1310 {
1311     $fs = filesize($fp_src);
1312     if ($fs === false || $fs == 0 || extension_loaded('sodium') == false || $fp_src == $fp_dst) {
1313         return false;
1314     }
1315
1316     /* Decrypt file. */
1317     $r = fopen($fp_src, 'rb');
1318     $w = fopen($fp_dst, 'wb');
1319
1320     $crypt_header = fread($r, SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES);
1321
1322     /* Init module. */
1323     $crypt_state = sodium_crypto_secretstream_xchacha20poly1305_init_pull($crypt_header, $k);
1324
1325     /* Decrypt file. */
1326
1327     for ($i = SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES; $i < $fs; $i += JIRAFEAU_SODIUM_CHUNKSIZE + SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_ABYTES) {
1328         $to_dec = fread($r, JIRAFEAU_SODIUM_CHUNKSIZE + SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_ABYTES);
1329         [$dec, $crypt_tag] = sodium_crypto_secretstream_xchacha20poly1305_pull($crypt_state, $to_dec);
1330
1331         if (fwrite($w, $dec) === false) {
1332             return false;
1333         }
1334     }
1335
1336     fclose($r);
1337     fclose($w);
1338
1339     /* Cleanup. */
1340     sodium_memzero($crypt_state);
1341
1342     return true;
1343 }
1344
1345 /**
1346  * Decrypt file using mcrypt.
1347  * @param $fp_src file path to the file to decrypt.
1348  * @param $fp_dst file path to the file to write decrypted file (could be the same).
1349  * @param $k string composed of the key and the iv separated by a point ('.')
1350  * @return true if decryption succeeded, false otherwise
1351  */
1352 function jirafeau_decrypt_file_legacy($fp_src, $fp_dst, $k)
1353 {
1354     $fs = filesize($fp_src);
1355     if ($fs === false || $fs == 0 || extension_loaded('mcrypt') == false) {
1356         return false;
1357     }
1358
1359     /* Init module */
1360     $m = mcrypt_module_open('rijndael-256', '', 'ofb', '');
1361     /* Extract key and iv. */
1362     $crypt_key = $k;
1363     $hash_key = md5($crypt_key);
1364     $iv = jirafeau_crypt_create_iv($hash_key, mcrypt_enc_get_iv_size($m));
1365     /* Init module. */
1366     mcrypt_generic_init($m, $hash_key, $iv);
1367     /* Decrypt file. */
1368     $r = fopen($fp_src, 'r');
1369     $w = fopen($fp_dst, 'c');
1370     while (!feof($r)) {
1371         $dec = mdecrypt_generic($m, fread($r, 1024));
1372         if (fwrite($w, $dec) === false) {
1373             return false;
1374         }
1375     }
1376     fclose($r);
1377     fclose($w);
1378     /* Cleanup. */
1379     mcrypt_generic_deinit($m);
1380     mcrypt_module_close($m);
1381     return true;
1382 }
1383
1384 /**
1385  * Check if Jirafeau is password protected for visitors.
1386  * @return true if Jirafeau is password protected, false otherwise.
1387  */
1388 function jirafeau_has_upload_password($cfg)
1389 {
1390     return count($cfg['upload_password']) > 0;
1391 }
1392
1393 /**
1394  * Challenge password for a visitor.
1395  * @param $password password to be challenged
1396  * @return true if password is valid, false otherwise.
1397  */
1398 function jirafeau_challenge_upload_password($cfg, $password)
1399 {
1400     if (!jirafeau_has_upload_password($cfg)) {
1401         return false;
1402     }
1403     foreach ($cfg['upload_password'] as $p) {
1404         if ($password == $p) {
1405             return true;
1406         }
1407     }
1408     return false;
1409 }
1410
1411 /**
1412  * Test if the given IP is whitelisted by the given list.
1413  *
1414  * @param $allowedIpList array of allowed IPs
1415  * @param $challengedIp IP to be challenged
1416  * @return true if IP is authorized, false otherwise.
1417  */
1418 function jirafeau_challenge_ip($allowedIpList, $challengedIp)
1419 {
1420     foreach ($allowedIpList as $i) {
1421         if ($i == $challengedIp) {
1422             return true;
1423         }
1424         // CIDR test for IPv4 only.
1425         if (strpos($i, '/') !== false) {
1426             list($subnet, $mask) = explode('/', $i);
1427             if ((ip2long($challengedIp) & ~((1 << (32 - $mask)) - 1)) == ip2long($subnet)) {
1428                 return true;
1429             }
1430         }
1431     }
1432     return false;
1433 }
1434
1435 /**
1436  * Check if Jirafeau has a restriction on the IP address for uploading.
1437  * @return true if uploading is IP restricted, false otherwise.
1438  */
1439 function jirafeau_upload_has_ip_restriction($cfg)
1440 {
1441     return count($cfg['upload_ip']) > 0;
1442 }
1443
1444 /**
1445  * Test if visitor's IP is authorized to upload at all.
1446  *
1447  * @param $cfg configuration
1448  * @param $challengedIp IP to be challenged
1449  * @return true if IP is authorized, false otherwise.
1450  */
1451 function jirafeau_challenge_upload_ip($cfg, $challengedIp)
1452 {
1453     // If no IP address have been listed, allow upload from any IP
1454     if (!jirafeau_upload_has_ip_restriction($cfg)) {
1455         return true;
1456     }
1457     return jirafeau_challenge_ip($cfg['upload_ip'], $challengedIp);
1458 }
1459
1460 /**
1461  * Test if visitor's IP is authorized to upload without a password.
1462  *
1463  * @param $cfg configuration
1464  * @param $challengedIp IP to be challenged
1465  * @return true if IP is authorized, false otherwise.
1466  */
1467 function jirafeau_challenge_upload_ip_without_password($cfg, $challengedIp)
1468 {
1469     return jirafeau_challenge_ip($cfg['upload_ip_nopassword'], $challengedIp);
1470 }
1471
1472 /**
1473  * Test if visitor's IP is authorized or password is supplied and authorized
1474  * @param $ip IP to be challenged
1475  * @param $password password to be challenged
1476  * @return true if access is valid, false otherwise.
1477  */
1478 function jirafeau_challenge_upload($cfg, $ip, $password)
1479 {
1480     return jirafeau_challenge_upload_ip_without_password($cfg, $ip) ||
1481             (!jirafeau_has_upload_password($cfg) && !jirafeau_upload_has_ip_restriction($cfg)) ||
1482             (jirafeau_challenge_upload_password($cfg, $password) && jirafeau_challenge_upload_ip($cfg, $ip));
1483 }
1484
1485 /**
1486  * Check if Jirafeau has a restriction on the IP address for accessing the admin interface.
1487  * @return true if admin interface is IP restricted, false otherwise.
1488  */
1489 function jirafeau_admin_has_ip_restriction($cfg)
1490 {
1491     return count($cfg['admin_ip']) > 0;
1492 }
1493
1494 /**
1495  * Test if visitor's IP is authorized to access the admin interface.
1496  *
1497  * @param $cfg configuration
1498  * @param $challengedIp IP to be challenged
1499  * @return true if IP is authorized, false otherwise.
1500  */
1501 function jirafeau_challenge_admin_ip($cfg, $challengedIp)
1502 {
1503     // If no IP address have been listed, allow upload from any IP
1504     if (!jirafeau_admin_has_ip_restriction($cfg)) {
1505         return true;
1506     }
1507     return jirafeau_challenge_ip($cfg['admin_ip'], $challengedIp);
1508 }
1509
1510 /** Tell if we have some HTTP headers generated by a proxy */
1511 function has_http_forwarded()
1512 {
1513     return
1514         !empty($_SERVER['HTTP_X_FORWARDED_FOR']) ||
1515         !empty($_SERVER['http_X_forwarded_for']);
1516 }
1517
1518 /**
1519  * Generate IP list from HTTP headers generated by a proxy
1520  * @return  array of IP strings
1521  */
1522 function get_ip_list_http_forwarded()
1523 {
1524     $ip_list = array();
1525     if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
1526         $l = explode(',', $_SERVER['HTTP_X_FORWARDED_FOR']);
1527         if ($l === false) {
1528             return array();
1529         }
1530         foreach ($l as $ip) {
1531             array_push($ip_list, preg_replace('/\s+/', '', $ip));
1532         }
1533     }
1534     if (!empty($_SERVER['http_X_forwarded_for'])) {
1535         $l = explode(',', $_SERVER['http_X_forwarded_for']);
1536         foreach ($l as $ip) {
1537             // Separate IP from port
1538             $ipa = explode(':', $ip);
1539             if ($ipa === false) {
1540                 continue;
1541             }
1542             $ip = $ipa[0];
1543             array_push($ip_list, preg_replace('/\s+/', '', $ip));
1544         }
1545     }
1546     return $ip_list;
1547 }
1548
1549 /**
1550  * Get the ip address of the client from REMOTE_ADDR
1551  * or from HTTP_X_FORWARDED_FOR if behind a proxy
1552  * @returns the client ip address
1553  */
1554 function get_ip_address($cfg)
1555 {
1556     $remote = $_SERVER['REMOTE_ADDR'];
1557     if (count($cfg['proxy_ip']) == 0 || !has_http_forwarded()) {
1558         return $remote;
1559     }
1560
1561     $ip_list = get_ip_list_http_forwarded();
1562     if (count($ip_list) == 0) {
1563         return $remote;
1564     }
1565
1566     foreach ($cfg['proxy_ip'] as $proxy_ip) {
1567         if ($remote != $proxy_ip) {
1568             continue;
1569         }
1570         // Take the last IP (the one which has been set by the defined proxy).
1571         return end($ip_list);
1572     }
1573     return $remote;
1574 }
1575
1576 /**
1577  * Convert hexadecimal string to base64
1578  */
1579 function hex_to_base64($hex)
1580 {
1581     $b = '';
1582     foreach (str_split($hex, 2) as $pair) {
1583         $b .= chr(hexdec($pair));
1584     }
1585     return base64_encode($b);
1586 }
1587
1588 /**
1589  * Replace markers in templates.
1590  *
1591  * Available markers have the scheme "###MARKERNAME###".
1592  *
1593  * @param $content string Template text with markers
1594  * @param $htmllinebreaks boolean Convert linebreaks to BR-Tags
1595  * @return Template with replaced markers
1596  */
1597 function jirafeau_replace_markers($content, $htmllinebreaks = false)
1598 {
1599     $patterns = array(
1600         '/###ORGANISATION###/',
1601         '/###CONTACTPERSON###/',
1602         '/###WEBROOT###/'
1603     );
1604     $replacements = array(
1605         $GLOBALS['cfg']['organisation'],
1606         $GLOBALS['cfg']['contactperson'],
1607         $GLOBALS['cfg']['web_root']
1608     );
1609     $content = preg_replace($patterns, $replacements, $content);
1610
1611     if (true === $htmllinebreaks) {
1612         $content = nl2br($content);
1613     }
1614
1615     return $content;
1616 }
1617
1618 function jirafeau_escape($string)
1619 {
1620     return htmlspecialchars($string, ENT_QUOTES);
1621 }
1622
1623 function jirafeau_admin_session_start()
1624 {
1625     $_SESSION['admin_auth'] = true;
1626     $_SESSION['admin_csrf'] = md5(uniqid(mt_rand(), true));
1627 }
1628
1629 function jirafeau_session_end()
1630 {
1631     $_SESSION = array();
1632     session_destroy();
1633 }
1634
1635 function jirafeau_admin_session_logged()
1636 {
1637     return isset($_SESSION['admin_auth']) &&
1638            isset($_SESSION['admin_csrf']) &&
1639            isset($_POST['admin_csrf']) &&
1640            $_SESSION['admin_auth'] === true &&
1641            $_SESSION['admin_csrf'] === $_POST['admin_csrf'];
1642 }
1643
1644 function jirafeau_admin_csrf_field()
1645 {
1646     return "<input type='hidden' name='admin_csrf' value='". $_SESSION['admin_csrf'] . "'/>";
1647 }
1648
1649 function jirafeau_user_session_start()
1650 {
1651     $_SESSION['user_auth'] = true;
1652 }
1653
1654 function jirafeau_user_session_logged()
1655 {
1656     return isset($_SESSION['user_auth']) &&
1657         $_SESSION['user_auth'] === true;
1658 }
1659
1660 function jirafeau_dir_size($dir)
1661 {
1662     $size = 0;
1663     foreach (glob(rtrim($dir, '/').'/*', GLOB_NOSORT) as $entry) {
1664         $size += is_file($entry) ? filesize($entry) : jirafeau_dir_size($entry);
1665     }
1666     return $size;
1667 }
1668
1669 function jirafeau_export_cfg($cfg)
1670 {
1671     $content = '<?php' . NL;
1672     $content .= '/* This file was generated by the install process. ' .
1673                'You can edit it. Please see config.original.php to understand the ' .
1674                'configuration items. */' . NL;
1675     $content .= '$cfg = ' . var_export($cfg, true) . ';';
1676
1677     $fileWrite = file_put_contents(JIRAFEAU_CFG, $content);
1678
1679     if (false === $fileWrite) {
1680         jirafeau_fatal_error(t('Can not write local configuration file'));
1681     }
1682 }
1683
1684 function jirafeau_mkdir($path)
1685 {
1686     return !(!file_exists($path) && !@mkdir($path, 0755));
1687 }
1688
1689 /**
1690  * Returns true whether the path is writable or we manage to make it
1691  * so, which essentially is the same thing.
1692  * @param $path is the file or directory to be tested.
1693  * @return true if $path is writable.
1694  */
1695 function jirafeau_is_writable($path)
1696 {
1697     /* "@" gets rid of error messages. */
1698     return is_writable($path) || @chmod($path, 0777);
1699 }
1700
1701 function jirafeau_check_var_dir($path)
1702 {
1703     $mkdir_str1 = t('CANNOT_CREATE_DIR') . ':';
1704     $mkdir_str2 = t('MANUAL_CREATE');
1705     $write_str1 = t('DIR_NOT_W') . ':';
1706     $write_str2 = t('You should give the write permission to the web server on ' .
1707                     'this directory.');
1708     $solution_str = t('HERE_SOLUTION') . ':';
1709
1710     if (!jirafeau_mkdir($path) || !jirafeau_is_writable($path)) {
1711         return array('has_error' => true,
1712                       'why' => $mkdir_str1 . '<br /><code>' .
1713                                $path . '</code><br />' . $solution_str .
1714                                '<br />' . $mkdir_str2);
1715     }
1716
1717     foreach (array('files', 'links', 'async') as $subdir) {
1718         $subpath = $path.$subdir;
1719
1720         if (!jirafeau_mkdir($subpath) || !jirafeau_is_writable($subpath)) {
1721             return array('has_error' => true,
1722                           'why' => $mkdir_str1 . '<br /><code>' .
1723                                    $subpath . '</code><br />' . $solution_str .
1724                                    '<br />' . $mkdir_str2);
1725         }
1726     }
1727
1728     return array('has_error' => false, 'why' => '');
1729 }
1730
1731 function jirafeau_add_ending_slash($path)
1732 {
1733     return $path . ((substr($path, -1) == '/') ? '' : '/');
1734 }
1735
1736 function jirafeau_default_web_root()
1737 {
1738     $url_scheme = (isset($_SERVER['HTTPS'])) ? 'https://' : 'http://';
1739     return $url_scheme . $_SERVER['HTTP_HOST'] . str_replace('install.php', '', $_SERVER['REQUEST_URI']);
1740 }
1741
1742 function jirafeau_get_download_stats($hash)
1743 {
1744     $filename = VAR_LINKS . s2p("$hash") . $hash . '_download';
1745
1746     if (!file_exists($filename)) {
1747         return array('count'=>0);
1748     }
1749
1750     $c = file($filename);
1751     $data['count'] = trim($c[0]);
1752     $data['date'] = trim($c[1]);
1753     $data['ip'] = trim($c[2]);
1754
1755     return $data;
1756 }
1757
1758 function jirafeau_write_download_stats($hash, $ip)
1759 {
1760     $data = jirafeau_get_download_stats($hash);
1761     $count = $data['count'];
1762     $count++;
1763
1764     $filename = VAR_LINKS . s2p("$hash") . $hash . '_download';
1765
1766     $handle = fopen($filename, 'w');
1767     fwrite($handle, $count . NL . time() . NL . $ip);
1768     fclose($handle);
1769 }
1770
1771 function jirafeau_create_upload_finished_box($preview = true) {
1772     ?>
1773
1774     <div id="upload_finished">
1775     <p><?php echo t('FILE_UP') ?></p>
1776
1777     <div id="upload_finished_download_page">
1778     <p>
1779         <a id="upload_link" href=""><?php echo t('DL_PAGE') ?></a>
1780         <a id="upload_link_email" href=""><img id="upload_image_email"/></a>
1781     </p><p>
1782         <code id=upload_link_text></code>
1783         <button id="upload_link_button">&#128203;</button>
1784     </p>
1785     </div>
1786
1787     <?php if ($preview == true) {
1788     ?>
1789     <div id="upload_finished_preview">
1790     <p>
1791         <a id="preview_link" href=""><?php echo t('VIEW_LINK') ?></a>
1792     </p><p>
1793         <code id=preview_link_text></code>
1794         <button id="preview_link_button">&#128203;</button>
1795     </p>
1796     </div>
1797     <?php
1798 } ?>
1799
1800     <div id="upload_direct_download">
1801     <p>
1802         <a id="direct_link" href=""><?php echo t('DIRECT_DL') ?></a>
1803     </p><p>
1804         <code id=direct_link_text></code>
1805         <button id="direct_link_button">&#128203;</button>
1806     </p>
1807     </div>
1808
1809     <div id="upload_delete">
1810     <p>
1811         <a id="delete_link" href=""><?php echo t('DELETE_LINK') ?></a>
1812     </p><p>
1813         <code id=delete_link_text></code>
1814         <button id="delete_link_button">&#128203;</button>
1815     </p>
1816     </div>
1817
1818     <div id="upload_validity">
1819     <p><?php echo t('VALID_UNTIL'); ?>:</p>
1820     <p id="date"></p>
1821     </div>
1822 </div>
1823 <?php
1824 }
1825
1826 function jirafeau_get_expiration_time_options() {
1827     return
1828     array(
1829         array(
1830           'value' => 'minute',
1831           'label' => '1_MIN'
1832         ),
1833         array(
1834           'value' => 'hour',
1835           'label' => '1_H'
1836         ),
1837         array(
1838           'value' => 'day',
1839           'label' => '1_D'
1840         ),
1841         array(
1842           'value' => 'week',
1843           'label' => '1_W'
1844         ),
1845         array(
1846             'value' => 'fortnight',
1847             'label' => '2_W'
1848         ),
1849         array(
1850           'value' => 'month',
1851           'label' => '1_M'
1852         ),
1853         array(
1854           'value' => 'quarter',
1855           'label' => '1_Q'
1856         ),
1857         array(
1858           'value' => 'year',
1859           'label' => '1_Y'
1860         ),
1861         array(
1862           'value' => 'none',
1863           'label' => 'NONE'
1864         )
1865       );
1866 }
1867
1868
1869
1870  /**
1871   *
1872   * creates the time selection field
1873   * @param mixed $cfg
1874   * @return void
1875   */
1876   function jirafeau_create_selection_array($cfg) {
1877     echo
1878     '<select name="time" id="select_time">';
1879
1880
1881         $expirationTimeOptions = jirafeau_get_expiration_time_options();
1882
1883         foreach ($expirationTimeOptions as $expirationTimeOption) {
1884             $selected = ($expirationTimeOption['value'] === $cfg['availability_default'])? 'selected="selected"' : '';
1885             if (true === $cfg['availabilities'][$expirationTimeOption['value']]) {
1886                 echo '<option value="' . $expirationTimeOption['value'] . '" ' .
1887               $selected . '>' . t($expirationTimeOption['label']) . '</option>';
1888             }
1889         }
1890         echo '</select>';
1891  }
1892
1893  function jirafeau_datestr_to_int ($time_str) {
1894     $time = time();
1895     switch ($time_str) {
1896         case 'minute':
1897             $time += JIRAFEAU_MINUTE;
1898             break;
1899         case 'hour':
1900             $time += JIRAFEAU_HOUR;
1901             break;
1902         case 'day':
1903             $time += JIRAFEAU_DAY;
1904             break;
1905         case 'week':
1906             $time += JIRAFEAU_WEEK;
1907             break;
1908         case 'fortnight':
1909             $time += JIRAFEAU_FORTNIGHT;
1910             break;
1911         case 'month':
1912             $time += JIRAFEAU_MONTH;
1913             break;
1914         case 'quarter':
1915             $time += JIRAFEAU_QUARTER;
1916             break;
1917         case 'year':
1918             $time += JIRAFEAU_YEAR;
1919             break;
1920        default:
1921             $time = JIRAFEAU_INFINITY;
1922             break;
1923     }
1924     return $time;
1925 }
1926
1927
1928
1929
1930 /**
1931  * links or copy a local file
1932  * TODO: boolean in config for linking
1933  * @param string $filepath
1934  * @param $one_time_download is the file a one time download ?
1935  * @param $key if not empty, protect the file with this key
1936  * @param $time the time of validity of the file
1937  * @param $ip uploader's ip
1938  * @param $crypt boolean asking to crypt or not
1939  * @param $link_name_length size of the link name
1940  * @returns an array containing some information
1941  *   'error' => information on possible errors
1942  *   'link' => the link name of the uploaded file
1943  *   'delete_link' => the link code to delete file
1944  */
1945 function jirafeau_copy_local_file($local_file_path, $one_time_download, $key, $time, $ip, $crypt, $link_name_length, $file_hash_method) {
1946
1947     if (!file_exists($local_file_path)) {
1948         return (array(
1949             'error' =>
1950               array('has_error' => true,
1951                      'why' => t('INTERNAL_ERROR_FILE_NOT_EXIST')),
1952             'link' =>'',
1953             'delete_link' => ''));
1954     }
1955     if(
1956         // sanity check if file can be opened
1957         $file = fopen($local_file_path, "r")
1958     )
1959     {
1960         // close file pointer - it's not needed here
1961         fclose($file);
1962         $time_in_int = jirafeau_datestr_to_int($time);
1963         return jirafeau_add_file(
1964             jirafeau_create_file_array($local_file_path),
1965             $one_time_download,
1966             $key,
1967             $time_in_int,
1968             $ip,
1969             $crypt,
1970             $link_name_length,
1971             $file_hash_method,
1972             false
1973         );
1974     }
1975     else {
1976         return (array(
1977             'error' =>
1978               array('has_error' => true,
1979                      'why' => t('INTERNAL_ERROR_FP_OPEN_LOCAL')),
1980             'link' =>'',
1981             'delete_link' => ''));
1982     }
1983
1984 }
1985
1986
1987 function jirafeau_create_file_array($file_path) {
1988     return
1989     [
1990        'type' => mime_content_type($file_path),
1991        'tmp_name' => $file_path,
1992        'name' => basename($file_path),
1993        'size' => filesize($file_path),
1994     ];
1995 }