[Summary view]

   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/>.
  16  
  17  /**
  18   * Picasa Portfolio Plugin
  19   *
  20   * @author Dan Poltawski <talktodan@gmail.com>
  21   * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  22   */
  23  require_once($CFG->libdir.'/portfolio/plugin.php');
  24  require_once($CFG->libdir.'/googleapi.php');
  25  
  26  class portfolio_plugin_picasa extends portfolio_plugin_push_base {
  27      private $googleoauth = null;
  28  
  29      public function supported_formats() {
  30          return array(PORTFOLIO_FORMAT_IMAGE, PORTFOLIO_FORMAT_VIDEO);
  31      }
  32  
  33      public static function get_name() {
  34          return get_string('pluginname', 'portfolio_picasa');
  35      }
  36  
  37      public function prepare_package() {
  38          // We send the files as they are, no prep required.
  39          return true;
  40      }
  41  
  42      public function get_interactive_continue_url() {
  43          return 'http://picasaweb.google.com/';
  44      }
  45  
  46      public function expected_time($callertime) {
  47          // We're forcing this to be run 'interactively' because the plugin
  48          // does not support running in cron.
  49          return PORTFOLIO_TIME_LOW;
  50      }
  51  
  52      public function send_package() {
  53          if (!$this->googleoauth) {
  54              throw new portfolio_plugin_exception('noauthtoken', 'portfolio_picasa');
  55          }
  56  
  57          $picasa = new google_picasa($this->googleoauth);
  58          foreach ($this->exporter->get_tempfiles() as $file) {
  59  
  60              if (!$picasa->send_file($file)) {
  61                  throw new portfolio_plugin_exception('sendfailed', 'portfolio_picasa', $file->get_filename());
  62              }
  63          }
  64      }
  65  
  66      public function steal_control($stage) {
  67          if ($stage != PORTFOLIO_STAGE_CONFIG) {
  68              return false;
  69          }
  70  
  71          $this->initialize_oauth();
  72  
  73          if ($this->googleoauth->is_logged_in()) {
  74              return false;
  75          } else {
  76              return $this->googleoauth->get_login_url();
  77          }
  78      }
  79  
  80      public function post_control($stage, $params) {
  81          if ($stage != PORTFOLIO_STAGE_CONFIG) {
  82              return;
  83          }
  84  
  85          $this->initialize_oauth();
  86          if ($this->googleoauth->is_logged_in()) {
  87              return false;
  88          } else {
  89              return $this->googleoauth->get_login_url();
  90          }
  91      }
  92  
  93      public static function has_admin_config() {
  94          return true;
  95      }
  96  
  97      public static function allows_multiple_instances() {
  98          return false;
  99      }
 100  
 101      public static function get_allowed_config() {
 102          return array('clientid', 'secret');
 103      }
 104  
 105      public static function admin_config_form(&$mform) {
 106          $a = new stdClass;
 107          $a->docsurl = get_docs_url('Google_OAuth_2.0_setup');
 108          $a->callbackurl = google_oauth::callback_url()->out(false);
 109  
 110          $mform->addElement('static', null, '', get_string('oauthinfo', 'portfolio_picasa', $a));
 111  
 112          $mform->addElement('text', 'clientid', get_string('clientid', 'portfolio_picasa'));
 113          $mform->setType('clientid', PARAM_RAW_TRIMMED);
 114          $mform->addElement('text', 'secret', get_string('secret', 'portfolio_picasa'));
 115          $mform->setType('secret', PARAM_RAW_TRIMMED);
 116  
 117          $strrequired = get_string('required');
 118          $mform->addRule('clientid', $strrequired, 'required', null, 'client');
 119          $mform->addRule('secret', $strrequired, 'required', null, 'client');
 120      }
 121  
 122      private function initialize_oauth() {
 123          $returnurl = new moodle_url('/portfolio/add.php');
 124          $returnurl->param('postcontrol', 1);
 125          $returnurl->param('id', $this->exporter->get('id'));
 126          $returnurl->param('sesskey', sesskey());
 127  
 128          $clientid = $this->get_config('clientid');
 129          $secret = $this->get_config('secret');
 130  
 131          $this->googleoauth = new google_oauth($clientid, $secret, $returnurl, google_picasa::REALM);
 132      }
 133  
 134      public function instance_sanity_check() {
 135          $clientid = $this->get_config('clientid');
 136          $secret = $this->get_config('secret');
 137  
 138          // If there is no oauth config (e.g. plugins upgraded from < 2.3 then
 139          // there will be no config and this plugin should be disabled.
 140          if (empty($clientid) or empty($secret)) {
 141              return 'nooauthcredentials';
 142          }
 143          return 0;
 144      }
 145  }