MDL-16089 some resource lib and lang pack cleanup
[moodle.git] / lib / resourcelib.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  * Recourse module like helper functions
20  *
21  * @package   moodlecore
22  * @copyright 2009 Petr Skoda (http://skodak.org)
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 /** Try the best way */
27 define('RESOURCELIB_DISPLAY_AUTO', 0);
28 /** Display using object tag */
29 define('RESOURCELIB_DISPLAY_EMBED', 1);
30 /** Display inside frame */
31 define('RESOURCELIB_DISPLAY_FRAME', 2);
32 /** Display normal link in new window */
33 define('RESOURCELIB_DISPLAY_NEW', 3);
34 /** Force download of file instead of display */
35 define('RESOURCELIB_DISPLAY_DOWNLOAD', 4);
36 /** Open directly */
37 define('RESOURCELIB_DISPLAY_OPEN', 5);
38 /** Open in "emulated" pop-up without navigation */
39 define('RESOURCELIB_DISPLAY_POPUP', 6);
41 /** Legacy files not needed or new resource */
42 define('RESOURCELIB_LEGACYFILES_NO', 0);
43 /** Legacy files conversion marked as completed */
44 define('RESOURCE_LEGACYYFILES_DONE', 1);
45 /** Legacy files conversion in progress*/
46 define('RESOURCELIB_LEGACYFILES_ACTIVE', 2);
49 /**
50  * Try on demand migration of file from old course files
51  * @param string $filepath old file path
52  * @param int $cmid migrated course module if
53  * @param int $courseid
54  * @param string $filearea new file area
55  * @param int $itemid migrated file item id
56  * @return mixed, false if not found, stored_file instance if migrated to new area
57  */
58 function resourcelib_try_file_migration($filepath, $cmid, $courseid, $filearea, $itemid) {
59     $fs = get_file_storage();
61     if (stripos($filepath, '/backupdata/') === 0 or stripos($filepath, '/moddata/') === 0) {
62         // do not steal protected files!
63         return false;
64     }
66     if (!$context = get_context_instance(CONTEXT_MODULE, $cmid)) {
67         return false;
68     }
69     if (!$coursecontext = get_context_instance(CONTEXT_COURSE, $courseid)) {
70         return false;
71     }
73     $pathnamehash = sha1($coursecontext->id.'course_content0'.$filepath);
74     if (!$file = $fs->get_file_by_hash($pathnamehash)) {
75         return false;
76     }
78     // copy and keep the same path, name, etc.
79     $file_record = array('contextid'=>$context->id, 'filearea'=>$filearea, 'itemid'=>$itemid);
80     try {
81         return $fs->create_file_from_storedfile($file_record, $file);
82     } catch (Exception $e) {
83         // file may exist - highly unlikely, we do not want upgrades to stop here
84         return false;
85     }
86 }
88 /**
89  * Returns list of available display options
90  * @param array $enabled list of options enabled in module configuration
91  * @param int $current current display options for existing instances
92  * @return array of key=>name pairs
93  */
94 function resourcelib_get_displayoptions(array $enabled, $current=null) {
95     if (is_number($current)) {
96         $enabled[] = $current;
97     }
99     $options = array(RESOURCELIB_DISPLAY_AUTO     => get_string('resourcedisplayauto'),
100                      RESOURCELIB_DISPLAY_EMBED    => get_string('resourcedisplayembed'),
101                      RESOURCELIB_DISPLAY_FRAME    => get_string('resourcedisplayframe'),
102                      RESOURCELIB_DISPLAY_NEW      => get_string('resourcedisplaynew'),
103                      RESOURCELIB_DISPLAY_DOWNLOAD => get_string('resourcedisplaydownload'),
104                      RESOURCELIB_DISPLAY_OPEN     => get_string('resourcedisplayopen'),
105                      RESOURCELIB_DISPLAY_POPUP    => get_string('resourcedisplaypopup'));
107     $result = array();
109     foreach ($options as $key=>$value) {
110         if (in_array($key, $enabled)) {
111             $result[$key] = $value;
112         }
113     }
115     if (empty($result)) {
116         // there should be always something in case admin misconfigures module
117         $result[RESOURCELIB_DISPLAY_OPEN] = $options[RESOURCELIB_DISPLAY_OPEN];
118     }
120     return $result;
123 /**
124  * Tries to guess correct mimetype for arbitrary URL
125  * @param string $fullurl
126  * @return string mimetype
127  */
128 function resourcelib_guess_url_mimetype($fullurl) {
129     global $CFG;
130     require_once("$CFG->libdir/filelib.php");
132     if (preg_match("|^(.*)/[a-z]*file.php(\?file=)?(/[^&\?]*)|", $fullurl, $matches)) {
133         // remove the special moodle file serving hacks so that the *file.php is ignored
134         $fullurl = $matches[1].$matches[3];
135     }
137     if (strpos($fullurl, '.php')){
138         // we do not really know what is in general php script
139         return 'text/html';
141     } else if (substr($fullurl, -1) === '/') {
142         // directory index (http://example.com/smaples/)
143         return 'text/html';
145     } else if (strpos($fullurl, '//') !== false and substr_count($fullurl, '/') == 2) {
146         // just a host name (http://example.com), solves Australian servers "audio" problem too
147         return 'text/html';
149     } else {
150         // ok, this finally looks like a real file
151         return mimeinfo('type', $fullurl);
152     }
155 /**
156  * Returns image embedding html.
157  * @param string $fullurl
158  * @param string $title
159  * @return string html
160  */
161 function resourcelib_embed_image($fullurl, $title) {
162     $code = '';
163     $code .= '<div class="resourcecontent resourceimg">';
164     $code .= "<img title=\"".strip_tags(format_string($title))."\" class=\"resourceimage\" src=\"$fullurl\" alt=\"\" />";
165     $code .= '</div>';
167     return $code;
170 /**
171  * Returns mp3 embedding html.
172  * @param string $fullurl
173  * @param string $title
174  * @param string $clicktoopen
175  * @return string html
176  */
177 function resourcelib_embed_mp3($fullurl, $title, $clicktoopen) {
178     global $CFG, $OUTPUT, $PAGE;
180     $c = $OUTPUT->resource_mp3player_colors();   // You can set this up in your theme/xxx/config.php
182     $c .= '&volText='.get_string('vol', 'resource').'&panText='.get_string('pan','resource');
183     $id = 'filter_mp3_'.time(); //we need something unique because it might be stored in text cache
185     $ufoargs = array('movie'        => $CFG->wwwroot.'/lib/mp3player/mp3player.swf?src='.urlencode($fullurl),
186                      'width'        => 600,
187                      'height'       => 70,
188                      'majorversion' => 6,
189                      'build'        => 40,
190                      'flashvars'    => $c,
191                      'quality'      => 'high');
193     // If we have Javascript, use UFO to embed the MP3 player, otherwise depend on plugins
194     $code = <<<OET
195 <div class="resourcecontent resourcemp3">
196   <span class="mediaplugin mediaplugin_mp3" id="$id"></span>
197   <noscript>
198     <object type="audio/mpeg" data="$fullurl" width="600" height="70">
199       <param name="src" value="$fullurl" />
200       <param name="quality" value="high" />
201       <param name="autoplay" value="true" />
202       <param name="autostart" value="true" />
203     </object>
204     $clicktoopen
205   </noscript>
206 </div>
207 OET;
209     $PAGE->requires->js('/lib/ufo.js');
210     $code .= $PAGE->requires->js_function_call('M.util.create_UFO_object', array($id, $ufoargs));
211     return $code;
214 /**
215  * Returns flash video embedding html.
216  * @param string $fullurl
217  * @param string $title
218  * @param string $clicktoopen
219  * @return string html
220  */
221 function resourcelib_embed_flashvideo($fullurl, $title, $clicktoopen) {
222     global $CFG, $PAGE;
224     $id = 'filter_flv_'.time(); //we need something unique because it might be stored in text cache
226     $ufoargs = array('movie'             => $CFG->wwwroot.'/filter/mediaplugin/flvplayer.swf?file='.urlencode($fullurl),
227                      'width'             => 600,
228                      'height'            => 400,
229                      'majorversion'      => 6,
230                      'build'             => 40,
231                      'allowscriptaccess' => 'never',
232                      'allowfullscreen'   => 'true',
233                      'quality'           => 'high');
235     // If we have Javascript, use UFO to embed the FLV player, otherwise depend on plugins
237     $code = <<<EOT
238 <div class="resourcecontent resourceflv">
239   <span class="mediaplugin mediaplugin_flv" id="$id"></span>
240   <noscript>
241     <object type="video/x-flv" data="$fullurl" width="600" height="400">
242       <param name="src" value="$fullurl" />
243       <param name="quality" value="high" />
244       <param name="autoplay" value="true" />
245       <param name="autostart" value="true" />
246     </object>
247     $clicktoopen
248   </noscript>
249 </div>
250 EOT;
252     $PAGE->requires->js('/lib/ufo.js');
253     $code .= $PAGE->requires->js_function_call('M.util.create_UFO_object', array($id, $ufoargs));
254     return $code;
257 /**
258  * Returns flash embedding html.
259  * @param string $fullurl
260  * @param string $title
261  * @param string $clicktoopen
262  * @return string html
263  */
264 function resourcelib_embed_flash($fullurl, $title, $clicktoopen) {
265     $code = <<<EOT
266 <div class="resourcecontent resourceswf">
267   <object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000">
268     <param name="movie" value="$fullurl" />
269     <param name="autoplay" value="true" />
270     <param name="loop" value="true" />
271     <param name="controller" value="true" />
272     <param name="scale" value="aspect" />
273     <param name="base" value="." />
274 <!--[if !IE]>-->
275     <object type="application/x-shockwave-flash" data="$fullurl">
276       <param name="controller" value="true" />
277       <param name="autoplay" value="true" />
278       <param name="loop" value="true" />
279       <param name="scale" value="aspect" />
280       <param name="base" value="." />
281 <!--<![endif]-->
282 $clicktoopen
283 <!--[if !IE]>-->
284     </object>
285 <!--<![endif]-->
286   </object>
287 </div>
288 EOT;
290     return $code;
293 /**
294  * Returns ms media embedding html.
295  * @param string $fullurl
296  * @param string $title
297  * @param string $clicktoopen
298  * @return string html
299  */
300 function resourcelib_embed_mediaplayer($fullurl, $title, $clicktoopen) {
301     $code = <<<EOT
302 <div class="resourcecontent resourcewmv">
303   <object type="video/x-ms-wmv" data="$fullurl">
304     <param name="controller" value="true" />
305     <param name="autostart" value="true" />
306     <param name="src" value="$fullurl" />
307     <param name="scale" value="noScale" />
308     $clicktoopen
309   </object>
310 </div>
311 EOT;
313     return $code;
316 /**
317  * Returns quicktime embedding html.
318  * @param string $fullurl
319  * @param string $title
320  * @param string $clicktoopen
321  * @return string html
322  */
323 function resourcelib_embed_quicktime($fullurl, $title, $clicktoopen) {
324     $code = <<<EOT
325 <div class="resourcecontent resourceqt">
326   <object classid="clsid:02BF25D5-8C17-4B23-BC80-D3488ABDDC6B" codebase="http://www.apple.com/qtactivex/qtplugin.cab">
327     <param name="src" value="$fullurl" />
328     <param name="autoplay" value="true" />
329     <param name="loop" value="true" />
330     <param name="controller" value="true" />
331     <param name="scale" value="aspect" />
332 <!--[if !IE]>-->
333     <object type="video/quicktime" data="$fullurl">
334       <param name="controller" value="true" />
335       <param name="autoplay" value="true" />
336       <param name="loop" value="true" />
337       <param name="scale" value="aspect" />
338 <!--<![endif]-->
339 $clicktoopen
340 <!--[if !IE]>-->
341     </object>
342 <!--<![endif]-->
343   </object>
344 </div>
345 EOT;
347     return $code;
350 /**
351  * Returns mpeg embedding html.
352  * @param string $fullurl
353  * @param string $title
354  * @param string $clicktoopen
355  * @return string html
356  */
357 function resourcelib_embed_mpeg($fullurl, $title, $clicktoopen) {
358     $code = <<<EOT
359 <div class="resourcecontent resourcempeg">
360   <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">
361     <param name="fileName" value="$fullurl" />
362     <param name="autoStart" value="true" />
363     <param name="animationatStart" value="true" />
364     <param name="transparentatStart" value="true" />
365     <param name="showControls" value="true" />
366     <param name="Volume" value="-450" />
367 <!--[if !IE]>-->
368     <object type="video/mpeg" data="$fullurl">
369       <param name="controller" value="true" />
370       <param name="autostart" value="true" />
371       <param name="src" value="$fullurl" />
372 <!--<![endif]-->
373 $clicktoopen
374 <!--[if !IE]>-->
375     </object>
376 <!--<![endif]-->
377   </object>
378 </div>
379 EOT;
381     return $code;
384 /**
385  * Returns real media embedding html.
386  * @param string $fullurl
387  * @param string $title
388  * @param string $clicktoopen
389  * @return string html
390  */
391 function resourcelib_embed_real($fullurl, $title, $clicktoopen) {
392     $code = <<<EOT
393 <div class="resourcecontent resourcerm">
394   <object classid="clsid:CFCDAA03-8BE4-11cf-B84B-0020AFBBCCFA" width="320" height="240">
395     <param name="src" value="$fullurl" />
396     <param name="controls" value="All" />
397 <!--[if !IE]>-->
398     <object type="audio/x-pn-realaudio-plugin" data="$fullurl" width="320" height="240">
399       <param name="controls" value="All" />
400 <!--<![endif]-->
401 $clicktoopen
402 <!--[if !IE]>-->
403     </object>
404 <!--<![endif]-->
405   </object>
406 </div>
407 EOT;
409     return $code;
412 /**
413  * Returns general link or file embedding html.
414  * @param string $fullurl
415  * @param string $title
416  * @param string $clicktoopen
417  * @return string html
418  */
419 function resourcelib_embed_general($fullurl, $title, $clicktoopen, $mimetype) {
420     global $CFG, $PAGE;
422     $iframe = false;
423     // IE can not embed stuff properly if stored on different server
424     // that is why we use iframe instead, unfortunately this tag does not validate
425     // in xhtml strict mode
426     if ($mimetype === 'text/html' and check_browser_version('MSIE', 5)) {
427         if (preg_match('(^https?://[^/]*)', $fullurl, $matches)) {
428             if (strpos($CFG->wwwroot, $matches[0]) !== 0) {
429                 $iframe = true;
430             }
431         }
432     }
434     if ($iframe) {
435         $code = <<<EOT
436 <div class="resourcecontent resourcegeneral">
437   <iframe id="resourceobject" src="$fullurl">
438     $clicktoopen
439   </iframe>
440 </div>
441 EOT;
442     } else {
443         $code = <<<EOT
444 <div class="resourcecontent resourcegeneral">
445   <object id="resourceobject" data="$fullurl" type="$mimetype">
446     <param name="src" value="$fullurl" />
447     $clicktoopen
448   </object>
449 </div>
450 EOT;
451         $PAGE->requires->js_init_call('M.util.init_maximised_embed', array('resourceobject'), true);
452     }
454     return $code;