MDL-29857 - google apis: Convert to OAuth 2.0
[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->googleoauth->setHeader('GData-Version: 3.0');
60     }
62     /**
63      * Returns a list of files the user has formated for files api
64      *
65      * @param string $search A search string to do full text search on the documents
66      * @return mixed Array of files formated for fileapoi
67      */
68     public function get_file_list($search = '') {
69         global $CFG, $OUTPUT;
70         $url = self::DOCUMENTFEED_URL;
72         if ($search) {
73             $url.='?q='.urlencode($search);
74         }
75         $content = $this->googleoauth->get($url);
77         $xml = new SimpleXMLElement($content);
79         $files = array();
80         foreach ($xml->entry as $gdoc) {
81             $docid  = (string) $gdoc->children('http://schemas.google.com/g/2005')->resourceId;
82             list($type, $docid) = explode(':', $docid);
84             $title  = '';
85             $source = '';
86             // FIXME: We're making hard-coded choices about format here.
87             // If the repo api can support it, we could let the user
88             // chose.
89             switch($type){
90                 case 'document':
91                     $title = $gdoc->title.'.rtf';
92                     $source = 'https://docs.google.com/feeds/download/documents/Export?id='.$docid.'&exportFormat=rtf';
93                     break;
94                 case 'presentation':
95                     $title = $gdoc->title.'.ppt';
96                     $source = 'https://docs.google.com/feeds/download/presentations/Export?id='.$docid.'&exportFormat=ppt';
97                     break;
98                 case 'spreadsheet':
99                     $title = $gdoc->title.'.xls';
100                     $source = 'https://spreadsheets.google.com/feeds/download/spreadsheets/Export?key='.$docid.'&exportFormat=xls';
101                     break;
102                 case 'pdf':
103                     $title  = (string)$gdoc->title;
104                     $source = (string)$gdoc->content[0]->attributes()->src;
105                     break;
106                 case 'file':
107                     $title = (string)$gdoc->title;
108                     $source = (string)$gdoc->content[0]->attributes()->src;
109                     break;
110             }
112             if (!empty($source)) {
113                 $files[] =  array( 'title' => $title,
114                     'url' => "{$gdoc->link[0]->attributes()->href}",
115                     'source' => $source,
116                     'date'   => usertime(strtotime($gdoc->updated)),
117                     'thumbnail' => (string) $OUTPUT->pix_url(file_extension_icon($title, 32))
118                 );
119             }
120         }
122         return $files;
123     }
125     /**
126      * Sends a file object to google documents
127      *
128      * @param object $file File object
129      * @return boolean True on success
130      */
131     public function send_file($file) {
132         // First we create the 'resumable upload request'.
133         $this->googleoauth->setHeader("Content-Length: 0");
134         $this->googleoauth->setHeader("X-Upload-Content-Length: ". $file->get_filesize());
135         $this->googleoauth->setHeader("X-Upload-Content-Type: ". $file->get_mimetype());
136         $this->googleoauth->setHeader("Slug: ". $file->get_filename());
137         $this->googleoauth->post(self::UPLOAD_URL);
139         if ($this->googleoauth->info['http_code'] !== 200) {
140             throw new moodle_exception('Cantpostupload');
141         }
143         // Now we http PUT the file in the location returned.
144         $location = $this->googleoauth->response['Location'];
145         if (empty($location)) {
146             throw new moodle_exception('Nouploadlocation');
147         }
149         // Reset the curl object for actually sending the file.
150         $this->googleoauth->clear_headers();
151         $this->googleoauth->setHeader("Content-Length: ". $file->get_filesize());
152         $this->googleoauth->setHeader("Content-Type: ". $file->get_mimetype());
154         // We can't get a filepointer, so have to copy the file..
155         $tmproot = make_temp_directory('googledocsuploads');
156         $tmpfilepath = $tmproot.'/'.$file->get_contenthash();
157         $file->copy_content_to($tmpfilepath);
159         // HTTP PUT the file.
160         $this->googleoauth->put($location, array('file'=>$tmpfilepath));
162         // Remove the temporary file we created..
163         unlink($tmpfilepath);
165         if ($this->googleoauth->info['http_code'] === 201) {
166             return true;
167         } else {
168             return false;
169         }
170     }
172     /**
173      * Downloads a file using authentication
174      *
175      * @param string $url url of file
176      * @param string $path path to save file to
177      * @return array stucture for repository download_file
178      */
179     public function download_file($url, $path) {
180         $content = $this->googleoauth->get($url);
181         file_put_contents($path, $content);
182         return array('path'=>$path, 'url'=>$url);
183     }
186 /**
187  * Class for manipulating picasa through the google data api.
188  *
189  * Docs for this can be found here:
190  * {@link http://code.google.com/apis/picasaweb/developers_guide_protocol.html}
191  *
192  * @package   core
193  * @copyright Dan Poltawski <talktodan@gmail.com>
194  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
195  */
196 class google_picasa {
197     /** @var string Realm for authentication */
198     const REALM             = 'http://picasaweb.google.com/data/';
199     /** @var string Upload url */
200     const UPLOAD_LOCATION   = 'https://picasaweb.google.com/data/feed/api/user/default/albumid/default';
201     /** @var string photo list url */
202     const ALBUM_PHOTO_LIST  = 'https://picasaweb.google.com/data/feed/api/user/default/albumid/';
203     /** @var string search url */
204     const PHOTO_SEARCH_URL  = 'https://picasaweb.google.com/data/feed/api/user/default?kind=photo&q=';
205     /** @var string album list url */
206     const LIST_ALBUMS_URL   = 'https://picasaweb.google.com/data/feed/api/user/default';
207     /** @var string manage files url */
208     const MANAGE_URL        = 'http://picasaweb.google.com/';
210     /** @var google_oauth oauth curl class for making authenticated requests */
211     private $googleoauth = null;
212     /** @var string Last album name retrievied */
213     private $lastalbumname = null;
215     /**
216      * Constructor.
217      *
218      * @param google_oauth $googleoauth oauth curl class for making authenticated requests
219      */
220     public function __construct(google_oauth $googleoauth) {
221         $this->googleoauth = $googleoauth;
222         $this->googleoauth->setHeader('GData-Version: 2');
223     }
225     /**
226      * Sends a file object to picasaweb
227      *
228      * @param object $file File object
229      * @return boolean True on success
230      */
231     public function send_file($file) {
232         $this->googleoauth->setHeader("Content-Length: ". $file->get_filesize());
233         $this->googleoauth->setHeader("Content-Type: ". $file->get_mimetype());
234         $this->googleoauth->setHeader("Slug: ". $file->get_filename());
236         $this->googleoauth->post(self::UPLOAD_LOCATION, $file->get_content());
238         if ($this->googleoauth->info['http_code'] === 201) {
239             return true;
240         } else {
241             return false;
242         }
243     }
245     /**
246      * Returns list of photos for file picker.
247      * If top level then returns list of albums, otherwise
248      * photos within an album.
249      *
250      * @param string $path The path to files (assumed to be albumid)
251      * @return mixed $files A list of files for the file picker
252      */
253     public function get_file_list($path = '') {
254         if (!$path) {
255             return $this->get_albums();
256         } else {
257             return $this->get_album_photos($path);
258         }
259     }
261     /**
262      * Returns list of photos in album specified
263      *
264      * @param int $albumid Photo album to list photos from
265      * @return mixed $files A list of files for the file picker
266      */
267     public function get_album_photos($albumid) {
268         $albumcontent = $this->googleoauth->get(self::ALBUM_PHOTO_LIST.$albumid);
270         return $this->get_photo_details($albumcontent);
271     }
273     /**
274      * Returns the name of the album for which get_photo_details was called last time.
275      *
276      * @return string
277      */
278     public function get_last_album_name() {
279         return $this->lastalbumname;
280     }
282     /**
283      * Does text search on the users photos and returns
284      * matches in format for picasa api
285      *
286      * @param string $query Search terms
287      * @return mixed $files A list of files for the file picker
288      */
289     public function do_photo_search($query) {
290         $content = $this->googleoauth->get(self::PHOTO_SEARCH_URL.htmlentities($query));
292         return $this->get_photo_details($content);
293     }
295     /**
296      * Gets all the users albums and returns them as a list of folders
297      * for the file picker
298      *
299      * @return mixes $files Array in the format get_listing uses for folders
300      */
301     public function get_albums() {
302         $content = $this->googleoauth->get(self::LIST_ALBUMS_URL);
303         $xml = new SimpleXMLElement($content);
305         $files = array();
307         foreach ($xml->entry as $album) {
308             $gphoto = $album->children('http://schemas.google.com/photos/2007');
310             $mediainfo = $album->children('http://search.yahoo.com/mrss/');
311             // Hacky...
312             $thumbnailinfo = $mediainfo->group->thumbnail[0]->attributes();
314             $files[] = array( 'title' => (string) $album->title,
315                 'date'  => userdate($gphoto->timestamp),
316                 'size'  => (int) $gphoto->bytesUsed,
317                 'path'  => (string) $gphoto->id,
318                 'thumbnail' => (string) $thumbnailinfo['url'],
319                 'thumbnail_width' => 160,  // 160 is the native maximum dimension.
320                 'thumbnail_height' => 160,
321                 'children' => array(),
322             );
324         }
326         return $files;
327     }
329     /**
330      * Recieves XML from a picasa list of photos and returns
331      * array in format for file picker.
332      *
333      * @param string $rawxml XML from picasa api
334      * @return mixed $files A list of files for the file picker
335      */
336     public function get_photo_details($rawxml) {
338         $xml = new SimpleXMLElement($rawxml);
339         $this->lastalbumname = (string)$xml->title;
341         $files = array();
343         foreach ($xml->entry as $photo) {
344             $gphoto = $photo->children('http://schemas.google.com/photos/2007');
346             $mediainfo = $photo->children('http://search.yahoo.com/mrss/');
347             $fullinfo = $mediainfo->group->content->attributes();
348             // Hacky...
349             $thumbnailinfo = $mediainfo->group->thumbnail[0]->attributes();
351             // Derive the nicest file name we can.
352             if (!empty($mediainfo->group->description)) {
353                 $title = shorten_text((string)$mediainfo->group->description, 20, false, '');
354                 $title = clean_filename($title).'.jpg';
355             } else {
356                 $title = (string)$mediainfo->group->title;
357             }
359             $files[] = array(
360                 'title' => $title,
361                 'date'  => userdate($gphoto->timestamp),
362                 'size' => (int) $gphoto->size,
363                 'path' => $gphoto->albumid.'/'.$gphoto->id,
364                 'thumbnail' => (string) $thumbnailinfo['url'],
365                 'thumbnail_width' => 72,  // 72 is the native maximum dimension.
366                 'thumbnail_height' => 72,
367                 'source' => (string) $fullinfo['url'],
368                 'url' => (string) $fullinfo['url']
369             );
370         }
372         return $files;
373     }
376 /**
377  * OAuth 2.0 client for Google Services
378  *
379  * @package   core
380  * @copyright 2012 Dan Poltawski
381  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
382  */
383 class google_oauth extends oauth2_client {
384     /**
385      * Returns the auth url for OAuth 2.0 request
386      * @return string the auth url
387      */
388     protected function auth_url() {
389         return 'https://accounts.google.com/o/oauth2/auth';
390     }
392     /**
393      * Returns the token url for OAuth 2.0 request
394      * @return string the auth url
395      */
396     protected function token_url() {
397         return 'https://accounts.google.com/o/oauth2/token';
398     }
400     /**
401      * Clear any headers in the curl object
402      */
403     public function clear_headers() {
404         $this->header = array();
405     }