-
Notifications
You must be signed in to change notification settings - Fork 0
/
HipChat.php
489 lines (419 loc) · 12.2 KB
/
HipChat.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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
<?php
namespace HipChat;
/**
* Library for interacting with the HipChat REST API.
*
* @see http://api.hipchat.com/docs/api
*/
class HipChat {
const DEFAULT_TARGET = 'https://api.hipchat.com';
/**
* HTTP response codes from API
*
* @see http://api.hipchat.com/docs/api/response_codes
*/
const STATUS_BAD_RESPONSE = -1; // Not an HTTP response code
const STATUS_OK = 200;
const STATUS_BAD_REQUEST = 400;
const STATUS_UNAUTHORIZED = 401;
const STATUS_FORBIDDEN = 403;
const STATUS_NOT_FOUND = 404;
const STATUS_NOT_ACCEPTABLE = 406;
const STATUS_INTERNAL_SERVER_ERROR = 500;
const STATUS_SERVICE_UNAVAILABLE = 503;
/**
* Colors for rooms/message
*/
const COLOR_YELLOW = 'yellow';
const COLOR_RED = 'red';
const COLOR_GRAY = 'gray';
const COLOR_GREEN = 'green';
const COLOR_PURPLE = 'purple';
const COLOR_RANDOM = 'random';
/**
* Formats for rooms/message
*/
const FORMAT_HTML = 'html';
const FORMAT_TEXT = 'text';
/**
* API versions
*/
const VERSION_1 = 'v1';
private $api_target;
private $auth_token;
private $verify_ssl = true;
private $proxy;
/**
* Creates a new API interaction object.
*
* @param $auth_token string Your API token.
* @param $api_target string API protocol and host. Change if you're using an API
* proxy such as apigee.com.
* @param $api_version string Version of API to use.
*/
function __construct($auth_token, $api_target = self::DEFAULT_TARGET,
$api_version = self::VERSION_1) {
$this->api_target = $api_target;
$this->auth_token = $auth_token;
$this->api_version = $api_version;
}
/////////////////////////////////////////////////////////////////////////////
// Room functions
/////////////////////////////////////////////////////////////////////////////
/**
* Get information about a room
*
* @see http://api.hipchat.com/docs/api/method/rooms/show
*/
public function get_room($room_id) {
$response = $this->make_request('rooms/show', array(
'room_id' => $room_id
));
return $response->room;
}
/**
* Determine if the given room name or room id already exists.
*
* @param mixed $room_id
* @return boolean
*/
public function room_exists($room_id) {
try {
$this->get_room($room_id);
}
catch (HipChat_Exception $e) {
if ($e->code === self::STATUS_NOT_FOUND) {
return false;
}
throw $e;
}
return true;
}
/**
* Get list of rooms
*
* @see http://api.hipchat.com/docs/api/method/rooms/list
*/
public function get_rooms() {
$response = $this->make_request('rooms/list');
return $response->rooms;
}
/**
* Send a message to a room
*
* @see http://api.hipchat.com/docs/api/method/rooms/message
*/
public function message_room($room_id, $from, $message, $notify = false,
$color = self::COLOR_YELLOW,
$message_format = self::FORMAT_HTML) {
$args = array(
'room_id' => $room_id,
'from' => $from,
'message' => $message,
'notify' => (int)$notify,
'color' => $color,
'message_format' => $message_format
);
$response = $this->make_request('rooms/message', $args, 'POST');
return ($response->status == 'sent');
}
/**
* Get chat history for a room
*
* @see https://www.hipchat.com/docs/api/method/rooms/history
*/
public function get_rooms_history($room_id, $date = 'recent') {
$response = $this->make_request('rooms/history', array(
'room_id' => $room_id,
'date' => $date
));
return $response->messages;
}
/**
* Set a room's topic
*
* @see http://api.hipchat.com/docs/api/method/rooms/topic
*/
public function set_room_topic($room_id, $topic, $from = null) {
$args = array(
'room_id' => $room_id,
'topic' => $topic,
);
if ($from) {
$args['from'] = $from;
}
$response = $this->make_request('rooms/topic', $args, 'POST');
return ($response->status == 'ok');
}
/**
* Create a room
*
* @see http://api.hipchat.com/docs/api/method/rooms/create
*/
public function create_room($name, $owner_user_id = null, $privacy = null, $topic = null, $guest_access = null) {
$args = array(
'name' => $name
);
if ($owner_user_id) {
$args['owner_user_id'] = $owner_user_id;
}
if ($privacy) {
$args['privacy'] = $privacy;
}
if ($topic) {
$args['topic'] = $topic;
}
if ($guest_access) {
$args['guest_access'] = (int)$guest_access;
}
// Return the std object
return $this->make_request('rooms/create', $args, 'POST');
}
/**
* Delete a room
*
* @see http://api.hipchat.com/docs/api/method/rooms/delete
*/
public function delete_room($room_id){
$args = array(
'room_id' => $room_id
);
$response = $this->make_request('rooms/delete', $args, 'POST');
return ($response->deleted == 'true');
}
/////////////////////////////////////////////////////////////////////////////
// User functions
/////////////////////////////////////////////////////////////////////////////
/**
* Get information about a user
*
* @see http://api.hipchat.com/docs/api/method/users/show
*/
public function get_user($user_id) {
$response = $this->make_request('users/show', array(
'user_id' => $user_id
));
return $response->user;
}
/**
* Get list of users
*
* @see http://api.hipchat.com/docs/api/method/users/list
*/
public function get_users() {
$response = $this->make_request('users/list');
return $response->users;
}
/**
* Create a new user in your group.
*
* @see http://api.hipchat.com/docs/api/method/users/create
*/
public function create_user($email, $name, $mention_name = null,
$title = null, $is_group_admin = 0,
$password = null, $timezone = null) {
$args = array(
'email' => $email,
'name' => $name,
);
if ($mention_name) {
$args['mention_name'] = $mention_name;
}
if ($title) {
$args['title'] = $title;
}
if ($is_group_admin) {
$args['is_group_admin'] = (int)$is_group_admin;
}
if ($password) {
$args['password'] = $password;
}
// @see http://api.hipchat.com/docs/api/timezones
if ($timezone) {
$args['timezone'] = $timezone;
}
// Return the std object
return $this->make_request('users/create', $args, 'POST');
}
/**
* Update a user.
*
* @see http://api.hipchat.com/docs/api/method/users/update
*/
public function update_user($user_id, $email = null, $name = null,
$mention_name = null, $title = null,
$is_group_admin = 0, $password = null,
$timezone = null) {
$args = array(
'user_id' => $user_id,
);
if ($email) {
$args['email'] = $email;
}
if ($name) {
$args['name'] = $name;
}
if ($mention_name) {
$args['mention_name'] = $mention_name;
}
if ($title) {
$args['title'] = $title;
}
if ($is_group_admin) {
$args['is_group_admin'] = (int)$is_group_admin;
}
if ($password) {
$args['password'] = $password;
}
// @see http://api.hipchat.com/docs/api/timezones
if ($timezone) {
$args['timezone'] = $timezone;
}
// Return the std object
return $this->make_request('users/update', $args, 'POST');
}
/**
* Delete a user.
*
* @see http://api.hipchat.com/docs/api/method/users/delete
*/
public function delete_user($user_id) {
return $this->make_request('users/delete', array(
'user_id' => $user_id
), 'POST');
}
/**
* Undelete a user. They will be sent an email requiring them to click a link to reactivate the account.
*
* @see http://api.hipchat.com/docs/api/method/users/undelete
*/
public function undelete_user($user_id) {
return $this->make_request('users/undelete', array(
'user_id' => $user_id
), 'POST');
}
/////////////////////////////////////////////////////////////////////////////
// Helper functions
/////////////////////////////////////////////////////////////////////////////
/**
* Performs a curl request
*
* @param $url URL to hit.
* @param $post_data Data to send via POST. Leave null for GET request.
*
* @throws HipChat_Exception
* @return string
*/
public function curl_request($url, $post_data = null) {
if (is_array($post_data)) {
$post_data = array_map(array($this, 'sanitize_curl_parameter'), $post_data);
}
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 15);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, $this->verify_ssl);
if (isset($this->proxy)) {
curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, 1);
curl_setopt($ch, CURLOPT_PROXY, $this->proxy);
}
if (is_array($post_data)) {
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
}
$response = curl_exec($ch);
// make sure we got a real response
if (strlen($response) == 0) {
$errno = curl_errno($ch);
$error = curl_error($ch);
throw new HipChat_Exception(self::STATUS_BAD_RESPONSE,
"CURL error: $errno - $error", $url);
}
// make sure we got a 200
$code = (int)curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($code != self::STATUS_OK) {
throw new HipChat_Exception($code,
"HTTP status code: $code, response=$response", $url);
}
curl_close($ch);
return $response;
}
/**
* Sanitizes the given value as cURL parameter.
*
* The first value may not be a "@". PHP would treat this as a file upload
*
* @link http://www.php.net/manual/en/function.curl-setopt.php CURLOPT_POSTFIELDS
*
* @param string $value
* @return string
*/
private function sanitize_curl_parameter ($value) {
if ((strlen($value) > 0) && ($value[0] === '@')) {
return substr_replace($value, '@', 0, 1);
}
return $value;
}
/**
* Make an API request using curl
*
* @param string $api_method Which API method to hit, like 'rooms/show'.
* @param array $args Data to send.
* @param string $http_method HTTP method (GET or POST).
*
* @throws HipChat_Exception
* @return mixed
*/
public function make_request($api_method, $args = array(),
$http_method = 'GET') {
$args['format'] = 'json';
$args['auth_token'] = $this->auth_token;
$url = "$this->api_target/$this->api_version/$api_method";
$post_data = null;
// add args to url for GET
if ($http_method == 'GET') {
$url .= '?' . http_build_query($args);
} else {
$post_data = $args;
}
$response = $this->curl_request($url, $post_data);
// make sure response is valid json
$response = json_decode($response);
if (!$response) {
throw new HipChat_Exception(self::STATUS_BAD_RESPONSE,
"Invalid JSON received: $response", $url);
}
return $response;
}
/**
* Enable/disable verify_ssl.
* This is useful when curl spits back ssl verification errors, most likely
* due to outdated SSL CA bundle file on server. If you are able to, update
* that CA bundle. If not, call this method with false for $bool param before
* interacting with the API.
*
* @param bool $bool
* @return bool
* @link http://davidwalsh.name/php-ssl-curl-error
*/
public function set_verify_ssl($bool = true) {
$this->verify_ssl = (bool)$bool;
return $this->verify_ssl;
}
/**
* Set an outbound proxy to use as a curl option
* To disable proxy usage, set $proxy to null
*
* @param string $proxy
*/
public function set_proxy($proxy) {
$this->proxy = $proxy;
}
}
class HipChat_Exception extends \Exception {
public $code;
public function __construct($code, $info, $url) {
$message = "HipChat API error: code=$code, info=$info, url=$url";
parent::__construct($message, (int)$code);
}
}