forked from Snider/php-cloudDNS
-
Notifications
You must be signed in to change notification settings - Fork 1
/
rackDNS.php
649 lines (528 loc) · 17.3 KB
/
rackDNS.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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
<?php
/**
*
* Rackspace DNS PHP API ...
* @author Alon Ben David & paul
* @copyright CoolGeex.com
* @contributor Alon Ben David @ CoolGeex.com (Now supports US API)
* - Changes:
* Class name now rackDNS
* callback function to cycle through registered call backs with timeout in place
* Added support to US rackspace DNS API
* delete_domain Now called delete_domains (accept int for one domain OR array for multiple domains)
* added modify_domain function to modify domain configuration
* added domain_import function to import BIND9 format string
* created a sample.php file with code samples
*/
class rackDNS {
private $apiEndpoint;
private $authEndpoint;
private $serverUrl;
private $account_id;
private $authToken;
private $authUser;
private $authKey;
private $lastResponseStatus;
private $callbacks = array ();
/**
* Timeout in seconds for an API call to respond
* @var integer
*/
const TIMEOUT = 20;
/**
* Timeout in micro_seconds between API calls
* @var integer
*/
const SLEEPTIME = 500000; //500000 micro_seconds = 0.5 seconds
/**
*
* rackspace api version ...
* @var string
*/
const DEFAULT_DNS_API_VERSION = '1.0';
/**
*
* user agent ...
* @var string
*/
const USER_AGENT = 'Rackspace DNS PHP Binding';
/**
*
* usa auth endpoint ...
* @var string
*/
const US_AUTHURL = 'https://auth.api.rackspacecloud.com';
/**
*
* uk auth endpoint...
* @var string
*/
const UK_AUTHURL = 'https://lon.auth.api.rackspacecloud.com';
/**
*
* uk dns endpoint ...
* @var string
*/
const UK_DNS_ENDPOINT = 'https://lon.dns.api.rackspacecloud.com';
/**
*
* us dns endpoint ...
* @var string
*/
const US_DNS_ENDPOINT = 'https://dns.api.rackspacecloud.com';
/**
* Creates a new Rackspace Cloud Servers API object to make calls with
*
* Your API key needs to be generated using the Rackspace Cloud Management
* Console. You can do this under Cloud Files (not Cloud Servers).
*
* Authentication is done automatically when making the first API call
* using this object.
*
* @param string $user The username of the account to use
* @param string $key The API key to use
*/
public function __construct($user, $key, $endpoint = 'US') {
$this->authUser = $user;
$this->authKey = $key;
$this->authEndpoint = $endpoint == 'US' ? self::US_AUTHURL : self::UK_AUTHURL;
$this->apiEndpoint = $endpoint == 'US' ? self::US_DNS_ENDPOINT : self::UK_DNS_ENDPOINT;
$this->authToken = NULL;
}
/**
*
* returns a list of domains ...
* @param int $limit show x results
* @param int $offset fetch from result x
*/
public function list_domains($limit = 10, $offset = 0) {
$url = "/domains?limit=$limit&offset=$offset";
return $this->makeApiCall ( $url );
}
/**
* list subdomains
* @param string|int $domainID
* @return boolean|Ambiguous <multitype:, NULL, mixed>
*/
public function list_subdomains($domainID){
if ($domainID == false || ! is_int ( $domainID )) {
return false;
}
$url = "/domains/$domainID/subdomains";
return $this->makeApiCall ( $url );
}
/**
* List domain records
* @param unknown_type $domainID
* @return boolean|Ambigous <multitype:, NULL, mixed>
*/
public function list_records($domainID){
if ($domainID == false || ! is_int ( $domainID )) {
return false;
}
$url = "/domains/$domainID/records";
return $this->makeApiCall ( $url );
}
/**
* List domain specific record
* @param unknown_type $domainID
* @param unknown_type $recordID
* @return boolean|Ambigous <multitype:, NULL, mixed>
*/
public function list_record_details($domainID,$recordID){
if ($domainID == false || ! is_int ( $domainID ) || $recordID == false ) {
return false;
}
$url = "/domains/$domainID/records/$recordID";
return $this->makeApiCall ( $url );
}
/**
* delete a DNS record from domain by record ID
* @param unknown_type $domainID
* @param unknown_type $recordID
* @return boolean|Ambigous <multitype:, NULL, mixed>
*/
public function delete_domain_record($domainID,$recordID){
if ($domainID == false || ! is_int ( $domainID ) || $recordID == false ) {
return false;
}
$url = "/domains/$domainID/records/$recordID";
$call = $this->makeApiCall ( $url,null,'DELETE' );
$timeout = time() + self::TIMEOUT;
while(isset($call ['callbackUrl']) && $timeout > time()) {
$this->callbacks [] = $call;
usleep( self::SLEEPTIME );
$url = explode ( 'status', $call ['callbackUrl'] );
$call = $this->makeApiCall ( '/status' . array_pop ( $url ) );
}
return $call;
}
/**
* Delete domain DNS records entirely
* @param integer $domainID or an Array on domains ID's
* @param unknown_type $deleteSubdomains
* @return boolean|Ambigous <multitype:, NULL, mixed>
*/
public function delete_domains($domainID, $deleteSubdomains = true) {
if ($domainID == false || (! is_int ( $domainID ) && ! is_array($domainID))) {
return false;
}
$deleteSubdomains = ($deleteSubdomains == false) ? 'false' : 'true';
$url = "/domains";
if(! is_array($domainID)){
$url.= "/$domainID?deleteSubdomains=$deleteSubdomains";
}else{
$url.= "?";
foreach($domainID as $id){
$url.= "id=$id&";
}
$url.="deleteSubdomains=$deleteSubdomains";
}
$call = $this->makeApiCall ( $url,null,'DELETE' );
$timeout = time() + self::TIMEOUT;
while(isset($call ['callbackUrl']) && $timeout > time()) {
$this->callbacks [] = $call;
usleep( self::SLEEPTIME );
$url = explode ( 'status', $call ['callbackUrl'] );
$call = $this->makeApiCall ( '/status' . array_pop ( $url ) );
}
return $call;
}
/**
*
* search domains for domains matching
*
* allows for searching of the available domains
* using list_domain_search("klwebconsultants") would return all TLD's
* @param string $domain
*/
public function list_domain_search($domain = false) {
if ($domain == false) {
return false;
}
$url = '/domains?name=' . rawurlencode ( $domain );
return $this->makeApiCall ( $url );
}
/**
*
* list domain data by domainID ...
* List details for a specific domain, using the showRecords and showSubdomains parameters that specify whether to request information for records and subdomains.
* @param int $domainID
* @param bool $showRecords
* @param bool $showSubdomains
*/
public function list_domain_details($domainID = false, $showRecords = false, $showSubdomains = false) {
if ($domainID == false || ! is_int ( $domainID )) {
return false;
}
$showRecords = ($showRecords == false) ? 'false' : 'true';
$showRecords = ($showSubdomains == false) ? 'false' : 'true';
$url = "/domains/$domainID?showRecords=$showRecords&showSubdomains=$showSubdomains";
return $this->makeApiCall ( $url );
}
/**
* exports a domain as a BIND9 format ...
* @param int $domainID
* @return boolean|array
*/
public function domain_export($domainID = false) {
if ($domainID == false || ! is_int ( $domainID )) {
return false;
}
$url = "/domains/$domainID/export";
$call = $this->makeApiCall ( $url );
$timeout = time() + self::TIMEOUT;
while(isset($call ['callbackUrl']) && $timeout > time()) {
$this->callbacks [] = $call;
usleep( self::SLEEPTIME );
$url = explode ( 'status', $call ['callbackUrl'] );
$call = $this->makeApiCall ( '/status' . array_pop ( $url ) );
}
return $call;
}
/**
* modify domain configuration
* @param int $domainID
* @param string $email
* @param int $ttl
* @param string $comment
* @return boolean|array
*/
public function modify_domain($domainID = false , $email = false , $ttl = 86400 , $comment = 'Modify Domain Using rackDNS API') {
if ($domainID == false || ! is_int ( $domainID ) || ! is_int ( $ttl ) || $ttl < 300) {
return false;
}
$postData = array (
'ttl' => (string)$ttl,
'comment' => (string)$comment,
'emailAddress' => (string)$email);
$url = "/domains/$domainID/";
$call = $this->makeApiCall ( $url,$postData,'PUT' );
$timeout = time() + self::TIMEOUT;
while(isset($call ['callbackUrl']) && $timeout > time()) {
$this->callbacks [] = $call;
usleep( self::SLEEPTIME );
$url = explode ( 'status', $call ['callbackUrl'] );
$call = $this->makeApiCall ( '/status' . array_pop ( $url ) );
}
return $call;
}
/**
*
* import domain ...
* @param string $records string with BIND9 format
* @param string $comment (option comments field)
*/
public function domain_import($records , $comment = 'Import Domain Using rackDNS API') {
if (!$records) {
return false;
}
$records = str_replace("\r","",$records); //Make sure linux new line in place
$postData = array('domains' => array(array(
'comment' => $comment,
'contents' => (string)$records )));
$url = "/domains/import/";
$call = $this->makeApiCall ( $url,$postData,'POST' );
/* DEBUG */
//print_r($call);
$timeout = time() + self::TIMEOUT;
while(isset($call ['callbackUrl']) && $timeout > time()) {
$this->callbacks [] = $call;
usleep( self::SLEEPTIME );
$url = explode ( 'status', $call ['callbackUrl'] );
$call = $this->makeApiCall ( '/status' . array_pop ( $url ) );
}
return $call;
}
/**
* creates a new zone ...
* @param unknown_type $name
* @param unknown_type $email
* @param unknown_type $records
* @return boolean|Ambigous <multitype:, NULL, mixed>
*/
public function create_domain($name = false, $email = false, $records = false) {
if (! $email || ! $name || ! is_array ( $records )) {
return false;
}
$postData = array('domains' => array(array (
'name' => $name,
'emailAddress' => $email,
'recordsList' => array('records' => $records) )));
$url = '/domains';
$call = $this->makeApiCall ( $url,$postData,'POST' );
//@todo make callback function to cycle through registered call backs
$timeout = time() + self::TIMEOUT;
while(isset($call ['callbackUrl']) && $timeout > time()) {
$this->callbacks [] = $call;
usleep( self::SLEEPTIME );
$url = explode ( 'status', $call ['callbackUrl'] );
$call = $this->makeApiCall ( '/status' . array_pop ( $url ) );
}
return $call;
}
/**
* creates a new record on a existing zone ...
* @param unknown_type $domainID
* @param unknown_type $records
* @return boolean|Ambigous <multitype:, NULL, mixed>
*/
public function create_domain_record($domainID = false, $records = false) {
if (! $domainID|| ! is_array ( $records )) {
return false;
}
$postData = array('records' => $records) ;
$url = "/domains/$domainID/records";
$call = $this->makeApiCall ( $url,$postData,'POST' );
//@todo make callback function to cycle through registered call backs
$timeout = time() + self::TIMEOUT;
while(isset($call ['callbackUrl']) && $timeout > time()) {
$this->callbacks [] = $call;
usleep( self::SLEEPTIME );
$url = explode ( 'status', $call ['callbackUrl'] );
$call = $this->makeApiCall ( '/status' . array_pop ( $url ) );
}
return $call;
}
/**
* makes a array encapsulating a dns record for use with the api ...
* @param string $type
* @param string $name
* @param string $data
* @param string|int $ttl
* @param string|int $priority
* @return boolean|array
*/
public function create_domain_record_helper($type = false, $name = false, $data = false, $ttl = 86400, $priority = false) {
if (! $type || ! $name || ! $data || ! is_int ( $ttl )) {
return false;
}
$record = array (
'ttl' => (string)$ttl,
'data' => (string)$data,
'name' => (string)$name,
'type' => (string)strtoupper ( $type ) );
if ($priority !== false) {
$record ['priority'] = (string)$priority;
}
return $record;
}
/**
* Makes a call to an API
*
* @param string $url The relative URL to call (example: "/server")
* @param string $postData (Optional) The JSON string to send
* @param string $method (Optional) The HTTP method to use
* @return array The parsed response, or NULL if there was an error
*/
private function makeApiCall($url, $postData = NULL, $method = NULL) {
// Authenticate if necessary
if (! $this->isAuthenticated ()) {
if (! $this->authenticate ()) {
return NULL;
}
}
$this->lastResponseStatus = NULL;
$urlParts = explode ( '?', $url );
$url = $urlParts [0] . ".json";
if (isset ( $urlParts [1] )) {
$url .= '?' . $urlParts [1];
}
$jsonUrl = $this->apiEndpoint . '/' . rawurlencode ( "v" . self::DEFAULT_DNS_API_VERSION ) . '/' . $this->account_id . $url;
$httpHeaders = array (
"X-Auth-Token: {$this->authToken}" );
$ch = curl_init ();
curl_setopt ( $ch, CURLOPT_URL, $jsonUrl );
if ($postData) {
curl_setopt ( $ch, CURLOPT_POSTFIELDS, json_encode($postData) );
$httpHeaders [] = "Content-Type: application/json";
}
if ($method) {
curl_setopt ( $ch, CURLOPT_CUSTOMREQUEST, strtoupper ( $method ) );
}
curl_setopt ( $ch, CURLOPT_HTTPHEADER, $httpHeaders );
curl_setopt ( $ch, CURLOPT_HEADER, 0 );
curl_setopt ( $ch, CURLOPT_USERAGENT, self::USER_AGENT );
curl_setopt ( $ch, CURLOPT_HEADERFUNCTION, array (
&$this,
'parseHeader' ) );
curl_setopt ( $ch, CURLOPT_ENCODING, 'gzip,deflate' );
curl_setopt ( $ch, CURLOPT_TIMEOUT, self::TIMEOUT );
curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, TRUE );
$jsonResponse = curl_exec ( $ch );
curl_close ( $ch );
return json_decode ( $jsonResponse, TRUE );
}
/**
* Curl call back method to parse header values one by one (there will be
* many)
*
* @param resource $ch The Curl handler
* @param string $header The HTTP header line to parse
* @return integer The number of bytes in the header line
*/
private function parseHeader($ch, $header) {
preg_match ( "/^HTTP\/1\.[01] (\d{3}) (.*)/", $header, $matches );
if (isset ( $matches [1] )) {
$this->lastResponseStatus = $matches [1];
}
return strlen ( $header );
}
/**
* Determines if authentication has been complete
*
* @return boolean TRUE if authentication is complete, FALSE if it needs to
* be done
*/
private function isAuthenticated() {
return ($this->serverUrl && $this->authToken);
}
/**
* Authenticates with the API
*
* @return boolean TRUE if the authentication was successful
*/
private function authenticate() {
$authHeaders = array (
"X-Auth-User: {$this->authUser}",
"X-Auth-Key: {$this->authKey}" );
$ch = curl_init ();
$url = $this->authEndpoint . '/' . rawurlencode ( "v" . self::DEFAULT_DNS_API_VERSION );
curl_setopt ( $ch, CURLOPT_SSL_VERIFYPEER, True );
// curl_setopt($ch, CURLOPT_CAINFO,dirname(dirname(__FILE__)) . "/share/cacert.pem");
curl_setopt ( $ch, CURLOPT_FOLLOWLOCATION, 1 );
curl_setopt ( $ch, CURLOPT_MAXREDIRS, 4 );
curl_setopt ( $ch, CURLOPT_HTTPHEADER, $authHeaders );
curl_setopt ( $ch, CURLOPT_HEADER, true );
curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, TRUE );
curl_setopt ( $ch, CURLOPT_CONNECTTIMEOUT, 10 );
curl_setopt ( $ch, CURLOPT_URL, $url );
$response = curl_exec ( $ch );
curl_close ( $ch );
preg_match ( "/^HTTP\/1\.[01] (\d{3}) (.*)/", $response, $matches );
if (isset ( $matches [1] )) {
$this->lastResponseStatus = $matches [1];
if ($this->lastResponseStatus == "204") {
preg_match ( "/X-Server-Management-Url: (.*)/", $response, $matches );
$this->serverUrl = trim ( $matches [1] );
$account = explode ( '/', $this->serverUrl );
$this->account_id = array_pop ( $account );
// TODO Replace this with parsing the correct one once the Load Balancer API goes public
//$this->apiEndpoint = self::UK_DNS_ENDPOINT; // "https://ord.loadbalancers.api.rackspacecloud.com/v1.0/425464";
preg_match ( "/X-Auth-Token: (.*)/", $response, $matches );
$this->authToken = trim ( $matches [1] );
return TRUE;
}
}
return FALSE;
}
/**
* Translates the HTTP response status from the last API call to a human
* friendly message
*
* @return string The response message from the last call
*/
public function getLastResponseMessage() {
$map = array (
"200" => "Successful informational response",
"202" => "Successful action response",
"203" => "Successful informational response from the cache",
"204" => "Authentication successful",
"400" => "Bad request (check the validity of input values)",
"401" => "Unauthorized (check username and API key)",
"403" => "Resize not allowed",
"404" => "Item not found",
"409" => "Item already exists",
"413" => "Over API limit (check limits())",
"415" => "Bad media type",
"500" => "Cloud server issue",
"503" => "API service in unavailable, or capacity is not available" );
$status = $this->getLastResponseStatus ();
if ($status) {
return $map [$status];
}
return "UNKNOWN - Probably a timeout on the connection";
}
/**
* Gets the HTTP response status from the last API call
*
* - 200 - successful informational response
* - 202 - successful action response
* - 203 - successful informational response from the cache
* - 400 - bad request (possibly because the input values were invalid)
* - 401 - unauthorized (check username and API key)
* - 403 - resize not allowed
* - 404 - item not found
* - 409 - build, backup or resize in process
* - 413 - over API limit (check limits())
* - 415 - bad media type
* - 500 - cloud server issue
* - 503 - API service in unavailable, or capacity is not available
*
* @return integer The 3 digit HTTP response status, or NULL if the call had
* issues
*/
public function getLastResponseStatus() {
return $this->lastResponseStatus;
}
}