"MDL-15488, fixed flickr plugin"
[moodle.git] / repository / flickr / repository.class.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 class
20  * This plugin is used to access user's private flickr repository
21  *
22  * @since 2.0
23  * @package moodlecore
24  * @subpackage repository
25  * @copyright 2009 Dongsheng Cai
26  * @author Dongsheng Cai <dongsheng@moodle.com>
27  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  */
30 require_once($CFG->libdir.'/flickrlib.php');
32 /**
33  *
34  */
35 class repository_flickr extends repository {
36     private $flickr;
37     public $photos;
39     /**
40      *
41      * @param int $repositoryid
42      * @param object $context
43      * @param array $options
44      */
45     public function __construct($repositoryid, $context = SITEID, $options = array()) {
46         global $SESSION, $CFG;
47         $options['page']    = optional_param('p', 1, PARAM_INT);
48         parent::__construct($repositoryid, $context, $options);
50         $this->setting = 'flickr_';
52         $this->api_key = $this->get_option('api_key');
53         $this->secret  = $this->get_option('secret');
55         $this->token = get_user_preferences($this->setting, '');
56         $this->nsid  = get_user_preferences($this->setting.'_nsid', '');
58         $this->flickr = new phpFlickr($this->api_key, $this->secret, $this->token);
60         $frob  = optional_param('frob', '', PARAM_RAW);
61         if (empty($this->token) && !empty($frob)) {
62             $auth_info = $this->flickr->auth_getToken($frob);
63             $this->token = $auth_info['token'];
64             $this->nsid  = $auth_info['user']['nsid'];
65             set_user_preference($this->setting, $auth_info['token']);
66             set_user_preference($this->setting.'_nsid', $auth_info['user']['nsid']);
67         }
69     }
71     /**
72      *
73      * @return bool
74      */
75     public function check_login() {
76         return !empty($this->token);
77     }
79     /**
80      *
81      * @return mixed
82      */
83     public function logout() {
84         set_user_preference($this->setting, '');
85         set_user_preference($this->setting.'_nsid', '');
86         $this->token = '';
87         $this->nsid  = '';
88         return $this->print_login();
89     }
91     /**
92      *
93      * @param array $options
94      * @return mixed
95      */
96     public function set_option($options = array()) {
97         if (!empty($options['api_key'])) {
98             set_config('api_key', trim($options['api_key']), 'flickr');
99         }
100         if (!empty($options['secret'])) {
101             set_config('secret', trim($options['secret']), 'flickr');
102         }
103         unset($options['api_key']);
104         unset($options['secret']);
105         $ret = parent::set_option($options);
106         return $ret;
107     }
109     /**
110      *
111      * @param string $config
112      * @return mixed
113      */
114     public function get_option($config = '') {
115         if ($config==='api_key') {
116             return trim(get_config('flickr', 'api_key'));
117         } elseif ($config ==='secret') {
118             return trim(get_config('flickr', 'secret'));
119         } else {
120             $options['api_key'] = trim(get_config('flickr', 'api_key'));
121             $options['secret']  = trim(get_config('flickr', 'secret'));
122         }
123         $options = parent::get_option($config);
124         return $options;
125     }
127     /**
128      *
129      * @return bool
130      */
131     public function global_search() {
132         if (empty($this->token)) {
133             return false;
134         } else {
135             return true;
136         }
137     }
139     /**
140      *
141      * @return null
142      */
143     public function print_login() {
144         if ($this->options['ajax']) {
145             $ret = array();
146             $popup_btn = new stdclass;
147             $popup_btn->type = 'popup';
148             $popup_btn->url = $this->flickr->auth();
149             $ret['login'] = array($popup_btn);
150             return $ret;
151         } else {
152             echo '<a target="_blank" href="'.$this->flickr->auth().'">'.get_string('login', 'repository').'</a>';
153         }
154     }
156     /**
157      *
158      * @param mixed $photos
159      * @param int $page
160      * @return array
161      */
162     private function build_list($photos, $page = 1) {
163         $photos_url = $this->flickr->urls_getUserPhotos($this->nsid);
164         $ret = array();
165         $ret['manage'] = $photos_url;
166         $ret['list']  = array();
167         $ret['pages'] = $photos['pages'];
168         $ret['total'] = $photos['total'];
169         $ret['perpage'] = $photos['perpage'];
170         if($page <= $ret['pages']) {
171             $ret['page'] = $page;
172         } else {
173             $ret['page'] = 1;
174         }
175         if (!empty($photos['photo'])) {
176             foreach ($photos['photo'] as $p) {
177                 if(empty($p['title'])) {
178                     $p['title'] = get_string('notitle', 'repository_flickr');
179                 }
180                 if (isset($p['originalformat'])) {
181                     $format = $p['originalformat'];
182                 } else {
183                     $format = 'jpg';
184                 }
185                 $format = '.'.$format;
186                 // append extensions to the files
187                 if (substr($p['title'], strlen($p['title'])-strlen($format)) != $format) {
188                     $p['title'] .= $format;
189                 }
190                 $ret['list'][] = array('title'=>$p['title'],'source'=>$p['id'],
191                     'id'=>$p['id'],'thumbnail'=>$this->flickr->buildPhotoURL($p, 'Square'),
192                     'date'=>'', 'size'=>'unknown', 'url'=>$photos_url.$p['id']);
193             }
194         }
195         return $ret;
196     }
198     /**
199      *
200      * @param string $search_text
201      * @return array
202      */
203     public function search($search_text) {
204         $photos = $this->flickr->photos_search(array(
205             'user_id'=>$this->nsid,
206             'per_page'=>24,
207             'extras'=>'original_format',
208             'text'=>$search_text
209             ));
210         $ret = $this->build_list($photos);
211         $ret['list'] = array_filter($ret['list'], array($this, 'filter'));
212         return $ret;
213     }
215     /**
216      *
217      * @param string $path
218      * @param int $page
219      * @return array
220      */
221     public function get_listing($path = '', $page = '1') {
222         $photos_url = $this->flickr->urls_getUserPhotos($this->nsid);
224         $photos = $this->flickr->photos_search(array(
225             'user_id'=>$this->nsid,
226             'per_page'=>24,
227             'page'=>$page,
228             'extras'=>'original_format'
229             ));
230         return $this->build_list($photos, $page);
231     }
233     public function get_link($photo_id) {
234         global $CFG;
235         $result = $this->flickr->photos_getSizes($photo_id);
236         $url = '';
237         if(!empty($result[4])) {
238             $url = $result[4]['source'];
239         } elseif(!empty($result[3])) {
240             $url = $result[3]['source'];
241         } elseif(!empty($result[2])) {
242             $url = $result[2]['source'];
243         }
244         return $url;
245     }
247     /**
248      *
249      * @param string $photo_id
250      * @param string $file
251      * @return string
252      */
253     public function get_file($photo_id, $file = '') {
254         global $CFG;
255         $result = $this->flickr->photos_getSizes($photo_id);
256         $url = '';
257         if(!empty($result[4])) {
258             $url = $result[4]['source'];
259         } elseif(!empty($result[3])) {
260             $url = $result[3]['source'];
261         } elseif(!empty($result[2])) {
262             $url = $result[2]['source'];
263         }
264         $path = $this->prepare_file($file);
265         $fp = fopen($path, 'w');
266         $c = new curl;
267         $c->download(array(
268             array('url'=>$url, 'file'=>$fp)
269         ));
270         return $path;
271     }
273     /**
274      * Add Plugin settings input to Moodle form
275      * @param object $mform
276      */
277     public function type_config_form($mform) {
278         global $CFG;
279         $api_key = get_config('flickr', 'api_key');
280         $secret = get_config('flickr', 'secret');
282         if (empty($api_key)) {
283             $api_key = '';
284         }
285         if (empty($secret)) {
286             $secret = '';
287         }
289         $strrequired = get_string('required');
290         $mform->addElement('text', 'api_key', get_string('apikey', 'repository_flickr'), array('value'=>$api_key,'size' => '40'));
291         $mform->addElement('text', 'secret', get_string('secret', 'repository_flickr'), array('value'=>$secret,'size' => '40'));
293         //retrieve the flickr instances
294         $params = array();
295         $params['context'] = array();
296         //$params['currentcontext'] = $this->context;
297         $params['onlyvisible'] = false;
298         $params['type'] = 'flickr';
299         $instances = repository::get_instances($params);
300         if (empty($instances)) {
301             $callbackurl = get_string('callbackwarning', 'repository_flickr');
302             $mform->addElement('static', null, '',  $callbackurl);
303         } else {
304             $instance = array_shift($instances);
305             $callbackurl = $CFG->wwwroot.'/repository/repository_ajax.php?callback=yes&amp;repo_id='.$instance->id;
306             $mform->addElement('static', 'callbackurl', '', get_string('callbackurltext', 'repository_flickr', $callbackurl));
307         }
309         $mform->addRule('api_key', $strrequired, 'required', null, 'client');
310         $mform->addRule('secret', $strrequired, 'required', null, 'client');
311     }
313     /**
314      * Names of the plugin settings
315      * @return array
316      */
317     public static function get_type_option_names() {
318         return array('api_key', 'secret');
319     }
320     public function supported_filetypes() {
321         return array('web_image');
322     }
323     public function supported_returntypes() {
324         return (FILE_INTERNAL | FILE_EXTERNAL);
325     }