lib/uploadlib.php

   1 <?php
   2
   3 /**
   4  * uploadlib.php - This class handles all aspects of fileuploading
   5  *
   6  * @author ?
   7  * @version $Id$
   8  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
   9  * @package moodlecore
  10  */
  11
  12 //error_reporting(E_ALL ^ E_NOTICE);
  13 /**
  14  * This class handles all aspects of fileuploading
  15  */
  16 class upload_manager {
  17
  18    /**
  19     * Array to hold local copies of stuff in $_FILES
  20     * @var array $files
  21     */
  22     var $files;
  23    /**
  24     * Holds all configuration stuff
  25     * @var array $config
  26     */
  27     var $config;
  28    /**
  29     * Keep track of if we're ok
  30     * (errors for each file are kept in $files['whatever']['uploadlog']
  31     * @var boolean $status
  32     */
  33     var $status;
  34    /**
  35     * The course this file has been uploaded for. {@link $COURSE}
  36     * (for logging and virus notifications)
  37     * @var course $course
  38     */
  39     var $course;
  40    /**
  41     * If we're only getting one file.
  42     * (for logging and virus notifications)
  43     * @var string $inputname
  44     */
  45     var $inputname;
  46    /**
  47     * If we're given silent=true in the constructor, this gets built
  48     * up to hold info about the process.
  49     * @var string $notify
  50     */
  51     var $notify;
  52
  53     /**
  54      * Constructor, sets up configuration stuff so we know how to act.
  55      *
  56      * Note: destination not taken as parameter as some modules want to use the insertid in the path and we need to check the other stuff first.
  57      *
  58      * @uses $CFG
  59      * @param string $inputname If this is given the upload manager will only process the file in $_FILES with this name.
  60      * @param boolean $deleteothers Whether to delete other files in the destination directory (optional, defaults to false)
  61      * @param boolean $handlecollisions Whether to use {@link handle_filename_collision()} or not. (optional, defaults to false)
  62      * @param course $course The course the files are being uploaded for (for logging and virus notifications) {@link $COURSE}
  63      * @param boolean $recoverifmultiple If we come across a virus, or if a file doesn't validate or whatever, do we continue? optional, defaults to true.
  64      * @param int $modbytes Max bytes for this module - this and $course->maxbytes are used to get the maxbytes from {@link get_max_upload_file_size()}.
  65      * @param boolean $silent Whether to notify errors or not.
  66      * @param boolean $allownull Whether we care if there's no file when we've set the input name.
  67      * @param boolean $allownullmultiple Whether we care if there's no files AT ALL  when we've got multiples. This won't complain if we have file 1 and file 3 but not file 2, only for NO FILES AT ALL.
  68      */
  69     function upload_manager($inputname='', $deleteothers=false, $handlecollisions=false, $course=null, $recoverifmultiple=false, $modbytes=0, $silent=false, $allownull=false, $allownullmultiple=true) {
  70
  71         global $CFG, $SITE;
  72
  73         if (empty($course->id)) {
  74             $course = $SITE;
  75         }
  76
  77         $this->config->deleteothers = $deleteothers;
  78         $this->config->handlecollisions = $handlecollisions;
  79         $this->config->recoverifmultiple = $recoverifmultiple;
  80         $this->config->maxbytes = get_max_upload_file_size($CFG->maxbytes, $course->maxbytes, $modbytes);
  81         $this->config->silent = $silent;
  82         $this->config->allownull = $allownull;
  83         $this->files = array();
  84         $this->status = false;
  85         $this->course = $course;
  86         $this->inputname = $inputname;
  87         if (empty($this->inputname)) {
  88             $this->config->allownull = $allownullmultiple;
  89         }
  90     }
  91
  92     /**
  93      * Gets all entries out of $_FILES and stores them locally in $files and then
  94      * checks each one against {@link get_max_upload_file_size()} and calls {@link cleanfilename()}
  95      * and scans them for viruses etc.
  96      * @uses $CFG
  97      * @uses $_FILES
  98      * @return boolean
  99      */
 100     function preprocess_files() {
 101         global $CFG;
 102
 103         foreach ($_FILES as $name => $file) {
 104             $this->status = true; // only set it to true here so that we can check if this function has been called.
 105             if (empty($this->inputname) || $name == $this->inputname) { // if we have input name, only process if it matches.
 106                 $file['originalname'] = $file['name']; // do this first for the log.
 107                 $this->files[$name] = $file; // put it in first so we can get uploadlog out in print_upload_log.
 108                 $this->files[$name]['uploadlog'] = ''; // initialize error log
 109                 $this->status = $this->validate_file($this->files[$name]); // default to only allowing empty on multiple uploads.
 110                 if (!$this->status && ($this->files[$name]['error'] == 0 || $this->files[$name]['error'] == 4) && ($this->config->allownull || empty($this->inputname))) {
 111                     // this shouldn't cause everything to stop.. modules should be responsible for knowing which if any are compulsory.
 112                     continue;
 113                 }
 114                 if ($this->status && !empty($CFG->runclamonupload)) {
 115                     $this->status = clam_scan_moodle_file($this->files[$name],$this->course);
 116                 }
 117                 if (!$this->status) {
 118                     if (!$this->config->recoverifmultiple && count($this->files) > 1) {
 119                         $a->name = $this->files[$name]['originalname'];
 120                         $a->problem = $this->files[$name]['uploadlog'];
 121                         if (!$this->config->silent) {
 122                             notify(get_string('uploadfailednotrecovering','moodle',$a));
 123                         }
 124                         else {
 125                             $this->notify .= '<br />'. get_string('uploadfailednotrecovering','moodle',$a);
 126                         }
 127                         $this->status = false;
 128                         return false;
 129
 130                     } else if (count($this->files) == 1) {
 131
 132                         if (!$this->config->silent and !$this->config->allownull) {
 133                             notify($this->files[$name]['uploadlog']);
 134                         } else {
 135                             $this->notify .= '<br />'. $this->files[$name]['uploadlog'];
 136                         }
 137                         $this->status = false;
 138                         return false;
 139                     }
 140                 }
 141                 else {
 142                     $newname = clean_filename($this->files[$name]['name']);
 143                     if ($newname != $this->files[$name]['name']) {
 144                         $a->oldname = $this->files[$name]['name'];
 145                         $a->newname = $newname;
 146                         $this->files[$name]['uploadlog'] .= get_string('uploadrenamedchars','moodle', $a);
 147                     }
 148                     $this->files[$name]['name'] = $newname;
 149                     $this->files[$name]['clear'] = true; // ok to save.
 150                     $this->config->somethingtosave = true;
 151                 }
 152             }
 153         }
 154         if (!is_array($_FILES) || count($_FILES) == 0) {
 155             return $this->config->allownull;
 156         }
 157         $this->status = true;
 158         return true; // if we've got this far it means that we're recovering so we want status to be ok.
 159     }
 160
 161     /**
 162      * Validates a single file entry from _FILES
 163      *
 164      * @param object $file The entry from _FILES to validate
 165      * @return boolean True if ok.
 166      */
 167     function validate_file(&$file) {
 168         if (empty($file)) {
 169             return false;
 170         }
 171         if (!is_uploaded_file($file['tmp_name']) || $file['size'] == 0) {
 172             $file['uploadlog'] .= "\n".$this->get_file_upload_error($file);
 173             return false;
 174         }
 175         if ($file['size'] > $this->config->maxbytes) {
 176             $file['uploadlog'] .= "\n". get_string('uploadedfiletoobig', 'moodle', $this->config->maxbytes);
 177             return false;
 178         }
 179         return true;
 180     }
 181
 182     /**
 183      * Moves all the files to the destination directory.
 184      *
 185      * @uses $CFG
 186      * @uses $USER
 187      * @param string $destination The destination directory.
 188      * @return boolean status;
 189      */
 190     function save_files($destination) {
 191         global $CFG, $USER;
 192
 193         if (!$this->status) { // preprocess_files hasn't been run
 194             $this->preprocess_files();
 195         }
 196
 197         // if there are no files, bail before we create an empty directory.
 198         if (empty($this->config->somethingtosave)) {
 199             return true;
 200         }
 201
 202         $savedsomething = false;
 203
 204         if ($this->status) {
 205             if (!(strpos($destination, $CFG->dataroot) === false)) {
 206                 // take it out for giving to make_upload_directory
 207                 $destination = substr($destination, strlen($CFG->dataroot)+1);
 208             }
 209
 210             if ($destination{strlen($destination)-1} == '/') { // strip off a trailing / if we have one
 211                 $destination = substr($destination, 0, -1);
 212             }
 213
 214             if (!make_upload_directory($destination, true)) { //TODO maybe put this function here instead of moodlelib.php now.
 215                 $this->status = false;
 216                 return false;
 217             }
 218
 219             $destination = $CFG->dataroot .'/'. $destination; // now add it back in so we have a full path
 220
 221             $exceptions = array(); //need this later if we're deleting other files.
 222
 223             foreach (array_keys($this->files) as $i) {
 224
 225                 if (!$this->files[$i]['clear']) {
 226                     // not ok to save
 227                     continue;
 228                 }
 229
 230                 if ($this->config->handlecollisions) {
 231                     $this->handle_filename_collision($destination, $this->files[$i]);
 232                 }
 233                 if (move_uploaded_file($this->files[$i]['tmp_name'], $destination.'/'.$this->files[$i]['name'])) {
 234                     chmod($destination .'/'. $this->files[$i]['name'], $CFG->directorypermissions);
 235                     $this->files[$i]['fullpath'] = $destination.'/'.$this->files[$i]['name'];
 236                     $this->files[$i]['uploadlog'] .= "\n".get_string('uploadedfile');
 237                     $this->files[$i]['saved'] = true;
 238                     $exceptions[] = $this->files[$i]['name'];
 239                     // now add it to the log (this is important so we know who to notify if a virus is found later on)
 240                     clam_log_upload($this->files[$i]['fullpath'], $this->course);
 241                     $savedsomething=true;
 242                 }
 243             }
 244             if ($savedsomething && $this->config->deleteothers) {
 245                 $this->delete_other_files($destination, $exceptions);
 246             }
 247         }
 248         if (empty($savedsomething)) {
 249             $this->status = false;
 250             if ((empty($this->config->allownull) && !empty($this->inputname)) || (empty($this->inputname) && empty($this->config->allownullmultiple))) {
 251                 notify(get_string('uploadnofilefound'));
 252             }
 253             return false;
 254         }
 255         return $this->status;
 256     }
 257
 258     /**
 259      * Wrapper function that calls {@link preprocess_files()} and {@link viruscheck_files()} and then {@link save_files()}
 260      * Modules that require the insert id in the filepath should not use this and call these functions seperately in the required order.
 261      * @parameter string $destination Where to save the uploaded files to.
 262      * @return boolean
 263      */
 264     function process_file_uploads($destination) {
 265         if ($this->preprocess_files()) {
 266             return $this->save_files($destination);
 267         }
 268         return false;
 269     }
 270
 271     /**
 272      * Deletes all the files in a given directory except for the files in $exceptions (full paths)
 273      *
 274      * @param string $destination The directory to clean up.
 275      * @param array $exceptions Full paths of files to KEEP.
 276      */
 277     function delete_other_files($destination, $exceptions=null) {
 278         $deletedsomething = false;
 279         if ($filestodel = get_directory_list($destination)) {
 280             foreach ($filestodel as $file) {
 281                 if (!is_array($exceptions) || !in_array($file, $exceptions)) {
 282                     unlink($destination .'/'. $file);
 283                     $deletedsomething = true;
 284                 }
 285             }
 286         }
 287         if ($deletedsomething) {
 288             if (!$this->config->silent) {
 289                 notify(get_string('uploadoldfilesdeleted'));
 290             }
 291             else {
 292                 $this->notify .= '<br />'. get_string('uploadoldfilesdeleted');
 293             }
 294         }
 295     }
 296
 297     /**
 298      * Handles filename collisions - if the desired filename exists it will rename it according to the pattern in $format
 299      * @param string $destination Destination directory (to check existing files against)
 300      * @param object $file Passed in by reference. The current file from $files we're processing.
 301      * @param string $format The printf style format to rename the file to (defaults to filename_number.extn)
 302      * @return string The new filename.
 303      * @todo verify return type - this function does not appear to return anything since $file is passed in by reference
 304      */
 305     function handle_filename_collision($destination, &$file, $format='%s_%d.%s') {
 306         $part1 = explode('.', $file['name']);
 307         $bits = array();
 308         $bits[1] = array_pop($part1);
 309         $bits[0] = implode('.', $part1);
 310         // check for collisions and append a nice numberydoo.
 311         if (file_exists($destination .'/'. $file['name'])) {
 312             $a->oldname = $file['name'];
 313             for ($i = 1; true; $i++) {
 314                 $try = sprintf($format, $bits[0], $i, $bits[1]);
 315                 if ($this->check_before_renaming($destination, $try, $file)) {
 316                     $file['name'] = $try;
 317                     break;
 318                 }
 319             }
 320             $a->newname = $file['name'];
 321             $file['uploadlog'] .= "\n". get_string('uploadrenamedcollision','moodle', $a);
 322         }
 323     }
 324
 325     /**
 326      * This function checks a potential filename against what's on the filesystem already and what's been saved already.
 327      * @param string $destination Destination directory (to check existing files against)
 328      * @param string $nametocheck The filename to be compared.
 329      * @param object $file The current file from $files we're processing.
 330      * return boolean
 331      */
 332     function check_before_renaming($destination, $nametocheck, $file) {
 333         if (!file_exists($destination .'/'. $nametocheck)) {
 334             return true;
 335         }
 336         if ($this->config->deleteothers) {
 337             foreach ($this->files as $tocheck) {
 338                 // if we're deleting files anyway, it's not THIS file and we care about it and it has the same name and has already been saved..
 339                 if ($file['tmp_name'] != $tocheck['tmp_name'] && $tocheck['clear'] && $nametocheck == $tocheck['name'] && $tocheck['saved']) {
 340                     $collision = true;
 341                 }
 342             }
 343             if (!$collision) {
 344                 return true;
 345             }
 346         }
 347         return false;
 348     }
 349
 350     /**
 351      * ?
 352      *
 353      * @param object $file Passed in by reference. The current file from $files we're processing.
 354      * @return string
 355      * @todo Finish documenting this function
 356      */
 357     function get_file_upload_error(&$file) {
 358
 359         switch ($file['error']) {
 360         case 0: // UPLOAD_ERR_OK
 361             if ($file['size'] > 0) {
 362                 $errmessage = get_string('uploadproblem', $file['name']);
 363             } else {
 364                 $errmessage = get_string('uploadnofilefound'); /// probably a dud file name
 365             }
 366             break;
 367
 368         case 1: // UPLOAD_ERR_INI_SIZE
 369             $errmessage = get_string('uploadserverlimit');
 370             break;
 371
 372         case 2: // UPLOAD_ERR_FORM_SIZE
 373             $errmessage = get_string('uploadformlimit');
 374             break;
 375
 376         case 3: // UPLOAD_ERR_PARTIAL
 377             $errmessage = get_string('uploadpartialfile');
 378             break;
 379
 380         case 4: // UPLOAD_ERR_NO_FILE
 381             $errmessage = get_string('uploadnofilefound');
 382             break;
 383
 384         // Note: there is no error with a value of 5
 385
 386         case 6: // UPLOAD_ERR_NO_TMP_DIR
 387             $errmessage = get_string('uploadnotempdir');
 388             break;
 389
 390         case 7: // UPLOAD_ERR_CANT_WRITE
 391             $errmessage = get_string('uploadcantwrite');
 392             break;
 393
 394         case 8: // UPLOAD_ERR_EXTENSION
 395             $errmessage = get_string('uploadextension');
 396             break;
 397
 398         default:
 399             $errmessage = get_string('uploadproblem', $file['name']);
 400         }
 401         return $errmessage;
 402     }
 403
 404     /**
 405      * prints a log of everything that happened (of interest) to each file in _FILES
 406      * @param $return - optional, defaults to false (log is echoed)
 407      */
 408     function print_upload_log($return=false,$skipemptyifmultiple=false) {
 409         foreach (array_keys($this->files) as $i => $key) {
 410             if (count($this->files) > 1 && !empty($skipemptyifmultiple) && $this->files[$key]['error'] == 4) {
 411                 continue;
 412             }
 413             $str .= '<strong>'. get_string('uploadfilelog', 'moodle', $i+1) .' '
 414                 .((!empty($this->files[$key]['originalname'])) ? '('.$this->files[$key]['originalname'].')' : '')
 415                 .'</strong> :'. nl2br($this->files[$key]['uploadlog']) .'<br />';
 416         }
 417         if ($return) {
 418             return $str;
 419         }
 420         echo $str;
 421     }
 422
 423     /**
 424      * If we're only handling one file (if inputname was given in the constructor) this will return the (possibly changed) filename of the file.
 425      @return boolean
 426      */
 427     function get_new_filename() {
 428         if (!empty($this->inputname) and count($this->files) == 1 and $this->files[$this->inputname]['error'] != 4) {
 429             return $this->files[$this->inputname]['name'];
 430         }
 431         return false;
 432     }
 433
 434     /**
 435      * If we're only handling one file (if input name was given in the constructor) this will return the full path to the saved file.
 436      * @return boolean
 437      */
 438     function get_new_filepath() {
 439         if (!empty($this->inputname) and count($this->files) == 1 and $this->files[$this->inputname]['error'] != 4) {
 440             return $this->files[$this->inputname]['fullpath'];
 441         }
 442         return false;
 443     }
 444
 445     /**
 446      * If we're only handling one file (if inputname was given in the constructor) this will return the ORIGINAL filename of the file.
 447      * @return boolean
 448      */
 449     function get_original_filename() {
 450         if (!empty($this->inputname) and count($this->files) == 1 and $this->files[$this->inputname]['error'] != 4) {
 451             return $this->files[$this->inputname]['originalname'];
 452         }
 453         return false;
 454     }
 455
 456     /**
 457      * This function returns any errors wrapped up in red.
 458      * @return string
 459      */
 460     function get_errors() {
 461         return '<p class="notifyproblem">'. $this->notify .'</p>';
 462     }
 463 }
 464
 465 /**************************************************************************************
 466 THESE FUNCTIONS ARE OUTSIDE THE CLASS BECAUSE THEY NEED TO BE CALLED FROM OTHER PLACES.
 467 FOR EXAMPLE CLAM_HANDLE_INFECTED_FILE AND CLAM_REPLACE_INFECTED_FILE USED FROM CRON
 468 UPLOAD_PRINT_FORM_FRAGMENT DOESN'T REALLY BELONG IN THE CLASS BUT CERTAINLY IN THIS FILE
 469 ***************************************************************************************/
 470
 471
 472 /**
 473  * This function prints out a number of upload form elements.
 474  *
 475  * @param int $numfiles The number of elements required (optional, defaults to 1)
 476  * @param array $names Array of element names to use (optional, defaults to FILE_n)
 477  * @param array $descriptions Array of strings to be printed out before each file bit.
 478  * @param boolean $uselabels -Whether to output text fields for file descriptions or not (optional, defaults to false)
 479  * @param array $labelnames Array of element names to use for labels (optional, defaults to LABEL_n)
 480  * @param int $coursebytes $coursebytes and $maxbytes are used to calculate upload max size ( using {@link get_max_upload_file_size})
 481  * @param int $modbytes $coursebytes and $maxbytes are used to calculate upload max size ( using {@link get_max_upload_file_size})
 482  * @param boolean $return -Whether to return the string (defaults to false - string is echoed)
 483  * @return string Form returned as string if $return is true
 484  */
 485 function upload_print_form_fragment($numfiles=1, $names=null, $descriptions=null, $uselabels=false, $labelnames=null, $coursebytes=0, $modbytes=0, $return=false) {
 486     global $CFG;
 487     $maxbytes = get_max_upload_file_size($CFG->maxbytes, $coursebytes, $modbytes);
 488     $str = '<input type="hidden" name="MAX_FILE_SIZE" value="'. $maxbytes .'" />'."\n";
 489     for ($i = 0; $i < $numfiles; $i++) {
 490         if (is_array($descriptions) && !empty($descriptions[$i])) {
 491             $str .= '<strong>'. $descriptions[$i] .'</strong><br />';
 492         }
 493         $name = ((is_array($names) && !empty($names[$i])) ? $names[$i] : 'FILE_'.$i);
 494         $str .= '<input type="file" size="50" name="'. $name .'" alt="'. $name .'" /><br />'."\n";
 495         if ($uselabels) {
 496             $lname = ((is_array($labelnames) && !empty($labelnames[$i])) ? $labelnames[$i] : 'LABEL_'.$i);
 497             $str .= get_string('uploadlabel').' <input type="text" size="50" name="'. $lname .'" alt="'. $lname
 498                 .'" /><br /><br />'."\n";
 499         }
 500     }
 501     if ($return) {
 502         return $str;
 503     }
 504     else {
 505         echo $str;
 506     }
 507 }
 508
 509
 510 /**
 511  * Deals with an infected file - either moves it to a quarantinedir
 512  * (specified in CFG->quarantinedir) or deletes it.
 513  *
 514  * If moving it fails, it deletes it.
 515  *
 516  *@uses $CFG
 517  * @uses $USER
 518  * @param string $file Full path to the file
 519  * @param int $userid If not used, defaults to $USER->id (there in case called from cron)
 520  * @param boolean $basiconly Admin level reporting or user level reporting.
 521  * @return string Details of what the function did.
 522  */
 523 function clam_handle_infected_file($file, $userid=0, $basiconly=false) {
 524
 525     global $CFG, $USER;
 526     if ($USER && !$userid) {
 527         $userid = $USER->id;
 528     }
 529     $delete = true;
 530     if (file_exists($CFG->quarantinedir) && is_dir($CFG->quarantinedir) && is_writable($CFG->quarantinedir)) {
 531         $now = date('YmdHis');
 532         if (rename($file, $CFG->quarantinedir .'/'. $now .'-user-'. $userid .'-infected')) {
 533             $delete = false;
 534             clam_log_infected($file, $CFG->quarantinedir.'/'. $now .'-user-'. $userid .'-infected', $userid);
 535             if ($basiconly) {
 536                 $notice .= "\n". get_string('clammovedfilebasic');
 537             }
 538             else {
 539                 $notice .= "\n". get_string('clammovedfile', 'moodle', $CFG->quarantinedir.'/'. $now .'-user-'. $userid .'-infected');
 540             }
 541         }
 542         else {
 543             if ($basiconly) {
 544                 $notice .= "\n". get_string('clamdeletedfile');
 545             }
 546             else {
 547                 $notice .= "\n". get_string('clamquarantinedirfailed', 'moodle', $CFG->quarantinedir);
 548             }
 549         }
 550     }
 551     else {
 552         if ($basiconly) {
 553             $notice .= "\n". get_string('clamdeletedfile');
 554         }
 555         else {
 556             $notice .= "\n". get_string('clamquarantinedirfailed', 'moodle', $CFG->quarantinedir);
 557         }
 558     }
 559     if ($delete) {
 560         if (unlink($file)) {
 561             clam_log_infected($file, '', $userid);
 562             $notice .= "\n". get_string('clamdeletedfile');
 563         }
 564         else {
 565             if ($basiconly) {
 566                 // still tell the user the file has been deleted. this is only for admins.
 567                 $notice .= "\n". get_string('clamdeletedfile');
 568             }
 569             else {
 570                 $notice .= "\n". get_string('clamdeletedfilefailed');
 571             }
 572         }
 573     }
 574     return $notice;
 575 }
 576
 577 /**
 578  * Replaces the given file with a string.
 579  *
 580  * The replacement string is used to notify that the original file had a virus
 581  * This is to avoid missing files but could result in the wrong content-type.
 582  * @param string $file Full path to the file.
 583  * @return boolean
 584  */
 585 function clam_replace_infected_file($file) {
 586     $newcontents = get_string('virusplaceholder');
 587     if (!$f = fopen($file, 'w')) {
 588         return false;
 589     }
 590     if (!fwrite($f, $newcontents)) {
 591         return false;
 592     }
 593     return true;
 594 }
 595
 596
 597 /**
 598  * If $CFG->runclamonupload is set, we scan a given file. (called from {@link preprocess_files()})
 599  *
 600  * This function will add on a uploadlog index in $file.
 601  * @param mixed $file The file to scan from $files. or an absolute path to a file.
 602  * @param course $course {@link $COURSE}
 603  * @return int 1 if good, 0 if something goes wrong (opposite from actual error code from clam)
 604  */
 605 function clam_scan_moodle_file(&$file, $course) {
 606     global $CFG, $USER;
 607
 608     if (is_array($file) && is_uploaded_file($file['tmp_name'])) { // it's from $_FILES
 609         $appendlog = true;
 610         $fullpath = $file['tmp_name'];
 611     }
 612     else if (file_exists($file)) { // it's a path to somewhere on the filesystem!
 613         $fullpath = $file;
 614     }
 615     else {
 616         return false; // erm, what is this supposed to be then, huh?
 617     }
 618
 619     $CFG->pathtoclam = trim($CFG->pathtoclam);
 620
 621     if (!$CFG->pathtoclam || !file_exists($CFG->pathtoclam) || !is_executable($CFG->pathtoclam)) {
 622         $newreturn = 1;
 623         $notice = get_string('clamlost', 'moodle', $CFG->pathtoclam);
 624         if ($CFG->clamfailureonupload == 'actlikevirus') {
 625             $notice .= "\n". get_string('clamlostandactinglikevirus');
 626             $notice .= "\n". clam_handle_infected_file($fullpath);
 627             $newreturn = false;
 628         }
 629         clam_mail_admins($notice);
 630         if ($appendlog) {
 631             $file['uploadlog'] .= "\n". get_string('clambroken');
 632             $file['clam'] = 1;
 633         }
 634         return $newreturn; // return 1 if we're allowing clam failures
 635     }
 636
 637     $cmd = $CFG->pathtoclam .' '. $fullpath ." 2>&1";
 638
 639     // before we do anything we need to change perms so that clamscan can read the file (clamdscan won't work otherwise)
 640     chmod($fullpath,0644);
 641
 642     exec($cmd, $output, $return);
 643
 644
 645     switch ($return) {
 646     case 0: // glee! we're ok.
 647         return 1; // translate clam return code into reasonable return code consistent with everything else.
 648     case 1:  // bad wicked evil, we have a virus.
 649         if (!empty($course)) {
 650             $info->course = $course->fullname;
 651         }
 652         else {
 653             $info->course = 'No course';
 654         }
 655         $info->user = fullname($USER);
 656         $notice = get_string('virusfound', 'moodle', $info);
 657         $notice .= "\n\n". implode("\n", $output);
 658         $notice .= "\n\n". clam_handle_infected_file($fullpath);
 659         clam_mail_admins($notice);
 660         if ($appendlog) {
 661             $info->filename = $file['originalname'];
 662             $file['uploadlog'] .= "\n". get_string('virusfounduser', 'moodle', $info);
 663             $file['virus'] = 1;
 664         }
 665         return false; // in this case, 0 means bad.
 666     default:
 667         // error - clam failed to run or something went wrong
 668         $notice .= get_string('clamfailed', 'moodle', get_clam_error_code($return));
 669         $notice .= "\n\n". implode("\n", $output);
 670         $newreturn = true;
 671         if ($CFG->clamfailureonupload == 'actlikevirus') {
 672             $notice .= "\n". clam_handle_infected_file($fullpath);
 673             $newreturn = false;
 674         }
 675         clam_mail_admins($notice);
 676         if ($appendlog) {
 677             $file['uploadlog'] .= "\n". get_string('clambroken');
 678             $file['clam'] = 1;
 679         }
 680         return $newreturn; // return 1 if we're allowing failures.
 681     }
 682 }
 683
 684 /**
 685  * Emails admins about a clam outcome
 686  *
 687  * @param string $notice The body of the email to be sent.
 688  */
 689 function clam_mail_admins($notice) {
 690
 691     $site = get_site();
 692
 693     $subject = get_string('clamemailsubject', 'moodle', format_string($site->fullname));
 694     $admins = get_admins();
 695     foreach ($admins as $admin) {
 696         email_to_user($admin, get_admin(), $subject, $notice);
 697     }
 698 }
 699
 700
 701 /**
 702  * Returns the string equivalent of a numeric clam error code
 703  *
 704  * @param int $returncode The numeric error code in question.
 705  * return string The definition of the error code
 706  */
 707 function get_clam_error_code($returncode) {
 708     $returncodes = array();
 709     $returncodes[0] = 'No virus found.';
 710     $returncodes[1] = 'Virus(es) found.';
 711     $returncodes[2] = ' An error occured'; // specific to clamdscan
 712     // all after here are specific to clamscan
 713     $returncodes[40] = 'Unknown option passed.';
 714     $returncodes[50] = 'Database initialization error.';
 715     $returncodes[52] = 'Not supported file type.';
 716     $returncodes[53] = 'Can\'t open directory.';
 717     $returncodes[54] = 'Can\'t open file. (ofm)';
 718     $returncodes[55] = 'Error reading file. (ofm)';
 719     $returncodes[56] = 'Can\'t stat input file / directory.';
 720     $returncodes[57] = 'Can\'t get absolute path name of current working directory.';
 721     $returncodes[58] = 'I/O error, please check your filesystem.';
 722     $returncodes[59] = 'Can\'t get information about current user from /etc/passwd.';
 723     $returncodes[60] = 'Can\'t get information about user \'clamav\' (default name) from /etc/passwd.';
 724     $returncodes[61] = 'Can\'t fork.';
 725     $returncodes[63] = 'Can\'t create temporary files/directories (check permissions).';
 726     $returncodes[64] = 'Can\'t write to temporary directory (please specify another one).';
 727     $returncodes[70] = 'Can\'t allocate and clear memory (calloc).';
 728     $returncodes[71] = 'Can\'t allocate memory (malloc).';
 729     if ($returncodes[$returncode])
 730        return $returncodes[$returncode];
 731     return get_string('clamunknownerror');
 732
 733 }
 734
 735 /**
 736  * Adds a file upload to the log table so that clam can resolve the filename to the user later if necessary
 737  *
 738  * @uses $CFG
 739  * @uses $USER
 740  * @param string $newfilepath ?
 741  * @param course $course {@link $COURSE}
 742  * @param boolean $nourl ?
 743  * @todo Finish documenting this function
 744  */
 745 function clam_log_upload($newfilepath, $course=null, $nourl=false) {
 746     global $CFG, $USER;
 747     // get rid of any double // that might have appeared
 748     $newfilepath = preg_replace('/\/\//', '/', $newfilepath);
 749     if (strpos($newfilepath, $CFG->dataroot) === false) {
 750         $newfilepath = $CFG->dataroot .'/'. $newfilepath;
 751     }
 752     $courseid = 0;
 753     if ($course) {
 754         $courseid = $course->id;
 755     }
 756     add_to_log($courseid, 'upload', 'upload', ((!$nourl) ? substr($_SERVER['HTTP_REFERER'], 0, 100) : ''), $newfilepath);
 757 }
 758
 759 /**
 760  * This function logs to error_log and to the log table that an infected file has been found and what's happened to it.
 761  *
 762  * @param string $oldfilepath Full path to the infected file before it was moved.
 763  * @param string $newfilepath Full path to the infected file since it was moved to the quarantine directory (if the file was deleted, leave empty).
 764  * @param int $userid The user id of the user who uploaded the file.
 765  */
 766 function clam_log_infected($oldfilepath='', $newfilepath='', $userid=0) {
 767
 768     add_to_log(0, 'upload', 'infected', $_SERVER['HTTP_REFERER'], $oldfilepath, 0, $userid);
 769
 770     $user = get_record('user', 'id', $userid);
 771
 772     $errorstr = 'Clam AV has found a file that is infected with a virus. It was uploaded by '
 773         . ((empty($user)) ? ' an unknown user ' : fullname($user))
 774         . ((empty($oldfilepath)) ? '. The infected file was caught on upload ('.$oldfilepath.')'
 775            : '. The original file path of the infected file was '. $oldfilepath)
 776         . ((empty($newfilepath)) ? '. The file has been deleted ' : '. The file has been moved to a quarantine directory and the new path is '. $newfilepath);
 777
 778     error_log($errorstr);
 779 }
 780
 781
 782 /**
 783  * Some of the modules allow moving attachments (glossary), in which case we need to hunt down an original log and change the path.
 784  *
 785  * @uses $CFG
 786  * @param string $oldpath The old path to the file (should be in the log)
 787  * @param string $newpath The new path to the file
 788  * @param boolean $update If true this function will overwrite old record (used for forum moving etc).
 789  */
 790 function clam_change_log($oldpath, $newpath, $update=true) {
 791     global $CFG;
 792
 793     if (!$record = get_record('log', 'info', $oldpath, 'module', 'upload')) {
 794         return false;
 795     }
 796     $record->info = $newpath;
 797     if ($update) {
 798         update_record('log', $record);
 799     }
 800     else {
 801         unset($record->id);
 802         insert_record('log', $record);
 803     }
 804 }
 805 ?>