[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  namespace OAuth\OAuth2\Service;
   4  
   5  use OAuth\OAuth2\Token\StdOAuth2Token;
   6  use OAuth\Common\Http\Exception\TokenResponseException;
   7  use OAuth\Common\Http\Uri\Uri;
   8  use OAuth\Common\Consumer\CredentialsInterface;
   9  use OAuth\Common\Http\Client\ClientInterface;
  10  use OAuth\Common\Storage\TokenStorageInterface;
  11  use OAuth\Common\Http\Uri\UriInterface;
  12  
  13  class Facebook extends AbstractService
  14  {
  15      /**
  16       * Defined scopes
  17       *
  18       * If you don't think this is scary you should not be allowed on the web at all
  19       *
  20       * @link https://developers.facebook.com/docs/reference/login/
  21       */
  22      // email scopes
  23      const SCOPE_EMAIL                         = 'email';
  24      // extended permissions
  25      const SCOPE_READ_FRIENDLIST               = 'read_friendlists';
  26      const SCOPE_READ_INSIGHTS                 = 'read_insights';
  27      const SCOPE_READ_MAILBOX                  = 'read_mailbox';
  28      const SCOPE_READ_REQUESTS                 = 'read_requests';
  29      const SCOPE_READ_STREAM                   = 'read_stream';
  30      const SCOPE_XMPP_LOGIN                    = 'xmpp_login';
  31      const SCOPE_USER_ONLINE_PRESENCE          = 'user_online_presence';
  32      const SCOPE_FRIENDS_ONLINE_PRESENCE       = 'friends_online_presence';
  33      const SCOPE_ADS_MANAGEMENT                = 'ads_management';
  34      const SCOPE_CREATE_EVENT                  = 'create_event';
  35      const SCOPE_MANAGE_FRIENDLIST             = 'manage_friendlists';
  36      const SCOPE_MANAGE_NOTIFICATIONS          = 'manage_notifications';
  37      const SCOPE_PUBLISH_ACTIONS               = 'publish_actions';
  38      const SCOPE_PUBLISH_STREAM                = 'publish_stream';
  39      const SCOPE_RSVP_EVENT                    = 'rsvp_event';
  40      // Extended Profile Properties
  41      const SCOPE_USER_ABOUT                    = 'user_about_me';
  42      const SCOPE_FRIENDS_ABOUT                 = 'friends_about_me';
  43      const SCOPE_USER_ACTIVITIES               = 'user_activities';
  44      const SCOPE_FRIENDS_ACTIVITIES            = 'friends_activities';
  45      const SCOPE_USER_BIRTHDAY                 = 'user_birthday';
  46      const SCOPE_FRIENDS_BIRTHDAY              = 'friends_birthday';
  47      const SCOPE_USER_CHECKINS                 = 'user_checkins';
  48      const SCOPE_FRIENDS_CHECKINS              = 'friends_checkins';
  49      const SCOPE_USER_EDUCATION                = 'user_education_history';
  50      const SCOPE_FRIENDS_EDUCATION             = 'friends_education_history';
  51      const SCOPE_USER_EVENTS                   = 'user_events';
  52      const SCOPE_FRIENDS_EVENTS                = 'friends_events';
  53      const SCOPE_USER_GROUPS                   = 'user_groups';
  54      const SCOPE_FRIENDS_GROUPS                = 'friends_groups';
  55      const SCOPE_USER_HOMETOWN                 = 'user_hometown';
  56      const SCOPE_FRIENDS_HOMETOWN              = 'friends_hometown';
  57      const SCOPE_USER_INTERESTS                = 'user_interests';
  58      const SCOPE_FRIEND_INTERESTS              = 'friends_interests';
  59      const SCOPE_USER_LIKES                    = 'user_likes';
  60      const SCOPE_FRIENDS_LIKES                 = 'friends_likes';
  61      const SCOPE_USER_LOCATION                 = 'user_location';
  62      const SCOPE_FRIENDS_LOCATION              = 'friends_location';
  63      const SCOPE_USER_NOTES                    = 'user_notes';
  64      const SCOPE_FRIENDS_NOTES                 = 'friends_notes';
  65      const SCOPE_USER_PHOTOS                   = 'user_photos';
  66      const SCOPE_FRIENDS_PHOTOS                = 'friends_photos';
  67      const SCOPE_USER_QUESTIONS                = 'user_questions';
  68      const SCOPE_FRIENDS_QUESTIONS             = 'friends_questions';
  69      const SCOPE_USER_RELATIONSHIPS            = 'user_relationships';
  70      const SCOPE_FRIENDS_RELATIONSHIPS         = 'friends_relationships';
  71      const SCOPE_USER_RELATIONSHIPS_DETAILS    = 'user_relationship_details';
  72      const SCOPE_FRIENDS_RELATIONSHIPS_DETAILS = 'friends_relationship_details';
  73      const SCOPE_USER_RELIGION                 = 'user_religion_politics';
  74      const SCOPE_FRIENDS_RELIGION              = 'friends_religion_politics';
  75      const SCOPE_USER_STATUS                   = 'user_status';
  76      const SCOPE_FRIENDS_STATUS                = 'friends_status';
  77      const SCOPE_USER_SUBSCRIPTIONS            = 'user_subscriptions';
  78      const SCOPE_FRIENDS_SUBSCRIPTIONS         = 'friends_subscriptions';
  79      const SCOPE_USER_VIDEOS                   = 'user_videos';
  80      const SCOPE_FRIENDS_VIDEOS                = 'friends_videos';
  81      const SCOPE_USER_WEBSITE                  = 'user_website';
  82      const SCOPE_FRIENDS_WEBSITE               = 'friends_website';
  83      const SCOPE_USER_WORK                     = 'user_work_history';
  84      const SCOPE_FRIENDS_WORK                  = 'friends_work_history';
  85      // Open Graph Permissions
  86      const SCOPE_USER_MUSIC                    = 'user_actions.music';
  87      const SCOPE_FRIENDS_MUSIC                 = 'friends_actions.music';
  88      const SCOPE_USER_NEWS                     = 'user_actions.news';
  89      const SCOPE_FRIENDS_NEWS                  = 'friends_actions.news';
  90      const SCOPE_USER_VIDEO                    = 'user_actions.video';
  91      const SCOPE_FREINDS_VIDEO                 = 'friends_actions.video';
  92      const SCOPE_USER_APP                      = 'user_actions:APP_NAMESPACE';
  93      const SCOPE_FRIENDS_APP                   = 'friends_actions:APP_NAMESPACE';
  94      const SCOPE_USER_GAMES                    = 'user_games_activity';
  95      const SCOPE_FRIENDS_GAMES                 = 'friends_games_activity';
  96      //Page Permissions
  97      const SCOPE_PAGES                         = 'manage_pages';
  98  
  99      public function __construct(
 100          CredentialsInterface $credentials,
 101          ClientInterface $httpClient,
 102          TokenStorageInterface $storage,
 103          $scopes = array(),
 104          UriInterface $baseApiUri = null
 105      ) {
 106          parent::__construct($credentials, $httpClient, $storage, $scopes, $baseApiUri);
 107  
 108          if (null === $baseApiUri) {
 109              $this->baseApiUri = new Uri('https://graph.facebook.com/');
 110          }
 111      }
 112  
 113      /**
 114       * {@inheritdoc}
 115       */
 116      public function getAuthorizationEndpoint()
 117      {
 118          return new Uri('https://www.facebook.com/dialog/oauth');
 119      }
 120  
 121      /**
 122       * {@inheritdoc}
 123       */
 124      public function getAccessTokenEndpoint()
 125      {
 126          return new Uri('https://graph.facebook.com/oauth/access_token');
 127      }
 128  
 129      /**
 130       * {@inheritdoc}
 131       */
 132      protected function parseAccessTokenResponse($responseBody)
 133      {
 134          // Facebook gives us a query string ... Oh wait. JSON is too simple, understand ?
 135          parse_str($responseBody, $data);
 136  
 137          if (null === $data || !is_array($data)) {
 138              throw new TokenResponseException('Unable to parse response.');
 139          } elseif (isset($data['error'])) {
 140              throw new TokenResponseException('Error in retrieving token: "' . $data['error'] . '"');
 141          }
 142  
 143          $token = new StdOAuth2Token();
 144          $token->setAccessToken($data['access_token']);
 145          $token->setLifeTime($data['expires']);
 146  
 147          if (isset($data['refresh_token'])) {
 148              $token->setRefreshToken($data['refresh_token']);
 149              unset($data['refresh_token']);
 150          }
 151  
 152          unset($data['access_token']);
 153          unset($data['expires']);
 154  
 155          $token->setExtraParams($data);
 156  
 157          return $token;
 158      }
 159  }