7a71e2a99f1456b32b6170d5bc580807b0e80e99
[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  * Returns list of available display options
51  * @param array $enabled list of options enabled in module configuration
52  * @param int $current current display options for existing instances
53  * @return array of key=>name pairs
54  */
55 function resourcelib_get_displayoptions(array $enabled, $current=null) {
56     if (is_number($current)) {
57         $enabled[] = $current;
58     }
60     $options = array(RESOURCELIB_DISPLAY_AUTO     => get_string('displayauto', 'resource'),
61                      RESOURCELIB_DISPLAY_EMBED    => get_string('displayembed', 'resource'),
62                      RESOURCELIB_DISPLAY_FRAME    => get_string('displayframe', 'resource'),
63                      RESOURCELIB_DISPLAY_NEW      => get_string('displaynew', 'resource'),
64                      RESOURCELIB_DISPLAY_DOWNLOAD => get_string('displaydownload', 'resource'),
65                      RESOURCELIB_DISPLAY_OPEN     => get_string('displayopen', 'resource'),
66                      RESOURCELIB_DISPLAY_POPUP    => get_string('displaypopup', 'resource'));
68     $result = array();
70     foreach ($options as $key=>$value) {
71         if (in_array($key, $enabled)) {
72             $result[$key] = $value;
73         }
74     }
76     if (empty($result)) {
77         // there should be always something in case admin misconfigures module
78         $result[RESOURCELIB_DISPLAY_OPEN] = $options[RESOURCELIB_DISPLAY_OPEN];
79     }
81     return $result;
82 }
84 /**
85  * Tries to guess correct mimetype for arbitrary URL
86  * @param string $fullurl
87  * @return string mimetype
88  */
89 function resourcelib_guess_url_mimetype($fullurl) {
90     global $CFG;
91     require_once("$CFG->libdir/filelib.php");
93     if (preg_match("|^(.*)/[a-z]*file.php(\?file=)?(/[^&\?]*)|", $fullurl, $matches)) {
94         // remove the special moodle file serving hacks so that the *file.php is ignored
95         $fullurl = $matches[1].$matches[3];
96     }
98     if (strpos($fullurl, '.php')){
99         // we do not really know what is in general php script
100         return 'text/html';
102     } else if (substr($fullurl, -1) === '/') {
103         // directory index (http://example.com/smaples/)
104         return 'text/html';
106     } else if (strpos($fullurl, '//') !== false and substr_count($fullurl, '/') == 2) {
107         // just a host name (http://example.com), solves Australian servers "audio" problem too
108         return 'text/html';
110     } else {
111         // ok, this finally looks like a real file
112         return mimeinfo('type', $fullurl);
113     }
116 /**
117  * Returns image embedding html.
118  * @param string $fullurl
119  * @param string $title
120  * @return string html
121  */
122 function resourcelib_embed_image($fullurl, $title) {
123     $code = '';
124     $code .= '<div class="resourcecontent resourceimg">';
125     $code .= "<img title=\"".strip_tags(format_string($title))."\" class=\"resourceimage\" src=\"$fullurl\" alt=\"\" />";
126     $code .= '</div>';
128     return $code;
131 /**
132  * Returns mp3 embedding html.
133  * @param string $fullurl
134  * @param string $title
135  * @param string $clicktoopen
136  * @return string html
137  */
138 function resourcelib_embed_mp3($fullurl, $title, $clicktoopen) {
139     global $CFG, $OUTPUT, $PAGE;
141     $c = $OUTPUT->resource_mp3player_colors();   // You can set this up in your theme/xxx/config.php
143     $c .= '&volText='.get_string('vol', 'resource').'&panText='.get_string('pan','resource');
144     $id = 'filter_mp3_'.time(); //we need something unique because it might be stored in text cache
146     $ufoargs = array('movie'        => $CFG->wwwroot.'/lib/mp3player/mp3player.swf?src='.addslashes_js($fullurl),
147                      'width'        => 600,
148                      'height'       => 70,
149                      'majorversion' => 6,
150                      'build'        => 40,
151                      'flashvars'    => $c,
152                      'quality'      => 'high');
154     // If we have Javascript, use UFO to embed the MP3 player, otherwise depend on plugins
155     $code = <<<OET
156 <div class="resourcecontent resourcemp3">
157   <span class="mediaplugin mediaplugin_mp3" id="$id"></span>
158   <noscript>
159     <object type="audio/mpeg" data="$fullurl" width="600" height="70">
160       <param name="src" value="$fullurl" />
161       <param name="quality" value="high" />
162       <param name="autoplay" value="true" />
163       <param name="autostart" value="true" />
164     </object>
165     $clicktoopen
166   </noscript>
167 </div>
168 OET;
170     $PAGE->requires->js('/lib/ufo.js');
171     $code .= $PAGE->requires->js_function_call('M.util.create_UFO_object', array($id, $ufoargs));
172     return $code;
175 /**
176  * Returns flash video embedding html.
177  * @param string $fullurl
178  * @param string $title
179  * @param string $clicktoopen
180  * @return string html
181  */
182 function resourcelib_embed_flashvideo($fullurl, $title, $clicktoopen) {
183     global $CFG, $PAGE;
185     $id = 'filter_flv_'.time(); //we need something unique because it might be stored in text cache
187     $ufoargs = array('movie'             => $CFG->wwwroot.'/filter/mediaplugin/flvplayer.swf?file='.addslashes_js($fullurl),
188                      'width'             => 600,
189                      'height'            => 400,
190                      'majorversion'      => 6,
191                      'build'             => 40,
192                      'allowscriptaccess' => 'never',
193                      'allowfullscreen'   => 'true',
194                      'quality'           => 'high');
196     // If we have Javascript, use UFO to embed the FLV player, otherwise depend on plugins
198     $code = <<<EOT
199 <div class="resourcecontent resourceflv">
200   <span class="mediaplugin mediaplugin_flv" id="$id"></span>
201   <noscript>
202     <object type="video/x-flv" data="$fullurl" width="600" height="400">
203       <param name="src" value="$fullurl" />
204       <param name="quality" value="high" />
205       <param name="autoplay" value="true" />
206       <param name="autostart" value="true" />
207     </object>
208     $clicktoopen
209   </noscript>
210 </div>
211 EOT;
213     $PAGE->requires->js('/lib/ufo.js');
214     $code .= $PAGE->requires->js_function_call('M.util.create_UFO_object', array($id, $ufoargs));
215     return $code;
218 /**
219  * Returns flash embedding html.
220  * @param string $fullurl
221  * @param string $title
222  * @param string $clicktoopen
223  * @return string html
224  */
225 function resourcelib_embed_flash($fullurl, $title, $clicktoopen) {
226     $code = <<<EOT
227 <div class="resourcecontent resourceswf">
228   <object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000">
229     <param name="movie" value="$fullurl" />
230     <param name="autoplay" value="true" />
231     <param name="loop" value="true" />
232     <param name="controller" value="true" />
233     <param name="scale" value="aspect" />
234     <param name="base" value="." />
235 <!--[if !IE]>-->
236     <object type="application/x-shockwave-flash" data="$fullurl">
237       <param name="controller" value="true" />
238       <param name="autoplay" value="true" />
239       <param name="loop" value="true" />
240       <param name="scale" value="aspect" />
241       <param name="base" value="." />
242 <!--<![endif]-->
243 $clicktoopen
244 <!--[if !IE]>-->
245     </object>
246 <!--<![endif]-->
247   </object>
248 </div>
249 EOT;
251     return $code;
254 /**
255  * Returns ms media embedding html.
256  * @param string $fullurl
257  * @param string $title
258  * @param string $clicktoopen
259  * @return string html
260  */
261 function resourcelib_embed_mediaplayer($fullurl, $title, $clicktoopen) {
262     $code = <<<EOT
263 <div class="resourcecontent resourcewmv">
264   <object type="video/x-ms-wmv" data="$fullurl">
265     <param name="controller" value="true" />
266     <param name="autostart" value="true" />
267     <param name="src" value="$fullurl" />
268     <param name="scale" value="noScale" />
269     $clicktoopen
270   </object>
271 </div>
272 EOT;
274     return $code;
277 /**
278  * Returns quicktime embedding html.
279  * @param string $fullurl
280  * @param string $title
281  * @param string $clicktoopen
282  * @return string html
283  */
284 function resourcelib_embed_quicktime($fullurl, $title, $clicktoopen) {
285     $code = <<<EOT
286 <div class="resourcecontent resourceqt">
287   <object classid="clsid:02BF25D5-8C17-4B23-BC80-D3488ABDDC6B" codebase="http://www.apple.com/qtactivex/qtplugin.cab">
288     <param name="src" value="$fullurl" />
289     <param name="autoplay" value="true" />
290     <param name="loop" value="true" />
291     <param name="controller" value="true" />
292     <param name="scale" value="aspect" />
293 <!--[if !IE]>-->
294     <object type="video/quicktime" data="$fullurl">
295       <param name="controller" value="true" />
296       <param name="autoplay" value="true" />
297       <param name="loop" value="true" />
298       <param name="scale" value="aspect" />
299 <!--<![endif]-->
300 $clicktoopen
301 <!--[if !IE]>-->
302     </object>
303 <!--<![endif]-->
304   </object>
305 </div>
306 EOT;
308     return $code;
311 /**
312  * Returns mpeg embedding html.
313  * @param string $fullurl
314  * @param string $title
315  * @param string $clicktoopen
316  * @return string html
317  */
318 function resourcelib_embed_mpeg($fullurl, $title, $clicktoopen) {
319     $code = <<<EOT
320 <div class="resourcecontent resourcempeg">
321   <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">
322     <param name="fileName" value="$fullurl" />
323     <param name="autoStart" value="true" />
324     <param name="animationatStart" value="true" />
325     <param name="transparentatStart" value="true" />
326     <param name="showControls" value="true" />
327     <param name="Volume" value="-450" />
328 <!--[if !IE]>-->
329     <object type="video/mpeg" data="$fullurl">
330       <param name="controller" value="true" />
331       <param name="autostart" value="true" />
332       <param name="src" value="$fullurl" />
333 <!--<![endif]-->
334 $clicktoopen
335 <!--[if !IE]>-->
336     </object>
337 <!--<![endif]-->
338   </object>
339 </div>
340 EOT;
342     return $code;
345 /**
346  * Returns real media embedding html.
347  * @param string $fullurl
348  * @param string $title
349  * @param string $clicktoopen
350  * @return string html
351  */
352 function resourcelib_embed_real($fullurl, $title, $clicktoopen) {
353     $code = <<<EOT
354 <div class="resourcecontent resourcerm">
355   <object classid="clsid:CFCDAA03-8BE4-11cf-B84B-0020AFBBCCFA" width="320" height="240">
356     <param name="src" value="$fullurl" />
357     <param name="controls" value="All" />
358 <!--[if !IE]>-->
359     <object type="audio/x-pn-realaudio-plugin" data="$fullurl" width="320" height="240">
360       <param name="controls" value="All" />
361 <!--<![endif]-->
362 $clicktoopen
363 <!--[if !IE]>-->
364     </object>
365 <!--<![endif]-->
366   </object>
367 </div>
368 EOT;
370     return $code;
373 /**
374  * Returns general link or file embedding html.
375  * @param string $fullurl
376  * @param string $title
377  * @param string $clicktoopen
378  * @return string html
379  */
380 function resourcelib_embed_general($fullurl, $title, $clicktoopen, $mimetype) {
381     global $CFG, $PAGE;
383     $iframe = false;
384     // IE can not embed stuff properly if stored on different server
385     // that is why we use iframe instead, unfortunately this tag does not validate
386     // in xhtml strict mode
387     if ($mimetype === 'text/html' and check_browser_version('MSIE', 5)) {
388         if (preg_match('(^https?://[^/]*)', $fullurl, $matches)) {
389             if (strpos($CFG->wwwroot, $matches[0]) !== 0) {
390                 $iframe = true;
391             }
392         }
393     }
395     if ($iframe) {
396         $code = <<<EOT
397 <div class="resourcecontent resourcegeneral">
398   <iframe id="resourceobject" src="$fullurl">
399     $clicktoopen
400   </iframe>
401 </div>
402 EOT;
403     } else {
404         $code = <<<EOT
405 <div class="resourcecontent resourcegeneral">
406   <object id="resourceobject" data="$fullurl" type="$mimetype">
407     <param name="src" value="$fullurl" />
408     $clicktoopen
409   </object>
410 </div>
411 EOT;
412         $PAGE->requires->js_init_call('M.util.init_maximised_embed', array('resourceobject'), true);
413     }
415     return $code;