Initial class commit

added .class file, change log and more info to the readme.

Author: N1ghteyes

README.md

@@ -1,4 +1,19 @@
-cpanel-UAPI-php-class
+cpanel UAPI PHP class
 =====================
 
-php class for cpanel's UAPI
+PHP class to provide an easy to use interface with cpanels UAPI.
+
+Usage
+=====
+
+See the example files, but typical useage takes the form of:
+
+##load class
+$cpuapi = new cpaneluapi();
+
+##Set the scope to the module we want to use. in this case, Mysql
+$cpuapi->scope = 'Mysql';
+
+##call the function we want like this. Any arguments are passed into the function as an array, in the form of param => value.
+$cpuapi->get_restrictions(); 
+

changelog.txt

@@ -0,0 +1,9 @@
+Changelog
+=========
+
+Changelog for the Cpanel UAPI PHP Class
+
+Version 1.0
+===========
+
+# Initial commit

cpaneluapi.class

@@ -0,0 +1,165 @@
+<?php
+class cpanelUAPI
+{
+  	public $cpanelUAPI = '1.0';
+	public $scope = ""; //String - Module we want to use
+	public $ssl = 1; //Bool - TRUE / FALSE for ssl connection
+	public $port = 2083; //default for ssl servers.
+	public $server;
+
+	protected $auth;
+	protected $user;
+	protected $pass;
+	protected $type;
+	protected $port;
+	protected $requestUrl;
+	
+	function __construct(){
+		$this->user = (isset($this->user) ? $this->user : '');
+  		$this->pass = (isset($this->pass) ? $this->pass : '');
+  		$this->server = (isset($this->server) ? $this->server : '');
+	}
+
+	function __construct($user, $pass){
+  		$this->user = $user;
+  		$this->pass = $pass;
+  		$this->server = (isset($this->server) ? $this->server : '');
+  	} 
+
+  	function __construct($user, $pass, $server){
+  		$this->user = $user;
+  		$this->pass = $pass;
+  		$this->server = $server;
+  	} 
+  	
+  	/**
+     * Magic __call method, will translate all function calls to object to API requests
+     * @param String $name name of the function
+     * @param array $arguments an array of arguments
+     * @return OauthResult
+     */
+    public function  __call($name, $arguments)
+    {
+    	$this->connections(); //set paths etc at the last possible moment to allow for changes before this call is made.
+        if(count($arguments) < 1 || !is_array($arguments[0]))
+            $arguments[0] = array();
+        $scope = $this->scope;
+        return json_decode($this->APIcall($name, $arguments[0]));
+    }
+
+    /**
+    * function to set all the connection variables, called before APIcall
+    */
+    private function connections(){
+    	$this->type = $this->ssl == 1 ? "https://" : "http://";
+		$this->requestUrl = $this->type.$this->server.':'.$this->port.'/execute/';
+  		$this->auth = base64_encode($user .":". $pass);
+    }
+
+    //function to build request URL
+  	private function APIcall($name, $arguments){
+  		$url = $this->requestUrl.($this->scope != '' ? $this->scope."/" : '').$name.'?';
+  		foreach($arguments as $key => $value){
+  			$url .= $key."=".$value."&";
+  		}
+  		sc_utils_watch("request URL", '', $url);
+	  	return $this->curl_request($url);
+  	}
+  	
+	private function curl_request($url){
+	
+		$ch = curl_init ();
+		curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); 
+		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
+		curl_setopt($ch, CURLOPT_HEADER, 0);
+		curl_setopt($ch, CURLOPT_URL, $url);
+		curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Basic " . $this->auth));
+		curl_setopt($ch, CURLOPT_TIMEOUT, 100020);
+		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+
+		$content = $this->curl_exec_follow($ch);
+		$err = curl_errno ($ch);
+		$errmsg = curl_error ($ch);
+		$header = curl_getinfo ($ch);
+		$httpCode = curl_getinfo ($ch, CURLINFO_HTTP_CODE);
+
+		curl_close ($ch);
+
+		$header['errno'] = $err;
+		$header['errmsg'] = $errmsg;
+		$header['content'] = $content;
+
+	    return $header['content'];
+	}
+
+	private function curl_exec_follow($ch, &$maxredirect = null) {
+  
+	  // we emulate a browser here since some websites detect
+	  // us as a bot and don't let us do our job
+	  $user_agent = "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.5)".
+	                " Gecko/20041107 Firefox/1.0";
+	  curl_setopt($ch, CURLOPT_USERAGENT, $user_agent );
+
+	  $mr = $maxredirect === null ? 5 : intval($maxredirect);
+
+	  if (ini_get('open_basedir') == '' && ini_get('safe_mode') == 'Off') {
+
+	    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, $mr > 0);
+	    curl_setopt($ch, CURLOPT_MAXREDIRS, $mr);
+	    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+	    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
+
+	  } else {
+	    
+	    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, false);
+
+	    if ($mr > 0)
+	    {
+	      $original_url = curl_getinfo($ch, CURLINFO_EFFECTIVE_URL);
+	      $newurl = $original_url;
+	      
+	      $rch = curl_copy_handle($ch);
+	      
+	      curl_setopt($rch, CURLOPT_HEADER, true);
+	      curl_setopt($rch, CURLOPT_NOBODY, true);
+	      curl_setopt($rch, CURLOPT_FORBID_REUSE, false);
+	      do
+	      {
+	        curl_setopt($rch, CURLOPT_URL, $newurl);
+	        $header = curl_exec($rch);
+	        if (curl_errno($rch)) {
+	          $code = 0;
+	        } else {
+	          $code = curl_getinfo($rch, CURLINFO_HTTP_CODE);
+	          if ($code == 301 || $code == 302) {
+	            preg_match('/Location:(.*?)\n/', $header, $matches);
+	            $newurl = trim(array_pop($matches));
+	            
+	            // if no scheme is present then the new url is a
+	            // relative path and thus needs some extra care
+	            if(!preg_match("/^https?:/i", $newurl)){
+	              $newurl = $original_url . $newurl;
+	            }   
+	          } else {
+	            $code = 0;
+	          }
+	        }
+	      } while ($code && --$mr);
+	      
+	      curl_close($rch);
+	      
+	      if (!$mr)
+	      {
+	        if ($maxredirect === null)
+	        trigger_error('Too many redirects.', E_USER_WARNING);
+	        else
+	        $maxredirect = 0;
+	        
+	        return false;
+	      }
+	      curl_setopt($ch, CURLOPT_URL, $newurl);
+	    }
+	  }
+	  return curl_exec($ch);
+	}
+}