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) 2012  Jerome Jutteau <j.jutteau@gmail.com>
   6  *
   7  *  This program is free software: you can redistribute it and/or modify
   8  *  it under the terms of the GNU Affero General Public License as
   9  *  published by the Free Software Foundation, either version 3 of the
  10  *  License, or (at your option) any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU Affero General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU Affero General Public License
  18  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 /**
  22  * transforms a php.ini string representing a value in an integer
  23  * @param $value the value from php.ini
  24  * @returns an integer for this value
  25  */
  26 function jirafeau_ini_to_bytes($value) {
  27   $modifier = substr($value, -1);
  28   $bytes = substr($value, 0, -1);
  29   switch(strtoupper($modifier)) {
  30   case 'P':
  31     $bytes *= 1024;
  32   case 'T':
  33     $bytes *= 1024;
  34   case 'G':
  35     $bytes *= 1024;
  36   case 'M':
  37     $bytes *= 1024;
  38   case 'K':
  39     $bytes *= 1024;
  40   default:
  41     break;
  42   }
  43   return $bytes;
  44 }
  45
  46 /**
  47  * gets the maximum upload size according to php.ini
  48  * @returns the maximum upload size
  49  */
  50 function jirafeau_get_max_upload_size() {
  51   return min(jirafeau_ini_to_bytes(ini_get('post_max_size')), jirafeau_ini_to_bytes(ini_get('upload_max_filesize')));
  52 }
  53
  54 /**
  55  * detects if a given filename is present in a directory and find an alternate filename
  56  * @param $name the initial filename
  57  * @param $dir the directory to explore (finishing with a '/')
  58  * @returns an alternate filename, possibly the initial filename
  59  */
  60 function jirafeau_detect_collision($name, $dir) {
  61   if(!file_exists($dir . $name)) {
  62     return $name;
  63   }
  64
  65   $dot = strpos($name, '.');
  66   $dot = ($dot === false) ? strlen($name) : $dot;
  67   $first = substr($name, 0, $dot);
  68   $second = substr($name, $dot);
  69   $i = 1;
  70   do {
  71     $new_name = $first . '-' . $i . $second;
  72     $i++;
  73   } while(file_exists($dir . $new_name));
  74
  75   return $new_name;
  76 }
  77
  78 /**
  79  * gets a string explaining the error
  80  * @param $code the error code
  81  * @returns a string explaining the error
  82  */
  83 function jirafeau_upload_errstr($code) {
  84   switch($code) {
  85   case UPLOAD_ERR_INI_SIZE:
  86   case UPLOAD_ERR_FORM_SIZE:
  87     return _('Your file exceeds the maximum authorized file size.');
  88     break;
  89
  90   case UPLOAD_ERR_PARTIAL:
  91   case UPLOAD_ERR_NO_FILE:
  92     return _('Your file was not uploaded correctly. You may succeed in retrying.');
  93     break;
  94
  95   case UPLOAD_ERR_NO_TMP_DIR:
  96   case UPLOAD_ERR_CANT_WRITE:
  97   case UPLOAD_ERR_EXTENSION:
  98     return _('Internal error. You may not succeed in retrying.');
  99     break;
 100
 101   default:
 102     break;
 103   }
 104   return _('Unknown error.');
 105 }
 106
 107 /**
 108  * handles an uploaded file
 109  * @param $file the file struct given by $_FILE[]
 110  * @param $one_time_download is the file a one time download ?
 111  * @param $key if not empty, protect the file with this key
 112  * @param $time the time of validity of the file
 113  * @param $cfg the current configuration
 114  * @returns an array containing some information
 115  *   'error' => information on possible errors
 116  *   'link' => the link name of the uploaded file
 117  */
 118 function jirafeau_upload($file, $one_time_download, $key, $time, $cfg) {
 119   if(empty($file['tmp_name']) || !is_uploaded_file($file['tmp_name'])) {
 120     return(array('error' => array('has_error' => true, 'why' => jirafeau_upload_errstr($file['error'])), 'link' => ''));
 121   }
 122
 123   /* array representing no error */
 124   $noerr = array('has_error' => false, 'why' => '');
 125
 126   /* file informations */
 127   $md5 = md5_file($file['tmp_name']);
 128   $name = trim($file['name']);
 129   $mime_type = $file['type'];
 130   $size = $file['size'];
 131
 132   /* does file already exist ? */
 133   $rc = false;
 134   if(file_exists(VAR_FILES . $md5)) {
 135     $rc = unlink($file['tmp_name']);
 136   }
 137   elseif(move_uploaded_file($file['tmp_name'], VAR_FILES . $md5)) {
 138     $rc = true;
 139   }
 140   if(!$rc)
 141   {
 142     return(array(
 143       'error' => array(
 144         'has_error' => true,
 145         'why' => _('Internal error during file creation.')),
 146       'link' => '')
 147     );
 148   }
 149
 150   /* increment or create count file */
 151   $counter=0;
 152   if(file_exists(VAR_FILES . $md5 . '_count')) {
 153     $content = file(VAR_FILES . $md5 . '_count');
 154     $counter = trim($content[0]);
 155   }
 156   $counter++;
 157   $handle = fopen(VAR_FILES . $md5 . '_count', 'w');
 158   fwrite($handle, $counter);
 159   fclose($handle);
 160
 161   /* create link file */
 162   $link_tmp_name = VAR_LINKS . $md5 . rand(0, 10000) . '.tmp';
 163   $handle = fopen($link_tmp_name, 'w');
 164   fwrite($handle, $name . NL . $mime_type . NL . $size . NL . $key . NL . $time . NL . $md5 . NL . ($one_time_download ? 'O' : 'R') . NL . date('U') . NL);
 165   fclose($handle);
 166   $md5_link = md5_file($link_tmp_name);
 167   if(!rename($link_tmp_name, VAR_LINKS . $md5_link)) {
 168     if ($counter > 1) {
 169       $counter--;
 170       $handle = fopen(VAR_FILES . $md5 . '_count', 'w');
 171       fwrite($handle, $counter);
 172       fclose($handle);
 173     }
 174     else {
 175       unlink($link_tmp_name);
 176       unlink(VAR_FILE . $md5 . '_count');
 177       unlink(VAR_FILE . $md5);
 178     }
 179     return(array(
 180       'error' => array(
 181         'has_error' => true,
 182         'why' => _('Internal error during file creation.')),
 183       'link' => '')
 184     );
 185   }
 186   return(array('error' => $noerr, 'link' => $md5_link));
 187 }
 188
 189 /**
 190  * tells if a mime-type is viewable in a browser
 191  * @param $mime the mime type
 192  * @returns a boolean telling if a mime type is viewable
 193  */
 194 function jirafeau_is_viewable($mime) {
 195   if(!empty($mime)) {
 196     // actually, verify if mime-type is an image or a text
 197     $viewable = array('image', 'text');
 198     $decomposed = explode('/', $mime);
 199     return in_array($decomposed[0], $viewable);
 200   }
 201   return false;
 202 }
 203
 204
 205 // Error handling functions.
 206 //! Global array that contains all registered errors.
 207 $error_list = array ();
 208
 209 /**
 210  * Adds an error to the list of errors.
 211  * @param $title the error's title
 212  * @param $description is a human-friendly description of the problem.
 213  */
 214 function add_error ($title, $description) {
 215     global $error_list;
 216     $error_list[] = '<p>' . $title . '<br />' . $description . '</p>';
 217 }
 218
 219 /**
 220  * Informs whether any error has been registered yet.
 221  * @return true if there are errors.
 222  */
 223 function has_error () {
 224     global $error_list;
 225     return !empty ($error_list);
 226 }
 227
 228 /**
 229  * Displays all the errors.
 230  */
 231 function show_errors () {
 232     if (has_error ()) {
 233         global $error_list;
 234         echo '<div class="error">';
 235         foreach ($error_list as $error) {
 236             echo $error;
 237         }
 238         echo '</div>';
 239     }
 240 }
 241
 242 ?>