Subversion-Projekte lars-tiefland.prado

<?php

/**

 * TActiveFileUpload.php

 *

 * @author Bradley Booms <Bradley.Booms@nsighttel.com>

 * @author Christophe Boulain <Christophe.Boulain@gmail.com>

 * @version $Id: TActiveFileUpload.php 2592 2008-12-22 21:36:50Z carlgmathisen $

 */

/**

 * Load TActiveControlAdapter and TFileUpload.

 */

Prado::using('System.Web.UI.ActiveControls.TActiveControlAdapter');

Prado::using('System.Web.UI.WebControls.TFileUpload');

/**

 * TActiveFileUpload

 *

 * TActiveFileUpload displays a file upload field on a page. Upon postback,

 * the text entered into the field will be treated as the name of the file

 * that will be uploaded to the server. The property {@link getHasFile HasFile}

 * indicates whether the file upload is successful. If successful, the file

 * may be obtained by calling {@link saveAs} to save it at a specified place.

 * You can use {@link getFileName FileName}, {@link getFileType FileType},

 * {@link getFileSize FileSize} to get the original client-side file name,

 * the file mime type, and the file size information. If the upload is not

 * successful, {@link getErrorCode ErrorCode} contains the error code

 * describing the cause of failure.

 *

 * TActiveFileUpload raises {@link onFileUpload OnFileUpload} event if a file is uploaded

 * (whether it succeeds or not).

 *

 * TActiveFileUpload actually does a postback in a hidden IFrame, and then does a callback.

 * This callback then raises the {@link onFileUpload OnFileUpload} event. After the postback

 * a status icon is displayed; either a green checkmark if the upload is successful,

 * or a red x if there was an error.

 *

 * @author Bradley Booms <Bradley.Booms@nsighttel.com>

 * @author Christophe Boulain <Christophe.Boulain@gmail.com>

 *

 * @version $Id: TActiveFileUpload.php 2592 2008-12-22 21:36:50Z carlgmathisen $

 */

class TActiveFileUpload extends TFileUpload implements IActiveControl, ICallbackEventHandler, INamingContainer

{

	const SCRIPT_PATH = 'prado/activefileupload';

	/**

	 * @var THiddenField a flag to tell which component is doing the callback.

	 */

	private $_flag;

	/**

	 * @var TImage that spins to show that the file is being uploaded.

	 */

	private $_busy;

	/**

	 * @var TImage that shows a green check mark for completed upload.

	 */

	private $_success;

	/**

	 * @var TImage that shows a red X for incomplete upload.

	 */

	private $_error;

	/**

	 * @var TInlineFrame used to submit the data in an "asynchronous" fashion.

	 */

	private $_target;

	/**

	 * Creates a new callback control, sets the adapter to

	 * TActiveControlAdapter. If you override this class, be sure to set the

	 * adapter appropriately by, for example, by calling this constructor.

	 */

	public function __construct(){

		parent::__construct();

		$this->setAdapter(new TActiveControlAdapter($this));

	}

	/**

	 * @param string asset file in the self::SCRIPT_PATH directory.

	 * @return string asset file url.

	 */

	protected function getAssetUrl($file='')

	{

		$base = $this->getPage()->getClientScript()->getPradoScriptAssetUrl();

		return $base.'/'.self::SCRIPT_PATH.'/'.$file;

	}

	/**

	 * This method is invoked when a file is uploaded.

	 * If you override this method, be sure to call the parent implementation to ensure

	 * the invocation of the attached event handlers.

	 * @param TEventParameter event parameter to be passed to the event handlers

	 */

	public function onFileUpload($param){

		if ($this->_flag->getValue() && $this->getPage()->getIsPostBack()){

			// save the file so that it will persist past the end of this return.

			$localName = str_replace('\\', '/', tempnam(Prado::getPathOfNamespace($this->getTempPath()),''));

			parent::saveAs($localName);

			$filename=addslashes($this->getFileName());

			// return some javascript to display a completion status.

			echo <<<EOS

<script language="Javascript">

	Options = new Object();

	Options.clientID = '{$this->getClientID()}';

	Options.targetID = '{$this->_target->getUniqueID()}';

	Options.localName = '$localName';

	Options.fileName = '{$filename}';

	Options.fileSize = '{$this->getFileSize()}';

	Options.fileType = '{$this->getFileType()}';

	Options.errorCode = '{$this->getErrorCode()}';

	parent.Prado.WebUI.TActiveFileUpload.onFileUpload(Options);

</script>

EOS;

			exit();

		}

	}

	/**

	 * @return string the path where the uploaded file will be stored temporarily, in namespace format

	 * default "Application.runtime.*"

	 */

	public function getTempPath(){

		return $this->getViewState('TempPath', 'Application.runtime.*');

	}

	/**

	 * @param string the path where the uploaded file will be stored temporarily in namespace format

	 * default "Application.runtime.*"

	 */

	public function setTempPath($value){

		$this->setViewState('TempNamespace',$value,'Application.runtime.*');

	}

	/**

	 * @throws TInvalidDataValueException if the {@link getTempPath TempPath} is not writable.

	 */

	public function onInit($sender){

		parent::onInit($sender);

		if (!is_writable(Prado::getPathOfNamespace($this->getTempPath()))){

			throw new TInvalidDataValueException("activefileupload_temppath_invalid", $this->getTempPath());

		}

	}

	/**

	 * Raises <b>OnFileUpload</b> event.

	 *

	 * This method is required by {@link ICallbackEventHandler} interface.

	 * This method is mainly used by framework and control developers.

	 * @param TCallbackEventParameter the event parameter

	 */

 	public function raiseCallbackEvent($param){

 		$cp = $param->getCallbackParameter();

		if ($key = $cp->targetID == $this->_target->getUniqueID()){

			$_FILES[$key]['name'] = $cp->fileName;

			$_FILES[$key]['size'] = intval($cp->fileSize);

			$_FILES[$key]['type'] = $cp->fileType;

			$_FILES[$key]['error'] = intval($cp->errorCode);

			$_FILES[$key]['tmp_name'] = $cp->localName;

			$this->loadPostData($key, null);

			$this->raiseEvent('OnFileUpload', $this, $param);

		}

	}

	/**

	 * Publish the javascript

	 */

	public function onPreRender($param){

		parent::onPreRender($param);

		$this->getPage()->getClientScript()->registerPradoScript('effects');

		$this->getPage()->getClientScript()->registerPradoScript('activefileupload');

	}

	public function createChildControls(){

		$this->_flag = Prado::createComponent('THiddenField');

		$this->_flag->setID('Flag');

		$this->getControls()->add($this->_flag);

		$this->_busy = Prado::createComponent('TImage');

		$this->_busy->setID('Busy');

		$this->_busy->setImageUrl($this->getAssetUrl('ActiveFileUploadIndicator.gif'));

		$this->_busy->setStyle("display:none");

		$this->getControls()->add($this->_busy);

		$this->_success = Prado::createComponent('TImage');

		$this->_success->setID('Success');

		$this->_success->setImageUrl($this->getAssetUrl('ActiveFileUploadComplete.png'));

		$this->_success->setStyle("display:none");

		$this->getControls()->add($this->_success);

		$this->_error = Prado::createComponent('TImage');

		$this->_error->setID('Error');

		$this->_error->setImageUrl($this->getAssetUrl('ActiveFileUploadError.png'));

		$this->_error->setStyle("display:none");

		$this->getControls()->add($this->_error);

		$this->_target = Prado::createComponent('TInlineFrame');

		$this->_target->setID('Target');

		$this->_target->setFrameUrl($this->getAssetUrl('ActiveFileUploadBlank.html'));

		$this->_target->setStyle("width:0px; height:0px;");

		$this->_target->setShowBorder(false);

		$this->getControls()->add($this->_target);

	}

	/**

	 * Removes localfile on ending of the callback.

	 */

	public function onUnload($param){

		if ($this->getPage()->getIsCallback() &&

			$this->getHasFile() &&

			file_exists($this->getLocalName())){

				unlink($this->getLocalName());

		}

		parent::onUnload($param);

	}

	/**

	 * @return TBaseActiveCallbackControl standard callback control options.

	 */

	public function getActiveControl(){

		return $this->getAdapter()->getBaseActiveControl();

	}

	/**

	 * Adds ID attribute, and renders the javascript for active component.

	 * @param THtmlWriter the writer used for the rendering purpose

	 */

	public function addAttributesToRender($writer){

		parent::addAttributesToRender($writer);

		$writer->addAttribute('id',$this->getClientID());

		$this->getActiveControl()->registerCallbackClientScript($this->getClientClassName(),$this->getClientOptions());

	}

	/**

	 * @return string corresponding javascript class name for this control.

	 */

	protected function getClientClassName(){

		return 'Prado.WebUI.TActiveFileUpload';

	}

	/**

	 * Gets the client side options for this control.

	 * @return array (	inputID => input client ID,

	 * 					flagID => flag client ID,

	 * 					targetName => target unique ID,

	 * 					formID => form client ID,

	 * 					indicatorID => upload indicator client ID,

	 * 					completeID => complete client ID,

	 * 					errorID => error client ID)

	 */

	protected function getClientOptions(){

		$options['ID'] = $this->getClientID();

		$options['EventTarget'] = $this->getUniqueID();

		$options['inputID'] = $this->getClientID();

		$options['flagID'] = $this->_flag->getClientID();

		$options['targetID'] = $this->_target->getUniqueID();

		$options['formID'] = $this->getPage()->getForm()->getClientID();

		$options['indicatorID'] = $this->_busy->getClientID();

		$options['completeID'] = $this->_success->getClientID();

		$options['errorID'] = $this->_error->getClientID();

		return $options;

	}

	/**

	 * Saves the uploaded file.

	 * @param string the file name used to save the uploaded file

	 * @param boolean whether to delete the temporary file after saving.

	 * If true, you will not be able to save the uploaded file again.

	 * @return boolean true if the file saving is successful

	 */

	public function saveAs($fileName,$deleteTempFile=true){

		if (($this->getErrorCode()===UPLOAD_ERR_OK) && (file_exists($this->getLocalName()))){

			if ($deleteTempFile)

				return rename($this->getLocalName(),$fileName);

			else

				return copy($this->getLocalName(),$fileName);

		} else

			return false;

	}

	/**

	 * @return TImage the image displayed when an upload

	 * 		completes successfully.

	 */

	public function getSuccessImage(){

		$this->ensureChildControls();

		return $this->_success;

	}

	/**

	 * @return TImage the image displayed when an upload

	 * 		does not complete successfully.

	 */

	public function getErrorImage(){

		$this->ensureChildControls();

		return $this->_error;

	}

	/**

	 * @return TImage the image displayed when an upload

	 * 		is in progress.

	 */

	public function getBusyImage(){

		$this->ensureChildControls();

		return $this->_busy;

	}

}