Facebook.php 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. <?php
  2. namespace OAuth\OAuth2\Service;
  3. use OAuth\Common\Exception\Exception;
  4. use OAuth\OAuth2\Token\StdOAuth2Token;
  5. use OAuth\Common\Http\Exception\TokenResponseException;
  6. use OAuth\Common\Http\Uri\Uri;
  7. use OAuth\Common\Consumer\CredentialsInterface;
  8. use OAuth\Common\Http\Client\ClientInterface;
  9. use OAuth\Common\Storage\TokenStorageInterface;
  10. use OAuth\Common\Http\Uri\UriInterface;
  11. class Facebook extends AbstractService
  12. {
  13. /**
  14. * Facebook www url - used to build dialog urls
  15. */
  16. const WWW_URL = 'https://www.facebook.com/';
  17. /**
  18. * Defined scopes
  19. *
  20. * If you don't think this is scary you should not be allowed on the web at all
  21. *
  22. * @link https://developers.facebook.com/docs/reference/login/
  23. * @link https://developers.facebook.com/tools/explorer For a list of permissions use 'Get Access Token'
  24. */
  25. // Default scope
  26. const SCOPE_PUBLIC_PROFILE = 'public_profile';
  27. // Email scopes
  28. const SCOPE_EMAIL = 'email';
  29. // Extended permissions
  30. const SCOPE_READ_FRIENDLIST = 'read_friendlists';
  31. const SCOPE_READ_INSIGHTS = 'read_insights';
  32. const SCOPE_READ_MAILBOX = 'read_mailbox';
  33. const SCOPE_READ_PAGE_MAILBOXES = 'read_page_mailboxes';
  34. const SCOPE_READ_REQUESTS = 'read_requests';
  35. const SCOPE_READ_STREAM = 'read_stream';
  36. const SCOPE_VIDEO_UPLOAD = 'video_upload';
  37. const SCOPE_XMPP_LOGIN = 'xmpp_login';
  38. const SCOPE_USER_ONLINE_PRESENCE = 'user_online_presence';
  39. const SCOPE_FRIENDS_ONLINE_PRESENCE = 'friends_online_presence';
  40. const SCOPE_ADS_MANAGEMENT = 'ads_management';
  41. const SCOPE_ADS_READ = 'ads_read';
  42. const SCOPE_CREATE_EVENT = 'create_event';
  43. const SCOPE_CREATE_NOTE = 'create_note';
  44. const SCOPE_EXPORT_STREAM = 'export_stream';
  45. const SCOPE_MANAGE_FRIENDLIST = 'manage_friendlists';
  46. const SCOPE_MANAGE_NOTIFICATIONS = 'manage_notifications';
  47. const SCOPE_PHOTO_UPLOAD = 'photo_upload';
  48. const SCOPE_PUBLISH_ACTIONS = 'publish_actions';
  49. const SCOPE_PUBLISH_CHECKINS = 'publish_checkins';
  50. const SCOPE_PUBLISH_STREAM = 'publish_stream';
  51. const SCOPE_RSVP_EVENT = 'rsvp_event';
  52. const SCOPE_SHARE_ITEM = 'share_item';
  53. const SCOPE_SMS = 'sms';
  54. const SCOPE_STATUS_UPDATE = 'status_update';
  55. // Extended Profile Properties
  56. const SCOPE_USER_POSTS = 'user_posts';
  57. const SCOPE_USER_FRIENDS = 'user_friends';
  58. const SCOPE_USER_ABOUT = 'user_about_me';
  59. const SCOPE_USER_TAGGED_PLACES = 'user_tagged_places';
  60. const SCOPE_FRIENDS_ABOUT = 'friends_about_me';
  61. const SCOPE_USER_ACTIVITIES = 'user_activities';
  62. const SCOPE_FRIENDS_ACTIVITIES = 'friends_activities';
  63. const SCOPE_USER_BIRTHDAY = 'user_birthday';
  64. const SCOPE_FRIENDS_BIRTHDAY = 'friends_birthday';
  65. const SCOPE_USER_CHECKINS = 'user_checkins';
  66. const SCOPE_FRIENDS_CHECKINS = 'friends_checkins';
  67. const SCOPE_USER_EDUCATION = 'user_education_history';
  68. const SCOPE_FRIENDS_EDUCATION = 'friends_education_history';
  69. const SCOPE_USER_EVENTS = 'user_events';
  70. const SCOPE_FRIENDS_EVENTS = 'friends_events';
  71. const SCOPE_USER_GROUPS = 'user_groups';
  72. const SCOPE_USER_MANAGED_GROUPS = 'user_managed_groups';
  73. const SCOPE_FRIENDS_GROUPS = 'friends_groups';
  74. const SCOPE_USER_HOMETOWN = 'user_hometown';
  75. const SCOPE_FRIENDS_HOMETOWN = 'friends_hometown';
  76. const SCOPE_USER_INTERESTS = 'user_interests';
  77. const SCOPE_FRIEND_INTERESTS = 'friends_interests';
  78. const SCOPE_USER_LIKES = 'user_likes';
  79. const SCOPE_FRIENDS_LIKES = 'friends_likes';
  80. const SCOPE_USER_LOCATION = 'user_location';
  81. const SCOPE_FRIENDS_LOCATION = 'friends_location';
  82. const SCOPE_USER_NOTES = 'user_notes';
  83. const SCOPE_FRIENDS_NOTES = 'friends_notes';
  84. const SCOPE_USER_PHOTOS = 'user_photos';
  85. const SCOPE_USER_PHOTO_VIDEO_TAGS = 'user_photo_video_tags';
  86. const SCOPE_FRIENDS_PHOTOS = 'friends_photos';
  87. const SCOPE_FRIENDS_PHOTO_VIDEO_TAGS = 'friends_photo_video_tags';
  88. const SCOPE_USER_QUESTIONS = 'user_questions';
  89. const SCOPE_FRIENDS_QUESTIONS = 'friends_questions';
  90. const SCOPE_USER_RELATIONSHIPS = 'user_relationships';
  91. const SCOPE_FRIENDS_RELATIONSHIPS = 'friends_relationships';
  92. const SCOPE_USER_RELATIONSHIPS_DETAILS = 'user_relationship_details';
  93. const SCOPE_FRIENDS_RELATIONSHIPS_DETAILS = 'friends_relationship_details';
  94. const SCOPE_USER_RELIGION = 'user_religion_politics';
  95. const SCOPE_FRIENDS_RELIGION = 'friends_religion_politics';
  96. const SCOPE_USER_STATUS = 'user_status';
  97. const SCOPE_FRIENDS_STATUS = 'friends_status';
  98. const SCOPE_USER_SUBSCRIPTIONS = 'user_subscriptions';
  99. const SCOPE_FRIENDS_SUBSCRIPTIONS = 'friends_subscriptions';
  100. const SCOPE_USER_VIDEOS = 'user_videos';
  101. const SCOPE_FRIENDS_VIDEOS = 'friends_videos';
  102. const SCOPE_USER_WEBSITE = 'user_website';
  103. const SCOPE_FRIENDS_WEBSITE = 'friends_website';
  104. const SCOPE_USER_WORK = 'user_work_history';
  105. const SCOPE_FRIENDS_WORK = 'friends_work_history';
  106. // Open Graph Permissions
  107. const SCOPE_USER_MUSIC = 'user_actions.music';
  108. const SCOPE_FRIENDS_MUSIC = 'friends_actions.music';
  109. const SCOPE_USER_NEWS = 'user_actions.news';
  110. const SCOPE_FRIENDS_NEWS = 'friends_actions.news';
  111. const SCOPE_USER_VIDEO = 'user_actions.video';
  112. const SCOPE_FRIENDS_VIDEO = 'friends_actions.video';
  113. const SCOPE_USER_APP = 'user_actions:APP_NAMESPACE';
  114. const SCOPE_FRIENDS_APP = 'friends_actions:APP_NAMESPACE';
  115. const SCOPE_USER_GAMES = 'user_games_activity';
  116. const SCOPE_FRIENDS_GAMES = 'friends_games_activity';
  117. //Page Permissions
  118. const SCOPE_PAGES = 'manage_pages';
  119. const SCOPE_PUBLISH_PAGES = 'publish_pages';
  120. public function __construct(
  121. CredentialsInterface $credentials,
  122. ClientInterface $httpClient,
  123. TokenStorageInterface $storage,
  124. $scopes = array(),
  125. UriInterface $baseApiUri = null,
  126. $apiVersion = ""
  127. ) {
  128. parent::__construct($credentials, $httpClient, $storage, $scopes, $baseApiUri, true, $apiVersion);
  129. if (null === $baseApiUri) {
  130. $this->baseApiUri = new Uri('https://graph.facebook.com'.$this->getApiVersionString().'/');
  131. }
  132. }
  133. /**
  134. * {@inheritdoc}
  135. */
  136. public function getAuthorizationEndpoint()
  137. {
  138. return new Uri('https://www.facebook.com'.$this->getApiVersionString().'/dialog/oauth');
  139. }
  140. /**
  141. * {@inheritdoc}
  142. */
  143. public function getAccessTokenEndpoint()
  144. {
  145. return new Uri('https://graph.facebook.com'.$this->getApiVersionString().'/oauth/access_token');
  146. }
  147. /**
  148. * {@inheritdoc}
  149. */
  150. protected function parseAccessTokenResponse($responseBody)
  151. {
  152. $data = @json_decode($responseBody, true);
  153. // Facebook gives us a query string on old api (v2.0)
  154. if (!$data) {
  155. parse_str($responseBody, $data);
  156. }
  157. if (null === $data || !is_array($data)) {
  158. throw new TokenResponseException('Unable to parse response.');
  159. } elseif (isset($data['error'])) {
  160. throw new TokenResponseException('Error in retrieving token: "' . $data['error'] . '"');
  161. }
  162. $token = new StdOAuth2Token();
  163. $token->setAccessToken($data['access_token']);
  164. if (isset($data['expires'])) {
  165. $token->setLifeTime($data['expires']);
  166. }
  167. if (isset($data['refresh_token'])) {
  168. $token->setRefreshToken($data['refresh_token']);
  169. unset($data['refresh_token']);
  170. }
  171. unset($data['access_token']);
  172. unset($data['expires']);
  173. $token->setExtraParams($data);
  174. return $token;
  175. }
  176. public function getDialogUri($dialogPath, array $parameters)
  177. {
  178. if (!isset($parameters['redirect_uri'])) {
  179. throw new Exception("Redirect uri is mandatory for this request");
  180. }
  181. $parameters['app_id'] = $this->credentials->getConsumerId();
  182. $baseUrl = self::WWW_URL .$this->getApiVersionString(). '/dialog/' . $dialogPath;
  183. $query = http_build_query($parameters);
  184. return new Uri($baseUrl . '?' . $query);
  185. }
  186. /**
  187. * {@inheritdoc}
  188. */
  189. protected function getApiVersionString()
  190. {
  191. return empty($this->apiVersion) ? '' : '/v' . $this->apiVersion;
  192. }
  193. /**
  194. * {@inheritdoc}
  195. */
  196. protected function getScopesDelimiter()
  197. {
  198. return ',';
  199. }
  200. }