* Copyright 2001-2012 Strangecode, LLC * * This file is part of The Strangecode Codebase. * * The Strangecode Codebase is free software: you can redistribute it and/or * modify it under the terms of the GNU General Public License as published by the * Free Software Foundation, either version 3 of the License, or (at your option) * any later version. * * The Strangecode Codebase is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more * details. * * You should have received a copy of the GNU General Public License along with * The Strangecode Codebase. If not, see . */ /** * Upload.inc.php * * The Upload class provides an interface to deal with http uploaded files. * * @author Quinn Comendant * @requires App.inc.php * @version 1.4 */ // Upload error types. define('UPLOAD_USER_ERR_EMPTY_FILE', 100); define('UPLOAD_USER_ERR_NOT_UPLOADED_FILE', 101); define('UPLOAD_USER_ERR_INVALID_EXTENSION', 102); define('UPLOAD_USER_ERR_NOT_UNIQUE', 103); define('UPLOAD_USER_ERR_MOVE_FAILED', 104); class Upload { // General object parameters. protected $_params = array( // Which messages do we pass to raiseMsg? 'display_messages' => MSG_ALL, // Existing files will be overwritten when there is a name conflict? 'allow_overwriting' => false, // The filesystem path to the final upload directory. 'upload_path' => null, // The file permissions of the uploaded files. Remember, files will be owned by the web server user. 'dest_file_perms' => 0600, // The file permissions of the uploaded files. Remember, files will be owned by the web server user. 'dest_dir_perms' => 0700, // Require file to have one of the following file name extensions. 'valid_file_extensions' => array('jpg', 'jpeg', 'gif', 'png', 'pdf', 'txt', 'text', 'html', 'htm'), ); // Array of files with errors. public $errors = array(); // Array of file name extensions and corresponding mime-types. public $mime_extension_map = array( 'ez' => 'application/andrew-inset', 'hqx' => 'application/mac-binhex40', 'cpt' => 'application/mac-compactpro', 'doc' => 'application/msword', 'bin' => 'application/octet-stream', 'class' => 'application/octet-stream', 'dll' => 'application/octet-stream', 'dms' => 'application/octet-stream', 'exe' => 'application/octet-stream', 'lha' => 'application/octet-stream', 'lzh' => 'application/octet-stream', 'so' => 'application/octet-stream', 'oda' => 'application/oda', 'pdf' => 'application/pdf', 'ai' => 'application/postscript', 'eps' => 'application/postscript', 'ps' => 'application/postscript', 'smi' => 'application/smil', 'smil' => 'application/smil', 'mif' => 'application/vnd.mif', 'xls' => 'application/vnd.ms-excel', 'ppt' => 'application/vnd.ms-powerpoint', 'sxc' => 'application/vnd.sun.xml.calc', 'stc' => 'application/vnd.sun.xml.calc.template', 'sxd' => 'application/vnd.sun.xml.draw', 'std' => 'application/vnd.sun.xml.draw.template', 'sxi' => 'application/vnd.sun.xml.impress', 'sti' => 'application/vnd.sun.xml.impress.template', 'sxm' => 'application/vnd.sun.xml.math', 'sxw' => 'application/vnd.sun.xml.writer', 'sxg' => 'application/vnd.sun.xml.writer.global', 'stw' => 'application/vnd.sun.xml.writer.template', 'vsd' => 'application/vnd.visio', 'wbxml' => 'application/vnd.wap.wbxml', 'wmlc' => 'application/vnd.wap.wmlc', 'wmlsc' => 'application/vnd.wap.wmlscriptc', 'bcpio' => 'application/x-bcpio', 'vcd' => 'application/x-cdlink', 'pgn' => 'application/x-chess-pgn', 'Z' => 'application/x-compress', 'cpio' => 'application/x-cpio', 'csh' => 'application/x-csh', 'dcr' => 'application/x-director', 'dir' => 'application/x-director', 'dxr' => 'application/x-director', 'dvi' => 'application/x-dvi', 'spl' => 'application/x-futuresplash', 'gtar' => 'application/x-gtar', 'tgz' => 'application/x-gtar', 'gz' => 'application/x-gzip', 'hdf' => 'application/x-hdf', 'php' => 'application/x-httpd-php', 'php3' => 'application/x-httpd-php3', 'js' => 'application/x-javascript', 'skd' => 'application/x-koan', 'skm' => 'application/x-koan', 'skp' => 'application/x-koan', 'skt' => 'application/x-koan', 'latex' => 'application/x-latex', 'wmd' => 'application/x-ms-wmd', 'wmz' => 'application/x-ms-wmz', 'cdf' => 'application/x-netcdf', 'nc' => 'application/x-netcdf', 'pl' => 'application/x-perl', 'pm' => 'application/x-perl', 'psd' => 'application/x-photoshop', 'sh' => 'application/x-sh', 'shar' => 'application/x-shar', 'swf' => 'application/x-shockwave-flash', 'sit' => 'application/x-stuffit', 'sv4cpio' => 'application/x-sv4cpio', 'sv4crc' => 'application/x-sv4crc', 'tar' => 'application/x-tar', 'tcl' => 'application/x-tcl', 'tex' => 'application/x-tex', 'texi' => 'application/x-texinfo', 'texinfo' => 'application/x-texinfo', 'roff' => 'application/x-troff', 't' => 'application/x-troff', 'tr' => 'application/x-troff', 'man' => 'application/x-troff-man', 'me' => 'application/x-troff-me', 'ms' => 'application/x-troff-ms', 'ustar' => 'application/x-ustar', 'src' => 'application/x-wais-source', 'xht' => 'application/xhtml+xml', 'xhtml' => 'application/xhtml+xml', 'xml' => 'application/xml', 'zip' => 'application/zip', 'au' => 'audio/basic', 'snd' => 'audio/basic', 'kar' => 'audio/midi', 'mid' => 'audio/midi', 'midi' => 'audio/midi', 'mp2' => 'audio/mpeg', 'mp3' => 'audio/mp3', 'mpga' => 'audio/mpeg', 'aif' => 'audio/x-aiff', 'aifc' => 'audio/x-aiff', 'aiff' => 'audio/x-aiff', 'm3u' => 'audio/x-mpegurl', 'wax' => 'audio/x-ms-wax', 'wma' => 'audio/x-ms-wma', 'ram' => 'audio/x-pn-realaudio', 'rm' => 'audio/x-pn-realaudio', 'rpm' => 'audio/x-pn-realaudio-plugin', 'ra' => 'audio/x-realaudio', 'wav' => 'audio/x-wav', 'pdb' => 'chemical/x-pdb', 'xyz' => 'chemical/x-xyz', 'bmp' => 'image/bmp', 'gif' => 'image/gif', 'ief' => 'image/ief', 'jpe' => 'image/jpeg', 'jpeg' => 'image/jpeg', 'jpg' => 'image/jpeg', 'png' => 'image/png', 'tif' => 'image/tiff', 'tiff' => 'image/tiff', 'wbmp' => 'image/vnd.wap.wbmp', 'ras' => 'image/x-cmu-raster', 'pnm' => 'image/x-portable-anymap', 'pbm' => 'image/x-portable-bitmap', 'pgm' => 'image/x-portable-graymap', 'ppm' => 'image/x-portable-pixmap', 'rgb' => 'image/x-rgb', 'xbm' => 'image/x-xbitmap', 'xpm' => 'image/x-xpixmap', 'xwd' => 'image/x-xwindowdump', 'iges' => 'model/iges', 'igs' => 'model/iges', 'mesh' => 'model/mesh', 'msh' => 'model/mesh', 'silo' => 'model/mesh', 'vrml' => 'model/vrml', 'wrl' => 'model/vrml', 'ics' => 'text/calendar', 'ifb' => 'text/calendar', 'vcs' => 'text/calendar', 'vfb' => 'text/calendar', 'css' => 'text/css', 'csv' => 'text/csv', 'diff' => 'text/diff', 'patch' => 'text/diff', 'htm' => 'text/html', 'html' => 'text/html', 'shtml' => 'text/html', 'asc' => 'text/plain', 'log' => 'text/plain', 'po' => 'text/plain', 'txt' => 'text/plain', 'rtx' => 'text/richtext', 'rtf' => 'text/rtf', 'sgm' => 'text/sgml', 'sgml' => 'text/sgml', 'tsv' => 'text/tab-separated-values', 'wml' => 'text/vnd.wap.wml', 'wmls' => 'text/vnd.wap.wmlscript', 'etx' => 'text/x-setext', 'vcf' => 'text/x-vcard', 'xsl' => 'text/xml', 'mp4' => 'video/mp4', 'mpe' => 'video/mpeg', 'mpeg' => 'video/mpeg', 'mpg' => 'video/mpeg', 'mov' => 'video/quicktime', 'qt' => 'video/quicktime', 'mxu' => 'video/vnd.mpegurl', 'asf' => 'video/x-ms-asf', 'asx' => 'video/x-ms-asf', 'wm' => 'video/x-ms-wm', 'wmv' => 'video/x-ms-wmv', 'wmx' => 'video/x-ms-wmx', 'wvx' => 'video/x-ms-wvx', 'avi' => 'video/x-msvideo', 'movie' => 'video/x-sgi-movie', 'ice' => 'x-conference/x-cooltalk', ); /** * Set (or overwrite existing) parameters by passing an array of new parameters. * * @access public * @param array $params Array of parameters (key => val pairs). */ public function setParam($params) { $app =& App::getInstance(); if (isset($params) && is_array($params)) { // Enforce valid upload_path parameter. if (isset($params['upload_path'])) { // Source must be directory. if (!is_dir($params['upload_path'])) { $app->logMsg(sprintf('Attempting to auto-create upload directory: %s', $params['upload_path']), LOG_NOTICE, __FILE__, __LINE__); mkdir($params['upload_path'], isset($params['dest_dir_perms']) ? $params['dest_dir_perms'] : $this->getParam('dest_dir_perms'), true); if (is_dir($params['upload_path'])) { $app->logMsg(sprintf('Created upload directory: %s', $params['upload_path']), LOG_ERR, __FILE__, __LINE__); } else { $app->logMsg(sprintf('Upload directory not found: %s', $params['upload_path']), LOG_ERR, __FILE__, __LINE__); trigger_error(sprintf('Upload directory not found: %s', $params['upload_path']), E_USER_ERROR); } } // Source must be writable. if (!is_writable($params['upload_path'])) { $app->logMsg(sprintf('Upload directory not writable: %s', $params['upload_path']), LOG_ERR, __FILE__, __LINE__); trigger_error(sprintf('Upload directory not writable: %s', $params['upload_path']), E_USER_ERROR); } } // Merge new parameters with old overriding only those passed. $this->_params = array_merge($this->_params, $params); } else { $app->logMsg(sprintf('Parameters are not an array: %s', $params), LOG_ERR, __FILE__, __LINE__); } } /** * Return the value of a parameter, if it exists. * * @access public * @param string $param Which parameter to return. * @return mixed Configured parameter value. */ public function getParam($param) { $app =& App::getInstance(); if (array_key_exists($param, $this->_params)) { return $this->_params[$param]; } else { $app->logMsg(sprintf('Parameter is not set: %s', $param), LOG_DEBUG, __FILE__, __LINE__); return null; } } /** * Process uploaded files. Processes files existing within the specified $_FILES['form_name'] array. * It tests for errors, cleans the filename, optionally sets custom file names. It will process * multiple files automatically if the file form element is an array (). * * @access public * @param string $form_name The name of the form to process. * @param string $custom_file_name The new name of the file. An array of filenames in the case of multiple files. * @return mixed Returns FALSE if a major error occurred preventing any file uploads. * Returns an empty array if any minor errors occurred or no files were found. * Returns a multidimensional array of filenames, sizes and extensions, if one-or-more files succeeded uploading. * Note: this last option presents a problem in the case of when some files uploaded successfully, and some failed. * In this case it is necessary to check the Upload::anyErrors method to discover if any did fail. */ public function process($form_name, $custom_file_name=null) { $app =& App::getInstance(); // Ensure we have a upload directory. if (!$this->getParam('upload_path')) { $app->logMsg(sprintf('Upload directory not set before processing.'), LOG_ERR, __FILE__, __LINE__); $this->_raiseMsg(_("There was a problem with the file upload. Please try again later."), MSG_ERR, __FILE__, __LINE__); return false; } // Ensure the file form element specified actually exists. if (!isset($_FILES[$form_name])) { $app->logMsg(sprintf('Form element %s does not exist.', $form_name), LOG_ERR, __FILE__, __LINE__); $this->_raiseMsg(_("There was a problem with the file upload. Please try again later."), MSG_ERR, __FILE__, __LINE__); return false; } if (is_array($_FILES[$form_name]['name'])) { $files = $_FILES[$form_name]; } else { // Convert variables to single-cell array so it will loop. $files = array( 'name' => array($_FILES[$form_name]['name']), 'type' => array($_FILES[$form_name]['type']), 'tmp_name' => array($_FILES[$form_name]['tmp_name']), 'error' => array($_FILES[$form_name]['error']), 'size' => array($_FILES[$form_name]['size']), ); } // To keep this script running even if user tries to stop browser. ignore_user_abort(true); ini_set('max_execution_time', 300); ini_set('max_input_time', 300); $new_file_names = array(); $num = sizeof($files['name']); for ($i=0; $i<$num; $i++) { $file_path_name = ''; if ('' === trim($files['name'][$i])) { // User may not have attached a file. $app->logMsg(sprintf('Skipping file %s with empty name', $i), LOG_DEBUG, __FILE__, __LINE__); continue; } // Determine final file name. if ($num == 1) { // Single upload. if (isset($custom_file_name)) { if (is_array($custom_file_name) && sizeof($custom_file_name) == 1) { // Is an array, but just one value. Pull it out. $file_name = current($custom_file_name); $this->_raiseMsg(sprintf(_("The file %s has been renamed to %s."), $files['name'][$i], $file_name), MSG_NOTICE, __FILE__, __LINE__); $app->logMsg(sprintf('Using custom file name: %s', $file_name), LOG_DEBUG, __FILE__, __LINE__); } else if (!is_array($custom_file_name) && '' != $custom_file_name) { // Valid custom file name. $file_name = $custom_file_name; $this->_raiseMsg(sprintf(_("The file %s has been renamed to %s."), $files['name'][$i], $file_name), MSG_NOTICE, __FILE__, __LINE__); $app->logMsg(sprintf('Using custom file name: %s', $file_name), LOG_DEBUG, __FILE__, __LINE__); } else { // Invalid custom file name provided. Use uploaded file name. $file_name = $files['name'][$i]; $app->logMsg(sprintf('Custom filename invalid! Using uploaded file name: %s', $file_name), LOG_WARNING, __FILE__, __LINE__); } } else { // Normal case. Use uploaded file name. $file_name = $files['name'][$i]; $app->logMsg(sprintf('Using uploaded file name: %s', $file_name), LOG_DEBUG, __FILE__, __LINE__); } } else { // Multiple upload. Final file names must be array. if (isset($custom_file_name) && is_array($custom_file_name) && '' != $custom_file_name[$i]) { // Valid custom file name. $file_name = $custom_file_name[$i]; $this->_raiseMsg(sprintf(_("The file %s has been renamed to %s."), $files['name'][$i], $file_name), MSG_NOTICE, __FILE__, __LINE__); $app->logMsg(sprintf('Using custom file name: %s', $file_name), LOG_DEBUG, __FILE__, __LINE__); } else { // Invalid custom file name provided. Use uploaded file name. $file_name = $files['name'][$i]; $app->logMsg(sprintf('Using uploaded file name: %s', $file_name), LOG_DEBUG, __FILE__, __LINE__); } } // Check The php upload error messages. if (UPLOAD_ERR_INI_SIZE === $files['error'][$i]) { // Error code 1 $this->_raiseMsg(sprintf(_("The file %s failed uploading: it exceeds the maximum allowed upload file size of %s."), $file_name, ini_get('upload_max_filesize')), MSG_ERR, __FILE__, __LINE__); $app->logMsg(sprintf('The file %s failed uploading with PHP error UPLOAD_ERR_INI_SIZE (currently %s).', $file_name, ini_get('upload_max_filesize')), LOG_ERR, __FILE__, __LINE__); $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_ERR_INI_SIZE); continue; } if (UPLOAD_ERR_FORM_SIZE === $files['error'][$i]) { // Error code 2 $this->_raiseMsg(sprintf(_("The file %s failed uploading: it exceeds the maximum allowed upload file size of %s."), $file_name, $_POST['MAX_FILE_SIZE']), MSG_ERR, __FILE__, __LINE__); $app->logMsg(sprintf('The file %s failed uploading with PHP error UPLOAD_ERR_FORM_SIZE (currently %s).', $file_name, $_POST['MAX_FILE_SIZE']), LOG_ERR, __FILE__, __LINE__); $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_ERR_FORM_SIZE); continue; } if (UPLOAD_ERR_PARTIAL === $files['error'][$i]) { // Error code 3 $this->_raiseMsg(sprintf(_("The file %s failed uploading: it was only partially uploaded."), $file_name), MSG_ERR, __FILE__, __LINE__); $app->logMsg(sprintf('The file %s failed uploading with PHP error UPLOAD_ERR_PARTIAL.', $file_name), LOG_ERR, __FILE__, __LINE__); $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_ERR_PARTIAL); continue; } if (UPLOAD_ERR_NO_FILE === $files['error'][$i]) { // Error code 4 $this->_raiseMsg(sprintf(_("The file %s failed uploading: no file was uploaded."), $file_name), MSG_ERR, __FILE__, __LINE__); $app->logMsg(sprintf('The file %s failed uploading with PHP error UPLOAD_ERR_NO_FILE.', $file_name), LOG_ERR, __FILE__, __LINE__); $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_ERR_NO_FILE); continue; } if (UPLOAD_ERR_NO_TMP_DIR === $files['error'][$i]) { // Error code 6 $this->_raiseMsg(sprintf(_("The file %s failed uploading: temporary upload directory missing."), $file_name), MSG_ERR, __FILE__, __LINE__); $app->logMsg(sprintf('The file %s failed uploading with PHP error UPLOAD_ERR_NO_TMP_DIR.', $file_name), LOG_ERR, __FILE__, __LINE__); $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_ERR_NO_TMP_DIR); continue; } // Check to be sure it's an uploaded file. if (!is_uploaded_file($files['tmp_name'][$i])) { $this->_raiseMsg(sprintf(_("The file %s failed uploading."), $file_name), MSG_ERR, __FILE__, __LINE__); $app->logMsg(sprintf('The file %s failed is_uploaded_file.', $file_name), LOG_ERR, __FILE__, __LINE__); $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_USER_ERR_NOT_UPLOADED_FILE); continue; } // Check to be sure the file is not empty. if ($files['size'][$i] <= 0) { $this->_raiseMsg(sprintf(_("The file %s failed uploading: it contains zero bytes."), $file_name), MSG_ERR, __FILE__, __LINE__); $app->logMsg(sprintf('The uploaded file %s contains zero bytes.', $file_name), LOG_ERR, __FILE__, __LINE__); $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_USER_ERR_EMPTY_FILE); continue; } // Check to be sure the file has a valid file name extension. if (!in_array(mb_strtolower(self::getFilenameExtension($file_name)), $this->getParam('valid_file_extensions'))) { // TODO: Add option to allow any extension to be uploaded. $this->_raiseMsg(sprintf(_("The file %s failed uploading: it is an unrecognized type. Files must have one of the following file name extensions: %s."), $file_name, join(', ', $this->getParam('valid_file_extensions'))), MSG_ERR, __FILE__, __LINE__); $app->logMsg(sprintf('The uploaded file %s has an unrecognized file name extension.', $file_name), LOG_WARNING, __FILE__, __LINE__); $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_USER_ERR_INVALID_EXTENSION); continue; } // Check to be sure the file has a unique file name. if (!$this->getParam('allow_overwriting') && $this->exists($file_name)) { $this->_raiseMsg(sprintf(_("The file %s failed uploading: a file with that name already exists."), $file_name), MSG_ERR, __FILE__, __LINE__); $app->logMsg(sprintf('The uploaded file %s does not have a unique filename.', $file_name), LOG_WARNING, __FILE__, __LINE__); $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_USER_ERR_NOT_UNIQUE); continue; } // If the file name has no extension, use the mime-type to choose one. if (!preg_match('/\.[^.]{1,5}$/', $file_name) && function_exists('mime_content_type')) { // TODO: will this run if an extension is filtered by 'valid_file_extensions'? if ($ext = array_search(mime_content_type($files['tmp_name'][$i]), $this->mime_extension_map)) { $file_name .= ".$ext"; } } // Clean the file name of bad characters. $file_name = self::cleanFileName($file_name); // FINAL path and file name, lowercase extension. $file_extension = mb_strtolower(self::getFilenameExtension($file_name)); $file_name = sprintf('%s.%s', mb_substr($file_name, 0, mb_strrpos($file_name, '.')), $file_extension); $file_path_name = sprintf('%s/%s', $this->getParam('upload_path'), $file_name); // Move the file to the final place. if (move_uploaded_file($files['tmp_name'][$i], $file_path_name)) { chmod($file_path_name, $this->getParam('dest_file_perms')); $app->logMsg(sprintf('File uploaded: %s', $file_path_name), LOG_INFO, __FILE__, __LINE__); $this->_raiseMsg(sprintf(_("The file %s uploaded successfully."), $file_name), MSG_SUCCESS, __FILE__, __LINE__); if (!isset($custom_file_name) && $files['name'][$i] != $file_name) { // Notify user if uploaded file name was modified (unless a custom file name will be used anyways). $this->_raiseMsg(sprintf(_("The file %s was renamed to %s."), $files['name'][$i], $file_name), MSG_NOTICE, __FILE__, __LINE__); } $new_file_names[] = array( 'name' => $file_name, 'mime' => $files['type'][$i], 'size' => filesize($file_path_name), 'extension' => $file_extension, 'original_index' => $i, 'original_name' => $files['name'][$i], ); } else { $this->_raiseMsg(sprintf(_("The file %s failed uploading."), $file_name), MSG_ERR, __FILE__, __LINE__); $app->logMsg(sprintf('Moving file failed: %s -> %s', $files['tmp_name'][$i], $file_path_name), LOG_ALERT, __FILE__, __LINE__); $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_USER_ERR_MOVE_FAILED); } // Check file extension with browsers interpretation of file type. if (isset($this->mime_extension_map[$file_extension]) && $files['type'][$i] != $this->mime_extension_map[$file_extension]) { $app->logMsg(sprintf('File extension (%s) does not match mime type (%s).', $file_extension, $files['type'][$i]), LOG_DEBUG, __FILE__, __LINE__); } } // Return names of files uploaded (or empty array when none processed). return $new_file_names; } /** * Remove file within upload path. * * @access public * @param string $file_name A name of a file. * @param bool $use_glob Set true to use glob to find the filename (using $file_name as a pattern) * @return bool Success of operation. */ public function deleteFile($file_name, $use_glob=false) { $app =& App::getInstance(); // Ensure we have a upload directory. if (!$this->getParam('upload_path')) { $app->logMsg(sprintf('Upload directory not set before processing.'), LOG_ERR, __FILE__, __LINE__); return false; } $file_path_name = $this->getParam('upload_path') . '/' . ($use_glob ? $this->getFilenameGlob($file_name) : $file_name); if (!is_file($file_path_name)) { $app->logMsg(sprintf('Error deleting; not a file: %s', $file_path_name), LOG_ERR, __FILE__, __LINE__); return false; } else if (unlink($file_path_name)) { $app->logMsg(sprintf('Deleted file: %s', $file_path_name), LOG_INFO, __FILE__, __LINE__); return true; } else { $this->_raiseMsg(sprintf(_("The file %s could not be deleted."), $file_name), MSG_ERR, __FILE__, __LINE__); $app->logMsg(sprintf('Failed deleting file: %s', $file_path_name), LOG_ERR, __FILE__, __LINE__); return false; } } /** * Renames a file within the upload path. * * @access public * @param string $old_name The currently existing file name. * @param string $new_name The new name for this file. * @return bool Success of operation. */ public function moveFile($old_name, $new_name) { $app =& App::getInstance(); // Ensure we have an upload directory. if (!$this->getParam('upload_path')) { $app->logMsg(sprintf('Upload directory not set before processing.'), LOG_ERR, __FILE__, __LINE__); return false; } $old_file_path_name = $this->getParam('upload_path') . '/' . $old_name; $new_file_path_name = $this->getParam('upload_path') . '/' . $new_name; if (file_exists($old_file_path_name) && is_file($old_file_path_name)) { if (rename($old_file_path_name, $new_file_path_name)) { $this->_raiseMsg(sprintf(_("The file %s has been renamed to %s."), basename($old_file_path_name), basename($new_file_path_name)), MSG_NOTICE, __FILE__, __LINE__); $app->logMsg(sprintf('File renamed from %s to %s', $old_file_path_name, $new_file_path_name), LOG_DEBUG, __FILE__, __LINE__); } else { $this->_raiseMsg(sprintf(_("Error renaming file to %s"), $new_file_path_name), MSG_WARNING, __FILE__, __LINE__); $app->logMsg(sprintf('Error renaming file to %s', $new_file_path_name), LOG_WARNING, __FILE__, __LINE__); return false; } } else { $this->_raiseMsg(sprintf(_("Couldn't rename nonexistent file %s."), $old_name), MSG_WARNING, __FILE__, __LINE__); $app->logMsg(sprintf('Error renaming nonexistent file: %s', $old_file_path_name), LOG_WARNING, __FILE__, __LINE__); return false; } } /** * Tests if a file exists within the current upload_path. * * @access public * @param string $file_name A name of a file. * @return bool Existence of file. */ public function exists($file_name) { $app =& App::getInstance(); // Ensure we have a upload directory. if (!$this->getParam('upload_path')) { $app->logMsg(sprintf('Upload directory not set before processing.'), LOG_ERR, __FILE__, __LINE__); return false; } return file_exists($this->getParam('upload_path') . '/' . $file_name); } /** * Get filename by glob pattern. Searches a directory for an image that matches the * specified glob pattern and returns the filename of the first file found. * * @access public * @param string $pattern Pattern to match filename. * @return string filename on success, empty string on failure. * @author Quinn Comendant * @since 15 Nov 2005 20:55:22 */ public function getFilenameGlob($pattern) { $file_list = glob(sprintf('%s/%s', $this->getParam('upload_path'), $pattern)); if (isset($file_list[0])) { return basename($file_list[0]); } else { return ''; } } /** * Returns an array of file names that failed uploading. * * @access public * @return array List of file names. */ public function getErrors() { return $this->errors; } /** * Determines if any errors occurred while calling the Upload::process method. * * @access public */ public function anyErrors() { return sizeof($this->errors) > 0; } /** * Returns the extension of a file name, or an empty string if none exists. * * @access public * @param string $file_name A name of a file, with extension after a dot. * @return string The value found after the dot */ static public function getFilenameExtension($file_name) { preg_match('/.*?\.(\w+)$/i', trim($file_name), $ext); return isset($ext[1]) ? $ext[1] : ''; } /** * An alias for $app->raiseMsg that only sends messages configured by display_messages. * * @access public * * @param string $message The text description of the message. * @param int $type The type of message: MSG_NOTICE, * MSG_SUCCESS, MSG_WARNING, or MSG_ERR. * @param string $file __FILE__. * @param string $line __LINE__. */ public function _raiseMsg($message, $type, $file, $line) { $app =& App::getInstance(); if ($this->getParam('display_messages') === true || (is_int($this->getParam('display_messages')) && ($this->getParam('display_messages') & $type) > 0)) { $app->raiseMsg($message, $type, $file, $line); } } /** * Remove unsafe characters from filename. * While this function has been moved to Utilities.inc.php, it should remain here for backwards compatibility. * * @access public * @param string $file_name A name of a file. * @return string The same name, but cleaned. */ public function cleanFileName($file_name) { $app =& App::getInstance(); $file_name = preg_replace(array( '/&([a-z]{1,2})(?:acute|cedil|circ|grave|lig|orn|ring|slash|th|tilde|uml|caron);/i' . $app->getParam('preg_u'), '/&(?:amp);/i' . $app->getParam('preg_u'), '/[&;]+/' . $app->getParam('preg_u'), '/[^a-zA-Z0-9()@._=+-]+/' . $app->getParam('preg_u'), '/^_+|_+$/' . $app->getParam('preg_u') ), array( '$1', 'and', '', '_', '' ), htmlentities($file_name, ENT_NOQUOTES | ENT_IGNORE, $app->getParam('character_set'))); return mb_substr($file_name, 0, 250); } }