lib.php 18.8 KB
Newer Older
Penny Leach's avatar
Penny Leach committed
1
2
3
4
5
<?php
/**
 *
 * @package    mahara
 * @subpackage blocktype-internalmedia
6
 * @author     Catalyst IT Ltd
7
8
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
 * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
Penny Leach's avatar
Penny Leach committed
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 *
 */

defined('INTERNAL') || die();

class PluginBlocktypeInternalmedia extends PluginBlocktype {

    public static function get_title() {
        return get_string('title', 'blocktype.file/internalmedia');
    }

    public static function get_description() {
        return get_string('description', 'blocktype.file/internalmedia');
    }

    public static function get_categories() {
25
        return array('fileimagevideo');
Penny Leach's avatar
Penny Leach committed
26
27
28
29
30
31
32
33
    }

    public static function has_config() {
        return true;
    }

    public static function postinst($oldversion) {
        if ($oldversion == 0) {
34
            set_config_plugin('blocktype', 'internalmedia', 'enabledtypes', serialize(array('flv', 'mp3')));
Penny Leach's avatar
Penny Leach committed
35
36
37
        }
    }

38
    public static function render_instance(BlockInstance $instance, $editing=false) {
Penny Leach's avatar
Penny Leach committed
39
40
41
42
43
44
        $configdata = $instance->get('configdata');

        if (empty($configdata['artefactid'])) {
            return '';
        }
        $result = self::get_js_source();
45
        require_once(get_config('docroot') . 'artefact/lib.php');
46
        $artefact = $instance->get_artefact_instance($configdata['artefactid']);
47
48
49
50
51
52
        $defaultwidth = get_config_plugin('blocktype', 'internalmedia', 'width') ?
                get_config_plugin('blocktype', 'internalmedia', 'width') : 300;
        $defaultheight = get_config_plugin('blocktype', 'internalmedia', 'height') ?
                get_config_plugin('blocktype', 'internalmedia', 'height') : 300;
        $width  = (!empty($configdata['width'])) ? hsc($configdata['width']) : $defaultwidth;
        $height = (!empty($configdata['height'])) ? hsc($configdata['height']) : $defaultheight;
53
54
55
        $mimetype = $artefact->get('filetype');
        $mimetypefiletypes = self::get_allowed_mimetype_filetypes();
        if (!isset($mimetypefiletypes[$mimetype])) {
56
            return get_string('typeremoved', 'blocktype.file/internalmedia');
Penny Leach's avatar
Penny Leach committed
57
        }
58
        $callbacks = self::get_all_filetype_players();
59
        $result .= '<div class="mediaplayer-container center"><div class="mediaplayer">' . call_static_method('PluginBlocktypeInternalmedia', $callbacks[$mimetypefiletypes[$mimetype]], $artefact, $instance, $width, $height) . '</div></div>';
Penny Leach's avatar
Penny Leach committed
60
61
62
63
64
65
66
        return $result;
    }

    public static function has_instance_config() {
        return true;
    }

67
68
69
70
71
72
73
    public static function get_instance_config_javascript() {
        $result = self::get_js_source(true);
        if (!empty($result)) {
            return $result;
        }
    }

74
    public static function instance_config_form($instance) {
Penny Leach's avatar
Penny Leach committed
75
        $configdata = $instance->get('configdata');
76
77
78
        safe_require('artefact', 'file');
        $instance->set('artefactplugin', 'file');
        return array(
79
            'artefactid' => self::filebrowser_element($instance, (isset($configdata['artefactid'])) ? array($configdata['artefactid']) : null),
80
            'width' => array(
Penny Leach's avatar
Penny Leach committed
81
82
83
84
                'type' => 'text',
                'title' => get_string('width'),
                'size' => 3,
                'defaultvalue' => (isset($configdata['width'])) ? $configdata['width'] : '',
85
                'rules' => array('minvalue' => 1, 'maxvalue' => 2000),
86
87
            ),
            'height' => array(
Penny Leach's avatar
Penny Leach committed
88
89
90
91
                'type' => 'text',
                'title' => get_string('height'),
                'size' => 3,
                'defaultvalue' => (isset($configdata['height'])) ? $configdata['height'] : '',
92
                'rules' => array('minvalue' => 1, 'maxvalue' => 2000),
93
            ),
Penny Leach's avatar
Penny Leach committed
94
        );
95
96
    }

97
98
    public static function filebrowser_element(&$instance, $default=array()) {
        $element = ArtefactTypeFileBase::blockconfig_filebrowser_element($instance, $default);
99
        $element['title'] = get_string('media', 'blocktype.file/internalmedia');
100
        $element['name'] = 'artefactid';
101
102
        $element['config']['selectone'] = true;
        $element['filters'] = array(
103
            'artefacttype'    => array('file', 'audio', 'video'),
104
            'filetype'        => self::get_allowed_mimetypes(),
105
106
107
108
        );
        return $element;
    }

109
    public static function artefactchooser_element($default=null) {
Penny Leach's avatar
Penny Leach committed
110
111
112
113
114
115
116
117
        return array(
            'name' => 'artefactid',
            'type'  => 'artefactchooser',
            'title' => get_string('media', 'blocktype.file/internalmedia'),
            'defaultvalue' => $default,
            'blocktype' => 'internalmedia',
            'limit' => 5,
            'selectone' => true,
118
            'artefacttypes' => array('file', 'audio', 'video'),
Penny Leach's avatar
Penny Leach committed
119
120
121
122
            'template' => 'artefact:file:artefactchooser-element.tpl',
        );
    }

123
124
125
126
127
    public static function artefactchooser_get_element_data($artefact) {
        $artefact->icon = call_static_method(generate_artefact_class_name($artefact->artefacttype), 'get_icon', array('id' => $artefact->id));
        return $artefact;
    }

128
    public static function save_config_options($form, $values) {
Penny Leach's avatar
Penny Leach committed
129
130
        $enabledtypes = array();
        foreach ($values as $type => $enabled) {
131
            if (!in_array($type, self::get_all_filetypes())) {
132
133
                continue;
            }
Penny Leach's avatar
Penny Leach committed
134
135
136
137
138
            if (!empty($enabled)) {
                $enabledtypes[] = $type;
            }
        }
        set_config_plugin('blocktype', 'internalmedia', 'enabledtypes', serialize($enabledtypes));
139
140
        set_config_plugin('blocktype', 'internalmedia', 'height', $values['height']);
        set_config_plugin('blocktype', 'internalmedia', 'width',  $values['width']);
Penny Leach's avatar
Penny Leach committed
141
142
143
144
145
146
    }

    public static function get_config_options() {
        $elements = array();
        // Allowed file types
        $filetypes = array();
147
        $currenttypes = self::get_allowed_filetypes();
Penny Leach's avatar
Penny Leach committed
148

149
        foreach (self::get_all_filetypes() as $filetype) {
150
151
152
153
154
            $filetypes[$filetype] = array(
                'type'  => 'checkbox',
                'title' => get_string($filetype, 'artefact.file'),
                'defaultvalue' => in_array($filetype, $currenttypes),
            );
Penny Leach's avatar
Penny Leach committed
155
156
        }
        uasort($filetypes, create_function('$a, $b', 'return $a["title"] > $b["title"];'));
157
        $options = array_merge(
Penny Leach's avatar
Penny Leach committed
158
159
            array(
                'description' => array(
160
                    'value' => get_string('configdesc', 'blocktype.file/internalmedia'),
Penny Leach's avatar
Penny Leach committed
161
162
163
164
                ),
            ),
            $filetypes
        );
165
166
167
168
169
170
171
172
173
174
175
176
177
178
        $options['height'] = array(
            'type'          => 'text',
            'title'         => get_string('height'),
            'rules'        => array('integer' => true, 'minvalue' => 120, 'maxvalue' => 3072),
            'defaultvalue'  => get_config_plugin('blocktype', 'internalmedia', 'height')
                ? get_config_plugin('blocktype', 'internalmedia', 'height') : 240,
        );
        $options['width'] = array(
            'type'          => 'text',
            'title'         => get_string('width'),
            'rules'        => array('integer' => true, 'minvalue' => 160, 'maxvalue' => 4096),
            'defaultvalue'  => get_config_plugin('blocktype', 'internalmedia', 'width')
                ? get_config_plugin('blocktype', 'internalmedia', 'width') : 320,
        );
Penny Leach's avatar
Penny Leach committed
179
180

        return array(
181
            'elements' => $options,
Penny Leach's avatar
Penny Leach committed
182
183
184
185
            'renderer' => 'table'
        );
    }

186
187

    private static function get_allowed_filetypes() {
Penny Leach's avatar
Penny Leach committed
188
189
190
191
192
193
        if ($data = get_config_plugin('blocktype', 'internalmedia', 'enabledtypes')) {
            return unserialize($data);
        }
        return array();
    }

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

    private static function get_allowed_mimetypes() {
        return array_keys(self::get_allowed_mimetype_filetypes());
    }


    private static function get_allowed_mimetype_filetypes() {
        if ($data = self::get_allowed_filetypes()) {
            if ($mimetypes = get_records_sql_assoc('
                SELECT mimetype, description
                FROM {artefact_file_mime_types}
                WHERE description IN (' . join(',', array_map('db_quote', $data)) . ')', array())) {
                foreach ($mimetypes as &$m) {
                    $m = $m->description;
                }
                return $mimetypes;
            }
        }
        return array();
    }


    private static function get_all_filetypes() {
        return array_keys(self::get_all_filetype_players());
    }


    private static function get_all_filetype_players() {
        /* Keyed by the file type descriptions from the artefact_file_mime_types table */
Penny Leach's avatar
Penny Leach committed
223
        return array(
224
            'mp3'       => 'flow_player', // tested
225
            'swf'       => 'flash_player', // tested
226
            'flv'       => 'flow_player', // tested
227
228
229
230
            'quicktime' => 'qt_player',  // tested
            'wmv'       => 'wmp_player', // tested
            'mpeg'      => 'qt_player',  // tested
            'avi'       => 'wmp_player', // tested
231
            'mp4_video' => 'flow_player', // tested
232
            /* commenting out for now
Penny Leach's avatar
Penny Leach committed
233
234
235
            'ram'   => 'real_player',
            'rm'    => 'real_player',
            'rpm'   => 'real_player',
236
            */
Penny Leach's avatar
Penny Leach committed
237
238
239
240
241
242
243
244
        );
    }

    public static function flash_player($artefact, $block, $width, $height) {
        static $count = 0;
        $count++;
        $id = 'blocktype_internalmedia_flash_' . time() . $count;
        $url = self::get_download_link($artefact, $block);
245
        $params = array('play' => 'true');
246
        $html =  '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>
247
               <span class="blocktype_internalmedia_mp3" id="' . $id . '">('
248
               . get_string('flashanimation', 'blocktype.file/internalmedia') . ')</span>
Penny Leach's avatar
Penny Leach committed
249
                <script type="text/javascript">
250
                    var so = new SWFObject("' . $url . '","player","' . $width . '","' . ($height + 20). '","7");
Penny Leach's avatar
Penny Leach committed
251
252
                    so.addParam("allowfullscreen","false");
                    so.addVariable("displayheight"," ' . $height . '");
253
                    so.addVariable("type", "swf");
Penny Leach's avatar
Penny Leach committed
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
                    so.addVariable("height", "' . $height . '");
                    so.addVariable("width", "' . $width . '");
                ';
        foreach ($params as $key => $value) {
            $html .= '      so.addParam("' . $key . '", "' . $value . '"); '. "\n";
        }

        $html .= '
                    so.write("' . $id . '");
                </script>
        ';
        return $html;

    }

269
270
271
272
273
274
275
    public static function flow_player($artefact, $block, $width, $height) {
        static $count = 0;
        $count++;
        $extn = $artefact->get('oldextension');

        $id = 'blocktype_internalmedia_flow_' . time() . $count;
        $url = self::get_download_link($artefact, $block);
276
        $url = parse_url($url, PHP_URL_PATH) . '?' . parse_url($url, PHP_URL_QUERY);
277
        $escapedurl = str_replace('&', '%26', $url); // Flash needs these escaped
278

279
280
        $baseurlpath = parse_url(get_config('wwwroot'), PHP_URL_PATH);
        $baseurl = $baseurlpath . 'artefact/file/blocktype/internalmedia/';
281

282
        $playerurl = $baseurl . 'mahara-flashplayer/mahara-flashplayer.swf';
283
284
285
286
287
288
289
290
291
292
        $autohide = 'true';
        $type = '';
        $audio = '';
        $buffering = 'true';
        if ($extn == 'mp3') {
            $height = 25; // only show the controls
            $autohide = 'false';
            $type = 'type: "audio",'; // force the player to use the audio plugin
            $buffering = 'false'; // without this autoPlay will also be set to true
            $audio = ', audio: {
293
		                  url: "' . $baseurl . 'flowplayer.audio/flowplayer.audio-3.2.11.swf"
294
295
296
297
		             }';
        }

        $html =  '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>
298
299
               <span class="blocktype_internalmedia_mp3" id="' . $id . '" style="display:block;width:'.$width.'px;height:'.$height.'px;"></span>
               <span id="' . $id . '_h">' . get_string('flashanimation', 'blocktype.file/internalmedia') . '</span>
300
301
302
               <script type="text/javascript">
               flowplayer("'.$id.'", "'.$playerurl.'", {
                   clip:  {
303
                       url: "'.$escapedurl.'",
304
305
306
307
308
309
                       '.$type.'
                       autoPlay: false,
                       autoBuffering: '.$buffering.'
                   },
                   plugins: {
	                  controls: {
310
                          url: "mahara-flashplayer.controls.swf",
311
312
313
314
315
316
                          play:true,
                          volume:true,
                          mute:true,
                          time:false,
                          stop:false,
                          playlist:false,
317
                          fullscreen:true,
318
319
320
321
322
                          scrubber: true,
                          autoHide: '.$autohide.'
                      }'.$audio.'
                   }
               }).load();
323
               addElementClass("' . $id . '_h", "hidden");
324
325
326
327
328
329
               </script>
';
        return $html;

    }

Penny Leach's avatar
Penny Leach committed
330
331
332
333
334
    public static function real_player($artefact, $block, $width, $height) {

        $url = self::get_download_link($artefact, $block);

        require_once('file.php');
335
        $mimetype = $artefact->get('filetype');
Penny Leach's avatar
Penny Leach committed
336
337
        $autostart = 'false';

338
        return '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>'
Penny Leach's avatar
Penny Leach committed
339
340
341
342
    . '<span class="blocktype_internalmedia_real">
    <script type="text/javascript">
    //<![CDATA[
    document.write(\'<object classid="clsid:CFCDAA03-8BE4-11cf-B84B-0020AFBBCCFA" width="240" height="180">\\
343
344
345
346
347
348
349
      <param name="src" value="' . $url . '">\\
      <param name="autostart" value="' . $autostart . '">\\
      <param name="controls" value="imagewindow">\\
      <param name="console" value="video">\\
      <param name="loop" value="true">\\
      <embed src="' . $url . '" width=240" height="180" loop="true" type="' . $mimetype . '" controls="imagewindow" console="video" autostart="' . $autostart . '">\\
      </object><br>\\
Penny Leach's avatar
Penny Leach committed
350
      <object classid="clsid:CFCDAA03-8BE4-11cf-B84B-0020AFBBCCFA" width="240" height="30">\\
351
352
353
354
355
      <param name="src" value="' . $url . '">\\
      <param name="autostart" value="' . $autostart . '">\\
      <param name="controls" value="ControlPanel">\\
      <param name="console" value="video">\\
      <embed src="' . $url . '" width="240" height="30" controls="ControlPanel" type="' . $mimetype . '" console="video" autostart="' . $autostart . '">\\
Penny Leach's avatar
Penny Leach committed
356
357
358
359
360
361
362
      </object>\');
    //]]>
    </script></span>';
    }

    public static function wmp_player($artefact, $block, $width, $height) {

363
        $url = hsc(self::get_download_link($artefact, $block, true));
Penny Leach's avatar
Penny Leach committed
364
365
366
367
368
369
370

        $size = 'width="' . $width . '" height="' . $height . '"';
        $autosize = 'false';

        $mimetype = 'video/x-ms-wmv'; // hardcode this
        $autostart = 'false';

371
        return '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>'
Penny Leach's avatar
Penny Leach committed
372
373
374
375
    . '<span class="mediaplugin mediaplugin_wmp">
    <object classid="CLSID:6BF52A52-394A-11d3-B153-00C04F79FAA6" ' . $size . '
      standby="Loading Microsoft(R) Windows(R) Media Player components..."
      type="application/x-oleobject">
376
377
378
379
380
381
382
383
384
385
386
387
     <param name="Filename" value="' . $url . '">' /* hsc($artefact->get('title')) . '"> */ . '
     <param name="src" value="' . $url . '">
     <param name="url" value="' . $url . '">
     <param name="ShowControls" value="true">
     <param name="AutoRewind" value="true">
     <param name="AutoStart" value="' . $autostart . '">
     <param name="Autosize" value="' . $autosize . '">
     <param name="EnableContextMenu" value="true">
     <param name="TransparentAtStart" value="false">
     <param name="AnimationAtStart" value="false">
     <param name="ShowGotoBar" value="false">
     <param name="EnableFullScreenControls" value="true">
388
     <param name="Wmode" value="opaque">
Penny Leach's avatar
Penny Leach committed
389
390
    <!--[if !IE]>-->
      <object data="' . $url . '" type="' . $mimetype . '" ' . $size . '>
391
392
393
394
395
396
       <param name="src" value="' . $url . '">
       <param name="url" value="' . $url . '">
       <param name="controller" value="true">
       <param name="autoplay" value="' . $autostart . '">
       <param name="autostart" value="' . $autostart . '">
       <param name="resize" value="scale">
397
       <param name="wmode" value="opaque">
Penny Leach's avatar
Penny Leach committed
398
399
400
401
402
403
404
405
406
407
408
409
      </object>
    <!--<![endif]-->
    </object></span>';
    }

    public static function qt_player($artefact, $block, $width, $height) {

        $url = self::get_download_link($artefact, $block);

        $size = 'width="' . $width . '" height="' . $height . '"';

        require_once('file.php');
410
        $mimetype = $artefact->get('filetype');
Penny Leach's avatar
Penny Leach committed
411
412
        $autostart = 'false';

413
        return '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>'
Penny Leach's avatar
Penny Leach committed
414
415
416
    . '<span class="mediaplugin mediaplugin_qt">
    <object classid="clsid:02BF25D5-8C17-4B23-BC80-D3488ABDDC6B"
      codebase="http://www.apple.com/qtactivex/qtplugin.cab" ' . $size . '>
417
418
     <param name="pluginspage" value="http://www.apple.com/quicktime/download/">
     <param name="src" value="' . $url . '">
419
     <param name="controller" value="true">
420
421
422
423
     <param name="loop" value="false">
     <param name="autoplay" value="' . $autostart . '">
     <param name="autostart" value="' . $autostart . '">
     <param name="scale" value="aspect">
Penny Leach's avatar
Penny Leach committed
424
425
    <!--[if !IE]>-->
      <object data="' . $url . '" type="' . $mimetype . '" ' . $size . '>
426
427
428
429
430
431
432
       <param name="src" value="'.$url.'">
       <param name="pluginurl" value="http://www.apple.com/quicktime/download/">
       <param name="controller" value="true">
       <param name="loop" value="false">
       <param name="autoplay" value="' . $autostart . '">
       <param name="autostart" value="' . $autostart . '">
       <param name="scale" value="aspect">
Penny Leach's avatar
Penny Leach committed
433
434
435
436
437
438
      </object>
    <!--<![endif]-->
    </object></span>';
    }

    private static function get_download_link(ArtefactTypeFile $artefact, BlockInstance $instance, $wmp=false) {
439
        return get_config('wwwroot') . 'artefact/file/download.php?file='
440
            . $artefact->get('id') . '&view=' . $instance->get('view')
Penny Leach's avatar
Penny Leach committed
441
442
443
            . ($wmp ? '&download=1' : '');
    }

444
    private static function get_js_source($asarray = false) {
Penny Leach's avatar
Penny Leach committed
445
446
447
448
        if (defined('BLOCKTYPE_INTERNALMEDIA_JS_INCLUDED')) {
            return '';
        }
        define('BLOCKTYPE_INTERNALMEDIA_JS_INCLUDED', true);
449
        if ($asarray) {
450
            return array(get_config('wwwroot').'artefact/file/blocktype/internalmedia/mahara-flashplayer/mahara-flashplayer.js',
451
452
453
                         get_config('wwwroot') . 'artefact/file/blocktype/internalmedia/swfobject.js',
                         );
        }
454
        return '<script src="'.get_config('wwwroot').'artefact/file/blocktype/internalmedia/mahara-flashplayer/mahara-flashplayer.js"></script>
455
             <script src="' . get_config('wwwroot') . 'artefact/file/blocktype/internalmedia/swfobject.js" type="text/javascript"></script>';
Penny Leach's avatar
Penny Leach committed
456
457
    }

458
459
460
461
    public static function default_copy_type() {
        return 'full';
    }

Penny Leach's avatar
Penny Leach committed
462
}