ywww: facebook.php annotate

annotate facebook.php @ 24:341d8c681357

prepare for temporary closure

author	Robert Boland <robert@markup.co.uk>
date	Tue, 01 Jan 2019 07:29:44 -0500
parents	077b0a0a3e6d
children

rev	line source
6 077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	1 <?php
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	2
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	3 if (!function_exists('curl_init')) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	4 throw new Exception('Facebook needs the CURL PHP extension.');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	5 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	6 if (!function_exists('json_decode')) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	7 throw new Exception('Facebook needs the JSON PHP extension.');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	8 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	9
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	10 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	11 * Thrown when an API call returns an exception.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	12 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	13 * @author Naitik Shah <naitik@facebook.com>
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	14 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	15 class FacebookApiException extends Exception
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	16 {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	17 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	18 * The result from the API server that represents the exception information.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	19 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	20 protected $result;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	21
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	22 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	23 * Make a new API Exception with the given result.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	24 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	25 * @param Array $result the result from the API server
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	26 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	27 public function __construct($result) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	28 $this->result = $result;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	29
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	30 $code = isset($result['error_code']) ? $result['error_code'] : 0;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	31 $msg = isset($result['error'])
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	32 ? $result['error']['message'] : $result['error_msg'];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	33 parent::__construct($msg, $code);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	34 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	35
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	36 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	37 * Return the associated result object returned by the API server.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	38 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	39 * @returns Array the result from the API server
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	40 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	41 public function getResult() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	42 return $this->result;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	43 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	44
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	45 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	46 * Returns the associated type for the error. This will default to
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	47 * 'Exception' when a type is not available.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	48 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	49 * @return String
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	50 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	51 public function getType() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	52 return
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	53 isset($this->result['error']) && isset($this->result['error']['type'])
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	54 ? $this->result['error']['type']
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	55 : 'Exception';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	56 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	57
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	58 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	59 * To make debugging easier.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	60 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	61 * @returns String the string representation of the error
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	62 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	63 public function __toString() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	64 $str = $this->getType() . ': ';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	65 if ($this->code != 0) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	66 $str .= $this->code . ': ';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	67 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	68 return $str . $this->message;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	69 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	70 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	71
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	72 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	73 * Provides access to the Facebook Platform.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	74 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	75 * @author Naitik Shah <naitik@facebook.com>
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	76 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	77 class Facebook
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	78 {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	79 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	80 * Version.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	81 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	82 const VERSION = '2.0.5';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	83
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	84 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	85 * Default options for curl.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	86 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	87 public static $CURL_OPTS = array(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	88 CURLOPT_CONNECTTIMEOUT => 10,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	89 CURLOPT_RETURNTRANSFER => true,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	90 CURLOPT_TIMEOUT => 60,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	91 CURLOPT_USERAGENT => 'facebook-php-2.0',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	92 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	93
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	94 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	95 * List of query parameters that get automatically dropped when rebuilding
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	96 * the current URL.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	97 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	98 protected static $DROP_QUERY_PARAMS = array(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	99 'session',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	100 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	101
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	102 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	103 * Maps aliases to Facebook domains.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	104 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	105 public static $DOMAIN_MAP = array(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	106 'api' => 'https://api.facebook.com/',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	107 'api_read' => 'https://api-read.facebook.com/',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	108 'graph' => 'https://graph.facebook.com/',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	109 'www' => 'https://www.facebook.com/',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	110 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	111
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	112 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	113 * The Application ID.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	114 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	115 protected $appId;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	116
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	117 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	118 * The Application API Secret.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	119 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	120 protected $apiSecret;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	121
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	122 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	123 * The active user session, if one is available.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	124 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	125 protected $session;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	126
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	127 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	128 * Indicates that we already loaded the session as best as we could.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	129 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	130 protected $sessionLoaded = false;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	131
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	132 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	133 * Indicates if Cookie support should be enabled.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	134 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	135 protected $cookieSupport = false;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	136
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	137 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	138 * Base domain for the Cookie.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	139 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	140 protected $baseDomain = '';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	141
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	142 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	143 * Initialize a Facebook Application.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	144 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	145 * The configuration:
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	146 * - appId: the application ID
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	147 * - secret: the application secret
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	148 * - cookie: (optional) boolean true to enable cookie support
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	149 * - domain: (optional) domain for the cookie
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	150 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	151 * @param Array $config the application configuration
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	152 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	153 public function __construct($config) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	154 $this->setAppId($config['appId']);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	155 $this->setApiSecret($config['secret']);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	156 if (isset($config['cookie'])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	157 $this->setCookieSupport($config['cookie']);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	158 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	159 if (isset($config['domain'])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	160 $this->setBaseDomain($config['domain']);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	161 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	162 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	163
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	164 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	165 * Set the Application ID.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	166 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	167 * @param String $appId the Application ID
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	168 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	169 public function setAppId($appId) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	170 $this->appId = $appId;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	171 return $this;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	172 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	173
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	174 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	175 * Get the Application ID.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	176 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	177 * @return String the Application ID
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	178 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	179 public function getAppId() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	180 return $this->appId;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	181 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	182
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	183 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	184 * Set the API Secret.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	185 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	186 * @param String $appId the API Secret
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	187 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	188 public function setApiSecret($apiSecret) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	189 $this->apiSecret = $apiSecret;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	190 return $this;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	191 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	192
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	193 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	194 * Get the API Secret.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	195 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	196 * @return String the API Secret
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	197 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	198 public function getApiSecret() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	199 return $this->apiSecret;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	200 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	201
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	202 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	203 * Set the Cookie Support status.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	204 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	205 * @param Boolean $cookieSupport the Cookie Support status
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	206 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	207 public function setCookieSupport($cookieSupport) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	208 $this->cookieSupport = $cookieSupport;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	209 return $this;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	210 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	211
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	212 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	213 * Get the Cookie Support status.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	214 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	215 * @return Boolean the Cookie Support status
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	216 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	217 public function useCookieSupport() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	218 return $this->cookieSupport;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	219 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	220
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	221 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	222 * Set the base domain for the Cookie.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	223 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	224 * @param String $domain the base domain
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	225 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	226 public function setBaseDomain($domain) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	227 $this->baseDomain = $domain;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	228 return $this;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	229 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	230
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	231 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	232 * Get the base domain for the Cookie.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	233 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	234 * @return String the base domain
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	235 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	236 public function getBaseDomain() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	237 return $this->baseDomain;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	238 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	239
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	240 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	241 * Set the Session.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	242 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	243 * @param Array $session the session
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	244 * @param Boolean $write_cookie indicate if a cookie should be written. this
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	245 * value is ignored if cookie support has been disabled.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	246 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	247 public function setSession($session=null, $write_cookie=true) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	248 $session = $this->validateSessionObject($session);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	249 $this->sessionLoaded = true;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	250 $this->session = $session;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	251 if ($write_cookie) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	252 $this->setCookieFromSession($session);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	253 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	254 return $this;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	255 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	256
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	257 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	258 * Get the session object. This will automatically look for a signed session
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	259 * sent via the Cookie or Query Parameters if needed.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	260 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	261 * @return Array the session
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	262 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	263 public function getSession() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	264 if (!$this->sessionLoaded) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	265 $session = null;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	266 $write_cookie = true;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	267
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	268 // try loading session from $_REQUEST
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	269 if (isset($_REQUEST['session'])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	270 $session = json_decode(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	271 get_magic_quotes_gpc()
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	272 ? stripslashes(urldecode($_REQUEST['session']))
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	273 : urldecode($_REQUEST['session']),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	274 true
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	275 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	276 $session = $this->validateSessionObject($session);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	277 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	278
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	279 // try loading session from cookie if necessary
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	280 if (!$session && $this->useCookieSupport()) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	281 $cookieName = $this->getSessionCookieName();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	282 if (isset($_COOKIE[$cookieName])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	283 $session = array();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	284 parse_str(trim(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	285 get_magic_quotes_gpc()
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	286 ? stripslashes($_COOKIE[$cookieName])
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	287 : $_COOKIE[$cookieName],
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	288 '"'
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	289 ), $session);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	290 $session = $this->validateSessionObject($session);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	291 // write only if we need to delete a invalid session cookie
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	292 $write_cookie = empty($session);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	293 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	294 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	295
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	296 $this->setSession($session, $write_cookie);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	297 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	298
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	299 return $this->session;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	300 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	301
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	302 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	303 * Get the UID from the session.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	304 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	305 * @return String the UID if available
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	306 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	307 public function getUser() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	308 $session = $this->getSession();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	309 return $session ? $session['uid'] : null;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	310 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	311
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	312 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	313 * Get a Login URL for use with redirects. By default, full page redirect is
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	314 * assumed. If you are using the generated URL with a window.open() call in
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	315 * JavaScript, you can pass in display=popup as part of the $params.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	316 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	317 * The parameters:
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	318 * - next: the url to go to after a successful login
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	319 * - cancel_url: the url to go to after the user cancels
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	320 * - req_perms: comma separated list of requested extended perms
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	321 * - display: can be "page" (default, full page) or "popup"
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	322 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	323 * @param Array $params provide custom parameters
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	324 * @return String the URL for the login flow
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	325 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	326 public function getLoginUrl($params=array()) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	327 $currentUrl = $this->getCurrentUrl();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	328 return $this->getUrl(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	329 'www',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	330 'login.php',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	331 array_merge(array(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	332 'api_key' => $this->getAppId(),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	333 'cancel_url' => $currentUrl,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	334 'display' => 'page',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	335 'fbconnect' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	336 'next' => $currentUrl,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	337 'return_session' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	338 'session_version' => 3,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	339 'v' => '1.0',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	340 ), $params)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	341 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	342 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	343
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	344 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	345 * Get a Logout URL suitable for use with redirects.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	346 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	347 * The parameters:
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	348 * - next: the url to go to after a successful logout
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	349 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	350 * @param Array $params provide custom parameters
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	351 * @return String the URL for the logout flow
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	352 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	353 public function getLogoutUrl($params=array()) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	354 $session = $this->getSession();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	355 return $this->getUrl(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	356 'www',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	357 'logout.php',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	358 array_merge(array(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	359 'api_key' => $this->getAppId(),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	360 'next' => $this->getCurrentUrl(),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	361 'session_key' => $session['session_key'],
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	362 ), $params)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	363 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	364 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	365
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	366 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	367 * Get a login status URL to fetch the status from facebook.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	368 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	369 * The parameters:
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	370 * - ok_session: the URL to go to if a session is found
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	371 * - no_session: the URL to go to if the user is not connected
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	372 * - no_user: the URL to go to if the user is not signed into facebook
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	373 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	374 * @param Array $params provide custom parameters
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	375 * @return String the URL for the logout flow
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	376 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	377 public function getLoginStatusUrl($params=array()) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	378 return $this->getUrl(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	379 'www',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	380 'extern/login_status.php',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	381 array_merge(array(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	382 'api_key' => $this->getAppId(),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	383 'no_session' => $this->getCurrentUrl(),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	384 'no_user' => $this->getCurrentUrl(),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	385 'ok_session' => $this->getCurrentUrl(),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	386 'session_version' => 3,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	387 ), $params)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	388 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	389 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	390
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	391 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	392 * Make an API call.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	393 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	394 * @param Array $params the API call parameters
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	395 * @return the decoded response
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	396 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	397 public function api(/* polymorphic */) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	398 $args = func_get_args();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	399 if (is_array($args[0])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	400 return $this->_restserver($args[0]);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	401 } else {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	402 return call_user_func_array(array($this, '_graph'), $args);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	403 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	404 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	405
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	406 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	407 * Invoke the old restserver.php endpoint.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	408 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	409 * @param Array $params method call object
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	410 * @return the decoded response object
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	411 * @throws FacebookApiException
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	412 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	413 protected function _restserver($params) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	414 // generic application level parameters
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	415 $params['api_key'] = $this->getAppId();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	416 $params['format'] = 'json-strings';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	417
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	418 $result = json_decode($this->_oauthRequest(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	419 $this->getApiUrl($params['method']),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	420 $params
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	421 ), true);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	422
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	423 // results are returned, errors are thrown
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	424 if (is_array($result) && isset($result['error_code'])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	425 throw new FacebookApiException($result);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	426 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	427 return $result;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	428 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	429
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	430 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	431 * Invoke the Graph API.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	432 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	433 * @param String $path the path (required)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	434 * @param String $method the http method (default 'GET')
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	435 * @param Array $params the query/post data
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	436 * @return the decoded response object
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	437 * @throws FacebookApiException
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	438 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	439 protected function _graph($path, $method='GET', $params=array()) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	440 if (is_array($method) && empty($params)) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	441 $params = $method;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	442 $method = 'GET';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	443 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	444 $params['method'] = $method; // method override as we always do a POST
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	445
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	446 $result = json_decode($this->_oauthRequest(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	447 $this->getUrl('graph', $path),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	448 $params
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	449 ), true);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	450
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	451 // results are returned, errors are thrown
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	452 if (is_array($result) && isset($result['error'])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	453 $e = new FacebookApiException($result);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	454 if ($e->getType() === 'OAuthException') {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	455 $this->setSession(null);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	456 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	457 throw $e;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	458 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	459 return $result;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	460 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	461
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	462 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	463 * Make a OAuth Request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	464 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	465 * @param String $path the path (required)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	466 * @param Array $params the query/post data
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	467 * @return the decoded response object
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	468 * @throws FacebookApiException
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	469 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	470 protected function _oauthRequest($url, $params) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	471 if (!isset($params['access_token'])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	472 $session = $this->getSession();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	473 // either user session signed, or app signed
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	474 if ($session) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	475 $params['access_token'] = $session['access_token'];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	476 } else {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	477 $params['access_token'] = $this->getAppId() .'\|'. $this->getApiSecret();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	478 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	479 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	480
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	481 // json_encode all params values that are not strings
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	482 foreach ($params as $key => $value) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	483 if (!is_string($value)) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	484 $params[$key] = json_encode($value);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	485 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	486 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	487 return $this->makeRequest($url, $params);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	488 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	489
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	490 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	491 * Makes an HTTP request. This method can be overriden by subclasses if
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	492 * developers want to do fancier things or use something other than curl to
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	493 * make the request.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	494 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	495 * @param String $url the URL to make the request to
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	496 * @param Array $params the parameters to use for the POST body
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	497 * @param CurlHandler $ch optional initialized curl handle
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	498 * @return String the response text
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	499 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	500 protected function makeRequest($url, $params, $ch=null) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	501 if (!$ch) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	502 $ch = curl_init();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	503 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	504
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	505 $opts = self::$CURL_OPTS;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	506 $opts[CURLOPT_POSTFIELDS] = http_build_query($params, null, '&');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	507 $opts[CURLOPT_URL] = $url;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	508 curl_setopt_array($ch, $opts);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	509 $result = curl_exec($ch);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	510 if ($result === false) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	511 $e = new FacebookApiException(array(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	512 'error_code' => curl_errno($ch),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	513 'error' => array(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	514 'message' => curl_error($ch),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	515 'type' => 'CurlException',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	516 ),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	517 ));
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	518 curl_close($ch);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	519 throw $e;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	520 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	521 curl_close($ch);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	522 return $result;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	523 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	524
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	525 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	526 * The name of the Cookie that contains the session.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	527 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	528 * @return String the cookie name
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	529 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	530 protected function getSessionCookieName() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	531 return 'fbs_' . $this->getAppId();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	532 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	533
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	534 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	535 * Set a JS Cookie based on the _passed in_ session. It does not use the
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	536 * currently stored session -- you need to explicitly pass it in.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	537 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	538 * @param Array $session the session to use for setting the cookie
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	539 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	540 protected function setCookieFromSession($session=null) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	541 if (!$this->useCookieSupport()) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	542 return;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	543 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	544
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	545 $cookieName = $this->getSessionCookieName();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	546 $value = 'deleted';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	547 $expires = time() - 3600;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	548 $domain = $this->getBaseDomain();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	549 if ($session) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	550 $value = '"' . http_build_query($session, null, '&') . '"';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	551 if (isset($session['base_domain'])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	552 $domain = $session['base_domain'];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	553 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	554 $expires = $session['expires'];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	555 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	556
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	557 // prepend dot if a domain is found
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	558 if ($domain) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	559 $domain = '.' . $domain;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	560 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	561
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	562 // if an existing cookie is not set, we dont need to delete it
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	563 if ($value == 'deleted' && empty($_COOKIE[$cookieName])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	564 return;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	565 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	566
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	567 if (headers_sent()) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	568 // disable error log if we are running in a CLI environment
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	569 // @codeCoverageIgnoreStart
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	570 if (php_sapi_name() != 'cli') {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	571 error_log('Could not set cookie. Headers already sent.');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	572 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	573 // @codeCoverageIgnoreEnd
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	574
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	575 // ignore for code coverage as we will never be able to setcookie in a CLI
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	576 // environment
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	577 // @codeCoverageIgnoreStart
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	578 } else {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	579 setcookie($cookieName, $value, $expires, '/', $domain);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	580 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	581 // @codeCoverageIgnoreEnd
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	582 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	583
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	584 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	585 * Validates a session_version=3 style session object.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	586 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	587 * @param Array $session the session object
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	588 * @return Array the session object if it validates, null otherwise
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	589 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	590 protected function validateSessionObject($session) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	591 // make sure some essential fields exist
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	592 if (is_array($session) &&
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	593 isset($session['uid']) &&
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	594 isset($session['session_key']) &&
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	595 isset($session['secret']) &&
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	596 isset($session['access_token']) &&
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	597 isset($session['sig'])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	598 // validate the signature
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	599 $session_without_sig = $session;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	600 unset($session_without_sig['sig']);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	601 $expected_sig = self::generateSignature(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	602 $session_without_sig,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	603 $this->getApiSecret()
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	604 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	605 if ($session['sig'] != $expected_sig) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	606 // disable error log if we are running in a CLI environment
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	607 // @codeCoverageIgnoreStart
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	608 if (php_sapi_name() != 'cli') {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	609 error_log('Got invalid session signature in cookie.');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	610 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	611 // @codeCoverageIgnoreEnd
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	612 $session = null;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	613 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	614 // check expiry time
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	615 } else {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	616 $session = null;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	617 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	618 return $session;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	619 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	620
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	621 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	622 * Build the URL for api given parameters.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	623 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	624 * @param $method String the method name.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	625 * @return String the URL for the given parameters
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	626 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	627 protected function getApiUrl($method) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	628 static $READ_ONLY_CALLS =
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	629 array('admin.getallocation' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	630 'admin.getappproperties' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	631 'admin.getbannedusers' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	632 'admin.getlivestreamvialink' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	633 'admin.getmetrics' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	634 'admin.getrestrictioninfo' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	635 'application.getpublicinfo' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	636 'auth.getapppublickey' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	637 'auth.getsession' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	638 'auth.getsignedpublicsessiondata' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	639 'comments.get' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	640 'connect.getunconnectedfriendscount' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	641 'dashboard.getactivity' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	642 'dashboard.getcount' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	643 'dashboard.getglobalnews' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	644 'dashboard.getnews' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	645 'dashboard.multigetcount' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	646 'dashboard.multigetnews' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	647 'data.getcookies' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	648 'events.get' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	649 'events.getmembers' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	650 'fbml.getcustomtags' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	651 'feed.getappfriendstories' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	652 'feed.getregisteredtemplatebundlebyid' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	653 'feed.getregisteredtemplatebundles' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	654 'fql.multiquery' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	655 'fql.query' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	656 'friends.arefriends' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	657 'friends.get' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	658 'friends.getappusers' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	659 'friends.getlists' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	660 'friends.getmutualfriends' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	661 'gifts.get' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	662 'groups.get' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	663 'groups.getmembers' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	664 'intl.gettranslations' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	665 'links.get' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	666 'notes.get' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	667 'notifications.get' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	668 'pages.getinfo' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	669 'pages.isadmin' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	670 'pages.isappadded' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	671 'pages.isfan' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	672 'permissions.checkavailableapiaccess' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	673 'permissions.checkgrantedapiaccess' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	674 'photos.get' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	675 'photos.getalbums' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	676 'photos.gettags' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	677 'profile.getinfo' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	678 'profile.getinfooptions' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	679 'stream.get' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	680 'stream.getcomments' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	681 'stream.getfilters' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	682 'users.getinfo' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	683 'users.getloggedinuser' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	684 'users.getstandardinfo' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	685 'users.hasapppermission' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	686 'users.isappuser' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	687 'users.isverified' => 1,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	688 'video.getuploadlimits' => 1);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	689 $name = 'api';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	690 if (isset($READ_ONLY_CALLS[strtolower($method)])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	691 $name = 'api_read';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	692 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	693 return self::getUrl($name, 'restserver.php');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	694 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	695
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	696 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	697 * Build the URL for given domain alias, path and parameters.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	698 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	699 * @param $name String the name of the domain
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	700 * @param $path String optional path (without a leading slash)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	701 * @param $params Array optional query parameters
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	702 * @return String the URL for the given parameters
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	703 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	704 protected function getUrl($name, $path='', $params=array()) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	705 $url = self::$DOMAIN_MAP[$name];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	706 if ($path) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	707 if ($path[0] === '/') {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	708 $path = substr($path, 1);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	709 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	710 $url .= $path;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	711 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	712 if ($params) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	713 $url .= '?' . http_build_query($params);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	714 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	715 return $url;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	716 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	717
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	718 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	719 * Returns the Current URL, stripping it of known FB parameters that should
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	720 * not persist.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	721 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	722 * @return String the current URL
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	723 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	724 protected function getCurrentUrl() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	725 $protocol = isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on'
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	726 ? 'https://'
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	727 : 'http://';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	728 $currentUrl = $protocol . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	729 $parts = parse_url($currentUrl);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	730
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	731 // drop known fb params
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	732 $query = '';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	733 if (!empty($parts['query'])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	734 $params = array();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	735 parse_str($parts['query'], $params);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	736 foreach(self::$DROP_QUERY_PARAMS as $key) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	737 unset($params[$key]);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	738 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	739 if (!empty($params)) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	740 $query = '?' . http_build_query($params);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	741 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	742 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	743
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	744 // use port if non default
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	745 $port =
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	746 isset($parts['port']) &&
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	747 (($protocol === 'http://' && $parts['port'] !== 80) \|\|
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	748 ($protocol === 'https://' && $parts['port'] !== 443))
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	749 ? ':' . $parts['port'] : '';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	750
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	751 // rebuild
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	752 return $protocol . $parts['host'] . $port . $parts['path'] . $query;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	753 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	754
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	755 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	756 * Generate a signature for the given params and secret.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	757 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	758 * @param Array $params the parameters to sign
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	759 * @param String $secret the secret to sign with
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	760 * @return String the generated signature
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	761 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	762 protected static function generateSignature($params, $secret) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	763 // work with sorted data
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	764 ksort($params);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	765
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	766 // generate the base string
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	767 $base_string = '';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	768 foreach($params as $key => $value) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	769 $base_string .= $key . '=' . $value;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	770 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	771 $base_string .= $secret;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	772
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	773 return md5($base_string);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	774 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	775 }

Mercurial > hg > ywww

annotate facebook.php @ 24:341d8c681357