Proyectos de Subversion Moodle

<?php

// This file is part of Moodle - http://moodle.org/

//

// Moodle is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Moodle is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**

 * This plugin is used to access s3 files

 *

 * @since Moodle 2.0

 * @package    repository_s3

 * @copyright  2010 Dongsheng Cai {@link http://dongsheng.org}

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

require_once($CFG->dirroot . '/repository/lib.php');

require_once($CFG->dirroot . '/repository/s3/S3.php');

// This constant is not defined in php 5.4. Set it to avoid errors.

if (!defined('CURL_SSLVERSION_TLSv1')) {

    define('CURL_SSLVERSION_TLSv1', 1);

}

/**

 * This is a repository class used to browse Amazon S3 content.

 *

 * @since Moodle 2.0

 * @package    repository_s3

 * @copyright  2009 Dongsheng Cai {@link http://dongsheng.org}

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class repository_s3 extends repository {

    /** @var string access key. */

    protected $access_key;

    /** @var string secret key. */

    protected $secret_key;

    /** @var string endpoint URL. */

    protected $endpoint;

    /** @var S3 S3 class. */

    protected $s;

    /**

     * Constructor

     * @param int $repositoryid

     * @param object $context

     * @param array $options

     */

    public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array()) {

        global $CFG;

        parent::__construct($repositoryid, $context, $options);

        $this->access_key = get_config('s3', 'access_key');

        $this->secret_key = get_config('s3', 'secret_key');

        $this->endpoint = get_config('s3', 'endpoint');

        if ($this->endpoint === false) { // If no endpoint has been set, use the default.

            $this->endpoint = 's3.amazonaws.com';

        }

        $this->s = new S3($this->access_key, $this->secret_key, false, $this->endpoint);

        $this->s->setExceptions(true);

        // Port of curl::__construct().

        if (!empty($CFG->proxyhost)) {

            if (empty($CFG->proxyport)) {

                $proxyhost = $CFG->proxyhost;

            } else {

                $proxyhost = $CFG->proxyhost . ':' . $CFG->proxyport;

            }

            $proxytype = CURLPROXY_HTTP;

            $proxyuser = null;

            $proxypass = null;

            if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {

                $proxyuser = $CFG->proxyuser;

                $proxypass = $CFG->proxypassword;

            }

            if (!empty($CFG->proxytype) && $CFG->proxytype == 'SOCKS5') {

                $proxytype = CURLPROXY_SOCKS5;

            }

            $this->s->setProxy($proxyhost, $proxyuser, $proxypass, $proxytype);

        }

    }

    /**

     * Extracts the Bucket and URI from the path

     *

     * @param string $path path in this format 'bucket/path/to/folder/and/file'

     * @return array including bucket and uri

     */

    protected function explode_path($path) {

        $parts = explode('/', $path, 2);

        if (isset($parts[1]) && $parts[1] !== '') {

            list($bucket, $uri) = $parts;

        } else {

            $bucket = $parts[0];

            $uri = '';

        }

        return array($bucket, $uri);

    }

    /**

     * Get S3 file list

     *

     * @param string $path

     * @return array The file list and options

     */

    public function get_listing($path = '', $page = '') {

        global $CFG, $OUTPUT;

        if (empty($this->access_key)) {

            throw new moodle_exception('needaccesskey', 'repository_s3');

        }

        $list = array();

        $list['list'] = array();

        $list['path'] = array(

            array('name' => get_string('pluginname', 'repository_s3'), 'path' => '')

        );

        // the management interface url

        $list['manage'] = false;

        // dynamically loading

        $list['dynload'] = true;

        // the current path of this list.

        // set to true, the login link will be removed

        $list['nologin'] = true;

        // set to true, the search button will be removed

        $list['nosearch'] = true;

        $tree = array();

        if (empty($path)) {

            try {

                $buckets = $this->s->listBuckets();

            } catch (S3Exception $e) {

                throw new moodle_exception(

                    'errorwhilecommunicatingwith',

                    'repository',

                    '',

                    $this->get_name(),

                    $e->getMessage()

                );

            }

            foreach ($buckets as $bucket) {

                $folder = array(

                    'title' => $bucket,

                    'children' => array(),

                    'thumbnail' => $OUTPUT->image_url(file_folder_icon())->out(false),

                    'path' => $bucket

                    );

                $tree[] = $folder;

            }

        } else {

            $files = array();

            $folders = array();

            list($bucket, $uri) = $this->explode_path($path);

            try {

                $contents = $this->s->getBucket($bucket, $uri, null, null, '/', true);

            } catch (S3Exception $e) {

                throw new moodle_exception(

                    'errorwhilecommunicatingwith',

                    'repository',

                    '',

                    $this->get_name(),

                    $e->getMessage()

                );

            }

            foreach ($contents as $object) {

                // If object has a prefix, it is a 'CommonPrefix', which we consider a folder

                if (isset($object['prefix'])) {

                    $title = rtrim($object['prefix'], '/');

                } else {

                    $title = $object['name'];

                }

                // Removes the prefix (folder path) from the title

                if (strlen($uri) > 0) {

                    $title = substr($title, strlen($uri));

                    // Check if title is empty and not zero

                    if (empty($title) && !is_numeric($title)) {

                        // Amazon returns the prefix itself, we skip it

                        continue;

                    }

                }

                // This is a so-called CommonPrefix, we consider it as a folder

                if (isset($object['prefix'])) {

                    $folders[] = array(

                        'title' => $title,

                        'children' => array(),

                        'thumbnail' => $OUTPUT->image_url(file_folder_icon())->out(false),

                        'path' => $bucket . '/' . $object['prefix'],

                    );

                } else {

                    $files[] = array(

                        'title' => $title,

                        'size' => $object['size'],

                        'datemodified' => $object['time'],

                        'source' => $bucket . '/' . $object['name'],

                        'thumbnail' => $OUTPUT->image_url(file_extension_icon($title))->out(false)

                    );

                }

            }

            $tree = array_merge($folders, $files);

        }

        $trail = '';

        if (!empty($path)) {

            $parts = explode('/', $path);

            if (count($parts) > 1) {

                foreach ($parts as $part) {

                    if (!empty($part)) {

                        $trail .= $part . '/';

                        $list['path'][] = array('name' => $part, 'path' => $trail);

                    }

                }

            } else {

                $list['path'][] = array('name' => $path, 'path' => $path);

            }

        }

        $list['list'] = $tree;

        return $list;

    }

    /**

     * Download S3 files to moodle

     *

     * @param string $filepath

     * @param string $file The file path in moodle

     * @return array The local stored path

     */

    public function get_file($filepath, $file = '') {

        list($bucket, $uri) = $this->explode_path($filepath);

        $path = $this->prepare_file($file);

        try {

            $this->s->getObject($bucket, $uri, $path);

        } catch (S3Exception $e) {

            throw new moodle_exception(

                'errorwhilecommunicatingwith',

                'repository',

                '',

                $this->get_name(),

                $e->getMessage()

            );

        }

        return array('path' => $path);

    }

    /**

     * Return the source information

     *

     * @param stdClass $filepath

     * @return string

     */

    public function get_file_source_info($filepath) {

        return 'Amazon S3: ' . $filepath;

    }

    /**

     * S3 doesn't require login

     *

     * @return bool

     */

    public function check_login() {

        return true;

    }

    /**

     * S3 doesn't provide search

     *

     * @return bool

     */

    public function global_search() {

        return false;

    }

    public static function get_type_option_names() {

        return array('access_key', 'secret_key', 'endpoint', 'pluginname');

    }

    public static function type_config_form($mform, $classname = 'repository') {

        parent::type_config_form($mform);

        $strrequired = get_string('required');

        $endpointselect = array( // List of possible Amazon S3 Endpoints.

            "s3.amazonaws.com" => "s3.amazonaws.com",

            "s3-external-1.amazonaws.com" => "s3-external-1.amazonaws.com",

            "s3-us-west-2.amazonaws.com" => "s3-us-west-2.amazonaws.com",

            "s3-us-west-1.amazonaws.com" => "s3-us-west-1.amazonaws.com",

            "s3-eu-west-1.amazonaws.com" => "s3-eu-west-1.amazonaws.com",

            "s3.eu-central-1.amazonaws.com" => "s3.eu-central-1.amazonaws.com",

            "s3-eu-central-1.amazonaws.com" => "s3-eu-central-1.amazonaws.com",

            "s3-ap-southeast-1.amazonaws.com" => "s3-ap-southeast-1.amazonaws.com",

            "s3-ap-southeast-2.amazonaws.com" => "s3-ap-southeast-2.amazonaws.com",

            "s3-ap-northeast-1.amazonaws.com" => "s3-ap-northeast-1.amazonaws.com",

            "s3-sa-east-1.amazonaws.com" => "s3-sa-east-1.amazonaws.com"

        );

        $mform->addElement('text', 'access_key', get_string('access_key', 'repository_s3'));

        $mform->setType('access_key', PARAM_RAW_TRIMMED);

        $mform->addElement('text', 'secret_key', get_string('secret_key', 'repository_s3'));

        $mform->setType('secret_key', PARAM_RAW_TRIMMED);

        $mform->addElement('select', 'endpoint', get_string('endpoint', 'repository_s3'), $endpointselect);

        $mform->setDefault('endpoint', 's3.amazonaws.com'); // Default to US Endpoint.

        $mform->addRule('access_key', $strrequired, 'required', null, 'client');

        $mform->addRule('secret_key', $strrequired, 'required', null, 'client');

    }

    /**

     * S3 plugins doesn't support return links of files

     *

     * @return int

     */

    public function supported_returntypes() {

        return FILE_INTERNAL;

    }

    /**

     * Is this repository accessing private data?

     *

     * @return bool

     */

    public function contains_private_data() {

        return false;

    }

}