YiiDropbox.php

<?php
/**
 * Yii Extension provide Dropbox API
 *
 * @author Alexey Salnikov <http://iamsalnikov.ru/>
 * @author Joe Constant <http://joeconstant.me/>
 */
class YiiDropbox extends CApplicationComponent {

    public $appKey;
    public $appSecret;
    public $root;
    public $chunkSize = 4194304;

    const URL_REQUEST_TOKEN = 'https://api.dropbox.com/1/oauth/request_token';
    const URL_ACCESS_TOKEN =  'https://api.dropbox.com/1/oauth/access_token';
    const URL_AUTHORIZE = 'https://www.dropbox.com/1/oauth/authorize';
    const URL_API = 'https://api.dropbox.com/1/';
    const API_CONTENT_URL = 'https://api-content.dropbox.com/1/';
    const CONTENT_URL = 'https://api-content.dropbox.com/1/';

    /**
     * @var OAuth $_oauth
     */
    protected $_oauth;

    protected $_oauthToken;
    protected $_oauthTokenSecret;

    protected $_errorCode;
    protected $_errorMessage;

    public function init() {
        $this->_oauth = new OAuth($this->appKey, $this->appSecret, OAUTH_SIG_METHOD_HMACSHA1, OAUTH_AUTH_TYPE_URI);
        $this->_oauth->enableDebug();
    }

    public function getErrorCode() {
        return $this->_errorCode;
    }

    public function getErrorMessage() {
        return $this->_errorMessage;
    }

    public function getRequestToken() {
        $tokens = $this->_oauth->getRequestToken(self::URL_REQUEST_TOKEN);
        $this->setToken($tokens);
        return $tokens;
    }

    public function setToken($oauthTokenSecret, $oauthToken = false) {
        if ($oauthToken) {
            $this->_oauthToken = $oauthToken;
            $this->_oauthTokenSecret = $oauthTokenSecret;
        }
        else {
            $this->_oauthToken = $oauthTokenSecret['oauth_token'];
            $this->_oauthTokenSecret = $oauthTokenSecret['oauth_token_secret'];
        }
        $this->_oauth->setToken($this->_oauthToken, $this->_oauthTokenSecret);
    }

    public function getAccessToken() {

        $tokens = $this->_oauth->getAccessToken(self::URL_ACCESS_TOKEN);
        $this->setToken($tokens);
        return $tokens;

    }

    public function getAuthorizeLink($callBack = false) {
        $uri = self::URL_AUTHORIZE . '?oauth_token=' . $this->_oauthToken;
        if ($callBack) $uri.='&oauth_callback=' . $callBack;
        return $uri;
    }

    /**
     * Get account information
     * @return mixed
     */
    public function getAccountInfo() {
        $data = $this->fetch(self::URL_API . 'account/info');
        return json_decode($data['body'],true);
    }

    /**
     * Get file content
     *
     * @param string $path path
     * @param string $root
     * @return string
     */
    public function getFile($path = '', $root = false) {

        if (!$root) $root = $this->root;
        $path = str_replace(array('%2F','~'), array('/','%7E'), rawurlencode($path));
        $result = $this->fetch(self::API_CONTENT_URL . 'files/' . $root . '/' . ltrim($path,'/'));
        return $result['body'];

    }

    /**
     * Send file to Dropbox
     *
     * @param $path
     * @param $file
     * @param null $root
     * @return bool
     * @throws CException
     */
    public function putFile($path, $file, $root = null) {

        if (dirname($path) == '\\') {
            $directory = "/";
        } else {
            $directory = dirname($path);
        }
        $filename = basename($path);

        if($directory==='.') $directory = '';
        $directory = str_replace(array('%2F','~'), array('/','%7E'), rawurlencode($directory));
        $filename = str_replace('~', '%7E', rawurlencode($filename));
        if (is_null($root)) $root = $this->root;

        if (is_string($file)) {

            $file = fopen($file,'rb');

        } elseif (!is_resource($file)) {
            $this->_errorCode = 1;
            $this->_errorMessage = 'File must be a file-resource or a string';
            return false;
        }
        $result=$this->multipartFetch(self::API_CONTENT_URL . 'files/' .
            $root . '/' . trim($directory,'/'), $file, $filename);

        if(!isset($result["httpStatus"]) || $result["httpStatus"] != 200) {
            $this->_errorCode = 1;
            $this->_errorMessage = 'Uploading file to Dropbox failed';
            return false;
        }

        return true;
    }


    /**
     * Upload big file
     * @param bool $filename
     * @param $file
     * @param null $root
     * @return mixed
     */
    public function chunkedUpload($filename, $file, $root = null) {

        $handle = fopen($file, 'rb');
        fseek($handle, 0);

        $arguments = array(
            'upload_id' => '',
            'offset' => 0,
        );
        while ($data = fread($handle, $this->chunkSize)) {

            $url = self::CONTENT_URL . 'chunked_upload';
            if ($arguments['offset'] > 0) {
                $url .= '?' . http_build_query($arguments);
            }
            $result = $this->multipartFetch($url, $data, $filename, 'PUT', true);

            $body = json_decode($result['body'], true);
            $arguments['upload_id'] = isset($body['upload_id']) ? $body['upload_id'] : '';
            $arguments['offset'] = isset($body['offset']) ? $body['offset'] : 0;
            @fseek($handle, $arguments['offset']);

        }

        if (is_null($root)) {
            $root = $this->root;
        }
        //fix upload
        $commit = self::CONTENT_URL . 'commit_chunked_upload/' . $root . '/' . $filename . '?upload_id=' . $arguments['upload_id'];
        $response = $this->oauth->fetch($commit, array(), 'POST');
        return json_decode($response['body'],true);
    }

    /**
     * Copy file
     *
     * @param $from
     * @param $to
     * @param null $root
     * @return mixed
     */
    public function copy($from, $to, $root = null) {

        if (is_null($root)) $root = $this->root;
        $response = $this->fetch(self::URL_API . 'fileops/copy', array('from_path' => $from, 'to_path' => $to, 'root' => $root));

        return json_decode($response['body'],true);

    }

    /**
     * Create folder
     *
     * @param $path
     * @param null $root
     * @return mixed
     */
    public function createFolder($path, $root = null) {

        if (is_null($root)) $root = $this->root;
        $path = '/' . ltrim($path,'/');

        $response = $this->fetch(self::URL_API . 'fileops/create_folder', array('path' => $path, 'root' => $root),'POST');
        return json_decode($response['body'],true);

    }

    /**
     * Delete file or directory
     *
     * @param $path
     * @param null $root
     * @return mixed
     */
    public function delete($path, $root = null) {

        if (is_null($root)) $root = $this->root;
        $response = $this->fetch(self::URL_API . 'fileops/delete', array('path' => $path, 'root' => $root));
        return json_decode($response['body']);

    }

    /**
     * Move file
     *
     * @param $from
     * @param $to
     * @param null $root
     * @return mixed
     */
    public function move($from, $to, $root = null) {

        if (is_null($root)) $root = $this->root;
        $response = $this->fetch(self::URL_API . 'fileops/move', array('from_path' => rawurldecode($from), 'to_path' => rawurldecode($to), 'root' => $root));

        return json_decode($response['body'],true);

    }

    /**
     * Get files metadata
     *
     * @param $path
     * @param bool $list
     * @param null $hash
     * @param null $fileLimit
     * @param null $root
     * @return bool|mixed
     */
    public function getMetaData($path, $list = true, $hash = null, $fileLimit = null, $root = null) {

        if (is_null($root)) $root = $this->root;

        $args = array(
            'list' => $list,
        );

        if (!is_null($hash)) $args['hash'] = $hash;
        if (!is_null($fileLimit)) $args['file_limit'] = $fileLimit;

        $path = str_replace(array('%2F','~'), array('/','%7E'), rawurlencode($path));
        $response = $this->fetch(self::URL_API . 'metadata/' . $root . '/' . ltrim($path,'/'), $args);

        /* 304 is not modified */
        if ($response['httpStatus']==304) {
            return true;
        } else {
            return json_decode($response['body'],true);
        }

    }

    public function delta($cursor) {

        $arg['cursor'] = $cursor;

        $response = $this->fetch(self::URL_API . 'delta', $arg, 'POST');
        return json_decode($response['body'],true);

    }

    /**
     * Get Thumbnail
     *
     * @param $path
     * @param string $size
     * @param null $root
     * @return mixed
     */
    public function getThumbnail($path, $size = 'small', $root = null) {

        if (is_null($root)) $root = $this->root;
        $path = str_replace(array('%2F','~'), array('/','%7E'), rawurlencode($path));
        $response = $this->fetch(self::URL_API . 'thumbnails/' . $root . '/' . ltrim($path,'/'),array('size' => $size));

        return $response['body'];

    }

    /**
     * Search
     *
     * @param string $query
     * @param string $root
     * @param string $path
     * @return array
     */
    public function search($query = '', $root = null, $path = ''){
        if (is_null($root)) $root = $this->root;
        if(!empty($path)){
            $path = str_replace(array('%2F','~'), array('/','%7E'), rawurlencode($path));
        }
        $response = $this->fetch(self::URL_API . 'search/' . $root . '/' . ltrim($path,'/'),array('query' => $query));
        return json_decode($response['body'],true);
    }

    /**
     * Create and return share link
     *
     * @param type $path
     * @param type $root
     * @return type
     */
    public function share($path, $root = null) {
        if (is_null($root)) $root = $this->root;
        $path = str_replace(array('%2F','~'), array('/','%7E'), rawurlencode($path));
        $response = $this->fetch(self::URL_API .  'shares/'. $root . '/' . ltrim($path, '/'), array(), 'POST');
        return json_decode($response['body'],true);

    }

    /**
     * Return link to file
     *
     * @param type $path
     * @param type $root
     * @return type
     */
    public function media($path, $root = null) {

        if (is_null($root)) $root = $this->root;
        $path = str_replace(array('%2F','~'), array('/','%7E'), rawurlencode($path));
        $response = $this->fetch(self::URL_API.  'media/'. $root . '/' . ltrim($path, '/'), array(), 'POST');
        return json_decode($response['body'],true);

    }

    /**
     * @param type $path
     * @param type $root
     * @return type
     */
    public function copy_ref($path, $root = null) {

        if (is_null($root)) $root = $this->root;
        $path = str_replace(array('%2F','~'), array('/','%7E'), rawurlencode($path));
        $response = $this->fetch(self::URL_API.  'copy_ref/'. $root . '/' . ltrim($path, '/'));
        return json_decode($response['body'],true);

    }

    /**
     * @param $uri
     * @param $file
     * @param $filename
     * @return array
     */
    protected function multipartFetch($uri, $file, $filename, $method = 'POST', $nowData = false) {

        $boundary = 'R50hrfBj5JYyfR3vF3wR96GPCC9Fd2q2pVMERvEaOE3D8LZTgLLbRpNwXek3';

        $headers = array(
            'Content-Type' => 'multipart/form-data; boundary=' . $boundary,
        );

        $body="--" . $boundary . "\r\n";
        $body.="Content-Disposition: form-data; name=file; filename=".rawurldecode($filename)."\r\n";
        $body.="Content-type: application/octet-stream\r\n";
        $body.="\r\n";
        if ($nowData) {
            $body .= $file;
        }
        else {
            $body.=stream_get_contents($file);
        }
        $body.="\r\n";
        $body.="--" . $boundary . "--";

        if ($method == 'POST') {
            $uri.='?file=' . $filename;
        }

        return $this->fetch($uri, $body, $method, $headers);

    }

    /**
     * @param String $uri
     * @param array $arguments
     * @param string $method
     * @param array $httpHeaders
     * @return array
     * @throws CException
     */
    public function fetch($uri, $arguments = array(), $method = 'GET', $httpHeaders = array()) {
        try {
            $this->_oauth->fetch($uri, $arguments, $method, $httpHeaders);
            $result = $this->_oauth->getLastResponse();
            $lastResponseInfo = $this->_oauth->getLastResponseInfo();
            return array(
                'httpStatus' => $lastResponseInfo['http_code'],
                'body'       => $result,
            );
        } catch (CException $e) {

            $lastResponseInfo = $this->_oauth->getLastResponseInfo();
            $this->_errorCode = $lastResponseInfo['http_code'];
            switch($lastResponseInfo['http_code']) {

                case 304 :
                    return array(
                        'httpStatus' => 304,
                        'body'       => null,
                    );
                    break;
                case 400 :
                    $this->_errorCode = 400;
                    $this->_errorMessage = 'Forbidden. Bad input parameter. Error message should indicate which one and why.';
                    return false;
                case 401 :
                    $this->_errorCode = 401;
                    $this->_errorMessage = 'Forbidden. Bad or expired token. This can happen if the user or Dropbox revoked or expired an access token. To fix, you should re-authenticate the user.';
                    return false;
                case 403 :
                    $this->_errorCode = 403;
                    $this->_errorMessage = 'Forbidden. This could mean a bad OAuth request, or a file or folder already existing at the target location.';
                    return false;
                case 404 :
                    $this->_errorCode = 404;
                    $this->_errorMessage = 'Resource at uri: ' . $uri . ' could not be found';
                    return false;
                case 405 :
                    $this->_errorCode = 405;
                    $this->_errorMessage = 'Forbidden. Request method not expected (generally should be GET or POST).';
                    return false;
                case 500 :
                    $this->_errorCode = 500;
                    $this->_errorMessage = 'Server error. ' . $e->getMessage();
                    return false;
                case 503 :
                    $this->_errorCode = 503;
                    $this->_errorMessage = 'Forbidden. Your app is making too many requests and is being rate limited. 503s can trigger on a per-app or per-user basis.';
                    return false;
                case 507 :
                    $this->_errorCode = 507;
                    $this->_errorMessage = 'This dropbox is full';
                    return false;
                default:
                    $this->_errorCode = 1;
                    $this->_errorMessage = $e->getMessage();
                    return false;
            }

        }

    }

}