lib.php 40.4 KB
Newer Older
Evan Goldenberg's avatar
Evan Goldenberg committed
1
2
3
4
<?php
/**
 *
 * @package    mahara
5
 * @subpackage blocktype-gallery
Evan Goldenberg's avatar
Evan Goldenberg committed
6
 * @author     Catalyst IT Ltd
7
 * @author     Gregor Anzelj (External Galleries, e.g. Flickr, Picasa)
8
9
 * @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.
10
 * @copyright  (C) 2011 Gregor Anzelj <gregor.anzelj@gmail.com>
Evan Goldenberg's avatar
Evan Goldenberg committed
11
12
13
14
15
 *
 */

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

16
class PluginBlocktypeGallery extends MaharaCoreBlocktype {
Evan Goldenberg's avatar
Evan Goldenberg committed
17
18
19
20
21
22

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

    public static function get_description() {
23
        return get_string('description1', 'blocktype.file/gallery');
Evan Goldenberg's avatar
Evan Goldenberg committed
24
25
26
    }

    public static function get_categories() {
27
        return array('fileimagevideo' => 5000);
Evan Goldenberg's avatar
Evan Goldenberg committed
28
29
30
    }

    public static function get_instance_javascript(BlockInstance $instance) {
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
        $blockid = $instance->get('id');
        // The initjs for the fancybox will be applied to all galleries on the page
        return array(
            array(
                'file'   => get_config('wwwroot') . 'js/fancybox/jquery.fancybox.min.js',
                'initjs' => " $('[data-fancybox]').fancybox({
                      buttons : [
                               'zoom',
                               'slideShow',
                               'download',
                               'close'
                               ],
                      loop : true,
                      lang : '" . current_language() . "',
                      i18n : {
                          '" . current_language() . "' : {
                              CLOSE: \"" . get_string('CLOSE', 'blocktype.file/gallery') . "\",
                              NEXT: \"" . get_string('NEXT', 'blocktype.file/gallery') . "\",
                              PREV: \"" . get_string('PREV', 'blocktype.file/gallery') . "\",
                              ERROR: \"" . get_string('ERROR', 'blocktype.file/gallery') . "\",
                              PLAY_START: \"" . get_string('PLAY_START', 'blocktype.file/gallery') . "\",
                              PLAY_STOP: \"" . get_string('PLAY_STOP', 'blocktype.file/gallery') . "\",
                              FULL_SCREEN: \"" . get_string('FULL_SCREEN', 'blocktype.file/gallery') . "\",
                              THUMBS: \"" . get_string('THUMBS', 'blocktype.file/gallery') . "\",
                              DOWNLOAD: \"" . get_string('DOWNLOAD', 'blocktype.file/gallery') . "\",
                              SHARE: \"" . get_string('SHARE', 'blocktype.file/gallery') . "\",
                              ZOOM: \"" . get_string('ZOOM', 'blocktype.file/gallery') . "\"
                          }
                      }
                });"
            ),
            array(
                'file'   => get_config('wwwroot') . 'js/masonry/masonry.min.js',
                'initjs' => " $('.js-masonry.thumbnails').masonry({ itemSelector: '.thumb' });"
            )
        );
    }

    public static function get_instance_css(BlockInstance $instance) {
        return array(
            get_config('wwwroot') . 'js/fancybox/jquery.fancybox.min.css'
        );
Evan Goldenberg's avatar
Evan Goldenberg committed
73
74
    }

Son Nguyen's avatar
Son Nguyen committed
75
    public static function get_instance_config_javascript(BlockInstance $instance) {
76
77
78
        return array(
            'js/configform.js',
        );
Evan Goldenberg's avatar
Evan Goldenberg committed
79
80
    }

81
    public static function render_instance(BlockInstance $instance, $editing=false, $versioning=false) {
Evan Goldenberg's avatar
Evan Goldenberg committed
82
83
        $configdata = $instance->get('configdata'); // this will make sure to unserialize it for us
        $configdata['viewid'] = $instance->get('view');
84
85
        $style = isset($configdata['style']) ? intval($configdata['style']) : 2;
        $copyright = null; // Needed to set Panoramio copyright later...
86
        $width = !empty($configdata['width']) ? $configdata['width'] : 75;
87
        $width = floor($width);
Richard Mansfield's avatar
Richard Mansfield committed
88
        switch ($style) {
Evan Goldenberg's avatar
Evan Goldenberg committed
89
90
91
92
93
            case 0: // thumbnails
                $template = 'thumbnails';
                break;
            case 1: // slideshow
                $template = 'slideshow';
94
                $width = !empty($configdata['width']) ? $configdata['width'] : 400;
Evan Goldenberg's avatar
Evan Goldenberg committed
95
                break;
96
97
98
            case 2: // square thumbnails
                $template = 'squarethumbs';
                break;
Evan Goldenberg's avatar
Evan Goldenberg committed
99
100
        }

101
        $images = array();
102
        $fancyboxattr = get_config_plugin('blocktype', 'gallery', 'usefancybox') ? 'lightbox_' . $instance->get('id') : null;
103

104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
        // if we're trying to embed external gallery (thumbnails or slideshow)
        if (isset($configdata['select']) && $configdata['select'] == 2) {
            $gallery = self::make_gallery_url($configdata['external']);
            if (empty($gallery)) {
                return get_string('externalnotsupported', 'blocktype.file/gallery');
            }
            $url  = isset($gallery['url']) ? hsc($gallery['url']) : null;
            $type = isset($gallery['type']) ? hsc($gallery['type']) : null;
            $var1 = isset($gallery['var1']) ? hsc($gallery['var1']) : null;
            $var2 = isset($gallery['var2']) ? hsc($gallery['var2']) : null;

            switch ($type) {
                case 'widget':
                /*****************************
                  Roy Tanck's FLICKR WIDGET
                  for Flickr RSS & Picasa RSS
          http://www.roytanck.com/get-my-flickr-widget/
                 *****************************/
                    $widget_sizes = array(100, 200, 300);
                    $width = self::find_nearest($widget_sizes, $width);
                    $images = urlencode(str_replace('&amp;', '&', $url));
                    $template = 'imagecloud';
                    break;
                case 'picasa':
                    // Slideshow
                    if ($style == 1) {
                        $picasa_show_sizes = array(144, 288, 400, 600, 800);
                        $width = self::find_nearest($picasa_show_sizes, $width);
                        $height = round($width * 0.75);
                        $images = array('user' => $var1, 'gallery' => $var2);
                        $template = 'picasashow';
                    }
                    // Thumbnails
                    else {
                        $picasa_thumbnails = array(32, 48, 64, 72, 104, 144, 150, 160);
                        $width = self::find_nearest($picasa_thumbnails, $width);
                        // If the Thumbnails should be Square...
                        if ($style == 2) {
                            $small = 's' . $width . '-c';
                            $URL = 'http://picasaweb.google.com/data/feed/api/user/' . $var1 . '/album/' . $var2 . '?kind=photo&thumbsize=' . $width . 'c';
                        }
                        else {
                            $small = 's' . $width;
                            $URL = 'http://picasaweb.google.com/data/feed/api/user/' . $var1 . '/album/' . $var2 . '?kind=photo&thumbsize=' . $width;
                        }
                        $big = 's' . get_config_plugin('blocktype', 'gallery', 'previewwidth');

151
                        libxml_before(true);
152
153
154
155
156
157
158
159
                        $xmlDoc = new DOMDocument('1.0', 'UTF-8');
                        $config = array(
                            CURLOPT_URL => $URL,
                            CURLOPT_RETURNTRANSFER => true,
                        );
                        $result = mahara_http_request($config);
                        $xmlDoc->loadXML($result->data);
                        $photos = $xmlDoc->getElementsByTagNameNS('http://search.yahoo.com/mrss/', 'group');
160
161
                        libxml_after();

162
163
164
165
166
167
168
169
170
171
172
173
                        foreach ($photos as $photo) {
                            $children = $photo->cloneNode(true);
                            $thumb = $children->getElementsByTagNameNS('http://search.yahoo.com/mrss/', 'thumbnail')->item(0)->getAttribute('url');
                            $description = null;
                            if (isset($children->getElementsByTagNameNS('http://search.yahoo.com/mrss/', 'description')->item(0)->firstChild->nodeValue)) {
                                $description = $children->getElementsByTagNameNS('http://search.yahoo.com/mrss/', 'description')->item(0)->firstChild->nodeValue;
                            }

                            $images[] = array(
                                'link' => str_replace($small, $big, $thumb),
                                'source' => $thumb,
                                'title' => $description,
174
                                'fancybox' => $fancyboxattr
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
                            );
                        }
                    }
                    break;
                case 'flickr':
                    // Slideshow
                    if ($style == 1) {
                        $flickr_show_sizes = array(400, 500, 700, 800);
                        $width = self::find_nearest($flickr_show_sizes, $width);
                        $height = round($width * 0.75);
                        $images = array('user' => $var1, 'gallery' => $var2);
                        $template = 'flickrshow';
                    }
                    // Thumbnails
                    else {
                        $width = 75; // Currently only thumbnail size, that Flickr supports

                        $api_key = get_config_plugin('blocktype', 'gallery', 'flickrapikey');
193
                        $URL = 'https://api.flickr.com/services/rest/?method=flickr.photosets.getPhotos&extras=url_sq,url_t&photoset_id=' . $var2 . '&api_key=' . $api_key;
194
                        libxml_before(true);
195
196
197
198
199
200
201
202
                        $xmlDoc = new DOMDocument('1.0', 'UTF-8');
                        $config = array(
                            CURLOPT_URL => $URL,
                            CURLOPT_RETURNTRANSFER => true,
                        );
                        $result = mahara_http_request($config);
                        $xmlDoc->loadXML($result->data);
                        $photos = $xmlDoc->getElementsByTagName('photo');
203
                        libxml_after();
204
205
206
207
208
209
210
211
212
213
214
                        foreach ($photos as $photo) {
                            // If the Thumbnails should be Square...
                            if ($style == 2) {
                                $thumb = $photo->getAttribute('url_sq');
                                $link = str_replace('_s.jpg', '_b.jpg', $thumb);
                            }
                            else {
                                $thumb = $photo->getAttribute('url_t');
                                $link = str_replace('_t.jpg', '_b.jpg', $thumb);
                            }
                            $description = $photo->getAttribute('title');
215

216
217
218
219
                            $images[] = array(
                                'link' => $link,
                                'source' => $thumb,
                                'title' => $description,
220
                                'fancybox' => $fancyboxattr
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
                            );
                        }
                    }
                    break;
                case 'photobucket':
                    // Slideshow
                    if ($style == 1) {
                        $height = round($width * 0.75);
                        $images = array('url' => $url, 'user' => $var1, 'album' => $var2);
                        $template = 'photobucketshow';
                    }
                    // Thumbnails
                    else {
                        $consumer_key = get_config_plugin('blocktype', 'gallery', 'pbapikey'); // PhotoBucket API key
                        $consumer_secret = get_config_plugin('blocktype', 'gallery', 'pbapiprivatekey'); //PhotoBucket API private key

                        $oauth_signature_method = 'HMAC-SHA1';
                        $oauth_version = '1.0';
                        $oauth_timestamp = time();
                        $mt = microtime();
                        $rand = mt_rand();
                        $oauth_nonce = md5($mt . $rand);

                        $method = 'GET';
                        $albumname = $var1 . '/' . $var2;
                        $api_url = 'http://api.photobucket.com/album/' . urlencode($albumname);

                        $params = null;
                        $paramstring = 'oauth_consumer_key=' . $consumer_key . '&oauth_nonce=' . $oauth_nonce . '&oauth_signature_method=' . $oauth_signature_method . '&oauth_timestamp=' . $oauth_timestamp . '&oauth_version=' . $oauth_version;
                        $base = urlencode($method) . '&' . urlencode($api_url) . '&' . urlencode($paramstring);
                        $oauth_signature = base64_encode(hash_hmac('sha1', $base, $consumer_secret.'&', true));

                        $URL = $api_url . '?' . $paramstring . '&oauth_signature=' . urlencode($oauth_signature);
254
                        libxml_before(true);
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
                        $xmlDoc = new DOMDocument('1.0', 'UTF-8');
                        $config = array(
                            CURLOPT_URL => $URL,
                            CURLOPT_HEADER => false,
                            CURLOPT_RETURNTRANSFER => true,
                        );
                        $result = mahara_http_request($config);
                        $xmlDoc->loadXML($result->data);

                        $xmlDoc2 = new DOMDocument('1.0', 'UTF-8');
                        $config2 = array(
                            CURLOPT_URL => $xmlDoc->getElementsByTagName('url')->item(0)->firstChild->nodeValue,
                            CURLOPT_HEADER => false,
                            CURLOPT_RETURNTRANSFER => true,
                        );
                        $result2 = mahara_http_request($config2);
                        $xmlDoc2->loadXML($result->data);

                        $photos = $xmlDoc2->getElementsByTagName('media');
274
                        libxml_after();
275
276
277
278
279
280
281
282
283
284
285
286
287
                        foreach ($photos as $photo) {
                            $children = $photo->cloneNode(true);
                            $link = $children->getElementsByTagName('url')->item(0)->firstChild->nodeValue;
                            $thumb = $children->getElementsByTagName('thumb')->item(0)->firstChild->nodeValue;
                            $description = null;
                            if (isset($children->getElementsByTagName('description')->item(0)->firstChild->nodeValue)) {
                                $description = $children->getElementsByTagName('description')->item(0)->firstChild->nodeValue;
                            }

                            $images[] = array(
                                'link' => $link,
                                'source' => $thumb,
                                'title' => $description,
288
                                'fancybox' => $fancyboxattr
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
                            );
                        }
                    }
                    break;
                case 'windowslive':
                    // Slideshow
                    if ($style == 1) {
                        $images = array('url' => $url, 'user' => $var1, 'album' => $var2);
                        $template = 'windowsliveshow';
                    }
                    // Thumbnails
                    else {
                        $config = array(
                            CURLOPT_URL => str_replace(' ', '%20', $url),
                            CURLOPT_HEADER => false,
                            CURLOPT_RETURNTRANSFER => true,
                        );
                        $result = mahara_http_request($config);
                        $data = $result->data;

                        // Extract data about images and thumbs from HTML source - hack!
                        preg_match_all("#previewImageUrl: '([a-zA-Z0-9\_\-\.\\\/]+)'#", $data, $photos);
                        preg_match_all("#thumbnailImageUrl: '([a-zA-Z0-9\_\-\.\\\/]+)'#", $data, $thumbs);

                        for ($i = 0; $i < sizeof($photos[1]); $i++) {
                            $images[] = array(
                                'link' => str_replace(array('\x3a','\x2f','\x25','\x3fpsid\x3d1'), array(':','/','%',''), $photos[1][$i]),
                                'source' => str_replace(array('\x3a','\x2f','\x25','\x3fpsid\x3d1'), array(':','/','%',''), $thumbs[1][$i]),
                                'title' => null,
318
                                'fancybox' => $fancyboxattr
319
320
321
322
                            );
                        }
                    }
                    break;
323
            }
324
325
        }
        else {
326
            safe_require('artefact', 'file');
327
328
329
            $artefactids = array();
            if (isset($configdata['select']) && $configdata['select'] == 1 && is_array($configdata['artefactids'])) {
                $artefactids = $configdata['artefactids'];
330
            }
331
332
333
            else if ($versioning && !empty($configdata['existing_artefacts'])) {
                $artefactids = (array) $configdata['existing_artefacts'];
            }
334
335
336
            else if (!empty($configdata['artefactid'])) {
                // Get descendents of this folder.
                $artefactids = artefact_get_descendants(array(intval($configdata['artefactid'])));
Evan Goldenberg's avatar
Evan Goldenberg committed
337
            }
338

339
340
            $artefactids = $instance->order_artefacts_by_title($artefactids);

341
342
343
344
            // This can be either an image or profileicon. They both implement
            // render_self
            foreach ($artefactids as $artefactid) {
                $image = $instance->get_artefact_instance($artefactid);
345

346
347
                if ($image instanceof ArtefactTypeProfileIcon) {
                    $src = get_config('wwwroot') . 'thumb.php?type=profileiconbyid&id=' . $artefactid;
348
                    $src .= '&view=' . $instance->get('view');
349
350
351
352
353
354
355
356
357
358
359
                    $description = $image->get('title');
                }
                else if ($image instanceof ArtefactTypeImage) {
                    $src = get_config('wwwroot') . 'artefact/file/download.php?file=' . $artefactid;
                    $src .= '&view=' . $instance->get('view');
                    $description = $image->get('description');
                }
                else {
                    continue;
                }

360
                if ($fancyboxattr) {
361
362
363
                    $link = $src . '&maxwidth=' . get_config_plugin('blocktype', 'gallery', 'previewwidth');
                }
                else {
364
                    $link = get_config('wwwroot') . 'view/view.php?id=' . $instance->get('view') . '&modal=1&block=' . $instance->get('id') .' &artefact=' . $artefactid;
365
366
367
368
                }

                // If the Thumbnails are Square or not...
                if ($style == 2) {
369
370
                    // Determine the scaling for the fitting the image in the square of $width size
                    // Calculate the bigger, width vs height, to work out the ratio
371
                    $configwidth = $width - (!empty($configdata['photoframe']) ? 8 : 0); // $width - photo frame padding
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
                    $imagewidth = $image->get('width');
                    $imageheight = $image->get('height');
                    if ($imagewidth > $imageheight) {
                        $ratio = $imagewidth / $configwidth;
                    }
                    else {
                        $ratio = $imageheight / $configwidth;
                    }
                    $ratiowidth = floor($imagewidth / $ratio);
                    $ratioheight = floor($imageheight / $ratio);
                    // All image dimensions need to be bigger than 15px
                    // see function imagesize_data_to_internal_form()
                    $ratiowidth = $ratiowidth < 16 ? 16 : $ratiowidth;
                    $ratioheight = $ratioheight < 16 ? 16 : $ratioheight;

387
                    $topoffset = floor(($configwidth - $ratioheight) / 2);
388
389
                    $src .= '&size=' . $ratiowidth . 'x' . $ratioheight;
                    $height = $ratioheight;
390
391
392
                }
                else {
                    $src .= '&maxwidth=' . $width;
393
394
395
                    $imgwidth = $image->get('width');
                    $imgheight = $image->get('height');
                    $height = ($imgwidth > $width) ? intval(($width / $imgwidth) * $imgheight) : $imgheight;
396
397
398
399
400
                }

                $images[] = array(
                    'link' => $link,
                    'source' => $src,
401
                    'height' => $height,
402
                    'width' => (!empty($ratiowidth) ? $ratiowidth : null),
403
                    'title' => $image->get('description'),
404
                    'fancybox' => $fancyboxattr,
405
406
                    'squaredimensions' => $width,
                    'squaretop' => (!empty($topoffset) ? $topoffset : null),
407
408
                );
            }
Evan Goldenberg's avatar
Evan Goldenberg committed
409
410
411
412
        }

        $smarty = smarty_core();
        $smarty->assign('instanceid', $instance->get('id'));
Lisa Seeto's avatar
Lisa Seeto committed
413
414
415
        if (isset($configdata['artefactid'])) {
            $smarty->assign('artefactid', $configdata['artefactid']);
        }
Evan Goldenberg's avatar
Evan Goldenberg committed
416
417
        $smarty->assign('count', count($images));
        $smarty->assign('images', $images);
418
        $smarty->assign('showdescription', (!empty($configdata['showdescription'])) ? $configdata['showdescription'] : false);
419
        $smarty->assign('width', $width);
Lisa Seeto's avatar
Lisa Seeto committed
420
        $smarty->assign('editing', $editing);
421
422
423
424
425
426
        if (isset($height)) {
            $smarty->assign('height', $height);
        }
        if (isset($needsapikey)) {
            $smarty->assign('needsapikey', $needsapikey);
        }
427
        $smarty->assign('frame', !empty($configdata['photoframe']));
428
        $smarty->assign('copyright', $copyright);
429
430
        if (!empty($configdata['artefactid'])) {
            $artefact = $instance->get_artefact_instance($configdata['artefactid']);
Evan Goldenberg's avatar
Evan Goldenberg committed
431

432
433
434
            require_once(get_config('docroot') . 'artefact/comment/lib.php');
            require_once(get_config('docroot') . 'lib/view.php');
            $view = new View($configdata['viewid']);
435
            list($commentcount, $comments) = ArtefactTypeComment::get_artefact_comments_for_view($artefact, $view, $instance->get('id'), true, $editing, $versioning);
436
        }
Evan Goldenberg's avatar
Evan Goldenberg committed
437
438
439
        return $smarty->fetch('blocktype:gallery:' . $template . '.tpl');
    }

440
441
442
443
444
445
446
447
448
449
450
    public static function has_config() {
        return true;
    }

    public static function get_config_options() {
        $elements = array();
        $elements['gallerysettings'] = array(
            'type' => 'fieldset',
            'legend' => get_string('gallerysettings', 'blocktype.file/gallery'),
            'collapsible' => true,
            'elements' => array(
451
                'usefancybox' => array(
452
                    'type'         => 'switchbox',
453
454
455
                    'title'        => get_string('usefancybox', 'blocktype.file/gallery'),
                    'description'  => get_string('usefancyboxdesc', 'blocktype.file/gallery'),
                    'defaultvalue' => get_config_plugin('blocktype', 'gallery', 'usefancybox'),
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
                ),
                'previewwidth' => array(
                    'type'         => 'text',
                    'size'         => 4,
                    'title'        => get_string('previewwidth', 'blocktype.file/gallery'),
                    'description'  => get_string('previewwidthdesc', 'blocktype.file/gallery'),
                    'defaultvalue' => get_config_plugin('blocktype', 'gallery', 'previewwidth'),
                    'rules'        => array('integer' => true, 'minvalue' => 16, 'maxvalue' => 1600),
                )
            ),
        );
        $elements['flickrsettings'] = array(
            'type' => 'fieldset',
            'legend' => get_string('flickrsettings', 'blocktype.file/gallery'),
            'collapsible' => true,
            'collapsed' => true,
            'elements' => array(
                'flickrapikey' => array(
                    'type'         => 'text',
                    'title'        => get_string('flickrapikey', 'blocktype.file/gallery'),
                    'size'         => 40, // Flickr API key is actually 32 characters long
                    'description'  => get_string('flickrapikeydesc', 'blocktype.file/gallery'),
                    'defaultvalue' => get_config_plugin('blocktype', 'gallery', 'flickrapikey'),
                ),
            ),
        );
        $elements['photobucketsettings'] = array(
            'type' => 'fieldset',
            'legend' => get_string('pbsettings', 'blocktype.file/gallery'),
            'collapsible' => true,
            'collapsed' => true,
487
            'class' => 'last',
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
            'elements' => array(
                'pbapikey' => array(
                    'type'         => 'text',
                    'title'        => get_string('pbapikey', 'blocktype.file/gallery'),
                    'size'         => 20, // PhotoBucket API key is actually 9 characters long
                    'description'  => get_string('pbapikeydesc', 'blocktype.file/gallery'),
                    'defaultvalue' => get_config_plugin('blocktype', 'gallery', 'pbapikey'),
                ),
                'pbapiprivatekey' => array(
                    'type'         => 'text',
                    'title'        => get_string('pbapiprivatekey', 'blocktype.file/gallery'),
                    'size'         => 40, // PhotoBucket API private key is actually 32 characters long
                    'defaultvalue' => get_config_plugin('blocktype', 'gallery', 'pbapiprivatekey'),
                ),
            ),
        );
        return array(
            'elements' => $elements,
506
507
            // Don't apply "panel panel-body" style to this form.
            'class' => null,
508
509
510
511
        );

    }

Son Nguyen's avatar
Son Nguyen committed
512
    public static function save_config_options(Pieform $form, $values) {
513
        set_config_plugin('blocktype', 'gallery', 'usefancybox', (int)$values['usefancybox']);
514
515
516
517
518
519
520
521
        set_config_plugin('blocktype', 'gallery', 'previewwidth', (int)$values['previewwidth']);
        set_config_plugin('blocktype', 'gallery', 'flickrapikey', $values['flickrapikey']);
        set_config_plugin('blocktype', 'gallery', 'pbapikey', $values['pbapikey']);
        set_config_plugin('blocktype', 'gallery', 'pbapiprivatekey', $values['pbapiprivatekey']);
    }

    public static function postinst($prevversion) {
        if ($prevversion == 0) {
522
523
            set_config_plugin('blocktype', 'gallery', 'usefancybox', 1); // Use Fancybox 3 by default
            set_config_plugin('blocktype', 'gallery', 'previewwidth', 1024); // Maximum photo width for fancybox preview
524
525
526
        }
    }

Evan Goldenberg's avatar
Evan Goldenberg committed
527
528
529
530
    public static function has_instance_config() {
        return true;
    }

Son Nguyen's avatar
Son Nguyen committed
531
    public static function instance_config_form(BlockInstance $instance) {
Evan Goldenberg's avatar
Evan Goldenberg committed
532
533
534
535
536
        $configdata = $instance->get('configdata');
        safe_require('artefact', 'file');
        $instance->set('artefactplugin', 'file');
        $user = $instance->get('view_obj')->get('owner');
        $select_options = array(
537
538
            0 => get_string('selectfolder', 'blocktype.file/gallery'),
            1 => get_string('selectimages', 'blocktype.file/gallery'),
539
            2 => get_string('selectexternal', 'blocktype.file/gallery'),
Evan Goldenberg's avatar
Evan Goldenberg committed
540
541
542
        );
        $style_options = array(
            0 => get_string('stylethumbs', 'blocktype.file/gallery'),
543
            2 => get_string('stylesquares', 'blocktype.file/gallery'),
Evan Goldenberg's avatar
Evan Goldenberg committed
544
545
            1 => get_string('styleslideshow', 'blocktype.file/gallery'),
        );
546
547
548
        if (isset($configdata['select']) && $configdata['select'] == 1) {
            $imageids = isset($configdata['artefactids']) ? $configdata['artefactids'] : array();
            $imageselector = self::imageselector($instance, $imageids);
549
550
            $folderselector = self::folderselector($instance, null, 'd-none');
            $externalurl = self::externalurl($instance, null, 'd-none');
551
552
        }
        else if (isset($configdata['select']) && $configdata['select'] == 2) {
553
554
            $imageselector = self::imageselector($instance, null, 'd-none');
            $folderselector = self::folderselector($instance, null, 'd-none');
555
556
            $url = isset($configdata['external']) ? urldecode($configdata['external']) : null;
            $externalurl = self::externalurl($instance, $url);
557
558
        }
        else {
559
            $imageselector = self::imageselector($instance, null, 'd-none');
560
561
            $folderid = !empty($configdata['artefactid']) ? array(intval($configdata['artefactid'])) : null;
            $folderselector = self::folderselector($instance, $folderid);
562
            $externalurl = self::externalurl($instance, null, 'd-none');
563
        }
Evan Goldenberg's avatar
Evan Goldenberg committed
564
565
566
567
568
569
570
571
572
573
574
        return array(
            'user' => array(
                'type' => 'hidden',
                'value' => $user,
            ),
            'select' => array(
                'type' => 'radio',
                'title' => get_string('select', 'blocktype.file/gallery'),
                'options' => $select_options,
                'defaultvalue' => (isset($configdata['select'])) ? $configdata['select'] : 0,
            ),
575
576
            'images' => $imageselector,
            'folder' => $folderselector,
577
            'external' => $externalurl,
Evan Goldenberg's avatar
Evan Goldenberg committed
578
579
580
581
            'style' => array(
                'type' => 'radio',
                'title' => get_string('style', 'blocktype.file/gallery'),
                'options' => $style_options,
582
                'defaultvalue' => (isset($configdata['style'])) ? $configdata['style'] : 2, // Square thumbnails should be default...
Evan Goldenberg's avatar
Evan Goldenberg committed
583
            ),
584
            'showdescription' => array(
585
                'type'  => 'switchbox',
586
587
588
589
                'title' => get_string('showdescriptions', 'blocktype.file/gallery'),
                'description' => get_string('showdescriptionsdescription', 'blocktype.file/gallery'),
                'defaultvalue' => !empty($configdata['showdescription']) ? true : false,
            ),
590
591
592
593
594
595
            'photoframe' => array(
                'type'         => 'switchbox',
                'title'        => get_string('photoframe', 'blocktype.file/gallery'),
                'description'  => get_string('photoframedesc2', 'blocktype.file/gallery'),
                'defaultvalue' => !empty($configdata['photoframe']) ? true : false,
            ),
Evan Goldenberg's avatar
Evan Goldenberg committed
596
597
598
599
600
601
602
603
604
605
606
607
608
609
            'width' => array(
                'type' => 'text',
                'title' => get_string('width', 'blocktype.file/gallery'),
                'size' => 3,
                'description' => get_string('widthdescription', 'blocktype.file/gallery'),
                'rules' => array(
                    'minvalue' => 16,
                    'maxvalue' => get_config('imagemaxwidth'),
                ),
                'defaultvalue' => (isset($configdata['width'])) ? $configdata['width'] : '75',
            ),
        );
    }

Son Nguyen's avatar
Son Nguyen committed
610
    public static function instance_config_validate(Pieform $form, $values) {
611
612
613
614
        global $USER;

        if (!empty($values['images'])) {
            foreach ($values['images'] as $id) {
615
                $image = artefact_instance_from_id($id);
616
                if (!($image instanceof ArtefactTypeImage) || !$USER->can_view_artefact($image)) {
617
618
619
620
621
622
                    $result['message'] = get_string('unrecoverableerror', 'error');
                    $form->set_error(null, $result['message']);
                    $form->reply(PIEFORM_ERR, $result);
                }
            }
        }
623
624
625

        if (!empty($values['folder'])) {
            $folder = artefact_instance_from_id($values['folder']);
626
            if (!($folder instanceof ArtefactTypeFolder) || !$USER->can_view_artefact($folder)) {
627
628
629
630
631
                $result['message'] = get_string('unrecoverableerror', 'error');
                $form->set_error(null, $result['message']);
                $form->reply(PIEFORM_ERR, $result);
            }
        }
632
633
    }

Evan Goldenberg's avatar
Evan Goldenberg committed
634
635
    public static function instance_config_save($values) {
        if ($values['select'] == 0) {
636
637
            $values['artefactid'] = $values['folder'];
            unset($values['artefactids']);
638
            unset($values['external']);
639
640
641
642
        }
        else if ($values['select'] == 1) {
            $values['artefactids'] = $values['images'];
            unset($values['artefactid']);
643
644
645
646
647
            unset($values['external']);
        }
        else if ($values['select'] == 2) {
            unset($values['artefactid']);
            unset($values['artefactids']);
Evan Goldenberg's avatar
Evan Goldenberg committed
648
        }
649
650
        unset($values['folder']);
        unset($values['images']);
651
652
653
654
655
656
657
658
659
        switch ($values['style']) {
            case 0: // thumbnails
            case 2: // square thumbnails
                $values['width'] = !empty($values['width']) ? $values['width'] : 75;
                break;
            case 1: // slideshow
                $values['width'] = !empty($values['width']) ? $values['width'] : 400;
                break;
        }
Evan Goldenberg's avatar
Evan Goldenberg committed
660
661
662
        return $values;
    }

663
    public static function imageselector(&$instance, $default=array(), $class=null) {
Evan Goldenberg's avatar
Evan Goldenberg committed
664
        $element = ArtefactTypeFileBase::blockconfig_filebrowser_element($instance, $default);
665
666
        $element['title'] = get_string('Images', 'artefact.file');
        $element['name'] = 'images';
667
        $element['accept'] = 'image/*';
668
669
670
        if ($class) {
            $element['class'] = $class;
        }
Evan Goldenberg's avatar
Evan Goldenberg committed
671
        $element['config']['selectone'] = false;
672
        $element['config']['selectmodal'] = true;
Evan Goldenberg's avatar
Evan Goldenberg committed
673
        $element['filters'] = array(
674
            'artefacttype'    => array('image', 'profileicon'),
Evan Goldenberg's avatar
Evan Goldenberg committed
675
676
677
678
        );
        return $element;
    }

679
680
681
682
683
684
685
686
687
688
    public static function folderselector(&$instance, $default=array(), $class=null) {
        $element = ArtefactTypeFileBase::blockconfig_filebrowser_element($instance, $default);
        $element['title'] = get_string('folder', 'artefact.file');
        $element['name'] = 'folder';
        if ($class) {
            $element['class'] = $class;
        }
        $element['config']['upload'] = false;
        $element['config']['selectone'] = true;
        $element['config']['selectfolders'] = true;
689
        $element['config']['selectmodal'] = true;
690
691
692
693
694
695
        $element['filters'] = array(
            'artefacttype'    => array('folder'),
        );
        return $element;
    }

696
697
698
699
700
701
702
703
    public static function externalurl(&$instance, $default=null, $class=null) {
        $element['title'] = get_string('externalgalleryurl', 'blocktype.file/gallery');
        $element['name'] = 'external';
        $element['type'] = 'textarea';
        if ($class) {
            $element['class'] = $class;
        }
        $element['rows'] = 5;
704
        $element['cols'] = 76;
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
        $element['defaultvalue'] = $default;
        $element['description'] = '<tr id="externalgalleryhelp" class="'.($class ? $class : '').'"><td colspan="2" class="description">'.
                                  get_string('externalgalleryurldesc', 'blocktype.file/gallery') . self::get_supported_external_galleries() .
                                  '</td></tr>';
        $element['help'] = true;
        return $element;
    }

    private static function make_gallery_url($url) {
        static $embedsources = array(
            // PicasaWeb Album (RSS) - for Roy Tanck's widget
            array(
                'match' => '#.*picasaweb.google.([a-zA-Z]{3}).*user\/([a-zA-Z0-9\_\-\=\&\.\/\:\%]+)\/albumid\/(\d+).*#',
                'url'   => 'http://picasaweb.google.$1/data/feed/base/user/$2/albumid/$3?alt=rss&kind=photo',
                'type'  => 'widget',
                'var1' => '$2',
                'var2' => '$3',
            ),
            // PicasaWeb Album (embed code)
            array(
                'match' => '#.*picasaweb.google.([a-zA-Z]{3})\/s\/c.*picasaweb.google.([a-zA-Z]{3})\/([a-zA-Z0-9\_\-\.]+)\/([a-zA-Z0-9\_\-\=\&\.\/\:\%]+).*#',
                'url'   => 'http://picasaweb.google.$2',
                'type'  => 'picasa',
                'var1' => '$3',
                'var2' => '$4',
            ),
            // PicasaWeb Album (direct link)
            array(
                'match' => '#.*picasaweb.google.([a-zA-Z]{3})\/([a-zA-Z0-9\_\-\.]+)\/([a-zA-Z0-9\_\-\=\&\.\/\:\%]+).*#',
                'url'   => 'http://picasaweb.google.$1',
                'type'  => 'picasa',
                'var1' => '$2',
                'var2' => '$3',
            ),
            // Flickr Set (RSS) - for Roy Tanck's widget
            array(
                'match' => '#.*api.flickr.com.*set=(\d+).*nsid=([a-zA-Z0-9\@]+).*#',
742
                'url'   => 'https://api.flickr.com/services/feeds/photoset.gne?set=$1&nsid=$2',
743
744
745
746
747
748
749
                'type'  => 'widget',
                'var1' => '$2',
                'var2' => '$1',
            ),
            // Flickr Set (direct link)
            array(
                'match' => '#.*www.flickr.com/photos/([a-zA-Z0-9\_\-\.\@]+).*/sets/([0-9]+).*#',
750
                'url'   => 'https://www.flickr.com/photos/$1/sets/$2/',
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
                'type'  => 'flickr',
                'var1' => '$1',
                'var2' => '$2',
            ),
            // Photobucket User Photos (direct link)
            array(
                'match' => '#.*([a-zA-Z0-9]+).photobucket.com/albums/([a-zA-Z0-9]+)/([a-zA-Z0-9\.\,\:\;\@\-\_\+\ ]+).*#',
                'url'   => 'http://$1.photobucket.com/albums/$2/$3',
                'type'  => 'photobucket',
                'var1' => '$3',
                'var2' => null,
            ),
            // Photobucket User Album Photos (direct link)
            array(
                'match' => '#.*([a-zA-Z0-9]+).photobucket.com/albums/([a-zA-Z0-9]+)/([a-zA-Z0-9\.\,\:\;\@\-\_\+\ ]+)/([a-zA-Z0-9\.\,\:\;\@\-\_\+\ ]*).*#',
                'url'   => 'http://$1.photobucket.com/albums/$2/$3/$4',
                'type'  => 'photobucket',
                'var1' => '$3',
                'var2' => '$4',
            ),
            // Windows Live Photo Gallery (MUST be a direct link to one of the photos in the album!)
            // This is a hack - in order to show photos from the album, we require a direct link to one of the photos.
            array(
                'match' => '#.*cid-([a-zA-Z0-9]+).photos.live.com/self.aspx/([a-zA-Z0-9\.\,\:\;\@\-\_\+\%\ ]+)/([a-zA-Z0-9\,\:\;\@\-\_\+\%\ ]+).(gif|png|jpg|jpeg)*#',
                'url'   => 'http://cid-$1.photos.live.com/self.aspx/$2/$3.$4',
                'type'  => 'windowslive',
                'var1' => 'cid-$1',
                'var2' => '$2',
            ),
        );

        foreach ($embedsources as $source) {
            $url = htmlspecialchars_decode($url); // convert &amp; back to &, etc.
            if (preg_match($source['match'], $url)) {
                $images_url = preg_replace($source['match'], $source['url'], $url);
                $images_type = $source['type'];
                $images_var1 = preg_replace($source['match'], $source['var1'], $url);
                $images_var2 = preg_replace($source['match'], $source['var2'], $url);
                return array('url' => $images_url, 'type' => $images_type, 'var1' => $images_var1, 'var2' => $images_var2);
            }
        }
        return array();
    }

    /**
     * Returns a block of HTML that the Gallery block can use to list
     * which external galleries or photo services are supported.
     */
    private static function get_supported_external_galleries() {
        $smarty = smarty_core();
        $smarty->assign('wwwroot', get_config('wwwroot'));
802
        if (is_https() === true) {
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
            $smarty->assign('protocol', 'https');
        }
        else {
            $smarty->assign('protocol', 'http');
        }
        return $smarty->fetch('blocktype:gallery:supported.tpl');
    }

    // Function to find nearest value (in array of values) to given value
    // e.g.: user defined thumbnail width is 75, abvaliable picasa thumbnails are array(32, 48, 64, 72, 104, 144, 150, 160)
    //         so this function should return 72 (which is nearest form available values)
    // Function found at http://www.sitepoint.com/forums/showthread.php?t=537541
    public static function find_nearest($values, $item) {
        if (in_array($item,$values)) {
            $out = $item;
        }
        else {
            sort($values);
            $length = count($values);
            for ($i=0; $i<$length; $i++) {
                if ($values[$i] > $item) {
                    if ($i == 0) {
                        return $values[$i];
                    }
                    $out = ($item - $values[$i-1]) > ($values[$i]-$item) ? $values[$i] : $values[$i-1];
                    break;
                }
            }
        }
        if (!isset($out)) {
            $out = end($values);
        }
        return $out;
    }

Evan Goldenberg's avatar
Evan Goldenberg committed
838
839
840
841
842
843
    public static function artefactchooser_element($default=null) {
    }

    public static function default_copy_type() {
        return 'full';
    }
844
845
846
847
848
849
850
851
852
853

    public static function get_current_artefacts(BlockInstance $instance) {
        $configdata = $instance->get('configdata');
        $artefacts = array();
        if (isset($configdata['artefactid'])) {
            safe_require('artefact', 'file');
            $artefacts = artefact_get_descendants(array(intval($configdata['artefactid'])));
        }
        return $artefacts;
    }
Evan Goldenberg's avatar
Evan Goldenberg committed
854
}