lib.php 17.5 KB
Newer Older
Penny Leach's avatar
Penny Leach committed
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4
 * Copyright (C) 2006-2008 Catalyst IT Ltd (http://www.catalyst.net.nz)
Penny Leach's avatar
Penny Leach committed
5
 *
Francois Marier's avatar
Francois Marier committed
6
7
8
9
 * This program 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.
Penny Leach's avatar
Penny Leach committed
10
 *
Francois Marier's avatar
Francois Marier committed
11
12
13
14
 * This program 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.
Penny Leach's avatar
Penny Leach committed
15
 *
Francois Marier's avatar
Francois Marier committed
16
17
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
Penny Leach's avatar
Penny Leach committed
18
19
20
 *
 * @package    mahara
 * @subpackage blocktype-internalmedia
21
 * @author     Catalyst IT Ltd
Penny Leach's avatar
Penny Leach committed
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
23
 * @copyright  (C) 2006-2008 Catalyst IT Ltd http://catalyst.net.nz
Penny Leach's avatar
Penny Leach committed
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 *
 */

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() {
40
        return array('fileimagevideo');
Penny Leach's avatar
Penny Leach committed
41
42
    }

43
44
45
46
    public static function get_viewtypes() {
        return array('portfolio', 'profile');
    }

Penny Leach's avatar
Penny Leach committed
47
48
49
50
51
52
    public static function has_config() {
        return true;
    }

    public static function postinst($oldversion) {
        if ($oldversion == 0) {
53
            set_config_plugin('blocktype', 'internalmedia', 'enabledtypes', serialize(self::get_all_filetypes()));
Penny Leach's avatar
Penny Leach committed
54
55
56
        }
    }

57
    public static function render_instance(BlockInstance $instance, $editing=false) {
Penny Leach's avatar
Penny Leach committed
58
59
60
61
62
63
        $configdata = $instance->get('configdata');

        if (empty($configdata['artefactid'])) {
            return '';
        }
        $result = self::get_js_source();
64
        require_once(get_config('docroot') . 'artefact/lib.php');
65
        $artefact = $instance->get_artefact_instance($configdata['artefactid']);
Penny Leach's avatar
Penny Leach committed
66
67
        $width  = (!empty($configdata['width'])) ? hsc($configdata['width']) : '300';
        $height = (!empty($configdata['height'])) ? hsc($configdata['height']) : '300';
68
69
70
        $mimetype = $artefact->get('filetype');
        $mimetypefiletypes = self::get_allowed_mimetype_filetypes();
        if (!isset($mimetypefiletypes[$mimetype])) {
71
            return get_string('typeremoved', 'blocktype.file/internalmedia');
Penny Leach's avatar
Penny Leach committed
72
        }
73
        $callbacks = self::get_all_filetype_players();
74
        $result .= '<div class="mediaplayer-container"><div class="mediaplayer">' . call_static_method('PluginBlocktypeInternalmedia', $callbacks[$mimetypefiletypes[$mimetype]], $artefact, $instance, $width, $height) . '</div></div>';
Penny Leach's avatar
Penny Leach committed
75
76
77
78
79
80
81
        return $result;
    }

    public static function has_instance_config() {
        return true;
    }

82
    public static function instance_config_form($instance, $istemplate) {
Penny Leach's avatar
Penny Leach committed
83
        $configdata = $instance->get('configdata');
84
85
86
87
88
        safe_require('artefact', 'file');
        $instance->set('artefactplugin', 'file');
        return array(
            'filebrowser' => self::filebrowser_element($instance, (isset($configdata['artefactid'])) ? $configdata['artefactid'] : null, $istemplate),
            'width' => array(
Penny Leach's avatar
Penny Leach committed
89
90
91
92
                'type' => 'text',
                'title' => get_string('width'),
                'size' => 3,
                'defaultvalue' => (isset($configdata['width'])) ? $configdata['width'] : '',
93
94
            ),
            'height' => array(
Penny Leach's avatar
Penny Leach committed
95
96
97
98
                'type' => 'text',
                'title' => get_string('height'),
                'size' => 3,
                'defaultvalue' => (isset($configdata['height'])) ? $configdata['height'] : '',
99
            ),
Penny Leach's avatar
Penny Leach committed
100
        );
101
102
103
104
105
106
107
108
    }

    public static function instance_config_save($values) {
        if (isset($values['filebrowser']['selected'])) {
            $values['artefactid'] = $values['filebrowser']['selected'][0];
        }
        unset($values['filebrowser']);
        return $values;
Penny Leach's avatar
Penny Leach committed
109
110
111
112
113
114
115
116
117
118
    }

    public static function get_artefacts(BlockInstance $instance) {
        $configdata = $instance->get('configdata');
        if (isset($configdata['artefactid'])) {
            return array($configdata['artefactid']);
        }
        return false;
    }

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
    public static function filebrowser_element(&$instance, $default=null, $istemplate=false) {
        $element = array(
            'name'         => 'filebrowser',
            'type'         => 'filebrowser',
            'title'        => get_string('media', 'blocktype.file/internalmedia'),
            'folder'       => param_integer('folder', 0),
            'highlight'    => null,
            'browse'       => true,
            'page'         => View::make_base_url(),
            'config'       => array(
                'upload'          => true,
                'uploadagreement' => get_config_plugin('artefact', 'file', 'uploadagreement'),
                'createfolder'    => false,
                'edit'            => false,
                'select'          => true,
                'selectone'       => true,
                'alwaysopen'      => true,
            ),
            'filters'      => array(
                'artefacttype'    => array('file'),
                'filetype'        => self::get_allowed_mimetypes(),
            ),
            'selectlistcallback' => array(
                'name' => 'artefact_get_records_by_id',
                'args' => array(empty($default) ? array() : array($default)),
            ),
        );
        if (!$istemplate) {
            // You don't have to choose a file if this view is a template
            $element['rules'] = array(
                'required' => true,
            );
        }
        return $element;
    }

155
    public static function artefactchooser_element($default=null, $istemplate=false) {
156
        $extraselect = 'filetype IN (' . join(',', array_map('db_quote', self::get_allowed_mimetypes())) . ')';
157
        $extrajoin   = ' JOIN {artefact_file_files} ON {artefact_file_files}.artefact = a.id ';
Penny Leach's avatar
Penny Leach committed
158
159
160
161
162
163
164
165
166
167
168

        return array(
            'name' => 'artefactid',
            'type'  => 'artefactchooser',
            'title' => get_string('media', 'blocktype.file/internalmedia'),
            'defaultvalue' => $default,
            'blocktype' => 'internalmedia',
            'limit' => 5,
            'selectone' => true,
            'artefacttypes' => array('file'),
            'extraselect' => $extraselect,
169
            'extrajoin' => $extrajoin,
Penny Leach's avatar
Penny Leach committed
170
171
            'template' => 'artefact:file:artefactchooser-element.tpl',
        );
172
173
174
175
176
177
178
        if (!$istemplate) {
            // You don't have to choose a file if this view is a template
            $element['rules'] = array(
                'required' => true,
            );
        }
        return $element;
Penny Leach's avatar
Penny Leach committed
179
180
    }

181
182
183
184
185
    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
186
187
188
    public static function save_config_options($values) {
        $enabledtypes = array();
        foreach ($values as $type => $enabled) {
189
            if (!in_array($type, self::get_all_filetypes())) {
190
191
                continue;
            }
Penny Leach's avatar
Penny Leach committed
192
193
194
195
196
197
198
199
200
201
202
            if (!empty($enabled)) {
                $enabledtypes[] = $type;
            }
        }
        set_config_plugin('blocktype', 'internalmedia', 'enabledtypes', serialize($enabledtypes));
    }

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

205
        foreach (self::get_all_filetypes() as $filetype) {
206
207
208
209
210
            $filetypes[$filetype] = array(
                'type'  => 'checkbox',
                'title' => get_string($filetype, 'artefact.file'),
                'defaultvalue' => in_array($filetype, $currenttypes),
            );
Penny Leach's avatar
Penny Leach committed
211
212
213
214
215
        }
        uasort($filetypes, create_function('$a, $b', 'return $a["title"] > $b["title"];'));
        $filetypes = array_merge(
            array(
                'description' => array(
216
                    'value' => get_string('configdesc', 'blocktype.file/internalmedia'),
Penny Leach's avatar
Penny Leach committed
217
218
219
220
221
222
223
224
225
226
227
                ),
            ),
            $filetypes
        );

        return array(
            'elements' => $filetypes,
            'renderer' => 'table'
        );
    }

228
229

    private static function get_allowed_filetypes() {
Penny Leach's avatar
Penny Leach committed
230
231
232
233
234
235
        if ($data = get_config_plugin('blocktype', 'internalmedia', 'enabledtypes')) {
            return unserialize($data);
        }
        return array();
    }

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

    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
265
        return array(
266
267
268
269
270
271
272
273
            'mp3'       => 'flash_player', // tested
            'swf'       => 'flash_player', // tested
            'flv'       => 'flash_player', // tested
            'quicktime' => 'qt_player',  // tested
            'wmv'       => 'wmp_player', // tested
            'mpeg'      => 'qt_player',  // tested
            'avi'       => 'wmp_player', // tested
            'mp4_video' => 'qt_player', // tested
274
            /* commenting out for now
Penny Leach's avatar
Penny Leach committed
275
276
277
            'ram'   => 'real_player',
            'rm'    => 'real_player',
            'rpm'   => 'real_player',
278
            */
Penny Leach's avatar
Penny Leach committed
279
280
281
282
283
284
285
286
287
        );
    }

    public static function flash_player($artefact, $block, $width, $height) {
        static $count = 0;
        $count++;
        $extn = $artefact->get('oldextension');
        if ($extn == 'mp3') {
            $height = 0; // one line
288
            $width = 100;
Penny Leach's avatar
Penny Leach committed
289
290
291
292
293
294
295
296
297
        }
        $id = 'blocktype_internalmedia_flash_' . time() . $count;
        $url = self::get_download_link($artefact, $block);
        $playerurl =  get_config('wwwroot') . "artefact/file/blocktype/internalmedia/mediaplayer.swf";
        $params = array();
        if ($extn == 'swf') {
            $playerurl = $url;
            $params['play'] = 'false';
        }
298
        $html =  '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>
Penny Leach's avatar
Penny Leach committed
299
               <span class="blocktype_internalmedia_mp3" id="' . $id . '">(' 
300
               . get_string('flashanimation', 'blocktype.file/internalmedia') . ')</span>
Penny Leach's avatar
Penny Leach committed
301
                <script type="text/javascript">
302
                    var so = new SWFObject(" ' . $playerurl . '","player","' . $width . '","' . ($height + 20). '","7");
Penny Leach's avatar
Penny Leach committed
303
304
305
                    so.addParam("allowfullscreen","false");
                    so.addVariable("file","' . urlencode($url) . '");
                    so.addVariable("displayheight"," ' . $height . '");
306
                    so.addVariable("type", "' . $extn . '");
Penny Leach's avatar
Penny Leach committed
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
                    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;

    }

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

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

        require_once('file.php');
327
        $mimetype = $artefact->get('filetype');
Penny Leach's avatar
Penny Leach committed
328
329
        $autostart = 'false';

330
        return '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>'
Penny Leach's avatar
Penny Leach committed
331
332
333
334
    . '<span class="blocktype_internalmedia_real">
    <script type="text/javascript">
    //<![CDATA[
    document.write(\'<object classid="clsid:CFCDAA03-8BE4-11cf-B84B-0020AFBBCCFA" width="240" height="180">\\
335
336
337
338
339
340
341
      <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
342
      <object classid="clsid:CFCDAA03-8BE4-11cf-B84B-0020AFBBCCFA" width="240" height="30">\\
343
344
345
346
347
      <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
348
349
350
351
352
353
354
      </object>\');
    //]]>
    </script></span>';
    }

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

355
        $url = hsc(self::get_download_link($artefact, $block, true));
Penny Leach's avatar
Penny Leach committed
356
357
358
359
360
361
362

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

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

363
        return '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>'
Penny Leach's avatar
Penny Leach committed
364
365
366
367
    . '<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">
368
369
370
371
372
373
374
375
376
377
378
379
     <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">
Penny Leach's avatar
Penny Leach committed
380
381
    <!--[if !IE]>-->
      <object data="' . $url . '" type="' . $mimetype . '" ' . $size . '>
382
383
384
385
386
387
       <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">
Penny Leach's avatar
Penny Leach committed
388
389
390
391
392
393
394
395
396
397
398
399
      </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');
400
        $mimetype = $artefact->get('filetype');
Penny Leach's avatar
Penny Leach committed
401
402
        $autostart = 'false';

403
        return '<a href="' . $url . '">' . hsc($artefact->get('title')) . '</a><br>'
Penny Leach's avatar
Penny Leach committed
404
405
406
    . '<span class="mediaplugin mediaplugin_qt">
    <object classid="clsid:02BF25D5-8C17-4B23-BC80-D3488ABDDC6B"
      codebase="http://www.apple.com/qtactivex/qtplugin.cab" ' . $size . '>
407
408
409
410
411
412
413
     <param name="pluginspage" value="http://www.apple.com/quicktime/download/">
     <param name="src" value="' . $url . '">
     <param name="coltroller" 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
414
415
    <!--[if !IE]>-->
      <object data="' . $url . '" type="' . $mimetype . '" ' . $size . '>
416
417
418
419
420
421
422
       <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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
      </object>
    <!--<![endif]-->
    </object></span>';
    }

    private static function get_download_link(ArtefactTypeFile $artefact, BlockInstance $instance, $wmp=false) {
        return get_config('wwwroot') . 'artefact/file/download.php?file=' 
            . $artefact->get('id') . '&view=' . $instance->get('view')
            . ($wmp ? '&download=1' : '');
    }

    private static function get_js_source() {
        if (defined('BLOCKTYPE_INTERNALMEDIA_JS_INCLUDED')) {
            return '';
        }
        define('BLOCKTYPE_INTERNALMEDIA_JS_INCLUDED', true);
Nigel McNie's avatar
Nigel McNie committed
439
440
        return '<script src="' . get_config('wwwroot') . 'artefact/file/blocktype/internalmedia/swfobject.js" type="text/javascript"></script>
             <script defer="defer" src="' . get_config('wwwroot') . 'artefact/file/blocktype/internalmedia/eolas_fix.js" type="text/javascript"></script>';
Penny Leach's avatar
Penny Leach committed
441
442
    }

443
444
445
446
    public static function default_copy_type() {
        return 'full';
    }

Penny Leach's avatar
Penny Leach committed
447
448
449
}

?>