web/Zend/File/Transfer/Adapter/Http.php
changeset 0 4eba9c11703f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/web/Zend/File/Transfer/Adapter/Http.php	Mon Dec 13 18:29:26 2010 +0100
@@ -0,0 +1,483 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@zend.com so we can send you a copy immediately.
+ *
+ * @category  Zend
+ * @package   Zend_File_Transfer
+ * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd     New BSD License
+ * @version   $Id: Http.php 22563 2010-07-15 20:42:04Z thomas $
+ */
+
+/**
+ * @see Zend_File_Transfer_Adapter_Abstract
+ */
+require_once 'Zend/File/Transfer/Adapter/Abstract.php';
+
+/**
+ * File transfer adapter class for the HTTP protocol
+ *
+ * @category  Zend
+ * @package   Zend_File_Transfer
+ * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd     New BSD License
+ */
+class Zend_File_Transfer_Adapter_Http extends Zend_File_Transfer_Adapter_Abstract
+{
+    protected static $_callbackApc            = 'apc_fetch';
+    protected static $_callbackUploadProgress = 'uploadprogress_get_info';
+
+    /**
+     * Constructor for Http File Transfers
+     *
+     * @param array $options OPTIONAL Options to set
+     */
+    public function __construct($options = array())
+    {
+        if (ini_get('file_uploads') == false) {
+            require_once 'Zend/File/Transfer/Exception.php';
+            throw new Zend_File_Transfer_Exception('File uploads are not allowed in your php config!');
+        }
+
+        $this->setOptions($options);
+        $this->_prepareFiles();
+        $this->addValidator('Upload', false, $this->_files);
+    }
+
+    /**
+     * Sets a validator for the class, erasing all previous set
+     *
+     * @param  string|array $validator Validator to set
+     * @param  string|array $files     Files to limit this validator to
+     * @return Zend_File_Transfer_Adapter
+     */
+    public function setValidators(array $validators, $files = null)
+    {
+        $this->clearValidators();
+        return $this->addValidators($validators, $files);
+    }
+
+    /**
+     * Remove an individual validator
+     *
+     * @param  string $name
+     * @return Zend_File_Transfer_Adapter_Abstract
+     */
+    public function removeValidator($name)
+    {
+        if ($name == 'Upload') {
+            return $this;
+        }
+
+        return parent::removeValidator($name);
+    }
+
+    /**
+     * Remove an individual validator
+     *
+     * @param  string $name
+     * @return Zend_File_Transfer_Adapter_Abstract
+     */
+    public function clearValidators()
+    {
+        parent::clearValidators();
+        $this->addValidator('Upload', false, $this->_files);
+
+        return $this;
+    }
+
+    /**
+     * Send the file to the client (Download)
+     *
+     * @param  string|array $options Options for the file(s) to send
+     * @return void
+     * @throws Zend_File_Transfer_Exception Not implemented
+     */
+    public function send($options = null)
+    {
+        require_once 'Zend/File/Transfer/Exception.php';
+        throw new Zend_File_Transfer_Exception('Method not implemented');
+    }
+
+    /**
+     * Checks if the files are valid
+     *
+     * @param  string|array $files (Optional) Files to check
+     * @return boolean True if all checks are valid
+     */
+    public function isValid($files = null)
+    {
+        // Workaround for WebServer not conforming HTTP and omitting CONTENT_LENGTH
+        $content = 0;
+        if (isset($_SERVER['CONTENT_LENGTH'])) {
+            $content = $_SERVER['CONTENT_LENGTH'];
+        } else if (!empty($_POST)) {
+            $content = serialize($_POST);
+        }
+
+        // Workaround for a PHP error returning empty $_FILES when form data exceeds php settings
+        if (empty($this->_files) && ($content > 0)) {
+            if (is_array($files)) {
+                $files = current($files);
+            }
+
+            $temp = array($files => array(
+                'name'  => $files,
+                'error' => 1));
+            $validator = $this->_validators['Zend_Validate_File_Upload'];
+            $validator->setFiles($temp)
+                      ->isValid($files, null);
+            $this->_messages += $validator->getMessages();
+            return false;
+        }
+
+        return parent::isValid($files);
+    }
+
+    /**
+     * Receive the file from the client (Upload)
+     *
+     * @param  string|array $files (Optional) Files to receive
+     * @return bool
+     */
+    public function receive($files = null)
+    {
+        if (!$this->isValid($files)) {
+            return false;
+        }
+
+        $check = $this->_getFiles($files);
+        foreach ($check as $file => $content) {
+            if (!$content['received']) {
+                $directory   = '';
+                $destination = $this->getDestination($file);
+                if ($destination !== null) {
+                    $directory = $destination . DIRECTORY_SEPARATOR;
+                }
+
+                $filename = $directory . $content['name'];
+                $rename   = $this->getFilter('Rename');
+                if ($rename !== null) {
+                    $tmp = $rename->getNewName($content['tmp_name']);
+                    if ($tmp != $content['tmp_name']) {
+                        $filename = $tmp;
+                    }
+
+                    if (dirname($filename) == '.') {
+                        $filename = $directory . $filename;
+                    }
+
+                    $key = array_search(get_class($rename), $this->_files[$file]['filters']);
+                    unset($this->_files[$file]['filters'][$key]);
+                }
+
+                // Should never return false when it's tested by the upload validator
+                if (!move_uploaded_file($content['tmp_name'], $filename)) {
+                    if ($content['options']['ignoreNoFile']) {
+                        $this->_files[$file]['received'] = true;
+                        $this->_files[$file]['filtered'] = true;
+                        continue;
+                    }
+
+                    $this->_files[$file]['received'] = false;
+                    return false;
+                }
+
+                if ($rename !== null) {
+                    $this->_files[$file]['destination'] = dirname($filename);
+                    $this->_files[$file]['name']        = basename($filename);
+                }
+
+                $this->_files[$file]['tmp_name'] = $filename;
+                $this->_files[$file]['received'] = true;
+            }
+
+            if (!$content['filtered']) {
+                if (!$this->_filter($file)) {
+                    $this->_files[$file]['filtered'] = false;
+                    return false;
+                }
+
+                $this->_files[$file]['filtered'] = true;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Checks if the file was already sent
+     *
+     * @param  string|array $file Files to check
+     * @return bool
+     * @throws Zend_File_Transfer_Exception Not implemented
+     */
+    public function isSent($files = null)
+    {
+        require_once 'Zend/File/Transfer/Exception.php';
+        throw new Zend_File_Transfer_Exception('Method not implemented');
+    }
+
+    /**
+     * Checks if the file was already received
+     *
+     * @param  string|array $files (Optional) Files to check
+     * @return bool
+     */
+    public function isReceived($files = null)
+    {
+        $files = $this->_getFiles($files, false, true);
+        if (empty($files)) {
+            return false;
+        }
+
+        foreach ($files as $content) {
+            if ($content['received'] !== true) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Checks if the file was already filtered
+     *
+     * @param  string|array $files (Optional) Files to check
+     * @return bool
+     */
+    public function isFiltered($files = null)
+    {
+        $files = $this->_getFiles($files, false, true);
+        if (empty($files)) {
+            return false;
+        }
+
+        foreach ($files as $content) {
+            if ($content['filtered'] !== true) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Has a file been uploaded ?
+     *
+     * @param  array|string|null $file
+     * @return bool
+     */
+    public function isUploaded($files = null)
+    {
+        $files = $this->_getFiles($files, false, true);
+        if (empty($files)) {
+            return false;
+        }
+
+        foreach ($files as $file) {
+            if (empty($file['name'])) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Returns the actual progress of file up-/downloads
+     *
+     * @param  string $id The upload to get the progress for
+     * @return array|null
+     */
+    public static function getProgress($id = null)
+    {
+        if (!function_exists('apc_fetch') and !function_exists('uploadprogress_get_info')) {
+            require_once 'Zend/File/Transfer/Exception.php';
+            throw new Zend_File_Transfer_Exception('Neither APC nor uploadprogress extension installed');
+        }
+
+        $session = 'Zend_File_Transfer_Adapter_Http_ProgressBar';
+        $status  = array(
+            'total'    => 0,
+            'current'  => 0,
+            'rate'     => 0,
+            'message'  => '',
+            'done'     => false
+        );
+
+        if (is_array($id)) {
+            if (isset($id['progress'])) {
+                $adapter = $id['progress'];
+            }
+
+            if (isset($id['session'])) {
+                $session = $id['session'];
+            }
+
+            if (isset($id['id'])) {
+                $id = $id['id'];
+            } else {
+                unset($id);
+            }
+        }
+
+        if (!empty($id) && (($id instanceof Zend_ProgressBar_Adapter) || ($id instanceof Zend_ProgressBar))) {
+            $adapter = $id;
+            unset($id);
+        }
+
+        if (empty($id)) {
+            if (!isset($_GET['progress_key'])) {
+                $status['message'] = 'No upload in progress';
+                $status['done']    = true;
+            } else {
+                $id = $_GET['progress_key'];
+            }
+        }
+
+        if (!empty($id)) {
+            if (self::isApcAvailable()) {
+
+                $call = call_user_func(self::$_callbackApc, ini_get('apc.rfc1867_prefix') . $id);
+                if (is_array($call)) {
+                    $status = $call + $status;
+                }
+            } else if (self::isUploadProgressAvailable()) {
+                $call = call_user_func(self::$_callbackUploadProgress, $id);
+                if (is_array($call)) {
+                    $status = $call + $status;
+                    $status['total']   = $status['bytes_total'];
+                    $status['current'] = $status['bytes_uploaded'];
+                    $status['rate']    = $status['speed_average'];
+                    if ($status['total'] == $status['current']) {
+                        $status['done'] = true;
+                    }
+                }
+            }
+
+            if (!is_array($call)) {
+                $status['done']    = true;
+                $status['message'] = 'Failure while retrieving the upload progress';
+            } else if (!empty($status['cancel_upload'])) {
+                $status['done']    = true;
+                $status['message'] = 'The upload has been canceled';
+            } else {
+                $status['message'] = self::_toByteString($status['current']) . " - " . self::_toByteString($status['total']);
+            }
+
+            $status['id'] = $id;
+        }
+
+        if (isset($adapter) && isset($status['id'])) {
+            if ($adapter instanceof Zend_ProgressBar_Adapter) {
+                require_once 'Zend/ProgressBar.php';
+                $adapter = new Zend_ProgressBar($adapter, 0, $status['total'], $session);
+            }
+
+            if (!($adapter instanceof Zend_ProgressBar)) {
+                require_once 'Zend/File/Transfer/Exception.php';
+                throw new Zend_File_Transfer_Exception('Unknown Adapter given');
+            }
+
+            if ($status['done']) {
+                $adapter->finish();
+            } else {
+                $adapter->update($status['current'], $status['message']);
+            }
+
+            $status['progress'] = $adapter;
+        }
+
+        return $status;
+    }
+
+    /**
+     * Checks the APC extension for progress information
+     *
+     * @return boolean
+     */
+    public static function isApcAvailable()
+    {
+        return (bool) ini_get('apc.enabled') && (bool) ini_get('apc.rfc1867') && is_callable(self::$_callbackApc);
+    }
+
+    /**
+     * Checks the UploadProgress extension for progress information
+     *
+     * @return boolean
+     */
+    public static function isUploadProgressAvailable()
+    {
+        return is_callable(self::$_callbackUploadProgress);
+    }
+
+    /**
+     * Prepare the $_FILES array to match the internal syntax of one file per entry
+     *
+     * @param  array $files
+     * @return array
+     */
+    protected function _prepareFiles()
+    {
+        $this->_files = array();
+        foreach ($_FILES as $form => $content) {
+            if (is_array($content['name'])) {
+                foreach ($content as $param => $file) {
+                    foreach ($file as $number => $target) {
+                        $this->_files[$form . '_' . $number . '_'][$param]      = $target;
+                        $this->_files[$form]['multifiles'][$number] = $form . '_' . $number . '_';
+                    }
+                }
+
+                $this->_files[$form]['name'] = $form;
+                foreach($this->_files[$form]['multifiles'] as $key => $value) {
+                    $this->_files[$value]['options']   = $this->_options;
+                    $this->_files[$value]['validated'] = false;
+                    $this->_files[$value]['received']  = false;
+                    $this->_files[$value]['filtered']  = false;
+
+                    $mimetype = $this->_detectMimeType($this->_files[$value]);
+                    $this->_files[$value]['type'] = $mimetype;
+
+                    $filesize = $this->_detectFileSize($this->_files[$value]);
+                    $this->_files[$value]['size'] = $filesize;
+
+                    if ($this->_options['detectInfos']) {
+                        $_FILES[$form]['type'][$key] = $mimetype;
+                        $_FILES[$form]['size'][$key] = $filesize;
+                    }
+                }
+            } else {
+                $this->_files[$form]              = $content;
+                $this->_files[$form]['options']   = $this->_options;
+                $this->_files[$form]['validated'] = false;
+                $this->_files[$form]['received']  = false;
+                $this->_files[$form]['filtered']  = false;
+
+                $mimetype = $this->_detectMimeType($this->_files[$form]);
+                $this->_files[$form]['type'] = $mimetype;
+
+                $filesize = $this->_detectFileSize($this->_files[$form]);
+                $this->_files[$form]['size'] = $filesize;
+
+                if ($this->_options['detectInfos']) {
+                    $_FILES[$form]['type'] = $mimetype;
+                    $_FILES[$form]['size'] = $filesize;
+                }
+            }
+        }
+
+        return $this;
+    }
+}