mirrored from git://git.moodle.org/moodle.git
/
resourcelib.php
528 lines (460 loc) · 16.2 KB
/
resourcelib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
<?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/>.
/**
* Recourse module like helper functions
*
* @package core
* @subpackage lib
* @copyright 2009 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/** Try the best way */
define('RESOURCELIB_DISPLAY_AUTO', 0);
/** Display using object tag */
define('RESOURCELIB_DISPLAY_EMBED', 1);
/** Display inside frame */
define('RESOURCELIB_DISPLAY_FRAME', 2);
/** Display normal link in new window */
define('RESOURCELIB_DISPLAY_NEW', 3);
/** Force download of file instead of display */
define('RESOURCELIB_DISPLAY_DOWNLOAD', 4);
/** Open directly */
define('RESOURCELIB_DISPLAY_OPEN', 5);
/** Open in "emulated" pop-up without navigation */
define('RESOURCELIB_DISPLAY_POPUP', 6);
/** Legacy files not needed or new resource */
define('RESOURCELIB_LEGACYFILES_NO', 0);
/** Legacy files conversion marked as completed */
define('RESOURCELIB_LEGACYFILES_DONE', 1);
/** Legacy files conversion in progress*/
define('RESOURCELIB_LEGACYFILES_ACTIVE', 2);
/**
* Try on demand migration of file from old course files
* @param string $filepath old file path
* @param int $cmid migrated course module if
* @param int $courseid
* @param string $component
* @param string $filearea new file area
* @param int $itemid migrated file item id
* @return mixed, false if not found, stored_file instance if migrated to new area
*/
function resourcelib_try_file_migration($filepath, $cmid, $courseid, $component, $filearea, $itemid) {
$fs = get_file_storage();
if (stripos($filepath, '/backupdata/') === 0 or stripos($filepath, '/moddata/') === 0) {
// do not steal protected files!
return false;
}
if (!$context = get_context_instance(CONTEXT_MODULE, $cmid)) {
return false;
}
if (!$coursecontext = get_context_instance(CONTEXT_COURSE, $courseid)) {
return false;
}
$fullpath = rtrim("/$coursecontext->id/course/legacy/0".$filepath, '/');
do {
if (!$file = $fs->get_file_by_hash(sha1($fullpath))) {
if ($file = $fs->get_file_by_hash(sha1("$fullpath/.")) and $file->is_directory()) {
if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.htm"))) {
break;
}
if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.html"))) {
break;
}
if ($file = $fs->get_file_by_hash(sha1("$fullpath/Default.htm"))) {
break;
}
}
return false;
}
} while (false);
// copy and keep the same path, name, etc.
$file_record = array('contextid'=>$context->id, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid);
try {
return $fs->create_file_from_storedfile($file_record, $file);
} catch (Exception $e) {
// file may exist - highly unlikely, we do not want upgrades to stop here
return false;
}
}
/**
* Returns list of available display options
* @param array $enabled list of options enabled in module configuration
* @param int $current current display options for existing instances
* @return array of key=>name pairs
*/
function resourcelib_get_displayoptions(array $enabled, $current=null) {
if (is_number($current)) {
$enabled[] = $current;
}
$options = array(RESOURCELIB_DISPLAY_AUTO => get_string('resourcedisplayauto'),
RESOURCELIB_DISPLAY_EMBED => get_string('resourcedisplayembed'),
RESOURCELIB_DISPLAY_FRAME => get_string('resourcedisplayframe'),
RESOURCELIB_DISPLAY_NEW => get_string('resourcedisplaynew'),
RESOURCELIB_DISPLAY_DOWNLOAD => get_string('resourcedisplaydownload'),
RESOURCELIB_DISPLAY_OPEN => get_string('resourcedisplayopen'),
RESOURCELIB_DISPLAY_POPUP => get_string('resourcedisplaypopup'));
$result = array();
foreach ($options as $key=>$value) {
if (in_array($key, $enabled)) {
$result[$key] = $value;
}
}
if (empty($result)) {
// there should be always something in case admin misconfigures module
$result[RESOURCELIB_DISPLAY_OPEN] = $options[RESOURCELIB_DISPLAY_OPEN];
}
return $result;
}
/**
* Tries to guess correct mimetype for arbitrary URL
* @param string $fullurl
* @return string mimetype
*/
function resourcelib_guess_url_mimetype($fullurl) {
global $CFG;
require_once("$CFG->libdir/filelib.php");
if ($fullurl instanceof moodle_url) {
$fullurl = $fullurl->out(false);
}
$matches = null;
if (preg_match("|^(.*)/[a-z]*file.php(\?file=)?(/[^&\?#]*)|", $fullurl, $matches)) {
// remove the special moodle file serving hacks so that the *file.php is ignored
$fullurl = $matches[1].$matches[3];
}
if (preg_match("|^(.*)#.*|", $fullurl, $matches)) {
// ignore all anchors
$fullurl = $matches[1];
}
if (strpos($fullurl, '.php')){
// we do not really know what is in general php script
return 'text/html';
} else if (substr($fullurl, -1) === '/') {
// directory index (http://example.com/smaples/)
return 'text/html';
} else if (strpos($fullurl, '//') !== false and substr_count($fullurl, '/') == 2) {
// just a host name (http://example.com), solves Australian servers "audio" problem too
return 'text/html';
} else {
// ok, this finally looks like a real file
$parts = explode('?', $fullurl);
$url = reset($parts);
return mimeinfo('type', $url);
}
}
/**
* Looks for the extension.
*
* @param string $fullurl
* @return string file extension
*/
function resourcelib_get_extension($fullurl) {
if ($fullurl instanceof moodle_url) {
$fullurl = $fullurl->out(false);
}
$matches = null;
if (preg_match("|^(.*)/[a-z]*file.php(\?file=)?(/.*)|", $fullurl, $matches)) {
// remove the special moodle file serving hacks so that the *file.php is ignored
$fullurl = $matches[1].$matches[3];
}
$matches = null;
if (preg_match('/^[^#\?]+\.([a-z0-9]+)([#\?].*)?$/i', $fullurl, $matches)) {
return strtolower($matches[1]);
}
return '';
}
/**
* Returns image embedding html.
* @param string $fullurl
* @param string $title
* @return string html
*/
function resourcelib_embed_image($fullurl, $title) {
$code = '';
$code .= '<div class="resourcecontent resourceimg">';
$code .= "<img title=\"".strip_tags(format_string($title))."\" class=\"resourceimage\" src=\"$fullurl\" alt=\"\" />";
$code .= '</div>';
return $code;
}
/**
* Returns mp3 embedding html.
* @param string $fullurl
* @param string $title
* @param string $clicktoopen
* @return string html
*/
function resourcelib_embed_mp3($fullurl, $title, $clicktoopen) {
if ($fullurl instanceof moodle_url) {
$fullurl = $fullurl->out(false);
} else {
$fullurl = str_replace('&', '&', $fullurl);
}
$id = 'resource_mp3_'.time(); //we need something unique because it might be stored in text cache
// note: size is specified in theme, it can be made as wide as necessary, but the height can not be changed
$output = '<div class="resourcecontent resourcemp3">';
$output .= html_writer::tag('span', $clicktoopen, array('id'=>$id, 'class'=>'resourcemediaplugin resourcemediaplugin_mp3', 'title'=>$title));
$output .= html_writer::script(js_writer::function_call('M.util.add_audio_player', array($id, $fullurl, false)));
$output .= '</div>';
return $output;
}
/**
* Returns flash video embedding html.
* @param string $fullurl
* @param string $title
* @param string $clicktoopen
* @return string html
*/
function resourcelib_embed_flashvideo($fullurl, $title, $clicktoopen) {
global $CFG, $PAGE;
if ($fullurl instanceof moodle_url) {
$fullurl = $fullurl->out(false);
} else {
$fullurl = str_replace('&', '&', $fullurl);
}
$id = 'resource_flv_'.time(); //we need something unique because it might be stored in text cache
//note: nobody should be adding any dimensions to themes!!!
if (preg_match('/\?d=([\d]{1,4}%?)x([\d]{1,4}%?)/', $fullurl, $matches)) {
$width = $matches[1];
$height = $matches[2];
$autosize = false;
} else {
$width = 400;
$height = 300;
$autosize = true;
}
$output = '<div class="resourcecontent resourceflv">';
$output .= html_writer::tag('span', $clicktoopen, array('id'=>$id, 'class'=>'resourcemediaplugin resourcemediaplugin_flv', 'title'=>$title));
$output .= html_writer::script(js_writer::function_call('M.util.add_video_player', array($id, rawurlencode($fullurl), $width, $height, $autosize)));
$output .= '</div>';
return $output;
}
/**
* Returns flash embedding html.
* @param string $fullurl
* @param string $title
* @param string $clicktoopen
* @return string html
*/
function resourcelib_embed_flash($fullurl, $title, $clicktoopen) {
if (preg_match('/[#\?]d=([\d]{1,4}%?)x([\d]{1,4}%?)/', $fullurl, $matches)) {
$width = $matches[1];
$height = $matches[2];
} else {
$width = 400;
$height = 300;
}
$code = <<<EOT
<div class="resourcecontent resourceswf">
<object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" width="$width" height="$height">
<param name="movie" value="$fullurl" />
<param name="autoplay" value="true" />
<param name="loop" value="true" />
<param name="controller" value="true" />
<param name="scale" value="aspect" />
<param name="base" value="." />
<!--[if !IE]>-->
<object type="application/x-shockwave-flash" data="$fullurl" width="$width" height="$height">
<param name="controller" value="true" />
<param name="autoplay" value="true" />
<param name="loop" value="true" />
<param name="scale" value="aspect" />
<param name="base" value="." />
<!--<![endif]-->
$clicktoopen
<!--[if !IE]>-->
</object>
<!--<![endif]-->
</object>
</div>
EOT;
return $code;
}
/**
* Returns ms media embedding html.
* @param string $fullurl
* @param string $title
* @param string $clicktoopen
* @return string html
*/
function resourcelib_embed_mediaplayer($fullurl, $title, $clicktoopen) {
$code = <<<EOT
<div class="resourcecontent resourcewmv">
<object type="video/x-ms-wmv" data="$fullurl">
<param name="controller" value="true" />
<param name="autostart" value="true" />
<param name="src" value="$fullurl" />
<param name="scale" value="noScale" />
$clicktoopen
</object>
</div>
EOT;
return $code;
}
/**
* Returns quicktime embedding html.
* @param string $fullurl
* @param string $title
* @param string $clicktoopen
* @return string html
*/
function resourcelib_embed_quicktime($fullurl, $title, $clicktoopen) {
$code = <<<EOT
<div class="resourcecontent resourceqt">
<object classid="clsid:02BF25D5-8C17-4B23-BC80-D3488ABDDC6B" codebase="http://www.apple.com/qtactivex/qtplugin.cab">
<param name="src" value="$fullurl" />
<param name="autoplay" value="true" />
<param name="loop" value="true" />
<param name="controller" value="true" />
<param name="scale" value="aspect" />
<!--[if !IE]>-->
<object type="video/quicktime" data="$fullurl">
<param name="controller" value="true" />
<param name="autoplay" value="true" />
<param name="loop" value="true" />
<param name="scale" value="aspect" />
<!--<![endif]-->
$clicktoopen
<!--[if !IE]>-->
</object>
<!--<![endif]-->
</object>
</div>
EOT;
return $code;
}
/**
* Returns mpeg embedding html.
* @param string $fullurl
* @param string $title
* @param string $clicktoopen
* @return string html
*/
function resourcelib_embed_mpeg($fullurl, $title, $clicktoopen) {
$code = <<<EOT
<div class="resourcecontent resourcempeg">
<object classid="CLSID:22d6f312-b0f6-11d0-94ab-0080c74c7e95" codebase="http://activex.microsoft.com/activex/controls/mplayer/en/nsm p2inf.cab#Version=5,1,52,701" type="application/x-oleobject">
<param name="fileName" value="$fullurl" />
<param name="autoStart" value="true" />
<param name="animationatStart" value="true" />
<param name="transparentatStart" value="true" />
<param name="showControls" value="true" />
<param name="Volume" value="-450" />
<!--[if !IE]>-->
<object type="video/mpeg" data="$fullurl">
<param name="controller" value="true" />
<param name="autostart" value="true" />
<param name="src" value="$fullurl" />
<!--<![endif]-->
$clicktoopen
<!--[if !IE]>-->
</object>
<!--<![endif]-->
</object>
</div>
EOT;
return $code;
}
/**
* Returns real media embedding html.
* @param string $fullurl
* @param string $title
* @param string $clicktoopen
* @return string html
*/
function resourcelib_embed_real($fullurl, $title, $clicktoopen) {
$code = <<<EOT
<div class="resourcecontent resourcerm">
<object classid="clsid:CFCDAA03-8BE4-11cf-B84B-0020AFBBCCFA" data="$fullurl" width="320" height="240">
<param name="src" value="$fullurl" />
<param name="controls" value="All" />
<!--[if !IE]>-->
<object type="audio/x-pn-realaudio-plugin" data="$fullurl" width="320" height="240">
<param name="src" value="$fullurl" />
<param name="controls" value="All" />
<!--<![endif]-->
$clicktoopen
<!--[if !IE]>-->
</object>
<!--<![endif]-->
</object>
</div>
EOT;
return $code;
}
/**
* Returns general link or pdf embedding html.
* @param string $fullurl
* @param string $title
* @param string $clicktoopen
* @return string html
*/
function resourcelib_embed_pdf($fullurl, $title, $clicktoopen) {
global $CFG, $PAGE;
$code = <<<EOT
<div class="resourcecontent resourcepdf">
<object id="resourceobject" data="$fullurl" type="application/pdf" width="800" height="600">
<param name="src" value="$fullurl" />
$clicktoopen
</object>
</div>
EOT;
// the size is hardcoded in the boject obove intentionally because it is adjusted by the following function on-the-fly
$PAGE->requires->js_init_call('M.util.init_maximised_embed', array('resourceobject'), true);
return $code;
}
/**
* Returns general link or file embedding html.
* @param string $fullurl
* @param string $title
* @param string $clicktoopen
* @param string $mimetype
* @return string html
*/
function resourcelib_embed_general($fullurl, $title, $clicktoopen, $mimetype) {
global $CFG, $PAGE;
if ($fullurl instanceof moodle_url) {
$fullurl = $fullurl->out();
}
$iframe = false;
$param = '<param name="src" value="'.$fullurl.'" />';
// IE can not embed stuff properly, that is why we use iframe instead.
// Unfortunately this tag does not validate in xhtml strict mode,
// but in any case it is undeprecated in HTML 5 - we will use it everywhere soon!
if ($mimetype === 'text/html' and check_browser_version('MSIE', 5)) {
$iframe = true;
}
if ($iframe) {
$code = <<<EOT
<div class="resourcecontent resourcegeneral">
<iframe id="resourceobject" src="$fullurl">
$clicktoopen
</iframe>
</div>
EOT;
} else {
$code = <<<EOT
<div class="resourcecontent resourcegeneral">
<object id="resourceobject" data="$fullurl" type="$mimetype" width="800" height="600">
$param
$clicktoopen
</object>
</div>
EOT;
}
// the size is hardcoded in the boject obove intentionally because it is adjusted by the following function on-the-fly
$PAGE->requires->js_init_call('M.util.init_maximised_embed', array('resourceobject'), true);
return $code;
}