Minor bugfixes & version check system

Added the version checking system to allow the DonDominio Domain Management Addon to check the version of this plugin.
dondominio · Nov 19, 2015 · 24037c2 · 24037c2
1 parent b713f22
commit 24037c2
Show file tree

Hide file tree

Showing 9 changed files with 149 additions and 85 deletions.
diff --git a/dondominio.php b/dondominio.php
@@ -15,24 +15,24 @@
 /**
  * The DonDominio API Client for PHP
  */
-if(!class_exists('DonDominioAPI')){
-	require_once("lib/sdk/DonDominioAPI.php");
+if(!class_exists( 'DonDominioAPI' )){
+	require_once( "lib/sdk/DonDominioAPI.php" );
 }
 
 /**
  * Helper library.
  */
-require_once("dondominio_helper.php");
+require_once( "dondominio_helper.php" );
 
 /**
  * Initialize the plugin.
  * @return DonDominioAPI
  */
-function dondominio_init($params)
+function dondominio_init( $params )
 {
 	if(
-		!array_key_exists('apiuser', $params)
-		|| !array_key_exists('apipasswd', $params)
+		!array_key_exists( 'apiuser', $params )
+		|| !array_key_exists( 'apipasswd', $params )
 	){
 		return false;
 	}
@@ -44,14 +44,43 @@ function dondominio_init($params)
 		'versionCheck' => true,
 		'response' => array(
 			'throwExceptions' => true
+		),
+		'userAgent' => array(
+			'PluginForWHMCS' => dondominio_getVersion()
 		)
 	);
 
-	$dondominio = new DonDominioAPI($options);
+	$dondominio = new DonDominioAPI( $options );
 
 	return $dondominio;
 }
 
+/**
+ * Get plugin version.
+ *
+ * @return string
+ */
+function dondominio_getVersion()
+{
+	if( !file_exists( __DIR__ . '/version.json' )){
+		return 'unknown';
+	}
+
+	$json = @file_get_contents( __DIR__ . '/version.json' );
+
+	if( empty( $json )){
+		return 'unknown';
+	}
+
+	$versionInfo = json_decode( $json, true );
+
+	if( !is_array( $versionInfo ) || !array_key_exists( 'version', $versionInfo )){
+		return 'unknown';
+	}
+
+	return $versionInfo['version'];
+}
+
 /**
  * Return the configuration for the plugin.
  * @return array
@@ -63,7 +92,7 @@ function dondominio_getConfigArray()
 
 	$customfields = "";
 
-	while(list($cf_id, $cf_fieldname) = mysql_fetch_row($query)){
+	while( list( $cf_id, $cf_fieldname ) = mysql_fetch_row( $query )){
 		$customfields .= ',' . $cf_fieldname;
 	}
 
@@ -163,23 +192,23 @@ function dondominio_getConfigArray()
  * @param array $params Parameters sent by WHMCS
  * @return array
  */
-function dondominio_GetNameservers($params)
+function dondominio_GetNameservers( $params )
 {
-	$dondominio = dondominio_init($params);
+	$dondominio = dondominio_init( $params );
 
 	$tld = $params["tld"];		//Top-Level Domain (.com)
 	$sld = $params["sld"];		//Second-Level Domain (example)
 
 	try{
-		$nameservers = $dondominio->domain_getNameServers($sld . '.' . $tld);
+		$nameservers = $dondominio->domain_getNameServers( $sld . '.' . $tld );
 
-		foreach($nameservers->get("nameservers") as $key=>$nameserver){
-			if($key <= 5){
+		foreach( $nameservers->get( "nameservers" ) as $key=>$nameserver ){
+			if( $key <= 5 ){
 				$values["ns" . $nameserver["order"]] = $nameserver["name"];
 			}
 		}
 
-		logModuleCall('dondominio', 'GetNameservers', $params, $nameservers->getRawResponse(), $nameservers->getResponseData()); 
+		logModuleCall( 'dondominio', 'GetNameservers', $params, $nameservers->getRawResponse(), $nameservers->getResponseData()); 
 	}catch(DonDominioAPI_Error $e){
 		return array('error' => $e->getMessage());
 	}
@@ -192,33 +221,33 @@ function dondominio_GetNameservers($params)
  * @param array $params Parameters passed by WHMCS
  * @return array
  */
-function dondominio_SaveNameservers($params)
+function dondominio_SaveNameservers( $params )
 {
-	$dondominio = dondominio_init($params);
+	$dondominio = dondominio_init( $params );
 
 	$tld = $params["tld"];		//Top-Level Domain (.com)
 	$sld = $params["sld"];		//Second-Level Domain (example)
 
 	$nameservers_array = array();
 
-    if(array_key_exists("ns1", $params)) $nameservers_array[] = $params["ns1"];
-	if(array_key_exists("ns2", $params)) $nameservers_array[] = $params["ns2"];
-    if(array_key_exists("ns3", $params)) $nameservers_array[] = $params["ns3"];
-	if(array_key_exists("ns4", $params)) $nameservers_array[] = $params["ns4"];
-	if(array_key_exists("ns5", $params)) $nameservers_array[] = $params["ns5"];
+    if( array_key_exists( "ns1", $params )) $nameservers_array[] = $params["ns1"];
+	if( array_key_exists( "ns2", $params )) $nameservers_array[] = $params["ns2"];
+    if( array_key_exists( "ns3", $params )) $nameservers_array[] = $params["ns3"];
+	if( array_key_exists( "ns4", $params )) $nameservers_array[] = $params["ns4"];
+	if( array_key_exists( "ns5", $params )) $nameservers_array[] = $params["ns5"];
 
 	try{
 		$nameservers = $dondominio->domain_updateNameServers(
 			$sld . '.' . $tld,
 			$nameservers_array
 		);
 
-		logModuleCall('dondominio', 'SaveNameservers', $params, $nameservers->getRawResponse(), $nameservers->getResponseData()); 
+		logModuleCall( 'dondominio', 'SaveNameservers', $params, $nameservers->getRawResponse(), $nameservers->getResponseData()); 
 	}catch(DonDominioAPI_Error $e){
-		return array('error' => $e->getMessage());
+		return array( 'error' => $e->getMessage());
 	}
 
-	return array('success' => true);
+	return array( 'success' => true );
 }
 
 /**
@@ -260,9 +289,9 @@ function dondominio_GetRegistrarLock($params)
  * @param array $params Parameters passed by WHMCS
  * @return array
  */
-function dondominio_SaveRegistrarLock($params)
+function dondominio_SaveRegistrarLock( $params )
 {
-	$dondominio = dondominio_init($params);
+	$dondominio = dondominio_init( $params );
 
 	$tld = $params["tld"];		//Top-Level Domain (.com)
 	$sld = $params["sld"];		//Second-Level Domain (example)
@@ -1216,4 +1245,4 @@ function dondominio_TransferSync($params)
 	return $values;
 }
 
-?>
+?>
diff --git a/dondominio_helper.php b/dondominio_helper.php
@@ -337,4 +337,4 @@ function populateContact(array $contact, $type, &$result)
 	$result[$type]['VAT Number'] = $contact['identNumber'];
 }
 
-?>
+?>
diff --git a/lib/sdk/DonDominioAPI.php b/lib/sdk/DonDominioAPI.php
@@ -68,7 +68,8 @@ class DonDominioAPI extends DonDominioAPIClientPostCurl
 		'verifySSL' => false,
 		'response' => array(
 			'throwExceptions' => true
-		)
+		),
+		'userAgent' => array()
 	);
 
 	/**
@@ -97,7 +98,8 @@ public function __construct(array $options = null)
 			'debugOutput' => $this->options['debugOutput'],
 			'verifySSL' => $this->options['verifySSL'],
 			'format' => 'json',
-			'pretty' => true
+			'pretty' => true,
+			'userAgent' => $this->options['userAgent']
 		));
 
 		//Modules