Rev 443 | Blame | Last modification | View Log | RSS feed
<?php/* vim: set expandtab tabstop=4 shiftwidth=4: */// +----------------------------------------------------------------------+// | PHP version 4.0 |// +----------------------------------------------------------------------+// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |// +----------------------------------------------------------------------+// | This source file is subject to version 2.0 of the PHP license, |// | that is bundled with this package in the file LICENSE, and is |// | available at through the world-wide-web at |// | http://www.php.net/license/2_02.txt. |// | If you did not receive a copy of the PHP license and are unable to |// | obtain it through the world-wide-web, please send a note to |// | license@php.net so we can mail you a copy immediately. |// +----------------------------------------------------------------------+// | Authors: Adam Daniel <adaniel1@eesus.jnj.com> |// | Bertrand Mansion <bmansion@mamasam.com> |// +----------------------------------------------------------------------+//// $Id: file.php,v 1.2 2005-09-20 17:01:22 ddelon Exp $require_once("HTML/QuickForm/input.php");// register file-related rulesif (class_exists('HTML_QuickForm')) {HTML_QuickForm::registerRule('uploadedfile', 'callback', '_ruleIsUploadedFile', 'HTML_QuickForm_file');HTML_QuickForm::registerRule('maxfilesize', 'callback', '_ruleCheckMaxFileSize', 'HTML_QuickForm_file');HTML_QuickForm::registerRule('mimetype', 'callback', '_ruleCheckMimeType', 'HTML_QuickForm_file');HTML_QuickForm::registerRule('filename', 'callback', '_ruleCheckFileName', 'HTML_QuickForm_file');}/*** HTML class for a file type element** @author Adam Daniel <adaniel1@eesus.jnj.com>* @author Bertrand Mansion <bmansion@mamasam.com>* @version 1.0* @since PHP4.04pl1* @access public*/class HTML_QuickForm_file extends HTML_QuickForm_input{// {{{ properties/*** Uploaded file data, from $_FILES* @var array*/var $_value = null;// }}}// {{{ constructor/*** Class constructor** @param string Input field name attribute* @param string Input field label* @param mixed (optional)Either a typical HTML attribute string* or an associative array* @since 1.0* @access public*/function HTML_QuickForm_file($elementName=null, $elementLabel=null, $attributes=null){HTML_QuickForm_input::HTML_QuickForm_input($elementName, $elementLabel, $attributes);$this->setType('file');} //end constructor// }}}// {{{ setSize()/*** Sets size of file element** @param int Size of file element* @since 1.0* @access public*/function setSize($size){$this->updateAttributes(array('size' => $size));} //end func setSize// }}}// {{{ getSize()/*** Returns size of file element** @since 1.0* @access public* @return int*/function getSize(){return $this->getAttribute('size');} //end func getSize// }}}// {{{ freeze()/*** Freeze the element so that only its value is returned** @access public* @return bool*/function freeze(){return false;} //end func freeze// }}}// {{{ setValue()/*** Sets value for file element.** Actually this does nothing. The function is defined here to override* HTML_Quickform_input's behaviour of setting the 'value' attribute. As* no sane user-agent uses <input type="file">'s value for anything* (because of security implications) we implement file's value as a* read-only property with a special meaning.** @param mixed Value for file element* @since 3.0* @access public*/function setValue($value){return null;} //end func setValue// }}}// {{{ getValue()/*** Returns information about the uploaded file** @since 3.0* @access public* @return array*/function getValue(){return $this->_value;} // end func getValue// }}}// {{{ onQuickFormEvent()/*** Called by HTML_QuickForm whenever form event is made on this element** @param string Name of event* @param mixed event arguments* @param object calling object* @since 1.0* @access public* @return bool*/function onQuickFormEvent($event, $arg, &$caller){switch ($event) {case 'updateValue':if ($caller->getAttribute('method') == 'get') {return PEAR::raiseError('Cannot add a file upload field to a GET method form');}$this->_value = $this->_findValue();$caller->updateAttributes(array('enctype' => 'multipart/form-data'));$caller->setMaxFileSize();break;case 'addElement':$this->onQuickFormEvent('createElement', $arg, $caller);return $this->onQuickFormEvent('updateValue', null, $caller);break;case 'createElement':$className = get_class($this);$this->$className($arg[0], $arg[1], $arg[2]);break;}return true;} // end func onQuickFormEvent// }}}// {{{ moveUploadedFile()/*** Moves an uploaded file into the destination** @param string Destination directory path* @param string New file name* @access public*/function moveUploadedFile($dest, $fileName = ''){if ($dest != '' && substr($dest, -1) != '/') {$dest .= '/';}$fileName = ($fileName != '') ? $fileName : basename($this->_value['name']);if (move_uploaded_file($this->_value['tmp_name'], $dest . $fileName)) {return true;} else {return false;}} // end func moveUploadedFile// }}}// {{{ isUploadedFile()/*** Checks if the element contains an uploaded file** @access public* @return bool true if file has been uploaded, false otherwise*/function isUploadedFile(){return $this->_ruleIsUploadedFile($this->_value);} // end func isUploadedFile// }}}// {{{ _ruleIsUploadedFile()/*** Checks if the given element contains an uploaded file** @param array Uploaded file info (from $_FILES)* @access private* @return bool true if file has been uploaded, false otherwise*/function _ruleIsUploadedFile($elementValue){if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||(!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')) {return is_uploaded_file($elementValue['tmp_name']);} else {return false;}} // end func _ruleIsUploadedFile// }}}// {{{ _ruleCheckMaxFileSize()/*** Checks that the file does not exceed the max file size** @param array Uploaded file info (from $_FILES)* @param int Max file size* @access private* @return bool true if filesize is lower than maxsize, false otherwise*/function _ruleCheckMaxFileSize($elementValue, $maxSize){if (!empty($elementValue['error']) &&(UPLOAD_ERR_FORM_SIZE == $elementValue['error'] || UPLOAD_ERR_INI_SIZE == $elementValue['error'])) {return false;}if (!HTML_QuickForm_file::_ruleIsUploadedFile($elementValue)) {return true;}return ($maxSize >= @filesize($elementValue['tmp_name']));} // end func _ruleCheckMaxFileSize// }}}// {{{ _ruleCheckMimeType()/*** Checks if the given element contains an uploaded file of the right mime type** @param array Uploaded file info (from $_FILES)* @param mixed Mime Type (can be an array of allowed types)* @access private* @return bool true if mimetype is correct, false otherwise*/function _ruleCheckMimeType($elementValue, $mimeType){if (!HTML_QuickForm_file::_ruleIsUploadedFile($elementValue)) {return true;}if (is_array($mimeType)) {return in_array($elementValue['type'], $mimeType);}return $elementValue['type'] == $mimeType;} // end func _ruleCheckMimeType// }}}// {{{ _ruleCheckFileName()/*** Checks if the given element contains an uploaded file of the filename regex** @param array Uploaded file info (from $_FILES)* @param string Regular expression* @access private* @return bool true if name matches regex, false otherwise*/function _ruleCheckFileName($elementValue, $regex){if (!HTML_QuickForm_file::_ruleIsUploadedFile($elementValue)) {return true;}return preg_match($regex, $elementValue['name']);} // end func _ruleCheckFileName// }}}// {{{ _findValue()/*** Tries to find the element value from the values array** Needs to be redefined here as $_FILES is populated differently from* other arrays when element name is of the form foo[bar]** @access private* @return mixed*/function _findValue(){if (empty($_FILES)) {return null;}$elementName = $this->getName();if (isset($_FILES[$elementName])) {return $_FILES[$elementName];} elseif (false !== ($pos = strpos($elementName, '['))) {$base = substr($elementName, 0, $pos);$idx = "['" . str_replace(array(']', '['), array('', "']['"), substr($elementName, $pos + 1, -1)) . "']";$props = array('name', 'type', 'size', 'tmp_name', 'error');$code = "if (!isset(\$_FILES['{$base}']['name']{$idx})) {\n" ." return null;\n" ."} else {\n" ." \$value = array();\n";foreach ($props as $prop) {$code .= " \$value['{$prop}'] = \$_FILES['{$base}']['{$prop}']{$idx};\n";}return eval($code . " return \$value;\n}\n");} else {return null;}}// }}}} // end class HTML_QuickForm_file?>