1: <?php
  2: 
  3: require_once('ApiSettings.php');
  4: require_once('WebhostingPackage.php');
  5: require_once('WebHost.php');
  6: require_once('Cronjob.php');
  7: require_once('MailBox.php');
  8: require_once('Db.php');
  9: require_once('MailForward.php');
 10: require_once('SubDomain.php');
 11: 
 12: /**
 13:  * This is the API endpoint for the WebhostingService
 14:  *
 15:  * @package Transip
 16:  * @class WebhostingService
 17:  * @author TransIP (support@transip.nl)
 18:  */
 19: class Transip_WebhostingService
 20: {
 21:     // These fields are SOAP related
 22:     /** The SOAP service that corresponds with this class. */
 23:     const SERVICE = 'WebhostingService';
 24:     /** The API version. */
 25:     const API_VERSION = '5.23';
 26:     /** @var SoapClient  The SoapClient used to perform the SOAP calls. */
 27:     protected static $_soapClient = null;
 28: 
 29:     /**
 30:      * Gets the singleton SoapClient which is used to connect to the TransIP Api.
 31:      *
 32:      * @param  mixed       $parameters  Parameters.
 33:      * @return SoapClient               The SoapClient object to which we can connect to the TransIP API
 34:      */
 35:     public static function _getSoapClient($parameters = array())
 36:     {
 37:         $endpoint = Transip_ApiSettings::$endpoint;
 38: 
 39:         if(self::$_soapClient === null)
 40:         {
 41:             $extensions = get_loaded_extensions();
 42:             $errors     = array();
 43:             if(!class_exists('SoapClient') || !in_array('soap', $extensions))
 44:             {
 45:                 $errors[] = 'The PHP SOAP extension doesn\'t seem to be installed. You need to install the PHP SOAP extension. (See: http://www.php.net/manual/en/book.soap.php)';
 46:             }
 47:             if(!in_array('openssl', $extensions))
 48:             {
 49:                 $errors[] = 'The PHP OpenSSL extension doesn\'t seem to be installed. You need to install PHP with the OpenSSL extension. (See: http://www.php.net/manual/en/book.openssl.php)';
 50:             }
 51:             if(!empty($errors)) die('<p>' . implode("</p>\n<p>", $errors) . '</p>');
 52: 
 53:             $classMap = array(
 54:                 'WebhostingPackage' => 'Transip_WebhostingPackage',
 55:                 'WebHost' => 'Transip_WebHost',
 56:                 'Cronjob' => 'Transip_Cronjob',
 57:                 'MailBox' => 'Transip_MailBox',
 58:                 'Db' => 'Transip_Db',
 59:                 'MailForward' => 'Transip_MailForward',
 60:                 'SubDomain' => 'Transip_SubDomain',
 61:             );
 62: 
 63:             $options = array(
 64:                 'classmap' => $classMap,
 65:                 'encoding' => 'utf-8', // lets support unicode
 66:                 'features' => SOAP_SINGLE_ELEMENT_ARRAYS, // see http://bugs.php.net/bug.php?id=43338
 67:                 'trace'    => false, // can be used for debugging
 68:             );
 69: 
 70:             $wsdlUri  = "https://{$endpoint}/wsdl/?service=" . self::SERVICE;
 71:             try
 72:             {
 73:                 self::$_soapClient = new SoapClient($wsdlUri, $options);
 74:             }
 75:             catch(SoapFault $sf)
 76:             {
 77:                 throw new Exception("Unable to connect to endpoint '{$endpoint}'");
 78:             }
 79:             self::$_soapClient->__setCookie('login', Transip_ApiSettings::$login);
 80:             self::$_soapClient->__setCookie('mode', Transip_ApiSettings::$mode);
 81:         }
 82: 
 83:         $timestamp = time();
 84:         $nonce     = uniqid('', true);
 85: 
 86:         self::$_soapClient->__setCookie('timestamp', $timestamp);
 87:         self::$_soapClient->__setCookie('nonce', $nonce);
 88:         self::$_soapClient->__setCookie('clientVersion', self::API_VERSION);
 89:         self::$_soapClient->__setCookie('signature', self::_urlencode(self::_sign(array_merge($parameters, array(
 90:             '__service'   => self::SERVICE,
 91:             '__hostname'  => $endpoint,
 92:             '__timestamp' => $timestamp,
 93:             '__nonce'     => $nonce
 94:         )))));
 95: 
 96:         return self::$_soapClient;
 97:     }
 98: 
 99:     /**
100:      * Calculates the hash to sign our request with based on the given parameters.
101:      *
102:      * @param  mixed   $parameters  The parameters to sign.
103:      * @return string               Base64 encoded signing hash.
104:      */
105:     protected static function _sign($parameters)
106:     {
107:         // Fixup our private key, copy-pasting the key might lead to whitespace faults
108:         if(!preg_match('/-----BEGIN (RSA )?PRIVATE KEY-----(.*)-----END (RSA )?PRIVATE KEY-----/si', Transip_ApiSettings::$privateKey, $matches))
109:             die('<p>Could not find your private key, please supply your private key in the ApiSettings file. You can request a new private key in your TransIP Controlpanel.</p>');
110: 
111:         $key = $matches[2];
112:         $key = preg_replace('/\s*/s', '', $key);
113:         $key = chunk_split($key, 64, "\n");
114: 
115:         $key = "-----BEGIN PRIVATE KEY-----\n" . $key . "-----END PRIVATE KEY-----";
116: 
117:         $digest = self::_sha512Asn1(self::_encodeParameters($parameters));
118:         if(!@openssl_private_encrypt($digest, $signature, $key))
119:             die('<p>Could not sign your request, please supply your private key in the ApiSettings file. You can request a new private key in your TransIP Controlpanel.</p>');
120: 
121:         return base64_encode($signature);
122:     }
123: 
124:     /**
125:      * Creates a digest of the given data, with an asn1 header.
126:      *
127:      * @param  string  $data  The data to create a digest of.
128:      * @return string         The digest of the data, with asn1 header.
129:      */
130:     protected static function _sha512Asn1($data)
131:     {
132:         $digest = hash('sha512', $data, true);
133: 
134:         // this ASN1 header is sha512 specific
135:         $asn1  = chr(0x30).chr(0x51);
136:         $asn1 .= chr(0x30).chr(0x0d);
137:         $asn1 .= chr(0x06).chr(0x09);
138:         $asn1 .= chr(0x60).chr(0x86).chr(0x48).chr(0x01).chr(0x65);
139:         $asn1 .= chr(0x03).chr(0x04);
140:         $asn1 .= chr(0x02).chr(0x03);
141:         $asn1 .= chr(0x05).chr(0x00);
142:         $asn1 .= chr(0x04).chr(0x40);
143:         $asn1 .= $digest;
144: 
145:         return $asn1;
146:     }
147: 
148:     /**
149:      * Encodes the given paramaters into a url encoded string based upon RFC 3986.
150:      *
151:      * @param  mixed   $parameters  The parameters to encode.
152:      * @param  string  $keyPrefix   Key prefix.
153:      * @return string               The given parameters encoded according to RFC 3986.
154:      */
155:     protected static function _encodeParameters($parameters, $keyPrefix = null)
156:     {
157:         if(!is_array($parameters) && !is_object($parameters))
158:             return self::_urlencode($parameters);
159: 
160:         $encodedData = array();
161: 
162:         foreach($parameters as $key => $value)
163:         {
164:             $encodedKey = is_null($keyPrefix)
165:                 ? self::_urlencode($key)
166:                 : $keyPrefix . '[' . self::_urlencode($key) . ']';
167: 
168:             if(is_array($value) || is_object($value))
169:             {
170:                 $encodedData[] = self::_encodeParameters($value, $encodedKey);
171:             }
172:             else
173:             {
174:                 $encodedData[] = $encodedKey . '=' . self::_urlencode($value);
175:             }
176:         }
177: 
178:         return implode('&', $encodedData);
179:     }
180: 
181:     /**
182:      * Our own function to encode a string according to RFC 3986 since.
183:      * PHP < 5.3.0 encodes the ~ character which is not allowed.
184:      *
185:      * @param string $string The string to encode.
186:      * @return string The encoded string according to RFC 3986.
187:      */
188:     protected static function _urlencode($string)
189:     {
190:         $string = trim($string);
191:         $string = rawurlencode($string);
192:         return str_replace('%7E', '~', $string);
193:     }
194: 
195:     const CANCELLATIONTIME_END = 'end';
196:     const CANCELLATIONTIME_IMMEDIATELY = 'immediately';
197:     const TRACK_ENDPOINT_NAME = 'Webhosting';
198: 
199:     /**
200:      * Get all domain names that have a webhosting package attached to them.
201:      *
202:      * @return string[] List of domain names that have a webhosting package
203:      */
204:     public static function getWebhostingDomainNames()
205:     {
206:         return self::_getSoapClient(array_merge(array(), array('__method' => 'getWebhostingDomainNames')))->getWebhostingDomainNames();
207:     }
208: 
209:     /**
210:      * Get available webhosting packages
211:      *
212:      * @return Transip_WebhostingPackage[] List of available webhosting packages
213:      */
214:     public static function getAvailablePackages()
215:     {
216:         return self::_getSoapClient(array_merge(array(), array('__method' => 'getAvailablePackages')))->getAvailablePackages();
217:     }
218: 
219:     /**
220:      * Get information about existing webhosting on a domain.
221:      * 
222:      * Please be aware that the information returned is outdated when
223:      * a modifying function in Transip_WebhostingService is called (e.g. createCronjob()).
224:      * 
225:      * Call this function again to refresh the info.
226:      *
227:      * @param string $domainName The domain name of the webhosting package to get the info for. Must be owned by this user
228:      * @return Transip_WebHost WebHost object with all info about the requested webhosting package
229:      */
230:     public static function getInfo($domainName)
231:     {
232:         return self::_getSoapClient(array_merge(array($domainName), array('__method' => 'getInfo')))->getInfo($domainName);
233:     }
234: 
235:     /**
236:      * Order webhosting for a domain name
237:      *
238:      * @param string $domainName The domain name to order the webhosting for. Must be owned by this user
239:      * @param Transip_WebhostingPackage $webhostingPackage The webhosting Package to order, one of the packages returned by Transip_WebhostingService::getAvailablePackages()
240:      * @throws ApiException on error
241:      */
242:     public static function order($domainName, $webhostingPackage)
243:     {
244:         return self::_getSoapClient(array_merge(array($domainName, $webhostingPackage), array('__method' => 'order')))->order($domainName, $webhostingPackage);
245:     }
246: 
247:     /**
248:      * Get available upgrades packages for a domain name with webhosting. Only those packages will be returned to which
249:      * the given domain name can be upgraded to.
250:      *
251:      * @param string $domainName Domain to get upgrades for. Must be owned by the current user.
252:      * @return Transip_WebhostingPackage[] Available packages to which the domain name can be upgraded to.
253:      * @throws ApiException Throwns an Exception ig the domain is not found in the requester account
254:      */
255:     public static function getAvailableUpgrades($domainName)
256:     {
257:         return self::_getSoapClient(array_merge(array($domainName), array('__method' => 'getAvailableUpgrades')))->getAvailableUpgrades($domainName);
258:     }
259: 
260:     /**
261:      * Upgrade the webhosting of a domain name to a new webhosting package to a given new package.
262:      *
263:      * @param string $domainName The domain to upgrade webhosting for. Must be owned by the current user.
264:      * @param string $newWebhostingPackage The new webhosting package, must be one of the packages returned getAvailableUpgrades() for the given domain name
265:      * @throws ApiException Throws an exception when the domain name does not belong to the requester (or is not found) or the package can't be upgraded
266:      */
267:     public static function upgrade($domainName, $newWebhostingPackage)
268:     {
269:         return self::_getSoapClient(array_merge(array($domainName, $newWebhostingPackage), array('__method' => 'upgrade')))->upgrade($domainName, $newWebhostingPackage);
270:     }
271: 
272:     /**
273:      * Cancel webhosting for a domain
274:      *
275:      * @param string $domainName The domain to cancel the webhosting for
276:      * @param string $endTime the time to cancel the domain (WebhostingService::CANCELLATIONTIME_END (end of contract) or WebhostingService::CANCELLATIONTIME_IMMEDIATELY (as soon as possible))
277:      * @throws ApiException Throws an exception when the domain name does not belong to the requester (or is not found).
278:      */
279:     public static function cancel($domainName, $endTime)
280:     {
281:         return self::_getSoapClient(array_merge(array($domainName, $endTime), array('__method' => 'cancel')))->cancel($domainName, $endTime);
282:     }
283: 
284:     /**
285:      * Set a new FTP password for a webhosting package
286:      *
287:      * @param string $domainName Domain to set webhosting FTP password for
288:      * @param string $newPassword The new FTP password for the webhosting package
289:      * @throws ApiException When the new password is empty
290:      */
291:     public static function setFtpPassword($domainName, $newPassword)
292:     {
293:         return self::_getSoapClient(array_merge(array($domainName, $newPassword), array('__method' => 'setFtpPassword')))->setFtpPassword($domainName, $newPassword);
294:     }
295: 
296:     /**
297:      * Create a cronjob
298:      *
299:      * @param string $domainName the domain name of the webhosting package to create cronjob for
300:      * @param Transip_Cronjob $cronjob the cronjob to create. All fields must be valid.
301:      * @throws ApiException When the new URL is either invalid or the URL is not a URL linking to the domain the CronJob is for.
302:      */
303:     public static function createCronjob($domainName, $cronjob)
304:     {
305:         return self::_getSoapClient(array_merge(array($domainName, $cronjob), array('__method' => 'createCronjob')))->createCronjob($domainName, $cronjob);
306:     }
307: 
308:     /**
309:      * Delete a cronjob from a webhosting package.
310:      * Note, all completely matching cronjobs will be removed
311:      *
312:      * @param string $domainName the domain name of the webhosting package to delete a cronjob
313:      * @param Transip_Cronjob $cronjob Cronjob the cronjob to delete. Be aware that all matching cronjobs will be removed.
314:      * @throws ApiException When the CronJob that needs to be deleted is not found.
315:      */
316:     public static function deleteCronjob($domainName, $cronjob)
317:     {
318:         return self::_getSoapClient(array_merge(array($domainName, $cronjob), array('__method' => 'deleteCronjob')))->deleteCronjob($domainName, $cronjob);
319:     }
320: 
321:     /**
322:      * Creates a MailBox for a webhosting package.
323:      * The address field of the MailBox object must be unique.
324:      *
325:      * @param string $domainName the domain name of the webhosting package to create the mailbox for
326:      * @param Transip_MailBox $mailBox MailBox object to create
327:      */
328:     public static function createMailBox($domainName, $mailBox)
329:     {
330:         return self::_getSoapClient(array_merge(array($domainName, $mailBox), array('__method' => 'createMailBox')))->createMailBox($domainName, $mailBox);
331:     }
332: 
333:     /**
334:      * Modifies MailBox settings
335:      *
336:      * @param string $domainName the domain name of the webhosting package to modify the mailbox for
337:      * @param Transip_MailBox $mailBox the MailBox to modify
338:      * @throws ApiException When the MailBox that needs to be modified is not found.
339:      */
340:     public static function modifyMailBox($domainName, $mailBox)
341:     {
342:         return self::_getSoapClient(array_merge(array($domainName, $mailBox), array('__method' => 'modifyMailBox')))->modifyMailBox($domainName, $mailBox);
343:     }
344: 
345:     /**
346:      * Sets a new password for a MailBox
347:      *
348:      * @param string $domainName the domain name of the webhosting package to set the mailbox password for
349:      * @param Transip_MailBox $mailBox the MailBox to set the password for
350:      * @param string $newPassword the new password for the MailBox, cannot be empty.
351:      * @throws ApiException When the MailBox that needs to be modified is not found.
352:      */
353:     public static function setMailBoxPassword($domainName, $mailBox, $newPassword)
354:     {
355:         return self::_getSoapClient(array_merge(array($domainName, $mailBox, $newPassword), array('__method' => 'setMailBoxPassword')))->setMailBoxPassword($domainName, $mailBox, $newPassword);
356:     }
357: 
358:     /**
359:      * Deletes a MailBox from a webhosting package
360:      *
361:      * @param string $domainName the domain name of the webhosting package to remove the MailBox from
362:      * @param Transip_MailBox $mailBox the mailbox object to remove
363:      * @throws ApiException When the MailBox that needs to be deleted is not found.
364:      */
365:     public static function deleteMailBox($domainName, $mailBox)
366:     {
367:         return self::_getSoapClient(array_merge(array($domainName, $mailBox), array('__method' => 'deleteMailBox')))->deleteMailBox($domainName, $mailBox);
368:     }
369: 
370:     /**
371:      * Creates a MailForward for a webhosting package
372:      *
373:      * @param string $domainName the domain name of the webhosting package to add the MailForward to
374:      * @param Transip_MailForward $mailForward The MailForward object to create
375:      */
376:     public static function createMailForward($domainName, $mailForward)
377:     {
378:         return self::_getSoapClient(array_merge(array($domainName, $mailForward), array('__method' => 'createMailForward')))->createMailForward($domainName, $mailForward);
379:     }
380: 
381:     /**
382:      * Changes an active MailForward object
383:      *
384:      * @param string $domainName the domain name of the webhosting package to modify the MailForward from
385:      * @param Transip_MailForward $mailForward the MailForward to modify
386:      * @throws ApiException When the MailForward that needs to be modified is not found.
387:      */
388:     public static function modifyMailForward($domainName, $mailForward)
389:     {
390:         return self::_getSoapClient(array_merge(array($domainName, $mailForward), array('__method' => 'modifyMailForward')))->modifyMailForward($domainName, $mailForward);
391:     }
392: 
393:     /**
394:      * Deletes an active MailForward object
395:      *
396:      * @param string $domainName the domain name of the webhosting package to delete the MailForward from
397:      * @param Transip_MailForward $mailForward the MailForward to delete
398:      */
399:     public static function deleteMailForward($domainName, $mailForward)
400:     {
401:         return self::_getSoapClient(array_merge(array($domainName, $mailForward), array('__method' => 'deleteMailForward')))->deleteMailForward($domainName, $mailForward);
402:     }
403: 
404:     /**
405:      * Creates a new database
406:      *
407:      * @param string $domainName the domain name of the webhosting package to create the Db for
408:      * @param Transip_Db $db Db object to create
409:      */
410:     public static function createDatabase($domainName, $db)
411:     {
412:         return self::_getSoapClient(array_merge(array($domainName, $db), array('__method' => 'createDatabase')))->createDatabase($domainName, $db);
413:     }
414: 
415:     /**
416:      * Changes a Db object
417:      *
418:      * @param string $domainName the domain name of the webhosting package to change the Db for
419:      * @param Transip_Db $db The db object to modify
420:      */
421:     public static function modifyDatabase($domainName, $db)
422:     {
423:         return self::_getSoapClient(array_merge(array($domainName, $db), array('__method' => 'modifyDatabase')))->modifyDatabase($domainName, $db);
424:     }
425: 
426:     /**
427:      * Sets A database password for a Db
428:      *
429:      * @param string $domainName the domain name of the webhosting package of the Db to change the password for
430:      * @param Transip_Db $db Modified database object to save
431:      * @param string $newPassword New password for the database
432:      */
433:     public static function setDatabasePassword($domainName, $db, $newPassword)
434:     {
435:         return self::_getSoapClient(array_merge(array($domainName, $db, $newPassword), array('__method' => 'setDatabasePassword')))->setDatabasePassword($domainName, $db, $newPassword);
436:     }
437: 
438:     /**
439:      * Deletes a Db object
440:      *
441:      * @param string $domainName the domain name of the webhosting package to delete the Db for
442:      * @param Transip_Db $db Db object to remove
443:      * @throws ApiException When the Database that needs to be deleted is not found.
444:      */
445:     public static function deleteDatabase($domainName, $db)
446:     {
447:         return self::_getSoapClient(array_merge(array($domainName, $db), array('__method' => 'deleteDatabase')))->deleteDatabase($domainName, $db);
448:     }
449: 
450:     /**
451:      * Creates a SubDomain
452:      *
453:      * @param string $domainName the domain name of the webhosting package to create the SubDomain for
454:      * @param Transip_SubDomain $subDomain SubDomain object to create
455:      */
456:     public static function createSubdomain($domainName, $subDomain)
457:     {
458:         return self::_getSoapClient(array_merge(array($domainName, $subDomain), array('__method' => 'createSubdomain')))->createSubdomain($domainName, $subDomain);
459:     }
460: 
461:     /**
462:      * Deletes a SubDomain
463:      *
464:      * @param string $domainName the domain name of the webhosting package to delete the SubDomain for
465:      * @param Transip_SubDomain $subDomain SubDomain object to delete
466:      * @throws ApiException When the Subdomain that needs to be deleted is not found.
467:      */
468:     public static function deleteSubdomain($domainName, $subDomain)
469:     {
470:         return self::_getSoapClient(array_merge(array($domainName, $subDomain), array('__method' => 'deleteSubdomain')))->deleteSubdomain($domainName, $subDomain);
471:     }
472: }
473: 
474: ?>
475: