df515f79798c4df6f81559032ce981d045486808
[moodle.git] / repository / upload / repository.class.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * repository_upload class
20  * A subclass of repository, which is used to upload file
21  *
22  * @since 2.0
23  * @package moodlecore
24  * @subpackage repository
25  * @copyright 2009 Dongsheng Cai
26  * @author Dongsheng Cai <dongsheng@moodle.com>
27  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  */
30 class repository_upload extends repository {
32     /**
33      *
34      * @param int $repositoryid
35      * @param object $context
36      * @param array $options
37      */
38     public function __construct($repositoryid, $context = SITEID, $options = array()){
39         parent::__construct($repositoryid, $context, $options);
40         $this->itemid = optional_param('itemid', '', PARAM_INT);
41         $this->filepath = urldecode(optional_param('savepath', '/', PARAM_PATH));
42     }
44     /**
45      * Print a upload form
46      *
47      * @return array
48      */
49     public function print_login() {
50         return $this->get_listing();
51     }
53     /**
54      * Process uploaded file
55      *
56      * @return array
57      */
58     public function upload() {
59         try {
60             $this->info = $this->upload_to_filepool('repo_upload_file', 'user_draft', $this->filepath, $this->itemid);
61         } catch(Exception $e) {
62             throw $e;
63         }
64         return $this->info;
65     }
67     public function get_listing() {
68         global $CFG;
69         $ret = array();
70         $ret['nologin']  = true;
71         $ret['nosearch'] = true;
72         // define upload form in file picker
73         $ret['upload'] = array('label'=>get_string('attachment', 'repository'), 'id'=>'repo-form');
74         $ret['manage'] = $CFG->wwwroot .'/files/index.php'; // temporary
75         $ret['list'] = array();
76         $ret['dynload'] = false;
77         return $ret;
78     }
80     /**
81      * Define the name of this repository
82      * @return string
83      */
84     public function get_name(){
85         return get_string('repositoryname', 'repository_upload');
86     }
88     /**
89      * supported return types
90      * @return int
91      */
92     public function supported_returntypes() {
93         return FILE_INTERNAL;
94     }
96     /**
97      * Upload file to local filesystem pool
98      * @param string $elname name of element
99      * @param string $filearea
100      * @param string $filepath
101      * @param string $filename - use specified filename, if not specified name of uploaded file used
102      * @param bool $override override file if exists
103      * @return mixed stored_file object or false if error; may throw exception if duplicate found
104      */
105     public function upload_to_filepool($elname, $filearea='user_draft', $filepath='/', $itemid='', $filename = '', $override = true) {
106         global $USER;
108         if ($filepath !== '/') {
109             $filepath = trim($filepath, '/');
110             $filepath = '/'.$filepath.'/';
111         }
113         if (!isset($_FILES[$elname])) {
114             throw new moodle_exception('nofile');
115         }
117         if (!empty($_FILES[$elname]['error'])) {
118             throw new moodle_exception('maxbytes');
119         }
121         if (!$filename) {
122             $filename = $_FILES[$elname]['name'];
123         }
125         $context = get_context_instance(CONTEXT_USER, $USER->id);
126         if (empty($itemid)) {
127             $itemid = (int)substr(hexdec(uniqid()), 0, 9)+rand(1,100);
128         }
129         $fs = get_file_storage();
130         $browser = get_file_browser();
132         if ($file = $fs->get_file($context->id, $filearea, $itemid, $filepath, $filename)) {
133             if ($override) {
134                 $file->delete();
135             } else {
136                 throw new moodle_exception('fileexist');
137             }
138         }
140         $file_record = new object();
141         $file_record->contextid = $context->id;
142         $file_record->filearea  = $filearea;
143         $file_record->itemid    = $itemid;
144         $file_record->filepath  = $filepath;
145         $file_record->filename  = $filename;
146         $file_record->userid    = $USER->id;
148         try {
149             $file = $fs->create_file_from_pathname($file_record, $_FILES[$elname]['tmp_name']);
150         } catch (Exception $e) {
151             $e->obj = $_FILES[$elname];
152             throw $e;
153         }
154         $info = $browser->get_file_info($context, $file->get_filearea(), $file->get_itemid(), $file->get_filepath(), $file->get_filename());
155         return array(
156             'url'=>$info->get_url(),
157             'id'=>$itemid,
158             'file'=>$file->get_filename()
159         );
160     }