MDL-36616 repository: Fix direct linking to images in Flickr Public.
[moodle.git] / repository / flickr_public / lib.php
CommitLineData
539b3d13 1<?php
10d53fd3
DC
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
67233725
DC
17/**
18 * This plugin is used to access flickr pictures
19 *
20 * @since 2.0
21 * @package repository_flickr_public
22 * @copyright 2010 Dongsheng Cai {@link http://dongsheng.org}
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25require_once($CFG->dirroot . '/repository/lib.php');
26require_once($CFG->libdir.'/flickrlib.php');
27require_once(dirname(__FILE__) . '/image.php');
28
539b3d13 29/**
30 * repository_flickr_public class
31 * This one is used to create public repository
49d20def
DC
32 * You can set up a public account in admin page, so everyone can access
33 * flickr photos from this plugin
539b3d13 34 *
10d53fd3 35 * @since 2.0
67233725
DC
36 * @package repository_flickr_public
37 * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
d078f6d3 38 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
539b3d13 39 */
dc0976b8 40class repository_flickr_public extends repository {
539b3d13 41 private $flickr;
42 public $photos;
43
82bf5b10
FM
44 /**
45 * Stores sizes of images to prevent multiple API call
46 */
47 static private $sizes = array();
48
49d20def
DC
49 /**
50 * constructor method
51 *
52 * @global object $CFG
53 * @global object $SESSION
54 * @param int $repositoryid
55 * @param int $context
56 * @param array $options
57 * @param boolean $readonly
58 */
59 public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array(), $readonly=0) {
60 global $CFG, $SESSION;
61 parent::__construct($repositoryid, $context, $options,$readonly);
62 $this->api_key = $this->get_option('api_key');
63 $this->flickr = new phpFlickr($this->api_key);
64 $this->flickr_account = $this->get_option('email_address');
2c40911a 65 $this->usewatermarks = $this->get_option('usewatermarks');
49d20def
DC
66
67 $account = optional_param('flickr_account', '', PARAM_RAW);
68 $fulltext = optional_param('flickr_fulltext', '', PARAM_RAW);
69 if (empty($fulltext)) {
70 $fulltext = optional_param('s', '', PARAM_RAW);
71 }
72 $tag = optional_param('flickr_tag', '', PARAM_RAW);
73 $license = optional_param('flickr_license', '', PARAM_RAW);
74
75 $this->sess_account = 'flickr_public_'.$this->id.'_account';
76 $this->sess_tag = 'flickr_public_'.$this->id.'_tag';
77 $this->sess_text = 'flickr_public_'.$this->id.'_text';
78
79 if (!empty($account) or !empty($fulltext) or !empty($tag) or !empty($license)) {
80 $SESSION->{$this->sess_tag} = $tag;
81 $SESSION->{$this->sess_text} = $fulltext;
82 $SESSION->{$this->sess_account} = $account;
83 }
84 }
85
96297ca2 86 /**
6b2a6c90 87 * save api_key in config table
88 * @param array $options
89 * @return boolean
96297ca2 90 */
dc0976b8 91 public function set_option($options = array()) {
539b3d13 92 if (!empty($options['api_key'])) {
93 set_config('api_key', trim($options['api_key']), 'flickr_public');
94 }
95 unset($options['api_key']);
99eaca9d 96 return parent::set_option($options);
539b3d13 97 }
98
96297ca2 99 /**
6b2a6c90 100 * get api_key from config table
99eaca9d 101 *
6b2a6c90 102 * @param string $config
103 * @return mixed
96297ca2 104 */
dc0976b8 105 public function get_option($config = '') {
106 if ($config==='api_key') {
539b3d13 107 return trim(get_config('flickr_public', 'api_key'));
108 } else {
109 $options['api_key'] = trim(get_config('flickr_public', 'api_key'));
110 }
99eaca9d 111 return parent::get_option($config);
539b3d13 112 }
113
96297ca2 114 /**
6b2a6c90 115 * is global_search available?
99eaca9d 116 *
6b2a6c90 117 * @return boolean
96297ca2 118 */
dc0976b8 119 public function global_search() {
539b3d13 120 if (empty($this->flickr_account)) {
121 return false;
122 } else {
123 return true;
124 }
125 }
126
96297ca2 127 /**
49d20def 128 * check if flickr account
6b2a6c90 129 * @return boolean
96297ca2 130 */
dc0976b8 131 public function check_login() {
d68c527f 132 return !empty($this->flickr_account);
133 }
96297ca2 134
135 /**
99eaca9d 136 * construct login form
96297ca2 137 *
6b2a6c90 138 * @param boolean $ajax
139 * @return array
96297ca2 140 */
78ff2983 141 public function print_login() {
142 if ($this->options['ajax']) {
d68c527f 143 $ret = array();
6bdfef5d 144 $fulltext = new stdClass();
6b2a6c90 145 $fulltext->label = get_string('fulltext', 'repository_flickr_public').': ';
146 $fulltext->id = 'el_fulltext';
147 $fulltext->type = 'text';
148 $fulltext->name = 'flickr_fulltext';
149
6bdfef5d 150 $tag = new stdClass();
6b2a6c90 151 $tag->label = get_string('tag', 'repository_flickr_public').': ';
152 $tag->id = 'el_tag';
153 $tag->type = 'text';
154 $tag->name = 'flickr_tag';
155
6bdfef5d 156 $email_field = new stdClass();
ca0174cc 157 $email_field->label = get_string('username', 'repository_flickr_public').': ';
158 $email_field->id = 'account';
159 $email_field->type = 'text';
160 $email_field->name = 'flickr_account';
45983072 161
6bdfef5d 162 $commercial = new stdClass();
16e9dccd 163 $commercial->label = get_string('commercialuse', 'repository_flickr_public').': ';
164 $commercial->id = 'flickr_commercial_id';
640bb8c1 165 $commercial->type = 'checkbox';
16e9dccd 166 $commercial->name = 'flickr_commercial';
640bb8c1 167 $commercial->value = 'yes';
9f50fb5f 168
6bdfef5d 169 $modification = new stdClass();
16e9dccd 170 $modification->label = get_string('modification', 'repository_flickr_public').': ';
171 $modification->id = 'flickr_modification_id';
640bb8c1 172 $modification->type = 'checkbox';
16e9dccd 173 $modification->name = 'flickr_modification';
640bb8c1 174 $modification->value = 'yes';
16e9dccd 175
176 $ret['login'] = array($fulltext, $tag, $email_field, $commercial, $modification);
45983072 177 $ret['login_btn_label'] = get_string('search');
da2946c9 178 $ret['login_btn_action'] = 'search';
d68c527f 179 return $ret;
78ff2983 180 } else {
181 echo '<table>';
182 echo '<tr><td><label>'.get_string('fulltext', 'repository_flickr_public').'</label></td>';
183 echo '<td><input type="text" name="flickr_fulltext" /></td></tr>';
184 echo '<tr><td><label>'.get_string('tag', 'repository_flickr_public').'</label></td>';
185 echo '<td><input type="text" name="flickr_tag" /></td></tr>';
186 echo '<tr><td><label>'.get_string('username', 'repository_flickr_public').'</label></td>';
187 echo '<td><input type="text" name="flickr_account" /></td></tr>';
188
16e9dccd 189 echo '<tr><td><label>'.get_string('commercialuse', 'repository_flickr_public').'</label></td>';
78ff2983 190 echo '<td>';
640bb8c1 191 echo '<input type="checkbox" name="flickr_commercial" value="yes" />';
16e9dccd 192 echo '</td></tr>';
193
194 echo '<tr><td><label>'.get_string('modification', 'repository_flickr_public').'</label></td>';
195 echo '<td>';
640bb8c1 196 echo '<input type="checkbox" name="flickr_modification" value="yes" />';
78ff2983 197 echo '</td></tr>';
198
199 echo '</table>';
200
201 echo '<input type="hidden" name="action" value="search" />';
362a728f 202 echo '<input type="submit" value="'.get_string('search', 'repository').'" />';
539b3d13 203 }
204 }
96297ca2 205
aa48f05d 206 /**
99eaca9d 207 * destroy session
aa48f05d 208 *
99eaca9d 209 * @return object
aa48f05d 210 */
211 public function logout() {
6b2a6c90 212 global $SESSION;
213 unset($SESSION->{$this->sess_tag});
214 unset($SESSION->{$this->sess_text});
215 unset($SESSION->{$this->sess_account});
aa48f05d 216 return $this->print_login();
217 }
218
1dce6261
DC
219 public function license4moodle ($license_id) {
220 $license = array(
668ba1e9 221 '0' => 'allrightsreserved',
1dce6261
DC
222 '1' => 'cc-nc-sa',
223 '2' => 'cc-nc',
224 '3' => 'cc-nc-nd',
225 '4' => 'cc',
226 '5' => 'cc-sa',
227 '6' => 'cc-nd',
668ba1e9 228 '7' => 'other'
1dce6261
DC
229 );
230 return $license[$license_id];
231 }
232
96297ca2 233 /**
99eaca9d 234 * search images on flickr
96297ca2 235 *
99eaca9d
DC
236 * @param string $search_text
237 * @return array
96297ca2 238 */
68a7c9a6 239 public function search($search_text, $page = 0) {
86e68c2d 240 global $SESSION;
d1bfc05e 241 $ret = array();
99eaca9d
DC
242 if (empty($page)) {
243 $page = 1;
244 }
245
6b2a6c90 246 if (!empty($this->flickr_account)) {
247 $people = $this->flickr->people_findByEmail($this->flickr_account);
248 $this->nsid = $people['nsid'];
249 }
250 if (!empty($SESSION->{$this->sess_account})) {
251 $people = $this->flickr->people_findByEmail($SESSION->{$this->sess_account});
252 $this->nsid = $people['nsid'];
253 }
254 if (empty($this->nsid)) {
255 $this->nsid = null;
d1bfc05e 256 // user specify a flickr account, but it is not valid
257 if (!empty($this->flickr_account) or !empty($SESSION->{$this->sess_account})) {
258 $ret['e'] = get_string('invalidemail', 'repository_flickr_public');
259 return $ret;
260 }
6b2a6c90 261 }
99eaca9d 262
16e9dccd 263 // including all licenses by default
264 $licenses = array(1=>1, 2, 3, 4, 5, 6, 7);
265
266 $commercial = optional_param('flickr_commercial', '', PARAM_RAW);
267 $modification = optional_param('flickr_modification', '', PARAM_RAW);
268
269 if ($commercial == 'yes') {
270 // including
271 // 4: Attribution License
272 // 5: Attribution ShareAlike
273 // 6: Attribution NoDerives
274 // 7: unknown license
275 unset($licenses[1], $licenses[2], $licenses[3]);
276 }
277 if ($modification == 'yes') {
278 // including
279 // 1: Attribution NonCommercial ShareAlike
280 // 2: Attribution NonCommercial
281 // 4: Attribution License
282 // 5: Attribution ShareAlike
283 // 7: unknown license
284 unset($licenses[3], $licenses[6]);
285 }
640bb8c1 286 //if ($modification == 'sharealike') {
16e9dccd 287 // including
288 // 1: Attribution NonCommercial ShareAlike
289 // 5: Attribution ShareAlike
640bb8c1
MD
290 //unset($licenses[2], $licenses[3], $licenses[4], $licenses[6], $licenses[7]);
291 //}
16e9dccd 292
293 $licenses = implode(',', $licenses);
294
da78b10c
DC
295 $tag = !empty($SESSION->{$this->sess_tag}) ? $SESSION->{$this->sess_tag} : null;
296 $text = !empty($SESSION->{$this->sess_text}) ? $SESSION->{$this->sess_text} : null;
297 $nsid = !empty($this->nsid) ? $this->nsid : null;
298
299 $photos = $this->flickr->photos_search(array(
300 'tags'=>$tag,
301 'page'=>$page,
302 'per_page'=>24,
303 'user_id'=>$nsid,
304 'license'=>$licenses,
305 'text'=>$text
306 )
307 );
009a97ce 308 $ret['total'] = $photos['total'];
309 $ret['perpage'] = $photos['perpage'];
9f50fb5f 310 if (empty($photos)) {
311 $ret['list'] = array();
312 return $ret;
313 }
c438f190 314 $ret = $this->build_list($photos, $page, $ret);
315 $ret['list'] = array_filter($ret['list'], array($this, 'filter'));
316 return $ret;
fbd508b4 317 }
96297ca2 318
319 /**
99eaca9d 320 * return an image list
96297ca2 321 *
5fa358d1 322 * @param string $path
323 * @param int $page
99eaca9d 324 * @return array
96297ca2 325 */
5fa358d1 326 public function get_listing($path = '', $page = 1) {
539b3d13 327 $people = $this->flickr->people_findByEmail($this->flickr_account);
353d5cf3 328 $this->nsid = $people['nsid'];
5fa358d1 329 $photos = $this->flickr->people_getPublicPhotos($people['nsid'], 'original_format', 24, $page);
86e68c2d 330 $ret = array();
539b3d13 331
5fa358d1 332 return $this->build_list($photos, $page, $ret);
353d5cf3 333 }
96297ca2 334
335 /**
99eaca9d 336 * build an image list
96297ca2 337 *
99eaca9d
DC
338 * @param array $photos
339 * @param int $page
340 * @return array
96297ca2 341 */
5fa358d1 342 private function build_list($photos, $page = 1, &$ret) {
6b2a6c90 343 if (!empty($this->nsid)) {
344 $photos_url = $this->flickr->urls_getUserPhotos($this->nsid);
345 $ret['manage'] = $photos_url;
346 }
539b3d13 347 $ret['list'] = array();
fdfb9cbe
DC
348 $ret['nosearch'] = true;
349 $ret['norefresh'] = true;
350 $ret['logouttext'] = get_string('backtosearch', 'repository_flickr_public');
539b3d13 351 $ret['pages'] = $photos['pages'];
5fa358d1 352 if (is_int($page) && $page <= $ret['pages']) {
353 $ret['page'] = $page;
539b3d13 354 } else {
355 $ret['page'] = 1;
356 }
353d5cf3 357 if (!empty($photos['photo'])) {
358 foreach ($photos['photo'] as $p) {
359 if(empty($p['title'])) {
360 $p['title'] = get_string('notitle', 'repository_flickr');
361 }
362 if (isset($p['originalformat'])) {
363 $format = $p['originalformat'];
364 } else {
365 $format = 'jpg';
366 }
0e51661b 367 $format = '.'.$format;
0e51661b 368 if (substr($p['title'], strlen($p['title'])-strlen($format)) != $format) {
d1bfc05e 369 // append author id
5fdc39c7 370 // $p['title'] .= '-'.$p['owner'];
d1bfc05e 371 // append file extension
4317f92f 372 $p['title'] .= $format;
0e51661b 373 }
1dce6261
DC
374 $ret['list'][] = array(
375 'title'=>$p['title'],
376 'source'=>$p['id'],
377 'id'=>$p['id'],
378 'thumbnail'=>$this->flickr->buildPhotoURL($p, 'Square'),
379 'date'=>'',
380 'size'=>'unknown',
381 'url'=>'http://www.flickr.com/photos/'.$p['owner'].'/'.$p['id'],
382 'haslicense'=>true,
383 'hasauthor'=>true
384 );
539b3d13 385 }
539b3d13 386 }
353d5cf3 387 return $ret;
539b3d13 388 }
dc0976b8 389
96297ca2 390 /**
99d52655 391 * Print a search form
96297ca2 392 *
99d52655 393 * @return string
96297ca2 394 */
dc0976b8 395 public function print_search() {
b763c2d9 396 $str = '';
397 $str .= '<input type="hidden" name="repo_id" value="'.$this->id.'" />';
398 $str .= '<input type="hidden" name="ctx_id" value="'.$this->context->id.'" />';
399 $str .= '<input type="hidden" name="seekey" value="'.sesskey().'" />';
400 $str .= '<label>'.get_string('fulltext', 'repository_flickr_public').': </label><br/><input name="s" value="" /><br/>';
1238246b 401 $str .= '<label>'.get_string('tag', 'repository_flickr_public').'</label><br /><input type="text" name="flickr_tag" /><br />';
b763c2d9 402 return $str;
539b3d13 403 }
dc0976b8 404
d6453211
DC
405 /**
406 * Return photo url by given photo id
407 * @param string $photoid
408 * @return string
409 */
410 private function build_photo_url($photoid) {
82bf5b10
FM
411 $bestsize = $this->get_best_size($photoid);
412 if (!isset($bestsize['source'])) {
413 throw new repository_exception('cannotdownload', 'repository');
414 }
415 return $bestsize['source'];
416 }
417
418 /**
419 * Returns the best size for a photo
420 *
421 * @param string $photoid the photo identifier
422 * @return array of information provided by the API
423 */
424 protected function get_best_size($photoid) {
425 if (!isset(self::$sizes[$photoid])) {
426 // Sizes are returned from smallest to greatest.
427 self::$sizes[$photoid] = $this->flickr->photos_getSizes($photoid);
428 }
429 $sizes = self::$sizes[$photoid];
430 $bestsize = array();
431 if (is_array($sizes)) {
432 while ($bestsize = array_pop($sizes)) {
433 // Make sure the source is set. Exit the loop if found.
434 if (isset($bestsize['source'])) {
435 break;
436 }
437 }
99d52655 438 }
82bf5b10 439 return $bestsize;
99d52655
DC
440 }
441
d6453211 442 public function get_link($photoid) {
a34209d5 443 return $this->build_photo_url($photoid);
d6453211
DC
444 }
445
96297ca2 446 /**
447 *
009a97ce 448 * @global object $CFG
d6453211 449 * @param string $photoid
009a97ce 450 * @param string $file
451 * @return string
96297ca2 452 */
d6453211 453 public function get_file($photoid, $file = '') {
539b3d13 454 global $CFG;
d6453211 455 $info = $this->flickr->photos_getInfo($photoid);
2c40911a
DC
456 if ($info['owner']['realname']) {
457 $author = $info['owner']['realname'];
458 } else {
459 $author = $info['owner']['username'];
460 }
461 $copyright = get_string('author', 'repository') . ': ' . $author;
82bf5b10
FM
462
463 // If we can read the original secret, it means that we have access to the original picture.
464 if (isset($info['originalsecret'])) {
465 $source = $this->flickr->buildPhotoURL($info, 'original');
466 } else {
467 $source = $this->build_photo_url($photoid);
539b3d13 468 }
82bf5b10 469
e53394ba
MG
470 $result = parent::get_file($source, $file);
471 $path = $result['path'];
82bf5b10 472
2c40911a
DC
473 if (!empty($this->usewatermarks)) {
474 $img = new moodle_image($path);
475 $img->watermark($copyright, array(10,10), array('ttf'=>true, 'fontsize'=>12))->saveas($path);
476 }
1dce6261 477
82bf5b10 478 return array('path'=>$path, 'author'=>$info['owner']['realname'], 'license'=>$this->license4moodle($info['license']));
539b3d13 479 }
539b3d13 480
96297ca2 481 /**
792ad3aa 482 * Add Instance settings input to Moodle form
99eaca9d 483 * @param object $mform
96297ca2 484 */
4a126f17 485 public static function instance_config_form($mform) {
b8f46e17 486 $mform->addElement('text', 'email_address', get_string('emailaddress', 'repository_flickr_public'));
2c40911a 487 $mform->addElement('checkbox', 'usewatermarks', get_string('watermark', 'repository_flickr_public'));
d55846d8 488 $mform->setDefault('usewatermarks', 0);
b8f46e17 489 }
490
96297ca2 491 /**
792ad3aa 492 * Names of the instance settings
99eaca9d 493 * @return array
96297ca2 494 */
b8f46e17 495 public static function get_instance_option_names() {
2c40911a 496 return array('email_address', 'usewatermarks');
539b3d13 497 }
498
96297ca2 499 /**
792ad3aa 500 * Add Plugin settings input to Moodle form
99eaca9d 501 * @param object $mform
96297ca2 502 */
68a7c9a6 503 public static function type_config_form($mform, $classname = 'repository') {
539b3d13 504 $api_key = get_config('flickr_public', 'api_key');
505 if (empty($api_key)) {
506 $api_key = '';
507 }
508 $strrequired = get_string('required');
d1bfc05e 509
539b3d13 510 $mform->addElement('text', 'api_key', get_string('apikey', 'repository_flickr_public'), array('value'=>$api_key,'size' => '40'));
539b3d13 511 $mform->addRule('api_key', $strrequired, 'required', null, 'client');
d1bfc05e 512
e49eaacb 513 $mform->addElement('static', null, '', get_string('information','repository_flickr_public'));
539b3d13 514 }
b8f46e17 515
96297ca2 516 /**
792ad3aa 517 * Names of the plugin settings
49d20def 518 * @return array
96297ca2 519 */
1b79955a 520 public static function get_type_option_names() {
a5adfa26 521 return array('api_key', 'pluginname');
b8f46e17 522 }
523
96297ca2 524 /**
83a018ed 525 * is run when moodle administrator add the plugin
96297ca2 526 */
948c2860 527 public static function plugin_init() {
e49eaacb 528 //here we create a default instance for this type
539b3d13 529
d55846d8 530 $id = repository::static_function('flickr_public','create', 'flickr_public', 0, get_system_context(), array('name'=>'', 'email_address' => null, 'usewatermarks' => false), 0);
60c366e8 531 if (empty($id)) {
532 return false;
533 } else {
534 return true;
535 }
dbc01944 536 }
014c1ca0 537 public function supported_filetypes() {
538 return array('web_image');
539 }
41076c58
DC
540 public function supported_returntypes() {
541 return (FILE_INTERNAL | FILE_EXTERNAL);
542 }
d6453211
DC
543
544 /**
545 * Return the source information
546 *
547 * @param string $photoid photo id
548 * @return string|null
549 */
550 public function get_file_source_info($photoid) {
551 return $this->build_photo_url($photoid);
552 }
539b3d13 553}