Merge branch 'm20_MDL-22449_wiki_help_buttons' of git://github.com/dongsheng/moodle
[moodle.git] / repository / upload / lib.php
CommitLineData
a62542e0 1<?php
10d53fd3
DC
2
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/>.
17
a62542e0 18/**
e35194be 19 * A repository plugin to allow user uploading files
a62542e0 20 *
10d53fd3 21 * @since 2.0
d078f6d3
PS
22 * @package repository
23 * @subpackage upload
24 * @copyright 2009 Dongsheng Cai
25 * @author Dongsheng Cai <dongsheng@moodle.com>
26 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
a62542e0 27 */
28
29class repository_upload extends repository {
e35194be 30 private $mimetypes = array();
a62542e0 31
96297ca2 32 /**
f3b38030 33 * Print a upload form
f3b38030 34 * @return array
96297ca2 35 */
f3b38030 36 public function print_login() {
a62542e0 37 return $this->get_listing();
38 }
39
f3b38030
DC
40 /**
41 * Process uploaded file
e35194be 42 * @return array|bool
f3b38030 43 */
b8a6131b 44 public function upload($saveas_filename, $maxbytes) {
e35194be 45 global $USER, $CFG;
900d4606 46
e35194be
DC
47 $types = optional_param('accepted_types', '*', PARAM_RAW);
48 if ((is_array($types) and in_array('*', $types)) or $types == '*') {
49 $this->mimetypes = '*';
50 } else {
51 foreach ($types as $type) {
52 $this->mimetypes[] = mimeinfo('type', $type);
53 }
900d4606 54 }
7d9cb3b5 55
6bdfef5d 56 $record = new stdClass();
e35194be
DC
57 $record->filearea = 'draft';
58 $record->component = 'user';
64654e78 59 $record->filepath = optional_param('savepath', '/', PARAM_PATH);
e35194be
DC
60 $record->itemid = optional_param('itemid', 0, PARAM_INT);
61 $record->license = optional_param('license', $CFG->sitedefaultlicense, PARAM_TEXT);
62 $record->author = optional_param('author', '', PARAM_TEXT);
7d9cb3b5 63
1dce6261 64 $context = get_context_instance(CONTEXT_USER, $USER->id);
e35194be 65 $elname = 'repo_upload_file';
64f93798 66
1dce6261 67 $fs = get_file_storage();
f954e12e 68 $sm = get_string_manager();
7d9cb3b5 69
1dce6261 70 if ($record->filepath !== '/') {
e35194be 71 $record->filepath = file_correct_filepath($record->filepath);
7d9cb3b5
DC
72 }
73
74 if (!isset($_FILES[$elname])) {
75 throw new moodle_exception('nofile');
76 }
7d9cb3b5 77 if (!empty($_FILES[$elname]['error'])) {
1298a119
DC
78 switch ($_FILES[$elname]['error']) {
79 case UPLOAD_ERR_INI_SIZE:
80 throw new moodle_exception('upload_error_ini_size', 'repository_upload');
81 break;
82 case UPLOAD_ERR_FORM_SIZE:
83 throw new moodle_exception('upload_error_form_size', 'repository_upload');
84 break;
85 case UPLOAD_ERR_PARTIAL:
86 throw new moodle_exception('upload_error_partial', 'repository_upload');
87 break;
88 case UPLOAD_ERR_NO_FILE:
89 throw new moodle_exception('upload_error_no_file', 'repository_upload');
90 break;
91 case UPLOAD_ERR_NO_TMP_DIR:
92 throw new moodle_exception('upload_error_no_tmp_dir', 'repository_upload');
93 break;
94 case UPLOAD_ERR_CANT_WRITE:
95 throw new moodle_exception('upload_error_cant_write', 'repository_upload');
96 break;
97 case UPLOAD_ERR_EXTENSION:
98 throw new moodle_exception('upload_error_extension', 'repository_upload');
99 break;
100 default:
101 throw new moodle_exception('nofile');
102 }
7d9cb3b5
DC
103 }
104
0bd269b7 105 if (empty($saveas_filename)) {
ffdd6d18 106 $record->filename = clean_param($_FILES[$elname]['name'], PARAM_FILE);
0bd269b7
DC
107 } else {
108 $record->filename = $saveas_filename;
7d9cb3b5
DC
109 }
110
e35194be
DC
111 if ($this->mimetypes != '*') {
112 // check filetype
f954e12e
MD
113 $filemimetype = mimeinfo('type', $_FILES[$elname]['name']);
114 if (!in_array($filemimetype, $this->mimetypes)) {
115 if ($sm->string_exists($filemimetype, 'mimetypes')) {
116 $filemimetype = get_string($filemimetype, 'mimetypes');
117 }
118 throw new moodle_exception('invalidfiletype', 'repository', '', $filemimetype);
e35194be
DC
119 }
120 }
121
1dce6261
DC
122 if (empty($record->itemid)) {
123 $record->itemid = 0;
7d9cb3b5 124 }
7d9cb3b5 125
b8a6131b
DC
126 if (($maxbytes!==-1) && (filesize($_FILES[$elname]['tmp_name']) > $maxbytes)) {
127 throw new file_exception('maxbytes');
128 }
129
64654e78 130 if ($file = $fs->get_file($context->id, $record->component, $record->filearea, $record->itemid, $record->filepath, $record->filename)) {
0bd269b7 131 throw new moodle_exception('fileexists', 'repository');
7d9cb3b5
DC
132 }
133
1dce6261
DC
134 $record->contextid = $context->id;
135 $record->userid = $USER->id;
136 $record->source = '';
7d9cb3b5 137
e35194be 138 $stored_file = $fs->create_file_from_pathname($record, $_FILES[$elname]['tmp_name']);
1dce6261 139
7d9cb3b5 140 return array(
50a8bd6c 141 'url'=>moodle_url::make_draftfile_url($record->itemid, $record->filepath, $record->filename)->out(),
1dce6261 142 'id'=>$record->itemid,
e35194be
DC
143 'file'=>$record->filename);
144 }
145
146 /**
147 * Return a upload form
148 * @return array
149 */
150 public function get_listing() {
151 global $CFG;
152 $ret = array();
153 $ret['nologin'] = true;
154 $ret['nosearch'] = true;
155 $ret['norefresh'] = true;
156 $ret['list'] = array();
157 $ret['dynload'] = false;
158 $ret['upload'] = array('label'=>get_string('attachment', 'repository'), 'id'=>'repo-form');
159 return $ret;
160 }
161
e35194be
DC
162 /**
163 * supported return types
164 * @return int
165 */
166 public function supported_returntypes() {
167 return FILE_INTERNAL;
168 }
169
170 /**
171 * Upload file to local filesystem pool
172 * @param string $elname name of element
173 * @param string $filearea
174 * @param string $filepath
175 * @param string $filename - use specified filename, if not specified name of uploaded file used
176 * @param bool $override override file if exists
177 * @return mixed stored_file object or false if error; may throw exception if duplicate found
178 */
179 public function upload_to_filepool($elname, $record, $override = true) {
7d9cb3b5 180 }
a62542e0 181}