phpipam / phpipam

functions/classes/class.Thread.php

Doc Comments +1 added lines, -1 removed lines

@@ -248,7 +248,7 @@
 	/**
 	* alias of stop();
 	*
-	* @return boolean
+	* @return boolean|null
 	*/
     public function kill( $_signal = SIGKILL, $_wait = false ) {
         return $this->stop( $_signal, $_wait );

Indentation +140 added lines, -140 removed lines

@@ -11,47 +11,47 @@ 
     const FUNCTION_NOT_CALLABLE = 10;
     const COULD_NOT_FORK = 15;
 
-	/**
-	* possible errors
-	*
-	* @var array
-	*/
+    /**
+     * possible errors
+     *
+     * @var array
+     */
     private $errors = array(
         Thread::FUNCTION_NOT_CALLABLE => 'You must specify a valid function name that can be called from the current scope.',
         Thread::COULD_NOT_FORK => 'pcntl_fork() returned a status of -1. No new process was created',
     );
 
-	/**
-	* callback for the function that should
-	* run as a separate thread
-	*
-	* @var callback
-	*/
+    /**
+     * callback for the function that should
+     * run as a separate thread
+     *
+     * @var callback
+     */
     protected $runnable;
 
-	/**
-	* holds the current process id
-	*
-	* @var integer
-	*/
+    /**
+     * holds the current process id
+     *
+     * @var integer
+     */
     private $pid;
 
-	/**
-	* holds the exit code after the child dies
-	*/
+    /**
+     * holds the exit code after the child dies
+     */
     private $exitCode = -1;
 
     /**
-	* holds type - needed for fping
-	*/
-	public $stype = "ping";
+     * holds type - needed for fping
+     */
+    public $stype = "ping";
 
-	/**
-	* checks if threading is supported by the current
-	* PHP configuration
-	*
-	* @return boolean
-	*/
+    /**
+     * checks if threading is supported by the current
+     * PHP configuration
+     *
+     * @return boolean
+     */
     public static function available() {
         $required_functions = array(
             'pcntl_fork',
@@ -66,24 +66,24 @@ 
         return true;
     }
 
-	/**
-	* class constructor - you can pass
-	* the callback function as an argument
-	*
-	* @param callback $_runnable
-	*/
+    /**
+     * class constructor - you can pass
+     * the callback function as an argument
+     *
+     * @param callback $_runnable
+     */
     public function __construct( $_runnable = null ) {
-		if( $_runnable !== null ) {
-			$this->setRunnable( $_runnable );
-		}
+        if( $_runnable !== null ) {
+            $this->setRunnable( $_runnable );
+        }
     }
 
-	/**
-	* sets the callback
-	*
-	* @param callback $_runnable
-	* @return callback
-	*/
+    /**
+     * sets the callback
+     *
+     * @param callback $_runnable
+     * @return callback
+     */
     public function setRunnable( $_runnable ) {
         if( self::runnableOk( $_runnable ) ) {
             $this->runnable = $_runnable;
@@ -93,43 +93,43 @@ 
         }
     }
 
-	/**
-	* gets the callback
-	*
-	* @return callback
-	*/
+    /**
+     * gets the callback
+     *
+     * @return callback
+     */
     public function getRunnable() {
         return $this->runnable;
     }
 
-	/**
-	* checks if the callback is ok (the function/method
-	* actually exists and is runnable from the current
-	* context)
-	*
-	* can be called statically
-	*
-	* @param callback $_runnable
-	* @return boolean
-	*/
+    /**
+     * checks if the callback is ok (the function/method
+     * actually exists and is runnable from the current
+     * context)
+     *
+     * can be called statically
+     *
+     * @param callback $_runnable
+     * @return boolean
+     */
     public static function runnableOk( $_runnable ) {
         return ( function_exists( $_runnable ) && is_callable( $_runnable ) );
     }
 
-	/**
-	* returns the process id (pid) of the simulated thread
-	*
-	* @return int
-	*/
+    /**
+     * returns the process id (pid) of the simulated thread
+     *
+     * @return int
+     */
     public function getPid() {
         return $this->pid;
     }
 
-	/**
-	* checks if the child thread is alive
-	*
-	* @return boolean
-	*/
+    /**
+     * checks if the child thread is alive
+     *
+     * @return boolean
+     */
     public function isAlive() {
         $pid = pcntl_waitpid( $this->pid, $status, WNOHANG );
 
@@ -143,22 +143,22 @@ 
         }
     }
 
-	/**
-	* return exit code of child (-1 if child is still alive)
-	*
-	* @return int
-	*/
+    /**
+     * return exit code of child (-1 if child is still alive)
+     *
+     * @return int
+     */
     public function getExitCode() {
         $this->isAlive();
         return $this->exitCode;
     }
 
-	/**
-	* starts the thread, all the parameters are
-	* passed to the callback function
-	*
-	* @return void
-	*/
+    /**
+     * starts the thread, all the parameters are
+     * passed to the callback function
+     *
+     * @return void
+     */
     public function start() {
         $pid = @ pcntl_fork();
         if( $pid == -1 ) {
@@ -183,59 +183,59 @@ 
         }
     }
 
-	/**
-	* starts the thread, all the parameters are
-	* passed to the callback function
-	*
-	*	modification for fping threading for cron scanning
-	*
-	* @return void
-	*/
+    /**
+     * starts the thread, all the parameters are
+     * passed to the callback function
+     *
+     *	modification for fping threading for cron scanning
+     *
+     * @return void
+     */
     public function start_fping() {
-		$status = 0;
-		$results = null;
-		$pid = pcntl_fork();
+        $status = 0;
+        $results = null;
+        $pid = pcntl_fork();
 
-		if( $pid == -1 ) { //error forking, no child is created
-			throw new Exception( $this->getError( Thread::COULD_NOT_FORK ), Thread::COULD_NOT_FORK );
-		}else if ( $pid ) {// parent
-			$this->pid = $pid;
+        if( $pid == -1 ) { //error forking, no child is created
+            throw new Exception( $this->getError( Thread::COULD_NOT_FORK ), Thread::COULD_NOT_FORK );
+        }else if ( $pid ) {// parent
+            $this->pid = $pid;
 
-		} else { // child
-			$this->pid = posix_getpid();//pid (child)
-			$this->ppid = posix_getppid();//pid (parent)
+        } else { // child
+            $this->pid = posix_getpid();//pid (child)
+            $this->ppid = posix_getppid();//pid (parent)
 
-			pcntl_signal( SIGTERM, array( $this, 'signalHandler' ) );
-			$array_args = func_get_args();
-			if ( !empty( $array_args ) ) {
-				$results = call_user_func_array( $this->runnable, $array_args );
-			}else{
-				$results = call_user_func( $this->runnable );
-			}
+            pcntl_signal( SIGTERM, array( $this, 'signalHandler' ) );
+            $array_args = func_get_args();
+            if ( !empty( $array_args ) ) {
+                $results = call_user_func_array( $this->runnable, $array_args );
+            }else{
+                $results = call_user_func( $this->runnable );
+            }
 
-			$pipe = "/tmp/pipe_".$this->pid;//pid is known by parent
+            $pipe = "/tmp/pipe_".$this->pid;//pid is known by parent
 
-			if(!file_exists($pipe)) {//child talks to parent using this pipe
-				umask(0);
-				posix_mkfifo($pipe, 0600);
-			}
-			//we have to open the pipe and send the data serialized
-			$pipe_descriptor = fopen($pipe, 'w');
-			fwrite($pipe_descriptor, serialize( $results ) );
+            if(!file_exists($pipe)) {//child talks to parent using this pipe
+                umask(0);
+                posix_mkfifo($pipe, 0600);
+            }
+            //we have to open the pipe and send the data serialized
+            $pipe_descriptor = fopen($pipe, 'w');
+            fwrite($pipe_descriptor, serialize( $results ) );
 
-			//and kill the child using posix_kill ( exit(0) duplicates headers!! )
-			posix_kill( $this->pid , SIGKILL);
-			exit(0);
-		}
+            //and kill the child using posix_kill ( exit(0) duplicates headers!! )
+            posix_kill( $this->pid , SIGKILL);
+            exit(0);
+        }
     }
 
-	/**
-	* attempts to stop the thread
-	* returns true on success and false otherwise
-	*
-	* @param integer $_signal - SIGKILL/SIGTERM
-	* @param boolean $_wait
-	*/
+    /**
+     * attempts to stop the thread
+     * returns true on success and false otherwise
+     *
+     * @param integer $_signal - SIGKILL/SIGTERM
+     * @param boolean $_wait
+     */
     public function stop( $_signal = SIGKILL, $_wait = false ) {
         if( $this->isAlive() ) {
             posix_kill( $this->pid, $_signal );
@@ -245,22 +245,22 @@ 
         }
     }
 
-	/**
-	* alias of stop();
-	*
-	* @return boolean
-	*/
+    /**
+     * alias of stop();
+     *
+     * @return boolean
+     */
     public function kill( $_signal = SIGKILL, $_wait = false ) {
         return $this->stop( $_signal, $_wait );
     }
 
-	/**
-	* gets the error's message based on
-	* its id
-	*
-	* @param integer $_code
-	* @return string
-	*/
+    /**
+     * gets the error's message based on
+     * its id
+     *
+     * @param integer $_code
+     * @return string
+     */
     public function getError( $_code ) {
         if ( isset( $this->errors[$_code] ) ) {
             return $this->errors[$_code];
@@ -270,11 +270,11 @@ 
         }
     }
 
-	/**
-	* signal handler
-	*
-	* @param integer $_signal
-	*/
+    /**
+     * signal handler
+     *
+     * @param integer $_signal
+     */
     protected function signalHandler( $_signal ) {
         switch( $_signal ) {
             case SIGTERM:

Braces +18 added lines, -8 removed lines

@@ -133,10 +133,13 @@ 
     public function isAlive() {
         $pid = pcntl_waitpid( $this->pid, $status, WNOHANG );
 
-        if ($pid === 0) { // child is still alive
+        if ($pid === 0) {
+// child is still alive
             return true;
-        } else {
-            if (pcntl_wifexited($status) && $this->exitCode == -1) { // normal exit
+        }
+        else {
+            if (pcntl_wifexited($status) && $this->exitCode == -1) {
+// normal exit
                 $this->exitCode = pcntl_wexitstatus($status);
             }
             return false;
@@ -196,12 +199,17 @@ 
 		$results = null;
 		$pid = pcntl_fork();
 
-		if( $pid == -1 ) { //error forking, no child is created
+		if( $pid == -1 ) {
+//error forking, no child is created
 			throw new Exception( $this->getError( Thread::COULD_NOT_FORK ), Thread::COULD_NOT_FORK );
-		}else if ( $pid ) {// parent
+		}
+		else if ( $pid ) {
+// parent
 			$this->pid = $pid;
 
-		} else { // child
+		}
+		else {
+// child
 			$this->pid = posix_getpid();//pid (child)
 			$this->ppid = posix_getppid();//pid (parent)
 
@@ -209,13 +217,15 @@ 
 			$array_args = func_get_args();
 			if ( !empty( $array_args ) ) {
 				$results = call_user_func_array( $this->runnable, $array_args );
-			}else{
+			}
+			else {
 				$results = call_user_func( $this->runnable );
 			}
 
 			$pipe = "/tmp/pipe_".$this->pid;//pid is known by parent
 
-			if(!file_exists($pipe)) {//child talks to parent using this pipe
+			if(!file_exists($pipe)) {
+//child talks to parent using this pipe
 				umask(0);
 				posix_mkfifo($pipe, 0600);
 			}

Spacing +65 added lines, -65 removed lines

@@ -16,7 +16,7 @@ 
 	*
 	* @var array
 	*/
-    private $errors = array(
+    private $errors = array (
         Thread::FUNCTION_NOT_CALLABLE => 'You must specify a valid function name that can be called from the current scope.',
         Thread::COULD_NOT_FORK => 'pcntl_fork() returned a status of -1. No new process was created',
     );
@@ -52,13 +52,13 @@ 
 	*
 	* @return boolean
 	*/
-    public static function available() {
-        $required_functions = array(
+    public static function available () {
+        $required_functions = array (
             'pcntl_fork',
         );
 
-        foreach( $required_functions as $function ) {
-            if ( !function_exists( $function ) ) {
+        foreach ($required_functions as $function) {
+            if (!function_exists ($function)) {
                 return false;
             }
         }
@@ -72,9 +72,9 @@ 
 	*
 	* @param callback $_runnable
 	*/
-    public function __construct( $_runnable = null ) {
-		if( $_runnable !== null ) {
-			$this->setRunnable( $_runnable );
+    public function __construct ($_runnable = null) {
+		if ($_runnable !== null) {
+			$this->setRunnable ($_runnable);
 		}
     }
 
@@ -84,12 +84,12 @@ 
 	* @param callback $_runnable
 	* @return callback
 	*/
-    public function setRunnable( $_runnable ) {
-        if( self::runnableOk( $_runnable ) ) {
+    public function setRunnable ($_runnable) {
+        if (self::runnableOk ($_runnable)) {
             $this->runnable = $_runnable;
         }
         else {
-            throw new Exception( $this->getError( Thread::FUNCTION_NOT_CALLABLE ), Thread::FUNCTION_NOT_CALLABLE );
+            throw new Exception ($this->getError (Thread::FUNCTION_NOT_CALLABLE), Thread::FUNCTION_NOT_CALLABLE);
         }
     }
 
@@ -98,7 +98,7 @@ 
 	*
 	* @return callback
 	*/
-    public function getRunnable() {
+    public function getRunnable () {
         return $this->runnable;
     }
 
@@ -112,8 +112,8 @@ 
 	* @param callback $_runnable
 	* @return boolean
 	*/
-    public static function runnableOk( $_runnable ) {
-        return ( function_exists( $_runnable ) && is_callable( $_runnable ) );
+    public static function runnableOk ($_runnable) {
+        return (function_exists ($_runnable) && is_callable ($_runnable));
     }
 
 	/**
@@ -121,7 +121,7 @@ 
 	*
 	* @return int
 	*/
-    public function getPid() {
+    public function getPid () {
         return $this->pid;
     }
 
@@ -130,14 +130,14 @@ 
 	*
 	* @return boolean
 	*/
-    public function isAlive() {
-        $pid = pcntl_waitpid( $this->pid, $status, WNOHANG );
+    public function isAlive () {
+        $pid = pcntl_waitpid ($this->pid, $status, WNOHANG);
 
         if ($pid === 0) { // child is still alive
             return true;
         } else {
-            if (pcntl_wifexited($status) && $this->exitCode == -1) { // normal exit
-                $this->exitCode = pcntl_wexitstatus($status);
+            if (pcntl_wifexited ($status) && $this->exitCode == -1) { // normal exit
+                $this->exitCode = pcntl_wexitstatus ($status);
             }
             return false;
         }
@@ -148,8 +148,8 @@ 
 	*
 	* @return int
 	*/
-    public function getExitCode() {
-        $this->isAlive();
+    public function getExitCode () {
+        $this->isAlive ();
         return $this->exitCode;
     }
 
@@ -159,27 +159,27 @@ 
 	*
 	* @return void
 	*/
-    public function start() {
-        $pid = @ pcntl_fork();
-        if( $pid == -1 ) {
-            throw new Exception( $this->getError( Thread::COULD_NOT_FORK ), Thread::COULD_NOT_FORK );
+    public function start () {
+        $pid = @ pcntl_fork ();
+        if ($pid == -1) {
+            throw new Exception ($this->getError (Thread::COULD_NOT_FORK), Thread::COULD_NOT_FORK);
         }
-        if( $pid ) {
+        if ($pid) {
             // parent
             $this->pid = $pid;
         }
         else {
             // child
-            pcntl_signal( SIGTERM, array( $this, 'signalHandler' ) );
-            $arguments = func_get_args();
-            if ( !empty( $arguments ) ) {
-                call_user_func_array( $this->runnable, $arguments );
+            pcntl_signal (SIGTERM, array ($this, 'signalHandler'));
+            $arguments = func_get_args ();
+            if (!empty($arguments)) {
+                call_user_func_array ($this->runnable, $arguments);
             }
             else {
-                call_user_func( $this->runnable );
+                call_user_func ($this->runnable);
             }
 
-            exit( 0 );
+            exit(0);
         }
     }
 
@@ -191,40 +191,40 @@ 
 	*
 	* @return void
 	*/
-    public function start_fping() {
+    public function start_fping () {
 		$status = 0;
 		$results = null;
-		$pid = pcntl_fork();
+		$pid = pcntl_fork ();
 
-		if( $pid == -1 ) { //error forking, no child is created
-			throw new Exception( $this->getError( Thread::COULD_NOT_FORK ), Thread::COULD_NOT_FORK );
-		}else if ( $pid ) {// parent
+		if ($pid == -1) { //error forking, no child is created
+			throw new Exception ($this->getError (Thread::COULD_NOT_FORK), Thread::COULD_NOT_FORK);
+		} else if ($pid) {// parent
 			$this->pid = $pid;
 
 		} else { // child
-			$this->pid = posix_getpid();//pid (child)
-			$this->ppid = posix_getppid();//pid (parent)
+			$this->pid = posix_getpid (); //pid (child)
+			$this->ppid = posix_getppid (); //pid (parent)
 
-			pcntl_signal( SIGTERM, array( $this, 'signalHandler' ) );
-			$array_args = func_get_args();
-			if ( !empty( $array_args ) ) {
-				$results = call_user_func_array( $this->runnable, $array_args );
-			}else{
-				$results = call_user_func( $this->runnable );
+			pcntl_signal (SIGTERM, array ($this, 'signalHandler'));
+			$array_args = func_get_args ();
+			if (!empty($array_args)) {
+				$results = call_user_func_array ($this->runnable, $array_args);
+			} else {
+				$results = call_user_func ($this->runnable);
 			}
 
-			$pipe = "/tmp/pipe_".$this->pid;//pid is known by parent
+			$pipe = "/tmp/pipe_".$this->pid; //pid is known by parent
 
-			if(!file_exists($pipe)) {//child talks to parent using this pipe
-				umask(0);
-				posix_mkfifo($pipe, 0600);
+			if (!file_exists ($pipe)) {//child talks to parent using this pipe
+				umask (0);
+				posix_mkfifo ($pipe, 0600);
 			}
 			//we have to open the pipe and send the data serialized
-			$pipe_descriptor = fopen($pipe, 'w');
-			fwrite($pipe_descriptor, serialize( $results ) );
+			$pipe_descriptor = fopen ($pipe, 'w');
+			fwrite ($pipe_descriptor, serialize ($results));
 
 			//and kill the child using posix_kill ( exit(0) duplicates headers!! )
-			posix_kill( $this->pid , SIGKILL);
+			posix_kill ($this->pid, SIGKILL);
 			exit(0);
 		}
     }
@@ -236,11 +236,11 @@ 
 	* @param integer $_signal - SIGKILL/SIGTERM
 	* @param boolean $_wait
 	*/
-    public function stop( $_signal = SIGKILL, $_wait = false ) {
-        if( $this->isAlive() ) {
-            posix_kill( $this->pid, $_signal );
-            if( $_wait ) {
-                pcntl_waitpid( $this->pid, $status = 0 );
+    public function stop ($_signal = SIGKILL, $_wait = false) {
+        if ($this->isAlive ()) {
+            posix_kill ($this->pid, $_signal);
+            if ($_wait) {
+                pcntl_waitpid ($this->pid, $status = 0);
             }
         }
     }
@@ -250,8 +250,8 @@ 
 	*
 	* @return boolean
 	*/
-    public function kill( $_signal = SIGKILL, $_wait = false ) {
-        return $this->stop( $_signal, $_wait );
+    public function kill ($_signal = SIGKILL, $_wait = false) {
+        return $this->stop ($_signal, $_wait);
     }
 
 	/**
@@ -261,12 +261,12 @@ 
 	* @param integer $_code
 	* @return string
 	*/
-    public function getError( $_code ) {
-        if ( isset( $this->errors[$_code] ) ) {
+    public function getError ($_code) {
+        if (isset($this->errors[$_code])) {
             return $this->errors[$_code];
         }
         else {
-            return 'No such error code ' . $_code . '! Quit inventing errors!!!';
+            return 'No such error code '.$_code.'! Quit inventing errors!!!';
         }
     }
 
@@ -275,10 +275,10 @@ 
 	*
 	* @param integer $_signal
 	*/
-    protected function signalHandler( $_signal ) {
-        switch( $_signal ) {
+    protected function signalHandler ($_signal) {
+        switch ($_signal) {
             case SIGTERM:
-                exit( 0 );
+                exit(0);
             break;
         }
     }

functions/scan/subnet-scan-icmp-execute.php

Indentation +92 added lines, -92 removed lines

@@ -52,7 +52,7 @@ 
 if($argv[1]!="update"&&$argv[1]!="discovery")			{ die(json_encode(array("status"=>1, "error"=>"Invalid scan type!"))); }
 //verify cidr
 if(!is_numeric($argv[2])) {
-	if($Subnets->verify_cidr_address($argv[2])!==true)	{ die(json_encode(array("status"=>1, "error"=>"Invalid subnet CIDR address provided"))); }
+    if($Subnets->verify_cidr_address($argv[2])!==true)	{ die(json_encode(array("status"=>1, "error"=>"Invalid subnet CIDR address provided"))); }
 }
 
 /**
@@ -64,103 +64,103 @@ 
 
 # fping
 if($Scan->settings->scanPingType=="fping" && $argv[1]=="discovery") {
-	# fetch subnet
-	$subnet = $Subnets->fetch_subnet(null, $argv[2]);
-	$subnet!==false ? : 								  die(json_encode(array("status"=>1, "error"=>"Invalid subnet ID provided")));
-
-	//set exit flag to true
-	$Scan->ping_set_exit(false);
-
-	# set cidr
-	$subnet_cidr = $Subnets->transform_to_dotted($subnet->subnet)."/".$subnet->mask;
-	# execute
-	$retval = $Scan->ping_address_method_fping_subnet ($subnet_cidr);
-
-	# errors
-	if($retval==3)										{ die(json_encode(array("status"=>1, "error"=>"invalid command line arguments"))); }
-	if($retval==4)										{ die(json_encode(array("status"=>1, "error"=>"system call failure"))); }
-
-	# parse result
-	if(sizeof(@$Scan->fping_result)==0)					{ die(json_encode(array("status"=>0, "values"=>array("alive"=>null)))); }
-	else {
-		//check each line
-		foreach($Scan->fping_result as $l) {
-			//split
-			$field = array_filter(explode(" ", $l));
-			//create result
-			$out['alive'][] = $Subnets->transform_to_decimal($field[0]);
-		}
-	}
+    # fetch subnet
+    $subnet = $Subnets->fetch_subnet(null, $argv[2]);
+    $subnet!==false ? : 								  die(json_encode(array("status"=>1, "error"=>"Invalid subnet ID provided")));
+
+    //set exit flag to true
+    $Scan->ping_set_exit(false);
+
+    # set cidr
+    $subnet_cidr = $Subnets->transform_to_dotted($subnet->subnet)."/".$subnet->mask;
+    # execute
+    $retval = $Scan->ping_address_method_fping_subnet ($subnet_cidr);
+
+    # errors
+    if($retval==3)										{ die(json_encode(array("status"=>1, "error"=>"invalid command line arguments"))); }
+    if($retval==4)										{ die(json_encode(array("status"=>1, "error"=>"system call failure"))); }
+
+    # parse result
+    if(sizeof(@$Scan->fping_result)==0)					{ die(json_encode(array("status"=>0, "values"=>array("alive"=>null)))); }
+    else {
+        //check each line
+        foreach($Scan->fping_result as $l) {
+            //split
+            $field = array_filter(explode(" ", $l));
+            //create result
+            $out['alive'][] = $Subnets->transform_to_decimal($field[0]);
+        }
+    }
 }
 # fping - status update
 elseif($Scan->settings->scanPingType=="fping") {
-	# fetch subnet
-	$subnet = $Subnets->fetch_subnet(null, $argv[2]);
-	$subnet!==false ? : 								  die(json_encode(array("status"=>1, "error"=>"Invalid subnet ID provided")));
-
-	//set exit flag to true
-	$Scan->ping_set_exit(false);
-
-	# set cidr
-	$subnet_cidr = $Subnets->transform_to_dotted($subnet->subnet)."/".$subnet->mask;
-	# execute
-	$retval = $Scan->ping_address_method_fping_subnet ($subnet_cidr);
-
-	# errors
-	if($retval==3)										{ die(json_encode(array("status"=>1, "error"=>"invalid command line arguments"))); }
-	if($retval==4)										{ die(json_encode(array("status"=>1, "error"=>"system call failure"))); }
-
-	# parse result
-	if(sizeof(@$Scan->fping_result)==0)					{ die(json_encode(array("status"=>0, "values"=>array("alive"=>null)))); }
-	else {
-		//check each line
-		foreach($Scan->fping_result as $l) {
-			//split
-			$field = array_filter(explode(" ", $l));
-			//create result
-			$out['alive'][] = $Subnets->transform_to_decimal($field[0]);
-		}
-	}
+    # fetch subnet
+    $subnet = $Subnets->fetch_subnet(null, $argv[2]);
+    $subnet!==false ? : 								  die(json_encode(array("status"=>1, "error"=>"Invalid subnet ID provided")));
+
+    //set exit flag to true
+    $Scan->ping_set_exit(false);
+
+    # set cidr
+    $subnet_cidr = $Subnets->transform_to_dotted($subnet->subnet)."/".$subnet->mask;
+    # execute
+    $retval = $Scan->ping_address_method_fping_subnet ($subnet_cidr);
+
+    # errors
+    if($retval==3)										{ die(json_encode(array("status"=>1, "error"=>"invalid command line arguments"))); }
+    if($retval==4)										{ die(json_encode(array("status"=>1, "error"=>"system call failure"))); }
+
+    # parse result
+    if(sizeof(@$Scan->fping_result)==0)					{ die(json_encode(array("status"=>0, "values"=>array("alive"=>null)))); }
+    else {
+        //check each line
+        foreach($Scan->fping_result as $l) {
+            //split
+            $field = array_filter(explode(" ", $l));
+            //create result
+            $out['alive'][] = $Subnets->transform_to_decimal($field[0]);
+        }
+    }
 }
 # pear / ping
 else {
-	# Create array of addresses to scan
-	$scan_addresses = $Scan->prepare_addresses_to_scan ($argv[1], $argv[2]);
-
-	$z = 0;			//addresses array index
-
-	//run per MAX_THREADS
-	for ($m=0; $m<=sizeof($scan_addresses); $m += $Scan->settings->scanMaxThreads) {
-	    // create threads
-	    $threads = array();
-	    // fork processes
-	    for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof($scan_addresses); $i++) {
-	    	//only if index exists!
-	    	if(isset($scan_addresses[$z])) {
-				//start new thread
-	            $threads[$z] = new Thread( "ping_address" );
-	            $threads[$z]->start( $Subnets->transform_to_dotted($scan_addresses[$z], true) );
-
-	            $z++;				//next index
-			}
-	    }
-	    // wait for all the threads to finish
-	    while( !empty( $threads ) ) {
-	        foreach( $threads as $index => $thread ) {
-	            if( ! $thread->isAlive() ) {
-	            	//online, save to array
-	            	if($thread->getExitCode() == 0) 									{ $out['alive'][] = $scan_addresses[$index]; }
-	            	//ok, but offline
-	            	elseif($thread->getExitCode() == 1 || $thread->getExitCode() == 2) 	{ $out['dead'][]  = $scan_addresses[$index];}
-	            	//error
-	            	else 																{ $out['error'][] = $scan_addresses[$index]; }
-	                //remove thread
-	                unset( $threads[$index] );
-	            }
-	        }
-	        usleep(100000);
-	    }
-	}
+    # Create array of addresses to scan
+    $scan_addresses = $Scan->prepare_addresses_to_scan ($argv[1], $argv[2]);
+
+    $z = 0;			//addresses array index
+
+    //run per MAX_THREADS
+    for ($m=0; $m<=sizeof($scan_addresses); $m += $Scan->settings->scanMaxThreads) {
+        // create threads
+        $threads = array();
+        // fork processes
+        for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof($scan_addresses); $i++) {
+            //only if index exists!
+            if(isset($scan_addresses[$z])) {
+                //start new thread
+                $threads[$z] = new Thread( "ping_address" );
+                $threads[$z]->start( $Subnets->transform_to_dotted($scan_addresses[$z], true) );
+
+                $z++;				//next index
+            }
+        }
+        // wait for all the threads to finish
+        while( !empty( $threads ) ) {
+            foreach( $threads as $index => $thread ) {
+                if( ! $thread->isAlive() ) {
+                    //online, save to array
+                    if($thread->getExitCode() == 0) 									{ $out['alive'][] = $scan_addresses[$index]; }
+                    //ok, but offline
+                    elseif($thread->getExitCode() == 1 || $thread->getExitCode() == 2) 	{ $out['dead'][]  = $scan_addresses[$index];}
+                    //error
+                    else 																{ $out['error'][] = $scan_addresses[$index]; }
+                    //remove thread
+                    unset( $threads[$index] );
+                }
+            }
+            usleep(100000);
+        }
+    }
 }
 
 # compose result - ok

Spacing +52 added lines, -52 removed lines

@@ -27,32 +27,32 @@ 
  */
 
 /* functions */
-require( dirname(__FILE__) . '/../../functions/functions.php');
-require( dirname(__FILE__) . '/../../functions/classes/class.Thread.php');
+require(dirname (__FILE__).'/../../functions/functions.php');
+require(dirname (__FILE__).'/../../functions/classes/class.Thread.php');
 
 # initialize user object
-$Database 	= new Database_PDO;
-$Subnets	= new Subnets ($Database);
-$Scan		= new Scan ($Database);
+$Database = new Database_PDO;
+$Subnets = new Subnets ($Database);
+$Scan = new Scan ($Database);
 
 //set exit flag to true
-$Scan->ping_set_exit(true);
+$Scan->ping_set_exit (true);
 
 /**
  *	Input checks
  */
 
 //script can only be run from cli
-if(php_sapi_name()!="cli") 								{ die(json_encode(array("status"=>1, "error"=>"This script can only be run from cli!"))); }
+if (php_sapi_name () != "cli") { die(json_encode (array ("status"=>1, "error"=>"This script can only be run from cli!"))); }
 //check input parameters
-if(!isset($argv[1]) || !isset($argv[2]))				{ die(json_encode(array("status"=>1, "error"=>"Missing required input parameters"))); }
+if (!isset($argv[1]) || !isset($argv[2])) { die(json_encode (array ("status"=>1, "error"=>"Missing required input parameters"))); }
 // test to see if threading is available
-if( !Thread::available() ) 								{ die(json_encode(array("status"=>1, "error"=>"Threading is required for scanning subnets. Please recompile PHP with pcntl extension"))); }
+if (!Thread::available ()) { die(json_encode (array ("status"=>1, "error"=>"Threading is required for scanning subnets. Please recompile PHP with pcntl extension"))); }
 //check script
-if($argv[1]!="update"&&$argv[1]!="discovery")			{ die(json_encode(array("status"=>1, "error"=>"Invalid scan type!"))); }
+if ($argv[1] != "update" && $argv[1] != "discovery") { die(json_encode (array ("status"=>1, "error"=>"Invalid scan type!"))); }
 //verify cidr
-if(!is_numeric($argv[2])) {
-	if($Subnets->verify_cidr_address($argv[2])!==true)	{ die(json_encode(array("status"=>1, "error"=>"Invalid subnet CIDR address provided"))); }
+if (!is_numeric ($argv[2])) {
+	if ($Subnets->verify_cidr_address ($argv[2]) !== true) { die(json_encode (array ("status"=>1, "error"=>"Invalid subnet CIDR address provided"))); }
 }
 
 /**
@@ -63,62 +63,62 @@ 
 
 
 # fping
-if($Scan->settings->scanPingType=="fping" && $argv[1]=="discovery") {
+if ($Scan->settings->scanPingType == "fping" && $argv[1] == "discovery") {
 	# fetch subnet
-	$subnet = $Subnets->fetch_subnet(null, $argv[2]);
-	$subnet!==false ? : 								  die(json_encode(array("status"=>1, "error"=>"Invalid subnet ID provided")));
+	$subnet = $Subnets->fetch_subnet (null, $argv[2]);
+	$subnet !== false ? : die(json_encode (array ("status"=>1, "error"=>"Invalid subnet ID provided")));
 
 	//set exit flag to true
-	$Scan->ping_set_exit(false);
+	$Scan->ping_set_exit (false);
 
 	# set cidr
-	$subnet_cidr = $Subnets->transform_to_dotted($subnet->subnet)."/".$subnet->mask;
+	$subnet_cidr = $Subnets->transform_to_dotted ($subnet->subnet)."/".$subnet->mask;
 	# execute
 	$retval = $Scan->ping_address_method_fping_subnet ($subnet_cidr);
 
 	# errors
-	if($retval==3)										{ die(json_encode(array("status"=>1, "error"=>"invalid command line arguments"))); }
-	if($retval==4)										{ die(json_encode(array("status"=>1, "error"=>"system call failure"))); }
+	if ($retval == 3) { die(json_encode (array ("status"=>1, "error"=>"invalid command line arguments"))); }
+	if ($retval == 4) { die(json_encode (array ("status"=>1, "error"=>"system call failure"))); }
 
 	# parse result
-	if(sizeof(@$Scan->fping_result)==0)					{ die(json_encode(array("status"=>0, "values"=>array("alive"=>null)))); }
+	if (sizeof (@$Scan->fping_result) == 0) { die(json_encode (array ("status"=>0, "values"=>array ("alive"=>null)))); }
 	else {
 		//check each line
-		foreach($Scan->fping_result as $l) {
+		foreach ($Scan->fping_result as $l) {
 			//split
-			$field = array_filter(explode(" ", $l));
+			$field = array_filter (explode (" ", $l));
 			//create result
-			$out['alive'][] = $Subnets->transform_to_decimal($field[0]);
+			$out['alive'][] = $Subnets->transform_to_decimal ($field[0]);
 		}
 	}
 }
 # fping - status update
-elseif($Scan->settings->scanPingType=="fping") {
+elseif ($Scan->settings->scanPingType == "fping") {
 	# fetch subnet
-	$subnet = $Subnets->fetch_subnet(null, $argv[2]);
-	$subnet!==false ? : 								  die(json_encode(array("status"=>1, "error"=>"Invalid subnet ID provided")));
+	$subnet = $Subnets->fetch_subnet (null, $argv[2]);
+	$subnet !== false ? : die(json_encode (array ("status"=>1, "error"=>"Invalid subnet ID provided")));
 
 	//set exit flag to true
-	$Scan->ping_set_exit(false);
+	$Scan->ping_set_exit (false);
 
 	# set cidr
-	$subnet_cidr = $Subnets->transform_to_dotted($subnet->subnet)."/".$subnet->mask;
+	$subnet_cidr = $Subnets->transform_to_dotted ($subnet->subnet)."/".$subnet->mask;
 	# execute
 	$retval = $Scan->ping_address_method_fping_subnet ($subnet_cidr);
 
 	# errors
-	if($retval==3)										{ die(json_encode(array("status"=>1, "error"=>"invalid command line arguments"))); }
-	if($retval==4)										{ die(json_encode(array("status"=>1, "error"=>"system call failure"))); }
+	if ($retval == 3) { die(json_encode (array ("status"=>1, "error"=>"invalid command line arguments"))); }
+	if ($retval == 4) { die(json_encode (array ("status"=>1, "error"=>"system call failure"))); }
 
 	# parse result
-	if(sizeof(@$Scan->fping_result)==0)					{ die(json_encode(array("status"=>0, "values"=>array("alive"=>null)))); }
+	if (sizeof (@$Scan->fping_result) == 0) { die(json_encode (array ("status"=>0, "values"=>array ("alive"=>null)))); }
 	else {
 		//check each line
-		foreach($Scan->fping_result as $l) {
+		foreach ($Scan->fping_result as $l) {
 			//split
-			$field = array_filter(explode(" ", $l));
+			$field = array_filter (explode (" ", $l));
 			//create result
-			$out['alive'][] = $Subnets->transform_to_decimal($field[0]);
+			$out['alive'][] = $Subnets->transform_to_decimal ($field[0]);
 		}
 	}
 }
@@ -127,38 +127,38 @@ 
 	# Create array of addresses to scan
 	$scan_addresses = $Scan->prepare_addresses_to_scan ($argv[1], $argv[2]);
 
-	$z = 0;			//addresses array index
+	$z = 0; //addresses array index
 
 	//run per MAX_THREADS
-	for ($m=0; $m<=sizeof($scan_addresses); $m += $Scan->settings->scanMaxThreads) {
+	for ($m = 0; $m <= sizeof ($scan_addresses); $m += $Scan->settings->scanMaxThreads) {
 	    // create threads
-	    $threads = array();
+	    $threads = array ();
 	    // fork processes
-	    for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof($scan_addresses); $i++) {
+	    for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof ($scan_addresses); $i++) {
 	    	//only if index exists!
-	    	if(isset($scan_addresses[$z])) {
+	    	if (isset($scan_addresses[$z])) {
 				//start new thread
-	            $threads[$z] = new Thread( "ping_address" );
-	            $threads[$z]->start( $Subnets->transform_to_dotted($scan_addresses[$z], true) );
+	            $threads[$z] = new Thread ("ping_address");
+	            $threads[$z]->start ($Subnets->transform_to_dotted ($scan_addresses[$z], true));
 
-	            $z++;				//next index
+	            $z++; //next index
 			}
 	    }
 	    // wait for all the threads to finish
-	    while( !empty( $threads ) ) {
-	        foreach( $threads as $index => $thread ) {
-	            if( ! $thread->isAlive() ) {
+	    while (!empty($threads)) {
+	        foreach ($threads as $index => $thread) {
+	            if (!$thread->isAlive ()) {
 	            	//online, save to array
-	            	if($thread->getExitCode() == 0) 									{ $out['alive'][] = $scan_addresses[$index]; }
+	            	if ($thread->getExitCode () == 0) { $out['alive'][] = $scan_addresses[$index]; }
 	            	//ok, but offline
-	            	elseif($thread->getExitCode() == 1 || $thread->getExitCode() == 2) 	{ $out['dead'][]  = $scan_addresses[$index];}
+	            	elseif ($thread->getExitCode () == 1 || $thread->getExitCode () == 2) { $out['dead'][] = $scan_addresses[$index]; }
 	            	//error
-	            	else 																{ $out['error'][] = $scan_addresses[$index]; }
+	            	else { $out['error'][] = $scan_addresses[$index]; }
 	                //remove thread
-	                unset( $threads[$index] );
+	                unset($threads[$index]);
 	            }
 	        }
-	        usleep(100000);
+	        usleep (100000);
 	    }
 	}
 }
@@ -168,8 +168,8 @@ 
 $result['values'] = @$out;
 
 # save to json
-$out = json_encode(@$result);
+$out = json_encode (@$result);
 
 # print result
-print_r($out);
+print_r ($out);
 ?>
\ No newline at end of file

functions/scan/subnet-scan-telnet-execute.php

Indentation +11 added lines, -11 removed lines

@@ -61,9 +61,9 @@ 
 
 //reset array, set each IP together with port
 foreach($scan_addresses as $k=>$v) {
-	foreach($ports as $p) {
-		$addresses[] = array("ip"=>$v, "port"=>$p);
-	}
+    foreach($ports as $p) {
+        $addresses[] = array("ip"=>$v, "port"=>$p);
+    }
 }
 
 
@@ -73,22 +73,22 @@ 
     $threads = array();
     //fork processes
     for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof($addresses); $i++) {
-    	//only if index exists!
-    	if(isset($addresses[$z])) {
-			//start new thread
+        //only if index exists!
+        if(isset($addresses[$z])) {
+            //start new thread
             $threads[$z] = new Thread( 'telnet_address' );
             $threads[$z]->start( $Subnets->transform_to_dotted($addresses[$z]['ip']), $addresses[$z]['port'], 2);
             $z++;				//next index
-		}
+        }
     }
     //wait for all the threads to finish
     while( !empty( $threads ) ) {
         foreach( $threads as $index => $thread ) {
             if( ! $thread->isAlive() ) {
-            	//online, save to array
-            	if($thread->getExitCode() == 0) { $out['alive'][$addresses[$index]['ip']][] = $addresses[$index]['port']; }
-            	//ok, but offline
-            	else 							{ $out['dead'][$addresses[$index]['ip']][]  = $addresses[$index]['port'];}
+                //online, save to array
+                if($thread->getExitCode() == 0) { $out['alive'][$addresses[$index]['ip']][] = $addresses[$index]['port']; }
+                //ok, but offline
+                else 							{ $out['dead'][$addresses[$index]['ip']][]  = $addresses[$index]['port'];}
                 //remove thread
                 unset( $threads[$index] );
             }

Spacing +30 added lines, -30 removed lines

@@ -21,28 +21,28 @@ 
  */
 
 /* functions */
-require( dirname(__FILE__) . '/../../functions/functions.php');
-require( dirname(__FILE__) . '/../../functions/classes/class.Thread.php');
+require(dirname (__FILE__).'/../../functions/functions.php');
+require(dirname (__FILE__).'/../../functions/classes/class.Thread.php');
 
 # initialize user object
 $Database 	= new Database_PDO;
-$Subnets	= new Subnets ($Database);
+$Subnets = new Subnets ($Database);
 $Addresses	= new Addresses ($Database);
-$Scan		= new Scan ($Database);
+$Scan = new Scan ($Database);
 
 //set exit flag to true
-$Scan->ping_set_exit(true);
+$Scan->ping_set_exit (true);
 
 /**
  *	Input checks
  */
 
 //script can only be run from cli
-if(php_sapi_name()!="cli") 								{ die(json_encode(array("status"=>1, "error"=>"This script can only be run from cli!"))); }
+if (php_sapi_name () != "cli") { die(json_encode (array ("status"=>1, "error"=>"This script can only be run from cli!"))); }
 //check input parameters
-if(!isset($argv[1]) || !isset($argv[2]))				{ die(json_encode(array("status"=>1, "error"=>"Missing required input parameters"))); }
+if (!isset($argv[1]) || !isset($argv[2])) { die(json_encode (array ("status"=>1, "error"=>"Missing required input parameters"))); }
 // test to see if threading is available
-if( !Thread::available() ) 								{ die(json_encode(array("status"=>1, "error"=>"Threading is required for scanning subnets. Please recompile PHP with pcntl extension"))); }
+if (!Thread::available ()) { die(json_encode (array ("status"=>1, "error"=>"Threading is required for scanning subnets. Please recompile PHP with pcntl extension"))); }
 
 /**
  *	Create array of addresses to scan
@@ -50,50 +50,50 @@ 
 $scan_addresses = $Scan->prepare_addresses_to_scan ("discovery", $argv[1]);
 
 
-$z = 0;			//addresses array index
+$z = 0; //addresses array index
 
 /*
 test
 */
-$ports = explode(";", $argv[2]);
+$ports = explode (";", $argv[2]);
 
-$out = array();
+$out = array ();
 
 //reset array, set each IP together with port
-foreach($scan_addresses as $k=>$v) {
-	foreach($ports as $p) {
-		$addresses[] = array("ip"=>$v, "port"=>$p);
+foreach ($scan_addresses as $k=>$v) {
+	foreach ($ports as $p) {
+		$addresses[] = array ("ip"=>$v, "port"=>$p);
 	}
 }
 
 
 # run per MAX_THREADS
-for ($m=0; $m<=sizeof($addresses); $m += $Scan->settings->scanMaxThreads) {
+for ($m = 0; $m <= sizeof ($addresses); $m += $Scan->settings->scanMaxThreads) {
     //create threads
-    $threads = array();
+    $threads = array ();
     //fork processes
-    for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof($addresses); $i++) {
+    for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof ($addresses); $i++) {
     	//only if index exists!
-    	if(isset($addresses[$z])) {
+    	if (isset($addresses[$z])) {
 			//start new thread
-            $threads[$z] = new Thread( 'telnet_address' );
-            $threads[$z]->start( $Subnets->transform_to_dotted($addresses[$z]['ip']), $addresses[$z]['port'], 2);
-            $z++;				//next index
+            $threads[$z] = new Thread ('telnet_address');
+            $threads[$z]->start ($Subnets->transform_to_dotted ($addresses[$z]['ip']), $addresses[$z]['port'], 2);
+            $z++; //next index
 		}
     }
     //wait for all the threads to finish
-    while( !empty( $threads ) ) {
-        foreach( $threads as $index => $thread ) {
-            if( ! $thread->isAlive() ) {
+    while (!empty($threads)) {
+        foreach ($threads as $index => $thread) {
+            if (!$thread->isAlive ()) {
             	//online, save to array
-            	if($thread->getExitCode() == 0) { $out['alive'][$addresses[$index]['ip']][] = $addresses[$index]['port']; }
+            	if ($thread->getExitCode () == 0) { $out['alive'][$addresses[$index]['ip']][] = $addresses[$index]['port']; }
             	//ok, but offline
-            	else 							{ $out['dead'][$addresses[$index]['ip']][]  = $addresses[$index]['port'];}
+            	else { $out['dead'][$addresses[$index]['ip']][] = $addresses[$index]['port']; }
                 //remove thread
-                unset( $threads[$index] );
+                unset($threads[$index]);
             }
         }
-        usleep(100000);
+        usleep (100000);
     }
 }
 
@@ -102,8 +102,8 @@ 
 $result['values'] = @$out;
 
 # save to json
-$out = json_encode(@$result);
+$out = json_encode (@$result);
 
 # print result
-print_r($out);
+print_r ($out);
 ?>
\ No newline at end of file

functions/scripts/pingCheck.php

Indentation +256 added lines, -256 removed lines

@@ -84,32 +84,32 @@ 
 //fetch all addresses that need to be checked
 foreach($scan_subnets as $s) {
 
-	// if subnet has slaves dont check it
-	if ($Subnets->has_slaves ($s->id) === false) {
-
-		$subnet_addresses = $Addresses->fetch_subnet_addresses ($s->id);
-		//set array for fping
-		if($Scan->icmp_type=="fping")	{
-			$subnets[] = array("id"=>$s->id, "cidr"=>$Subnets->transform_to_dotted($s->subnet)."/".$s->mask);
-		}
-		//save addresses
-		if(sizeof($subnet_addresses)>1) {
-			foreach($subnet_addresses as $a) {
-				//ignore excludePing
-				if($a->excludePing!=1) {
-					//create different array for fping
-					if($Scan->icmp_type=="fping")	{
-						$addresses2[$s->id][$a->id] = array("id"=>$a->id, "ip_addr"=>$a->ip_addr, "description"=>$a->description, "dns_name"=>$a->dns_name, "subnetId"=>$a->subnetId, "lastSeenOld"=>$a->lastSeen, "lastSeen"=>$a->lastSeen);	//used for status check
-						$addresses[$s->id][$a->id]  = $a->ip_addr;																												//used for alive check
-					}
-					else {
-						$addresses[] 		 		= array("id"=>$a->id, "ip_addr"=>$a->ip_addr, "description"=>$a->description, "dns_name"=>$a->dns_name, "subnetId"=>$a->subnetId, "lastSeenOld"=>$a->lastSeen, "lastSeen"=>$a->lastSeen);
-					}
-				}
-			}
-		}
-
-	}
+    // if subnet has slaves dont check it
+    if ($Subnets->has_slaves ($s->id) === false) {
+
+        $subnet_addresses = $Addresses->fetch_subnet_addresses ($s->id);
+        //set array for fping
+        if($Scan->icmp_type=="fping")	{
+            $subnets[] = array("id"=>$s->id, "cidr"=>$Subnets->transform_to_dotted($s->subnet)."/".$s->mask);
+        }
+        //save addresses
+        if(sizeof($subnet_addresses)>1) {
+            foreach($subnet_addresses as $a) {
+                //ignore excludePing
+                if($a->excludePing!=1) {
+                    //create different array for fping
+                    if($Scan->icmp_type=="fping")	{
+                        $addresses2[$s->id][$a->id] = array("id"=>$a->id, "ip_addr"=>$a->ip_addr, "description"=>$a->description, "dns_name"=>$a->dns_name, "subnetId"=>$a->subnetId, "lastSeenOld"=>$a->lastSeen, "lastSeen"=>$a->lastSeen);	//used for status check
+                        $addresses[$s->id][$a->id]  = $a->ip_addr;																												//used for alive check
+                    }
+                    else {
+                        $addresses[] 		 		= array("id"=>$a->id, "ip_addr"=>$a->ip_addr, "description"=>$a->description, "dns_name"=>$a->dns_name, "subnetId"=>$a->subnetId, "lastSeenOld"=>$a->lastSeen, "lastSeen"=>$a->lastSeen);
+                    }
+                }
+            }
+        }
+
+    }
 }
 
 
@@ -124,126 +124,126 @@ 
 
 //different scan for fping
 if($Scan->icmp_type=="fping") {
-	//run per MAX_THREADS
-	for ($m=0; $m<=sizeof($subnets); $m += $Scan->settings->scanMaxThreads) {
-	    // create threads
-	    $threads = array();
-	    //fork processes
-	    for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof($subnets); $i++) {
-	    	//only if index exists!
-	    	if(isset($subnets[$z])) {
-				//start new thread
-	            $threads[$z] = new Thread( 'fping_subnet' );
-	            $threads[$z]->start_fping( $subnets[$z]['cidr'] );
-	            $z++;				//next index
-			}
-	    }
-	    // wait for all the threads to finish
-	    while( !empty( $threads ) ) {
-			foreach($threads as $index => $thread) {
-				$child_pipe = "/tmp/pipe_".$thread->getPid();
-
-				if (file_exists($child_pipe)) {
-					$file_descriptor = fopen( $child_pipe, "r");
-					$child_response = "";
-					while (!feof($file_descriptor)) {
-						$child_response .= fread($file_descriptor, 8192);
-					}
-					//we have the child data in the parent, but serialized:
-					$child_response = unserialize( $child_response );
-					//store
-					$subnets[$index]['result'] = $child_response;
-
-					//now, child is dead, and parent close the pipe
-					unlink( $child_pipe );
-					unset($threads[$index]);
-				}
-			}
-	        usleep(200000);
-	    }
-	}
-
-	//now we must remove all non-existing hosts
-	foreach($subnets as $sk=>$s) {
-		if(sizeof(@$s['result'])>0 && isset($addresses[$s['id']])) {
-			//loop addresses
-			foreach($addresses[$s['id']] as $ak=>$a) {
-				//offline host
-				if(array_search($Subnets->transform_to_dotted($a), $subnets[$sk]['result'])===false) {
-    				// new change = null
-    				$addresses2[$s['id']][$ak]['lastSeenNew'] = NULL;
-					//save to out array
+    //run per MAX_THREADS
+    for ($m=0; $m<=sizeof($subnets); $m += $Scan->settings->scanMaxThreads) {
+        // create threads
+        $threads = array();
+        //fork processes
+        for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof($subnets); $i++) {
+            //only if index exists!
+            if(isset($subnets[$z])) {
+                //start new thread
+                $threads[$z] = new Thread( 'fping_subnet' );
+                $threads[$z]->start_fping( $subnets[$z]['cidr'] );
+                $z++;				//next index
+            }
+        }
+        // wait for all the threads to finish
+        while( !empty( $threads ) ) {
+            foreach($threads as $index => $thread) {
+                $child_pipe = "/tmp/pipe_".$thread->getPid();
+
+                if (file_exists($child_pipe)) {
+                    $file_descriptor = fopen( $child_pipe, "r");
+                    $child_response = "";
+                    while (!feof($file_descriptor)) {
+                        $child_response .= fread($file_descriptor, 8192);
+                    }
+                    //we have the child data in the parent, but serialized:
+                    $child_response = unserialize( $child_response );
+                    //store
+                    $subnets[$index]['result'] = $child_response;
+
+                    //now, child is dead, and parent close the pipe
+                    unlink( $child_pipe );
+                    unset($threads[$index]);
+                }
+            }
+            usleep(200000);
+        }
+    }
+
+    //now we must remove all non-existing hosts
+    foreach($subnets as $sk=>$s) {
+        if(sizeof(@$s['result'])>0 && isset($addresses[$s['id']])) {
+            //loop addresses
+            foreach($addresses[$s['id']] as $ak=>$a) {
+                //offline host
+                if(array_search($Subnets->transform_to_dotted($a), $subnets[$sk]['result'])===false) {
+                    // new change = null
+                    $addresses2[$s['id']][$ak]['lastSeenNew'] = NULL;
+                    //save to out array
                     $address_change[] = $addresses2[$s['id']][$ak];
-				}
-				//online host
-				else {
-    				// new change = now
-    				$addresses2[$s['id']][$ak]['lastSeenNew'] = $nowdate;
-					//save to out array
+                }
+                //online host
+                else {
+                    // new change = now
+                    $addresses2[$s['id']][$ak]['lastSeenNew'] = $nowdate;
+                    //save to out array
                     $address_change[] = $addresses2[$s['id']][$ak];
                     //update status
                     $Scan->ping_update_lastseen ($addresses2[$s['id']][$ak]['id'], $nowdate);
-				}
-			}
-		}
-	}
+                }
+            }
+        }
+    }
 }
 //ping, pear
 else {
-	//run per MAX_THREADS
-	for ($m=0; $m<=sizeof($addresses); $m += $Scan->settings->scanMaxThreads) {
-	    // create threads
-	    $threads = array();
-	    //fork processes
-	    for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof($addresses); $i++) {
-	    	//only if index exists!
-	    	if(isset($addresses[$z])) {
-				//start new thread
-	            $threads[$z] = new Thread( 'ping_address' );
-	            $threads[$z]->start($Subnets->transform_to_dotted($addresses[$z]['ip_addr']));
-	            $z++;				//next index
-			}
-	    }
-	    // wait for all the threads to finish
-	    while( !empty( $threads ) ) {
-	        foreach( $threads as $index => $thread ) {
-	            if( ! $thread->isAlive() ) {
-	            	//online
-	            	if($thread->getExitCode() == 0) {
-    	            	// set new available time
-    	            	$addresses[$index]['lastSeenNew'] =  $nowdate;
+    //run per MAX_THREADS
+    for ($m=0; $m<=sizeof($addresses); $m += $Scan->settings->scanMaxThreads) {
+        // create threads
+        $threads = array();
+        //fork processes
+        for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof($addresses); $i++) {
+            //only if index exists!
+            if(isset($addresses[$z])) {
+                //start new thread
+                $threads[$z] = new Thread( 'ping_address' );
+                $threads[$z]->start($Subnets->transform_to_dotted($addresses[$z]['ip_addr']));
+                $z++;				//next index
+            }
+        }
+        // wait for all the threads to finish
+        while( !empty( $threads ) ) {
+            foreach( $threads as $index => $thread ) {
+                if( ! $thread->isAlive() ) {
+                    //online
+                    if($thread->getExitCode() == 0) {
+                        // set new available time
+                        $addresses[$index]['lastSeenNew'] =  $nowdate;
                         $address_change[$index] = $addresses[$index];	 				//change to online
-	            	}
-	            	//offline
-	            	else {
-    	            	// set nw online
-    	            	$addresses[$index]['lastSeenNew'] =  NULL;
+                    }
+                    //offline
+                    else {
+                        // set nw online
+                        $addresses[$index]['lastSeenNew'] =  NULL;
                         $address_change[$index] = $addresses[$index];	 				//change to online
-					}
-	            	//save exit code for host
-	                $addresses[$index]['newStatus'] = $thread->getExitCode();
-	                //remove thread
-	                unset( $threads[$index] );
-	            }
-	        }
-	        usleep(200000);
-	    }
-	}
-
-	//update statuses for online
-
-	# re-initialize classes
-	$Database = new Database_PDO;
-	$Scan = new Scan ($Database, $Subnets->settings);
-	// reset debugging
-	$Scan->reset_debugging(false);
-
-	# update all active statuses
-	foreach($addresses as $k=>$a) {
-		if($a['newStatus']==0) {
-			$Scan->ping_update_lastseen ($a['id'], $nowdate);
-		}
-	}
+                    }
+                    //save exit code for host
+                    $addresses[$index]['newStatus'] = $thread->getExitCode();
+                    //remove thread
+                    unset( $threads[$index] );
+                }
+            }
+            usleep(200000);
+        }
+    }
+
+    //update statuses for online
+
+    # re-initialize classes
+    $Database = new Database_PDO;
+    $Scan = new Scan ($Database, $Subnets->settings);
+    // reset debugging
+    $Scan->reset_debugging(false);
+
+    # update all active statuses
+    foreach($addresses as $k=>$a) {
+        if($a['newStatus']==0) {
+            $Scan->ping_update_lastseen ($a['id'], $nowdate);
+        }
+    }
 }
 
 
@@ -293,125 +293,125 @@ 
 # all done, mail diff?
 if(sizeof($address_change)>0 && $send_mail) {
 
-	# remove old classes
-	unset($Database, $Subnets, $Addresses, $Tools, $Scan, $Result);
-
-	$Database 	= new Database_PDO;
-	$Subnets	= new Subnets ($Database);
-	$Addresses	= new Addresses ($Database);
-	$Tools		= new Tools ($Database);
-	$Scan		= new Scan ($Database);
-	$Result		= new Result();
-
-	// set exit flag to true
-	$Scan->ping_set_exit(true);
-	// set debugging
-	$Scan->reset_debugging(false);
-
-
-	# check for recipients
-	foreach($Tools->fetch_multiple_objects ("users", "role", "Administrator") as $admin) {
-		if($admin->mailNotify=="Yes") {
-			$recepients[] = array("name"=>$admin->real_name, "email"=>$admin->email);
-		}
-	}
-	# none?
-	if(!isset($recepients))	{ die(); }
-
-	# fetch mailer settings
-	$mail_settings = $Tools->fetch_object("settingsMail", "id", 1);
-	# fake user object, needed for create_link
-	$User = new StdClass();
-	@$User->settings->prettyLinks = $Scan->settings->prettyLinks;
-
-	# initialize mailer
-	$phpipam_mail = new phpipam_mail($Scan->settings, $mail_settings);
-	$phpipam_mail->initialize_mailer();
-
-	// set subject
-	$subject	= "phpIPAM IP state change ".$nowdate;
-
-	//html
-	$content[] = "<h3>phpIPAM host changes</h3>";
-	$content[] = "<table style='margin-left:10px;margin-top:5px;width:auto;padding:0px;border-collapse:collapse;border:1px solid gray;'>";
-	$content[] = "<tr>";
-	$content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>IP</th>";
-	$content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>Description</th>";
-	$content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>Hostname</th>";
-	$content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>Subnet</th>";
-	$content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>Section</th>";
-	$content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>last seen</th>";
-	$content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>old status</th>";
-	$content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>new status</th>";
-	$content[] = "</tr>";
-
-	//plain
-	$content_plain[] = "phpIPAM host changes \r\n------------------------------";
-
-	//Changes
-	foreach($address_change as $change) {
-		//reformat statuses
-		if($change['oldStatus'] == 0) {
-			$oldStatus = "<font style='color:#04B486'>Online</font>";
-			$newStatus = "<font style='color:#DF0101'>Offline</font>";
-		}
-		else {
-			$oldStatus = "<font style='color:#DF0101'>Offline</font>";
-			$newStatus = "<font style='color:#04B486'>Online</font>";
-		}
-
-		//set subnet
-		$subnet 	 = $Subnets->fetch_subnet(null, $change['subnetId']);
-		//set section
-		$section 	 = $Tools->fetch_object("sections", "id", $subnet->sectionId);
-		//ago
-		if(is_null($change['lastSeen']) || $change['lastSeen']=="0000-00-00 00:00:00") {
-			$ago	  = "never";
-		} else {
-			$timeDiff = $now - strtotime($change['lastSeen']);
-			$ago 	  = $change['lastSeen']." (".$Result->sec2hms($timeDiff)." ago)";
-		}
-
-		//content
-		$content[] = "<tr>";
-		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'><a href='".rtrim($Scan->settings->siteURL, "/")."".create_link("subnets",$section->id,$subnet->id)."'>".$Subnets->transform_to_dotted($change['ip_addr'])."</a></td>";
-		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$change[description]</td>";
-		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$change[dns_name]</td>";
-		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'><a href='".rtrim($Scan->settings->siteURL, "/")."".create_link("subnets",$section->id,$subnet->id)."'>".$Subnets->transform_to_dotted($subnet->subnet)."/".$subnet->mask." - ".$subnet->description."</a></td>";
-		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'><a href='".rtrim($Scan->settings->siteURL, "/")."".create_link("subnets",$section->id)."'>$section->name $section->description</a></td>";
-		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$ago</td>";
-		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$oldStatus</td>";
-		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$newStatus</td>";
-		$content[] = "</tr>";
-
-		//plain content
-		$content_plain[] = "\t * ".$Subnets->transform_to_dotted($change['ip_addr'])." (".$Subnets->transform_to_dotted($subnet->subnet)."/".$subnet->mask.")\r\n \t  ".strip_tags($oldStatus)." => ".strip_tags($newStatus);
-
-	}
-	$content[] = "</table>";
-
-
-	# set content
-	$content 		= $phpipam_mail->generate_message (implode("\r\n", $content));
-	$content_plain 	= implode("\r\n",$content_plain);
-
-	# try to send
-	try {
-		$phpipam_mail->Php_mailer->setFrom($mail_settings->mAdminMail, $mail_settings->mAdminName);
-		//add all admins to CC
-		foreach($recepients as $admin) {
-			$phpipam_mail->Php_mailer->addAddress(addslashes($admin['email']), addslashes($admin['name']));
-		}
-		$phpipam_mail->Php_mailer->Subject = $subject;
-		$phpipam_mail->Php_mailer->msgHTML($content);
-		$phpipam_mail->Php_mailer->AltBody = $content_plain;
-		//send
-		$phpipam_mail->Php_mailer->send();
-	} catch (phpmailerException $e) {
-		$Result->show_cli("Mailer Error: ".$e->errorMessage(), true);
-	} catch (Exception $e) {
-		$Result->show_cli("Mailer Error: ".$e->errorMessage(), true);
-	}
+    # remove old classes
+    unset($Database, $Subnets, $Addresses, $Tools, $Scan, $Result);
+
+    $Database 	= new Database_PDO;
+    $Subnets	= new Subnets ($Database);
+    $Addresses	= new Addresses ($Database);
+    $Tools		= new Tools ($Database);
+    $Scan		= new Scan ($Database);
+    $Result		= new Result();
+
+    // set exit flag to true
+    $Scan->ping_set_exit(true);
+    // set debugging
+    $Scan->reset_debugging(false);
+
+
+    # check for recipients
+    foreach($Tools->fetch_multiple_objects ("users", "role", "Administrator") as $admin) {
+        if($admin->mailNotify=="Yes") {
+            $recepients[] = array("name"=>$admin->real_name, "email"=>$admin->email);
+        }
+    }
+    # none?
+    if(!isset($recepients))	{ die(); }
+
+    # fetch mailer settings
+    $mail_settings = $Tools->fetch_object("settingsMail", "id", 1);
+    # fake user object, needed for create_link
+    $User = new StdClass();
+    @$User->settings->prettyLinks = $Scan->settings->prettyLinks;
+
+    # initialize mailer
+    $phpipam_mail = new phpipam_mail($Scan->settings, $mail_settings);
+    $phpipam_mail->initialize_mailer();
+
+    // set subject
+    $subject	= "phpIPAM IP state change ".$nowdate;
+
+    //html
+    $content[] = "<h3>phpIPAM host changes</h3>";
+    $content[] = "<table style='margin-left:10px;margin-top:5px;width:auto;padding:0px;border-collapse:collapse;border:1px solid gray;'>";
+    $content[] = "<tr>";
+    $content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>IP</th>";
+    $content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>Description</th>";
+    $content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>Hostname</th>";
+    $content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>Subnet</th>";
+    $content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>Section</th>";
+    $content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>last seen</th>";
+    $content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>old status</th>";
+    $content[] = "	<th style='padding:3px 8px;border:1px solid silver;border-bottom:2px solid gray;'>new status</th>";
+    $content[] = "</tr>";
+
+    //plain
+    $content_plain[] = "phpIPAM host changes \r\n------------------------------";
+
+    //Changes
+    foreach($address_change as $change) {
+        //reformat statuses
+        if($change['oldStatus'] == 0) {
+            $oldStatus = "<font style='color:#04B486'>Online</font>";
+            $newStatus = "<font style='color:#DF0101'>Offline</font>";
+        }
+        else {
+            $oldStatus = "<font style='color:#DF0101'>Offline</font>";
+            $newStatus = "<font style='color:#04B486'>Online</font>";
+        }
+
+        //set subnet
+        $subnet 	 = $Subnets->fetch_subnet(null, $change['subnetId']);
+        //set section
+        $section 	 = $Tools->fetch_object("sections", "id", $subnet->sectionId);
+        //ago
+        if(is_null($change['lastSeen']) || $change['lastSeen']=="0000-00-00 00:00:00") {
+            $ago	  = "never";
+        } else {
+            $timeDiff = $now - strtotime($change['lastSeen']);
+            $ago 	  = $change['lastSeen']." (".$Result->sec2hms($timeDiff)." ago)";
+        }
+
+        //content
+        $content[] = "<tr>";
+        $content[] = "	<td style='padding:3px 8px;border:1px solid silver;'><a href='".rtrim($Scan->settings->siteURL, "/")."".create_link("subnets",$section->id,$subnet->id)."'>".$Subnets->transform_to_dotted($change['ip_addr'])."</a></td>";
+        $content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$change[description]</td>";
+        $content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$change[dns_name]</td>";
+        $content[] = "	<td style='padding:3px 8px;border:1px solid silver;'><a href='".rtrim($Scan->settings->siteURL, "/")."".create_link("subnets",$section->id,$subnet->id)."'>".$Subnets->transform_to_dotted($subnet->subnet)."/".$subnet->mask." - ".$subnet->description."</a></td>";
+        $content[] = "	<td style='padding:3px 8px;border:1px solid silver;'><a href='".rtrim($Scan->settings->siteURL, "/")."".create_link("subnets",$section->id)."'>$section->name $section->description</a></td>";
+        $content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$ago</td>";
+        $content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$oldStatus</td>";
+        $content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$newStatus</td>";
+        $content[] = "</tr>";
+
+        //plain content
+        $content_plain[] = "\t * ".$Subnets->transform_to_dotted($change['ip_addr'])." (".$Subnets->transform_to_dotted($subnet->subnet)."/".$subnet->mask.")\r\n \t  ".strip_tags($oldStatus)." => ".strip_tags($newStatus);
+
+    }
+    $content[] = "</table>";
+
+
+    # set content
+    $content 		= $phpipam_mail->generate_message (implode("\r\n", $content));
+    $content_plain 	= implode("\r\n",$content_plain);
+
+    # try to send
+    try {
+        $phpipam_mail->Php_mailer->setFrom($mail_settings->mAdminMail, $mail_settings->mAdminName);
+        //add all admins to CC
+        foreach($recepients as $admin) {
+            $phpipam_mail->Php_mailer->addAddress(addslashes($admin['email']), addslashes($admin['name']));
+        }
+        $phpipam_mail->Php_mailer->Subject = $subject;
+        $phpipam_mail->Php_mailer->msgHTML($content);
+        $phpipam_mail->Php_mailer->AltBody = $content_plain;
+        //send
+        $phpipam_mail->Php_mailer->send();
+    } catch (phpmailerException $e) {
+        $Result->show_cli("Mailer Error: ".$e->errorMessage(), true);
+    } catch (Exception $e) {
+        $Result->show_cli("Mailer Error: ".$e->errorMessage(), true);
+    }
 }
 
 ?>
\ No newline at end of file

Braces +5 added lines, -4 removed lines

@@ -89,7 +89,7 @@ 
 
 		$subnet_addresses = $Addresses->fetch_subnet_addresses ($s->id);
 		//set array for fping
-		if($Scan->icmp_type=="fping")	{
+		if($Scan->icmp_type=="fping") {
 			$subnets[] = array("id"=>$s->id, "cidr"=>$Subnets->transform_to_dotted($s->subnet)."/".$s->mask);
 		}
 		//save addresses
@@ -98,7 +98,7 @@ 
 				//ignore excludePing
 				if($a->excludePing!=1) {
 					//create different array for fping
-					if($Scan->icmp_type=="fping")	{
+					if($Scan->icmp_type=="fping") {
 						$addresses2[$s->id][$a->id] = array("id"=>$a->id, "ip_addr"=>$a->ip_addr, "description"=>$a->description, "dns_name"=>$a->dns_name, "subnetId"=>$a->subnetId, "lastSeenOld"=>$a->lastSeen, "lastSeen"=>$a->lastSeen);	//used for status check
 						$addresses[$s->id][$a->id]  = $a->ip_addr;																												//used for alive check
 					}
@@ -269,7 +269,7 @@ 
     // now offline, and diff > offline period, do checks
     elseif($change['lastSeenNew']==NULL && $deviceDiff >= (int) $statuses[1]) {
         // if not already reported
-        if ($deviceDiff <= ((int) $statuses[1] + $agentDiff))  {
+        if ($deviceDiff <= ((int) $statuses[1] + $agentDiff)) {
             $address_change[$k]['oldStatus'] = 0;
             $address_change[$k]['newStatus'] = 2;
         }
@@ -367,7 +367,8 @@ 
 		//ago
 		if(is_null($change['lastSeen']) || $change['lastSeen']=="0000-00-00 00:00:00") {
 			$ago	  = "never";
-		} else {
+		}
+		else {
 			$timeDiff = $now - strtotime($change['lastSeen']);
 			$ago 	  = $change['lastSeen']." (".$Result->sec2hms($timeDiff)." ago)";
 		}

Spacing +120 added lines, -120 removed lines

@@ -31,79 +31,79 @@ 
 
 
 # include required scripts
-require( dirname(__FILE__) . '/../functions.php' );
-require( dirname(__FILE__) . '/../../functions/classes/class.Thread.php');
+require(dirname (__FILE__).'/../functions.php');
+require(dirname (__FILE__).'/../../functions/classes/class.Thread.php');
 
 # initialize objects
 $Database 	= new Database_PDO;
-$Subnets	= new Subnets ($Database);
+$Subnets = new Subnets ($Database);
 $Addresses	= new Addresses ($Database);
-$Tools		= new Tools ($Database);
-$Scan		= new Scan ($Database);
-$Result		= new Result();
+$Tools = new Tools ($Database);
+$Scan = new Scan ($Database);
+$Result = new Result ();
 
 // set exit flag to true
-$Scan->ping_set_exit(true);
+$Scan->ping_set_exit (true);
 // set debugging
-$Scan->reset_debugging(false);
+$Scan->reset_debugging (false);
 // fetch agent
-$agent = $Tools->fetch_object("scanAgents", "id", 1);
+$agent = $Tools->fetch_object ("scanAgents", "id", 1);
 // change scan type?
 // $Scan->reset_scan_method ("fping");
 // set ping statuses
-$statuses = explode(";", $Scan->settings->pingStatus);
+$statuses = explode (";", $Scan->settings->pingStatus);
 // set mail override flag
 $send_mail = true;
 
 // response for mailing
-$address_change = array();			// Array with differences, can be used to email to admins
+$address_change = array (); // Array with differences, can be used to email to admins
 
 // set now for whole script
-$now     = time();
+$now     = time ();
 $nowdate = date ("Y-m-d H:i:s");
 
 
 // script can only be run from cli
-if(php_sapi_name()!="cli") 						{ die("This script can only be run from cli!"); }
+if (php_sapi_name () != "cli") { die("This script can only be run from cli!"); }
 // test to see if threading is available
-if(!Thread::available()) 						{ die("Threading is required for scanning subnets. Please recompile PHP with pcntl extension"); }
+if (!Thread::available ()) { die("Threading is required for scanning subnets. Please recompile PHP with pcntl extension"); }
 // verify ping path
-if ($Scan->icmp_type=="ping") {
-if(!file_exists($Scan->settings->scanPingPath)) { die("Invalid ping path!"); }
+if ($Scan->icmp_type == "ping") {
+if (!file_exists ($Scan->settings->scanPingPath)) { die("Invalid ping path!"); }
 }
 // verify fping path
-if ($Scan->icmp_type=="fping") {
-if(!file_exists($Scan->settings->scanFPingPath)){ die("Invalid fping path!"); }
+if ($Scan->icmp_type == "fping") {
+if (!file_exists ($Scan->settings->scanFPingPath)) { die("Invalid fping path!"); }
 }
 
 
 //first fetch all subnets to be scanned
 $scan_subnets = $Subnets->fetch_all_subnets_for_pingCheck (1);
-if($Scan->debugging)							{ print_r($scan_subnets); }
-if($scan_subnets===false) 						{ die("No subnets are marked for checking status updates"); }
+if ($Scan->debugging) { print_r ($scan_subnets); }
+if ($scan_subnets === false) { die("No subnets are marked for checking status updates"); }
 //fetch all addresses that need to be checked
-foreach($scan_subnets as $s) {
+foreach ($scan_subnets as $s) {
 
 	// if subnet has slaves dont check it
 	if ($Subnets->has_slaves ($s->id) === false) {
 
 		$subnet_addresses = $Addresses->fetch_subnet_addresses ($s->id);
 		//set array for fping
-		if($Scan->icmp_type=="fping")	{
-			$subnets[] = array("id"=>$s->id, "cidr"=>$Subnets->transform_to_dotted($s->subnet)."/".$s->mask);
+		if ($Scan->icmp_type == "fping") {
+			$subnets[] = array ("id"=>$s->id, "cidr"=>$Subnets->transform_to_dotted ($s->subnet)."/".$s->mask);
 		}
 		//save addresses
-		if(sizeof($subnet_addresses)>1) {
-			foreach($subnet_addresses as $a) {
+		if (sizeof ($subnet_addresses) > 1) {
+			foreach ($subnet_addresses as $a) {
 				//ignore excludePing
-				if($a->excludePing!=1) {
+				if ($a->excludePing != 1) {
 					//create different array for fping
-					if($Scan->icmp_type=="fping")	{
-						$addresses2[$s->id][$a->id] = array("id"=>$a->id, "ip_addr"=>$a->ip_addr, "description"=>$a->description, "dns_name"=>$a->dns_name, "subnetId"=>$a->subnetId, "lastSeenOld"=>$a->lastSeen, "lastSeen"=>$a->lastSeen);	//used for status check
-						$addresses[$s->id][$a->id]  = $a->ip_addr;																												//used for alive check
+					if ($Scan->icmp_type == "fping") {
+						$addresses2[$s->id][$a->id] = array ("id"=>$a->id, "ip_addr"=>$a->ip_addr, "description"=>$a->description, "dns_name"=>$a->dns_name, "subnetId"=>$a->subnetId, "lastSeenOld"=>$a->lastSeen, "lastSeen"=>$a->lastSeen); //used for status check
+						$addresses[$s->id][$a->id]  = $a->ip_addr; //used for alive check
 					}
 					else {
-						$addresses[] 		 		= array("id"=>$a->id, "ip_addr"=>$a->ip_addr, "description"=>$a->description, "dns_name"=>$a->dns_name, "subnetId"=>$a->subnetId, "lastSeenOld"=>$a->lastSeen, "lastSeen"=>$a->lastSeen);
+						$addresses[] = array ("id"=>$a->id, "ip_addr"=>$a->ip_addr, "description"=>$a->description, "dns_name"=>$a->dns_name, "subnetId"=>$a->subnetId, "lastSeenOld"=>$a->lastSeen, "lastSeen"=>$a->lastSeen);
 					}
 				}
 			}
@@ -113,63 +113,63 @@ 
 }
 
 
-if($Scan->debugging)							{ print "Using $Scan->icmp_type\n--------------------\n\n";print_r($addresses); }
+if ($Scan->debugging) { print "Using $Scan->icmp_type\n--------------------\n\n"; print_r ($addresses); }
 //if none die
-if(!isset($addresses))							{ die("No addresses to check"); }
+if (!isset($addresses)) { die("No addresses to check"); }
 
 
 /* scan */
 
-$z = 0;			//addresses array index
+$z = 0; //addresses array index
 
 //different scan for fping
-if($Scan->icmp_type=="fping") {
+if ($Scan->icmp_type == "fping") {
 	//run per MAX_THREADS
-	for ($m=0; $m<=sizeof($subnets); $m += $Scan->settings->scanMaxThreads) {
+	for ($m = 0; $m <= sizeof ($subnets); $m += $Scan->settings->scanMaxThreads) {
 	    // create threads
-	    $threads = array();
+	    $threads = array ();
 	    //fork processes
-	    for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof($subnets); $i++) {
+	    for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof ($subnets); $i++) {
 	    	//only if index exists!
-	    	if(isset($subnets[$z])) {
+	    	if (isset($subnets[$z])) {
 				//start new thread
-	            $threads[$z] = new Thread( 'fping_subnet' );
-	            $threads[$z]->start_fping( $subnets[$z]['cidr'] );
-	            $z++;				//next index
+	            $threads[$z] = new Thread ('fping_subnet');
+	            $threads[$z]->start_fping ($subnets[$z]['cidr']);
+	            $z++; //next index
 			}
 	    }
 	    // wait for all the threads to finish
-	    while( !empty( $threads ) ) {
-			foreach($threads as $index => $thread) {
-				$child_pipe = "/tmp/pipe_".$thread->getPid();
+	    while (!empty($threads)) {
+			foreach ($threads as $index => $thread) {
+				$child_pipe = "/tmp/pipe_".$thread->getPid ();
 
-				if (file_exists($child_pipe)) {
-					$file_descriptor = fopen( $child_pipe, "r");
+				if (file_exists ($child_pipe)) {
+					$file_descriptor = fopen ($child_pipe, "r");
 					$child_response = "";
-					while (!feof($file_descriptor)) {
-						$child_response .= fread($file_descriptor, 8192);
+					while (!feof ($file_descriptor)) {
+						$child_response .= fread ($file_descriptor, 8192);
 					}
 					//we have the child data in the parent, but serialized:
-					$child_response = unserialize( $child_response );
+					$child_response = unserialize ($child_response);
 					//store
 					$subnets[$index]['result'] = $child_response;
 
 					//now, child is dead, and parent close the pipe
-					unlink( $child_pipe );
+					unlink ($child_pipe);
 					unset($threads[$index]);
 				}
 			}
-	        usleep(200000);
+	        usleep (200000);
 	    }
 	}
 
 	//now we must remove all non-existing hosts
-	foreach($subnets as $sk=>$s) {
-		if(sizeof(@$s['result'])>0 && isset($addresses[$s['id']])) {
+	foreach ($subnets as $sk=>$s) {
+		if (sizeof (@$s['result']) > 0 && isset($addresses[$s['id']])) {
 			//loop addresses
-			foreach($addresses[$s['id']] as $ak=>$a) {
+			foreach ($addresses[$s['id']] as $ak=>$a) {
 				//offline host
-				if(array_search($Subnets->transform_to_dotted($a), $subnets[$sk]['result'])===false) {
+				if (array_search ($Subnets->transform_to_dotted ($a), $subnets[$sk]['result']) === false) {
     				// new change = null
     				$addresses2[$s['id']][$ak]['lastSeenNew'] = NULL;
 					//save to out array
@@ -191,42 +191,42 @@ 
 //ping, pear
 else {
 	//run per MAX_THREADS
-	for ($m=0; $m<=sizeof($addresses); $m += $Scan->settings->scanMaxThreads) {
+	for ($m = 0; $m <= sizeof ($addresses); $m += $Scan->settings->scanMaxThreads) {
 	    // create threads
-	    $threads = array();
+	    $threads = array ();
 	    //fork processes
-	    for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof($addresses); $i++) {
+	    for ($i = 0; $i <= $Scan->settings->scanMaxThreads && $i <= sizeof ($addresses); $i++) {
 	    	//only if index exists!
-	    	if(isset($addresses[$z])) {
+	    	if (isset($addresses[$z])) {
 				//start new thread
-	            $threads[$z] = new Thread( 'ping_address' );
-	            $threads[$z]->start($Subnets->transform_to_dotted($addresses[$z]['ip_addr']));
-	            $z++;				//next index
+	            $threads[$z] = new Thread ('ping_address');
+	            $threads[$z]->start ($Subnets->transform_to_dotted ($addresses[$z]['ip_addr']));
+	            $z++; //next index
 			}
 	    }
 	    // wait for all the threads to finish
-	    while( !empty( $threads ) ) {
-	        foreach( $threads as $index => $thread ) {
-	            if( ! $thread->isAlive() ) {
+	    while (!empty($threads)) {
+	        foreach ($threads as $index => $thread) {
+	            if (!$thread->isAlive ()) {
 	            	//online
-	            	if($thread->getExitCode() == 0) {
+	            	if ($thread->getExitCode () == 0) {
     	            	// set new available time
-    	            	$addresses[$index]['lastSeenNew'] =  $nowdate;
-                        $address_change[$index] = $addresses[$index];	 				//change to online
+    	            	$addresses[$index]['lastSeenNew'] = $nowdate;
+                        $address_change[$index] = $addresses[$index]; //change to online
 	            	}
 	            	//offline
 	            	else {
     	            	// set nw online
-    	            	$addresses[$index]['lastSeenNew'] =  NULL;
-                        $address_change[$index] = $addresses[$index];	 				//change to online
+    	            	$addresses[$index]['lastSeenNew'] = NULL;
+                        $address_change[$index] = $addresses[$index]; //change to online
 					}
 	            	//save exit code for host
-	                $addresses[$index]['newStatus'] = $thread->getExitCode();
+	                $addresses[$index]['newStatus'] = $thread->getExitCode ();
 	                //remove thread
-	                unset( $threads[$index] );
+	                unset($threads[$index]);
 	            }
 	        }
-	        usleep(200000);
+	        usleep (200000);
 	    }
 	}
 
@@ -236,11 +236,11 @@ 
 	$Database = new Database_PDO;
 	$Scan = new Scan ($Database, $Subnets->settings);
 	// reset debugging
-	$Scan->reset_debugging(false);
+	$Scan->reset_debugging (false);
 
 	# update all active statuses
-	foreach($addresses as $k=>$a) {
-		if($a['newStatus']==0) {
+	foreach ($addresses as $k=>$a) {
+		if ($a['newStatus'] == 0) {
 			$Scan->ping_update_lastseen ($a['id'], $nowdate);
 		}
 	}
@@ -255,21 +255,21 @@ 
 // loop
 foreach ($address_change as $k=>$change) {
     // null old - set to epoch time
-    if (strtotime($change['lastSeenOld'])===false)  { $change['lastSeenOld'] = date("Y-m-d H:i:s", 0); }
+    if (strtotime ($change['lastSeenOld']) === false) { $change['lastSeenOld'] = date ("Y-m-d H:i:s", 0); }
 
     // set general diffs
-    $deviceDiff = $now - strtotime($change['lastSeenOld']);	        // now - device last seen
-    $agentDiff  = $now - strtotime($agent->last_access);	        // now - last agent check
+    $deviceDiff = $now - strtotime ($change['lastSeenOld']); // now - device last seen
+    $agentDiff  = $now - strtotime ($agent->last_access); // now - last agent check
 
     // if now online and old offline send mail
-    if ($change['lastSeenNew']!=NULL && $deviceDiff >= (int) $statuses[1]) {
+    if ($change['lastSeenNew'] != NULL && $deviceDiff >= (int) $statuses[1]) {
         $address_change[$k]['oldStatus'] = 2;
         $address_change[$k]['newStatus'] = 0;
     }
     // now offline, and diff > offline period, do checks
-    elseif($change['lastSeenNew']==NULL && $deviceDiff >= (int) $statuses[1]) {
+    elseif ($change['lastSeenNew'] == NULL && $deviceDiff >= (int) $statuses[1]) {
         // if not already reported
-        if ($deviceDiff <= ((int) $statuses[1] + $agentDiff))  {
+        if ($deviceDiff <= ((int) $statuses[1] + $agentDiff)) {
             $address_change[$k]['oldStatus'] = 0;
             $address_change[$k]['newStatus'] = 2;
         }
@@ -288,48 +288,48 @@ 
 
 
 # print change
-if($Scan->debugging)							{ print "\nAddress changes:\n----------\n"; print_r($address_change); }
+if ($Scan->debugging) { print "\nAddress changes:\n----------\n"; print_r ($address_change); }
 
 # all done, mail diff?
-if(sizeof($address_change)>0 && $send_mail) {
+if (sizeof ($address_change) > 0 && $send_mail) {
 
 	# remove old classes
 	unset($Database, $Subnets, $Addresses, $Tools, $Scan, $Result);
 
 	$Database 	= new Database_PDO;
-	$Subnets	= new Subnets ($Database);
+	$Subnets = new Subnets ($Database);
 	$Addresses	= new Addresses ($Database);
-	$Tools		= new Tools ($Database);
-	$Scan		= new Scan ($Database);
-	$Result		= new Result();
+	$Tools = new Tools ($Database);
+	$Scan = new Scan ($Database);
+	$Result = new Result ();
 
 	// set exit flag to true
-	$Scan->ping_set_exit(true);
+	$Scan->ping_set_exit (true);
 	// set debugging
-	$Scan->reset_debugging(false);
+	$Scan->reset_debugging (false);
 
 
 	# check for recipients
-	foreach($Tools->fetch_multiple_objects ("users", "role", "Administrator") as $admin) {
-		if($admin->mailNotify=="Yes") {
-			$recepients[] = array("name"=>$admin->real_name, "email"=>$admin->email);
+	foreach ($Tools->fetch_multiple_objects ("users", "role", "Administrator") as $admin) {
+		if ($admin->mailNotify == "Yes") {
+			$recepients[] = array ("name"=>$admin->real_name, "email"=>$admin->email);
 		}
 	}
 	# none?
-	if(!isset($recepients))	{ die(); }
+	if (!isset($recepients)) { die(); }
 
 	# fetch mailer settings
-	$mail_settings = $Tools->fetch_object("settingsMail", "id", 1);
+	$mail_settings = $Tools->fetch_object ("settingsMail", "id", 1);
 	# fake user object, needed for create_link
-	$User = new StdClass();
+	$User = new StdClass ();
 	@$User->settings->prettyLinks = $Scan->settings->prettyLinks;
 
 	# initialize mailer
-	$phpipam_mail = new phpipam_mail($Scan->settings, $mail_settings);
-	$phpipam_mail->initialize_mailer();
+	$phpipam_mail = new phpipam_mail ($Scan->settings, $mail_settings);
+	$phpipam_mail->initialize_mailer ();
 
 	// set subject
-	$subject	= "phpIPAM IP state change ".$nowdate;
+	$subject = "phpIPAM IP state change ".$nowdate;
 
 	//html
 	$content[] = "<h3>phpIPAM host changes</h3>";
@@ -349,9 +349,9 @@ 
 	$content_plain[] = "phpIPAM host changes \r\n------------------------------";
 
 	//Changes
-	foreach($address_change as $change) {
+	foreach ($address_change as $change) {
 		//reformat statuses
-		if($change['oldStatus'] == 0) {
+		if ($change['oldStatus'] == 0) {
 			$oldStatus = "<font style='color:#04B486'>Online</font>";
 			$newStatus = "<font style='color:#DF0101'>Offline</font>";
 		}
@@ -361,56 +361,56 @@ 
 		}
 
 		//set subnet
-		$subnet 	 = $Subnets->fetch_subnet(null, $change['subnetId']);
+		$subnet = $Subnets->fetch_subnet (null, $change['subnetId']);
 		//set section
-		$section 	 = $Tools->fetch_object("sections", "id", $subnet->sectionId);
+		$section = $Tools->fetch_object ("sections", "id", $subnet->sectionId);
 		//ago
-		if(is_null($change['lastSeen']) || $change['lastSeen']=="0000-00-00 00:00:00") {
-			$ago	  = "never";
+		if (is_null ($change['lastSeen']) || $change['lastSeen'] == "0000-00-00 00:00:00") {
+			$ago = "never";
 		} else {
-			$timeDiff = $now - strtotime($change['lastSeen']);
-			$ago 	  = $change['lastSeen']." (".$Result->sec2hms($timeDiff)." ago)";
+			$timeDiff = $now - strtotime ($change['lastSeen']);
+			$ago = $change['lastSeen']." (".$Result->sec2hms ($timeDiff)." ago)";
 		}
 
 		//content
 		$content[] = "<tr>";
-		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'><a href='".rtrim($Scan->settings->siteURL, "/")."".create_link("subnets",$section->id,$subnet->id)."'>".$Subnets->transform_to_dotted($change['ip_addr'])."</a></td>";
+		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'><a href='".rtrim ($Scan->settings->siteURL, "/")."".create_link ("subnets", $section->id, $subnet->id)."'>".$Subnets->transform_to_dotted ($change['ip_addr'])."</a></td>";
 		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$change[description]</td>";
 		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$change[dns_name]</td>";
-		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'><a href='".rtrim($Scan->settings->siteURL, "/")."".create_link("subnets",$section->id,$subnet->id)."'>".$Subnets->transform_to_dotted($subnet->subnet)."/".$subnet->mask." - ".$subnet->description."</a></td>";
-		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'><a href='".rtrim($Scan->settings->siteURL, "/")."".create_link("subnets",$section->id)."'>$section->name $section->description</a></td>";
+		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'><a href='".rtrim ($Scan->settings->siteURL, "/")."".create_link ("subnets", $section->id, $subnet->id)."'>".$Subnets->transform_to_dotted ($subnet->subnet)."/".$subnet->mask." - ".$subnet->description."</a></td>";
+		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'><a href='".rtrim ($Scan->settings->siteURL, "/")."".create_link ("subnets", $section->id)."'>$section->name $section->description</a></td>";
 		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$ago</td>";
 		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$oldStatus</td>";
 		$content[] = "	<td style='padding:3px 8px;border:1px solid silver;'>$newStatus</td>";
 		$content[] = "</tr>";
 
 		//plain content
-		$content_plain[] = "\t * ".$Subnets->transform_to_dotted($change['ip_addr'])." (".$Subnets->transform_to_dotted($subnet->subnet)."/".$subnet->mask.")\r\n \t  ".strip_tags($oldStatus)." => ".strip_tags($newStatus);
+		$content_plain[] = "\t * ".$Subnets->transform_to_dotted ($change['ip_addr'])." (".$Subnets->transform_to_dotted ($subnet->subnet)."/".$subnet->mask.")\r\n \t  ".strip_tags ($oldStatus)." => ".strip_tags ($newStatus);
 
 	}
 	$content[] = "</table>";
 
 
 	# set content
-	$content 		= $phpipam_mail->generate_message (implode("\r\n", $content));
-	$content_plain 	= implode("\r\n",$content_plain);
+	$content = $phpipam_mail->generate_message (implode ("\r\n", $content));
+	$content_plain = implode ("\r\n", $content_plain);
 
 	# try to send
 	try {
-		$phpipam_mail->Php_mailer->setFrom($mail_settings->mAdminMail, $mail_settings->mAdminName);
+		$phpipam_mail->Php_mailer->setFrom ($mail_settings->mAdminMail, $mail_settings->mAdminName);
 		//add all admins to CC
-		foreach($recepients as $admin) {
-			$phpipam_mail->Php_mailer->addAddress(addslashes($admin['email']), addslashes($admin['name']));
+		foreach ($recepients as $admin) {
+			$phpipam_mail->Php_mailer->addAddress (addslashes ($admin['email']), addslashes ($admin['name']));
 		}
 		$phpipam_mail->Php_mailer->Subject = $subject;
-		$phpipam_mail->Php_mailer->msgHTML($content);
+		$phpipam_mail->Php_mailer->msgHTML ($content);
 		$phpipam_mail->Php_mailer->AltBody = $content_plain;
 		//send
-		$phpipam_mail->Php_mailer->send();
+		$phpipam_mail->Php_mailer->send ();
 	} catch (phpmailerException $e) {
-		$Result->show_cli("Mailer Error: ".$e->errorMessage(), true);
+		$Result->show_cli ("Mailer Error: ".$e->errorMessage (), true);
 	} catch (Exception $e) {
-		$Result->show_cli("Mailer Error: ".$e->errorMessage(), true);
+		$Result->show_cli ("Mailer Error: ".$e->errorMessage (), true);
 	}
 }
 

functions/scripts/reset-admin-password.php

Indentation +30 added lines, -30 removed lines

@@ -27,17 +27,17 @@ 
 // check if argv[1] provided, if not check readline support and wait for user pass
 if (isset($argv[1]))	{ $password = $argv[1]; }
 else {
-	// get available extensions
-	$available_extensions = get_loaded_extensions();
-	// not in array
-	if (!in_array("readline", $available_extensions)) 		{ $Result->show_cli("readline php extension is required.\nOr provide password as first argument", true); }
-	else {
-		// read password
-		$line = readline("Enter password: ");
-		readline_add_history($line);
-		// save
-		$password = array_pop(readline_list_history());
-	}
+    // get available extensions
+    $available_extensions = get_loaded_extensions();
+    // not in array
+    if (!in_array("readline", $available_extensions)) 		{ $Result->show_cli("readline php extension is required.\nOr provide password as first argument", true); }
+    else {
+        // read password
+        $line = readline("Enter password: ");
+        readline_add_history($line);
+        // save
+        $password = array_pop(readline_list_history());
+    }
 }
 
 // validate password
@@ -50,8 +50,8 @@ 
 
 // set update array
 $values = array("id"=>1,
-				"password"=>$password_crypted
-				);
+                "password"=>$password_crypted
+                );
 
 // update password
 if(!$Admin->object_modify("users", "edit", "id", $values))	{ $Result->show_cli("Failed to update Admin password", false); }
@@ -60,10 +60,10 @@ 
 
 // debug ?
 if ($debugging || $fail) {
-	$Result->show_cli("---------");
-	$Result->show_cli("Crypt type: ".$crypt_type);
-	$Result->show_cli("Password: ".$password_crypted);
-	$Result->show_cli("---------");
+    $Result->show_cli("---------");
+    $Result->show_cli("Crypt type: ".$crypt_type);
+    $Result->show_cli("Password: ".$password_crypted);
+    $Result->show_cli("---------");
 }
 
 // fail
@@ -73,7 +73,7 @@ 
 
 # check for recipients
 foreach($Admin->fetch_multiple_objects ("users", "role", "Administrator") as $admin) {
-	$recepients[] = array("name"=>$admin->real_name, "email"=>$admin->email);
+    $recepients[] = array("name"=>$admin->real_name, "email"=>$admin->email);
 }
 # none?
 if(!isset($recepients))	{ die(); }
@@ -104,20 +104,20 @@ 
 
 # try to send
 try {
-	$phpipam_mail->Php_mailer->setFrom($mail_settings->mAdminMail, $mail_settings->mAdminName);
-	//add all admins to CC
-	foreach($recepients as $admin) {
-		$phpipam_mail->Php_mailer->addAddress(addslashes($admin['email']), addslashes($admin['name']));
-	}
-	$phpipam_mail->Php_mailer->Subject = $subject;
-	$phpipam_mail->Php_mailer->msgHTML($content);
-	$phpipam_mail->Php_mailer->AltBody = $content_plain;
-	//send
-	$phpipam_mail->Php_mailer->send();
+    $phpipam_mail->Php_mailer->setFrom($mail_settings->mAdminMail, $mail_settings->mAdminName);
+    //add all admins to CC
+    foreach($recepients as $admin) {
+        $phpipam_mail->Php_mailer->addAddress(addslashes($admin['email']), addslashes($admin['name']));
+    }
+    $phpipam_mail->Php_mailer->Subject = $subject;
+    $phpipam_mail->Php_mailer->msgHTML($content);
+    $phpipam_mail->Php_mailer->AltBody = $content_plain;
+    //send
+    $phpipam_mail->Php_mailer->send();
 } catch (phpmailerException $e) {
-	$Result->show_cli("Mailer Error: ".$e->errorMessage(), true);
+    $Result->show_cli("Mailer Error: ".$e->errorMessage(), true);
 } catch (Exception $e) {
-	$Result->show_cli("Mailer Error: ".$e->errorMessage(), true);
+    $Result->show_cli("Mailer Error: ".$e->errorMessage(), true);
 }
 
 ?>
\ No newline at end of file

Spacing +38 added lines, -38 removed lines

@@ -8,40 +8,40 @@ 
  */
 
 # include required scripts
-require( dirname(__FILE__) . '/../functions.php' );
+require(dirname (__FILE__).'/../functions.php');
 
 # set debugging
 $debugging = false;
-$fail	   = false;
+$fail = false;
 
 # initialize objects
-$Database 	= new Database_PDO;
-$Admin		= new Admin ($Database, false);
-$User		= new User ($Database, true);
-$Result		= new Result();
+$Database = new Database_PDO;
+$Admin = new Admin ($Database, false);
+$User = new User ($Database, true);
+$Result = new Result ();
 
 
 // script can only be run from cli
-if(php_sapi_name()!="cli") 									{ $Result->show_cli("This script can only be run from cli", true); }
+if (php_sapi_name () != "cli") { $Result->show_cli ("This script can only be run from cli", true); }
 
 // check if argv[1] provided, if not check readline support and wait for user pass
-if (isset($argv[1]))	{ $password = $argv[1]; }
+if (isset($argv[1])) { $password = $argv[1]; }
 else {
 	// get available extensions
-	$available_extensions = get_loaded_extensions();
+	$available_extensions = get_loaded_extensions ();
 	// not in array
-	if (!in_array("readline", $available_extensions)) 		{ $Result->show_cli("readline php extension is required.\nOr provide password as first argument", true); }
+	if (!in_array ("readline", $available_extensions)) { $Result->show_cli ("readline php extension is required.\nOr provide password as first argument", true); }
 	else {
 		// read password
-		$line = readline("Enter password: ");
-		readline_add_history($line);
+		$line = readline ("Enter password: ");
+		readline_add_history ($line);
 		// save
-		$password = array_pop(readline_list_history());
+		$password = array_pop (readline_list_history ());
 	}
 }
 
 // validate password
-if(strlen($password)<8)										{ $Result->show_cli("Password must be at least 8 characters long", true); }
+if (strlen ($password) < 8) { $Result->show_cli ("Password must be at least 8 characters long", true); }
 
 // hash passowrd
 $password_crypted = $User->crypt_user_pass ($password);
@@ -49,21 +49,21 @@ 
 $crypt_type = $User->return_crypt_type ();
 
 // set update array
-$values = array("id"=>1,
+$values = array ("id"=>1,
 				"password"=>$password_crypted
 				);
 
 // update password
-if(!$Admin->object_modify("users", "edit", "id", $values))	{ $Result->show_cli("Failed to update Admin password", false); }
-else														{ $Result->show_cli("Admin password updated", false); }
+if (!$Admin->object_modify ("users", "edit", "id", $values)) { $Result->show_cli ("Failed to update Admin password", false); }
+else { $Result->show_cli ("Admin password updated", false); }
 
 
 // debug ?
 if ($debugging || $fail) {
-	$Result->show_cli("---------");
-	$Result->show_cli("Crypt type: ".$crypt_type);
-	$Result->show_cli("Password: ".$password_crypted);
-	$Result->show_cli("---------");
+	$Result->show_cli ("---------");
+	$Result->show_cli ("Crypt type: ".$crypt_type);
+	$Result->show_cli ("Password: ".$password_crypted);
+	$Result->show_cli ("---------");
 }
 
 // fail
@@ -72,23 +72,23 @@ 
 # send mail
 
 # check for recipients
-foreach($Admin->fetch_multiple_objects ("users", "role", "Administrator") as $admin) {
-	$recepients[] = array("name"=>$admin->real_name, "email"=>$admin->email);
+foreach ($Admin->fetch_multiple_objects ("users", "role", "Administrator") as $admin) {
+	$recepients[] = array ("name"=>$admin->real_name, "email"=>$admin->email);
 }
 # none?
-if(!isset($recepients))	{ die(); }
+if (!isset($recepients)) { die(); }
 
 // fetch settings
-$settings = $Admin->fetch_object("settings", "id", 1);
+$settings = $Admin->fetch_object ("settings", "id", 1);
 // fetch mailer settings
-$mail_settings = $Admin->fetch_object("settingsMail", "id", 1);
+$mail_settings = $Admin->fetch_object ("settingsMail", "id", 1);
 
 # initialize mailer
-$phpipam_mail = new phpipam_mail($settings, $mail_settings);
-$phpipam_mail->initialize_mailer();
+$phpipam_mail = new phpipam_mail ($settings, $mail_settings);
+$phpipam_mail->initialize_mailer ();
 
 // set subject
-$subject	= "phpIPAM Administrator password updated";
+$subject = "phpIPAM Administrator password updated";
 //html
 $content[] = "<h3>phpIPAM Administrator password updated</h3>";
 $content[] = "<hr>";
@@ -99,25 +99,25 @@ 
 
 
 # set content
-$content 		= $phpipam_mail->generate_message (implode("\r\n", $content));
-$content_plain 	= implode("\r\n",$content_plain);
+$content = $phpipam_mail->generate_message (implode ("\r\n", $content));
+$content_plain = implode ("\r\n", $content_plain);
 
 # try to send
 try {
-	$phpipam_mail->Php_mailer->setFrom($mail_settings->mAdminMail, $mail_settings->mAdminName);
+	$phpipam_mail->Php_mailer->setFrom ($mail_settings->mAdminMail, $mail_settings->mAdminName);
 	//add all admins to CC
-	foreach($recepients as $admin) {
-		$phpipam_mail->Php_mailer->addAddress(addslashes($admin['email']), addslashes($admin['name']));
+	foreach ($recepients as $admin) {
+		$phpipam_mail->Php_mailer->addAddress (addslashes ($admin['email']), addslashes ($admin['name']));
 	}
 	$phpipam_mail->Php_mailer->Subject = $subject;
-	$phpipam_mail->Php_mailer->msgHTML($content);
+	$phpipam_mail->Php_mailer->msgHTML ($content);
 	$phpipam_mail->Php_mailer->AltBody = $content_plain;
 	//send
-	$phpipam_mail->Php_mailer->send();
+	$phpipam_mail->Php_mailer->send ();
 } catch (phpmailerException $e) {
-	$Result->show_cli("Mailer Error: ".$e->errorMessage(), true);
+	$Result->show_cli ("Mailer Error: ".$e->errorMessage (), true);
 } catch (Exception $e) {
-	$Result->show_cli("Mailer Error: ".$e->errorMessage(), true);
+	$Result->show_cli ("Mailer Error: ".$e->errorMessage (), true);
 }
 
 ?>
\ No newline at end of file

functions/classes/class.Install.php

Doc Comments +10 added lines, -10 removed lines

@@ -67,7 +67,7 @@ 
 	 * @param bool $drop_database (default: false)
 	 * @param bool $create_database (default: false)
 	 * @param bool $create_grants (default: false)
-	 * @return void
+	 * @return boolean|null
 	 */
 	public function install_database ($rootuser, $rootpass, $drop_database = false, $create_database = false, $create_grants = false) {
 
@@ -145,7 +145,7 @@ 
 	 * Execute files installation
 	 *
 	 * @access private
-	 * @return void
+	 * @return false|null
 	 */
 	private function install_database_execute () {
 	    # import SCHEMA file queries
@@ -197,7 +197,7 @@ 
 	 *
 	 * @access public
 	 * @param bool $redirect
-	 * @return void
+	 * @return boolean
 	 */
 	public function check_db_connection ($redirect = false) {
 		# try to connect
@@ -217,7 +217,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $table
-	 * @return void
+	 * @return boolean
 	 */
 	public function check_table ($table, $redirect = false) {
 		# set query
@@ -284,7 +284,7 @@ 
 	 * @param mixed $adminpass
 	 * @param mixed $siteTitle
 	 * @param mixed $siteURL
-	 * @return void
+	 * @return boolean
 	 */
 	function postauth_update($adminpass, $siteTitle, $siteURL) {
 		# update Admin pass
@@ -300,7 +300,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $adminpass
-	 * @return void
+	 * @return boolean
 	 */
 	public function postauth_update_admin_pass ($adminpass) {
 		try { $this->Database->updateObject("users", array("password"=>$adminpass, "passChange"=>"No","username"=>"Admin"), "username"); }
@@ -314,7 +314,7 @@ 
 	 * @access private
 	 * @param mixed $siteTitle
 	 * @param mixed $siteURL
-	 * @return void
+	 * @return boolean
 	 */
 	private function postauth_update_settings ($siteTitle, $siteURL) {
 		try { $this->Database->updateObject("settings", array("siteTitle"=>$siteTitle, "siteURL"=>$siteURL,"id"=>1), "id"); }
@@ -340,7 +340,7 @@ 
 	 * Upgrade database checks and executes.
 	 *
 	 * @access public
-	 * @return void
+	 * @return null|boolean
 	 */
 	public function upgrade_database () {
 		# first check version
@@ -361,7 +361,7 @@ 
 	 * Execute database upgrade.
 	 *
 	 * @access private
-	 * @return void
+	 * @return boolean
 	 */
 	private function upgrade_database_execute () {
 		# set queries
@@ -408,7 +408,7 @@ 
 	 * Fetch all upgrade queries from DB files
 	 *
 	 * @access public
-	 * @return void
+	 * @return string
 	 */
 	public function get_upgrade_queries () {
 		// save all queries fro UPDATE.sql file

Braces +25 added lines, -25 removed lines

@@ -41,8 +41,7 @@ 
 		# set debugging
 		$this->set_db_params ();
 		# Log object
-		try { $this->Database->connect(); }
-		catch ( Exception $e ) {}
+		try { $this->Database->connect(); } catch ( Exception $e ) {}
 	}
 
 
@@ -109,8 +108,7 @@ 
 	 	# set query
 	    $query = "drop database if exists `". $this->db['name'] ."`;";
 		# execute
-		try { $this->Database_root->runQuery($query); }
-		catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
+		try { $this->Database_root->runQuery($query); } catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
 	}
 
 	/**
@@ -123,8 +121,7 @@ 
 	 	# set query
 	    $query = "create database `". $this->db['name'] ."`;";
 		# execute
-		try { $this->Database_root->runQuery($query); }
-		catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
+		try { $this->Database_root->runQuery($query); } catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
 	}
 
 	/**
@@ -137,8 +134,7 @@ 
 	 	# set query
 	    $query = 'grant ALL on `'. $this->db['name'] .'`.* to '. $this->db['user'] .'@localhost identified by "'. $this->db['pass'] .'";';
 		# execute
-		try { $this->Database_root->runQuery($query); }
-		catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
+		try { $this->Database_root->runQuery($query); } catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
 	}
 
 	/**
@@ -158,14 +154,11 @@ 
 	    foreach($queries as $q) {
 		    //length check
 		    if (strlen($q)>0) {
-				try { $this->Database_root->runQuery($q.";"); }
-				catch (Exception $e) {
+				try { $this->Database_root->runQuery($q.";"); } catch (Exception $e) {
 					//unlock tables
-					try { $this->Database_root->runQuery("UNLOCK TABLES;"); }
-					catch (Exception $e) {}
+					try { $this->Database_root->runQuery("UNLOCK TABLES;"); } catch (Exception $e) {}
 					//drop database
-					try { $this->Database_root->runQuery("drop database if exists `". $this->db['name'] ."`;"); }
-					catch (Exception $e) {
+					try { $this->Database_root->runQuery("drop database if exists `". $this->db['name'] ."`;"); } catch (Exception $e) {
 						$this->Result->show("danger", 'Cannot drop database: '.$e->getMessage(), true);
 					}
 					//print error
@@ -201,8 +194,7 @@ 
 	 */
 	public function check_db_connection ($redirect = false) {
 		# try to connect
-		try { $res = $this->Database->connect(); }
-		catch (Exception $e) 	{
+		try { $res = $this->Database->connect(); } catch (Exception $e) 	{
 			$this->exception = $e->getMessage();
 			# redirect ?
 			if($redirect == true)  	{ $this->redirect_to_install (); }
@@ -223,10 +215,21 @@ 
 		# set query
 		$query = "SELECT COUNT(*) AS `cnt` FROM information_schema.tables WHERE table_schema = '".$this->db['name']."' AND table_name = '$table';";
 		# try to fetch count
-		try { $table = $this->Database->getObjectQuery($query); }
-		catch (Exception $e) 	{ if($redirect === true) $this->redirect_to_install ();	else return false; }
+		try { $table = $this->Database->getObjectQuery($query); } catch (Exception $e) 	{ if($redirect === true) {
+		    $this->redirect_to_install ();
+		}
+		else {
+		    return false;
+		}
+		}
 		# redirect if it is not existing
-		if($table->cnt!=1) 	 	{ if($redirect === true) $this->redirect_to_install ();	else return false; }
+		if($table->cnt!=1) 	 	{ if($redirect === true) {
+		    $this->redirect_to_install ();
+		}
+		else {
+		    return false;
+		}
+		}
 		# ok
 		return true;
 	}
@@ -303,8 +306,7 @@ 
 	 * @return void
 	 */
 	public function postauth_update_admin_pass ($adminpass) {
-		try { $this->Database->updateObject("users", array("password"=>$adminpass, "passChange"=>"No","username"=>"Admin"), "username"); }
-		catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
+		try { $this->Database->updateObject("users", array("password"=>$adminpass, "passChange"=>"No","username"=>"Admin"), "username"); } catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
 		return true;
 	}
 
@@ -317,8 +319,7 @@ 
 	 * @return void
 	 */
 	private function postauth_update_settings ($siteTitle, $siteURL) {
-		try { $this->Database->updateObject("settings", array("siteTitle"=>$siteTitle, "siteURL"=>$siteURL,"id"=>1), "id"); }
-		catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
+		try { $this->Database->updateObject("settings", array("siteTitle"=>$siteTitle, "siteURL"=>$siteURL,"id"=>1), "id"); } catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
 		return true;
 	}
 
@@ -378,8 +379,7 @@ 
 	    # execute all queries
 	    foreach($queries as $query) {
     	    if (strlen($query)>5) {
-    			try { $this->Database->runQuery($query); }
-    			catch (Exception $e) {
+    			try { $this->Database->runQuery($query); } catch (Exception $e) {
     				$this->Log = new Logging ($this->Database);
     				# write log
     				$this->Log->write( "Database upgrade", $e->getMessage()."<br>query: ".$query, 2 );

Indentation +458 added lines, -458 removed lines

@@ -7,461 +7,461 @@ 
 class Install extends Common_functions {
 
 
-	/**
-	 * to store DB exceptions
-	 *
-	 * @var mixed
-	 * @access public
-	 */
-	public $exception;
-
-	/**
-	 * Database parameters
-	 *
-	 * @var mixed
-	 * @access protected
-	 */
-	protected $db;
-
-	/**
-	 * debugging flag
-	 *
-	 * (default value: false)
-	 *
-	 * @var bool
-	 * @access public
-	 */
-	public $debugging = false;
-
-	/**
-	 * Result
-	 *
-	 * @var mixed
-	 * @access public
-	 */
-	public $Result;
-
-	/**
-	 * Database
-	 *
-	 * @var mixed
-	 * @access protected
-	 */
-	protected $Database;
-
-	/**
-	 * Database_root - for initial installation
-	 *
-	 * @var mixed
-	 * @access protected
-	 */
-	protected $Database_root;
-
-	/**
-	 * Log
-	 *
-	 * @var mixed
-	 * @access public
-	 */
-	public $Log;
-
-
-
-
-
-	/**
-	 * __construct function.
-	 *
-	 * @access public
-	 * @param Database_PDO $Database
-	 */
-	public function __construct (Database_PDO $Database) {
-		# initialize Result
-		$this->Result = new Result ();
-		# initialize object
-		$this->Database = $Database;
-		# set debugging
-		$this->set_debugging ();
-		# set debugging
-		$this->set_db_params ();
-		# Log object
-		try { $this->Database->connect(); }
-		catch ( Exception $e ) {}
-	}
-
-
-
-
-
-
-
-
-
-	/**
-	 * @install methods
-	 * ------------------------------
-	 */
-
-	/**
-	 * Install database files
-	 *
-	 * @access public
-	 * @param mixed $rootuser
-	 * @param mixed $rootpass
-	 * @param bool $drop_database (default: false)
-	 * @param bool $create_database (default: false)
-	 * @param bool $create_grants (default: false)
-	 * @return void
-	 */
-	public function install_database ($rootuser, $rootpass, $drop_database = false, $create_database = false, $create_grants = false) {
-
-		# open new connection
-		$this->Database_root = new Database_PDO ($rootuser, $rootpass);
-
-		# set install flag to make sure DB is not trying to be selected via DSN
-		$this->Database_root->install = true;
-
-		# drop database if requested
-		if($drop_database===true) 	{ $this->drop_database(); }
-
-		# create database if requested
-		if($create_database===true) { $this->create_database(); }
-
-		# set permissions!
-		if($create_grants===true) 	{ $this->create_grants(); }
-
-	    # reset connection, reset install flag and connect again
-		$this->Database_root->resetConn();
-
-		# install database
-		if($this->install_database_execute () !== false) {
-		    # return true, if some errors occured script already died! */
-			sleep(1);
-			$this->Log = new Logging ($this->Database);
-			$this->Log->write( "Database installation", "Database installed successfully. Version ".VERSION.".".REVISION." installed", 1 );
-			return true;
-		}
-	}
-
-	/**
-	 * Drop existing database
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function drop_database () {
-	 	# set query
-	    $query = "drop database if exists `". $this->db['name'] ."`;";
-		# execute
-		try { $this->Database_root->runQuery($query); }
-		catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
-	}
-
-	/**
-	 * Create database
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function create_database () {
-	 	# set query
-	    $query = "create database `". $this->db['name'] ."`;";
-		# execute
-		try { $this->Database_root->runQuery($query); }
-		catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
-	}
-
-	/**
-	 * Create user grants
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function create_grants () {
-	 	# set query
-	    $query = 'grant ALL on `'. $this->db['name'] .'`.* to '. $this->db['user'] .'@localhost identified by "'. $this->db['pass'] .'";';
-		# execute
-		try { $this->Database_root->runQuery($query); }
-		catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
-	}
-
-	/**
-	 * Execute files installation
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function install_database_execute () {
-	    # import SCHEMA file queries
-	    $query  = file_get_contents("../../db/SCHEMA.sql");
-
-	    # formulate queries
-	    $queries = array_filter(explode(";\n", $query));
-
-	    # execute
-	    foreach($queries as $q) {
-		    //length check
-		    if (strlen($q)>0) {
-				try { $this->Database_root->runQuery($q.";"); }
-				catch (Exception $e) {
-					//unlock tables
-					try { $this->Database_root->runQuery("UNLOCK TABLES;"); }
-					catch (Exception $e) {}
-					//drop database
-					try { $this->Database_root->runQuery("drop database if exists `". $this->db['name'] ."`;"); }
-					catch (Exception $e) {
-						$this->Result->show("danger", 'Cannot drop database: '.$e->getMessage(), true);
-					}
-					//print error
-					$this->Result->show("danger", "Cannot install sql SCHEMA file: ".$e->getMessage()."<br>query that failed: <pre>$q</pre>", false);
-					$this->Result->show("info", "Database dropped", false);
-
-					return false;
-				}
-			}
-	    }
-	}
-
-
-
-
-
-
-
-
-
-
-	/**
-	 * @check methods
-	 * ------------------------------
-	 */
-
-	/**
-	 * Tries to connect to database
-	 *
-	 * @access public
-	 * @param bool $redirect
-	 * @return void
-	 */
-	public function check_db_connection ($redirect = false) {
-		# try to connect
-		try { $res = $this->Database->connect(); }
-		catch (Exception $e) 	{
-			$this->exception = $e->getMessage();
-			# redirect ?
-			if($redirect == true)  	{ $this->redirect_to_install (); }
-			else					{ return false; }
-		}
-		# ok
-		return true;
-	}
-
-	/**
-	 * Checks if table exists
-	 *
-	 * @access public
-	 * @param mixed $table
-	 * @return void
-	 */
-	public function check_table ($table, $redirect = false) {
-		# set query
-		$query = "SELECT COUNT(*) AS `cnt` FROM information_schema.tables WHERE table_schema = '".$this->db['name']."' AND table_name = '$table';";
-		# try to fetch count
-		try { $table = $this->Database->getObjectQuery($query); }
-		catch (Exception $e) 	{ if($redirect === true) $this->redirect_to_install ();	else return false; }
-		# redirect if it is not existing
-		if($table->cnt!=1) 	 	{ if($redirect === true) $this->redirect_to_install ();	else return false; }
-		# ok
-		return true;
-	}
-
-	/**
-	 * This function redirects to install page
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function redirect_to_install () {
-		# redirect to install
-		header("Location: ".create_link("install"));
-	}
-
-	/**
-	 * sets debugging if set in config.php file
-	 *
-	 * @access private
-	 * @return void
-	 */
-	public function set_debugging () {
-		require( dirname(__FILE__) . '/../../config.php' );
-		if($debugging==true) { $this->debugging = true; }
-	}
-
-	/**
-	 * Sets DB parmaeters
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function set_db_params () {
-		require( dirname(__FILE__) . '/../../config.php' );
-		$this->db = $db;
-	}
-
-
-
-
-
-
-
-
-
-	/**
-	 * @postinstallation functions
-	 * ------------------------------
-	 */
-
-	/**
-	 * Post installation settings update.
-	 *
-	 * @access public
-	 * @param mixed $adminpass
-	 * @param mixed $siteTitle
-	 * @param mixed $siteURL
-	 * @return void
-	 */
-	function postauth_update($adminpass, $siteTitle, $siteURL) {
-		# update Admin pass
-		$this->postauth_update_admin_pass ($adminpass);
-		# update settings
-		$this->postauth_update_settings ($siteTitle, $siteURL);
-		# ok
-		return true;
-	}
-
-	/**
-	 * Updates admin password after installation
-	 *
-	 * @access public
-	 * @param mixed $adminpass
-	 * @return void
-	 */
-	public function postauth_update_admin_pass ($adminpass) {
-		try { $this->Database->updateObject("users", array("password"=>$adminpass, "passChange"=>"No","username"=>"Admin"), "username"); }
-		catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
-		return true;
-	}
-
-	/**
-	 * Updates settings after installation
-	 *
-	 * @access private
-	 * @param mixed $siteTitle
-	 * @param mixed $siteURL
-	 * @return void
-	 */
-	private function postauth_update_settings ($siteTitle, $siteURL) {
-		try { $this->Database->updateObject("settings", array("siteTitle"=>$siteTitle, "siteURL"=>$siteURL,"id"=>1), "id"); }
-		catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
-		return true;
-	}
-
-
-
-
-
-
-
-
-
-
-	/**
-	 * @upgrade database
-	 * -----------------
-	 */
-
-	/**
-	 * Upgrade database checks and executes.
-	 *
-	 * @access public
-	 * @return void
-	 */
-	public function upgrade_database () {
-		# first check version
-		$this->get_settings ();
-
-		if($this->settings->version == VERSION)				{ $this->Result->show("danger", "Database already at latest version", true); }
-		else {
-			# check db connection
-			if($this->check_db_connection(false)===false)  	{ $this->Result->show("danger", "Cannot connect to database", true); }
-			# execute
-			else {
-				return $this->upgrade_database_execute ();
-			}
-		}
-	}
-
-	/**
-	 * Execute database upgrade.
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function upgrade_database_execute () {
-		# set queries
-		$subversion_queries = $this->get_upgrade_queries ();
-		// create default arrays
-		$queries = array();
-		// succesfull queries:
-		$queries_ok = array();
-
-		// replace CRLF
-		$subversion_queries = str_replace("\r\n", "\n", $subversion_queries);
-		$queries = array_filter(explode(";\n", $subversion_queries));
-
-	    # execute all queries
-	    foreach($queries as $query) {
-    	    if (strlen($query)>5) {
-    			try { $this->Database->runQuery($query); }
-    			catch (Exception $e) {
-    				$this->Log = new Logging ($this->Database);
-    				# write log
-    				$this->Log->write( "Database upgrade", $e->getMessage()."<br>query: ".$query, 2 );
-    				# fail
-    				print "<h3>Upgrade failed !</h3><hr style='margin:30px;'>";
-    				$this->Result->show("danger", $e->getMessage()."<hr>Failed query: <pre>".$query.";</pre>", false);
-    				$this->Result->show("success", "Succesfull queries: <pre>".implode(";", $queries_ok).";</pre>", false);
-    				# revert version
-    				//try { $this->Database->runQuery('update `settings` set `version` = ?', array($this->settings->version)); }
-    				//catch (Exception $e) { var_dump($e); }
-    				// false
-    				return false;
-    			}
-    			// save ok
-    			$queries_ok[] = $query;
-			}
-	    }
-
-
-		# all good, print it
-		sleep(1);
-		$this->Log = new Logging ($this->Database);
-		$this->Log->write( "Database upgrade", "Database upgraded from version ".$this->settings->version." to version ".VERSION.".".REVISION, 1 );
-		return true;
-	}
-
-	/**
-	 * Fetch all upgrade queries from DB files
-	 *
-	 * @access public
-	 * @return void
-	 */
-	public function get_upgrade_queries () {
-		// save all queries fro UPDATE.sql file
-		$queries = str_replace("\r\n", "\n", (file_get_contents( dirname(__FILE__) . '/../../db/UPDATE.sql')));
-
-		// fetch settings if not present - for manual instructions
-		if (!isset($this->settings->version)) { $this->get_settings (); }
+    /**
+     * to store DB exceptions
+     *
+     * @var mixed
+     * @access public
+     */
+    public $exception;
+
+    /**
+     * Database parameters
+     *
+     * @var mixed
+     * @access protected
+     */
+    protected $db;
+
+    /**
+     * debugging flag
+     *
+     * (default value: false)
+     *
+     * @var bool
+     * @access public
+     */
+    public $debugging = false;
+
+    /**
+     * Result
+     *
+     * @var mixed
+     * @access public
+     */
+    public $Result;
+
+    /**
+     * Database
+     *
+     * @var mixed
+     * @access protected
+     */
+    protected $Database;
+
+    /**
+     * Database_root - for initial installation
+     *
+     * @var mixed
+     * @access protected
+     */
+    protected $Database_root;
+
+    /**
+     * Log
+     *
+     * @var mixed
+     * @access public
+     */
+    public $Log;
+
+
+
+
+
+    /**
+     * __construct function.
+     *
+     * @access public
+     * @param Database_PDO $Database
+     */
+    public function __construct (Database_PDO $Database) {
+        # initialize Result
+        $this->Result = new Result ();
+        # initialize object
+        $this->Database = $Database;
+        # set debugging
+        $this->set_debugging ();
+        # set debugging
+        $this->set_db_params ();
+        # Log object
+        try { $this->Database->connect(); }
+        catch ( Exception $e ) {}
+    }
+
+
+
+
+
+
+
+
+
+    /**
+     * @install methods
+     * ------------------------------
+     */
+
+    /**
+     * Install database files
+     *
+     * @access public
+     * @param mixed $rootuser
+     * @param mixed $rootpass
+     * @param bool $drop_database (default: false)
+     * @param bool $create_database (default: false)
+     * @param bool $create_grants (default: false)
+     * @return void
+     */
+    public function install_database ($rootuser, $rootpass, $drop_database = false, $create_database = false, $create_grants = false) {
+
+        # open new connection
+        $this->Database_root = new Database_PDO ($rootuser, $rootpass);
+
+        # set install flag to make sure DB is not trying to be selected via DSN
+        $this->Database_root->install = true;
+
+        # drop database if requested
+        if($drop_database===true) 	{ $this->drop_database(); }
+
+        # create database if requested
+        if($create_database===true) { $this->create_database(); }
+
+        # set permissions!
+        if($create_grants===true) 	{ $this->create_grants(); }
+
+        # reset connection, reset install flag and connect again
+        $this->Database_root->resetConn();
+
+        # install database
+        if($this->install_database_execute () !== false) {
+            # return true, if some errors occured script already died! */
+            sleep(1);
+            $this->Log = new Logging ($this->Database);
+            $this->Log->write( "Database installation", "Database installed successfully. Version ".VERSION.".".REVISION." installed", 1 );
+            return true;
+        }
+    }
+
+    /**
+     * Drop existing database
+     *
+     * @access private
+     * @return void
+     */
+    private function drop_database () {
+            # set query
+        $query = "drop database if exists `". $this->db['name'] ."`;";
+        # execute
+        try { $this->Database_root->runQuery($query); }
+        catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
+    }
+
+    /**
+     * Create database
+     *
+     * @access private
+     * @return void
+     */
+    private function create_database () {
+            # set query
+        $query = "create database `". $this->db['name'] ."`;";
+        # execute
+        try { $this->Database_root->runQuery($query); }
+        catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
+    }
+
+    /**
+     * Create user grants
+     *
+     * @access private
+     * @return void
+     */
+    private function create_grants () {
+            # set query
+        $query = 'grant ALL on `'. $this->db['name'] .'`.* to '. $this->db['user'] .'@localhost identified by "'. $this->db['pass'] .'";';
+        # execute
+        try { $this->Database_root->runQuery($query); }
+        catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
+    }
+
+    /**
+     * Execute files installation
+     *
+     * @access private
+     * @return void
+     */
+    private function install_database_execute () {
+        # import SCHEMA file queries
+        $query  = file_get_contents("../../db/SCHEMA.sql");
+
+        # formulate queries
+        $queries = array_filter(explode(";\n", $query));
+
+        # execute
+        foreach($queries as $q) {
+            //length check
+            if (strlen($q)>0) {
+                try { $this->Database_root->runQuery($q.";"); }
+                catch (Exception $e) {
+                    //unlock tables
+                    try { $this->Database_root->runQuery("UNLOCK TABLES;"); }
+                    catch (Exception $e) {}
+                    //drop database
+                    try { $this->Database_root->runQuery("drop database if exists `". $this->db['name'] ."`;"); }
+                    catch (Exception $e) {
+                        $this->Result->show("danger", 'Cannot drop database: '.$e->getMessage(), true);
+                    }
+                    //print error
+                    $this->Result->show("danger", "Cannot install sql SCHEMA file: ".$e->getMessage()."<br>query that failed: <pre>$q</pre>", false);
+                    $this->Result->show("info", "Database dropped", false);
+
+                    return false;
+                }
+            }
+        }
+    }
+
+
+
+
+
+
+
+
+
+
+    /**
+     * @check methods
+     * ------------------------------
+     */
+
+    /**
+     * Tries to connect to database
+     *
+     * @access public
+     * @param bool $redirect
+     * @return void
+     */
+    public function check_db_connection ($redirect = false) {
+        # try to connect
+        try { $res = $this->Database->connect(); }
+        catch (Exception $e) 	{
+            $this->exception = $e->getMessage();
+            # redirect ?
+            if($redirect == true)  	{ $this->redirect_to_install (); }
+            else					{ return false; }
+        }
+        # ok
+        return true;
+    }
+
+    /**
+     * Checks if table exists
+     *
+     * @access public
+     * @param mixed $table
+     * @return void
+     */
+    public function check_table ($table, $redirect = false) {
+        # set query
+        $query = "SELECT COUNT(*) AS `cnt` FROM information_schema.tables WHERE table_schema = '".$this->db['name']."' AND table_name = '$table';";
+        # try to fetch count
+        try { $table = $this->Database->getObjectQuery($query); }
+        catch (Exception $e) 	{ if($redirect === true) $this->redirect_to_install ();	else return false; }
+        # redirect if it is not existing
+        if($table->cnt!=1) 	 	{ if($redirect === true) $this->redirect_to_install ();	else return false; }
+        # ok
+        return true;
+    }
+
+    /**
+     * This function redirects to install page
+     *
+     * @access private
+     * @return void
+     */
+    private function redirect_to_install () {
+        # redirect to install
+        header("Location: ".create_link("install"));
+    }
+
+    /**
+     * sets debugging if set in config.php file
+     *
+     * @access private
+     * @return void
+     */
+    public function set_debugging () {
+        require( dirname(__FILE__) . '/../../config.php' );
+        if($debugging==true) { $this->debugging = true; }
+    }
+
+    /**
+     * Sets DB parmaeters
+     *
+     * @access private
+     * @return void
+     */
+    private function set_db_params () {
+        require( dirname(__FILE__) . '/../../config.php' );
+        $this->db = $db;
+    }
+
+
+
+
+
+
+
+
+
+    /**
+     * @postinstallation functions
+     * ------------------------------
+     */
+
+    /**
+     * Post installation settings update.
+     *
+     * @access public
+     * @param mixed $adminpass
+     * @param mixed $siteTitle
+     * @param mixed $siteURL
+     * @return void
+     */
+    function postauth_update($adminpass, $siteTitle, $siteURL) {
+        # update Admin pass
+        $this->postauth_update_admin_pass ($adminpass);
+        # update settings
+        $this->postauth_update_settings ($siteTitle, $siteURL);
+        # ok
+        return true;
+    }
+
+    /**
+     * Updates admin password after installation
+     *
+     * @access public
+     * @param mixed $adminpass
+     * @return void
+     */
+    public function postauth_update_admin_pass ($adminpass) {
+        try { $this->Database->updateObject("users", array("password"=>$adminpass, "passChange"=>"No","username"=>"Admin"), "username"); }
+        catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
+        return true;
+    }
+
+    /**
+     * Updates settings after installation
+     *
+     * @access private
+     * @param mixed $siteTitle
+     * @param mixed $siteURL
+     * @return void
+     */
+    private function postauth_update_settings ($siteTitle, $siteURL) {
+        try { $this->Database->updateObject("settings", array("siteTitle"=>$siteTitle, "siteURL"=>$siteURL,"id"=>1), "id"); }
+        catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
+        return true;
+    }
+
+
+
+
+
+
+
+
+
+
+    /**
+     * @upgrade database
+     * -----------------
+     */
+
+    /**
+     * Upgrade database checks and executes.
+     *
+     * @access public
+     * @return void
+     */
+    public function upgrade_database () {
+        # first check version
+        $this->get_settings ();
+
+        if($this->settings->version == VERSION)				{ $this->Result->show("danger", "Database already at latest version", true); }
+        else {
+            # check db connection
+            if($this->check_db_connection(false)===false)  	{ $this->Result->show("danger", "Cannot connect to database", true); }
+            # execute
+            else {
+                return $this->upgrade_database_execute ();
+            }
+        }
+    }
+
+    /**
+     * Execute database upgrade.
+     *
+     * @access private
+     * @return void
+     */
+    private function upgrade_database_execute () {
+        # set queries
+        $subversion_queries = $this->get_upgrade_queries ();
+        // create default arrays
+        $queries = array();
+        // succesfull queries:
+        $queries_ok = array();
+
+        // replace CRLF
+        $subversion_queries = str_replace("\r\n", "\n", $subversion_queries);
+        $queries = array_filter(explode(";\n", $subversion_queries));
+
+        # execute all queries
+        foreach($queries as $query) {
+            if (strlen($query)>5) {
+                try { $this->Database->runQuery($query); }
+                catch (Exception $e) {
+                    $this->Log = new Logging ($this->Database);
+                    # write log
+                    $this->Log->write( "Database upgrade", $e->getMessage()."<br>query: ".$query, 2 );
+                    # fail
+                    print "<h3>Upgrade failed !</h3><hr style='margin:30px;'>";
+                    $this->Result->show("danger", $e->getMessage()."<hr>Failed query: <pre>".$query.";</pre>", false);
+                    $this->Result->show("success", "Succesfull queries: <pre>".implode(";", $queries_ok).";</pre>", false);
+                    # revert version
+                    //try { $this->Database->runQuery('update `settings` set `version` = ?', array($this->settings->version)); }
+                    //catch (Exception $e) { var_dump($e); }
+                    // false
+                    return false;
+                }
+                // save ok
+                $queries_ok[] = $query;
+            }
+        }
+
+
+        # all good, print it
+        sleep(1);
+        $this->Log = new Logging ($this->Database);
+        $this->Log->write( "Database upgrade", "Database upgraded from version ".$this->settings->version." to version ".VERSION.".".REVISION, 1 );
+        return true;
+    }
+
+    /**
+     * Fetch all upgrade queries from DB files
+     *
+     * @access public
+     * @return void
+     */
+    public function get_upgrade_queries () {
+        // save all queries fro UPDATE.sql file
+        $queries = str_replace("\r\n", "\n", (file_get_contents( dirname(__FILE__) . '/../../db/UPDATE.sql')));
+
+        // fetch settings if not present - for manual instructions
+        if (!isset($this->settings->version)) { $this->get_settings (); }
 
         // explode and loop to get next version from current
         $delimiter = false;
@@ -483,7 +483,7 @@ 
         $old_queries = explode("/* VERSION $delimiter */", $queries);
         $old_queries = trim($old_queries[1]);
 
-		# return
-		return $old_queries;
-	}
+        # return
+        return $old_queries;
+    }
 }
\ No newline at end of file

Spacing +66 added lines, -66 removed lines

@@ -85,8 +85,8 @@ 
 		# set debugging
 		$this->set_db_params ();
 		# Log object
-		try { $this->Database->connect(); }
-		catch ( Exception $e ) {}
+		try { $this->Database->connect (); }
+		catch (Exception $e) {}
 	}
 
 
@@ -122,23 +122,23 @@ 
 		$this->Database_root->install = true;
 
 		# drop database if requested
-		if($drop_database===true) 	{ $this->drop_database(); }
+		if ($drop_database === true) { $this->drop_database (); }
 
 		# create database if requested
-		if($create_database===true) { $this->create_database(); }
+		if ($create_database === true) { $this->create_database (); }
 
 		# set permissions!
-		if($create_grants===true) 	{ $this->create_grants(); }
+		if ($create_grants === true) { $this->create_grants (); }
 
 	    # reset connection, reset install flag and connect again
-		$this->Database_root->resetConn();
+		$this->Database_root->resetConn ();
 
 		# install database
-		if($this->install_database_execute () !== false) {
+		if ($this->install_database_execute () !== false) {
 		    # return true, if some errors occured script already died! */
-			sleep(1);
+			sleep (1);
 			$this->Log = new Logging ($this->Database);
-			$this->Log->write( "Database installation", "Database installed successfully. Version ".VERSION.".".REVISION." installed", 1 );
+			$this->Log->write ("Database installation", "Database installed successfully. Version ".VERSION.".".REVISION." installed", 1);
 			return true;
 		}
 	}
@@ -151,10 +151,10 @@ 
 	 */
 	private function drop_database () {
 	 	# set query
-	    $query = "drop database if exists `". $this->db['name'] ."`;";
+	    $query = "drop database if exists `".$this->db['name']."`;";
 		# execute
-		try { $this->Database_root->runQuery($query); }
-		catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
+		try { $this->Database_root->runQuery ($query); }
+		catch (Exception $e) {	$this->Result->show ("danger", $e->getMessage (), true); }
 	}
 
 	/**
@@ -165,10 +165,10 @@ 
 	 */
 	private function create_database () {
 	 	# set query
-	    $query = "create database `". $this->db['name'] ."`;";
+	    $query = "create database `".$this->db['name']."`;";
 		# execute
-		try { $this->Database_root->runQuery($query); }
-		catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
+		try { $this->Database_root->runQuery ($query); }
+		catch (Exception $e) {	$this->Result->show ("danger", $e->getMessage (), true); }
 	}
 
 	/**
@@ -179,10 +179,10 @@ 
 	 */
 	private function create_grants () {
 	 	# set query
-	    $query = 'grant ALL on `'. $this->db['name'] .'`.* to '. $this->db['user'] .'@localhost identified by "'. $this->db['pass'] .'";';
+	    $query = 'grant ALL on `'.$this->db['name'].'`.* to '.$this->db['user'].'@localhost identified by "'.$this->db['pass'].'";';
 		# execute
-		try { $this->Database_root->runQuery($query); }
-		catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
+		try { $this->Database_root->runQuery ($query); }
+		catch (Exception $e) {	$this->Result->show ("danger", $e->getMessage (), true); }
 	}
 
 	/**
@@ -193,28 +193,28 @@ 
 	 */
 	private function install_database_execute () {
 	    # import SCHEMA file queries
-	    $query  = file_get_contents("../../db/SCHEMA.sql");
+	    $query = file_get_contents ("../../db/SCHEMA.sql");
 
 	    # formulate queries
-	    $queries = array_filter(explode(";\n", $query));
+	    $queries = array_filter (explode (";\n", $query));
 
 	    # execute
-	    foreach($queries as $q) {
+	    foreach ($queries as $q) {
 		    //length check
-		    if (strlen($q)>0) {
-				try { $this->Database_root->runQuery($q.";"); }
+		    if (strlen ($q) > 0) {
+				try { $this->Database_root->runQuery ($q.";"); }
 				catch (Exception $e) {
 					//unlock tables
-					try { $this->Database_root->runQuery("UNLOCK TABLES;"); }
+					try { $this->Database_root->runQuery ("UNLOCK TABLES;"); }
 					catch (Exception $e) {}
 					//drop database
-					try { $this->Database_root->runQuery("drop database if exists `". $this->db['name'] ."`;"); }
+					try { $this->Database_root->runQuery ("drop database if exists `".$this->db['name']."`;"); }
 					catch (Exception $e) {
-						$this->Result->show("danger", 'Cannot drop database: '.$e->getMessage(), true);
+						$this->Result->show ("danger", 'Cannot drop database: '.$e->getMessage (), true);
 					}
 					//print error
-					$this->Result->show("danger", "Cannot install sql SCHEMA file: ".$e->getMessage()."<br>query that failed: <pre>$q</pre>", false);
-					$this->Result->show("info", "Database dropped", false);
+					$this->Result->show ("danger", "Cannot install sql SCHEMA file: ".$e->getMessage ()."<br>query that failed: <pre>$q</pre>", false);
+					$this->Result->show ("info", "Database dropped", false);
 
 					return false;
 				}
@@ -245,12 +245,12 @@ 
 	 */
 	public function check_db_connection ($redirect = false) {
 		# try to connect
-		try { $res = $this->Database->connect(); }
-		catch (Exception $e) 	{
-			$this->exception = $e->getMessage();
+		try { $res = $this->Database->connect (); }
+		catch (Exception $e) {
+			$this->exception = $e->getMessage ();
 			# redirect ?
-			if($redirect == true)  	{ $this->redirect_to_install (); }
-			else					{ return false; }
+			if ($redirect == true) { $this->redirect_to_install (); }
+			else { return false; }
 		}
 		# ok
 		return true;
@@ -267,10 +267,10 @@ 
 		# set query
 		$query = "SELECT COUNT(*) AS `cnt` FROM information_schema.tables WHERE table_schema = '".$this->db['name']."' AND table_name = '$table';";
 		# try to fetch count
-		try { $table = $this->Database->getObjectQuery($query); }
-		catch (Exception $e) 	{ if($redirect === true) $this->redirect_to_install ();	else return false; }
+		try { $table = $this->Database->getObjectQuery ($query); }
+		catch (Exception $e) { if ($redirect === true) $this->redirect_to_install (); else return false; }
 		# redirect if it is not existing
-		if($table->cnt!=1) 	 	{ if($redirect === true) $this->redirect_to_install ();	else return false; }
+		if ($table->cnt != 1) { if ($redirect === true) $this->redirect_to_install (); else return false; }
 		# ok
 		return true;
 	}
@@ -283,7 +283,7 @@ 
 	 */
 	private function redirect_to_install () {
 		# redirect to install
-		header("Location: ".create_link("install"));
+		header ("Location: ".create_link ("install"));
 	}
 
 	/**
@@ -293,8 +293,8 @@ 
 	 * @return void
 	 */
 	public function set_debugging () {
-		require( dirname(__FILE__) . '/../../config.php' );
-		if($debugging==true) { $this->debugging = true; }
+		require(dirname (__FILE__).'/../../config.php');
+		if ($debugging == true) { $this->debugging = true; }
 	}
 
 	/**
@@ -304,7 +304,7 @@ 
 	 * @return void
 	 */
 	private function set_db_params () {
-		require( dirname(__FILE__) . '/../../config.php' );
+		require(dirname (__FILE__).'/../../config.php');
 		$this->db = $db;
 	}
 
@@ -330,7 +330,7 @@ 
 	 * @param mixed $siteURL
 	 * @return void
 	 */
-	function postauth_update($adminpass, $siteTitle, $siteURL) {
+	function postauth_update ($adminpass, $siteTitle, $siteURL) {
 		# update Admin pass
 		$this->postauth_update_admin_pass ($adminpass);
 		# update settings
@@ -347,8 +347,8 @@ 
 	 * @return void
 	 */
 	public function postauth_update_admin_pass ($adminpass) {
-		try { $this->Database->updateObject("users", array("password"=>$adminpass, "passChange"=>"No","username"=>"Admin"), "username"); }
-		catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
+		try { $this->Database->updateObject ("users", array ("password"=>$adminpass, "passChange"=>"No", "username"=>"Admin"), "username"); }
+		catch (Exception $e) { $this->Result->show ("danger", $e->getMessage (), false); }
 		return true;
 	}
 
@@ -361,8 +361,8 @@ 
 	 * @return void
 	 */
 	private function postauth_update_settings ($siteTitle, $siteURL) {
-		try { $this->Database->updateObject("settings", array("siteTitle"=>$siteTitle, "siteURL"=>$siteURL,"id"=>1), "id"); }
-		catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
+		try { $this->Database->updateObject ("settings", array ("siteTitle"=>$siteTitle, "siteURL"=>$siteURL, "id"=>1), "id"); }
+		catch (Exception $e) { $this->Result->show ("danger", $e->getMessage (), false); }
 		return true;
 	}
 
@@ -390,10 +390,10 @@ 
 		# first check version
 		$this->get_settings ();
 
-		if($this->settings->version == VERSION)				{ $this->Result->show("danger", "Database already at latest version", true); }
+		if ($this->settings->version == VERSION) { $this->Result->show ("danger", "Database already at latest version", true); }
 		else {
 			# check db connection
-			if($this->check_db_connection(false)===false)  	{ $this->Result->show("danger", "Cannot connect to database", true); }
+			if ($this->check_db_connection (false) === false) { $this->Result->show ("danger", "Cannot connect to database", true); }
 			# execute
 			else {
 				return $this->upgrade_database_execute ();
@@ -411,26 +411,26 @@ 
 		# set queries
 		$subversion_queries = $this->get_upgrade_queries ();
 		// create default arrays
-		$queries = array();
+		$queries = array ();
 		// succesfull queries:
-		$queries_ok = array();
+		$queries_ok = array ();
 
 		// replace CRLF
-		$subversion_queries = str_replace("\r\n", "\n", $subversion_queries);
-		$queries = array_filter(explode(";\n", $subversion_queries));
+		$subversion_queries = str_replace ("\r\n", "\n", $subversion_queries);
+		$queries = array_filter (explode (";\n", $subversion_queries));
 
 	    # execute all queries
-	    foreach($queries as $query) {
-    	    if (strlen($query)>5) {
-    			try { $this->Database->runQuery($query); }
+	    foreach ($queries as $query) {
+    	    if (strlen ($query) > 5) {
+    			try { $this->Database->runQuery ($query); }
     			catch (Exception $e) {
     				$this->Log = new Logging ($this->Database);
     				# write log
-    				$this->Log->write( "Database upgrade", $e->getMessage()."<br>query: ".$query, 2 );
+    				$this->Log->write ("Database upgrade", $e->getMessage ()."<br>query: ".$query, 2);
     				# fail
     				print "<h3>Upgrade failed !</h3><hr style='margin:30px;'>";
-    				$this->Result->show("danger", $e->getMessage()."<hr>Failed query: <pre>".$query.";</pre>", false);
-    				$this->Result->show("success", "Succesfull queries: <pre>".implode(";", $queries_ok).";</pre>", false);
+    				$this->Result->show ("danger", $e->getMessage ()."<hr>Failed query: <pre>".$query.";</pre>", false);
+    				$this->Result->show ("success", "Succesfull queries: <pre>".implode (";", $queries_ok).";</pre>", false);
     				# revert version
     				//try { $this->Database->runQuery('update `settings` set `version` = ?', array($this->settings->version)); }
     				//catch (Exception $e) { var_dump($e); }
@@ -444,9 +444,9 @@ 
 
 
 		# all good, print it
-		sleep(1);
+		sleep (1);
 		$this->Log = new Logging ($this->Database);
-		$this->Log->write( "Database upgrade", "Database upgraded from version ".$this->settings->version." to version ".VERSION.".".REVISION, 1 );
+		$this->Log->write ("Database upgrade", "Database upgraded from version ".$this->settings->version." to version ".VERSION.".".REVISION, 1);
 		return true;
 	}
 
@@ -458,30 +458,30 @@ 
 	 */
 	public function get_upgrade_queries () {
 		// save all queries fro UPDATE.sql file
-		$queries = str_replace("\r\n", "\n", (file_get_contents( dirname(__FILE__) . '/../../db/UPDATE.sql')));
+		$queries = str_replace ("\r\n", "\n", (file_get_contents (dirname (__FILE__).'/../../db/UPDATE.sql')));
 
 		// fetch settings if not present - for manual instructions
 		if (!isset($this->settings->version)) { $this->get_settings (); }
 
         // explode and loop to get next version from current
         $delimiter = false;
-        foreach (explode("/* VERSION ", $queries) as $k=>$q) {
-            $q_version = str_replace(" */", "", array_shift(explode("\n", $q)));
+        foreach (explode ("/* VERSION ", $queries) as $k=>$q) {
+            $q_version = str_replace (" */", "", array_shift (explode ("\n", $q)));
 
             // if delimiter was found in previous loop
-            if ($delimiter!==false) {
+            if ($delimiter !== false) {
                 $delimiter = $q_version;
                 break;
             }
             // if match with current set pointer to next item - delimiter
-            if ($q_version==$this->settings->version) {
+            if ($q_version == $this->settings->version) {
                 $delimiter = true;
             };
         }
 
         // remove older queries before this version
-        $old_queries = explode("/* VERSION $delimiter */", $queries);
-        $old_queries = trim($old_queries[1]);
+        $old_queries = explode ("/* VERSION $delimiter */", $queries);
+        $old_queries = trim ($old_queries[1]);
 
 		# return
 		return $old_queries;

api/controllers/Responses.php

Doc Comments +4 added lines, -5 removed lines

@@ -80,7 +80,6 @@ 
 	 * Sets header based on provided HTTP code
 	 *
 	 * @access private
-	 * @param mixed $code
 	 * @return void
 	 */
 	private function set_header () {
@@ -99,7 +98,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $result
-	 * @return void
+	 * @return string
 	 */
 	public function formulate_result ($result) {
 		// make sure result is array
@@ -210,7 +209,7 @@ 
 	 * Outputs result
 	 *
 	 * @access private
-	 * @return void
+	 * @return string
 	 */
 	private function create_result () {
 		// reorder
@@ -239,7 +238,7 @@ 
 	 * Creates XML result
 	 *
 	 * @access private
-	 * @return void
+	 * @return string|false
 	 */
 	private function create_xml () {
 		// convert whole object to array
@@ -329,7 +328,7 @@ 
 	 * Creates JSON result
 	 *
 	 * @access private
-	 * @return void
+	 * @return string
 	 */
 	private function create_json () {
 		return json_encode((array) $this->result);

Braces +12 added lines, -5 removed lines

@@ -270,7 +270,9 @@ 
 		    if(strpos($key, " ")>0)	{ $key = str_replace(" ", "_", $key); }
 
 		    // if key is numeric append item
-		    if(is_numeric($key)) $key = "item".$key;
+		    if(is_numeric($key)) {
+		        $key = "item".$key;
+		    }
 
 			// if array add child
 	        if (is_array($value)) {
@@ -300,8 +302,9 @@ 
 	 * @license CC-BY-3.0 <http://spdx.org/licenses/CC-BY-3.0>
 	 */
 	public function xml_to_array ( $xmlObject, $out = array () ) {
-	    foreach ( (array) $xmlObject as $index => $node )
-	        $out[$index] = ( is_object ( $node ) ) ? $this->xml_to_array ( $node ) : $node;
+	    foreach ( (array) $xmlObject as $index => $node ) {
+	    	        $out[$index] = ( is_object ( $node ) ) ? $this->xml_to_array ( $node ) : $node;
+	    }
 
 	    return $out;
 	}
@@ -315,14 +318,18 @@ 
 	 */
 	private function object_to_array ($obj) {
 		// object to array
-	    if(is_object($obj)) $obj = (array) $obj;
+	    if(is_object($obj)) {
+	        $obj = (array) $obj;
+	    }
 	    if(is_array($obj)) {
 	        $new = array();
 	        foreach($obj as $key => $val) {
 	            $new[$key] = $this->object_to_array($val);
 	        }
 	    }
-	    else $new = $obj;
+	    else {
+	        $new = $obj;
+	    }
 	    return $new;
 	}
 

Indentation +363 added lines, -363 removed lines

@@ -8,369 +8,369 @@
 class Responses {
 
 
-	/**
-	 * error code handler
-	 *
-	 * @var mixed
-	 * @access public
-	 */
-	public $errors;
-
-	/**
-	 * result handler
-	 *
-	 * (default value: null)
-	 *
-	 * @var mixed
-	 * @access public
-	 */
-	public $result = null;
-
-	/**
-	 * Sets result type
-	 *
-	 * @var mixed
-	 * @access private
-	 */
-	private $result_type;
-
-	/**
-	 * is exception set?
-	 *
-	 * (default value: false)
-	 *
-	 * @var bool
-	 * @access public
-	 */
-	public $exception = false;
-
-
-
-
-
-	/**
-	 * __construct function
-	 *
-	 * @access public
-	 */
-	public function __construct() {
-		# set error codes
-		$this->set_error_codes ();
-	}
-
-	/**
-	 * Sets error code object
-	 *
-	 *	http://www.restapitutorial.com/httpstatuscodes.html
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function set_error_codes () {
-		// OK
-		$this->errors[200] = "OK";
-		$this->errors[201] = "Created";
-		$this->errors[202] = "Accepted";
-		$this->errors[204] = "No Content";
-		// Client errors
-		$this->errors[400] = "Bad Request";
-		$this->errors[401] = "Unauthorized";
-		$this->errors[403] = "Forbidden";
-		$this->errors[404] = "Not Found";
-		$this->errors[405] = "Method Not Allowed";
-		$this->errors[415] = "Unsupported Media Type";
-		// Server errors
-		$this->errors[500] = "Internal Server Error";
-		$this->errors[501] = "Not Implemented";
-		$this->errors[503] = "Service Unavailable";
-		$this->errors[505] = "HTTP Version Not Supported";
-		$this->errors[511] = "Network Authentication Required";
-	}
-
-	/**
-	 * Sets new header and throws exception
-	 *
-	 * @access public
-	 * @param int $code (default: 400)
-	 * @param mixed $exception
-	 * @return void
-	 */
-	public function throw_exception ($code = 400, $exception) {
-		// set failed
-		$this->exception = true;
-
-		// set success
-		$this->result['success'] = false;
-		// set exit code
-		$this->result['code'] = $code;
-		// set message
-		$this->result['message'] = $exception;
-
-		// set header
-		$this->set_header ();
-		// throw exception
-		throw new Exception($exception);
-	}
-
-	/**
-	 * Sets header based on provided HTTP code
-	 *
-	 * @access private
-	 * @param mixed $code
-	 * @return void
-	 */
-	private function set_header () {
-		// wrong code
-		if(!isset($this->exception))		{ header("HTTP/1.1 500 Invalid result code"); }
-		else								{ header("HTTP/1.1 ".$this->result['code']." ".$this->errors[$this->result['code']]); }
-
-		// 401 - add location
-		if ($this->result['code']==401) {
-			$this->set_location_header ("/api/".$_REQUEST['app_id']."/user/");
-		}
-	}
-
-	/**
-	 * Formulates result to JSON or XML
-	 *
-	 * @access public
-	 * @param mixed $result
-	 * @return void
-	 */
-	public function formulate_result ($result) {
-		// make sure result is array
-		$this->result = is_null($this->result) ? (array) $result : $this->result;
-
-		// get requested content type
-		$this->get_request_content_type ();
-
-		// set result contrnt type
-		$this->set_content_type_header ();
-		// set cache header
-		$this->set_cache_header ();
-		// set result header if not already set with $result['success']=false
-		$this->exception===true ? : $this->set_success_header ();
-
-		// return result
-		return $this->create_result ();
-	}
-
-	/**
-	 * Validates that proper content type is set in request
-	 *
-	 * @access public
-	 * @return void
-	 */
-	public function validate_content_type () {
-		// not set, presume json
-		if( !isset($_SERVER['CONTENT_TYPE']) ) {}
-		// post
-		elseif($_SERVER['CONTENT_TYPE']=="application/x-www-form-urlencoded") {}
-		// set, verify
-		elseif (!($_SERVER['CONTENT_TYPE']=="application/xml" || $_SERVER['CONTENT_TYPE']=="application/json")) {
-			$this->throw_exception (415, "Invalid Content type ".$_SERVER['CONTENT_TYPE']);
-		}
-	}
-
-	/**
-	 * Sets request content type
-	 *
-	 * @access public
-	 * @return void
-	 */
-	private function get_request_content_type () {
-		$this->result_type = $_SERVER['CONTENT_TYPE']=="application/xml" ? "xml" : "json";
-	}
-
-	/**
-	 * Sets result content type
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function set_content_type_header () {
-		// content_type
-		$this->result_type == "xml" ? header('Content-Type: application/xml') : header('Content-Type: application/json');
-	}
-
-	/**
-	 * Sets Cache header.
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function set_cache_header ($seconds = NULL) {
-		// none
-		if($seconds===NULL) {
-			header("Cache-Control: no-cache");
-			header("Pragma: no-cache");
-		}
-		// cache
-		else {
-			header("Cache-Control: $seconds");
-		}
-	}
-
-	/**
-	 * Sets success header
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function set_success_header () {
-		// check fo location
-		if(isset($this->result['location'])) {
-			$this->set_location_header ($this->result['location']);
-		}
-
-		// set success
-		$this->result['success'] = true;
-
-		// set header
-		$this->set_header ();
-
-	}
-
-	/**
-	 * Sets location header for newly created objects
-	 *
-	 * @access private
-	 * @param mixed $location
-	 * @return void
-	 */
-	private function set_location_header ($location) {
-		header("Location: ".$location);
-	}
-
-	/**
-	 * Outputs result
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function create_result () {
-		// reorder
-		$this->reorder_result ();
-		// creates result
-		return $this->result_type == "xml" ? $this->create_xml () : $this->create_json ();
-	}
-
-	/**
-	 * Reorders result to proper format
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function reorder_result () {
-		$tmp = $this->result;
-		unset($this->result);
-		// reset
-		$this->result['code'] = $tmp['code'];
-		$this->result['success'] = $tmp['success'];
-		if(isset($tmp['message']))	{ $this->result['message'] = $tmp['message']; }
-		if(isset($tmp['data']))		{ $this->result['data'] = $tmp['data']; }
-		if(isset($tmp['ip']))	    { $this->result['ip'] = $tmp['ip']; }
-	}
-
-	/**
-	 * Creates XML result
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function create_xml () {
-		// convert whole object to array
-		$this->result = $this->object_to_array($this->result);
-
-		// new SimpleXMLElement object
-		$xml = new SimpleXMLElement('<'.$_GET['controller'].'/>');
-		// generate xml from result
-		$this->array_to_xml($xml, $this->result);
-
-		// return XML result
-		return $xml->asXML();
-	}
-
-	/**
-	 * Transforms array to XML
-	 *
-	 * @access private
-	 * @param SimpleXMLElement $object
-	 * @param array $data
-	 * @return void
-	 */
-	private function array_to_xml(SimpleXMLElement $object, array $data) {
-		// loop through values
-	    foreach ($data as $key => $value) {
-		    // if spaces exist in key replace them with underscores
-		    if(strpos($key, " ")>0)	{ $key = str_replace(" ", "_", $key); }
-
-		    // if key is numeric append item
-		    if(is_numeric($key)) $key = "item".$key;
-
-			// if array add child
-	        if (is_array($value)) {
-	            $new_object = $object->addChild($key);
-	            $this->array_to_xml($new_object, $value);
-	        }
-	        // else write value
-	        else {
-	            $object->addChild($key, $value);
-	        }
-	    }
-	}
-
-	/**
-	 * function xml2array
-	 *
-	 * This function is part of the PHP manual.
-	 *
-	 * The PHP manual text and comments are covered by the Creative Commons
-	 * Attribution 3.0 License, copyright (c) the PHP Documentation Group
-	 *
-	 * @author  k dot antczak at livedata dot pl
-	 * @date    2011-04-22 06:08 UTC
-	 * @link    http://www.php.net/manual/en/ref.simplexml.php#103617
-	 * @license http://www.php.net/license/index.php#doc-lic
-	 * @license http://creativecommons.org/licenses/by/3.0/
-	 * @license CC-BY-3.0 <http://spdx.org/licenses/CC-BY-3.0>
-	 */
-	public function xml_to_array ( $xmlObject, $out = array () ) {
-	    foreach ( (array) $xmlObject as $index => $node )
-	        $out[$index] = ( is_object ( $node ) ) ? $this->xml_to_array ( $node ) : $node;
-
-	    return $out;
-	}
-
-	/**
-	 * Transforms object to array
-	 *
-	 * @access private
-	 * @param mixed $obj
-	 * @return void
-	 */
-	private function object_to_array ($obj) {
-		// object to array
-	    if(is_object($obj)) $obj = (array) $obj;
-	    if(is_array($obj)) {
-	        $new = array();
-	        foreach($obj as $key => $val) {
-	            $new[$key] = $this->object_to_array($val);
-	        }
-	    }
-	    else $new = $obj;
-	    return $new;
-	}
-
-	/**
-	 * Creates JSON result
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function create_json () {
-		return json_encode((array) $this->result);
-	}
+    /**
+     * error code handler
+     *
+     * @var mixed
+     * @access public
+     */
+    public $errors;
+
+    /**
+     * result handler
+     *
+     * (default value: null)
+     *
+     * @var mixed
+     * @access public
+     */
+    public $result = null;
+
+    /**
+     * Sets result type
+     *
+     * @var mixed
+     * @access private
+     */
+    private $result_type;
+
+    /**
+     * is exception set?
+     *
+     * (default value: false)
+     *
+     * @var bool
+     * @access public
+     */
+    public $exception = false;
+
+
+
+
+
+    /**
+     * __construct function
+     *
+     * @access public
+     */
+    public function __construct() {
+        # set error codes
+        $this->set_error_codes ();
+    }
+
+    /**
+     * Sets error code object
+     *
+     *	http://www.restapitutorial.com/httpstatuscodes.html
+     *
+     * @access private
+     * @return void
+     */
+    private function set_error_codes () {
+        // OK
+        $this->errors[200] = "OK";
+        $this->errors[201] = "Created";
+        $this->errors[202] = "Accepted";
+        $this->errors[204] = "No Content";
+        // Client errors
+        $this->errors[400] = "Bad Request";
+        $this->errors[401] = "Unauthorized";
+        $this->errors[403] = "Forbidden";
+        $this->errors[404] = "Not Found";
+        $this->errors[405] = "Method Not Allowed";
+        $this->errors[415] = "Unsupported Media Type";
+        // Server errors
+        $this->errors[500] = "Internal Server Error";
+        $this->errors[501] = "Not Implemented";
+        $this->errors[503] = "Service Unavailable";
+        $this->errors[505] = "HTTP Version Not Supported";
+        $this->errors[511] = "Network Authentication Required";
+    }
+
+    /**
+     * Sets new header and throws exception
+     *
+     * @access public
+     * @param int $code (default: 400)
+     * @param mixed $exception
+     * @return void
+     */
+    public function throw_exception ($code = 400, $exception) {
+        // set failed
+        $this->exception = true;
+
+        // set success
+        $this->result['success'] = false;
+        // set exit code
+        $this->result['code'] = $code;
+        // set message
+        $this->result['message'] = $exception;
+
+        // set header
+        $this->set_header ();
+        // throw exception
+        throw new Exception($exception);
+    }
+
+    /**
+     * Sets header based on provided HTTP code
+     *
+     * @access private
+     * @param mixed $code
+     * @return void
+     */
+    private function set_header () {
+        // wrong code
+        if(!isset($this->exception))		{ header("HTTP/1.1 500 Invalid result code"); }
+        else								{ header("HTTP/1.1 ".$this->result['code']." ".$this->errors[$this->result['code']]); }
+
+        // 401 - add location
+        if ($this->result['code']==401) {
+            $this->set_location_header ("/api/".$_REQUEST['app_id']."/user/");
+        }
+    }
+
+    /**
+     * Formulates result to JSON or XML
+     *
+     * @access public
+     * @param mixed $result
+     * @return void
+     */
+    public function formulate_result ($result) {
+        // make sure result is array
+        $this->result = is_null($this->result) ? (array) $result : $this->result;
+
+        // get requested content type
+        $this->get_request_content_type ();
+
+        // set result contrnt type
+        $this->set_content_type_header ();
+        // set cache header
+        $this->set_cache_header ();
+        // set result header if not already set with $result['success']=false
+        $this->exception===true ? : $this->set_success_header ();
+
+        // return result
+        return $this->create_result ();
+    }
+
+    /**
+     * Validates that proper content type is set in request
+     *
+     * @access public
+     * @return void
+     */
+    public function validate_content_type () {
+        // not set, presume json
+        if( !isset($_SERVER['CONTENT_TYPE']) ) {}
+        // post
+        elseif($_SERVER['CONTENT_TYPE']=="application/x-www-form-urlencoded") {}
+        // set, verify
+        elseif (!($_SERVER['CONTENT_TYPE']=="application/xml" || $_SERVER['CONTENT_TYPE']=="application/json")) {
+            $this->throw_exception (415, "Invalid Content type ".$_SERVER['CONTENT_TYPE']);
+        }
+    }
+
+    /**
+     * Sets request content type
+     *
+     * @access public
+     * @return void
+     */
+    private function get_request_content_type () {
+        $this->result_type = $_SERVER['CONTENT_TYPE']=="application/xml" ? "xml" : "json";
+    }
+
+    /**
+     * Sets result content type
+     *
+     * @access private
+     * @return void
+     */
+    private function set_content_type_header () {
+        // content_type
+        $this->result_type == "xml" ? header('Content-Type: application/xml') : header('Content-Type: application/json');
+    }
+
+    /**
+     * Sets Cache header.
+     *
+     * @access private
+     * @return void
+     */
+    private function set_cache_header ($seconds = NULL) {
+        // none
+        if($seconds===NULL) {
+            header("Cache-Control: no-cache");
+            header("Pragma: no-cache");
+        }
+        // cache
+        else {
+            header("Cache-Control: $seconds");
+        }
+    }
+
+    /**
+     * Sets success header
+     *
+     * @access private
+     * @return void
+     */
+    private function set_success_header () {
+        // check fo location
+        if(isset($this->result['location'])) {
+            $this->set_location_header ($this->result['location']);
+        }
+
+        // set success
+        $this->result['success'] = true;
+
+        // set header
+        $this->set_header ();
+
+    }
+
+    /**
+     * Sets location header for newly created objects
+     *
+     * @access private
+     * @param mixed $location
+     * @return void
+     */
+    private function set_location_header ($location) {
+        header("Location: ".$location);
+    }
+
+    /**
+     * Outputs result
+     *
+     * @access private
+     * @return void
+     */
+    private function create_result () {
+        // reorder
+        $this->reorder_result ();
+        // creates result
+        return $this->result_type == "xml" ? $this->create_xml () : $this->create_json ();
+    }
+
+    /**
+     * Reorders result to proper format
+     *
+     * @access private
+     * @return void
+     */
+    private function reorder_result () {
+        $tmp = $this->result;
+        unset($this->result);
+        // reset
+        $this->result['code'] = $tmp['code'];
+        $this->result['success'] = $tmp['success'];
+        if(isset($tmp['message']))	{ $this->result['message'] = $tmp['message']; }
+        if(isset($tmp['data']))		{ $this->result['data'] = $tmp['data']; }
+        if(isset($tmp['ip']))	    { $this->result['ip'] = $tmp['ip']; }
+    }
+
+    /**
+     * Creates XML result
+     *
+     * @access private
+     * @return void
+     */
+    private function create_xml () {
+        // convert whole object to array
+        $this->result = $this->object_to_array($this->result);
+
+        // new SimpleXMLElement object
+        $xml = new SimpleXMLElement('<'.$_GET['controller'].'/>');
+        // generate xml from result
+        $this->array_to_xml($xml, $this->result);
+
+        // return XML result
+        return $xml->asXML();
+    }
+
+    /**
+     * Transforms array to XML
+     *
+     * @access private
+     * @param SimpleXMLElement $object
+     * @param array $data
+     * @return void
+     */
+    private function array_to_xml(SimpleXMLElement $object, array $data) {
+        // loop through values
+        foreach ($data as $key => $value) {
+            // if spaces exist in key replace them with underscores
+            if(strpos($key, " ")>0)	{ $key = str_replace(" ", "_", $key); }
+
+            // if key is numeric append item
+            if(is_numeric($key)) $key = "item".$key;
+
+            // if array add child
+            if (is_array($value)) {
+                $new_object = $object->addChild($key);
+                $this->array_to_xml($new_object, $value);
+            }
+            // else write value
+            else {
+                $object->addChild($key, $value);
+            }
+        }
+    }
+
+    /**
+     * function xml2array
+     *
+     * This function is part of the PHP manual.
+     *
+     * The PHP manual text and comments are covered by the Creative Commons
+     * Attribution 3.0 License, copyright (c) the PHP Documentation Group
+     *
+     * @author  k dot antczak at livedata dot pl
+     * @date    2011-04-22 06:08 UTC
+     * @link    http://www.php.net/manual/en/ref.simplexml.php#103617
+     * @license http://www.php.net/license/index.php#doc-lic
+     * @license http://creativecommons.org/licenses/by/3.0/
+     * @license CC-BY-3.0 <http://spdx.org/licenses/CC-BY-3.0>
+     */
+    public function xml_to_array ( $xmlObject, $out = array () ) {
+        foreach ( (array) $xmlObject as $index => $node )
+            $out[$index] = ( is_object ( $node ) ) ? $this->xml_to_array ( $node ) : $node;
+
+        return $out;
+    }
+
+    /**
+     * Transforms object to array
+     *
+     * @access private
+     * @param mixed $obj
+     * @return void
+     */
+    private function object_to_array ($obj) {
+        // object to array
+        if(is_object($obj)) $obj = (array) $obj;
+        if(is_array($obj)) {
+            $new = array();
+            foreach($obj as $key => $val) {
+                $new[$key] = $this->object_to_array($val);
+            }
+        }
+        else $new = $obj;
+        return $new;
+    }
+
+    /**
+     * Creates JSON result
+     *
+     * @access private
+     * @return void
+     */
+    private function create_json () {
+        return json_encode((array) $this->result);
+    }
 
 
 }

Spacing +41 added lines, -41 removed lines

@@ -53,7 +53,7 @@ 
 	 *
 	 * @access public
 	 */
-	public function __construct() {
+	public function __construct () {
 		# set error codes
 		$this->set_error_codes ();
 	}
@@ -109,7 +109,7 @@ 
 		// set header
 		$this->set_header ();
 		// throw exception
-		throw new Exception($exception);
+		throw new Exception ($exception);
 	}
 
 	/**
@@ -121,11 +121,11 @@ 
 	 */
 	private function set_header () {
 		// wrong code
-		if(!isset($this->exception))		{ header("HTTP/1.1 500 Invalid result code"); }
-		else								{ header("HTTP/1.1 ".$this->result['code']." ".$this->errors[$this->result['code']]); }
+		if (!isset($this->exception)) { header ("HTTP/1.1 500 Invalid result code"); }
+		else { header ("HTTP/1.1 ".$this->result['code']." ".$this->errors[$this->result['code']]); }
 
 		// 401 - add location
-		if ($this->result['code']==401) {
+		if ($this->result['code'] == 401) {
 			$this->set_location_header ("/api/".$_REQUEST['app_id']."/user/");
 		}
 	}
@@ -139,7 +139,7 @@ 
 	 */
 	public function formulate_result ($result) {
 		// make sure result is array
-		$this->result = is_null($this->result) ? (array) $result : $this->result;
+		$this->result = is_null ($this->result) ? (array) $result : $this->result;
 
 		// get requested content type
 		$this->get_request_content_type ();
@@ -149,7 +149,7 @@ 
 		// set cache header
 		$this->set_cache_header ();
 		// set result header if not already set with $result['success']=false
-		$this->exception===true ? : $this->set_success_header ();
+		$this->exception === true ? : $this->set_success_header ();
 
 		// return result
 		return $this->create_result ();
@@ -163,11 +163,11 @@ 
 	 */
 	public function validate_content_type () {
 		// not set, presume json
-		if( !isset($_SERVER['CONTENT_TYPE']) ) {}
+		if (!isset($_SERVER['CONTENT_TYPE'])) {}
 		// post
-		elseif($_SERVER['CONTENT_TYPE']=="application/x-www-form-urlencoded") {}
+		elseif ($_SERVER['CONTENT_TYPE'] == "application/x-www-form-urlencoded") {}
 		// set, verify
-		elseif (!($_SERVER['CONTENT_TYPE']=="application/xml" || $_SERVER['CONTENT_TYPE']=="application/json")) {
+		elseif (!($_SERVER['CONTENT_TYPE'] == "application/xml" || $_SERVER['CONTENT_TYPE'] == "application/json")) {
 			$this->throw_exception (415, "Invalid Content type ".$_SERVER['CONTENT_TYPE']);
 		}
 	}
@@ -179,7 +179,7 @@ 
 	 * @return void
 	 */
 	private function get_request_content_type () {
-		$this->result_type = $_SERVER['CONTENT_TYPE']=="application/xml" ? "xml" : "json";
+		$this->result_type = $_SERVER['CONTENT_TYPE'] == "application/xml" ? "xml" : "json";
 	}
 
 	/**
@@ -190,7 +190,7 @@ 
 	 */
 	private function set_content_type_header () {
 		// content_type
-		$this->result_type == "xml" ? header('Content-Type: application/xml') : header('Content-Type: application/json');
+		$this->result_type == "xml" ? header ('Content-Type: application/xml') : header ('Content-Type: application/json');
 	}
 
 	/**
@@ -201,13 +201,13 @@ 
 	 */
 	private function set_cache_header ($seconds = NULL) {
 		// none
-		if($seconds===NULL) {
-			header("Cache-Control: no-cache");
-			header("Pragma: no-cache");
+		if ($seconds === NULL) {
+			header ("Cache-Control: no-cache");
+			header ("Pragma: no-cache");
 		}
 		// cache
 		else {
-			header("Cache-Control: $seconds");
+			header ("Cache-Control: $seconds");
 		}
 	}
 
@@ -219,7 +219,7 @@ 
 	 */
 	private function set_success_header () {
 		// check fo location
-		if(isset($this->result['location'])) {
+		if (isset($this->result['location'])) {
 			$this->set_location_header ($this->result['location']);
 		}
 
@@ -239,7 +239,7 @@ 
 	 * @return void
 	 */
 	private function set_location_header ($location) {
-		header("Location: ".$location);
+		header ("Location: ".$location);
 	}
 
 	/**
@@ -267,9 +267,9 @@ 
 		// reset
 		$this->result['code'] = $tmp['code'];
 		$this->result['success'] = $tmp['success'];
-		if(isset($tmp['message']))	{ $this->result['message'] = $tmp['message']; }
-		if(isset($tmp['data']))		{ $this->result['data'] = $tmp['data']; }
-		if(isset($tmp['ip']))	    { $this->result['ip'] = $tmp['ip']; }
+		if (isset($tmp['message'])) { $this->result['message'] = $tmp['message']; }
+		if (isset($tmp['data'])) { $this->result['data'] = $tmp['data']; }
+		if (isset($tmp['ip'])) { $this->result['ip'] = $tmp['ip']; }
 	}
 
 	/**
@@ -280,15 +280,15 @@ 
 	 */
 	private function create_xml () {
 		// convert whole object to array
-		$this->result = $this->object_to_array($this->result);
+		$this->result = $this->object_to_array ($this->result);
 
 		// new SimpleXMLElement object
-		$xml = new SimpleXMLElement('<'.$_GET['controller'].'/>');
+		$xml = new SimpleXMLElement ('<'.$_GET['controller'].'/>');
 		// generate xml from result
-		$this->array_to_xml($xml, $this->result);
+		$this->array_to_xml ($xml, $this->result);
 
 		// return XML result
-		return $xml->asXML();
+		return $xml->asXML ();
 	}
 
 	/**
@@ -299,23 +299,23 @@ 
 	 * @param array $data
 	 * @return void
 	 */
-	private function array_to_xml(SimpleXMLElement $object, array $data) {
+	private function array_to_xml (SimpleXMLElement $object, array $data) {
 		// loop through values
 	    foreach ($data as $key => $value) {
 		    // if spaces exist in key replace them with underscores
-		    if(strpos($key, " ")>0)	{ $key = str_replace(" ", "_", $key); }
+		    if (strpos ($key, " ") > 0) { $key = str_replace (" ", "_", $key); }
 
 		    // if key is numeric append item
-		    if(is_numeric($key)) $key = "item".$key;
+		    if (is_numeric ($key)) $key = "item".$key;
 
 			// if array add child
-	        if (is_array($value)) {
-	            $new_object = $object->addChild($key);
-	            $this->array_to_xml($new_object, $value);
+	        if (is_array ($value)) {
+	            $new_object = $object->addChild ($key);
+	            $this->array_to_xml ($new_object, $value);
 	        }
 	        // else write value
 	        else {
-	            $object->addChild($key, $value);
+	            $object->addChild ($key, $value);
 	        }
 	    }
 	}
@@ -335,9 +335,9 @@ 
 	 * @license http://creativecommons.org/licenses/by/3.0/
 	 * @license CC-BY-3.0 <http://spdx.org/licenses/CC-BY-3.0>
 	 */
-	public function xml_to_array ( $xmlObject, $out = array () ) {
-	    foreach ( (array) $xmlObject as $index => $node )
-	        $out[$index] = ( is_object ( $node ) ) ? $this->xml_to_array ( $node ) : $node;
+	public function xml_to_array ($xmlObject, $out = array ()) {
+	    foreach ((array) $xmlObject as $index => $node)
+	        $out[$index] = (is_object ($node)) ? $this->xml_to_array ($node) : $node;
 
 	    return $out;
 	}
@@ -351,11 +351,11 @@ 
 	 */
 	private function object_to_array ($obj) {
 		// object to array
-	    if(is_object($obj)) $obj = (array) $obj;
-	    if(is_array($obj)) {
-	        $new = array();
-	        foreach($obj as $key => $val) {
-	            $new[$key] = $this->object_to_array($val);
+	    if (is_object ($obj)) $obj = (array) $obj;
+	    if (is_array ($obj)) {
+	        $new = array ();
+	        foreach ($obj as $key => $val) {
+	            $new[$key] = $this->object_to_array ($val);
 	        }
 	    }
 	    else $new = $obj;
@@ -369,7 +369,7 @@ 
 	 * @return void
 	 */
 	private function create_json () {
-		return json_encode((array) $this->result);
+		return json_encode ((array) $this->result);
 	}
 
 

api/controllers/User.php

Doc Comments +2 added lines, -2 removed lines

@@ -330,7 +330,7 @@ 
 	 * Validates users token from database
 	 *
 	 * @access private
-	 * @return void
+	 * @return boolean
 	 */
 	private function validate_user_token () {
 		// is set
@@ -412,7 +412,7 @@ 
 	 * Checks if token has expired
 	 *
 	 * @access private
-	 * @return void
+	 * @return boolean
 	 */
 	private function validate_token_expiration () {
 		return strtotime($this->token_expires) < time() ? true : false;

Indentation +516 added lines, -516 removed lines

@@ -9,153 +9,153 @@ 
 class User_controller extends Common_api_functions {
 
 
-	/**
-	 * users token
-	 *
-	 * @var mixed
-	 * @access public
-	 */
-	public $token;
-
-	/**
-	 * time when token expires
-	 *
-	 * @var mixed
-	 * @access public
-	 */
-	public $token_expires;
-
-	/**
-	 * for how many seconds token is valid
-	 *
-	 * @var mixed
-	 * @access private
-	 */
-	private $token_valid_time;
-
-	/**
-	 * number of chars for token
-	 *
-	 * @var mixed
-	 * @access private
-	 */
-	private $token_length;
-
-	/**
-	 * max number of failures before IP is blocked
-	 *
-	 * @var mixed
-	 * @access private
-	 */
-	private $max_failures;
-
-	/**
-	 * controls if IP should be blocked for 5 minutes on invalid requests
-	 *
-	 * (default value: true)
-	 *
-	 * @var bool
-	 * @access private
-	 */
-	private $block_ip = true;
-
-	/**
-	 * Database object
-	 *
-	 * @var mixed
-	 * @access protected
-	 */
-	protected $Database;
-
-	/**
-	 * Master Tools object
-	 *
-	 * @var mixed
-	 * @access protected
-	 */
-	protected $Tools;
-
-	/**
-	 * Master Admin object
-	 *
-	 * @var mixed
-	 * @access protected
-	 */
-	protected $Admin;
-
-	/**
-	 * Master User object
-	 *
-	 * @var mixed
-	 * @access protected
-	 */
-	protected $User;
-
-	/**
-	 * requested parameters
-	 *
-	 * @var mixed
-	 * @access public
-	 */
-	public $_params;
-
-
-
-	/**
-	 * __construct function
-	 *
-	 * @access public
-	 * @param mixed $Database
-	 * @param mixed $Tools
-	 * @param mixed $params
-	 * @param mixed $Response
-	 */
-	public function __construct ($Database, $Tools=null, $params=null, $Response) {
-		$this->Database = $Database;
-		$this->Response = $Response;
-		$this->_params = $params;
-		// init required objects
-		$this->init_object ("Admin", $Database);
-		$this->init_object ("User", $Database);
-		// set default for tokens
-		$this->set_token_valid_time ();
-		$this->set_max_failures ();
-		$this->set_token_length ();
-
-		// if HTTP_TOKEN is set change it to HTTP_PHPIPAM_TOKEN
-		if (isset($_SERVER['HTTP_TOKEN'])&&!isset($_SERVER['HTTP_PHPIPAM_TOKEN'])) 		{ $_SERVER['HTTP_PHPIPAM_TOKEN'] = $_SERVER['HTTP_TOKEN']; }
-	}
-
-
-
-
-
-
-
-
-
-
-	/**
-	 * returns general Controllers and supported methods
-	 *
-	 * @access public
-	 * @return void
-	 */
-	public function OPTIONS () {
-		// validate
-		$this->validate_options_request ();
-
-		// methods
-		$result = array();
-		$result['methods'] = array(
-								array("href"=>"/api/".$this->_params->app_id."/user/", 	"methods"=>array(array("rel"=>"read", 	"method"=>"GET"),
-																										 array("rel"=>"create", "method"=>"POST"),
-																										 array("rel"=>"update", "method"=>"PATCH"),
-																										 array("rel"=>"delete", "method"=>"DELETE"))),
-							);
-		# result
-		return array("code"=>200, "data"=>$result);
-	}
+    /**
+     * users token
+     *
+     * @var mixed
+     * @access public
+     */
+    public $token;
+
+    /**
+     * time when token expires
+     *
+     * @var mixed
+     * @access public
+     */
+    public $token_expires;
+
+    /**
+     * for how many seconds token is valid
+     *
+     * @var mixed
+     * @access private
+     */
+    private $token_valid_time;
+
+    /**
+     * number of chars for token
+     *
+     * @var mixed
+     * @access private
+     */
+    private $token_length;
+
+    /**
+     * max number of failures before IP is blocked
+     *
+     * @var mixed
+     * @access private
+     */
+    private $max_failures;
+
+    /**
+     * controls if IP should be blocked for 5 minutes on invalid requests
+     *
+     * (default value: true)
+     *
+     * @var bool
+     * @access private
+     */
+    private $block_ip = true;
+
+    /**
+     * Database object
+     *
+     * @var mixed
+     * @access protected
+     */
+    protected $Database;
+
+    /**
+     * Master Tools object
+     *
+     * @var mixed
+     * @access protected
+     */
+    protected $Tools;
+
+    /**
+     * Master Admin object
+     *
+     * @var mixed
+     * @access protected
+     */
+    protected $Admin;
+
+    /**
+     * Master User object
+     *
+     * @var mixed
+     * @access protected
+     */
+    protected $User;
+
+    /**
+     * requested parameters
+     *
+     * @var mixed
+     * @access public
+     */
+    public $_params;
+
+
+
+    /**
+     * __construct function
+     *
+     * @access public
+     * @param mixed $Database
+     * @param mixed $Tools
+     * @param mixed $params
+     * @param mixed $Response
+     */
+    public function __construct ($Database, $Tools=null, $params=null, $Response) {
+        $this->Database = $Database;
+        $this->Response = $Response;
+        $this->_params = $params;
+        // init required objects
+        $this->init_object ("Admin", $Database);
+        $this->init_object ("User", $Database);
+        // set default for tokens
+        $this->set_token_valid_time ();
+        $this->set_max_failures ();
+        $this->set_token_length ();
+
+        // if HTTP_TOKEN is set change it to HTTP_PHPIPAM_TOKEN
+        if (isset($_SERVER['HTTP_TOKEN'])&&!isset($_SERVER['HTTP_PHPIPAM_TOKEN'])) 		{ $_SERVER['HTTP_PHPIPAM_TOKEN'] = $_SERVER['HTTP_TOKEN']; }
+    }
+
+
+
+
+
+
+
+
+
+
+    /**
+     * returns general Controllers and supported methods
+     *
+     * @access public
+     * @return void
+     */
+    public function OPTIONS () {
+        // validate
+        $this->validate_options_request ();
+
+        // methods
+        $result = array();
+        $result['methods'] = array(
+                                array("href"=>"/api/".$this->_params->app_id."/user/", 	"methods"=>array(array("rel"=>"read", 	"method"=>"GET"),
+                                                                                                            array("rel"=>"create", "method"=>"POST"),
+                                                                                                            array("rel"=>"update", "method"=>"PATCH"),
+                                                                                                            array("rel"=>"delete", "method"=>"DELETE"))),
+                            );
+        # result
+        return array("code"=>200, "data"=>$result);
+    }
 
 
 
@@ -164,99 +164,99 @@ 
 
 
 
-	/**
-	 * Authenticates user and returns token
-	 *
-	 * @access public
-	 * @return void
-	 */
-	public function GET () {
-		// block IP
-		$this->validate_block ();
-		// validate token
-		$this->validate_requested_token ();
-		// ok
-		return array("code"=>200, "data"=>array("expires"=>$this->token_expires));
-	}
+    /**
+     * Authenticates user and returns token
+     *
+     * @access public
+     * @return void
+     */
+    public function GET () {
+        // block IP
+        $this->validate_block ();
+        // validate token
+        $this->validate_requested_token ();
+        // ok
+        return array("code"=>200, "data"=>array("expires"=>$this->token_expires));
+    }
 
 
 
 
 
-	/**
-	 * Refreshes token and returns status
-	 *
-	 * @access public
-	 * @return void
-	 */
-	public function POST () {
-		// block IP
-		$this->validate_block ();
-		// authenticate user and provide token
-		return $this->authenticate ();
-	}
+    /**
+     * Refreshes token and returns status
+     *
+     * @access public
+     * @return void
+     */
+    public function POST () {
+        // block IP
+        $this->validate_block ();
+        // authenticate user and provide token
+        return $this->authenticate ();
+    }
 
 
 
 
 
-	/**
-	 * Extends token validity
-	 *
-	 * @access public
-	 * @return void
-	 */
-	public function PATCH () {
-		// block IP
-		$this->validate_block ();
-		// validate token
-		$this->validate_requested_token ();
-		// refresh
-		$this->refresh_token_expiration ();
-		// ok
-		return array("code"=>200, "data"=>array("expires"=>$this->token_expires));
-	}
+    /**
+     * Extends token validity
+     *
+     * @access public
+     * @return void
+     */
+    public function PATCH () {
+        // block IP
+        $this->validate_block ();
+        // validate token
+        $this->validate_requested_token ();
+        // refresh
+        $this->refresh_token_expiration ();
+        // ok
+        return array("code"=>200, "data"=>array("expires"=>$this->token_expires));
+    }
 
 
 
 
 
 
-	/**
-	 * Deletes token
-	 *
-	 * @access public
-	 * @return void
-	 */
-	public function DELETE () {
-		// block IP
-		$this->validate_block ();
-		// validate token
-		$this->validate_requested_token ();
-		// remove token
-		$this->remove_token ();
-		// result
-		return array("code"=>200, "data"=>array("Token removed"));
-	}
+    /**
+     * Deletes token
+     *
+     * @access public
+     * @return void
+     */
+    public function DELETE () {
+        // block IP
+        $this->validate_block ();
+        // validate token
+        $this->validate_requested_token ();
+        // remove token
+        $this->remove_token ();
+        // result
+        return array("code"=>200, "data"=>array("Token removed"));
+    }
 
 
 
 
 
-	/**
-	 * Checks authentication token and refresh expiration
-	 *
-	 * @access public
-	 * @return void
-	 */
-	public function check_auth () {
-		// block IP
-		$this->validate_block ();
-		// validate token
-		$this->validate_requested_token ();
-		// refresh
-		$this->refresh_token_expiration ();
-	}
+    /**
+     * Checks authentication token and refresh expiration
+     *
+     * @access public
+     * @return void
+     */
+    public function check_auth () {
+        // block IP
+        $this->validate_block ();
+        // validate token
+        $this->validate_requested_token ();
+        // refresh
+        $this->refresh_token_expiration ();
+    }
 
 
 
@@ -265,313 +265,313 @@ 
 
 
 
-	/* @blocks -------------------- */
+    /* @blocks -------------------- */
 
 
-	/**
-	 * Checks if IP should be blocked form access
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function validate_block () {
-		// check if block is permitted
-		if ($this->block_ip === true) {
-			// get count
-			$cnt = $this->User->block_check_ip ();
-			// failure
-			if ($cnt > $this->max_failures) 		{ $this->Response->throw_exception(500, "Your IP has been blocked for 5 minutes because of excesive login failures"); }
-		}
-	}
+    /**
+     * Checks if IP should be blocked form access
+     *
+     * @access private
+     * @return void
+     */
+    private function validate_block () {
+        // check if block is permitted
+        if ($this->block_ip === true) {
+            // get count
+            $cnt = $this->User->block_check_ip ();
+            // failure
+            if ($cnt > $this->max_failures) 		{ $this->Response->throw_exception(500, "Your IP has been blocked for 5 minutes because of excesive login failures"); }
+        }
+    }
 
 
 
 
 
 
-	/* @authentication -------------------- */
+    /* @authentication -------------------- */
 
-	/**
-	 * Authenticates user and returns token and validity
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function authenticate () {
-		# try to authenticate user, it it fails it will fail by itself
-		$this->User->authenticate ($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']);
-
-		# if token is valid and set extend it, otherwise generate new
-		if ($this->validate_user_token ()) {
-			// extend
-			$this->refresh_token_expiration ();
-		}
-		else {
-			// generate new token
-			$this->generate_token ();
-			// save to user
-		    $this->save_user_token ();
-		}
-
-	    # result
-	    return array("code"=>200, "data"=>array("token"=>$this->token, "expires"=>$this->token_expires));
-	}
-
-
-
-
-
-
-
-
-
-
-	/* @tokens -------------------- */
-
-
-	/**
-	 * Sets default validiy for token (default 12 hours)
-	 *
-	 * @access public
-	 * @param int $token_valid_time (default: null)
-	 * @return void
-	 */
-	public function set_token_valid_time ($token_valid_time = null) {
-		// validate integer
-		if ($this->token_length!=null) {
-			if (!is_numeric($this->token_length))	{ $this->Response->throw_exception(500, "token valid time must be an integer"); }
-		}
-		// save
-		$this->token_valid_time = is_null($token_valid_time) ? 21600 : $token_valid_time;
-	}
-
-	/**
-	 * Sets max number of failures before IP is blocked.
-	 *
-	 * @access public
-	 * @param mixed $failures (default: null)
-	 * @return void
-	 */
-	public function set_max_failures ($failures=null) {
-		// validate integer
-		if ($this->token_length!=null) {
-			if (!is_numeric($this->token_length))	{ $this->Response->throw_exception(500, "Max failures must be an integer"); }
-		}
-		// save
-		$this->max_failures = $failures==null ? 10 : $failures;
-	}
-
-	/**
-	 * Block IP address.
-	 *
-	 * @access public
-	 * @param bool $block (default: true)
-	 * @return void
-	 */
-	public function block_ip ($block = true) {
-		// validate integer
-		if (!is_bool($block)) {
-			if (!is_numeric($this->token_length))	{ $this->Response->throw_exception(500, "Max failures must be an integer"); }
-		}
-		// save
-		$this->block_ip = $$block;
-	}
-
-	/**
-	 * Sets length of token
-	 *
-	 * @access public
-	 * @param mixed $length (default: null)
-	 * @return void
-	 */
-	public function set_token_length ($length = null) {
-		// validate number
-		if ($length!=null) {
-			if (!is_numeric($length))				{ $this->Response->throw_exception(500, "token length must be an integer"); }
-			elseif ($length>24)						{ $this->Response->throw_exception(500, "Maximum token length is 24 characters"); }
-		}
-		// save
-		$this->token_length = is_null($length) ? 24 : $length;
-	}
-
-	/**
-	 * Saves new token to database
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function save_user_token () {
-		# set token values
-		$values = array(
-					"id"=>$this->User->user->id,
-					"token"=>$this->token,
-					"token_valid_until"=>$this->token_expires
-					);
-		# save token to database
-		if(!$this->Admin->object_modify ("users", "edit",  "id", $values ))
-													{ $this->Response->throw_exception(500, "Failed to update token"); }
-	}
-
-	/**
-	 * Validates users token from database
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function validate_user_token () {
-		// is set
-		if (strlen($this->User->user->token)==0)							{ return false; }
-		// date not set
-		elseif (strlen($this->User->user->token_valid_until)==0)			{ return false; }
-		// expired
-		elseif ($this->User->user->token_valid_until < date("Y-m-d H:is:"))	{ return false; }
-		// ok
-		else																{ return true; }
-
-	}
-
-	/**
-	 * Validates requested token and saves it to $this->token
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function validate_requested_token () {
-		return $this->_params->controller=="user" ? $this->validate_requested_token_user () : $this->validate_requested_token_general ();
-	}
-
-	/**
-	 * Validates token if User controller is requested - different response
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function validate_requested_token_user () {
-		// check that token is present
-		if(!isset($_SERVER['HTTP_PHPIPAM_TOKEN']))	{ $this->Response->throw_exception(403, "Please provide token"); }
-		// validate and remove token
-		else {
-			// fetch token
-			if(($token = $this->Admin->fetch_object ("users", "token", $_SERVER['HTTP_PHPIPAM_TOKEN'])) === false)
-													{ $this->Response->throw_exception(403, "Invalid token"); }
-			// save token
-			$this->User->user = $token;
-			$this->token = $token->token;
-			$this->token_expires = $token->token_valid_until;
-
-			// expired
-			if($this->validate_token_expiration () === true)
-													{  $this->Response->throw_exception(403, "Token expired");  }
-		}
-	}
-
-	/**
-	 * Validates token if general controller is requested - different response
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function validate_requested_token_general () {
-		// check that token is present
-		if(!isset($_SERVER['HTTP_PHPIPAM_TOKEN']))	{ $this->Response->throw_exception(401, $this->Response->errors[401]); }
-		// validate and remove token
-		else {
-			// fetch token
-			if(($token = $this->Admin->fetch_object ("users", "token", $_SERVER['HTTP_PHPIPAM_TOKEN'])) === false)
-													{ $this->Response->throw_exception(401, $this->Response->errors[401]); }
-			// save token
-			$this->User->user = $token;
-			$this->token = $token->token;
-			$this->token_expires = $token->token_valid_until;
-
-			// expired
-			if($this->validate_token_expiration () === true)
-													{  $this->Response->throw_exception(401, $this->Response->errors[401]);  }
-			// refresh
-			$this->refresh_token_expiration ();
-		}
-	}
-
-
-
-	/**
-	 * Checks if token has expired
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function validate_token_expiration () {
-		return strtotime($this->token_expires) < time() ? true : false;
-	}
-
-	/**
-	 * Refreshes token expireation date in database
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function refresh_token_expiration () {
-		# reset values
-		$this->token = $this->User->user->token;
+    /**
+     * Authenticates user and returns token and validity
+     *
+     * @access private
+     * @return void
+     */
+    private function authenticate () {
+        # try to authenticate user, it it fails it will fail by itself
+        $this->User->authenticate ($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']);
+
+        # if token is valid and set extend it, otherwise generate new
+        if ($this->validate_user_token ()) {
+            // extend
+            $this->refresh_token_expiration ();
+        }
+        else {
+            // generate new token
+            $this->generate_token ();
+            // save to user
+            $this->save_user_token ();
+        }
+
+        # result
+        return array("code"=>200, "data"=>array("token"=>$this->token, "expires"=>$this->token_expires));
+    }
+
+
+
+
+
+
+
+
+
+
+    /* @tokens -------------------- */
+
+
+    /**
+     * Sets default validiy for token (default 12 hours)
+     *
+     * @access public
+     * @param int $token_valid_time (default: null)
+     * @return void
+     */
+    public function set_token_valid_time ($token_valid_time = null) {
+        // validate integer
+        if ($this->token_length!=null) {
+            if (!is_numeric($this->token_length))	{ $this->Response->throw_exception(500, "token valid time must be an integer"); }
+        }
+        // save
+        $this->token_valid_time = is_null($token_valid_time) ? 21600 : $token_valid_time;
+    }
+
+    /**
+     * Sets max number of failures before IP is blocked.
+     *
+     * @access public
+     * @param mixed $failures (default: null)
+     * @return void
+     */
+    public function set_max_failures ($failures=null) {
+        // validate integer
+        if ($this->token_length!=null) {
+            if (!is_numeric($this->token_length))	{ $this->Response->throw_exception(500, "Max failures must be an integer"); }
+        }
+        // save
+        $this->max_failures = $failures==null ? 10 : $failures;
+    }
+
+    /**
+     * Block IP address.
+     *
+     * @access public
+     * @param bool $block (default: true)
+     * @return void
+     */
+    public function block_ip ($block = true) {
+        // validate integer
+        if (!is_bool($block)) {
+            if (!is_numeric($this->token_length))	{ $this->Response->throw_exception(500, "Max failures must be an integer"); }
+        }
+        // save
+        $this->block_ip = $$block;
+    }
+
+    /**
+     * Sets length of token
+     *
+     * @access public
+     * @param mixed $length (default: null)
+     * @return void
+     */
+    public function set_token_length ($length = null) {
+        // validate number
+        if ($length!=null) {
+            if (!is_numeric($length))				{ $this->Response->throw_exception(500, "token length must be an integer"); }
+            elseif ($length>24)						{ $this->Response->throw_exception(500, "Maximum token length is 24 characters"); }
+        }
+        // save
+        $this->token_length = is_null($length) ? 24 : $length;
+    }
+
+    /**
+     * Saves new token to database
+     *
+     * @access private
+     * @return void
+     */
+    private function save_user_token () {
+        # set token values
+        $values = array(
+                    "id"=>$this->User->user->id,
+                    "token"=>$this->token,
+                    "token_valid_until"=>$this->token_expires
+                    );
+        # save token to database
+        if(!$this->Admin->object_modify ("users", "edit",  "id", $values ))
+                                                    { $this->Response->throw_exception(500, "Failed to update token"); }
+    }
+
+    /**
+     * Validates users token from database
+     *
+     * @access private
+     * @return void
+     */
+    private function validate_user_token () {
+        // is set
+        if (strlen($this->User->user->token)==0)							{ return false; }
+        // date not set
+        elseif (strlen($this->User->user->token_valid_until)==0)			{ return false; }
+        // expired
+        elseif ($this->User->user->token_valid_until < date("Y-m-d H:is:"))	{ return false; }
+        // ok
+        else																{ return true; }
+
+    }
+
+    /**
+     * Validates requested token and saves it to $this->token
+     *
+     * @access private
+     * @return void
+     */
+    private function validate_requested_token () {
+        return $this->_params->controller=="user" ? $this->validate_requested_token_user () : $this->validate_requested_token_general ();
+    }
+
+    /**
+     * Validates token if User controller is requested - different response
+     *
+     * @access private
+     * @return void
+     */
+    private function validate_requested_token_user () {
+        // check that token is present
+        if(!isset($_SERVER['HTTP_PHPIPAM_TOKEN']))	{ $this->Response->throw_exception(403, "Please provide token"); }
+        // validate and remove token
+        else {
+            // fetch token
+            if(($token = $this->Admin->fetch_object ("users", "token", $_SERVER['HTTP_PHPIPAM_TOKEN'])) === false)
+                                                    { $this->Response->throw_exception(403, "Invalid token"); }
+            // save token
+            $this->User->user = $token;
+            $this->token = $token->token;
+            $this->token_expires = $token->token_valid_until;
+
+            // expired
+            if($this->validate_token_expiration () === true)
+                                                    {  $this->Response->throw_exception(403, "Token expired");  }
+        }
+    }
+
+    /**
+     * Validates token if general controller is requested - different response
+     *
+     * @access private
+     * @return void
+     */
+    private function validate_requested_token_general () {
+        // check that token is present
+        if(!isset($_SERVER['HTTP_PHPIPAM_TOKEN']))	{ $this->Response->throw_exception(401, $this->Response->errors[401]); }
+        // validate and remove token
+        else {
+            // fetch token
+            if(($token = $this->Admin->fetch_object ("users", "token", $_SERVER['HTTP_PHPIPAM_TOKEN'])) === false)
+                                                    { $this->Response->throw_exception(401, $this->Response->errors[401]); }
+            // save token
+            $this->User->user = $token;
+            $this->token = $token->token;
+            $this->token_expires = $token->token_valid_until;
+
+            // expired
+            if($this->validate_token_expiration () === true)
+                                                    {  $this->Response->throw_exception(401, $this->Response->errors[401]);  }
+            // refresh
+            $this->refresh_token_expiration ();
+        }
+    }
+
+
+
+    /**
+     * Checks if token has expired
+     *
+     * @access private
+     * @return void
+     */
+    private function validate_token_expiration () {
+        return strtotime($this->token_expires) < time() ? true : false;
+    }
+
+    /**
+     * Refreshes token expireation date in database
+     *
+     * @access private
+     * @return void
+     */
+    private function refresh_token_expiration () {
+        # reset values
+        $this->token = $this->User->user->token;
         
-		// convert existing expiry date string to a timestamp
-		$expire_time = strtotime($this->token_expires);
-
-		// Write Throttling from token updates
-		// In order to keep the DB writes from token updates to a minimum, only update the expire time
-		// if the expire time was set more than 60 seconds ago.
-		if ( ((time()+$this->token_valid_time) - $expire_time) < 60) {
-				return;
-		}
-
-		$this->token_expires = date("Y-m-d H:i:s", time()+$this->token_valid_time);
-		# set token values
-		$values = array(
-					"id"=>$this->User->user->id,
-					"token_valid_until"=>$this->token_expires
-					);
-		# save token to database
-		if(!$this->Admin->object_modify ("users", "edit",  "id", $values ))
-													{ $this->Response->throw_exception(500, "Failed to update token expiration date"); }
-	}
-
-	/**
-	 * Removes users token
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function remove_token () {
-		# set token values
-		$values = array(
-					"id"=>$this->User->user->id,
-					"token"=>null,
-					"token_valid_until"=>null
-					);
-		# save token to database
-		if(!$this->Admin->object_modify ("users", "edit",  "id", $values ))
-													{ $this->Response->throw_exception(500, "Failed to remove token"); }
-
-	}
-
-	/**
-	 * Generates new token for user and writes it to database
-	 *
-	 * @access private
-	 * @return void
-	 */
-	private function generate_token () {
-	    $chars 		  = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_$%!=.';
-	    $chars_length = strlen($chars);
-	    // generate string
-	    $token = '';
-	    for ($i = 0; $i < $this->token_length; $i++) {
-	        $token .= $chars[rand(0, $chars_length - 1)];
-	    }
-	    // save token and valid time
-	    $this->token = $token;
-	    $this->token_expires = date("Y-m-d H:i:s", time()+$this->token_valid_time);
-	}
+        // convert existing expiry date string to a timestamp
+        $expire_time = strtotime($this->token_expires);
+
+        // Write Throttling from token updates
+        // In order to keep the DB writes from token updates to a minimum, only update the expire time
+        // if the expire time was set more than 60 seconds ago.
+        if ( ((time()+$this->token_valid_time) - $expire_time) < 60) {
+                return;
+        }
+
+        $this->token_expires = date("Y-m-d H:i:s", time()+$this->token_valid_time);
+        # set token values
+        $values = array(
+                    "id"=>$this->User->user->id,
+                    "token_valid_until"=>$this->token_expires
+                    );
+        # save token to database
+        if(!$this->Admin->object_modify ("users", "edit",  "id", $values ))
+                                                    { $this->Response->throw_exception(500, "Failed to update token expiration date"); }
+    }
+
+    /**
+     * Removes users token
+     *
+     * @access private
+     * @return void
+     */
+    private function remove_token () {
+        # set token values
+        $values = array(
+                    "id"=>$this->User->user->id,
+                    "token"=>null,
+                    "token_valid_until"=>null
+                    );
+        # save token to database
+        if(!$this->Admin->object_modify ("users", "edit",  "id", $values ))
+                                                    { $this->Response->throw_exception(500, "Failed to remove token"); }
+
+    }
+
+    /**
+     * Generates new token for user and writes it to database
+     *
+     * @access private
+     * @return void
+     */
+    private function generate_token () {
+        $chars 		  = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_$%!=.';
+        $chars_length = strlen($chars);
+        // generate string
+        $token = '';
+        for ($i = 0; $i < $this->token_length; $i++) {
+            $token .= $chars[rand(0, $chars_length - 1)];
+        }
+        // save token and valid time
+        $this->token = $token;
+        $this->token_expires = date("Y-m-d H:i:s", time()+$this->token_valid_time);
+    }
 
 }
 

Spacing +59 added lines, -59 removed lines

@@ -110,7 +110,7 @@ 
 	 * @param mixed $params
 	 * @param mixed $Response
 	 */
-	public function __construct ($Database, $Tools=null, $params=null, $Response) {
+	public function __construct ($Database, $Tools = null, $params = null, $Response) {
 		$this->Database = $Database;
 		$this->Response = $Response;
 		$this->_params = $params;
@@ -123,7 +123,7 @@ 
 		$this->set_token_length ();
 
 		// if HTTP_TOKEN is set change it to HTTP_PHPIPAM_TOKEN
-		if (isset($_SERVER['HTTP_TOKEN'])&&!isset($_SERVER['HTTP_PHPIPAM_TOKEN'])) 		{ $_SERVER['HTTP_PHPIPAM_TOKEN'] = $_SERVER['HTTP_TOKEN']; }
+		if (isset($_SERVER['HTTP_TOKEN']) && !isset($_SERVER['HTTP_PHPIPAM_TOKEN'])) { $_SERVER['HTTP_PHPIPAM_TOKEN'] = $_SERVER['HTTP_TOKEN']; }
 	}
 
 
@@ -146,15 +146,15 @@ 
 		$this->validate_options_request ();
 
 		// methods
-		$result = array();
-		$result['methods'] = array(
-								array("href"=>"/api/".$this->_params->app_id."/user/", 	"methods"=>array(array("rel"=>"read", 	"method"=>"GET"),
-																										 array("rel"=>"create", "method"=>"POST"),
-																										 array("rel"=>"update", "method"=>"PATCH"),
-																										 array("rel"=>"delete", "method"=>"DELETE"))),
+		$result = array ();
+		$result['methods'] = array (
+								array ("href"=>"/api/".$this->_params->app_id."/user/", "methods"=>array (array ("rel"=>"read", "method"=>"GET"),
+																										 array ("rel"=>"create", "method"=>"POST"),
+																										 array ("rel"=>"update", "method"=>"PATCH"),
+																										 array ("rel"=>"delete", "method"=>"DELETE"))),
 							);
 		# result
-		return array("code"=>200, "data"=>$result);
+		return array ("code"=>200, "data"=>$result);
 	}
 
 
@@ -176,7 +176,7 @@ 
 		// validate token
 		$this->validate_requested_token ();
 		// ok
-		return array("code"=>200, "data"=>array("expires"=>$this->token_expires));
+		return array ("code"=>200, "data"=>array ("expires"=>$this->token_expires));
 	}
 
 
@@ -214,7 +214,7 @@ 
 		// refresh
 		$this->refresh_token_expiration ();
 		// ok
-		return array("code"=>200, "data"=>array("expires"=>$this->token_expires));
+		return array ("code"=>200, "data"=>array ("expires"=>$this->token_expires));
 	}
 
 
@@ -236,7 +236,7 @@ 
 		// remove token
 		$this->remove_token ();
 		// result
-		return array("code"=>200, "data"=>array("Token removed"));
+		return array ("code"=>200, "data"=>array ("Token removed"));
 	}
 
 
@@ -280,7 +280,7 @@ 
 			// get count
 			$cnt = $this->User->block_check_ip ();
 			// failure
-			if ($cnt > $this->max_failures) 		{ $this->Response->throw_exception(500, "Your IP has been blocked for 5 minutes because of excesive login failures"); }
+			if ($cnt > $this->max_failures) { $this->Response->throw_exception (500, "Your IP has been blocked for 5 minutes because of excesive login failures"); }
 		}
 	}
 
@@ -314,7 +314,7 @@ 
 		}
 
 	    # result
-	    return array("code"=>200, "data"=>array("token"=>$this->token, "expires"=>$this->token_expires));
+	    return array ("code"=>200, "data"=>array ("token"=>$this->token, "expires"=>$this->token_expires));
 	}
 
 
@@ -338,11 +338,11 @@ 
 	 */
 	public function set_token_valid_time ($token_valid_time = null) {
 		// validate integer
-		if ($this->token_length!=null) {
-			if (!is_numeric($this->token_length))	{ $this->Response->throw_exception(500, "token valid time must be an integer"); }
+		if ($this->token_length != null) {
+			if (!is_numeric ($this->token_length)) { $this->Response->throw_exception (500, "token valid time must be an integer"); }
 		}
 		// save
-		$this->token_valid_time = is_null($token_valid_time) ? 21600 : $token_valid_time;
+		$this->token_valid_time = is_null ($token_valid_time) ? 21600 : $token_valid_time;
 	}
 
 	/**
@@ -352,13 +352,13 @@ 
 	 * @param mixed $failures (default: null)
 	 * @return void
 	 */
-	public function set_max_failures ($failures=null) {
+	public function set_max_failures ($failures = null) {
 		// validate integer
-		if ($this->token_length!=null) {
-			if (!is_numeric($this->token_length))	{ $this->Response->throw_exception(500, "Max failures must be an integer"); }
+		if ($this->token_length != null) {
+			if (!is_numeric ($this->token_length)) { $this->Response->throw_exception (500, "Max failures must be an integer"); }
 		}
 		// save
-		$this->max_failures = $failures==null ? 10 : $failures;
+		$this->max_failures = $failures == null ? 10 : $failures;
 	}
 
 	/**
@@ -370,8 +370,8 @@ 
 	 */
 	public function block_ip ($block = true) {
 		// validate integer
-		if (!is_bool($block)) {
-			if (!is_numeric($this->token_length))	{ $this->Response->throw_exception(500, "Max failures must be an integer"); }
+		if (!is_bool ($block)) {
+			if (!is_numeric ($this->token_length)) { $this->Response->throw_exception (500, "Max failures must be an integer"); }
 		}
 		// save
 		$this->block_ip = $$block;
@@ -386,12 +386,12 @@ 
 	 */
 	public function set_token_length ($length = null) {
 		// validate number
-		if ($length!=null) {
-			if (!is_numeric($length))				{ $this->Response->throw_exception(500, "token length must be an integer"); }
-			elseif ($length>24)						{ $this->Response->throw_exception(500, "Maximum token length is 24 characters"); }
+		if ($length != null) {
+			if (!is_numeric ($length)) { $this->Response->throw_exception (500, "token length must be an integer"); }
+			elseif ($length > 24) { $this->Response->throw_exception (500, "Maximum token length is 24 characters"); }
 		}
 		// save
-		$this->token_length = is_null($length) ? 24 : $length;
+		$this->token_length = is_null ($length) ? 24 : $length;
 	}
 
 	/**
@@ -402,14 +402,14 @@ 
 	 */
 	private function save_user_token () {
 		# set token values
-		$values = array(
+		$values = array (
 					"id"=>$this->User->user->id,
 					"token"=>$this->token,
 					"token_valid_until"=>$this->token_expires
 					);
 		# save token to database
-		if(!$this->Admin->object_modify ("users", "edit",  "id", $values ))
-													{ $this->Response->throw_exception(500, "Failed to update token"); }
+		if (!$this->Admin->object_modify ("users", "edit", "id", $values))
+													{ $this->Response->throw_exception (500, "Failed to update token"); }
 	}
 
 	/**
@@ -420,13 +420,13 @@ 
 	 */
 	private function validate_user_token () {
 		// is set
-		if (strlen($this->User->user->token)==0)							{ return false; }
+		if (strlen ($this->User->user->token) == 0) { return false; }
 		// date not set
-		elseif (strlen($this->User->user->token_valid_until)==0)			{ return false; }
+		elseif (strlen ($this->User->user->token_valid_until) == 0) { return false; }
 		// expired
-		elseif ($this->User->user->token_valid_until < date("Y-m-d H:is:"))	{ return false; }
+		elseif ($this->User->user->token_valid_until < date ("Y-m-d H:is:")) { return false; }
 		// ok
-		else																{ return true; }
+		else { return true; }
 
 	}
 
@@ -437,7 +437,7 @@ 
 	 * @return void
 	 */
 	private function validate_requested_token () {
-		return $this->_params->controller=="user" ? $this->validate_requested_token_user () : $this->validate_requested_token_general ();
+		return $this->_params->controller == "user" ? $this->validate_requested_token_user () : $this->validate_requested_token_general ();
 	}
 
 	/**
@@ -448,20 +448,20 @@ 
 	 */
 	private function validate_requested_token_user () {
 		// check that token is present
-		if(!isset($_SERVER['HTTP_PHPIPAM_TOKEN']))	{ $this->Response->throw_exception(403, "Please provide token"); }
+		if (!isset($_SERVER['HTTP_PHPIPAM_TOKEN'])) { $this->Response->throw_exception (403, "Please provide token"); }
 		// validate and remove token
 		else {
 			// fetch token
-			if(($token = $this->Admin->fetch_object ("users", "token", $_SERVER['HTTP_PHPIPAM_TOKEN'])) === false)
-													{ $this->Response->throw_exception(403, "Invalid token"); }
+			if (($token = $this->Admin->fetch_object ("users", "token", $_SERVER['HTTP_PHPIPAM_TOKEN'])) === false)
+													{ $this->Response->throw_exception (403, "Invalid token"); }
 			// save token
 			$this->User->user = $token;
 			$this->token = $token->token;
 			$this->token_expires = $token->token_valid_until;
 
 			// expired
-			if($this->validate_token_expiration () === true)
-													{  $this->Response->throw_exception(403, "Token expired");  }
+			if ($this->validate_token_expiration () === true)
+													{  $this->Response->throw_exception (403, "Token expired"); }
 		}
 	}
 
@@ -473,20 +473,20 @@ 
 	 */
 	private function validate_requested_token_general () {
 		// check that token is present
-		if(!isset($_SERVER['HTTP_PHPIPAM_TOKEN']))	{ $this->Response->throw_exception(401, $this->Response->errors[401]); }
+		if (!isset($_SERVER['HTTP_PHPIPAM_TOKEN'])) { $this->Response->throw_exception (401, $this->Response->errors[401]); }
 		// validate and remove token
 		else {
 			// fetch token
-			if(($token = $this->Admin->fetch_object ("users", "token", $_SERVER['HTTP_PHPIPAM_TOKEN'])) === false)
-													{ $this->Response->throw_exception(401, $this->Response->errors[401]); }
+			if (($token = $this->Admin->fetch_object ("users", "token", $_SERVER['HTTP_PHPIPAM_TOKEN'])) === false)
+													{ $this->Response->throw_exception (401, $this->Response->errors[401]); }
 			// save token
 			$this->User->user = $token;
 			$this->token = $token->token;
 			$this->token_expires = $token->token_valid_until;
 
 			// expired
-			if($this->validate_token_expiration () === true)
-													{  $this->Response->throw_exception(401, $this->Response->errors[401]);  }
+			if ($this->validate_token_expiration () === true)
+													{  $this->Response->throw_exception (401, $this->Response->errors[401]); }
 			// refresh
 			$this->refresh_token_expiration ();
 		}
@@ -501,7 +501,7 @@ 
 	 * @return void
 	 */
 	private function validate_token_expiration () {
-		return strtotime($this->token_expires) < time() ? true : false;
+		return strtotime ($this->token_expires) < time () ? true : false;
 	}
 
 	/**
@@ -515,24 +515,24 @@ 
 		$this->token = $this->User->user->token;
         
 		// convert existing expiry date string to a timestamp
-		$expire_time = strtotime($this->token_expires);
+		$expire_time = strtotime ($this->token_expires);
 
 		// Write Throttling from token updates
 		// In order to keep the DB writes from token updates to a minimum, only update the expire time
 		// if the expire time was set more than 60 seconds ago.
-		if ( ((time()+$this->token_valid_time) - $expire_time) < 60) {
+		if (((time () + $this->token_valid_time) - $expire_time) < 60) {
 				return;
 		}
 
-		$this->token_expires = date("Y-m-d H:i:s", time()+$this->token_valid_time);
+		$this->token_expires = date ("Y-m-d H:i:s", time () + $this->token_valid_time);
 		# set token values
-		$values = array(
+		$values = array (
 					"id"=>$this->User->user->id,
 					"token_valid_until"=>$this->token_expires
 					);
 		# save token to database
-		if(!$this->Admin->object_modify ("users", "edit",  "id", $values ))
-													{ $this->Response->throw_exception(500, "Failed to update token expiration date"); }
+		if (!$this->Admin->object_modify ("users", "edit", "id", $values))
+													{ $this->Response->throw_exception (500, "Failed to update token expiration date"); }
 	}
 
 	/**
@@ -543,14 +543,14 @@ 
 	 */
 	private function remove_token () {
 		# set token values
-		$values = array(
+		$values = array (
 					"id"=>$this->User->user->id,
 					"token"=>null,
 					"token_valid_until"=>null
 					);
 		# save token to database
-		if(!$this->Admin->object_modify ("users", "edit",  "id", $values ))
-													{ $this->Response->throw_exception(500, "Failed to remove token"); }
+		if (!$this->Admin->object_modify ("users", "edit", "id", $values))
+													{ $this->Response->throw_exception (500, "Failed to remove token"); }
 
 	}
 
@@ -561,16 +561,16 @@ 
 	 * @return void
 	 */
 	private function generate_token () {
-	    $chars 		  = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_$%!=.';
-	    $chars_length = strlen($chars);
+	    $chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_$%!=.';
+	    $chars_length = strlen ($chars);
 	    // generate string
 	    $token = '';
 	    for ($i = 0; $i < $this->token_length; $i++) {
-	        $token .= $chars[rand(0, $chars_length - 1)];
+	        $token .= $chars[rand (0, $chars_length - 1)];
 	    }
 	    // save token and valid time
 	    $this->token = $token;
-	    $this->token_expires = date("Y-m-d H:i:s", time()+$this->token_valid_time);
+	    $this->token_expires = date ("Y-m-d H:i:s", time () + $this->token_valid_time);
 	}
 
 }

api/index.php

Indentation +106 added lines, -106 removed lines

@@ -37,60 +37,60 @@ 
 
 # set empty controller for options
 if($_SERVER['REQUEST_METHOD']=="OPTIONS") {
-	if( !isset($_GET['controller']) || $_GET['controller']=="")	{ $_GET['controller'] = "Tools"; }
+    if( !isset($_GET['controller']) || $_GET['controller']=="")	{ $_GET['controller'] = "Tools"; }
 }
 
 /* wrap in a try-catch block to catch exceptions */
 try {
 
-	/* Validate application ---------- */
-
-	// verify that API is enabled on server
-	if($settings->api!=1) 									{ $Response->throw_exception(503, "API server disabled");}
-
-	# fetch app
-	$app = $Tools->fetch_object ("api", "app_id", $_GET['app_id']);
-
-	// verify app_id
-	if($app === false) 										{ $Response->throw_exception(400, "Invalid application id"); }
-	// check that app is enabled
-	if($app->app_permissions==="0") 						{ $Response->throw_exception(503, "Application disabled"); }
-
-
-	/* Check app security and prepare request parameters ---------- */
-
-	// crypt check
-	if($app->app_security=="crypt") {
-		// verify php extensions
-		foreach (array("mcrypt") as $extension) {
-	    	if (!in_array($extension, get_loaded_extensions()))
-	    													{ $Response->throw_exception(500, 'php extension '.$extension.' missing'); }
-		}
-		// decrypt request - to JSON
-		$params = json_decode(trim(mcrypt_decrypt(MCRYPT_RIJNDAEL_256, $app->app_code, base64_decode($_GET['enc_request']), MCRYPT_MODE_ECB)));
-	}
-	// SSL checks
-	elseif($app->app_security=="ssl") {
-		// verify SSL
-		if (!((!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off') || $_SERVER['SERVER_PORT'] == 443)) {
-															{ $Response->throw_exception(503, 'App requires SSL connection'); }
-		}
-		// save request parameters
-		$params = (object) $_GET;
-	}
-	// no security
-	elseif($app->app_security=="none") {
-		$params = (object) $_GET;
-	}
-	// error, invalid security
-	else {
-		$Response->throw_exception(503, 'Invalid app security');
-	}
-
-
-	// append POST parameters if POST or PATCH
-	if($_SERVER['REQUEST_METHOD']=="POST" || $_SERVER['REQUEST_METHOD']=="PATCH"){
-		// if application tupe is JSON (application/json)
+    /* Validate application ---------- */
+
+    // verify that API is enabled on server
+    if($settings->api!=1) 									{ $Response->throw_exception(503, "API server disabled");}
+
+    # fetch app
+    $app = $Tools->fetch_object ("api", "app_id", $_GET['app_id']);
+
+    // verify app_id
+    if($app === false) 										{ $Response->throw_exception(400, "Invalid application id"); }
+    // check that app is enabled
+    if($app->app_permissions==="0") 						{ $Response->throw_exception(503, "Application disabled"); }
+
+
+    /* Check app security and prepare request parameters ---------- */
+
+    // crypt check
+    if($app->app_security=="crypt") {
+        // verify php extensions
+        foreach (array("mcrypt") as $extension) {
+            if (!in_array($extension, get_loaded_extensions()))
+                                                            { $Response->throw_exception(500, 'php extension '.$extension.' missing'); }
+        }
+        // decrypt request - to JSON
+        $params = json_decode(trim(mcrypt_decrypt(MCRYPT_RIJNDAEL_256, $app->app_code, base64_decode($_GET['enc_request']), MCRYPT_MODE_ECB)));
+    }
+    // SSL checks
+    elseif($app->app_security=="ssl") {
+        // verify SSL
+        if (!((!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off') || $_SERVER['SERVER_PORT'] == 443)) {
+                                                            { $Response->throw_exception(503, 'App requires SSL connection'); }
+        }
+        // save request parameters
+        $params = (object) $_GET;
+    }
+    // no security
+    elseif($app->app_security=="none") {
+        $params = (object) $_GET;
+    }
+    // error, invalid security
+    else {
+        $Response->throw_exception(503, 'Invalid app security');
+    }
+
+
+    // append POST parameters if POST or PATCH
+    if($_SERVER['REQUEST_METHOD']=="POST" || $_SERVER['REQUEST_METHOD']=="PATCH"){
+        // if application tupe is JSON (application/json)
         if($_SERVER['CONTENT_TYPE']=="application/json"){
                 $rawPostData = file_get_contents('php://input');
                 $json = json_decode($rawPostData,true);
@@ -98,7 +98,7 @@ 
                 $params = array_merge((array) $params, $json);
                 $params = (object) $params;
         }
-		// if application tupe is XML (application/json)
+        // if application tupe is XML (application/json)
         elseif($_SERVER['CONTENT_TYPE']=="application/xml"){
                 $rawPostData = file_get_contents('php://input');
                 $xml = $Response->xml_to_array($rawPostData);
@@ -106,7 +106,7 @@ 
                 $params = array_merge((array) $params, $xml);
                 $params = (object) $params;
         }
-		//if application type is default (application/x-www-form-urlencoded)
+        //if application type is default (application/x-www-form-urlencoded)
         elseif(sizeof(@$_POST)>0) {
                 $params = array_merge((array) $params, $_POST);
                 $params = (object) $params;
@@ -116,74 +116,74 @@ 
 
 
 
-	/* Authentication ---------- */
+    /* Authentication ---------- */
 
-	# authenticate user if required
-	if (@$params->controller != "user" && $enable_authentication) {
-		if($app->app_security=="ssl" || $app->app_security=="none") {
-			// start auth class and validate connection
-			require( dirname(__FILE__) . '/controllers/User.php');				// authentication and token handling
-			$Authentication = new User_controller ($Database, $Tools, $params, $Response);
-			$Authentication->check_auth ();
-		}
-	}
+    # authenticate user if required
+    if (@$params->controller != "user" && $enable_authentication) {
+        if($app->app_security=="ssl" || $app->app_security=="none") {
+            // start auth class and validate connection
+            require( dirname(__FILE__) . '/controllers/User.php');				// authentication and token handling
+            $Authentication = new User_controller ($Database, $Tools, $params, $Response);
+            $Authentication->check_auth ();
+        }
+    }
 
 
-	/* verify request ---------- */
+    /* verify request ---------- */
 
-	// check if the request is valid by checking if it's an array and looking for the controller and action
-	if( $params == false || isset($params->controller) == false ) {
-		$Response->throw_exception(400, 'Request is not valid');
-	}
-	// verify permissions for delete/create/edit if controller is not user (needed for auth)
-	if (@$params->controller != "user") {
-    	if( ($_SERVER['REQUEST_METHOD']=="POST" || $_SERVER['REQUEST_METHOD']=="PATCH"
-    	  || $_SERVER['REQUEST_METHOD']=="PUT"  || $_SERVER['REQUEST_METHOD']=="DELETE"
-    	  )
-    	  && $app->app_permissions<2) {
-    		$Response->throw_exception(401, 'invalid permissions');
-    	}
-	}
-	// verify content type
-	$Response->validate_content_type ();
+    // check if the request is valid by checking if it's an array and looking for the controller and action
+    if( $params == false || isset($params->controller) == false ) {
+        $Response->throw_exception(400, 'Request is not valid');
+    }
+    // verify permissions for delete/create/edit if controller is not user (needed for auth)
+    if (@$params->controller != "user") {
+        if( ($_SERVER['REQUEST_METHOD']=="POST" || $_SERVER['REQUEST_METHOD']=="PATCH"
+          || $_SERVER['REQUEST_METHOD']=="PUT"  || $_SERVER['REQUEST_METHOD']=="DELETE"
+            )
+          && $app->app_permissions<2) {
+            $Response->throw_exception(401, 'invalid permissions');
+        }
+    }
+    // verify content type
+    $Response->validate_content_type ();
 
 
-	/* Initialize controller ---------- */
+    /* Initialize controller ---------- */
 
-	//get the controller and format it correctly
-	$controller 	 = ucfirst(strtolower($params->controller))."_controller";
-	$controller_file = ucfirst(strtolower($params->controller));
+    //get the controller and format it correctly
+    $controller 	 = ucfirst(strtolower($params->controller))."_controller";
+    $controller_file = ucfirst(strtolower($params->controller));
 
-	//check if the controller exists. if not, throw an exception
-	if( file_exists( dirname(__FILE__) . "/controllers/$controller_file.php") ) {
-		require( dirname(__FILE__) . "/controllers/$controller_file.php");
-	} else {
-		$Response->throw_exception(400, 'invalid controller');
-	}
+    //check if the controller exists. if not, throw an exception
+    if( file_exists( dirname(__FILE__) . "/controllers/$controller_file.php") ) {
+        require( dirname(__FILE__) . "/controllers/$controller_file.php");
+    } else {
+        $Response->throw_exception(400, 'invalid controller');
+    }
 
-	//create a new instance of the controller, and pass
-	//it the parameters from the request and Database object
-	$controller = new $controller($Database, $Tools, $params, $Response);
+    //create a new instance of the controller, and pass
+    //it the parameters from the request and Database object
+    $controller = new $controller($Database, $Tools, $params, $Response);
 
-	//check if the action exists in the controller. if not, throw an exception.
-	if( method_exists($controller, strtolower($_SERVER['REQUEST_METHOD'])) === false ) {
-		$Response->throw_exception(501, $Response->errors[501]);
-	}
+    //check if the action exists in the controller. if not, throw an exception.
+    if( method_exists($controller, strtolower($_SERVER['REQUEST_METHOD'])) === false ) {
+        $Response->throw_exception(501, $Response->errors[501]);
+    }
 
-	//execute the action
-	$result = $controller->$_SERVER['REQUEST_METHOD'] ();
+    //execute the action
+    $result = $controller->$_SERVER['REQUEST_METHOD'] ();
 
 } catch ( Exception $e ) {
-	//catch any exceptions and report the problem
-	$result = $e->getMessage();
-
-	//set flag if it came from Result, just to be sure
-	if($Response->exception!==true) {
-		$Response->exception = true;
-		$Response->result['success'] = false;
-		$Response->result['code'] 	 = 500;
-		$Response->result['message'] = $result;
-	}
+    //catch any exceptions and report the problem
+    $result = $e->getMessage();
+
+    //set flag if it came from Result, just to be sure
+    if($Response->exception!==true) {
+        $Response->exception = true;
+        $Response->result['success'] = false;
+        $Response->result['code'] 	 = 500;
+        $Response->result['message'] = $result;
+    }
 }
 
 

Braces +11 added lines, -8 removed lines

@@ -89,21 +89,23 @@ 
 
 
 	// append POST parameters if POST or PATCH
-	if($_SERVER['REQUEST_METHOD']=="POST" || $_SERVER['REQUEST_METHOD']=="PATCH"){
+	if($_SERVER['REQUEST_METHOD']=="POST" || $_SERVER['REQUEST_METHOD']=="PATCH") {
 		// if application tupe is JSON (application/json)
-        if($_SERVER['CONTENT_TYPE']=="application/json"){
+        if($_SERVER['CONTENT_TYPE']=="application/json") {
                 $rawPostData = file_get_contents('php://input');
                 $json = json_decode($rawPostData,true);
-                if(is_array($json))
-                $params = array_merge((array) $params, $json);
+                if(is_array($json)) {
+                                $params = array_merge((array) $params, $json);
+                }
                 $params = (object) $params;
         }
 		// if application tupe is XML (application/json)
-        elseif($_SERVER['CONTENT_TYPE']=="application/xml"){
+        elseif($_SERVER['CONTENT_TYPE']=="application/xml") {
                 $rawPostData = file_get_contents('php://input');
                 $xml = $Response->xml_to_array($rawPostData);
-                if(is_array($xml))
-                $params = array_merge((array) $params, $xml);
+                if(is_array($xml)) {
+                                $params = array_merge((array) $params, $xml);
+                }
                 $params = (object) $params;
         }
 		//if application type is default (application/x-www-form-urlencoded)
@@ -157,7 +159,8 @@ 
 	//check if the controller exists. if not, throw an exception
 	if( file_exists( dirname(__FILE__) . "/controllers/$controller_file.php") ) {
 		require( dirname(__FILE__) . "/controllers/$controller_file.php");
-	} else {
+	}
+	else {
 		$Response->throw_exception(400, 'invalid controller');
 	}
 

Spacing +51 added lines, -51 removed lines

@@ -18,9 +18,9 @@ 
  */
 
 # include funtions
-require( dirname(__FILE__) . '/../functions/functions.php');		// functions and objects from phpipam
-require( dirname(__FILE__) . '/controllers/Common.php');			// common methods
-require( dirname(__FILE__) . '/controllers/Responses.php');			// exception, header and response handling
+require(dirname (__FILE__).'/../functions/functions.php'); // functions and objects from phpipam
+require(dirname (__FILE__).'/controllers/Common.php'); // common methods
+require(dirname (__FILE__).'/controllers/Responses.php'); // exception, header and response handling
 
 # settings
 $enable_authentication = true;
@@ -33,11 +33,11 @@ 
 $Response = new Responses ();
 
 # get phpipam settings
-$settings 	= $Tools->fetch_object ("settings", "id", 1);
+$settings = $Tools->fetch_object ("settings", "id", 1);
 
 # set empty controller for options
-if($_SERVER['REQUEST_METHOD']=="OPTIONS") {
-	if( !isset($_GET['controller']) || $_GET['controller']=="")	{ $_GET['controller'] = "Tools"; }
+if ($_SERVER['REQUEST_METHOD'] == "OPTIONS") {
+	if (!isset($_GET['controller']) || $_GET['controller'] == "") { $_GET['controller'] = "Tools"; }
 }
 
 /* wrap in a try-catch block to catch exceptions */
@@ -46,69 +46,69 @@ 
 	/* Validate application ---------- */
 
 	// verify that API is enabled on server
-	if($settings->api!=1) 									{ $Response->throw_exception(503, "API server disabled");}
+	if ($settings->api != 1) { $Response->throw_exception (503, "API server disabled"); }
 
 	# fetch app
 	$app = $Tools->fetch_object ("api", "app_id", $_GET['app_id']);
 
 	// verify app_id
-	if($app === false) 										{ $Response->throw_exception(400, "Invalid application id"); }
+	if ($app === false) { $Response->throw_exception (400, "Invalid application id"); }
 	// check that app is enabled
-	if($app->app_permissions==="0") 						{ $Response->throw_exception(503, "Application disabled"); }
+	if ($app->app_permissions === "0") { $Response->throw_exception (503, "Application disabled"); }
 
 
 	/* Check app security and prepare request parameters ---------- */
 
 	// crypt check
-	if($app->app_security=="crypt") {
+	if ($app->app_security == "crypt") {
 		// verify php extensions
-		foreach (array("mcrypt") as $extension) {
-	    	if (!in_array($extension, get_loaded_extensions()))
-	    													{ $Response->throw_exception(500, 'php extension '.$extension.' missing'); }
+		foreach (array ("mcrypt") as $extension) {
+	    	if (!in_array ($extension, get_loaded_extensions ()))
+	    													{ $Response->throw_exception (500, 'php extension '.$extension.' missing'); }
 		}
 		// decrypt request - to JSON
-		$params = json_decode(trim(mcrypt_decrypt(MCRYPT_RIJNDAEL_256, $app->app_code, base64_decode($_GET['enc_request']), MCRYPT_MODE_ECB)));
+		$params = json_decode (trim (mcrypt_decrypt (MCRYPT_RIJNDAEL_256, $app->app_code, base64_decode ($_GET['enc_request']), MCRYPT_MODE_ECB)));
 	}
 	// SSL checks
-	elseif($app->app_security=="ssl") {
+	elseif ($app->app_security == "ssl") {
 		// verify SSL
 		if (!((!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off') || $_SERVER['SERVER_PORT'] == 443)) {
-															{ $Response->throw_exception(503, 'App requires SSL connection'); }
+															{ $Response->throw_exception (503, 'App requires SSL connection'); }
 		}
 		// save request parameters
 		$params = (object) $_GET;
 	}
 	// no security
-	elseif($app->app_security=="none") {
+	elseif ($app->app_security == "none") {
 		$params = (object) $_GET;
 	}
 	// error, invalid security
 	else {
-		$Response->throw_exception(503, 'Invalid app security');
+		$Response->throw_exception (503, 'Invalid app security');
 	}
 
 
 	// append POST parameters if POST or PATCH
-	if($_SERVER['REQUEST_METHOD']=="POST" || $_SERVER['REQUEST_METHOD']=="PATCH"){
+	if ($_SERVER['REQUEST_METHOD'] == "POST" || $_SERVER['REQUEST_METHOD'] == "PATCH") {
 		// if application tupe is JSON (application/json)
-        if($_SERVER['CONTENT_TYPE']=="application/json"){
-                $rawPostData = file_get_contents('php://input');
-                $json = json_decode($rawPostData,true);
-                if(is_array($json))
-                $params = array_merge((array) $params, $json);
+        if ($_SERVER['CONTENT_TYPE'] == "application/json") {
+                $rawPostData = file_get_contents ('php://input');
+                $json = json_decode ($rawPostData, true);
+                if (is_array ($json))
+                $params = array_merge ((array) $params, $json);
                 $params = (object) $params;
         }
 		// if application tupe is XML (application/json)
-        elseif($_SERVER['CONTENT_TYPE']=="application/xml"){
-                $rawPostData = file_get_contents('php://input');
-                $xml = $Response->xml_to_array($rawPostData);
-                if(is_array($xml))
-                $params = array_merge((array) $params, $xml);
+        elseif ($_SERVER['CONTENT_TYPE'] == "application/xml") {
+                $rawPostData = file_get_contents ('php://input');
+                $xml = $Response->xml_to_array ($rawPostData);
+                if (is_array ($xml))
+                $params = array_merge ((array) $params, $xml);
                 $params = (object) $params;
         }
 		//if application type is default (application/x-www-form-urlencoded)
-        elseif(sizeof(@$_POST)>0) {
-                $params = array_merge((array) $params, $_POST);
+        elseif (sizeof (@$_POST) > 0) {
+                $params = array_merge ((array) $params, $_POST);
                 $params = (object) $params;
         }
     }
@@ -120,9 +120,9 @@ 
 
 	# authenticate user if required
 	if (@$params->controller != "user" && $enable_authentication) {
-		if($app->app_security=="ssl" || $app->app_security=="none") {
+		if ($app->app_security == "ssl" || $app->app_security == "none") {
 			// start auth class and validate connection
-			require( dirname(__FILE__) . '/controllers/User.php');				// authentication and token handling
+			require(dirname (__FILE__).'/controllers/User.php'); // authentication and token handling
 			$Authentication = new User_controller ($Database, $Tools, $params, $Response);
 			$Authentication->check_auth ();
 		}
@@ -132,16 +132,16 @@ 
 	/* verify request ---------- */
 
 	// check if the request is valid by checking if it's an array and looking for the controller and action
-	if( $params == false || isset($params->controller) == false ) {
-		$Response->throw_exception(400, 'Request is not valid');
+	if ($params == false || isset($params->controller) == false) {
+		$Response->throw_exception (400, 'Request is not valid');
 	}
 	// verify permissions for delete/create/edit if controller is not user (needed for auth)
 	if (@$params->controller != "user") {
-    	if( ($_SERVER['REQUEST_METHOD']=="POST" || $_SERVER['REQUEST_METHOD']=="PATCH"
-    	  || $_SERVER['REQUEST_METHOD']=="PUT"  || $_SERVER['REQUEST_METHOD']=="DELETE"
+    	if (($_SERVER['REQUEST_METHOD'] == "POST" || $_SERVER['REQUEST_METHOD'] == "PATCH"
+    	  || $_SERVER['REQUEST_METHOD'] == "PUT" || $_SERVER['REQUEST_METHOD'] == "DELETE"
     	  )
-    	  && $app->app_permissions<2) {
-    		$Response->throw_exception(401, 'invalid permissions');
+    	  && $app->app_permissions < 2) {
+    		$Response->throw_exception (401, 'invalid permissions');
     	}
 	}
 	// verify content type
@@ -151,37 +151,37 @@ 
 	/* Initialize controller ---------- */
 
 	//get the controller and format it correctly
-	$controller 	 = ucfirst(strtolower($params->controller))."_controller";
-	$controller_file = ucfirst(strtolower($params->controller));
+	$controller = ucfirst (strtolower ($params->controller))."_controller";
+	$controller_file = ucfirst (strtolower ($params->controller));
 
 	//check if the controller exists. if not, throw an exception
-	if( file_exists( dirname(__FILE__) . "/controllers/$controller_file.php") ) {
-		require( dirname(__FILE__) . "/controllers/$controller_file.php");
+	if (file_exists (dirname (__FILE__)."/controllers/$controller_file.php")) {
+		require(dirname (__FILE__)."/controllers/$controller_file.php");
 	} else {
-		$Response->throw_exception(400, 'invalid controller');
+		$Response->throw_exception (400, 'invalid controller');
 	}
 
 	//create a new instance of the controller, and pass
 	//it the parameters from the request and Database object
-	$controller = new $controller($Database, $Tools, $params, $Response);
+	$controller = new $controller ($Database, $Tools, $params, $Response);
 
 	//check if the action exists in the controller. if not, throw an exception.
-	if( method_exists($controller, strtolower($_SERVER['REQUEST_METHOD'])) === false ) {
-		$Response->throw_exception(501, $Response->errors[501]);
+	if (method_exists ($controller, strtolower ($_SERVER['REQUEST_METHOD'])) === false) {
+		$Response->throw_exception (501, $Response->errors[501]);
 	}
 
 	//execute the action
 	$result = $controller->$_SERVER['REQUEST_METHOD'] ();
 
-} catch ( Exception $e ) {
+} catch (Exception $e) {
 	//catch any exceptions and report the problem
-	$result = $e->getMessage();
+	$result = $e->getMessage ();
 
 	//set flag if it came from Result, just to be sure
-	if($Response->exception!==true) {
+	if ($Response->exception !== true) {
 		$Response->exception = true;
 		$Response->result['success'] = false;
-		$Response->result['code'] 	 = 500;
+		$Response->result['code'] = 500;
 		$Response->result['message'] = $result;
 	}
 }