mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-13 12:32:08 +02:00
Code Issues Projects Releases Wiki Activity

MDL-44260 core_file: final deprecation of upload_manager class and clam functions

Browse Source
This commit is contained in:
Simey Lameze 2014-12-17 15:10:13 +08:00
parent 8f06fffbe1
commit 1e23ff2122
1 changed files with 5 additions and 591 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

596
lib/uploadlib.php
View File

@ -37,466 +37,16 @@ defined('MOODLE_INTERNAL') || die();
*/
class upload_manager {
/**
* Array to hold local copies of stuff in $_FILES
* @var array $files
*/
var $files;
/**
* Holds all configuration stuff
* @var array $config
*/
var $config;
/**
* Keep track of if we're ok
* (errors for each file are kept in $files['whatever']['uploadlog']
* @var boolean $status
*/
var $status;
/**
* The course this file has been uploaded for. {@link $COURSE}
* (for logging and virus notifications)
* @var course $course
*/
var $course;
/**
* If we're only getting one file.
* (for logging and virus notifications)
* @var string $inputname
*/
var $inputname;
/**
* If we're given silent=true in the constructor, this gets built
* up to hold info about the process.
* @var string $notify
*/
var $notify;
/**
* Constructor, sets up configuration stuff so we know how to act.
*
* 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.
*
* @uses $CFG
* @param string $inputname If this is given the upload manager will only process the file in $_FILES with this name.
* @param boolean $deleteothers Whether to delete other files in the destination directory (optional, defaults to false)
* @param boolean $handlecollisions Whether to use {@link handle_filename_collision()} or not. (optional, defaults to false)
* @param course $course The course the files are being uploaded for (for logging and virus notifications) {@link $COURSE}
* @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.
* @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()}.
* @param boolean $silent Whether to notify errors or not.
* @param boolean $allownull Whether we care if there's no file when we've set the input name.
* @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.
* @deprecated since 2.7 - use new file pickers instead
*
*/
function __construct($inputname='', $deleteothers=false, $handlecollisions=false, $course=null, $recoverifmultiple=false, $modbytes=0, $silent=false, $allownull=false, $allownullmultiple=true) {
global $CFG, $SITE;
debugging('upload_manager class is deprecated, use new file picker instead', DEBUG_DEVELOPER);
if (empty($course->id)) {
$course = $SITE;
}
$this->config = new stdClass();
$this->config->deleteothers = $deleteothers;
$this->config->handlecollisions = $handlecollisions;
$this->config->recoverifmultiple = $recoverifmultiple;
$this->config->maxbytes = get_max_upload_file_size($CFG->maxbytes, $course->maxbytes, $modbytes);
$this->config->silent = $silent;
$this->config->allownull = $allownull;
$this->files = array();
$this->status = false;
$this->course = $course;
$this->inputname = $inputname;
if (empty($this->inputname)) {
$this->config->allownull = $allownullmultiple;
}
}
/**
* Gets all entries out of $_FILES and stores them locally in $files and then
* checks each one against {@link get_max_upload_file_size()} and calls {@link cleanfilename()}
* and scans them for viruses etc.
* @uses $CFG
* @uses $_FILES
* @return boolean
*/
function preprocess_files() {
global $CFG, $OUTPUT;
foreach ($_FILES as $name => $file) {
$this->status = true; // only set it to true here so that we can check if this function has been called.
if (empty($this->inputname) || $name == $this->inputname) { // if we have input name, only process if it matches.
$file['originalname'] = $file['name']; // do this first for the log.
$this->files[$name] = $file; // put it in first so we can get uploadlog out in print_upload_log.
$this->files[$name]['uploadlog'] = ''; // initialize error log
$this->status = $this->validate_file($this->files[$name]); // default to only allowing empty on multiple uploads.
if (!$this->status && ($this->files[$name]['error'] == 0 || $this->files[$name]['error'] == 4) && ($this->config->allownull || empty($this->inputname))) {
// this shouldn't cause everything to stop.. modules should be responsible for knowing which if any are compulsory.
continue;
}
if ($this->status && !empty($CFG->runclamonupload)) {
$this->status = clam_scan_moodle_file($this->files[$name],$this->course);
}
if (!$this->status) {
if (!$this->config->recoverifmultiple && count($this->files) > 1) {
$a = new stdClass();
$a->name = $this->files[$name]['originalname'];
$a->problem = $this->files[$name]['uploadlog'];
if (!$this->config->silent) {
echo $OUTPUT->notification(get_string('uploadfailednotrecovering','moodle',$a));
}
else {
$this->notify .= '<br />'. get_string('uploadfailednotrecovering','moodle',$a);
}
$this->status = false;
return false;
} else if (count($this->files) == 1) {
if (!$this->config->silent and !$this->config->allownull) {
echo $OUTPUT->notification($this->files[$name]['uploadlog']);
} else {
$this->notify .= '<br />'. $this->files[$name]['uploadlog'];
}
$this->status = false;
return false;
}
}
else {
$newname = clean_filename($this->files[$name]['name']);
if ($newname != $this->files[$name]['name']) {
$a = new stdClass();
$a->oldname = $this->files[$name]['name'];
$a->newname = $newname;
$this->files[$name]['uploadlog'] .= get_string('uploadrenamedchars','moodle', $a);
}
$this->files[$name]['name'] = $newname;
$this->files[$name]['clear'] = true; // ok to save.
$this->config->somethingtosave = true;
}
}
}
if (!is_array($_FILES) || count($_FILES) == 0) {
return $this->config->allownull;
}
$this->status = true;
return true; // if we've got this far it means that we're recovering so we want status to be ok.
}
/**
* Validates a single file entry from _FILES
*
* @param object $file The entry from _FILES to validate
* @return boolean True if ok.
*/
function validate_file(&$file) {
if (empty($file)) {
return false;
}
if (!is_uploaded_file($file['tmp_name']) || $file['size'] == 0) {
$file['uploadlog'] .= "\n".$this->get_file_upload_error($file);
return false;
}
if ($file['size'] > $this->config->maxbytes) {
$file['uploadlog'] .= "\n". get_string('uploadedfiletoobig', 'moodle', $this->config->maxbytes);
return false;
}
return true;
}
/**
* Moves all the files to the destination directory.
*
* @uses $CFG
* @uses $USER
* @param string $destination The destination directory.
* @return boolean status;
*/
function save_files($destination) {
global $CFG, $USER, $OUTPUT;
if (!$this->status) { // preprocess_files hasn't been run
$this->preprocess_files();
}
// if there are no files, bail before we create an empty directory.
if (empty($this->config->somethingtosave)) {
return true;
}
$savedsomething = false;
if ($this->status) {
if (!(strpos($destination, $CFG->dataroot) === false)) {
// take it out for giving to make_upload_directory
$destination = substr($destination, strlen($CFG->dataroot)+1);
}
if ($destination{strlen($destination)-1} == '/') { // strip off a trailing / if we have one
$destination = substr($destination, 0, -1);
}
if (!make_upload_directory($destination, true)) {
$this->status = false;
return false;
}
$destination = $CFG->dataroot .'/'. $destination; // now add it back in so we have a full path
$exceptions = array(); //need this later if we're deleting other files.
foreach (array_keys($this->files) as $i) {
if (!$this->files[$i]['clear']) {
// not ok to save
continue;
}
if ($this->config->handlecollisions) {
$this->handle_filename_collision($destination, $this->files[$i]);
}
if (move_uploaded_file($this->files[$i]['tmp_name'], $destination.'/'.$this->files[$i]['name'])) {
chmod($destination .'/'. $this->files[$i]['name'], $CFG->directorypermissions);
$this->files[$i]['fullpath'] = $destination.'/'.$this->files[$i]['name'];
$this->files[$i]['uploadlog'] .= "\n".get_string('uploadedfile');
$this->files[$i]['saved'] = true;
$exceptions[] = $this->files[$i]['name'];
$savedsomething=true;
}
}
if ($savedsomething && $this->config->deleteothers) {
$this->delete_other_files($destination, $exceptions);
}
}
if (empty($savedsomething)) {
$this->status = false;
if ((empty($this->config->allownull) && !empty($this->inputname)) || (empty($this->inputname) && empty($this->config->allownullmultiple))) {
echo $OUTPUT->notification(get_string('uploadnofilefound'));
}
return false;
}
return $this->status;
}
/**
* Wrapper function that calls {@link preprocess_files()} and {@link viruscheck_files()} and then {@link save_files()}
* Modules that require the insert id in the filepath should not use this and call these functions seperately in the required order.
* @parameter string $destination Where to save the uploaded files to.
* @return boolean
*/
function process_file_uploads($destination) {
if ($this->preprocess_files()) {
return $this->save_files($destination);
}
return false;
}
/**
* Deletes all the files in a given directory except for the files in $exceptions (full paths)
*
* @param string $destination The directory to clean up.
* @param array $exceptions Full paths of files to KEEP.
*/
function delete_other_files($destination, $exceptions=null) {
global $OUTPUT;
$deletedsomething = false;
if ($filestodel = get_directory_list($destination)) {
foreach ($filestodel as $file) {
if (!is_array($exceptions) || !in_array($file, $exceptions)) {
unlink($destination .'/'. $file);
$deletedsomething = true;
}
}
}
if ($deletedsomething) {
if (!$this->config->silent) {
echo $OUTPUT->notification(get_string('uploadoldfilesdeleted'));
}
else {
$this->notify .= '<br />'. get_string('uploadoldfilesdeleted');
}
}
}
/**
* Handles filename collisions - if the desired filename exists it will rename it according to the pattern in $format
* @param string $destination Destination directory (to check existing files against)
* @param object $file Passed in by reference. The current file from $files we're processing.
* @return void - modifies &$file parameter.
*/
function handle_filename_collision($destination, &$file) {
if (!file_exists($destination .'/'. $file['name'])) {
return;
}
$parts = explode('.', $file['name']);
if (count($parts) > 1) {
$extension = '.'.array_pop($parts);
$name = implode('.', $parts);
} else {
$extension = '';
$name = $file['name'];
}
$current = 0;
if (preg_match('/^(.*)_(\d*)$/s', $name, $matches)) {
$name = $matches[1];
$current = (int)$matches[2];
}
$i = $current + 1;
while (!$this->check_before_renaming($destination, $name.'_'.$i.$extension, $file)) {
$i++;
}
$a = new stdClass();
$a->oldname = $file['name'];
$file['name'] = $name.'_'.$i.$extension;
$a->newname = $file['name'];
$file['uploadlog'] .= "\n". get_string('uploadrenamedcollision','moodle', $a);
}
/**
* This function checks a potential filename against what's on the filesystem already and what's been saved already.
* @param string $destination Destination directory (to check existing files against)
* @param string $nametocheck The filename to be compared.
* @param object $file The current file from $files we're processing.
* return boolean
*/
function check_before_renaming($destination, $nametocheck, $file) {
if (!file_exists($destination .'/'. $nametocheck)) {
return true;
}
if ($this->config->deleteothers) {
foreach ($this->files as $tocheck) {
// 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..
if ($file['tmp_name'] != $tocheck['tmp_name'] && $tocheck['clear'] && $nametocheck == $tocheck['name'] && $tocheck['saved']) {
$collision = true;
}
}
if (!$collision) {
return true;
}
}
return false;
}
/**
* ?
*
* @param object $file Passed in by reference. The current file from $files we're processing.
* @return string
*/
function get_file_upload_error(&$file) {
switch ($file['error']) {
case 0: // UPLOAD_ERR_OK
if ($file['size'] > 0) {
$errmessage = get_string('uploadproblem', $file['name']);
} else {
$errmessage = get_string('uploadnofilefound'); /// probably a dud file name
}
break;
case 1: // UPLOAD_ERR_INI_SIZE
$errmessage = get_string('uploadserverlimit');
break;
case 2: // UPLOAD_ERR_FORM_SIZE
$errmessage = get_string('uploadformlimit');
break;
case 3: // UPLOAD_ERR_PARTIAL
$errmessage = get_string('uploadpartialfile');
break;
case 4: // UPLOAD_ERR_NO_FILE
$errmessage = get_string('uploadnofilefound');
break;
// Note: there is no error with a value of 5
case 6: // UPLOAD_ERR_NO_TMP_DIR
$errmessage = get_string('uploadnotempdir');
break;
case 7: // UPLOAD_ERR_CANT_WRITE
$errmessage = get_string('uploadcantwrite');
break;
case 8: // UPLOAD_ERR_EXTENSION
$errmessage = get_string('uploadextension');
break;
default:
$errmessage = get_string('uploadproblem', $file['name']);
}
return $errmessage;
}
/**
* prints a log of everything that happened (of interest) to each file in _FILES
* @param $return - optional, defaults to false (log is echoed)
*/
function print_upload_log($return=false,$skipemptyifmultiple=false) {
$str = '';
foreach (array_keys($this->files) as $i => $key) {
if (count($this->files) > 1 && !empty($skipemptyifmultiple) && $this->files[$key]['error'] == 4) {
continue;
}
$str .= '<strong>'. get_string('uploadfilelog', 'moodle', $i+1) .' '
.((!empty($this->files[$key]['originalname'])) ? '('.$this->files[$key]['originalname'].')' : '')
.'</strong> :'. nl2br($this->files[$key]['uploadlog']) .'<br />';
}
if ($return) {
return $str;
}
echo $str;
}
/**
* If we're only handling one file (if inputname was given in the constructor) this will return the (possibly changed) filename of the file.
@return boolean
*/
function get_new_filename() {
if (!empty($this->inputname) and count($this->files) == 1 and $this->files[$this->inputname]['error'] != 4) {
return $this->files[$this->inputname]['name'];
}
return false;
}
/**
* 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.
* @return boolean
*/
function get_new_filepath() {
if (!empty($this->inputname) and count($this->files) == 1 and $this->files[$this->inputname]['error'] != 4) {
return $this->files[$this->inputname]['fullpath'];
}
return false;
}
/**
* If we're only handling one file (if inputname was given in the constructor) this will return the ORIGINAL filename of the file.
* @return boolean
*/
function get_original_filename() {
if (!empty($this->inputname) and count($this->files) == 1 and $this->files[$this->inputname]['error'] != 4) {
return $this->files[$this->inputname]['originalname'];
}
return false;
}
/**
* This function returns any errors wrapped up in red.
* @return string
*/
function get_errors() {
if (!empty($this->notify)) {
return '<p class="notifyproblem">'. $this->notify .'</p>';
} else {
return null;
}
throw new coding_exception('upload_manager class can not be used any more, please use file picker instead');
}
}
@ -514,64 +64,9 @@ UPLOAD_PRINT_FORM_FRAGMENT DOESN'T REALLY BELONG IN THE CLASS BUT CERTAINLY IN T
*
* @deprecated since 2.7 - to be removed together with the upload_manager above
*
* @param string $file Full path to the file
* @param int $userid If not used, defaults to $USER->id (there in case called from cron)
* @param boolean $basiconly Admin level reporting or user level reporting.
* @return string Details of what the function did.
*/
function clam_handle_infected_file($file, $userid=0, $basiconly=false) {
global $CFG, $USER;
debugging('clam_handle_infected_file() is not supposed to be used, the files are now scanned in file picker', DEBUG_DEVELOPER);
if ($USER && !$userid) {
$userid = $USER->id;
}
$delete = true;
$notice = '';
if (file_exists($CFG->quarantinedir) && is_dir($CFG->quarantinedir) && is_writable($CFG->quarantinedir)) {
$now = date('YmdHis');
if (rename($file, $CFG->quarantinedir .'/'. $now .'-user-'. $userid .'-infected')) {
$delete = false;
if ($basiconly) {
$notice .= "\n". get_string('clammovedfilebasic');
}
else {
$notice .= "\n". get_string('clammovedfile', 'moodle', $CFG->quarantinedir.'/'. $now .'-user-'. $userid .'-infected');
}
}
else {
if ($basiconly) {
$notice .= "\n". get_string('clamdeletedfile');
}
else {
$notice .= "\n". get_string('clamquarantinedirfailed', 'moodle', $CFG->quarantinedir);
}
}
}
else {
if ($basiconly) {
$notice .= "\n". get_string('clamdeletedfile');
}
else {
$notice .= "\n". get_string('clamquarantinedirfailed', 'moodle', $CFG->quarantinedir);
}
}
if ($delete) {
if (unlink($file)) {
$notice .= "\n". get_string('clamdeletedfile');
}
else {
if ($basiconly) {
// still tell the user the file has been deleted. this is only for admins.
$notice .= "\n". get_string('clamdeletedfile');
}
else {
$notice .= "\n". get_string('clamdeletedfilefailed');
}
}
}
return $notice;
throw new coding_exception('clam_handle_infected_file() can not be used any more, please use file picker instead');
}
/**
@ -579,90 +74,9 @@ function clam_handle_infected_file($file, $userid=0, $basiconly=false) {
*
* @deprecated since 2.7 - to be removed together with the upload_manager above
*
* @param mixed $file The file to scan from $files. or an absolute path to a file.
* @param stdClass $course
* @return int 1 if good, 0 if something goes wrong (opposite from actual error code from clam)
*/
function clam_scan_moodle_file(&$file, $course) {
global $CFG, $USER;
debugging('clam_scan_moodle_file() is not supposed to be used, the files are now scanned in file picker', DEBUG_DEVELOPER);
if (is_array($file) && is_uploaded_file($file['tmp_name'])) { // it's from $_FILES
$appendlog = true;
$fullpath = $file['tmp_name'];
}
else if (file_exists($file)) { // it's a path to somewhere on the filesystem!
$fullpath = $file;
}
else {
return false; // erm, what is this supposed to be then, huh?
}
$CFG->pathtoclam = trim($CFG->pathtoclam);
if (!$CFG->pathtoclam || !file_exists($CFG->pathtoclam) || !is_executable($CFG->pathtoclam)) {
$newreturn = 1;
$notice = get_string('clamlost', 'moodle', $CFG->pathtoclam);
if ($CFG->clamfailureonupload == 'actlikevirus') {
$notice .= "\n". get_string('clamlostandactinglikevirus');
$notice .= "\n". clam_handle_infected_file($fullpath);
$newreturn = false;
}
clam_message_admins($notice);
if ($appendlog) {
$file['uploadlog'] .= "\n". get_string('clambroken');
$file['clam'] = 1;
}
return $newreturn; // return 1 if we're allowing clam failures
}
$cmd = $CFG->pathtoclam .' '. $fullpath ." 2>&1";
// before we do anything we need to change perms so that clamscan can read the file (clamdscan won't work otherwise)
chmod($fullpath, $CFG->directorypermissions);
exec($cmd, $output, $return);
switch ($return) {
case 0: // glee! we're ok.
return 1; // translate clam return code into reasonable return code consistent with everything else.
case 1: // bad wicked evil, we have a virus.
$info = new stdClass();
if (!empty($course)) {
$info->course = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
}
else {
$info->course = 'No course';
}
$info->user = fullname($USER);
$notice = get_string('virusfound', 'moodle', $info);
$notice .= "\n\n". implode("\n", $output);
$notice .= "\n\n". clam_handle_infected_file($fullpath);
clam_message_admins($notice);
if ($appendlog) {
$info->filename = $file['originalname'];
$file['uploadlog'] .= "\n". get_string('virusfounduser', 'moodle', $info);
$file['virus'] = 1;
}
return false; // in this case, 0 means bad.
default:
// error - clam failed to run or something went wrong
$notice = get_string('clamfailed', 'moodle', get_clam_error_code($return));
$notice .= "\n\n". implode("\n", $output);
$newreturn = true;
if ($CFG->clamfailureonupload == 'actlikevirus') {
$notice .= "\n". clam_handle_infected_file($fullpath);
$newreturn = false;
}
clam_message_admins($notice);
if ($appendlog) {
$file['uploadlog'] .= "\n". get_string('clambroken');
$file['clam'] = 1;
}
return $newreturn; // return 1 if we're allowing failures.
}
throw new coding_exception('clam_scan_moodle_file() can not be used any more, please use file picker instead');
}
/**