MDL-33981 repository_equella: support internal copy
[moodle.git] / repository / equella / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This plugin is used to access equella repositories.
19  *
20  * @since Moodle 2.3
21  * @package    repository_equella
22  * @copyright  2012 Dongsheng Cai {@link http://dongsheng.org}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 require_once($CFG->dirroot . '/repository/lib.php');
30 /**
31  * repository_equella class implements equella_client
32  *
33  * @since Moodle 2.3
34  * @package    repository_equella
35  * @copyright  2012 Dongsheng Cai {@link http://dongsheng.org}
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class repository_equella extends repository {
39     /** @var array mimetype filter */
40     private $mimetypes = array();
42     /**
43      * Constructor
44      *
45      * @param int $repositoryid repository instance id
46      * @param int|stdClass $context a context id or context object
47      * @param array $options repository options
48      */
49     public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array()) {
50         parent::__construct($repositoryid, $context, $options);
52         if (isset($this->options['mimetypes'])) {
53             $mt = $this->options['mimetypes'];
54             if (!empty($mt) && is_array($mt) && !in_array('*', $mt)) {
55                 $this->mimetypes = array_unique(array_map(array($this, 'to_mime_type'), $mt));
56             }
57         }
58     }
60     /**
61      * Display embedded equella interface
62      *
63      * @param string $path
64      * @param mixed $page
65      * @return array
66      */
67     public function get_listing($path = null, $page = null) {
68         global $COURSE;
69         $callbackurl = new moodle_url('/repository/equella/callback.php', array('repo_id'=>$this->id));
71         $mimetypesstr = '';
72         $restrict = '';
73         if (!empty($this->mimetypes)) {
74             $mimetypesstr = '&mimeTypes=' . implode(',', $this->mimetypes);
75             // We're restricting to a mime type, so we always restrict to selecting resources only.
76             $restrict = '&attachmentonly=true';
77         } else if ($this->get_option('equella_select_restriction') != 'none') {
78             // The option value matches the EQUELLA paramter name.
79             $restrict = '&' . $this->get_option('equella_select_restriction') . '=true';
80         }
82         $url = $this->get_option('equella_url')
83                 . '?method=lms'
84                 . '&returnurl='.urlencode($callbackurl)
85                 . '&returnprefix=tle'
86                 . '&template=standard'
87                 . '&token='.urlencode($this->getssotoken('write'))
88                 . '&courseId='.urlencode($COURSE->idnumber)
89                 . '&courseCode='.urlencode($COURSE->shortname)
90                 . '&action=searchThin'
91                 . '&forcePost=true'
92                 . '&cancelDisabled=true'
93                 . '&attachmentUuidUrls=true'
94                 . '&options='.urlencode($this->get_option('equella_options') . $mimetypesstr)
95                 . $restrict;
97         $manageurl = $this->get_option('equella_url');
98         $manageurl = str_ireplace('signon.do', 'logon.do', $manageurl);
99         $manageurl = $this->appendtoken($manageurl);
101         $list = array();
102         $list['object'] = array();
103         $list['object']['type'] = 'text/html';
104         $list['object']['src'] = $url;
105         $list['nologin']  = true;
106         $list['nosearch'] = true;
107         $list['norefresh'] = true;
108         $list['manage'] = $manageurl;
109         return $list;
110     }
112     /**
113      * Supported equella file types
114      *
115      * @return int
116      */
117     public function supported_returntypes() {
118         return (FILE_INTERNAL | FILE_REFERENCE);
119     }
121     /**
122      * Prepare file reference information
123      *
124      * @param string $source
125      * @return string file referece
126      */
127     public function get_file_reference($source) {
128         // Internally we store serialized value but user input is json-encoded for security reasons.
129         $ref = json_decode(base64_decode($source));
130         $filename  = clean_param($ref->filename, PARAM_FILE);
131         $url = clean_param($ref->url, PARAM_URL);
132         return base64_encode(serialize((object)array('url' => $url, 'filename' => $filename)));
133     }
135     /**
136      * Counts the number of failed connections.
137      *
138      * If we received the connection timeout more than 3 times in a row, we don't attemt to
139      * connect to the server any more during this request.
140      *
141      * This function is used by {@link repository_equella::sync_reference()} that
142      * synchronises the file size of referenced files.
143      *
144      * @param int $errno omit if we just want to know the return value, the last curl_errno otherwise
145      * @return bool true if we had less than 3 failed connections, false if no more connections
146      * attempts recommended
147      */
148     private function connection_result($errno = null) {
149         static $countfailures = array();
150         $sess = sesskey();
151         if (!array_key_exists($sess, $countfailures)) {
152             $countfailures[$sess] = 0;
153         }
154         if ($errno !== null) {
155             if ($errno == 0) {
156                 // reset count of failed connections
157                 $countfailures[$sess] = 0;
158             } else if ($errno == 7 /*CURLE_COULDNT_CONNECT*/ || $errno == 9 /*CURLE_REMOTE_ACCESS_DENIED*/) {
159                 // problems with server
160                 $countfailures[$sess]++;
161             }
162         }
163         return ($countfailures[$sess] < 3);
164     }
166     /**
167      * Download a file, this function can be overridden by subclass. {@link curl}
168      *
169      * @param string $reference the source of the file
170      * @param string $filename filename (without path) to save the downloaded file in the
171      * temporary directory
172      * @return null|array null if download failed or array with elements:
173      *   path: internal location of the file
174      *   url: URL to the source (from parameters)
175      */
176     public function get_file($reference, $filename = '') {
177         global $USER, $CFG;
178         $ref = @unserialize(base64_decode($reference));
179         if (!isset($ref->url) || !($url = $this->appendtoken($ref->url))) {
180             // Occurs when the user isn't known..
181             return null;
182         }
183         $path = $this->prepare_file($filename);
184         $cookiepathname = $this->prepare_file($USER->id. '_'. uniqid('', true). '.cookie');
185         $c = new curl(array('cookie'=>$cookiepathname));
186         $result = $c->download_one($url, null, array('filepath' => $path, 'followlocation' => true, 'timeout' => $CFG->repositorygetfiletimeout));
187         // Delete cookie jar.
188         if (file_exists($cookiepathname)) {
189             unlink($cookiepathname);
190         }
191         if ($result !== true) {
192             throw new moodle_exception('errorwhiledownload', 'repository', '', $result);
193         }
194         return array('path'=>$path, 'url'=>$url);
195     }
197     public function sync_reference(stored_file $file) {
198         global $USER, $CFG;
199         if ($file->get_referencelastsync() + DAYSECS > time() || !$this->connection_result()) {
200             // Synchronise not more often than once a day.
201             // if we had several unsuccessfull attempts to connect to server - do not try any more.
202             return false;
203         }
204         $ref = @unserialize(base64_decode($file->get_reference()));
205         if (!isset($ref->url) || !($url = $this->appendtoken($ref->url))) {
206             // Occurs when the user isn't known..
207             $file->set_missingsource();
208             return true;
209         }
211         $cookiepathname = $this->prepare_file($USER->id. '_'. uniqid('', true). '.cookie');
212         $c = new curl(array('cookie' => $cookiepathname));
213         if (file_extension_in_typegroup($ref->filename, 'web_image')) {
214             $path = $this->prepare_file('');
215             $result = $c->download_one($url, null, array('filepath' => $path, 'followlocation' => true, 'timeout' => $CFG->repositorysyncimagetimeout));
216             if ($result === true) {
217                 $file->set_synchronised_content_from_file($path);
218                 return true;
219             }
220         } else {
221             $result = $c->head($url, array('followlocation' => true, 'timeout' => $CFG->repositorysyncfiletimeout));
222         }
223         // Delete cookie jar.
224         if (file_exists($cookiepathname)) {
225             unlink($cookiepathname);
226         }
228         $this->connection_result($c->get_errno());
229         $curlinfo = $c->get_info();
230         if (isset($curlinfo['http_code']) && $curlinfo['http_code'] == 200
231                 && array_key_exists('download_content_length', $curlinfo)
232                 && $curlinfo['download_content_length'] >= 0) {
233             // we received a correct header and at least can tell the file size
234             $file->set_synchronized(null, $curlinfo['download_content_length']);
235             return true;
236         }
237         $file->set_missingsource();
238         return true;
239     }
241     /**
242      * Repository method to serve the referenced file
243      *
244      * @param stored_file $storedfile the file that contains the reference
245      * @param int $lifetime Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
246      * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
247      * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
248      * @param array $options additional options affecting the file serving
249      */
250     public function send_file($stored_file, $lifetime=null , $filter=0, $forcedownload=false, array $options = null) {
251         $reference  = unserialize(base64_decode($stored_file->get_reference()));
252         $url = $this->appendtoken($reference->url);
253         if ($url) {
254             header('Location: ' . $url);
255         } else {
256             send_file_not_found();
257         }
258     }
260     /**
261      * Add Instance settings input to Moodle form
262      *
263      * @param moodleform $mform
264      */
265     public static function instance_config_form($mform) {
266         $mform->addElement('text', 'equella_url', get_string('equellaurl', 'repository_equella'));
267         $mform->setType('equella_url', PARAM_URL);
269         $strrequired = get_string('required');
270         $mform->addRule('equella_url', $strrequired, 'required', null, 'client');
272         $mform->addElement('text', 'equella_options', get_string('equellaoptions', 'repository_equella'));
273         $mform->setType('equella_options', PARAM_NOTAGS);
275         $choices = array(
276             'none' => get_string('restrictionnone', 'repository_equella'),
277             'itemonly' => get_string('restrictionitemsonly', 'repository_equella'),
278             'attachmentonly' => get_string('restrictionattachmentsonly', 'repository_equella'),
279         );
280         $mform->addElement('select', 'equella_select_restriction', get_string('selectrestriction', 'repository_equella'), $choices);
282         $mform->addElement('header', 'groupheader',
283             get_string('group', 'repository_equella', get_string('groupdefault', 'repository_equella')));
284         $mform->addElement('text', 'equella_shareid', get_string('sharedid', 'repository_equella'));
285         $mform->setType('equella_shareid', PARAM_RAW);
286         $mform->addRule('equella_shareid', $strrequired, 'required', null, 'client');
288         $mform->addElement('text', 'equella_sharedsecret', get_string('sharedsecrets', 'repository_equella'));
289         $mform->setType('equella_sharedsecret', PARAM_RAW);
290         $mform->addRule('equella_sharedsecret', $strrequired, 'required', null, 'client');
292         foreach (self::get_all_editing_roles() as $role) {
293             $mform->addElement('header', 'groupheader_'.$role->shortname, get_string('group', 'repository_equella',
294                 role_get_name($role)));
295             $mform->addElement('text', "equella_{$role->shortname}_shareid", get_string('sharedid', 'repository_equella'));
296             $mform->setType("equella_{$role->shortname}_shareid", PARAM_RAW);
297             $mform->addElement('text', "equella_{$role->shortname}_sharedsecret",
298                 get_string('sharedsecrets', 'repository_equella'));
299             $mform->setType("equella_{$role->shortname}_sharedsecret", PARAM_RAW);
300         }
301     }
303     /**
304      * Names of the instance settings
305      *
306      * @return array
307      */
308     public static function get_instance_option_names() {
309         $rv = array('equella_url', 'equella_select_restriction', 'equella_options',
310             'equella_shareid', 'equella_sharedsecret'
311         );
313         foreach (self::get_all_editing_roles() as $role) {
314             array_push($rv, "equella_{$role->shortname}_shareid");
315             array_push($rv, "equella_{$role->shortname}_sharedsecret");
316         }
318         return $rv;
319     }
321     /**
322      * Generate equella token
323      *
324      * @param string $username
325      * @param string $shareid
326      * @param string $sharedsecret
327      * @return string
328      */
329     private static function getssotoken_raw($username, $shareid, $sharedsecret) {
330         $time = time() . '000';
331         return urlencode($username)
332             . ':'
333             . $shareid
334             . ':'
335             . $time
336             . ':'
337             . base64_encode(pack('H*', md5($username . $shareid . $time . $sharedsecret)));
338     }
340     /**
341      * Append token
342      *
343      * @param string $url
344      * @param $readwrite
345      * @return string
346      */
347     private function appendtoken($url, $readwrite = null) {
348         $ssotoken = $this->getssotoken($readwrite);
349         if (!$ssotoken) {
350             return false;
351         }
352         return $url . (strpos($url, '?') != false ? '&' : '?') . 'token=' . urlencode($ssotoken);
353     }
355     /**
356      * Generate equella sso token
357      *
358      * @param string $readwrite
359      * @return string
360      */
361     private function getssotoken($readwrite = 'read') {
362         global $USER;
364         if (empty($USER->username)) {
365             return false;
366         }
368         if ($readwrite == 'write') {
370             foreach (self::get_all_editing_roles() as $role) {
371                 if (user_has_role_assignment($USER->id, $role->id, $this->context->id)) {
372                     // See if the user has a role that is linked to an equella role.
373                     $shareid = $this->get_option("equella_{$role->shortname}_shareid");
374                     if (!empty($shareid)) {
375                         return $this->getssotoken_raw($USER->username, $shareid,
376                             $this->get_option("equella_{$role->shortname}_sharedsecret"));
377                     }
378                 }
379             }
380         }
381         // If we are only reading, use the unadorned shareid and secret.
382         $shareid = $this->get_option('equella_shareid');
383         if (!empty($shareid)) {
384             return $this->getssotoken_raw($USER->username, $shareid, $this->get_option('equella_sharedsecret'));
385         }
386     }
388     private static function get_all_editing_roles() {
389         return get_roles_with_capability('moodle/course:manageactivities', CAP_ALLOW);
390     }
392     /**
393      * Convert moodle mimetypes list to equella format
394      *
395      * @param string $value
396      * @return string
397      */
398     private static function to_mime_type($value) {
399         return mimeinfo('type', $value);
400     }
402     /**
403      * Return the source information
404      *
405      * @param string $source
406      * @return string|null
407      */
408     public function get_file_source_info($source) {
409         $ref = json_decode(base64_decode($source));
410         $filename  = clean_param($ref->filename, PARAM_FILE);
411         return 'EQUELLA: ' . $filename;
412     }
414     /**
415      * Return human readable reference information
416      * {@link stored_file::get_reference()}
417      *
418      * @param string $reference
419      * @param int $filestatus status of the file, 0 - ok, 666 - source missing
420      * @return string
421      */
422     public function get_reference_details($reference, $filestatus = 0) {
423         if (!$filestatus) {
424             $ref = unserialize(base64_decode($reference));
425             return $this->get_name(). ': '. $ref->filename;
426         } else {
427             return get_string('lostsource', 'repository', '');
428         }
429     }
431     /**
432      * Is this repository accessing private data?
433      *
434      * @return bool
435      */
436     public function contains_private_data() {
437         return false;
438     }