google_func.php

<?php

/**
 * Functions which can be used from plugin or cli.
 *
 * @version 1.0
 * @author Stefan L. Wagner
 */

require_once(dirname(__FILE__) . '/../../vendor/autoload.php');
require_once(dirname(__FILE__) . '/google_addressbook_backend.php');
require_once(dirname(__FILE__) . '/xml_utils.php');

class google_func
{
  public static $settings_key_token = 'google_current_token';
  public static $settings_key_use_plugin = 'google_use_addressbook';
  public static $settings_key_auto_sync = 'google_autosync';
  public static $settings_key_auth_code = 'google_auth_code';

  static function get_client()
  {
    $config = rcmail::get_instance()->config;
    $client = new Google_Client();
    $client->setApplicationName($config->get('google_addressbook_application_name'));
    $client->setScopes(['https://www.googleapis.com/auth/contacts.readonly']);
    $client->setClientId($config->get('google_addressbook_client_id'));
    $client->setClientSecret($config->get('google_addressbook_client_secret'));
    $client->setAccessType('offline');
    if (google_func::has_redirect()){
        $redirect_url = $config->get('google_addressbook_client_redirect_url');
        if ($redirect_url === null){
            $redirect_url = 'http'.(isset($_SERVER['HTTPS']) ? 's' : '')."://{$_SERVER['HTTP_HOST']}".parse_url($_SERVER["REQUEST_URI"], PHP_URL_PATH).'?_task=settings&_action=plugin.google_addressbook.auth';
        }
    }else{
        $redirect_url = 'urn:ietf:wg:oauth:2.0:oob';
    }
    $client->setRedirectUri($redirect_url);
    return $client;
  }

  static function has_redirect(){
      $config = rcmail::get_instance()->config;
      return $config->get('google_addressbook_client_redirect', false);
  }

  static function get_auth_code(rcube_user $user) {
    $prefs = $user->get_prefs();
    return $prefs[google_func::$settings_key_auth_code];
  }

  static function get_current_token(rcube_user $user)
  {
    $prefs = $user->get_prefs();
    return $prefs[google_func::$settings_key_token];
  }

  static function save_current_token(rcube_user $user, $token)
  {
    $prefs = array(google_func::$settings_key_token => $token);
    $result = $user->save_prefs($prefs);
    if(!$result) {
      rcube::write_log('google_addressbook', 'Failed to save current token.');
    }
    return $result;
  }

  static function clear_authdata(rcube_user $user)
  {
    $prefs = [
        google_func::$settings_key_token => null,
        google_func::$settings_key_auth_code => null,
        google_func::$settings_key_auto_sync => false,
    ];
    $result = $user->save_prefs($prefs);
    if(!$result) {
        rcube::write_log('google_addressbook', 'Failed to clear current authdata.');
    }
    return $result;
  }

  static function is_enabled($user)
  {
    $prefs = $user->get_prefs();
    return (bool)$prefs[google_func::$settings_key_use_plugin];
  }

  static function is_autosync($user)
  {
    $prefs = $user->get_prefs();
    return (bool)$prefs[google_func::$settings_key_auto_sync];
  }

  static function google_authenticate(Google_Client $client, $user)
  {
    $rcmail = rcmail::get_instance();
    $token = google_func::get_current_token($user);
    if($token !== null) {
      $client->setAccessToken($token);
    }

    $success = false;
    $msg = '';

    try {
      if($client->getAccessToken() === null || $client->getAccessToken() == '[]') {
        $code = google_func::get_auth_code($user);
        if(empty($code)) {
          throw new Exception($rcmail->gettext('noauthcode', 'google_addressbook'));
        }
        $client->authenticate($code);
        $msg = $rcmail->gettext('done', 'google_addressbook');
        $success = true;
      } else if($client->isAccessTokenExpired()) {
        $token = json_decode($client->getAccessToken());
        if(empty($token->refresh_token)) {
          throw new Exception("Error fetching refresh token.");
          // this only happens if google client id is wrong and access type != offline
        } else {
          $client->refreshToken($token->refresh_token);
          $msg = $rcmail->gettext('done', 'google_addressbook');
          $success = true;
        }
      } else {
        // token valid, nothing to do.
        $msg = $rcmail->gettext('done', 'google_addressbook');
        $success = true;
      }
    } catch(Exception $e) {
      $msg = $e->getMessage();
      // invalidate saved authdata as they are probably invalid
      if (strpos($msg, "'invalid_grant: Bad Request'") !== false) {
          google_func::clear_authdata($user);
      }
      error_log('google_addressbook: ' . $msg);
      rcube::write_log('google_addressbook', $msg);
    }

    if($success) {
      $token = $client->getAccessToken();
      google_func::save_current_token($user, $token);
    }

    return array('success' => $success, 'message' => $msg);
  }

  static function google_sync_contacts($user)
  {
    $rcmail = rcmail::get_instance();
    $client = google_func::get_client();

    $auth_res = google_func::google_authenticate($client, $user);
    if(!$auth_res['success']) {
      return $auth_res;
    }

    $feed = 'https://www.google.com/m8/feeds/groups/default/full'.'?v=3.0';
    $val = $client->getAuth()->authenticatedRequest(new Google_Http_Request($feed));
    if($val->getResponseHttpCode() == 401) {
      return array('success' => false, 'message' => $rcmail->gettext('googleauthfailed', 'google_addressbook'));
    } else if($val->getResponseHttpCode() == 403) {
      return array('success' => false, 'message' => $rcmail->gettext('googleforbidden', 'google_addressbook'));
    } else if($val->getResponseHttpCode() != 200) {
      return array('success' => false, 'message' => $rcmail->gettext('googleunreachable', 'google_addressbook'));
    }

    $xml = xml_utils::xmlstr_to_array($val->getResponseBody());
    $gid = $xml['entry'][0]['id'][0]['@text'];

    $feed = 'https://www.google.com/m8/feeds/contacts/default/full'.'?max-results=9999'.'&v=3.0'.'&group='.urlencode($gid);
    $val = $client->getAuth()->authenticatedRequest(new Google_Http_Request($feed));
    if($val->getResponseHttpCode() == 401) {
      return array('success' => false, 'message' => $rcmail->gettext('googleauthfailed', 'google_addressbook'));
    } else if($val->getResponseHttpCode() == 403) {
      return array('success' => false, 'message' => $rcmail->gettext('googleforbidden', 'google_addressbook'));
    } else if($val->getResponseHttpCode() != 200) {
      return array('success' => false, 'message' => $rcmail->gettext('googleunreachable', 'google_addressbook'));
    }

    $xml = xml_utils::xmlstr_to_array($val->getResponseBody());

    if(is_null($xml['entry'])) {
      // When the user does not have any google contacts. Avoids PHP Warning in foreach.
      return array('success' => true, 'message' => '0'.$rcmail->gettext('contactsfound', 'google_addressbook'));
    }

    $backend = new google_addressbook_backend($rcmail->get_dbh(), $user->ID);
    $backend->delete_all();

    $num_entries = 0;
    foreach($xml['entry'] as $entry) {
      //write_log('google_addressbook', 'getting contact: '.$entry['title'][0]['@text']);
      $record = array();
      $name = $entry['gd:name'][0];
      $record['name']= trim($name['gd:fullName'][0]['@text']);
      $record['firstname'] = trim($name['gd:givenName'][0]['@text']);
      $record['surname'] = trim($name['gd:familyName'][0]['@text']);
      $record['middlename'] = trim($name['gd:additionalName'][0]['@text']);
      $record['prefix'] = $name['gd:namePrefix'][0]['@text'];
      $record['suffix'] = $name['gd:nameSuffix'][0]['@text'];
      if(empty($record['name'])) {
        $record['name'] = $entry['title'][0]['@text'];
      }

      if(empty($record['name']) &&
         empty($record['firstname']) &&
         empty($record['surname']) &&
         empty($record['middlename']) &&
         !array_key_exists('gd:email', $entry)) {
          continue;
      }

      if(array_key_exists('gd:email', $entry)) {
        foreach($entry['gd:email'] as $email) {
          list($rel, $type) = explode('#', $email['@attributes']['rel'], 2);
          $type = empty($type) ? '' : ':'.$type;
          $record['email'.$type][] = $email['@attributes']['address'];
        }
      }

      if(array_key_exists('gd:phoneNumber', $entry)) {
        foreach($entry['gd:phoneNumber'] as $phone) {
          list($rel, $type) = explode('#', $phone['@attributes']['rel'], 2);
          $type = empty($type) ? '' : ':'.$type;
          $record['phone'.$type][] = $phone['@text'];
        }
      }

      if(array_key_exists('link', $entry)) {
        foreach($entry['link'] as $link) {
          $rel = $link['@attributes']['rel'];
          $href = $link['@attributes']['href'];
          if($rel == 'http://schemas.google.com/contacts/2008/rel#photo') {
            // etag is only set if image is available
            if(isset($link['@attributes']['etag'])) {
              $resp = $client->getAuth()->authenticatedRequest(new Google_Http_Request($href));
              if($resp->getResponseHttpCode() == 200) {
                $record['photo'] = $resp->getResponseBody();
              }
            }
            break;
          }
        }
      }

      $num_entries++;

      $backend->insert($record, false);
    }

    return array('success' => true, 'message' => $num_entries.$rcmail->gettext('contactsfound', 'google_addressbook'));
  }
}