74fac87312f8b00b4013741fe08949920010cb84
[moodle.git] / repository / flickr_public / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * repository_flickr_public class
20  * This one is used to create public repository
21  * You can set up a public account in admin page, so everyone can access
22  * flickr photos from this plugin
23  *
24  * @since 2.0
25  * @package    repository
26  * @subpackage flickr_public
27  * @copyright  2009 Dongsheng Cai
28  * @author     Dongsheng Cai <dongsheng@moodle.com>
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
32 require_once($CFG->libdir.'/flickrlib.php');
34 class repository_flickr_public extends repository {
35     private $flickr;
36     public $photos;
38     /**
39      * constructor method
40      *
41      * @global object $CFG
42      * @global object $SESSION
43      * @param int $repositoryid
44      * @param int $context
45      * @param array $options
46      * @param boolean $readonly
47      */
48     public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array(), $readonly=0) {
49         global $CFG, $SESSION;
50         parent::__construct($repositoryid, $context, $options,$readonly);
51         $this->api_key = $this->get_option('api_key');
52         $this->flickr  = new phpFlickr($this->api_key);
53         $this->flickr_account = $this->get_option('email_address');
55         $account  = optional_param('flickr_account', '', PARAM_RAW);
56         $fulltext = optional_param('flickr_fulltext', '', PARAM_RAW);
57         if (empty($fulltext)) {
58             $fulltext = optional_param('s', '', PARAM_RAW);
59         }
60         $tag      = optional_param('flickr_tag', '', PARAM_RAW);
61         $license  = optional_param('flickr_license', '', PARAM_RAW);
63         $this->sess_account = 'flickr_public_'.$this->id.'_account';
64         $this->sess_tag     = 'flickr_public_'.$this->id.'_tag';
65         $this->sess_text    = 'flickr_public_'.$this->id.'_text';
67         if (!empty($account) or !empty($fulltext) or !empty($tag) or !empty($license)) {
68             $SESSION->{$this->sess_tag}  = $tag;
69             $SESSION->{$this->sess_text} = $fulltext;
70             $SESSION->{$this->sess_account} = $account;
71         }
72     }
74     /**
75      * save api_key in config table
76      * @param array $options
77      * @return boolean
78      */
79     public function set_option($options = array()) {
80         if (!empty($options['api_key'])) {
81             set_config('api_key', trim($options['api_key']), 'flickr_public');
82         }
83         unset($options['api_key']);
84         return parent::set_option($options);
85     }
87     /**
88      * get api_key from config table
89      *
90      * @param string $config
91      * @return mixed
92      */
93     public function get_option($config = '') {
94         if ($config==='api_key') {
95             return trim(get_config('flickr_public', 'api_key'));
96         } else {
97             $options['api_key'] = trim(get_config('flickr_public', 'api_key'));
98         }
99         return parent::get_option($config);
100     }
102     /**
103      * is global_search available?
104      *
105      * @return boolean
106      */
107     public function global_search() {
108         if (empty($this->flickr_account)) {
109             return false;
110         } else {
111             return true;
112         }
113     }
115     /**
116      * check if flickr account
117      * @return boolean
118      */
119     public function check_login() {
120         return !empty($this->flickr_account);
121     }
123     /**
124      * construct login form
125      *
126      * @param boolean $ajax
127      * @return array
128      */
129     public function print_login() {
130         if ($this->options['ajax']) {
131             $ret = array();
132             $fulltext = new stdClass();
133             $fulltext->label = get_string('fulltext', 'repository_flickr_public').': ';
134             $fulltext->id    = 'el_fulltext';
135             $fulltext->type = 'text';
136             $fulltext->name = 'flickr_fulltext';
138             $tag = new stdClass();
139             $tag->label = get_string('tag', 'repository_flickr_public').': ';
140             $tag->id    = 'el_tag';
141             $tag->type = 'text';
142             $tag->name = 'flickr_tag';
144             $email_field = new stdClass();
145             $email_field->label = get_string('username', 'repository_flickr_public').': ';
146             $email_field->id    = 'account';
147             $email_field->type = 'text';
148             $email_field->name = 'flickr_account';
150             $commercial = new stdClass();
151             $commercial->label = get_string('commercialuse', 'repository_flickr_public').': ';
152             $commercial->id    = 'flickr_commercial_id';
153             $commercial->type  = 'checkbox';
154             $commercial->name  = 'flickr_commercial';
155             $commercial->value = 'yes';
157             $modification = new stdClass();
158             $modification->label = get_string('modification', 'repository_flickr_public').': ';
159             $modification->id    = 'flickr_modification_id';
160             $modification->type  = 'checkbox';
161             $modification->name  = 'flickr_modification';
162             $modification->value = 'yes';
164             $ret['login'] = array($fulltext, $tag, $email_field, $commercial, $modification);
165             $ret['login_btn_label'] = get_string('search');
166             $ret['login_btn_action'] = 'search';
167             return $ret;
168         } else {
169             echo '<table>';
170             echo '<tr><td><label>'.get_string('fulltext', 'repository_flickr_public').'</label></td>';
171             echo '<td><input type="text" name="flickr_fulltext" /></td></tr>';
172             echo '<tr><td><label>'.get_string('tag', 'repository_flickr_public').'</label></td>';
173             echo '<td><input type="text" name="flickr_tag" /></td></tr>';
174             echo '<tr><td><label>'.get_string('username', 'repository_flickr_public').'</label></td>';
175             echo '<td><input type="text" name="flickr_account" /></td></tr>';
177             echo '<tr><td><label>'.get_string('commercialuse', 'repository_flickr_public').'</label></td>';
178             echo '<td>';
179             echo '<input type="checkbox" name="flickr_commercial" value="yes" />';
180             echo '</td></tr>';
182             echo '<tr><td><label>'.get_string('modification', 'repository_flickr_public').'</label></td>';
183             echo '<td>';
184             echo '<input type="checkbox" name="flickr_modification" value="yes" />';
185             echo '</td></tr>';
187             echo '</table>';
189             echo '<input type="hidden" name="action" value="search" />';
190             echo '<input type="submit" value="'.get_string('search', 'repository').'" />';
191         }
192     }
194     /**
195      * destroy session
196      *
197      * @return object
198      */
199     public function logout() {
200         global $SESSION;
201         unset($SESSION->{$this->sess_tag});
202         unset($SESSION->{$this->sess_text});
203         unset($SESSION->{$this->sess_account});
204         return $this->print_login();
205     }
207     public function license4moodle ($license_id) {
208         $license = array(
209             '1' => 'cc-nc-sa',
210             '2' => 'cc-nc',
211             '3' => 'cc-nc-nd',
212             '4' => 'cc',
213             '5' => 'cc-sa',
214             '6' => 'cc-nd',
215             '7' => 'allrightsreserved'
216             );
217         return $license[$license_id];
218     }
220     /**
221      * search images on flickr
222      *
223      * @param string $search_text
224      * @return array
225      */
226     public function search($search_text, $page = 1) {
227         global $SESSION;
228         $ret = array();
229         if (empty($page)) {
230             $page = 1;
231         }
233         if (!empty($this->flickr_account)) {
234             $people = $this->flickr->people_findByEmail($this->flickr_account);
235             $this->nsid = $people['nsid'];
236         }
237         if (!empty($SESSION->{$this->sess_account})) {
238             $people = $this->flickr->people_findByEmail($SESSION->{$this->sess_account});
239             $this->nsid = $people['nsid'];
240         }
241         if (empty($this->nsid)) {
242             $this->nsid = null;
243             // user specify a flickr account, but it is not valid
244             if (!empty($this->flickr_account) or !empty($SESSION->{$this->sess_account})) {
245                 $ret['e'] = get_string('invalidemail', 'repository_flickr_public');
246                 return $ret;
247             }
248         }
250         // including all licenses by default
251         $licenses = array(1=>1, 2, 3, 4, 5, 6, 7);
253         $commercial   = optional_param('flickr_commercial', '', PARAM_RAW);
254         $modification = optional_param('flickr_modification', '', PARAM_RAW);
256         if ($commercial == 'yes') {
257             // including
258             // 4: Attribution License
259             // 5: Attribution ShareAlike
260             // 6: Attribution NoDerives
261             // 7: unknown license
262             unset($licenses[1], $licenses[2], $licenses[3]);
263         }
264         if ($modification == 'yes') {
265             // including
266             // 1: Attribution NonCommercial ShareAlike
267             // 2: Attribution NonCommercial
268             // 4: Attribution License
269             // 5: Attribution ShareAlike
270             // 7: unknown license
271             unset($licenses[3], $licenses[6]);
272         }
273         //if ($modification == 'sharealike') {
274             // including
275             // 1: Attribution NonCommercial ShareAlike
276             // 5: Attribution ShareAlike
277             //unset($licenses[2], $licenses[3], $licenses[4], $licenses[6], $licenses[7]);
278         //}
280         $licenses = implode(',', $licenses);
282         if (!empty($SESSION->{$this->sess_tag})         // use tag to search
283             or !empty($SESSION->{$this->sess_text})     // use keyword to search
284             or !empty($this->nsid)/*use pre-defined accound*/) {
285             $photos = $this->flickr->photos_search(array(
286                 'tags'=>$SESSION->{$this->sess_tag},
287                 'page'=>$page,
288                 'per_page'=>24,
289                 'user_id'=>$this->nsid,
290                 'license'=>$licenses,
291                 'text'=>$SESSION->{$this->sess_text}
292                 )
293             );
294         }
295         $ret['total'] = $photos['total'];
296         $ret['perpage'] = $photos['perpage'];
297         if (empty($photos)) {
298             $ret['list'] = array();
299             return $ret;
300         }
301         $ret = $this->build_list($photos, $page, $ret);
302         $ret['list'] = array_filter($ret['list'], array($this, 'filter'));
303         return $ret;
304     }
306     /**
307      * return an image list
308      *
309      * @param string $path
310      * @param int $page
311      * @return array
312      */
313     public function get_listing($path = '', $page = 1) {
314         $people = $this->flickr->people_findByEmail($this->flickr_account);
315         $this->nsid = $people['nsid'];
316         $photos = $this->flickr->people_getPublicPhotos($people['nsid'], 'original_format', 24, $page);
317         $ret = array();
319         return $this->build_list($photos, $page, $ret);
320     }
322     /**
323      * build an image list
324      *
325      * @param array $photos
326      * @param int $page
327      * @return array
328      */
329     private function build_list($photos, $page = 1, &$ret) {
330         if (!empty($this->nsid)) {
331             $photos_url = $this->flickr->urls_getUserPhotos($this->nsid);
332             $ret['manage'] = $photos_url;
333         }
334         $ret['list']  = array();
335         $ret['nosearch'] = true;
336         $ret['norefresh'] = true;
337         $ret['logouttext'] = get_string('backtosearch', 'repository_flickr_public');
338         $ret['pages'] = $photos['pages'];
339         if (is_int($page) && $page <= $ret['pages']) {
340             $ret['page'] = $page;
341         } else {
342             $ret['page'] = 1;
343         }
344         if (!empty($photos['photo'])) {
345             foreach ($photos['photo'] as $p) {
346                 if(empty($p['title'])) {
347                     $p['title'] = get_string('notitle', 'repository_flickr');
348                 }
349                 if (isset($p['originalformat'])) {
350                     $format = $p['originalformat'];
351                 } else {
352                     $format = 'jpg';
353                 }
354                 $format = '.'.$format;
355                 if (substr($p['title'], strlen($p['title'])-strlen($format)) != $format) {
356                     // append author id
357                     // $p['title'] .= '-'.$p['owner'];
358                     // append file extension
359                     $p['title'] .= $format;
360                 }
361                 $ret['list'][] = array(
362                     'title'=>$p['title'],
363                     'source'=>$p['id'],
364                     'id'=>$p['id'],
365                     'thumbnail'=>$this->flickr->buildPhotoURL($p, 'Square'),
366                     'date'=>'',
367                     'size'=>'unknown',
368                     'url'=>'http://www.flickr.com/photos/'.$p['owner'].'/'.$p['id'],
369                     'haslicense'=>true,
370                     'hasauthor'=>true
371                 );
372             }
373         }
374         return $ret;
375     }
377     /**
378      * Print a search form
379      *
380      * @return string
381      */
382     public function print_search() {
383         $str = '';
384         $str .= '<input type="hidden" name="repo_id" value="'.$this->id.'" />';
385         $str .= '<input type="hidden" name="ctx_id" value="'.$this->context->id.'" />';
386         $str .= '<input type="hidden" name="seekey" value="'.sesskey().'" />';
387         $str .= '<label>'.get_string('fulltext', 'repository_flickr_public').': </label><br/><input name="s" value="" /><br/>';
388         $str .= '<label>'.get_string('tag', 'repository_flickr_public').'</label><br /><input type="text" name="flickr_tag" /><br />';
389         return $str;
390     }
392     public function get_link($photo_id) {
393         global $CFG;
394         $result = $this->flickr->photos_getSizes($photo_id);
395         $url = '';
396         if(!empty($result[4])) {
397             $url = $result[4]['source'];
398         } elseif(!empty($result[3])) {
399             $url = $result[3]['source'];
400         } elseif(!empty($result[2])) {
401             $url = $result[2]['source'];
402         }
403         return $url;
404     }
406     /**
407      *
408      * @global object $CFG
409      * @param string $photo_id
410      * @param string $file
411      * @return string
412      */
413     public function get_file($photo_id, $file = '') {
414         global $CFG;
415         $info = $this->flickr->photos_getInfo($photo_id);
416         $result = $this->flickr->photos_getSizes($photo_id);
417         // download link
418         $source = '';
419         // flickr photo page
420         $url = '';
421         if (!empty($result[4])) {
422             $source = $result[4]['source'];
423             $url = $result[4]['url'];
424         } elseif(!empty($result[3])) {
425             $source = $result[3]['source'];
426             $url = $result[3]['url'];
427         } elseif(!empty($result[2])) {
428             $source = $result[2]['source'];
429             $url = $result[2]['url'];
430         }
431         $path = $this->prepare_file($file);
432         $fp = fopen($path, 'w');
433         $c = new curl;
434         $c->download(array(array('url'=>$source, 'file'=>$fp)));
436         return array('path'=>$path, 'url'=>$url, 'author'=>$info['owner']['realname'], 'license'=>$this->license4moodle($info['license']));
437     }
439     /**
440      * Add Instance settings input to Moodle form
441      * @param object $mform
442      */
443     public function instance_config_form($mform) {
444         $mform->addElement('text', 'email_address', get_string('emailaddress', 'repository_flickr_public'));
445         //$mform->addRule('email_address', get_string('required'), 'required', null, 'client');
446     }
448     /**
449      * Names of the instance settings
450      * @return array
451      */
452     public static function get_instance_option_names() {
453         return array('email_address');
454     }
456     /**
457      * Add Plugin settings input to Moodle form
458      * @param object $mform
459      */
460     public function type_config_form($mform) {
461         $api_key = get_config('flickr_public', 'api_key');
462         if (empty($api_key)) {
463             $api_key = '';
464         }
465         $strrequired = get_string('required');
467         $mform->addElement('text', 'api_key', get_string('apikey', 'repository_flickr_public'), array('value'=>$api_key,'size' => '40'));
468         $mform->addRule('api_key', $strrequired, 'required', null, 'client');
470         $mform->addElement('static', null, '',  get_string('information','repository_flickr_public'));
471     }
473     /**
474      * Names of the plugin settings
475      * @return array
476      */
477     public static function get_type_option_names() {
478         return array('api_key', 'pluginname');
479     }
481     /**
482      * is run when moodle administrator add the plugin
483      */
484     public static function plugin_init() {
485         //here we create a default instance for this type
487         $id = repository::static_function('flickr_public','create', 'flickr_public', 0, get_system_context(), array('name'=>'', 'email_address' => null), 0);
488         if (empty($id)) {
489             return false;
490         } else {
491             return true;
492         }
493     }
494     public function supported_filetypes() {
495         return array('web_image');
496     }
497     public function supported_returntypes() {
498         return (FILE_INTERNAL | FILE_EXTERNAL);
499     }