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