Detain\Cloudlinux\Cloudlinux

Complexity

Total Complexity

38

Size/Duplication

Total Lines	302
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

0%

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	remove()	0	6	2
B	__construct()	0	15	5
A	authToken()	0	4	1
A	getcurlpage()	0	13	4
A	log()	0	4	2
A	status()	0	4	1
A	availability()	0	4	1
A	isLicensed()	0	6	2
A	check()	0	8	2
A	xmlIsLicensed()	0	10	2
A	restRemove()	0	7	2
A	removeLicense()	0	10	2
A	licenseList()	0	6	2
A	restList()	0	4	1
A	reconcile()	0	4	1
A	license()	0	3	2
A	register()	0	5	2
A	xmlLicense()	0	18	4

<?php
/**
 * Cloudlinux Functionality
 *
 * API Documentation at: .. ill fill this in later from forum posts
 *
 * @author Joe Huss <detain@interserver.net>
 * @copyright 2017
 * @package MyAdmin
 * @category Licenses
 */

namespace Detain\Cloudlinux;

/**
 * Cloudlinux Licensing Class
 *
 * XMLRPC Exception codes:
 * 	1 ­ Internal (unknown) Error
 * 	10 ­ Not authorized
 * 	30 ­ Invalid call arguments
 * 	40 ­ Invalid IP format
 *
 * @link https://cln.cloudlinux.com/clweb/downloads/cloudlinux-xmlrpc-api.pdf XML API Documentation
 * @link https://cln.cloudlinux.com/clweb/downloads/cloudlinux-rest-api.pdf REST API Documentation
 *
 * @access public
 */
class Cloudlinux {
	private $login = '';
	private $key = '';
	public $prefix = 'registration.';
	public $encoding = 'utf-8'; // utf-8 / UTF-8
	public $apiType = 'rest';
	public $sslverify = FALSE;
	public $xmlOptions = [];
	public $xmlUrl = 'https://cln.cloudlinux.com/clweb/xmlrpc';
	public $restUrl = 'https://cln.cloudlinux.com/api/';
	public $restOptions = [];

	/**
	 * @var \XML_RPC2_Client
	 */
	public $xmlClient;
	public $response;

	/**
	 * Cloudlinux::__construct()
	 *
	 * @param string $login API Login Name
	 * @param string $key API Key
	 * @param string $apiType API type to use, can be 'rest' or 'xml'
	 */
	public function __construct($login, $key, $apiType = 'rest') {
		$this->login = $login;
		$this->key = $key;
		$this->apiType = $apiType;
		$limitType = FALSE;
		if ($limitType === FALSE || $this->apiType == 'xml') {
			include_once 'XML/RPC2/Client.php';
			$this->xmlOptions['prefix'] = $this->prefix;
			$this->xmlOptions['encoding'] = $this->encoding;
			$this->xmlOptions['sslverify'] = $this->sslverify;
			$this->xmlClient = \XML_RPC2_Client::create($this->xmlUrl, $this->xmlOptions);
		}
		if ($limitType === FALSE || $this->apiType == 'rest')
			$this->restOptions[CURLOPT_SSL_VERIFYHOST] = $this->sslverify;
	}

	/**
	 * automatic authToken generator
	 *
	 * @return FALSE|string the authToken
	 */
	public function authToken() {
		$time = time();
		return $this->login.'|'.$time.'|'.sha1($this->key.$time);
	}

	/**
	 * getcurlpage()
	 * gets a webpage via curl and returns the response.
	 * also it sets a mozilla type agent.
	 * @param string $url        the url of the page you want
	 * @return string the webpage
	 */
	public function getcurlpage($url) {
		$agent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2790.0 Safari/537.36';
		$curl = curl_init($url);
		$options = $this->restOptions;
		curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
		curl_setopt($curl, CURLOPT_USERAGENT, $agent);
		if (is_array($options) && count($options) > 0)
			foreach ($options as $key => $value)
				curl_setopt($curl, $key, $value);
		$return = curl_exec($curl);
		curl_close($curl);
		return $return;
	}

	/**
	 * @param        $level
	 * @param        $text
	 * @param string $line
	 * @param string $file
	 */
	public function log($level, $text, $line = '', $file = '') {
		if (function_exists('myadmin_log'))
			myadmin_log('cloudlinux', $level, $text, $line, $file);
	}

	/**
	 * Return system information about several Cloudlinux services
	 *
	 * @return array array of system information
	 */
	public function status() {
		$this->response = $this->getcurlpage($this->restUrl.'status.json');
		return json_decode($this->response, TRUE);
	}

	/**
	 * Will return information about what kind of license types are available for registration and what types are already used by current account.
	 * @param string $ipAddress ip address to check
	 * @return array returns an array with  available(int[]) ­ list of types that can be used to register new IP license, and owned(int[]) ­ list of types that already registered(owned) by this account
	 */
	public function availability($ipAddress) {
		$this->response = $this->getcurlpage($this->restUrl.'ipl/availability.json?ip='.$ipAddress.'&token='.$this->authToken());
		return json_decode($this->response, TRUE);
	}

	/**
	 * Check if IP license was registered by any customer. Arguments:
	 *
	 * @param string $ipAddress ip address to remove
	 * @param bool $checkAll True will search for any type of license. False ­ only for types 1 or 2
	 * @throws XmlRpcException for critical errors
	 * @return FALSE|array (list<int>): List of registered license types or empty list if no license found
	 */
	public function isLicensed($ipAddress, $checkAll = TRUE) {
		if ($this->apiType == 'xml')
			return $this->xmlIsLicensed($ipAddress, $checkAll);
		else
			return $this->check($ipAddress);
	}

	/**
	 * Check if IP license is registered by any customer.
	 *
	 * @param string $ipAddress ip address to check
	 * @return FALSE|array Will return list of registered license types or empty list if provided IP is not registered yet.
	 */
	public function check($ipAddress) {
		$this->response = $this->getcurlpage($this->restUrl.'ipl/check.json?ip='.$ipAddress.'&token='.$this->authToken());
		$response = json_decode($this->response, TRUE);
		if ($response['success'] == 1)
			return $response['data'];
		else
			return FALSE;
	}

	/**
	 * Check if IP license was registered by any customer. Arguments:
	 *
	 * @throws XmlRpcException for critical errors
	 * @param string $ipAddress ip address to remove
	 * @param bool $checkAll True will search for any type of license. False ­ only for types 1 or 2
	 * @return FALSE|array (list<int>): List of registered license types or empty list if no license found
	 */
	public function xmlIsLicensed($ipAddress, $checkAll = TRUE) {
		$xmlClient = $this->xmlClient;
		try {
			return $this->response = $xmlClient->is_licensed($this->authToken(), $ipAddress, $checkAll);
		} catch (\Exception $e) {
			$this->log('error', 'Caught exception code: '.$e->getCode(), __LINE__, __FILE__);
			$this->log('error', 'Caught exception message: '.$e->getMessage(), __LINE__, __FILE__);
			return FALSE;
		}
	}

	/**
	 * Will remove IP based license from authorized user licenses.
	 *
	 * @param string $ipAddress ip address to remove licenses on
	 * @param int $type optional license type. If empty or 0, will remove licenses with all types
	 * @return bool|int
	 */
	public function remove($ipAddress, $type = 0) {
		if ($this->apiType == 'xml')
			return $this->removeLicense($ipAddress, $type);
		else
			return $this->restRemove($ipAddress, $type);
	}

	/**
	 * Will remove IP based license from authorized user licenses.
	 *
	 * @param string $ipAddress ip address to remove licenses on
	 * @param int $type optional license type. If empty, will remove licenses with all types
	 * @return bool
	 */
	public function restRemove($ipAddress, $type = 0) {
		if ($type != 0)
			$this->response = $this->getcurlpage($this->restUrl.'ipl/remove.json?ip='.$ipAddress.'&type='.$type.'&token='.$this->authToken());
		else
			$this->response = $this->getcurlpage($this->restUrl.'ipl/remove.json?ip='.$ipAddress.'&token='.$this->authToken());
		return json_decode($this->response, TRUE);
	}

	/**
	 * Remove IP licenses with specified type for customer. Also un­registers from CLN server associated with IP.
	 * or
	 * Remove IP licenses with specified type for customer. Also un­registers from CLN server associated with IP.
	 * @param string         $ipAddress   ip address to remove
	 * @param int $type optional parameter to specify the type of license to remove (1,2, or 16) or 0 for all
	 * @return bool|int 0 on success, -1 on error, Error will be returned also if account have no licenses for provided IP.
	 */
	public function removeLicense($ipAddress, $type = 0) {
		$this->log('info', "Calling CloudLinux->xmlClient->remove_license({$this->authToken()}, {$ipAddress}, {$type})", __LINE__, __FILE__);
		try {
			return $this->response = $this->xmlClient->remove_license($this->authToken(), $ipAddress, $type);
		} catch (\Exception $e) {
			$this->log('error', 'Caught exception code: '.$e->getCode(), __LINE__, __FILE__);
			$this->log('error', 'Caught exception message: '.$e->getMessage(), __LINE__, __FILE__);
			return FALSE;
		}
	}

	/**
	 * alias function to get a list of licenses
	 *
	 * @return array|FALSE
	 * @throws \Detain\Cloudlinux\XmlRpcException
	 */
	public function licenseList() {
		if ($this->apiType == 'rest')
			return $this->restList();
		else
			return $this->reconcile();
	}

	/**
	 * Return all IP licenses owned by authorized user.
	 *
	 * The normal response will look something like:
	 * 	[
	 * 		'success': TRUE,
	 * 		'data': [
	 * 			[
	 * 				'created': '2017-05-05T16:19-0400',
	 * 				'ip': '66.45.240.186',
	 * 				'registered': TRUE,
	 * 				'type': 1
	 * 			], [
	 * 				'created': '2016-10-14T10:42-0400',
	 * 				'ip': '131.153.38.228',
	 * 				'registered': FALSE,
	 * 				'type': 1
	 * 			],
	 *  .....
	 *
	 * @return FALSE|array an array of licenses each one containing these fields: ip(string)   ype(int) ­ license type (1,2,16)   registered(boolean) ­ TRUE if server was registered in CLN with this license (CLN licenses only).    created(string) ­ license creation time
	 */
	public function restList() {
		$this->response = $this->getcurlpage($this->restUrl.'ipl/list.json?token='.$this->authToken());
		return json_decode($this->response, TRUE);
	}

	/**
	 * Return list of all IP licenses owned by authorized user
	 *
	 * @throws XmlRpcException for critical errors
	 * @return FALSE|array (list<structure>): List of structures or empty list. Each structure contains keys:  IP(string)   TYPE(int) ­ license type  REGISTERED(boolean) ­ True if server was registered in CLN with this license
	 */
	public function reconcile() {
		$this->response = $this->xmlClient->reconcile($this->authToken());
		return $this->response;
	}

	/**
	 * Register new IP license.
	 *
	 * @param string $ipAddress IP Address
	 * @param integer $type license type (1,2 or 16)
	 * @return bool|mixed whether or not it was successfull

Consider making the return type a bit more specific; maybe use boolean|array.

	 */
	public function license($ipAddress, $type) {
		return $this->apiType == 'rest' ? $this->register($ipAddress, $type) : $this->reconcile($ipAddress, $type);

The call to Cloudlinux::reconcile() has too many arguments starting with $ipAddress.

	}

	/**
	 * Will register IP based license for authorized user.
	 *
	 * @param string $ipAddress ip address to registger
	 * @param int $type IP license type (1,2 or 16)
	 * @return bool|array true/false with normal response otherwise returns response
	 */
	public function register($ipAddress, $type) {
		$this->response = $this->getcurlpage($this->restUrl.'ipl/register.json?ip='.$ipAddress.'&type='.$type.'&token='.$this->authToken());
		$return = json_decode($this->response, TRUE);
		return isset($return['registered']) ? $return['registered'] : $return;
	}

	/**
	 * Register new IP license.
	 *
	 * @param string $ipAddress IP Address
	 * @param integer $type license type (1,2 or 16)
	 * @throws XmlRpcException for critical errors
	 * @return FALSE|integer 0 on success, -1 on error
	 */
	public function xmlLicense($ipAddress, $type) {
		$type = (int) $type;
		$xmlClient = $this->xmlClient;
		try {
			$this->log('error', 'Calling License('.$this->authToken().','.$ipAddress.','.$type.')', __LINE__, __FILE__);
			$this->response = $xmlClient->license($this->authToken(), $ipAddress, $type);
		} catch (\Exception $e) {
			$this->log('error', 'Caught exception code: '.$e->getCode(), __LINE__, __FILE__);
			$this->log('error', 'Caught exception message: '.$e->getMessage(), __LINE__, __FILE__);
			return FALSE;
		}
		if ($this->response == -1)
			return FALSE;
		elseif ($this->response == 0)
			return TRUE;
		else
			return $this->response;
	}
}