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) 2015  Nicola Spanti (RyDroid) <dev@nicola-spanti.info>
   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 is_ssl()
 105 {
 106     if (isset($_SERVER['HTTPS'])) {
 107         if ('on' == strtolower($_SERVER['HTTPS']) ||
 108              '1' == $_SERVER['HTTPS']) {
 109             return true;
 110         }
 111     } elseif (isset($_SERVER['SERVER_PORT']) && ('443' == $_SERVER['SERVER_PORT'])) {
 112         return true;
 113     } elseif (isset($_SERVER['HTTP_X_FORWARDED_PROTO'])) {
 114         if ($_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') {
 115             return true;
 116         }
 117     }
 118     return false;
 119 }
 120
 121 function jirafeau_human_size($octets)
 122 {
 123     $u = array('B', 'KB', 'MB', 'GB', 'TB');
 124     $o = max($octets, 0);
 125     $p = min(floor(($o ? log($o) : 0) / log(1024)), count($u) - 1);
 126     $o /= pow(1024, $p);
 127     return round($o, 1) . $u[$p];
 128 }
 129
 130 // Convert UTC timestamp to a datetime field
 131 function jirafeau_get_datetimefield($timestamp)
 132 {
 133     $content = '<span class="datetime" data-datetime="' . strftime('%Y-%m-%d %H:%M', $timestamp) . '">'
 134         . strftime('%Y-%m-%d %H:%M', $timestamp) . ' (GMT)</span>';
 135     return $content;
 136 }
 137
 138 function jirafeau_fatal_error($errorText, $cfg = array())
 139 {
 140     echo '<div class="error"><h2>Error</h2><p>' . $errorText . '</p></div>';
 141     require(JIRAFEAU_ROOT . 'lib/template/footer.php');
 142     exit;
 143 }
 144
 145 function jirafeau_clean_rm_link($link)
 146 {
 147     $p = s2p("$link");
 148     if (file_exists(VAR_LINKS . $p . $link)) {
 149         unlink(VAR_LINKS . $p . $link);
 150     }
 151     $parse = VAR_LINKS . $p;
 152     $scan = array();
 153     while (file_exists($parse)
 154            && ($scan = scandir($parse))
 155            && count($scan) == 2 // '.' and '..' folders => empty.
 156            && basename($parse) != basename(VAR_LINKS)) {
 157         rmdir($parse);
 158         $parse = substr($parse, 0, strlen($parse) - strlen(basename($parse)) - 1);
 159     }
 160 }
 161
 162 function jirafeau_clean_rm_file($hash)
 163 {
 164     $p = s2p("$hash");
 165     $f = VAR_FILES . $p . $hash;
 166     if (file_exists($f) && is_file($f)) {
 167         unlink($f);
 168     }
 169     if (file_exists($f . '_count') && is_file($f . '_count')) {
 170         unlink($f . '_count');
 171     }
 172     $parse = VAR_FILES . $p;
 173     $scan = array();
 174     while (file_exists($parse)
 175            && ($scan = scandir($parse))
 176            && count($scan) == 2 // '.' and '..' folders => empty.
 177            && basename($parse) != basename(VAR_FILES)) {
 178         rmdir($parse);
 179         $parse = substr($parse, 0, strlen($parse) - strlen(basename($parse)) - 1);
 180     }
 181 }
 182
 183 /**
 184  * transforms a php.ini string representing a value in an integer
 185  * @param $value the value from php.ini
 186  * @returns an integer for this value
 187  */
 188 function jirafeau_ini_to_bytes($value)
 189 {
 190     $modifier = substr($value, -1);
 191     $bytes = substr($value, 0, -1);
 192     switch (strtoupper($modifier)) {
 193     case 'P':
 194         $bytes *= 1024;
 195         // no break
 196     case 'T':
 197         $bytes *= 1024;
 198         // no break
 199     case 'G':
 200         $bytes *= 1024;
 201         // no break
 202     case 'M':
 203         $bytes *= 1024;
 204         // no break
 205     case 'K':
 206         $bytes *= 1024;
 207     }
 208     return $bytes;
 209 }
 210
 211 /**
 212  * gets the maximum upload size according to php.ini
 213  * @returns the maximum upload size in bytes
 214  */
 215 function jirafeau_get_max_upload_size_bytes()
 216 {
 217     return min(
 218         jirafeau_ini_to_bytes(ini_get('post_max_size')),
 219         jirafeau_ini_to_bytes(ini_get('upload_max_filesize'))
 220     );
 221 }
 222
 223 /**
 224  * gets the maximum upload size according to php.ini
 225  * @returns the maximum upload size string
 226  */
 227 function jirafeau_get_max_upload_size()
 228 {
 229     return jirafeau_human_size(jirafeau_get_max_upload_size_bytes());
 230 }
 231
 232 /**
 233  * get the maximal upload size for a data chunk in async uploads
 234  * @param max_upload_chunk_size_bytes
 235  */
 236 function jirafeau_get_max_upload_chunk_size_bytes($max_upload_chunk_size_bytes = 0)
 237 {
 238     if ($max_upload_chunk_size_bytes > 0) {
 239         return min(
 240             jirafeau_get_max_upload_size_bytes(),
 241             $max_upload_chunk_size_bytes
 242         );
 243     }
 244     return jirafeau_get_max_upload_size_bytes();
 245 }
 246
 247 /**
 248  * gets a string explaining the error
 249  * @param $code the error code
 250  * @returns a string explaining the error
 251  */
 252 function jirafeau_upload_errstr($code)
 253 {
 254     switch ($code) {
 255     case UPLOAD_ERR_INI_SIZE:
 256     case UPLOAD_ERR_FORM_SIZE:
 257         return t('Your file exceeds the maximum authorized file size. ');
 258
 259     case UPLOAD_ERR_PARTIAL:
 260     case UPLOAD_ERR_NO_FILE:
 261         return
 262             t('Your file was not uploaded correctly. You may succeed in retrying. ');
 263
 264     case UPLOAD_ERR_NO_TMP_DIR:
 265     case UPLOAD_ERR_CANT_WRITE:
 266     case UPLOAD_ERR_EXTENSION:
 267         return t('Internal error. You may not succeed in retrying. ');
 268     }
 269     return t('Unknown error. ');
 270 }
 271
 272 /** Remove link and it's file
 273  * @param $link the link's name (hash)
 274  */
 275
 276 function jirafeau_delete_link($link)
 277 {
 278     $l = jirafeau_get_link($link);
 279     if (!count($l)) {
 280         return;
 281     }
 282
 283     jirafeau_clean_rm_link($link);
 284
 285     $hash = $l['hash'];
 286     $p = s2p("$hash");
 287
 288     $counter = 1;
 289     if (file_exists(VAR_FILES . $p . $hash. '_count')) {
 290         $content = file(VAR_FILES . $p . $hash. '_count');
 291         $counter = trim($content[0]);
 292     }
 293     $counter--;
 294
 295     if ($counter >= 1) {
 296         $handle = fopen(VAR_FILES . $p . $hash. '_count', 'w');
 297         fwrite($handle, $counter);
 298         fclose($handle);
 299     }
 300
 301     if ($counter == 0) {
 302         jirafeau_clean_rm_file($hash);
 303     }
 304 }
 305
 306 /**
 307  * Delete a file and it's links.
 308  */
 309 function jirafeau_delete_file($hash)
 310 {
 311     $count = 0;
 312     /* Get all links files. */
 313     $stack = array(VAR_LINKS);
 314     while (($d = array_shift($stack)) && $d != null) {
 315         $dir = scandir($d);
 316
 317         foreach ($dir as $node) {
 318             if (strcmp($node, '.') == 0 || strcmp($node, '..') == 0 ||
 319                 preg_match('/\.tmp/i', "$node")) {
 320                 continue;
 321             }
 322
 323             if (is_dir($d . $node)) {
 324                 /* Push new found directory. */
 325                 $stack[] = $d . $node . '/';
 326             } elseif (is_file($d . $node)) {
 327                 /* Read link informations. */
 328                 $l = jirafeau_get_link(basename($node));
 329                 if (!count($l)) {
 330                     continue;
 331                 }
 332                 if ($l['hash'] == $hash) {
 333                     $count++;
 334                     jirafeau_delete_link($node);
 335                 }
 336             }
 337         }
 338     }
 339     jirafeau_clean_rm_file($hash);
 340     return $count;
 341 }
 342
 343
 344 /** hash file's content
 345  * @param $method hash method, see 'file_hash' option. Valid methods are 'md5', 'md5_outside' or 'random'
 346  * @param $file_path file to hash
 347  * @returns hash string
 348  */
 349 function jirafeau_hash_file($method, $file_path)
 350 {
 351     switch ($method) {
 352         case 'md5_outside':
 353             return jirafeau_md5_outside($file_path);
 354         case 'md5':
 355             return md5_file($file_path);
 356         case 'random':
 357             return jirafeau_gen_random(32);
 358     }
 359     return md5_file($file_path);
 360 }
 361
 362 /** hash part of file: start, end and size.
 363  * This is a partial file hash, faster but weaker.
 364  * @param $file_path file to hash
 365  * @returns hash string
 366  */
 367 function jirafeau_md5_outside($file_path)
 368 {
 369     $out = false;
 370     $handle = fopen($file_path, "r");
 371     if ($handle === false) {
 372         return false;
 373     }
 374     $size = filesize($file_path);
 375     if ($size === false) {
 376         goto err;
 377     }
 378     $first = fread($handle, 64);
 379     if ($first === false) {
 380         goto err;
 381     }
 382     if (fseek($handle, $size < 64 ? 0 : $size - 64) == -1) {
 383         goto err;
 384     }
 385     $last = fread($handle, 64);
 386     if ($last === false) {
 387         goto err;
 388     }
 389     $out = md5($first . $last . $size);
 390     err:
 391     fclose($handle);
 392     return $out;
 393 }
 394
 395 /**
 396  * handles an uploaded file
 397  * @param $file the file struct given by $_FILE[]
 398  * @param $one_time_download is the file a one time download ?
 399  * @param $key if not empty, protect the file with this key
 400  * @param $time the time of validity of the file
 401  * @param $ip uploader's ip
 402  * @param $crypt boolean asking to crypt or not
 403  * @param $link_name_length size of the link name
 404  * @returns an array containing some information
 405  *   'error' => information on possible errors
 406  *   'link' => the link name of the uploaded file
 407  *   'delete_link' => the link code to delete file
 408  */
 409 function jirafeau_upload($file, $one_time_download, $key, $time, $ip, $crypt, $link_name_length, $file_hash_method)
 410 {
 411     if (empty($file['tmp_name']) || !is_uploaded_file($file['tmp_name'])) {
 412         return (array(
 413                  'error' =>
 414                    array('has_error' => true,
 415                           'why' => jirafeau_upload_errstr($file['error'])),
 416                  'link' => '',
 417                  'delete_link' => ''));
 418     }
 419
 420     /* array representing no error */
 421     $noerr = array('has_error' => false, 'why' => '');
 422
 423     /* Crypt file if option is enabled. */
 424     $crypted = false;
 425     $crypt_key = '';
 426     if ($crypt == true && !(extension_loaded('mcrypt') == true)) {
 427         error_log("PHP extension mcrypt not loaded, won't encrypt in Jirafeau");
 428     }
 429     if ($crypt == true && extension_loaded('mcrypt') == true) {
 430         $crypt_key = jirafeau_encrypt_file($file['tmp_name'], $file['tmp_name']);
 431         if (strlen($crypt_key) > 0) {
 432             $crypted = true;
 433         }
 434     }
 435
 436     /* file information */
 437     $hash = jirafeau_hash_file($file_hash_method, $file['tmp_name']);
 438     $name = str_replace(NL, '', trim($file['name']));
 439     $mime_type = $file['type'];
 440     $size = $file['size'];
 441
 442     /* does file already exist ? */
 443     $rc = false;
 444     $p = s2p("$hash");
 445     if (file_exists(VAR_FILES . $p .  $hash)) {
 446         $rc = unlink($file['tmp_name']);
 447     } elseif ((file_exists(VAR_FILES . $p) || @mkdir(VAR_FILES . $p, 0755, true))
 448             && move_uploaded_file($file['tmp_name'], VAR_FILES . $p . $hash)) {
 449         $rc = true;
 450     }
 451     if (!$rc) {
 452         return (array(
 453                  'error' =>
 454                    array('has_error' => true,
 455                           'why' => t('INTERNAL_ERROR_DEL')),
 456                  'link' =>'',
 457                  'delete_link' => ''));
 458     }
 459
 460     /* Increment or create count file. */
 461     $counter = 0;
 462     if (file_exists(VAR_FILES . $p . $hash . '_count')) {
 463         $content = file(VAR_FILES . $p . $hash. '_count');
 464         $counter = trim($content[0]);
 465     }
 466     $counter++;
 467     $handle = fopen(VAR_FILES . $p . $hash. '_count', 'w');
 468     fwrite($handle, $counter);
 469     fclose($handle);
 470
 471     /* Create delete code. */
 472     $delete_link_code = jirafeau_gen_random(5);
 473
 474     /* hash password or empty. */
 475     $password = '';
 476     if (!empty($key)) {
 477         $password = md5($key);
 478     }
 479
 480     /* create link file */
 481     $link_tmp_name =  VAR_LINKS . $hash . rand(0, 10000) . '.tmp';
 482     $handle = fopen($link_tmp_name, 'w');
 483     fwrite(
 484         $handle,
 485         $name . NL. $mime_type . NL. $size . NL. $password . NL. $time .
 486             NL . $hash. NL . ($one_time_download ? 'O' : 'R') . NL . time() .
 487             NL . $ip . NL. $delete_link_code . NL . ($crypted ? 'C' : 'O')
 488     );
 489     fclose($handle);
 490     $hash_link = substr(base_16_to_64(md5_file($link_tmp_name)), 0, $link_name_length);
 491     $l = s2p("$hash_link");
 492     if (!@mkdir(VAR_LINKS . $l, 0755, true) ||
 493         !rename($link_tmp_name, VAR_LINKS . $l . $hash_link)) {
 494         if (file_exists($link_tmp_name)) {
 495             unlink($link_tmp_name);
 496         }
 497
 498         $counter--;
 499         if ($counter >= 1) {
 500             $handle = fopen(VAR_FILES . $p . $hash. '_count', 'w');
 501             fwrite($handle, $counter);
 502             fclose($handle);
 503         } else {
 504             jirafeau_clean_rm_file($hash_link);
 505         }
 506         return array(
 507                  'error' =>
 508                    array('has_error' => true,
 509                           'why' => t('Internal error during file creation. ')),
 510                  'link' =>'',
 511                  'delete_link' => '');
 512     }
 513     return array( 'error' => $noerr,
 514                   'link' => $hash_link,
 515                   'delete_link' => $delete_link_code,
 516                   'crypt_key' => $crypt_key);
 517 }
 518
 519 /**
 520  * Tells if a mime-type is viewable in a browser
 521  * @param $mime the mime type
 522  * @returns a boolean telling if a mime type is viewable
 523  */
 524 function jirafeau_is_viewable($mime)
 525 {
 526     if (!empty($mime)) {
 527         $viewable = array('image', 'video', 'audio');
 528         $decomposed = explode('/', $mime);
 529         if (in_array($decomposed[0], $viewable) && strpos($mime, 'image/svg+xml') === false) {
 530             return true;
 531         }
 532         $viewable = array('text/plain');
 533         if (in_array($mime, $viewable)) {
 534             return true;
 535         }
 536     }
 537     return false;
 538 }
 539
 540 // Error handling functions.
 541 //! Global array that contains all registered errors.
 542 $error_list = array();
 543
 544 /**
 545  * Adds an error to the list of errors.
 546  * @param $title the error's title
 547  * @param $description is a human-friendly description of the problem.
 548  */
 549 function add_error($title, $description)
 550 {
 551     global $error_list;
 552     $error_list[] = '<p>' . $title. '<br />' . $description. '</p>';
 553 }
 554
 555 /**
 556  * Informs whether any error has been registered yet.
 557  * @return true if there are errors.
 558  */
 559 function has_error()
 560 {
 561     global $error_list;
 562     return !empty($error_list);
 563 }
 564
 565 /**
 566  * Displays all the errors.
 567  */
 568 function show_errors()
 569 {
 570     if (has_error()) {
 571         global $error_list;
 572         echo '<div class="error">';
 573         foreach ($error_list as $error) {
 574             echo $error;
 575         }
 576         echo '</div>';
 577     }
 578 }
 579
 580 function check_errors($cfg)
 581 {
 582     if (file_exists(JIRAFEAU_ROOT . 'install.php')
 583         && !($cfg['installation_done'] === true)) {
 584         header('Location: install.php');
 585         exit;
 586     }
 587
 588     /* Checking for errors. */
 589     if (!is_writable(VAR_FILES)) {
 590         add_error(t('FILE_DIR_W'), VAR_FILES);
 591     }
 592
 593     if (!is_writable(VAR_LINKS)) {
 594         add_error(t('LINK_DIR_W'), VAR_LINKS);
 595     }
 596
 597     if (!is_writable(VAR_ASYNC)) {
 598         add_error(t('ASYNC_DIR_W'), VAR_ASYNC);
 599     }
 600
 601     if ($cfg['enable_crypt'] && $cfg['litespeed_workaround']) {
 602         add_error(t('INCOMPATIBLE_OPTIONS_W'), 'enable_crypt=true<br>litespeed_workaround=true');
 603     }
 604
 605     if ($cfg['one_time_download'] && $cfg['litespeed_workaround']) {
 606         add_error(t('INCOMPATIBLE_OPTIONS_W'), 'one_time_download=true<br>litespeed_workaround=true');
 607     }
 608 }
 609
 610 /**
 611  * Read link information
 612  * @return array containing information.
 613  */
 614 function jirafeau_get_link($hash)
 615 {
 616     $out = array();
 617     $link = VAR_LINKS . s2p("$hash") . $hash;
 618
 619     if (!file_exists($link)) {
 620         return $out;
 621     }
 622
 623     $c = file($link);
 624     $out['file_name'] = trim($c[0]);
 625     $out['mime_type'] = trim($c[1]);
 626     $out['file_size'] = trim($c[2]);
 627     $out['key'] = trim($c[3], NL);
 628     $out['time'] = trim($c[4]);
 629     $out['hash'] = trim($c[5]);
 630     $out['onetime'] = trim($c[6]);
 631     $out['upload_date'] = trim($c[7]);
 632     $out['ip'] = trim($c[8]);
 633     $out['link_code'] = trim($c[9]);
 634     $out['crypted'] = trim($c[10]) == 'C';
 635
 636     return $out;
 637 }
 638
 639 /**
 640  * List files in admin interface.
 641  */
 642 function jirafeau_admin_list($name, $file_hash, $link_hash)
 643 {
 644     echo '<fieldset><legend>';
 645     if (!empty($name)) {
 646         echo t('FILENAME') . ": " . jirafeau_escape($name);
 647     }
 648     if (!empty($file_hash)) {
 649         echo t('FILE') . ": " . jirafeau_escape($file_hash);
 650     }
 651     if (!empty($link_hash)) {
 652         echo t('LINK') . ": " . jirafeau_escape($link_hash);
 653     }
 654     if (empty($name) && empty($file_hash) && empty($link_hash)) {
 655         echo t('LS_FILES');
 656     }
 657     echo '</legend>';
 658     echo '<table>';
 659     echo '<tr>';
 660     echo '<th></th>';
 661     echo '<th>' . t('ACTION') . '</th>';
 662     echo '</tr>';
 663
 664     /* Get all links files. */
 665     $stack = array(VAR_LINKS);
 666     while (($d = array_shift($stack)) && $d != null) {
 667         $dir = scandir($d);
 668         foreach ($dir as $node) {
 669             if (strcmp($node, '.') == 0 || strcmp($node, '..') == 0 ||
 670                 preg_match('/\.tmp/i', "$node")) {
 671                 continue;
 672             }
 673             if (is_dir($d . $node)) {
 674                 /* Push new found directory. */
 675                 $stack[] = $d . $node . '/';
 676             } elseif (is_file($d . $node)) {
 677                 /* Read link information. */
 678                 $l = jirafeau_get_link($node);
 679                 if (!count($l)) {
 680                     continue;
 681                 }
 682
 683                 /* Filter. */
 684                 if (!empty($name) && !@preg_match("/$name/i", jirafeau_escape($l['file_name']))) {
 685                     continue;
 686                 }
 687                 if (!empty($file_hash) && $file_hash != $l['hash']) {
 688                     continue;
 689                 }
 690                 if (!empty($link_hash) && $link_hash != $node) {
 691                     continue;
 692                 }
 693                 /* Print link information. */
 694                 echo '<tr>';
 695                 echo '<td>' .
 696                 '<strong><a id="upload_link" href="f.php?h='. jirafeau_escape($node) .'" title="' .
 697                     t('DL_PAGE') . '">' . jirafeau_escape($l['file_name']) . '</a></strong><br/>';
 698                 echo t('TYPE') . ': ' . jirafeau_escape($l['mime_type']) . '<br/>';
 699                 echo t('SIZE') . ': ' . jirafeau_human_size($l['file_size']) . '<br>';
 700                 echo t('EXPIRE') . ': ' . ($l['time'] == -1 ? '∞' : jirafeau_get_datetimefield($l['time'])) . '<br/>';
 701                 echo t('ONETIME') . ': ' . ($l['onetime'] == 'O' ? 'Yes' : 'No') . '<br/>';
 702                 echo t('UPLOAD_DATE') . ': ' . jirafeau_get_datetimefield($l['upload_date']) . '<br/>';
 703                 if (strlen($l['ip']) > 0) {
 704                     echo t('ORIGIN') . ': ' . $l['ip'] . '<br/>';
 705                 }
 706                 echo '</td><td>';
 707                 echo '<form method="post">' .
 708                 '<input type = "hidden" name = "action" value = "download"/>' .
 709                 '<input type = "hidden" name = "link" value = "' . $node . '"/>' .
 710                 jirafeau_admin_csrf_field() .
 711                 '<input type = "submit" value = "' . t('DL') . '" />' .
 712                 '</form>' .
 713                 '<form method="post">' .
 714                 '<input type = "hidden" name = "action" value = "delete_link"/>' .
 715                 '<input type = "hidden" name = "link" value = "' . $node . '"/>' .
 716                 jirafeau_admin_csrf_field() .
 717                 '<input type = "submit" value = "' . t('DEL_LINK') . '" />' .
 718                 '</form>' .
 719                 '<form method="post">' .
 720                 '<input type = "hidden" name = "action" value = "delete_file"/>' .
 721                 '<input type = "hidden" name = "hash" value = "' . $l['hash'] . '"/>' .
 722                 jirafeau_admin_csrf_field() .
 723                 '<input type = "submit" value = "' . t('DEL_FILE_LINKS') . '" />' .
 724                 '</form>' .
 725                 '</td>';
 726                 echo '</tr>';
 727             }
 728         }
 729     }
 730     echo '</table></fieldset>';
 731 }
 732
 733 /**
 734  * Clean expired files.
 735  * @return number of cleaned files.
 736  */
 737 function jirafeau_admin_clean()
 738 {
 739     $count = 0;
 740     /* Get all links files. */
 741     $stack = array(VAR_LINKS);
 742     while (($d = array_shift($stack)) && $d != null) {
 743         $dir = scandir($d);
 744
 745         foreach ($dir as $node) {
 746             if (strcmp($node, '.') == 0 || strcmp($node, '..') == 0 ||
 747                 preg_match('/\.tmp/i', "$node")) {
 748                 continue;
 749             }
 750
 751             if (is_dir($d . $node)) {
 752                 /* Push new found directory. */
 753                 $stack[] = $d . $node . '/';
 754             } elseif (is_file($d . $node)) {
 755                 /* Read link information. */
 756                 $l = jirafeau_get_link(basename($node));
 757                 if (!count($l)) {
 758                     continue;
 759                 }
 760                 $p = s2p($l['hash']);
 761                 if ($l['time'] > 0 && $l['time'] < time() || // expired
 762                     !file_exists(VAR_FILES . $p . $l['hash']) || // invalid
 763                     !file_exists(VAR_FILES . $p . $l['hash'] . '_count')) { // invalid
 764                     jirafeau_delete_link($node);
 765                     $count++;
 766                 }
 767             }
 768         }
 769     }
 770     return $count;
 771 }
 772
 773
 774 /**
 775  * Clean old async transfers.
 776  * @return number of cleaned files.
 777  */
 778 function jirafeau_admin_clean_async()
 779 {
 780     $count = 0;
 781     /* Get all links files. */
 782     $stack = array(VAR_ASYNC);
 783     while (($d = array_shift($stack)) && $d != null) {
 784         $dir = scandir($d);
 785
 786         foreach ($dir as $node) {
 787             if (strcmp($node, '.') == 0 || strcmp($node, '..') == 0 ||
 788                 preg_match('/\.tmp/i', "$node")) {
 789                 continue;
 790             }
 791
 792             if (is_dir($d . $node)) {
 793                 /* Push new found directory. */
 794                 $stack[] = $d . $node . '/';
 795             } elseif (is_file($d . $node)) {
 796                 /* Read async information. */
 797                 $a = jirafeau_get_async_ref(basename($node));
 798                 if (!count($a)) {
 799                     continue;
 800                 }
 801                 /* Delete transfers older than 1 hour. */
 802                 if (time() - $a['last_edited'] > 3600) {
 803                     jirafeau_async_delete(basename($node));
 804                     $count++;
 805                 }
 806             }
 807         }
 808     }
 809     return $count;
 810 }
 811
 812 /**
 813  * Better strval function for debug purposes
 814  */
 815 function jirafeau_strval($value)
 816 {
 817     if (gettype($value) == "boolean") {
 818         return $value ? 'true' : 'false';
 819     }
 820     return strval($value);
 821 }
 822
 823 /**
 824  * Show file/folder permissions
 825  */
 826 function jirafeau_fileperms($path)
 827 {
 828     $out = substr(sprintf("%o", @fileperms($path)), -4) . ", ";
 829     $out .= "read " . (is_readable($path) ? "OK" : "KO") . ", ";
 830     $out .= "write " . (is_writable($path) ? "OK" : "KO");
 831     return $out;
 832 }
 833
 834 /**
 835  * Show some useful informations for bug reporting.
 836  */
 837 function jirafeau_admin_bug_report($cfg)
 838 {
 839     $out = "<fieldset><legend>" . t('REPORTING_AN_ISSUE') . "</legend>";
 840     $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>";
 841
 842     $out .= "# Jirafeau<br/>";
 843     $out .= "- version: " . JIRAFEAU_VERSION . "<br/>";
 844     $jirafeau_options = [
 845         'debug',
 846         'file_hash',
 847         'litespeed_workaround',
 848         'store_uploader_ip',
 849         'installation_done',
 850         'enable_crypt',
 851         'preview',
 852         'maximal_upload_size',
 853         'store_uploader_ip',
 854         'max_upload_chunk_size_bytes'
 855     ];
 856     foreach ($jirafeau_options as &$o) {
 857         $v = $cfg[$o];
 858         $out .= "- $o: " . jirafeau_strval($v) . " (" . gettype($v) . ")<br/>";
 859     }
 860     $out .= "<br/>";
 861
 862     $out .= "# PHP options<br/>";
 863     $out .= "- php version: " . phpversion() . "<br/>";
 864     $out .= "- mcrypt version: " . phpversion('mcrypt') . "<br/>";
 865     $php_options =  [
 866         'post_max_size',
 867         'upload_max_filesize',
 868         'safe_mode',
 869         'max_execution_time',
 870         'max_input_time'
 871     ];
 872     foreach ($php_options as &$o) {
 873         $v = ini_get($o);
 874         $out .= "- $o: " . jirafeau_strval($v) . " (" . gettype($v). ")<br/>";
 875     }
 876     $out .= "- can set_time_limit: " . (set_time_limit(0) ? "yes" : "no") . "<br/>";
 877     $out .= "<br/>";
 878
 879     $out .= "# File permissions<br/>";
 880     $out .= "- 'var' folder permissions: " . jirafeau_fileperms($cfg['var_root']) . "<br/>";
 881     $out .= "- 'file' folder permissions: " . jirafeau_fileperms(VAR_FILES) . "<br/>";
 882     $out .= "- 'links' folder permissions: " . jirafeau_fileperms(VAR_LINKS) . "<br/>";
 883     $out .= "- 'async' folder permissions: " . jirafeau_fileperms(VAR_ASYNC) . "<br/>";
 884     $out .= "<br/>";
 885
 886     $out .= "# Server details<br/>";
 887     $out .= "- server software: " . $_SERVER["SERVER_SOFTWARE"] . "<br/>";
 888     $out .= "<br/>";
 889
 890     $out .= "# OS details<br/>";
 891     $out .= "- OS: " . php_uname() . "<br/>";
 892     $out .= "<br/>";
 893
 894     $out .= "# Browser details<br/>";
 895     $out .= "<script type='text/javascript' lang='Javascript'>
 896         // @license magnet:?xt=urn:btih:0b31508aeb0634b347b8270c7bee4d411b5d4109&dn=agpl-3.0.txt AGPL-v3-or-Later
 897         document.write('- html5 support: ' + (check_html5_file_api() ? 'yes' : 'no') + '<br/>');
 898         document.write('- user agent: ' + navigator.userAgent + '<br/>');
 899         // @license-end
 900         </script>";
 901     $out .= "<br/>";
 902
 903     $out .= "# Memory<br/>";
 904     $out .= "- memory_get_peak_usage: " . jirafeau_human_size(memory_get_peak_usage()) . "<br/>";
 905
 906     $out .= "</code></fieldset>";
 907     return $out;
 908 }
 909
 910 /**
 911  * Read async transfer information
 912  * @return array containing information.
 913  */
 914 function jirafeau_get_async_ref($ref)
 915 {
 916     $out = array();
 917     $refinfos = VAR_ASYNC . s2p("$ref") . "$ref";
 918
 919     if (!file_exists($refinfos)) {
 920         return $out;
 921     }
 922
 923     $c = file($refinfos);
 924     $out['file_name'] = trim($c[0]);
 925     $out['mime_type'] = trim($c[1]);
 926     $out['key'] = trim($c[2], NL);
 927     $out['time'] = trim($c[3]);
 928     $out['onetime'] = trim($c[4]);
 929     $out['ip'] = trim($c[5]);
 930     $out['last_edited'] = trim($c[6]);
 931     $out['next_code'] = trim($c[7]);
 932     return $out;
 933 }
 934
 935 /**
 936  * Delete async transfer information
 937  */
 938 function jirafeau_async_delete($ref)
 939 {
 940     $p = s2p("$ref");
 941     if (file_exists(VAR_ASYNC . $p . $ref)) {
 942         unlink(VAR_ASYNC . $p . $ref);
 943     }
 944     if (file_exists(VAR_ASYNC . $p . $ref . '_data')) {
 945         unlink(VAR_ASYNC . $p . $ref . '_data');
 946     }
 947     $parse = VAR_ASYNC . $p;
 948     $scan = array();
 949     while (file_exists($parse)
 950            && ($scan = scandir($parse))
 951            && count($scan) == 2 // '.' and '..' folders => empty.
 952            && basename($parse) != basename(VAR_ASYNC)) {
 953         rmdir($parse);
 954         $parse = substr($parse, 0, strlen($parse) - strlen(basename($parse)) - 1);
 955     }
 956 }
 957
 958 /**
 959   * Init a new asynchronous upload.
 960   * @param $filename Name of the file to send
 961   * @param $one_time One time upload parameter
 962   * @param $key eventual password (or blank)
 963   * @param $time time limit
 964   * @param $ip ip address of the client
 965   * @return a string containing a temporary reference followed by a code or a string starting with 'Error'
 966   */
 967 function jirafeau_async_init($filename, $type, $one_time, $key, $time, $ip)
 968 {
 969     /* Create temporary folder. */
 970     $ref;
 971     $p;
 972     $code = jirafeau_gen_random(4);
 973     do {
 974         $ref = jirafeau_gen_random(32);
 975         $p = VAR_ASYNC . s2p($ref);
 976     } while (file_exists($p));
 977     @mkdir($p, 0755, true);
 978     if (!file_exists($p)) {
 979         return 'Error: cannot create async folder.';
 980     }
 981
 982     /* touch empty data file */
 983     $w_path = $p . $ref . '_data';
 984     touch($w_path);
 985
 986     /* md5 password or empty */
 987     $password = '';
 988     if (!empty($key)) {
 989         $password = md5($key);
 990     }
 991
 992     /* Store information. */
 993     $p .= $ref;
 994     $handle = fopen($p, 'w');
 995     fwrite(
 996         $handle,
 997         str_replace(NL, '', trim($filename)) . NL .
 998             str_replace(NL, '', trim($type)) . NL . $password . NL .
 999             $time . NL . ($one_time ? 'O' : 'R') . NL . $ip . NL .
1000             time() . NL . $code . NL
1001     );
1002     fclose($handle);
1003
1004     return $ref . NL . $code ;
1005 }
1006
1007 /**
1008   * Append a piece of file on the asynchronous upload.
1009   * @param $ref asynchronous upload reference
1010   * @param $file piece of data
1011   * @param $code client code for this operation
1012   * @param $max_file_size maximum allowed file size
1013   * @return a string containing a next code to use or a string starting with 'Error'
1014   */
1015 function jirafeau_async_push($ref, $data, $code, $max_file_size)
1016 {
1017     /* Get async infos. */
1018     $a = jirafeau_get_async_ref($ref);
1019
1020     /* Check some errors. */
1021     if (count($a) == 0) {
1022         return "Error: cannot find transfer";
1023     }
1024     if ($a['next_code'] != "$code") {
1025         return "Error: bad transfer code";
1026     }
1027     if ($data['error'] != UPLOAD_ERR_OK) {
1028         // Check error code in https://www.php.net/manual/en/features.file-upload.errors.php
1029         $data_details = print_r($data, true);
1030         return "Error: upload error: {$data_details}";
1031     }
1032     if (empty($data['tmp_name'])) {
1033         return "Error: missing tmp_name";
1034     }
1035     if (!is_uploaded_file($data['tmp_name'])) {
1036         return "Error: tmp_name may not be uploaded";
1037     }
1038
1039     $p = s2p($ref);
1040
1041     /* File path. */
1042     $r_path = $data['tmp_name'];
1043     $w_path = VAR_ASYNC . $p . $ref . '_data';
1044
1045     /* Check that file size is not above upload limit. */
1046     if ($max_file_size > 0 &&
1047         filesize($r_path) + filesize($w_path) > $max_file_size * 1024 * 1024) {
1048         jirafeau_async_delete($ref);
1049         return "Error: file size is above upload limit";
1050     }
1051
1052     /* Concatenate data. */
1053     $r = fopen($r_path, 'r');
1054     $w = fopen($w_path, 'a');
1055     while (!feof($r)) {
1056         if (fwrite($w, fread($r, 1024)) === false) {
1057             fclose($r);
1058             fclose($w);
1059             jirafeau_async_delete($ref);
1060             return "Error: cannot write file";
1061         }
1062     }
1063     fclose($r);
1064     fclose($w);
1065     unlink($r_path);
1066
1067     /* Update async file. */
1068     $code = jirafeau_gen_random(4);
1069     $handle = fopen(VAR_ASYNC . $p . $ref, 'w');
1070     fwrite(
1071         $handle,
1072         $a['file_name'] . NL. $a['mime_type'] . NL. $a['key'] . NL .
1073             $a['time'] . NL . $a['onetime'] . NL . $a['ip'] . NL .
1074             time() . NL . $code . NL
1075     );
1076     fclose($handle);
1077     return $code;
1078 }
1079
1080 /**
1081   * Finalize an asynchronous upload.
1082   * @param $ref asynchronous upload reference
1083   * @param $code client code for this operation
1084   * @param $crypt boolean asking to crypt or not
1085   * @param $link_name_length link name length
1086   * @return a string containing the download reference followed by a delete code or a string starting with 'Error'
1087   */
1088 function jirafeau_async_end($ref, $code, $crypt, $link_name_length, $file_hash_method)
1089 {
1090     /* Get async infos. */
1091     $a = jirafeau_get_async_ref($ref);
1092     if (count($a) == 0
1093         || $a['next_code'] != "$code") {
1094         return "Error: bad code for ending transfer";
1095     }
1096
1097     /* Generate link infos. */
1098     $p = VAR_ASYNC . s2p($ref) . $ref . "_data";
1099     if (!file_exists($p)) {
1100         return "Error: referenced file does not exist";
1101     }
1102
1103     $crypted = false;
1104     $crypt_key = '';
1105     if ($crypt == true && extension_loaded('mcrypt') == true) {
1106         $crypt_key = jirafeau_encrypt_file($p, $p);
1107         if (strlen($crypt_key) > 0) {
1108             $crypted = true;
1109         }
1110     }
1111
1112     $hash = jirafeau_hash_file($file_hash_method, $p);
1113     $size = filesize($p);
1114     $np = s2p($hash);
1115     $delete_link_code = jirafeau_gen_random(5);
1116
1117     /* File already exist ? */
1118     if (!file_exists(VAR_FILES . $np)) {
1119         @mkdir(VAR_FILES . $np, 0755, true);
1120     }
1121     if (!file_exists(VAR_FILES . $np . $hash)) {
1122         rename($p, VAR_FILES . $np . $hash);
1123     }
1124
1125     /* Increment or create count file. */
1126     $counter = 0;
1127     if (file_exists(VAR_FILES . $np . $hash . '_count')) {
1128         $content = file(VAR_FILES . $np . $hash. '_count');
1129         $counter = trim($content[0]);
1130     }
1131     $counter++;
1132     $handle = fopen(VAR_FILES . $np . $hash. '_count', 'w');
1133     fwrite($handle, $counter);
1134     fclose($handle);
1135
1136     /* Create link. */
1137     $link_tmp_name =  VAR_LINKS . $hash . rand(0, 10000) . '.tmp';
1138     $handle = fopen($link_tmp_name, 'w');
1139     fwrite(
1140         $handle,
1141         $a['file_name'] . NL . $a['mime_type'] . NL . $size . NL .
1142             $a['key'] . NL . $a['time'] . NL . $hash . NL . $a['onetime'] . NL .
1143             time() . NL . $a['ip'] . NL . $delete_link_code . NL . ($crypted ? 'C' : 'O')
1144     );
1145     fclose($handle);
1146     $hash_link = substr(base_16_to_64(md5_file($link_tmp_name)), 0, $link_name_length);
1147     $l = s2p("$hash_link");
1148     if (!@mkdir(VAR_LINKS . $l, 0755, true)) {
1149         return "Error: cannot create folder in LINKS";
1150     }
1151     if (!rename($link_tmp_name, VAR_LINKS . $l . $hash_link)) {
1152         return "Error: cannot rename file in LINKS";
1153     }
1154
1155     /* Clean async upload. */
1156     jirafeau_async_delete($ref);
1157     return $hash_link . NL . $delete_link_code . NL . urlencode($crypt_key);
1158 }
1159
1160 function jirafeau_crypt_create_iv($base, $size)
1161 {
1162     $iv = '';
1163     while (strlen($iv) < $size) {
1164         $iv = $iv . $base;
1165     }
1166     $iv = substr($iv, 0, $size);
1167     return $iv;
1168 }
1169
1170 /**
1171  * Crypt file and returns decrypt key.
1172  * @param $fp_src file path to the file to crypt.
1173  * @param $fp_dst file path to the file to write crypted file (could be the same).
1174  * @return decrypt key composed of the key and the iv separated by a point ('.')
1175  */
1176 function jirafeau_encrypt_file($fp_src, $fp_dst)
1177 {
1178     $fs = filesize($fp_src);
1179     if ($fs === false || $fs == 0 || !(extension_loaded('mcrypt') == true)) {
1180         return '';
1181     }
1182
1183     /* Prepare module. */
1184     $m = mcrypt_module_open('rijndael-256', '', 'ofb', '');
1185     /* Generate key. */
1186     $crypt_key = jirafeau_gen_random(10);
1187     $hash_key = md5($crypt_key);
1188     $iv = jirafeau_crypt_create_iv($hash_key, mcrypt_enc_get_iv_size($m));
1189     /* Init module. */
1190     mcrypt_generic_init($m, $hash_key, $iv);
1191     /* Crypt file. */
1192     $r = fopen($fp_src, 'r');
1193     $w = fopen($fp_dst, 'c');
1194     while (!feof($r)) {
1195         $enc = mcrypt_generic($m, fread($r, 1024));
1196         if (fwrite($w, $enc) === false) {
1197             return '';
1198         }
1199     }
1200     fclose($r);
1201     fclose($w);
1202     /* Cleanup. */
1203     mcrypt_generic_deinit($m);
1204     mcrypt_module_close($m);
1205     return $crypt_key;
1206 }
1207
1208 /**
1209  * Decrypt file.
1210  * @param $fp_src file path to the file to decrypt.
1211  * @param $fp_dst file path to the file to write decrypted file (could be the same).
1212  * @param $k string composed of the key and the iv separated by a point ('.')
1213  * @return key used to decrypt. a string of length 0 is returned if failed.
1214  */
1215 function jirafeau_decrypt_file($fp_src, $fp_dst, $k)
1216 {
1217     $fs = filesize($fp_src);
1218     if ($fs === false || $fs == 0 || extension_loaded('mcrypt') == false) {
1219         return false;
1220     }
1221
1222     /* Init module */
1223     $m = mcrypt_module_open('rijndael-256', '', 'ofb', '');
1224     /* Extract key and iv. */
1225     $crypt_key = $k;
1226     $hash_key = md5($crypt_key);
1227     $iv = jirafeau_crypt_create_iv($hash_key, mcrypt_enc_get_iv_size($m));
1228     /* Decrypt file. */
1229     $r = fopen($fp_src, 'r');
1230     $w = fopen($fp_dst, 'c');
1231     while (!feof($r)) {
1232         $dec = mdecrypt_generic($m, fread($r, 1024));
1233         if (fwrite($w, $dec) === false) {
1234             return false;
1235         }
1236     }
1237     fclose($r);
1238     fclose($w);
1239     /* Cleanup. */
1240     mcrypt_generic_deinit($m);
1241     mcrypt_module_close($m);
1242     return true;
1243 }
1244
1245 /**
1246  * Check if Jirafeau is password protected for visitors.
1247  * @return true if Jirafeau is password protected, false otherwise.
1248  */
1249 function jirafeau_has_upload_password($cfg)
1250 {
1251     return count($cfg['upload_password']) > 0;
1252 }
1253
1254 /**
1255  * Challenge password for a visitor.
1256  * @param $password password to be challenged
1257  * @return true if password is valid, false otherwise.
1258  */
1259 function jirafeau_challenge_upload_password($cfg, $password)
1260 {
1261     if (!jirafeau_has_upload_password($cfg)) {
1262         return false;
1263     }
1264     foreach ($cfg['upload_password'] as $p) {
1265         if ($password == $p) {
1266             return true;
1267         }
1268     }
1269     return false;
1270 }
1271
1272 /**
1273  * Test if the given IP is whitelisted by the given list.
1274  *
1275  * @param $allowedIpList array of allowed IPs
1276  * @param $challengedIp IP to be challenged
1277  * @return true if IP is authorized, false otherwise.
1278  */
1279 function jirafeau_challenge_ip($allowedIpList, $challengedIp)
1280 {
1281     foreach ($allowedIpList as $i) {
1282         if ($i == $challengedIp) {
1283             return true;
1284         }
1285         // CIDR test for IPv4 only.
1286         if (strpos($i, '/') !== false) {
1287             list($subnet, $mask) = explode('/', $i);
1288             if ((ip2long($challengedIp) & ~((1 << (32 - $mask)) - 1)) == ip2long($subnet)) {
1289                 return true;
1290             }
1291         }
1292     }
1293     return false;
1294 }
1295
1296 /**
1297  * Check if Jirafeau has a restriction on the IP address for uploading.
1298  * @return true if uploading is IP restricted, false otherwise.
1299  */
1300 function jirafeau_upload_has_ip_restriction($cfg)
1301 {
1302     return count($cfg['upload_ip']) > 0;
1303 }
1304
1305 /**
1306  * Test if visitor's IP is authorized to upload at all.
1307  *
1308  * @param $cfg configuration
1309  * @param $challengedIp IP to be challenged
1310  * @return true if IP is authorized, false otherwise.
1311  */
1312 function jirafeau_challenge_upload_ip($cfg, $challengedIp)
1313 {
1314     // If no IP address have been listed, allow upload from any IP
1315     if (!jirafeau_upload_has_ip_restriction($cfg)) {
1316         return true;
1317     }
1318     return jirafeau_challenge_ip($cfg['upload_ip'], $challengedIp);
1319 }
1320
1321 /**
1322  * Test if visitor's IP is authorized to upload without a password.
1323  *
1324  * @param $cfg configuration
1325  * @param $challengedIp IP to be challenged
1326  * @return true if IP is authorized, false otherwise.
1327  */
1328 function jirafeau_challenge_upload_ip_without_password($cfg, $challengedIp)
1329 {
1330     return jirafeau_challenge_ip($cfg['upload_ip_nopassword'], $challengedIp);
1331 }
1332
1333 /**
1334  * Test if visitor's IP is authorized or password is supplied and authorized
1335  * @param $ip IP to be challenged
1336  * @param $password password to be challenged
1337  * @return true if access is valid, false otherwise.
1338  */
1339 function jirafeau_challenge_upload($cfg, $ip, $password)
1340 {
1341     return jirafeau_challenge_upload_ip_without_password($cfg, $ip) ||
1342             (!jirafeau_has_upload_password($cfg) && !jirafeau_upload_has_ip_restriction($cfg)) ||
1343             (jirafeau_challenge_upload_password($cfg, $password) && jirafeau_challenge_upload_ip($cfg, $ip));
1344 }
1345
1346 /** Tell if we have some HTTP headers generated by a proxy */
1347 function has_http_forwarded()
1348 {
1349     return
1350         !empty($_SERVER['HTTP_X_FORWARDED_FOR']) ||
1351         !empty($_SERVER['http_X_forwarded_for']);
1352 }
1353
1354 /**
1355  * Generate IP list from HTTP headers generated by a proxy
1356  * @return  array of IP strings
1357  */
1358 function get_ip_list_http_forwarded()
1359 {
1360     $ip_list = array();
1361     if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
1362         $l = explode(',', $_SERVER['HTTP_X_FORWARDED_FOR']);
1363         if ($l === false) {
1364             return array();
1365         }
1366         foreach ($l as $ip) {
1367             array_push($ip_list, preg_replace('/\s+/', '', $ip));
1368         }
1369     }
1370     if (!empty($_SERVER['http_X_forwarded_for'])) {
1371         $l = explode(',', $_SERVER['http_X_forwarded_for']);
1372         foreach ($l as $ip) {
1373             // Separate IP from port
1374             $ipa = explode(':', $ip);
1375             if ($ipa === false) {
1376                 continue;
1377             }
1378             $ip = $ipa[0];
1379             array_push($ip_list, preg_replace('/\s+/', '', $ip));
1380         }
1381     }
1382     return $ip_list;
1383 }
1384
1385 /**
1386  * Get the ip address of the client from REMOTE_ADDR
1387  * or from HTTP_X_FORWARDED_FOR if behind a proxy
1388  * @returns the client ip address
1389  */
1390 function get_ip_address($cfg)
1391 {
1392     $remote = $_SERVER['REMOTE_ADDR'];
1393     if (count($cfg['proxy_ip']) == 0 || !has_http_forwarded()) {
1394         return $remote;
1395     }
1396
1397     $ip_list = get_ip_list_http_forwarded();
1398     if (count($ip_list) == 0) {
1399         return $remote;
1400     }
1401
1402     foreach ($cfg['proxy_ip'] as $proxy_ip) {
1403         if ($remote != $proxy_ip) {
1404             continue;
1405         }
1406         // Take the last IP (the one which has been set by the defined proxy).
1407         return end($ip_list);
1408     }
1409     return $remote;
1410 }
1411
1412 /**
1413  * Convert hexadecimal string to base64
1414  */
1415 function hex_to_base64($hex)
1416 {
1417     $b = '';
1418     foreach (str_split($hex, 2) as $pair) {
1419         $b .= chr(hexdec($pair));
1420     }
1421     return base64_encode($b);
1422 }
1423
1424 /**
1425  * Replace markers in templates.
1426  *
1427  * Available markers have the scheme "###MARKERNAME###".
1428  *
1429  * @param $content string Template text with markers
1430  * @param $htmllinebreaks boolean Convert linebreaks to BR-Tags
1431  * @return Template with replaced markers
1432  */
1433 function jirafeau_replace_markers($content, $htmllinebreaks = false)
1434 {
1435     $patterns = array(
1436         '/###ORGANISATION###/',
1437         '/###CONTACTPERSON###/',
1438         '/###WEBROOT###/'
1439     );
1440     $replacements = array(
1441         $GLOBALS['cfg']['organisation'],
1442         $GLOBALS['cfg']['contactperson'],
1443         $GLOBALS['cfg']['web_root']
1444     );
1445     $content = preg_replace($patterns, $replacements, $content);
1446
1447     if (true === $htmllinebreaks) {
1448         $content = nl2br($content);
1449     }
1450
1451     return $content;
1452 }
1453
1454 function jirafeau_escape($string)
1455 {
1456     return htmlspecialchars($string, ENT_QUOTES);
1457 }
1458
1459 function jirafeau_admin_session_start()
1460 {
1461     $_SESSION['admin_auth'] = true;
1462     $_SESSION['admin_csrf'] = md5(uniqid(mt_rand(), true));
1463 }
1464
1465 function jirafeau_admin_session_end()
1466 {
1467     $_SESSION = array();
1468     session_destroy();
1469 }
1470
1471 function jirafeau_admin_session_logged()
1472 {
1473     return isset($_SESSION['admin_auth']) &&
1474            isset($_SESSION['admin_csrf']) &&
1475            isset($_POST['admin_csrf']) &&
1476            $_SESSION['admin_auth'] === true &&
1477            $_SESSION['admin_csrf'] === $_POST['admin_csrf'];
1478 }
1479
1480 function jirafeau_admin_csrf_field()
1481 {
1482     return "<input type='hidden' name='admin_csrf' value='". $_SESSION['admin_csrf'] . "'/>";
1483 }
1484
1485 function jirafeau_dir_size($dir)
1486 {
1487     $size = 0;
1488     foreach (glob(rtrim($dir, '/').'/*', GLOB_NOSORT) as $entry) {
1489         $size += is_file($entry) ? filesize($entry) : jirafeau_dir_size($entry);
1490     }
1491     return $size;
1492 }
1493
1494 function jirafeau_export_cfg($cfg)
1495 {
1496     $content = '<?php' . NL;
1497     $content .= '/* This file was generated by the install process. ' .
1498                'You can edit it. Please see config.original.php to understand the ' .
1499                'configuration items. */' . NL;
1500     $content .= '$cfg = ' . var_export($cfg, true) . ';';
1501
1502     $fileWrite = file_put_contents(JIRAFEAU_CFG, $content);
1503
1504     if (false === $fileWrite) {
1505         jirafeau_fatal_error(t('Can not write local configuration file'));
1506     }
1507 }
1508
1509 function jirafeau_mkdir($path)
1510 {
1511     return !(!file_exists($path) && !@mkdir($path, 0755));
1512 }
1513
1514 /**
1515  * Returns true whether the path is writable or we manage to make it
1516  * so, which essentially is the same thing.
1517  * @param $path is the file or directory to be tested.
1518  * @return true if $path is writable.
1519  */
1520 function jirafeau_is_writable($path)
1521 {
1522     /* "@" gets rid of error messages. */
1523     return is_writable($path) || @chmod($path, 0777);
1524 }
1525
1526 function jirafeau_check_var_dir($path)
1527 {
1528     $mkdir_str1 = t('CANNOT_CREATE_DIR') . ':';
1529     $mkdir_str2 = t('MANUAL_CREATE');
1530     $write_str1 = t('DIR_NOT_W') . ':';
1531     $write_str2 = t('You should give the write permission to the web server on ' .
1532                     'this directory.');
1533     $solution_str = t('HERE_SOLUTION') . ':';
1534
1535     if (!jirafeau_mkdir($path) || !jirafeau_is_writable($path)) {
1536         return array('has_error' => true,
1537                       'why' => $mkdir_str1 . '<br /><code>' .
1538                                $path . '</code><br />' . $solution_str .
1539                                '<br />' . $mkdir_str2);
1540     }
1541
1542     foreach (array('files', 'links', 'async') as $subdir) {
1543         $subpath = $path.$subdir;
1544
1545         if (!jirafeau_mkdir($subpath) || !jirafeau_is_writable($subpath)) {
1546             return array('has_error' => true,
1547                           'why' => $mkdir_str1 . '<br /><code>' .
1548                                    $subpath . '</code><br />' . $solution_str .
1549                                    '<br />' . $mkdir_str2);
1550         }
1551     }
1552
1553     return array('has_error' => false, 'why' => '');
1554 }
1555
1556 function jirafeau_add_ending_slash($path)
1557 {
1558     return $path . ((substr($path, -1) == '/') ? '' : '/');
1559 }
1560
1561 function jirafeau_default_web_root()
1562 {
1563     return $_SERVER['HTTP_HOST'] . str_replace(basename(__FILE__), '', $_SERVER['REQUEST_URI']);
1564 }