File controllers/components/be_upload_to_obj.php | BEdita API doc

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213

<?php
/*-----8<--------------------------------------------------------------------
 * 
 * BEdita - a semantic content management framework
 * 
 * Copyright 2008 ChannelWeb Srl, Chialab Srl
 * 
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published 
 * by the Free Software Foundation, either version 3 of the License, or 
 * (at your option) any later version.
 * BEdita is distributed WITHOUT ANY WARRANTY; without even the implied 
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License 
 * version 3 along with BEdita (see LICENSE.LGPL).
 * If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
 * 
 *------------------------------------------------------------------->8-----
 */

/**
 * Upload component: common file, multimedia file, third party multimedia url (vimeo, youtube, etc.)
 *
 */
class BeUploadToObjComponent extends Object {
    var $components = array('BeFileHandler', 'BeVimeo', 'BeYoutube') ;

    function startup(&$controller) {
        $this->params = &$controller->params;
        $this->BeFileHandler->startup($controller) ;
    }

    /**
     * Uploads a file to location and create stream object.
     * 
     * @param array $dataStream
     * @param string $formFileName
     * @return mixed int|boolean, object_id if upload was successful, false otherwise.
     */
    public function upload($dataStream=null, $formFileName="Filedata") {
        $result = false ;
        if (empty($this->params["form"][$formFileName]["name"])) {
            throw new BEditaException(__("No file in the form", true));
        }
        if ($this->params['form'][$formFileName]['error']) {
            throw new BEditaUploadPHPException($this->params['form'][$formFileName]['error']);
        }
        // Prepare data
        if (!empty($dataStream)) {
            $data = array_merge($dataStream, $this->params['form'][$formFileName]);
        } else {
            $data = $this->params['form'][$formFileName];
        }
        $data['original_name'] = $data['name'];
        $data['name'] = $this->BeFileHandler->buildNameFromFile($data['name']);
        $data['mime_type'] = $this->BeFileHandler->getMimeType($data);
        unset($data['type']);
        $data['file_size'] = $this->params['form'][$formFileName]['size'];
        unset($data['size']);
        
        if (!empty($this->params['form']['mediatype'])) {
            $data['mediatype'] = $this->params['form']['mediatype'];
        }
        
        $forceupload = (isset($this->params['form']['forceupload'])) ? ((boolean)$this->params['form']['forceupload']) : false ;

        if (empty($data['title']))
            $data['title'] = $data['original_name'];

        $data['uri']    = $data['tmp_name'] ;

        if (empty($data["status"]))
            $data["status"] = "on";

        unset($data['tmp_name']) ;
        unset($data['error']) ;

        $result = $this->BeFileHandler->save($data, $forceupload) ;
        
        return $result;
    }

    /**
     * Create obj stream from URL. Form must have: url, title, lang.
     * 
     * @param string $dataURL
     * @param boolean $clone
     * @return mixed boolean|int, false if upload was unsuccessful, int $id otherwise
     * @throws BEditaMediaProviderException
     */
    public function uploadFromURL($dataURL, $clone=false) {
        $result = false ;
        $getInfoURL = false;
        $mediaProvider = ClassRegistry::init("Stream")->getMediaProvider($dataURL['url']);
        if(empty($dataURL['title'])) {
            $link = ClassRegistry::init("Link");
            $dataURL['title'] = $link->readHtmlTitle($dataURL['url']);
        }
        if (!empty($mediaProvider)) {
            $dataURL['provider'] = $mediaProvider["provider"];
            $dataURL['video_uid'] = $mediaProvider["video_uid"];
            $dataURL['uri'] = $mediaProvider["uri"];
            $componentName = Inflector::camelize("be_" . $mediaProvider["provider"]);
            if (isset($this->{$componentName}) && method_exists($this->{$componentName}, "setInfoToSave")) {
                if (!$this->{$componentName}->setInfoToSave($dataURL)) {
                    throw new BEditaMediaProviderException(__("Multimedia Provider not found or error preparing data to save",true)) ;
                }
            } else {
                throw new BEditaMediaProviderException(__("Multimedia provider is not managed",true)) ;
            }
        } else {
            $dataURL['provider'] = null;
            $dataURL['video_uid'] = null;
            $dataURL['uri'] = $dataURL["url"];
            $getInfoURL = true;
        }
        if (empty($dataURL["status"])) {
            $dataURL['status'] = "on";
        }
        if (!empty($this->params['form']['mediatype'])) {
            $dataURL['mediatype'] = $this->params['form']['mediatype'];
        }

        $dataURL['hash_file'] = null;
        $dataURL['original_name'] = null;

        unset($dataURL["url"]);
        $id = $this->BeFileHandler->save($dataURL, $clone, $getInfoURL) ;
        return $id;
    }

    /**
     * Clone data for media
     * This method is not intended to upload file!
     *
     * Its purpose is to clone $data into another multimedia object (or in the same if $cloneOnlyFile = true)
     * If $cloneOnlyFile = true file data and file on filesystem will be cloned and $data will be saved on the same multimedia object
     *
     * If $data['uri'] is filled and it's not an url
     * the original file located in Configure::read("mediaRoot") . $data["uri"] will be duplicate with different name and attached to cloned object
     *
     * @param array $data
     * @param bool $cloneOnlyFile, true to clone only file (no new multimedia object will be created if $data['id'] is populated)
     * @return mixed boolean|int, false if cloning was unsuccessful, int $id otherwise
     */
    public function cloneMediaObject(&$data, $cloneOnlyFile = false) {
        if (!$cloneOnlyFile) {
            if (!empty($data["id"])) {
                unset($data["id"]);
            }
            if (!empty($data["nickname"])) {
                unset($data["nickname"]);
            }
        }
        if (preg_match(Configure::read("validate_resource.URL"), $data["uri"])) {
            $data["url"] = $data["uri"];
            return $this->uploadFromURL($data, true);
        } else {
            if (!empty($data['uri'])) {
                $data['uri'] = Configure::read("mediaRoot") . $data["uri"];
                if (empty($data["file_size"])) {
                    $data["file_size"] = filesize($data["uri"]);
                }
            }
            if (!empty($this->params['form']['mediatype'])) {
                $data['mediatype'] = $this->params['form']['mediatype'];
            }
            if (!empty($data['original_name'])) {
                $data['name'] = $this->BeFileHandler->buildNameFromFile($data['original_name']);
            }
            return $this->BeFileHandler->save($data, true);
        }
    }

    /**
     * Get thumbnail for media
     * 
     * @param array $data
     * @return array
     * @throws BEditaMediaProviderException
     */
    public function getThumbnail($data) {
        if (!empty($data["thumbnail"]) && preg_match(Configure::read("validate_resource.URL"), $data["thumbnail"])) {
            $thumbnail = $data["thumbnail"];    
        } else {
            if (empty($data["provider"]) || empty($data["video_uid"])) {
                $url = (!empty($data['url']))? $data['url'] : $data['uri'];
                $mediaProvider = ClassRegistry::init("Stream")->getMediaProvider($data['url']);
                if (!empty($mediaProvider)) {
                    $provider = $mediaProvider["provider"];
                    $uid = $mediaProvider["video_uid"];
                }
            } else {
                $provider = $data["provider"];
                $uid = $data["video_uid"];
            }
            $thumbnail = null;
            if (!empty($provider)) {
                $componentName = Inflector::camelize("be_" . $provider);
                if (isset($this->{$componentName}) && method_exists($this->{$componentName}, "getThumbnail")) {
                    if (!$thumbnail = $this->{$componentName}->getThumbnail($uid)) {
                        throw new BEditaMediaProviderException(__("Multimedia Provider not found or error getting thumbnail",true)) ;
                    }
                } else {
                    throw new BEditaMediaProviderException(__("Multimedia provider is not managed",true)) ;
                }
            }
        }
        return $thumbnail;
    }
}
?>

Classes

Interfaces

Exceptions