MDL-36655: Assignment - do not add empty group to grading form when there is only...
[moodle.git] / lib / googleapi.php
1 <?php
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/>.
17 /**
18  * Simple implementation of some Google API functions for Moodle.
19  *
20  * @package   core
21  * @copyright Dan Poltawski <talktodan@gmail.com>
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once($CFG->libdir.'/filelib.php');
28 require_once($CFG->libdir.'/oauthlib.php');
30 /**
31  * Class for manipulating google documents through the google data api.
32  *
33  * Docs for this can be found here:
34  * {@link http://code.google.com/apis/documents/docs/2.0/developers_guide_protocol.html}
35  *
36  * @package    core
37  * @subpackage lib
38  * @copyright Dan Poltawski <talktodan@gmail.com>
39  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class google_docs {
42     /** @var string Realm for authentication, need both docs and spreadsheet realm */
43     const REALM            = 'https://docs.google.com/feeds/ https://spreadsheets.google.com/feeds/ https://docs.googleusercontent.com/';
44     /** @var string Document list url */
45     const DOCUMENTFEED_URL = 'https://docs.google.com/feeds/default/private/full';
46     /** @var string Upload url */
47     const UPLOAD_URL       = 'https://docs.google.com/feeds/upload/create-session/default/private/full?convert=false';
49     /** @var google_oauth oauth curl class for making authenticated requests */
50     private $googleoauth = null;
52     /**
53      * Constructor.
54      *
55      * @param google_oauth $googleoauth oauth curl class for making authenticated requests
56      */
57     public function __construct(google_oauth $googleoauth) {
58         $this->googleoauth = $googleoauth;
59         $this->reset_curl_state();
60     }
62     /**
63      * Resets state on oauth curl object and set GData protocol
64      * version
65      */
66     private function reset_curl_state() {
67         $this->googleoauth->reset_state();
68         $this->googleoauth->setHeader('GData-Version: 3.0');
69     }
71     /**
72      * Returns a list of files the user has formated for files api
73      *
74      * @param string $search A search string to do full text search on the documents
75      * @return mixed Array of files formated for fileapoi
76      */
77     public function get_file_list($search = '') {
78         global $CFG, $OUTPUT;
79         $url = self::DOCUMENTFEED_URL;
81         if ($search) {
82             $url.='?q='.urlencode($search);
83         }
84         $content = $this->googleoauth->get($url);
86         $xml = new SimpleXMLElement($content);
88         $files = array();
89         foreach ($xml->entry as $gdoc) {
90             $docid  = (string) $gdoc->children('http://schemas.google.com/g/2005')->resourceId;
91             list($type, $docid) = explode(':', $docid);
93             $title  = '';
94             $source = '';
95             // FIXME: We're making hard-coded choices about format here.
96             // If the repo api can support it, we could let the user
97             // chose.
98             switch($type){
99                 case 'document':
100                     $title = $gdoc->title.'.rtf';
101                     $source = 'https://docs.google.com/feeds/download/documents/Export?id='.$docid.'&exportFormat=rtf';
102                     break;
103                 case 'presentation':
104                     $title = $gdoc->title.'.ppt';
105                     $source = 'https://docs.google.com/feeds/download/presentations/Export?id='.$docid.'&exportFormat=ppt';
106                     break;
107                 case 'spreadsheet':
108                     $title = $gdoc->title.'.xls';
109                     $source = 'https://spreadsheets.google.com/feeds/download/spreadsheets/Export?key='.$docid.'&exportFormat=xls';
110                     break;
111                 case 'pdf':
112                 case 'file':
113                     $title  = (string)$gdoc->title;
114                     // Some files don't have a content probably because the download has been restricted.
115                     if (isset($gdoc->content)) {
116                         $source = (string)$gdoc->content[0]->attributes()->src;
117                     }
118                     break;
119             }
121             $files[] =  array( 'title' => $title,
122                 'url' => "{$gdoc->link[0]->attributes()->href}",
123                 'source' => $source,
124                 'date'   => usertime(strtotime($gdoc->updated)),
125                 'thumbnail' => (string) $OUTPUT->pix_url(file_extension_icon($title, 32))
126             );
127         }
129         return $files;
130     }
132     /**
133      * Sends a file object to google documents
134      *
135      * @param object $file File object
136      * @return boolean True on success
137      */
138     public function send_file($file) {
139         // First we create the 'resumable upload request'.
140         $this->googleoauth->setHeader("Content-Length: 0");
141         $this->googleoauth->setHeader("X-Upload-Content-Length: ". $file->get_filesize());
142         $this->googleoauth->setHeader("X-Upload-Content-Type: ". $file->get_mimetype());
143         $this->googleoauth->setHeader("Slug: ". $file->get_filename());
144         $this->googleoauth->post(self::UPLOAD_URL);
146         if ($this->googleoauth->info['http_code'] !== 200) {
147             throw new moodle_exception('Cantpostupload');
148         }
150         // Now we http PUT the file in the location returned.
151         $location = $this->googleoauth->response['Location'];
152         if (empty($location)) {
153             throw new moodle_exception('Nouploadlocation');
154         }
156         // Reset the curl object for actually sending the file.
157         $this->reset_curl_state();
158         $this->googleoauth->setHeader("Content-Length: ". $file->get_filesize());
159         $this->googleoauth->setHeader("Content-Type: ". $file->get_mimetype());
161         // We can't get a filepointer, so have to copy the file..
162         $tmproot = make_temp_directory('googledocsuploads');
163         $tmpfilepath = $tmproot.'/'.$file->get_contenthash();
164         $file->copy_content_to($tmpfilepath);
166         // HTTP PUT the file.
167         $this->googleoauth->put($location, array('file'=>$tmpfilepath));
169         // Remove the temporary file we created..
170         unlink($tmpfilepath);
172         if ($this->googleoauth->info['http_code'] === 201) {
173             // Clear headers for further requests.
174             $this->reset_curl_state();
175             return true;
176         } else {
177             return false;
178         }
179     }
181     /**
182      * Downloads a file using authentication
183      *
184      * @param string $url url of file
185      * @param string $path path to save file to
186      * @param int $timeout request timeout, default 0 which means no timeout
187      * @return array stucture for repository download_file
188      */
189     public function download_file($url, $path, $timeout = 0) {
190         $result = $this->googleoauth->download_one($url, null, array('filepath' => $path, 'timeout' => $timeout));
191         if ($result === true) {
192             $info = $this->googleoauth->get_info();
193             if (isset($info['http_code']) && $info['http_code'] == 200) {
194                 return array('path'=>$path, 'url'=>$url);
195             } else {
196                 throw new moodle_exception('cannotdownload', 'repository');
197             }
198         } else {
199             throw new moodle_exception('errorwhiledownload', 'repository', '', $result);
200         }
201     }
204 /**
205  * Class for manipulating picasa through the google data api.
206  *
207  * Docs for this can be found here:
208  * {@link http://code.google.com/apis/picasaweb/developers_guide_protocol.html}
209  *
210  * @package   core
211  * @copyright Dan Poltawski <talktodan@gmail.com>
212  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
213  */
214 class google_picasa {
215     /** @var string Realm for authentication */
216     const REALM             = 'http://picasaweb.google.com/data/';
217     /** @var string Upload url */
218     const UPLOAD_LOCATION   = 'https://picasaweb.google.com/data/feed/api/user/default/albumid/default';
219     /** @var string photo list url */
220     const ALBUM_PHOTO_LIST  = 'https://picasaweb.google.com/data/feed/api/user/default/albumid/';
221     /** @var string search url */
222     const PHOTO_SEARCH_URL  = 'https://picasaweb.google.com/data/feed/api/user/default?kind=photo&q=';
223     /** @var string album list url */
224     const LIST_ALBUMS_URL   = 'https://picasaweb.google.com/data/feed/api/user/default';
225     /** @var string manage files url */
226     const MANAGE_URL        = 'http://picasaweb.google.com/';
228     /** @var google_oauth oauth curl class for making authenticated requests */
229     private $googleoauth = null;
230     /** @var string Last album name retrievied */
231     private $lastalbumname = null;
233     /**
234      * Constructor.
235      *
236      * @param google_oauth $googleoauth oauth curl class for making authenticated requests
237      */
238     public function __construct(google_oauth $googleoauth) {
239         $this->googleoauth = $googleoauth;
240         $this->googleoauth->setHeader('GData-Version: 2');
241     }
243     /**
244      * Sends a file object to picasaweb
245      *
246      * @param object $file File object
247      * @return boolean True on success
248      */
249     public function send_file($file) {
250         $this->googleoauth->setHeader("Content-Length: ". $file->get_filesize());
251         $this->googleoauth->setHeader("Content-Type: ". $file->get_mimetype());
252         $this->googleoauth->setHeader("Slug: ". $file->get_filename());
254         $this->googleoauth->post(self::UPLOAD_LOCATION, $file->get_content());
256         if ($this->googleoauth->info['http_code'] === 201) {
257             return true;
258         } else {
259             return false;
260         }
261     }
263     /**
264      * Returns list of photos for file picker.
265      * If top level then returns list of albums, otherwise
266      * photos within an album.
267      *
268      * @param string $path The path to files (assumed to be albumid)
269      * @return mixed $files A list of files for the file picker
270      */
271     public function get_file_list($path = '') {
272         if (!$path) {
273             return $this->get_albums();
274         } else {
275             return $this->get_album_photos($path);
276         }
277     }
279     /**
280      * Returns list of photos in album specified
281      *
282      * @param int $albumid Photo album to list photos from
283      * @return mixed $files A list of files for the file picker
284      */
285     public function get_album_photos($albumid) {
286         $albumcontent = $this->googleoauth->get(self::ALBUM_PHOTO_LIST.$albumid);
288         return $this->get_photo_details($albumcontent);
289     }
291     /**
292      * Returns the name of the album for which get_photo_details was called last time.
293      *
294      * @return string
295      */
296     public function get_last_album_name() {
297         return $this->lastalbumname;
298     }
300     /**
301      * Does text search on the users photos and returns
302      * matches in format for picasa api
303      *
304      * @param string $query Search terms
305      * @return mixed $files A list of files for the file picker
306      */
307     public function do_photo_search($query) {
308         $content = $this->googleoauth->get(self::PHOTO_SEARCH_URL.htmlentities($query));
310         return $this->get_photo_details($content);
311     }
313     /**
314      * Gets all the users albums and returns them as a list of folders
315      * for the file picker
316      *
317      * @return mixes $files Array in the format get_listing uses for folders
318      */
319     public function get_albums() {
320         $files = array();
321         $content = $this->googleoauth->get(self::LIST_ALBUMS_URL);
323         if (empty($content)) {
324             return $files;
325         }
327         $xml = new SimpleXMLElement($content);
328         foreach ($xml->entry as $album) {
329             $gphoto = $album->children('http://schemas.google.com/photos/2007');
331             $mediainfo = $album->children('http://search.yahoo.com/mrss/');
332             // Hacky...
333             $thumbnailinfo = $mediainfo->group->thumbnail[0]->attributes();
335             $files[] = array( 'title' => (string) $album->title,
336                 'date'  => userdate($gphoto->timestamp),
337                 'size'  => (int) $gphoto->bytesUsed,
338                 'path'  => (string) $gphoto->id,
339                 'thumbnail' => (string) $thumbnailinfo['url'],
340                 'thumbnail_width' => 160,  // 160 is the native maximum dimension.
341                 'thumbnail_height' => 160,
342                 'children' => array(),
343             );
344         }
346         return $files;
347     }
349     /**
350      * Recieves XML from a picasa list of photos and returns
351      * array in format for file picker.
352      *
353      * @param string $rawxml XML from picasa api
354      * @return mixed $files A list of files for the file picker
355      */
356     public function get_photo_details($rawxml) {
357         $files = array();
358         if (empty($rawxml)) {
359             return $files;
360         }
362         $xml = new SimpleXMLElement($rawxml);
363         $this->lastalbumname = (string)$xml->title;
365         foreach ($xml->entry as $photo) {
366             $gphoto = $photo->children('http://schemas.google.com/photos/2007');
368             $mediainfo = $photo->children('http://search.yahoo.com/mrss/');
369             $fullinfo = $mediainfo->group->content->attributes();
370             // Hacky...
371             $thumbnailinfo = $mediainfo->group->thumbnail[0]->attributes();
373             // Derive the nicest file name we can.
374             if (!empty($mediainfo->group->description)) {
375                 $title = shorten_text((string)$mediainfo->group->description, 20, false, '');
376                 $title = clean_filename($title).'.jpg';
377             } else {
378                 $title = (string)$mediainfo->group->title;
379             }
381             $files[] = array(
382                 'title' => $title,
383                 'date'  => userdate($gphoto->timestamp),
384                 'size' => (int) $gphoto->size,
385                 'path' => $gphoto->albumid.'/'.$gphoto->id,
386                 'thumbnail' => (string) $thumbnailinfo['url'],
387                 'thumbnail_width' => 72,  // 72 is the native maximum dimension.
388                 'thumbnail_height' => 72,
389                 'source' => (string) $fullinfo['url'],
390                 'url' => (string) $fullinfo['url']
391             );
392         }
394         return $files;
395     }
398 /**
399  * OAuth 2.0 client for Google Services
400  *
401  * @package   core
402  * @copyright 2012 Dan Poltawski
403  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
404  */
405 class google_oauth extends oauth2_client {
406     /**
407      * Returns the auth url for OAuth 2.0 request
408      * @return string the auth url
409      */
410     protected function auth_url() {
411         return 'https://accounts.google.com/o/oauth2/auth';
412     }
414     /**
415      * Returns the token url for OAuth 2.0 request
416      * @return string the auth url
417      */
418     protected function token_url() {
419         return 'https://accounts.google.com/o/oauth2/token';
420     }
422     /**
423      * Resets headers and response for multiple requests
424      */
425     public function reset_state() {
426         $this->header = array();
427         $this->response = array();
428     }