source: trunk/lib/Upload.inc.php @ 121

Last change on this file since 121 was 121, checked in by scdev, 18 years ago

Q - Added "sc-" to all css class selectors; Finished reworking Upload and ImageThumb? (now with GD support!); More PHP 5 upgrades.
File size: 28.2 KB
Line 
1<?php
2/**
3 * Upload.inc.php
4 * Code by Strangecode :: www.strangecode.com :: This document contains copyrighted information
5 *
6 * The Upload class provides an interface to deal with http uploaded files.
7 *
8 * @author  Quinn Comendant <quinn@strangecode.com>
9 * @requires App.inc.php
10 * @version 1.4
11 */
12
13// Upload error types.
14define('UPLOAD_USER_ERR_EMPTY_FILE', 100);
15define('UPLOAD_USER_ERR_NOT_UPLOADED_FILE', 101);
16define('UPLOAD_USER_ERR_INVALID_EXTENSION', 102);
17define('UPLOAD_USER_ERR_NOT_UNIQUE', 103);
18define('UPLOAD_USER_ERR_MOVE_FAILED', 104);
19
20class Upload {
21
22    // General object parameters.
23    var $_params = array(
24
25        // Which messages do we pass to raiseMsg?
26        'display_messages' => MSG_ALL,
27
28        // Existing files will be overwritten when there is a name conflict?
29        'allow_overwriting' => false,
30
31        // The filesystem path to the final upload directory.
32        'upload_path' => null,
33
34        // The file permissions of the uploaded files. Remember, files will be owned by the web server user.
35        'dest_file_perms' => 0600,
36
37        // The file permissions of the uploaded files. Remember, files will be owned by the web server user.
38        'dest_dir_perms' => 0700,
39
40        // Require file to have one of the following file name extentions.
41        'valid_file_extensions' => array('jpg', 'jpeg', 'gif', 'png', 'pdf', 'txt', 'text', 'html', 'htm'),
42    );
43
44    // Array of files with errors.
45    var $errors = array();
46
47    // Array of file name extensions and corresponding mime-types.
48    var $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/mpeg', '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/mp4v-es', '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', );
49
50    /**
51     * Set (or overwrite existing) parameters by passing an array of new parameters.
52     *
53     * @access public
54     * @param  array    $params     Array of parameters (key => val pairs).
55     */
56    function setParam($params)
57    {
58        if (isset($params) && is_array($params)) {
59
60            // Enforce valid upload_path parameter.
61            if (isset($params['upload_path'])) {
62                $params['upload_path'] = realpath($params['upload_path']);
63                // Must be directory.
64                if (!is_dir($params['upload_path'])) {
65                    App::logMsg(sprintf('Attempting to auto-create upload directory: %s', $params['upload_path']), LOG_NOTICE, __FILE__, __LINE__);
66                    mkdir($params['upload_path'], $this->getParam('dest_dir_perms'));
67                    if (!is_dir($params['upload_path'])) {
68                        App::logMsg(sprintf('Upload directory invalid: %s', $params['upload_path']), LOG_ERR, __FILE__, __LINE__);
69                        trigger_error(sprintf('Upload directory invalid: %s', $params['upload_path']), E_USER_ERROR);
70                    }
71                }
72                // Must be writable.
73                if (!is_writable($params['upload_path'])) {
74                    App::logMsg(sprintf('Upload directory not writable: %s', $params['upload_path']), LOG_ERR, __FILE__, __LINE__);
75                    trigger_error(sprintf('Upload directory not writable: %s', $params['upload_path']), E_USER_ERROR);
76                }
77            }
78
79            // Merge new parameters with old overriding only those passed.
80            $this->_params = array_merge($this->_params, $params);
81        } else {
82            App::logMsg(sprintf('Parameters are not an array: %s', $params), LOG_ERR, __FILE__, __LINE__);
83        }
84    }
85
86    /**
87     * Return the value of a parameter, if it exists.
88     *
89     * @access public
90     * @param string $param        Which parameter to return.
91     * @return mixed               Configured parameter value.
92     */
93    function getParam($param)
94    {
95        if (isset($this->_params[$param])) {
96            return $this->_params[$param];
97        } else {
98            App::logMsg(sprintf('Parameter is not set: %s', $param), LOG_DEBUG, __FILE__, __LINE__);
99            return null;
100        }
101    }
102
103    /**
104     * Process uploaded files. Processes files existing within the specified $_FILES['form_name'] array.
105     * It tests for errors, cleans the filename, optionally sets custom file names. It will process
106     * multiple files automatically if the file form element is an array (<input type="file" name="myfiles[]" />).
107     *
108     * @access  public
109     * @param   string  $form_name          The name of the form to process.
110     * @param   string  $custom_file_name   The new name of the file. An array of filename in the case of multiple files.
111     * @return  mixed   Returns FALSE if a major error occured preventing any file uploads.
112     *                  Returns an empty array if any minor errors occured or no files were found.
113     *                  Returns a multidimentional array of filenames, sizes and extentions, if one-or-more files succeeded uploading.
114     *                  Note: this last option presents a problem in the case of when some files uploaded successfully, and some failed.
115     *                        In this case it is necessary to check the Upload::anyErrors method to discover if any did fail.
116     */
117    function process($form_name, $custom_file_name=null)
118    {
119        // Ensure we have a upload directory.
120        if (!$this->getParam('upload_path')) {
121            App::logMsg(sprintf('Upload directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
122            $this->_raiseMsg(_("There was a problem with the file upload. Please try again later."), MSG_ERR, __FILE__, __LINE__);
123            return false;
124        }
125
126        // Ensure the file form element specified actually exists.
127        if (!isset($_FILES[$form_name])) {
128            App::logMsg(sprintf(_("Form element %s does not exist."), $form_name), LOG_ERR, __FILE__, __LINE__);
129            $this->_raiseMsg(_("There was a problem with the file upload. Please try again later."), MSG_ERR, __FILE__, __LINE__);
130            return false;
131        }
132
133        if (is_array($_FILES[$form_name]['name'])) {
134            $files = $_FILES[$form_name];
135        } else {
136            // Convert variables to single-cell array so it will loop.
137            $files = array(
138                'name'      => array($_FILES[$form_name]['name']),
139                'type'      => array($_FILES[$form_name]['type']),
140                'tmp_name'  => array($_FILES[$form_name]['tmp_name']),
141                'error'     => array($_FILES[$form_name]['error']),
142                'size'      => array($_FILES[$form_name]['size']),
143            );
144        }
145
146        // To keep this script running even if user tries to stop browser.
147        ignore_user_abort(true);
148        ini_set('max_execution_time', 300);
149        ini_set('max_input_time', 300);
150
151        $new_file_names = array();
152
153        $num = sizeof($files['name']);
154        for ($i=0; $i<$num; $i++) {
155            $file_path_name = '';
156
157            if ('' == trim($files['name'][$i])) {
158                // User may not have attached a file.
159                continue;
160            }
161
162            // Determine final file name.
163            if ($num == 1) {
164                // Single upload.
165                if (isset($custom_file_name) && '' != $custom_file_name) {
166                    // Valid custom file name.
167                    $file_name = $custom_file_name;
168                    $this->_raiseMsg(sprintf(_("The file %s has been renamed to %s."), $files['name'][$i], $file_name), MSG_NOTICE, __FILE__, __LINE__);
169                    App::logMsg(sprintf('Using custom file name: %s', $file_name), LOG_DEBUG, __FILE__, __LINE__);
170                } else {
171                    // Invalid custom file name provided. Use uploaded file name.
172                    $file_name = $files['name'][$i];
173                    App::logMsg(sprintf('Using uploaded file name: %s', $file_name), LOG_DEBUG, __FILE__, __LINE__);
174                }
175            } else {
176                // Multiple upload. Final file names must be array.
177                if (isset($custom_file_name) && is_array($custom_file_name) && is_array($custom_file_name[$i]) && '' != $custom_file_name[$i]) {
178                    // Valid custom file name.
179                    $file_name = $custom_file_name[$i];
180                    $this->_raiseMsg(sprintf(_("The file %s has been renamed to %s."), $files['name'][$i], $file_name), MSG_NOTICE, __FILE__, __LINE__);
181                    App::logMsg(sprintf('Using custom file name: %s', $file_name), LOG_DEBUG, __FILE__, __LINE__);
182                } else {
183                    // Invalid custom file name provided. Use uploaded file name.
184                    $file_name = $files['name'][$i];
185                    App::logMsg(sprintf('Using uploaded file name: %s', $file_name), LOG_DEBUG, __FILE__, __LINE__);
186                }
187            }
188
189            // Check The php upload error messages.
190            if (UPLOAD_ERR_INI_SIZE === $files['error'][$i]) {
191                $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__);
192                App::logMsg(sprintf(_("The file %s failed uploading with PHP error %s UPLOAD_ERR_INI_SIZE (currently %s)."), $files['error'][$i], $file_name, ini_get('upload_max_filesize')), LOG_ERR, __FILE__, __LINE__);
193                $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_ERR_INI_SIZE);
194                continue;
195            }
196            if (UPLOAD_ERR_FORM_SIZE === $files['error'][$i]) {
197                $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__);
198                App::logMsg(sprintf(_("The file %s failed uploading with PHP error %s UPLOAD_ERR_FORM_SIZE (currently %s)."), $files['error'][$i], $file_name, $_POST['MAX_FILE_SIZE']), LOG_ERR, __FILE__, __LINE__);
199                $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_ERR_FORM_SIZE);
200                continue;
201            }
202            if (UPLOAD_ERR_PARTIAL === $files['error'][$i]) {
203                $this->_raiseMsg(sprintf(_("The file %s failed uploading: it was only partially uploaded."), $file_name), MSG_ERR, __FILE__, __LINE__);
204                App::logMsg(sprintf(_("The file %s failed uploading with PHP error %s UPLOAD_ERR_PARTIAL."), $files['error'][$i], $file_name), LOG_ERR, __FILE__, __LINE__);
205                $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_ERR_PARTIAL);
206                continue;
207            }
208            if (UPLOAD_ERR_NO_FILE === $files['error'][$i]) {
209                $this->_raiseMsg(sprintf(_("The file %s failed uploading: no file was uploaded."), $file_name), MSG_ERR, __FILE__, __LINE__);
210                App::logMsg(sprintf(_("The file %s failed uploading with PHP error %s UPLOAD_ERR_NO_FILE."), $files['error'][$i], $file_name), LOG_ERR, __FILE__, __LINE__);
211                $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_ERR_NO_FILE);
212                continue;
213            }
214            if (UPLOAD_ERR_NO_TMP_DIR === $files['error'][$i]) {
215                $this->_raiseMsg(sprintf(_("The file %s failed uploading: temporary upload directory missing."), $file_name), MSG_ERR, __FILE__, __LINE__);
216                App::logMsg(sprintf(_("The file %s failed uploading with PHP error %s UPLOAD_ERR_NO_TMP_DIR."), $files['error'][$i], $file_name), LOG_ERR, __FILE__, __LINE__);
217                $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_ERR_NO_TMP_DIR);
218                continue;
219            }
220
221            // Check to be sure it's an uploaded file.
222            if (!is_uploaded_file($files['tmp_name'][$i])) {
223                $this->_raiseMsg(sprintf(_("The file %s failed uploading."), $file_name), MSG_ERR, __FILE__, __LINE__);
224                App::logMsg(sprintf(_("The file %s failed is_uploaded_file."), $file_name), LOG_ERR, __FILE__, __LINE__);
225                $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_USER_ERR_NOT_UPLOADED_FILE);
226                continue;
227            }
228
229            // Check to be sure the file is not empty.
230            if ($files['size'][$i] <= 0) {
231                $this->_raiseMsg(sprintf(_("The file %s failed uploading: it contains zero bytes."), $file_name), MSG_ERR, __FILE__, __LINE__);
232                App::logMsg(sprintf(_("The uploaded file %s contains zero bytes."), $file_name), LOG_ERR, __FILE__, __LINE__);
233                $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_USER_ERR_EMPTY_FILE);
234                continue;
235            }
236
237            // Check to be sure the file has a valid file name extension.
238            if (!in_array(strtolower($this->getFilenameExtension($file_name)), $this->getParam('valid_file_extensions'))) {
239                $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__);
240                App::logMsg(sprintf(_("The uploaded file %s has an unrecognized file name extension."), $file_name), LOG_WARNING, __FILE__, __LINE__);
241                $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_USER_ERR_INVALID_EXTENSION);
242                continue;
243            }
244
245            // Check to be sure the file has a unique file name.
246            if (!$this->getParam('allow_overwriting') && $this->exists($file_name)) {
247                $this->_raiseMsg(sprintf(_("The file %s failed uploading: a file with that name already exists."), $file_name), MSG_ERR, __FILE__, __LINE__);
248                App::logMsg(sprintf(_("The uploaded file %s doesn't have a unique filename."), $file_name), LOG_WARNING, __FILE__, __LINE__);
249                $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_USER_ERR_NOT_UNIQUE);
250                continue;
251            }
252
253            // If the file name has no extension, use the mime-type to choose one.
254            if (!preg_match('/\.[^.]{1,5}$/', $file_name) && function_exists('mime_content_type')) {
255                if ($ext = array_search(mime_content_type($files['tmp_name'][$i]), $this->mime_extension_map)) {
256                    $file_name .= ".$ext";
257                }
258            }
259
260            // Clean the file name of bad characters.
261            $file_name = $this->cleanFileName($file_name);
262
263            // FINAL path and file name, lowercase extension.
264            $file_extension = strtolower($this->getFilenameExtension($file_name));
265            $file_name = sprintf('%s.%s', substr($file_name, 0, strrpos($file_name, '.')), $file_extension);
266            $file_path_name = sprintf('%s/%s', $this->getParam('upload_path'), $file_name);
267
268            // Move the file to the final place.
269            if (move_uploaded_file($files['tmp_name'][$i], $file_path_name)) {
270                chmod($file_path_name, $this->getParam('dest_file_perms'));
271                App::logMsg(sprintf('File uploaded: %s', $file_path_name), LOG_INFO, __FILE__, __LINE__);
272                $this->_raiseMsg(sprintf(_("The file %s uploaded successfully."), $file_name), MSG_SUCCESS, __FILE__, __LINE__);
273                if (!isset($custom_file_name) && $files['name'][$i] != $file_name) {
274                    // Notify user if uploaded file name was modified (unless a custom file name will be used anyways).
275                    $this->_raiseMsg(sprintf(_("The file %s was renamed to %s."), $files['name'][$i], $file_name), MSG_NOTICE, __FILE__, __LINE__);
276                }
277                $new_file_names[] = array(
278                    'name' => $file_name,
279                    'mime' => $files['type'][$i],
280                    'size' => filesize($file_path_name),
281                    'extension' => $file_extension,
282                    'original_index' => $i,
283                );
284            } else {
285                $this->_raiseMsg(sprintf(_("The file %s failed uploading."), $file_name), MSG_ERR, __FILE__, __LINE__);
286                App::logMsg(sprintf(_("Moving file failed: %s -> %s"), $files['tmp_name'][$i], $file_path_name), LOG_ALERT, __FILE__, __LINE__);
287                $this->errors[] = array('filename' => $file_name, 'errortype' => UPLOAD_USER_ERR_MOVE_FAILED);
288            }
289
290            // Check file extension with browsers interpretation of file type.
291            if (isset($this->mime_extension_map[$file_extension]) && $files['type'][$i] != $this->mime_extension_map[$file_extension]) {
292                App::logMsg(sprintf('File extension (%s) does not match mime type (%s).', $file_extension, $files['type'][$i]), LOG_NOTICE, __FILE__, __LINE__);
293            }
294        }
295
296        // Return names of files uploaded (or empty array when none processed).
297        return $new_file_names;
298    }
299
300    /**
301     * Remove file within upload path.
302     *
303     * @access  public
304     * @param   string  $file_name  A name of a file.
305     * @return  bool                Success of operation.
306     */
307    function deleteFile($file_name)
308    {
309        // Ensure we have a upload directory.
310        if (!$this->getParam('upload_path')) {
311            App::logMsg(sprintf('Upload directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
312            return false;
313        }
314
315        $file_path_name = $this->getParam('upload_path') . '/' . $file_name;
316
317        if (!is_file($file_path_name)) {
318            App::logMsg(sprintf(_("Error deleting nonexistent file: %s"), $file_path_name), LOG_ERR, __FILE__, __LINE__);
319            return false;
320        } else if (unlink($file_path_name)) {
321            App::logMsg(sprintf('Deleted file: %s', $file_path_name), LOG_INFO, __FILE__, __LINE__);
322        } else {
323            $this->_raiseMsg(sprintf(_("The file %s could not be deleted."), $file_name), MSG_ERR, __FILE__, __LINE__);
324            App::logMsg(sprintf(_("Failed deleting file: %s"), $file_path_name), LOG_ERR, __FILE__, __LINE__);
325            return false;
326        }
327    }
328
329    /**
330     * Renames a file within the upload path.
331     *
332     * @access  public
333     * @param   string  $old_name   The currently existing file name.
334     * @param   string  $new_name   The new name for this file.
335     * @return  bool                Success of operation.
336     */
337    function moveFile($old_name, $new_name)
338    {
339        // Ensure we have an upload directory.
340        if (!$this->getParam('upload_path')) {
341            App::logMsg(sprintf('Upload directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
342            return false;
343        }
344
345        $old_file_path_name = $this->getParam('upload_path') . '/' . $old_name;
346        $new_file_path_name = $this->getParam('upload_path') . '/' . $new_name;
347        if (file_exists($old_file_path_name)) {
348            if (rename($old_file_path_name, $new_file_path_name)) {
349                $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__);
350                App::logMsg(sprintf('File renamed from %s to %s', $old_file_path_name, $new_file_path_name), LOG_DEBUG, __FILE__, __LINE__);
351            } else {
352                $this->_raiseMsg(sprintf(_("Error renaming file to %s"), $new_file_path_name), MSG_WARNING, __FILE__, __LINE__);
353                App::logMsg(sprintf(_("Error renaming file to %s"), $new_file_path_name), LOG_WARNING, __FILE__, __LINE__);
354                return false;
355            }
356        } else {
357            $this->_raiseMsg(sprintf(_("Couldn't rename nonexistent file %s."), $old_name), MSG_WARNING, __FILE__, __LINE__);
358            App::logMsg(sprintf(_("Error renaming nonexistent file: %s"), $old_file_path_name), LOG_WARNING, __FILE__, __LINE__);
359            return false;
360        }
361    }
362
363    /**
364     * Tests if a file exists within the current upload_path.
365     *
366     * @access  public
367     * @param   string  $file_name  A name of a file.
368     * @return  bool                Existence of file.
369     */
370    function exists($file_name)
371    {
372        // Ensure we have a upload directory.
373        if (!$this->getParam('upload_path')) {
374            App::logMsg(sprintf('Upload directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
375            return false;
376        }
377
378        return file_exists($this->getParam('upload_path') . '/' . $file_name);
379    }
380
381    /**
382     * Get filename by glob pattern. Searches a directory for an image that matches the
383     * specified glob pattern and returns the filename of the first file found.
384     *
385     * @access  public
386     * @param   string  $pattern   Pattern to match filename.
387     * @return  string filename on success, empty string on failure.
388     * @author  Quinn Comendant <quinn@strangecode.com>
389     * @since   15 Nov 2005 20:55:22
390     */
391    function getFilenameGlob($pattern)
392    {
393        $file_list = glob(sprintf('%s/%s', $this->getParam('upload_path'), $pattern));
394        if (isset($file_list[0])) {
395            return basename($file_list[0]);
396        } else {
397            return '';
398        }
399    }
400
401    /**
402     * Returns an array of file names that failed uploading.
403     *
404     * @access  public
405     * @return  array   List of file names.
406     */
407    function getErrors()
408    {
409        return $this->errors;
410    }
411
412    /**
413     * Determintes if any errors occured while calling the Upload::process method.
414     *
415     * @access  public
416     */
417    function anyErrors()
418    {
419        return sizeof($this->errors) > 0;
420    }
421
422    /**
423     * Removes unsafe characters from file name.
424     *
425     * @access  public
426     * @param   string  $file_name  A name of a file.
427     * @return  string              The same name, but cleaned.
428     */
429    function cleanFileName($file_name)
430    {
431        $bad  = 'áéíóúàÚìòùÀëïöÌÁÉÍÓÚÀÈÌÒÙÄËÏÖÜâêîÎûÂÊÎÔÛñçÇ@';
432        $good = 'aeiouaeiouaeiouAEIOUAEIOUAEIOUaeiouAEIOUncCa';
433        $file_name = trim($file_name);
434        $file_name = strtr($file_name, $bad, $good);
435        $file_name = preg_replace('/[^-\w.,~_=+()]/i', '_', $file_name);
436        $file_name = substr($file_name, 0, 250);
437        return $file_name;
438    }
439
440
441    /**
442     * Returns the extention of a file name, or an empty string if non exists.
443     *
444     * @access  public
445     * @param   string  $file_name  A name of a file, with extention after a dot.
446     * @return  string              The value found after the dot
447     */
448    function getFilenameExtension($file_name)
449    {
450        preg_match('/.*?\.(\w+)$/i', trim($file_name), $ext);
451        return isset($ext[1]) ? $ext[1] : '';
452    }
453
454    /**
455     * An alias for App::raiseMsg that only sends messages configured by display_messages.
456     *
457     * @access public
458     *
459     * @param string $message The text description of the message.
460     * @param int    $type    The type of message: MSG_NOTICE,
461     *                        MSG_SUCCESS, MSG_WARNING, or MSG_ERR.
462     * @param string $file    __FILE__.
463     * @param string $line    __LINE__.
464     */
465    function _raiseMsg($message, $type, $file, $line)
466    {
467        if ($this->getParam('display_messages') === true || (is_int($this->getParam('display_messages')) && $this->getParam('display_messages') & $type > 0)) {
468            App::raiseMsg($message, $type, $file, $line);
469        }
470    }
471}
472
473?>
Note: See TracBrowser for help on using the repository browser.