-
Notifications
You must be signed in to change notification settings - Fork 5
/
Gravatar.php
300 lines (263 loc) · 7.86 KB
/
Gravatar.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
<?php
/**
*
*===================================================================
*
* GravatarLib - Gravatar PHP 5.3 OOP Library
*-------------------------------------------------------------------
* @category gravatarlib
* @package gravatarlib
* @author emberlabs.org
* @copyright (c) 2011 emberlabs.org
* @license MIT License
* @link https://github.com/emberlabs/gravatarlib
*
*===================================================================
*
* This source file is subject to the MIT license that is bundled
* with this package in the file LICENSE.
*
*/
namespace thomaswelton\GravatarLib;
use \InvalidArgumentException;
/**
* GravatarLib - A lightweight library for working with gravatars en masse,
* used for setting a ton of options and then just passing in only the essential data needed.
*
*
* @category gravatarlib
* @package gravatarlib
* @author emberlabs.org
* @license MIT License
* @link https://github.com/emberlabs/gravatarlib
*/
class Gravatar
{
/**
* @var integer - The size to use for avatars.
*/
protected $size = 80;
/**
* @var mixed - The default image to use - either a string of the gravatar-recognized default image "type" to use, a URL, or false if using the...default gravatar default image (hah)
*/
protected $default_image = false;
/**
* @var string - The maximum rating to allow for the avatar.
*/
protected $max_rating = 'g';
/**
* @var boolean - Should we use the secure (HTTPS) URL base?
*/
protected $use_secure_url = false;
/**
* @var string - A temporary internal cache of the URL parameters to use.
*/
protected $param_cache = NULL;
/**#@+
* @var string - URL constants for the avatar images
*/
const HTTP_URL = 'http://www.gravatar.com/avatar/';
const HTTPS_URL = 'https://secure.gravatar.com/avatar/';
/**#@-*/
/**
* Get the currently set avatar size.
* @return integer - The current avatar size in use.
*/
public function getAvatarSize()
{
return $this->size;
}
/**
* Set the avatar size to use.
* @param integer $size - The avatar size to use, must be less than 512 and greater than 0.
* @return \thomaswelton\GravatarLib\Gravatar - Provides a fluent interface.
*
* @throws \InvalidArgumentException
*/
public function setAvatarSize($size)
{
// Wipe out the param cache.
$this->param_cache = NULL;
if(!is_int($size) && !ctype_digit($size))
{
throw new InvalidArgumentException('Avatar size specified must be an integer');
}
$this->size = (int) $size;
if($this->size > 512 || $this->size < 0)
{
throw new InvalidArgumentException('Avatar size must be within 0 pixels and 512 pixels');
}
return $this;
}
/**
* Get the current default image setting.
* @return mixed - False if no default image set, string if one is set.
*/
public function getDefaultImage()
{
return $this->default_image;
}
/**
* Set the default image to use for avatars.
* @param mixed $image - The default image to use. Use boolean false for the gravatar default, a string containing a valid image URL, or a string specifying a recognized gravatar "default".
* @return \thomaswelton\GravatarLib\Gravatar - Provides a fluent interface.
*
* @throws \InvalidArgumentException
*/
public function setDefaultImage($image)
{
// Quick check against boolean false.
if($image === false)
{
$this->default_image = false;
return $this;
}
// Wipe out the param cache.
$this->param_cache = NULL;
// Check $image against recognized gravatar "defaults", and if it doesn't match any of those we need to see if it is a valid URL.
$_image = strtolower($image);
$valid_defaults = array('404' => 1, 'mm' => 1, 'identicon' => 1, 'monsterid' => 1, 'wavatar' => 1, 'retro' => 1);
if(!isset($valid_defaults[$_image]))
{
if(!filter_var($image, FILTER_VALIDATE_URL))
{
throw new InvalidArgumentException('The default image specified is not a recognized gravatar "default" and is not a valid URL');
}
else
{
$this->default_image = rawurlencode($image);
}
}
else
{
$this->default_image = $_image;
}
return $this;
}
/**
* Get the current maximum allowed rating for avatars.
* @return string - The string representing the current maximum allowed rating ('g', 'pg', 'r', 'x').
*/
public function getMaxRating()
{
return $this->max_rating;
}
/**
* Set the maximum allowed rating for avatars.
* @param string $rating - The maximum rating to use for avatars ('g', 'pg', 'r', 'x').
* @return \thomaswelton\GravatarLib\Gravatar - Provides a fluent interface.
*
* @throws \InvalidArgumentException
*/
public function setMaxRating($rating)
{
// Wipe out the param cache.
$this->param_cache = NULL;
$rating = strtolower($rating);
$valid_ratings = array('g' => 1, 'pg' => 1, 'r' => 1, 'x' => 1);
if(!isset($valid_ratings[$rating]))
{
throw new InvalidArgumentException(sprintf('Invalid rating "%s" specified, only "g", "pg", "r", or "x" are allowed to be used.', $rating));
}
$this->max_rating = $rating;
return $this;
}
/**
* Check if we are using the secure protocol for the image URLs.
* @return boolean - Are we supposed to use the secure protocol?
*/
public function usingSecureImages()
{
return $this->use_secure_url;
}
/**
* Enable the use of the secure protocol for image URLs.
* @return \thomaswelton\GravatarLib\Gravatar - Provides a fluent interface.
*/
public function enableSecureImages()
{
$this->use_secure_url = true;
return $this;
}
/**
* Disable the use of the secure protocol for image URLs.
* @return \thomaswelton\GravatarLib\Gravatar - Provides a fluent interface.
*/
public function disableSecureImages()
{
$this->use_secure_url = false;
return $this;
}
/**
* Build the avatar URL based on the provided email address.
* @param string $email - The email to get the gravatar for.
* @param string $hash_email - Should we hash the $email variable? (Useful if the email address has a hash stored already)
* @return string - The XHTML-safe URL to the gravatar.
*/
public function buildGravatarURL($email, $hash_email = true)
{
// Start building the URL, and deciding if we're doing this via HTTPS or HTTP.
if($this->usingSecureImages())
{
$url = static::HTTPS_URL;
}
else
{
$url = static::HTTP_URL;
}
// Tack the email hash onto the end.
if($hash_email == true && !empty($email))
{
$url .= $this->getEmailHash($email);
}
elseif(!empty($email))
{
$url .= $email;
}
else
{
$url .= str_repeat('0', 32);
}
// Check to see if the param_cache property has been populated yet
if($this->param_cache === NULL)
{
// Time to figure out our request params
$params = array();
$params[] = 's=' . $this->getAvatarSize();
$params[] = 'r=' . $this->getMaxRating();
if($this->getDefaultImage())
{
$params[] = 'd=' . $this->getDefaultImage();
}
// Stuff the request params into the param_cache property for later reuse
$this->param_cache = (!empty($params)) ? '?' . implode('&', $params) : '';
}
// Handle "null" gravatar requests.
$tail = '';
if(empty($email))
{
$tail = !empty($this->param_cache) ? '&f=y' : '?f=y';
}
// And we're done.
return $url . $this->param_cache . $tail;
}
/**
* Get the email hash to use (after cleaning the string).
* @param string $email - The email to get the hash for.
* @return string - The hashed form of the email, post cleaning.
*/
public function getEmailHash($email)
{
// Using md5 as per gravatar docs.
return hash('md5', strtolower(trim($email)));
}
/**
* ...Yeah, it's just an alias of buildGravatarURL. This is just to make it easier to use as a twig asset.
* @see \thomaswelton\GravatarLib\Gravatar::buildGravatarURL()
*/
public function get($email, $hash_email = true)
{
// Just an alias. Makes it easy to use this as a twig asset.
return $this->buildGravatarURL($email, $hash_email);
}
}