lib.php 19 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;
    }

Penny Leach's avatar
Penny Leach committed
128 129 130
    public static function save_config_options($values) {
        $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 246 247 248
        $params = array('play' => 'true',
                        'allowscriptaccess' => 'never',
                        'allownetworking' => 'never'
                       );
249
        $html =  '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>
Penny Leach's avatar
Penny Leach committed
250
               <span class="blocktype_internalmedia_mp3" id="' . $id . '">(' 
251
               . get_string('flashanimation', 'blocktype.file/internalmedia') . ')</span>
Penny Leach's avatar
Penny Leach committed
252
                <script type="text/javascript">
253
                    var so = new SWFObject("' . $url . '&embedded=1","player","' . $width . '","' . ($height + 20). '","7");
Penny Leach's avatar
Penny Leach committed
254 255
                    so.addParam("allowfullscreen","false");
                    so.addVariable("displayheight"," ' . $height . '");
256
                    so.addVariable("type", "swf");
Penny Leach's avatar
Penny Leach committed
257 258
                    so.addVariable("height", "' . $height . '");
                    so.addVariable("width", "' . $width . '");
259
                    so.addVariable("wmode", "transparent");
Penny Leach's avatar
Penny Leach committed
260 261 262 263 264 265 266 267 268 269 270 271 272
                ';
        foreach ($params as $key => $value) {
            $html .= '      so.addParam("' . $key . '", "' . $value . '"); '. "\n";
        }

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

    }

273 274 275 276 277 278 279
    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);
280
        $url = parse_url($url, PHP_URL_PATH) . '?' . parse_url($url, PHP_URL_QUERY);
281
        $escapedurl = str_replace('&', '%26', $url); // Flash needs these escaped
282

283 284
        $baseurlpath = parse_url(get_config('wwwroot'), PHP_URL_PATH);
        $baseurl = $baseurlpath . 'artefact/file/blocktype/internalmedia/';
285

286
        $playerurl = $baseurl . 'mahara-flashplayer/mahara-flashplayer.swf';
287 288 289 290 291 292 293 294 295 296
        $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: {
297
		                  url: "' . $baseurl . 'flowplayer.audio/flowplayer.audio-3.2.2.swf"
298 299 300 301
		             }';
        }

        $html =  '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>
302 303
               <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>
304 305 306
               <script type="text/javascript">
               flowplayer("'.$id.'", "'.$playerurl.'", {
                   clip:  {
307
                       url: "'.$escapedurl.'",
308 309
                       '.$type.'
                       autoPlay: false,
310 311
                       autoBuffering: '.$buffering.',
                       scaling: "fit",
312 313 314
                   },
                   plugins: {
	                  controls: {
315
                          url: "mahara-flashplayer.controls.swf",
316 317 318 319 320 321
                          play:true,
                          volume:true,
                          mute:true,
                          time:false,
                          stop:false,
                          playlist:false,
322
                          fullscreen:true,
323 324 325 326 327
                          scrubber: true,
                          autoHide: '.$autohide.'
                      }'.$audio.'
                   }
               }).load();
328
               addElementClass("' . $id . '_h", "hidden");
329 330 331 332 333 334
               </script>
';
        return $html;

    }

Penny Leach's avatar
Penny Leach committed
335 336 337 338 339
    public static function real_player($artefact, $block, $width, $height) {

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

        require_once('file.php');
340
        $mimetype = $artefact->get('filetype');
Penny Leach's avatar
Penny Leach committed
341 342
        $autostart = 'false';

343
        return '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>'
Penny Leach's avatar
Penny Leach committed
344 345 346 347
    . '<span class="blocktype_internalmedia_real">
    <script type="text/javascript">
    //<![CDATA[
    document.write(\'<object classid="clsid:CFCDAA03-8BE4-11cf-B84B-0020AFBBCCFA" width="240" height="180">\\
348 349 350 351 352 353 354
      <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
355
      <object classid="clsid:CFCDAA03-8BE4-11cf-B84B-0020AFBBCCFA" width="240" height="30">\\
356 357 358 359 360
      <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
361 362 363 364 365 366 367
      </object>\');
    //]]>
    </script></span>';
    }

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

368
        $url = hsc(self::get_download_link($artefact, $block));
Penny Leach's avatar
Penny Leach committed
369 370 371 372 373 374 375

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

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

376
        return '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>'
Penny Leach's avatar
Penny Leach committed
377 378 379 380
    . '<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">
381 382 383 384 385 386 387 388 389 390 391 392
     <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">
393
     <param name="Wmode" value="opaque">
Penny Leach's avatar
Penny Leach committed
394 395
    <!--[if !IE]>-->
      <object data="' . $url . '" type="' . $mimetype . '" ' . $size . '>
396 397 398 399 400 401
       <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">
402
       <param name="wmode" value="opaque">
Penny Leach's avatar
Penny Leach committed
403 404 405 406 407 408 409 410 411 412 413 414
      </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');
415
        $mimetype = $artefact->get('filetype');
Penny Leach's avatar
Penny Leach committed
416 417
        $autostart = 'false';

418
        return '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>'
Penny Leach's avatar
Penny Leach committed
419 420 421
    . '<span class="mediaplugin mediaplugin_qt">
    <object classid="clsid:02BF25D5-8C17-4B23-BC80-D3488ABDDC6B"
      codebase="http://www.apple.com/qtactivex/qtplugin.cab" ' . $size . '>
422 423
     <param name="pluginspage" value="http://www.apple.com/quicktime/download/">
     <param name="src" value="' . $url . '">
424
     <param name="controller" value="true">
425 426 427 428
     <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
429 430
    <!--[if !IE]>-->
      <object data="' . $url . '" type="' . $mimetype . '" ' . $size . '>
431 432 433 434 435 436 437
       <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">
438
       <param name="wmode" value="transparent">
Penny Leach's avatar
Penny Leach committed
439 440 441 442 443
      </object>
    <!--<![endif]-->
    </object></span>';
    }

444 445 446
    private static function get_download_link(ArtefactTypeFile $artefact, BlockInstance $instance) {
        return get_config('wwwroot') . 'artefact/file/download.php?file='
            . $artefact->get('id') . '&view=' . $instance->get('view');
Penny Leach's avatar
Penny Leach committed
447 448
    }

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

463 464 465 466
    public static function default_copy_type() {
        return 'full';
    }

Penny Leach's avatar
Penny Leach committed
467
}