jens-maus / carddav2fb

lib/fritzbox_api_php/fritzbox_api.class.php

Indentation +144 added lines, -144 removed lines

@@ -48,70 +48,70 @@ 
  */
 class fritzbox_api {
   /**
-    * @var  object  config object
-    */
+   * @var  object  config object
+   */
   public $config = array();
   
   /**
-    * @var  string  the session ID, set by method initSID() after login
-    */
+   * @var  string  the session ID, set by method initSID() after login
+   */
   protected $sid = '0000000000000000';
   
   
   /**
-    * the constructor, initializes the object and calls the login method
-    * 
-    * @access public
-    */
+   * the constructor, initializes the object and calls the login method
+   * 
+   * @access public
+   */
   public function __construct($password = false,$user_name = false,$fritzbox_ip = 'fritz.box',$force_local_login = false)
   {
-	// init the config object
-	$this->config = new fritzbox_api_config();
+  // init the config object
+  $this->config = new fritzbox_api_config();
     
-	// try autoloading the config
-	if (file_exists(__DIR__ . '/fritzbox_user.conf.php') && is_readable(__DIR__ . '/fritzbox_user.conf.php') ) {
-		require_once(__DIR__ . '/fritzbox_user.conf.php');
-	}
+  // try autoloading the config
+  if (file_exists(__DIR__ . '/fritzbox_user.conf.php') && is_readable(__DIR__ . '/fritzbox_user.conf.php') ) {
+    require_once(__DIR__ . '/fritzbox_user.conf.php');
+  }
 
-	// set FRITZ!Box-IP and URL
-	$this->config->setItem('fritzbox_ip',$fritzbox_ip);
+  // set FRITZ!Box-IP and URL
+  $this->config->setItem('fritzbox_ip',$fritzbox_ip);
 
-	// check if login on local network (fritz.box) or via a dynamic DNS-host
-	if ($fritzbox_ip != 'fritz.box' && !$force_local_login) {
-		$this->config->setItem('enable_remote_config',true);
-		$this->config->setItem('remote_config_user',$user_name);
-		$this->config->setItem('remote_config_password',$password);
-		$this->config->setItem('fritzbox_url', 'https://'.$this->config->getItem('fritzbox_ip'));
-	} else {
-		$this->config->setItem('enable_remote_config',false);
-		if($user_name != false){
-			$this->config->setItem('username',$user_name);
-		}
-		if($password != false){
-			$this->config->setItem('password',$password);
-		}
-		$this->config->setItem('fritzbox_url', 'http://' . $this->config->getItem('fritzbox_ip'));
-	}
+  // check if login on local network (fritz.box) or via a dynamic DNS-host
+  if ($fritzbox_ip != 'fritz.box' && !$force_local_login) {
+    $this->config->setItem('enable_remote_config',true);
+    $this->config->setItem('remote_config_user',$user_name);
+    $this->config->setItem('remote_config_password',$password);
+    $this->config->setItem('fritzbox_url', 'https://'.$this->config->getItem('fritzbox_ip'));
+  } else {
+    $this->config->setItem('enable_remote_config',false);
+    if($user_name != false){
+      $this->config->setItem('username',$user_name);
+    }
+    if($password != false){
+      $this->config->setItem('password',$password);
+    }
+    $this->config->setItem('fritzbox_url', 'http://' . $this->config->getItem('fritzbox_ip'));
+  }
 
-	// make some config consistency checks
-	if ( $this->config->getItem('enable_remote_config') === true ){
-		if ( !$this->config->getItem('remote_config_user') || !$this->config->getItem('remote_config_password') ){
-		  $this->error('ERROR: Remote config mode enabled, but no username or no password provided');
-		}
-	}
-	else {
-		$this->config->setItem('old_remote_config_user', null);
-		$this->config->setItem('old_remote_config_password', null);
-	}
-	$this->sid = $this->initSID();
+  // make some config consistency checks
+  if ( $this->config->getItem('enable_remote_config') === true ){
+    if ( !$this->config->getItem('remote_config_user') || !$this->config->getItem('remote_config_password') ){
+      $this->error('ERROR: Remote config mode enabled, but no username or no password provided');
+    }
+  }
+  else {
+    $this->config->setItem('old_remote_config_user', null);
+    $this->config->setItem('old_remote_config_password', null);
+  }
+  $this->sid = $this->initSID();
   }
   
   
   /**
-    * the destructor just calls the logout method
-    * 
-    * @access public
-    */
+   * the destructor just calls the logout method
+   * 
+   * @access public
+   */
   public function __destruct()
   {
     $this->logout();
@@ -119,12 +119,12 @@ 
   
   
   /**
-    * do a POST request on the box
-    * the main cURL wrapper handles the command
-    * 
-    * @param  array  $formfields    an associative array with the POST fields to pass
-    * @return string                the raw HTML code returned by the Fritz!Box
-    */
+   * do a POST request on the box
+   * the main cURL wrapper handles the command
+   * 
+   * @param  array  $formfields    an associative array with the POST fields to pass
+   * @return string                the raw HTML code returned by the Fritz!Box
+   */
   public function doPostForm($formfields = array())
   {
     $ch = curl_init();
@@ -147,23 +147,23 @@ 
     curl_setopt($ch, CURLOPT_POST, 1);
     if ( $this->config->getItem('enable_remote_config') == true )
     {
-		// set name of SSL-certificate (must be same as remote-hostname (dynDNS) of FRITZ!Box) and remove port in address if alternate port is given
-		if (strpos($this->config->getItem('fritzbox_ip'),":")){
-			$ssl_cert_fritzbox = explode(":", $this->config->getItem('fritzbox_ip'));
-			$ssl_cert_fritzbox = $ssl_cert_fritzbox[0];
-		} else {
-			$ssl_cert_fritzbox = $this->config->getItem('fritzbox_ip');
-		}
+    // set name of SSL-certificate (must be same as remote-hostname (dynDNS) of FRITZ!Box) and remove port in address if alternate port is given
+    if (strpos($this->config->getItem('fritzbox_ip'),":")){
+      $ssl_cert_fritzbox = explode(":", $this->config->getItem('fritzbox_ip'));
+      $ssl_cert_fritzbox = $ssl_cert_fritzbox[0];
+    } else {
+      $ssl_cert_fritzbox = $this->config->getItem('fritzbox_ip');
+    }
 
-		// set SSL-options and path to certificate
-		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 2);
-		curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
-		curl_setopt($ch, CURLOPT_CAPATH, '/etc/ssl/certs');
+    // set SSL-options and path to certificate
+    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 2);
+    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
+    curl_setopt($ch, CURLOPT_CAPATH, '/etc/ssl/certs');
 
-		// support for pre FRITZ!OS 5.50 remote config
-		if (!$this->config->getItem('use_lua_login_method')){
-		curl_setopt($ch, CURLOPT_USERPWD, $this->config->getItem('remote_config_user') . ':' . $this->config->getItem('remote_config_password'));
-		}
+    // support for pre FRITZ!OS 5.50 remote config
+    if (!$this->config->getItem('use_lua_login_method')){
+    curl_setopt($ch, CURLOPT_USERPWD, $this->config->getItem('remote_config_user') . ':' . $this->config->getItem('remote_config_password'));
+    }
     }
     curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($formfields));
     $output = curl_exec($ch);
@@ -178,10 +178,10 @@ 
     // add the sid, if it is already set
     if ($this->sid != '0000000000000000')
     {
-		// 'sid' MUST be the first POST variable!!! (otherwise it will not work!!)
-		// therfore we use array_merge to ensuere the foreach outputs 'sid' fist
-		$formfields = array_merge(array('sid' => $this->sid), $formfields);
-		//$formfields['sid'] = $this->sid;
+    // 'sid' MUST be the first POST variable!!! (otherwise it will not work!!)
+    // therfore we use array_merge to ensuere the foreach outputs 'sid' fist
+    $formfields = array_merge(array('sid' => $this->sid), $formfields);
+    //$formfields['sid'] = $this->sid;
     }   
     curl_setopt($ch, CURLOPT_URL, $this->config->getItem('fritzbox_url') . '/cgi-bin/firmwarecfg'); 
     curl_setopt($ch, CURLOPT_POST, 1);
@@ -192,30 +192,30 @@ 
     
     // if filefileds not specified ('@/path/to/file.xml;type=text/xml' works fine)
     if(empty( $filefileds )) {
-		curl_setopt($ch, CURLOPT_POSTFIELDS, $formfields); // http_build_query
-	} 
-	// post calculated raw data
-	else {
-		$header = $this->_create_custom_file_post_header($formfields, $filefileds);
-		curl_setopt($ch, CURLOPT_HTTPHEADER , array(
-			'Content-Type: multipart/form-data; boundary=' . $header['delimiter'], 'Content-Length: ' . strlen($header['data']) )
-			);
+    curl_setopt($ch, CURLOPT_POSTFIELDS, $formfields); // http_build_query
+  } 
+  // post calculated raw data
+  else {
+    $header = $this->_create_custom_file_post_header($formfields, $filefileds);
+    curl_setopt($ch, CURLOPT_HTTPHEADER , array(
+      'Content-Type: multipart/form-data; boundary=' . $header['delimiter'], 'Content-Length: ' . strlen($header['data']) )
+      );
 			
-		curl_setopt($ch, CURLOPT_POSTFIELDS, $header['data']);		
-	}
+    curl_setopt($ch, CURLOPT_POSTFIELDS, $header['data']);		
+  }
 	
     $output = curl_exec($ch);
 
-	// curl error
-	if(curl_errno($ch)) {
-		$this->error(curl_error($ch)." (".curl_errno($ch).")");
-	}
+  // curl error
+  if(curl_errno($ch)) {
+    $this->error(curl_error($ch)." (".curl_errno($ch).")");
+  }
 
     // finger out an error message, if given
     preg_match('@<p class="ErrorMsg">(.*?)</p>@is', $output, $matches);
     if (isset($matches[1]))
     {
-		$this->error(str_replace('&nbsp;', ' ', $matches[1]));
+    $this->error(str_replace('&nbsp;', ' ', $matches[1]));
     }
 
     curl_close($ch);
@@ -223,10 +223,10 @@ 
   }
 
   private function _create_custom_file_post_header($postFields, $fileFields) {
-		// form field separator
-		$delimiter = '-------------' . uniqid();
+    // form field separator
+    $delimiter = '-------------' . uniqid();
 		
-		/*
+    /*
 		// file upload fields: name => array(type=>'mime/type',content=>'raw data')
 		$fileFields = array(
 			'file1' => array(
@@ -241,44 +241,44 @@ 
 		);
 		*/
 		
-		$data = '';
+    $data = '';
 
-		// populate normal fields first (simpler)
-		foreach ($postFields as $name => $content) {
-		   $data .= "--" . $delimiter . "\r\n";
-			$data .= 'Content-Disposition: form-data; name="' . urlencode($name) . '"';
-			$data .= "\r\n\r\n";
-			$data .= $content;
-			$data .= "\r\n";
-		}
-		// populate file fields
-		foreach ($fileFields as $name => $file) {
-			$data .= "--" . $delimiter . "\r\n";
-			// "filename" attribute is not essential; server-side scripts may use it
-			$data .= 'Content-Disposition: form-data; name="' . urlencode($name) . '";' .
-					 ' filename="' . $file['filename'] . '"' . "\r\n";
+    // populate normal fields first (simpler)
+    foreach ($postFields as $name => $content) {
+        $data .= "--" . $delimiter . "\r\n";
+      $data .= 'Content-Disposition: form-data; name="' . urlencode($name) . '"';
+      $data .= "\r\n\r\n";
+      $data .= $content;
+      $data .= "\r\n";
+    }
+    // populate file fields
+    foreach ($fileFields as $name => $file) {
+      $data .= "--" . $delimiter . "\r\n";
+      // "filename" attribute is not essential; server-side scripts may use it
+      $data .= 'Content-Disposition: form-data; name="' . urlencode($name) . '";' .
+            ' filename="' . $file['filename'] . '"' . "\r\n";
 					 
-			//$data .= 'Content-Transfer-Encoding: binary'."\r\n";
-			// this is, again, informative only; good practice to include though
-			$data .= 'Content-Type: ' . $file['type'] . "\r\n";
-			// this endline must be here to indicate end of headers
-			$data .= "\r\n";
-			// the file itself (note: there's no encoding of any kind)
-			$data .= $file['content'] . "\r\n";
-		}
-		// last delimiter
-		$data .= "--" . $delimiter . "--\r\n";
+      //$data .= 'Content-Transfer-Encoding: binary'."\r\n";
+      // this is, again, informative only; good practice to include though
+      $data .= 'Content-Type: ' . $file['type'] . "\r\n";
+      // this endline must be here to indicate end of headers
+      $data .= "\r\n";
+      // the file itself (note: there's no encoding of any kind)
+      $data .= $file['content'] . "\r\n";
+    }
+    // last delimiter
+    $data .= "--" . $delimiter . "--\r\n";
 	
-		return array('delimiter' => $delimiter, 'data' => $data);
-	}
+    return array('delimiter' => $delimiter, 'data' => $data);
+  }
   
   /**
-    * do a GET request on the box
-    * the main cURL wrapper handles the command
-    * 
-    * @param  array  $params    an associative array with the GET params to pass
-    * @return string            the raw HTML code returned by the Fritz!Box
-    */
+   * do a GET request on the box
+   * the main cURL wrapper handles the command
+   * 
+   * @param  array  $params    an associative array with the GET params to pass
+   * @return string            the raw HTML code returned by the Fritz!Box
+   */
   public function doGetRequest($params = array())
   {
     // add the sid, if it is already set
@@ -318,12 +318,12 @@ 
   
   
   /**
-    * the login method, handles the secured login-process
-    * newer firmwares (xx.04.74 and newer) need a challenge-response mechanism to prevent Cross-Site Request Forgery attacks
-    * see http://www.avm.de/de/Extern/Technical_Note_Session_ID.pdf for details
-    * 
-    * @return string                a valid SID, if the login was successful, otherwise throws an Exception with an error message
-    */
+   * the login method, handles the secured login-process
+   * newer firmwares (xx.04.74 and newer) need a challenge-response mechanism to prevent Cross-Site Request Forgery attacks
+   * see http://www.avm.de/de/Extern/Technical_Note_Session_ID.pdf for details
+   * 
+   * @return string                a valid SID, if the login was successful, otherwise throws an Exception with an error message
+   */
   protected function initSID()
   {
     // determine, wich login type we have to use
@@ -403,9 +403,9 @@ 
   
   
   /**
-    * the logout method just sends a logout command to the Fritz!Box
-    * 
-    */
+   * the logout method just sends a logout command to the Fritz!Box
+   * 
+   */
   protected function logout()
   {
     if ( $this->config->getItem('use_lua_login_method') == true )
@@ -424,10 +424,10 @@ 
   
   
   /**
-    * the error method just throws an Exception
-    * 
-    * @param  string   $message     an error message for the Exception
-    */
+   * the error method just throws an Exception
+   * 
+   * @param  string   $message     an error message for the Exception
+   */
   public function error($message = null)
   {
     throw new Exception($message);
@@ -435,20 +435,20 @@ 
   
   
   /**
-    * a getter for the session ID
-    * 
-    * @return string                $this->sid
-    */
+   * a getter for the session ID
+   * 
+   * @return string                $this->sid
+   */
   public function getSID()
   {
     return $this->sid;
   }
   
   /**
-    * log a message
-    * 
-    * @param  $message  string  the message to log
-    */
+   * log a message
+   * 
+   * @param  $message  string  the message to log
+   */
   public function logMessage($message)
   {
     if ( $this->config->getItem('newline') == false )

Spacing +46 added lines, -46 removed lines

@@ -63,39 +63,39 @@ 
     * 
     * @access public
     */
-  public function __construct($password = false,$user_name = false,$fritzbox_ip = 'fritz.box',$force_local_login = false)
+  public function __construct($password = false, $user_name = false, $fritzbox_ip = 'fritz.box', $force_local_login = false)
   {
 	// init the config object
 	$this->config = new fritzbox_api_config();
     
 	// try autoloading the config
-	if (file_exists(__DIR__ . '/fritzbox_user.conf.php') && is_readable(__DIR__ . '/fritzbox_user.conf.php') ) {
+	if(file_exists(__DIR__ . '/fritzbox_user.conf.php') && is_readable(__DIR__ . '/fritzbox_user.conf.php')) {
 		require_once(__DIR__ . '/fritzbox_user.conf.php');
 	}
 
 	// set FRITZ!Box-IP and URL
-	$this->config->setItem('fritzbox_ip',$fritzbox_ip);
+	$this->config->setItem('fritzbox_ip', $fritzbox_ip);
 
 	// check if login on local network (fritz.box) or via a dynamic DNS-host
-	if ($fritzbox_ip != 'fritz.box' && !$force_local_login) {
-		$this->config->setItem('enable_remote_config',true);
-		$this->config->setItem('remote_config_user',$user_name);
-		$this->config->setItem('remote_config_password',$password);
-		$this->config->setItem('fritzbox_url', 'https://'.$this->config->getItem('fritzbox_ip'));
+	if($fritzbox_ip != 'fritz.box' && !$force_local_login) {
+		$this->config->setItem('enable_remote_config', true);
+		$this->config->setItem('remote_config_user', $user_name);
+		$this->config->setItem('remote_config_password', $password);
+		$this->config->setItem('fritzbox_url', 'https://' . $this->config->getItem('fritzbox_ip'));
 	} else {
-		$this->config->setItem('enable_remote_config',false);
-		if($user_name != false){
-			$this->config->setItem('username',$user_name);
+		$this->config->setItem('enable_remote_config', false);
+		if($user_name != false) {
+			$this->config->setItem('username', $user_name);
 		}
-		if($password != false){
-			$this->config->setItem('password',$password);
+		if($password != false) {
+			$this->config->setItem('password', $password);
 		}
 		$this->config->setItem('fritzbox_url', 'http://' . $this->config->getItem('fritzbox_ip'));
 	}
 
 	// make some config consistency checks
-	if ( $this->config->getItem('enable_remote_config') === true ){
-		if ( !$this->config->getItem('remote_config_user') || !$this->config->getItem('remote_config_password') ){
+	if($this->config->getItem('enable_remote_config') === true) {
+		if(!$this->config->getItem('remote_config_user') || !$this->config->getItem('remote_config_password')) {
 		  $this->error('ERROR: Remote config mode enabled, but no username or no password provided');
 		}
 	}
@@ -129,7 +129,7 @@ 
   {
     $ch = curl_init();
 
-    if ( isset($formfields['getpage']) && strpos($formfields['getpage'], '.lua') > 0 )
+    if(isset($formfields['getpage']) && strpos($formfields['getpage'], '.lua') > 0)
     {
       curl_setopt($ch, CURLOPT_URL, $this->config->getItem('fritzbox_url') . $formfields['getpage'] . '?sid=' . $this->sid);
       unset($formfields['getpage']);
@@ -137,7 +137,7 @@ 
     else
     {
       // add the sid, if it is already set
-      if ($this->sid != '0000000000000000')
+      if($this->sid != '0000000000000000')
       {
         $formfields['sid'] = $this->sid;
       }   
@@ -145,10 +145,10 @@ 
     }
     curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
     curl_setopt($ch, CURLOPT_POST, 1);
-    if ( $this->config->getItem('enable_remote_config') == true )
+    if($this->config->getItem('enable_remote_config') == true)
     {
 		// set name of SSL-certificate (must be same as remote-hostname (dynDNS) of FRITZ!Box) and remove port in address if alternate port is given
-		if (strpos($this->config->getItem('fritzbox_ip'),":")){
+		if(strpos($this->config->getItem('fritzbox_ip'), ":")) {
 			$ssl_cert_fritzbox = explode(":", $this->config->getItem('fritzbox_ip'));
 			$ssl_cert_fritzbox = $ssl_cert_fritzbox[0];
 		} else {
@@ -161,7 +161,7 @@ 
 		curl_setopt($ch, CURLOPT_CAPATH, '/etc/ssl/certs');
 
 		// support for pre FRITZ!OS 5.50 remote config
-		if (!$this->config->getItem('use_lua_login_method')){
+		if(!$this->config->getItem('use_lua_login_method')) {
 		curl_setopt($ch, CURLOPT_USERPWD, $this->config->getItem('remote_config_user') . ':' . $this->config->getItem('remote_config_password'));
 		}
     }
@@ -176,7 +176,7 @@ 
     $ch = curl_init();
    
     // add the sid, if it is already set
-    if ($this->sid != '0000000000000000')
+    if($this->sid != '0000000000000000')
     {
 		// 'sid' MUST be the first POST variable!!! (otherwise it will not work!!)
 		// therfore we use array_merge to ensuere the foreach outputs 'sid' fist
@@ -191,13 +191,13 @@ 
     curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
     
     // if filefileds not specified ('@/path/to/file.xml;type=text/xml' works fine)
-    if(empty( $filefileds )) {
+    if(empty($filefileds)) {
 		curl_setopt($ch, CURLOPT_POSTFIELDS, $formfields); // http_build_query
 	} 
 	// post calculated raw data
 	else {
 		$header = $this->_create_custom_file_post_header($formfields, $filefileds);
-		curl_setopt($ch, CURLOPT_HTTPHEADER , array(
+		curl_setopt($ch, CURLOPT_HTTPHEADER, array(
 			'Content-Type: multipart/form-data; boundary=' . $header['delimiter'], 'Content-Length: ' . strlen($header['data']) )
 			);
 			
@@ -208,12 +208,12 @@ 
 
 	// curl error
 	if(curl_errno($ch)) {
-		$this->error(curl_error($ch)." (".curl_errno($ch).")");
+		$this->error(curl_error($ch) . " (" . curl_errno($ch) . ")");
 	}
 
     // finger out an error message, if given
     preg_match('@<p class="ErrorMsg">(.*?)</p>@is', $output, $matches);
-    if (isset($matches[1]))
+    if(isset($matches[1]))
     {
 		$this->error(str_replace('&nbsp;', ' ', $matches[1]));
     }
@@ -244,7 +244,7 @@ 
 		$data = '';
 
 		// populate normal fields first (simpler)
-		foreach ($postFields as $name => $content) {
+		foreach($postFields as $name => $content) {
 		   $data .= "--" . $delimiter . "\r\n";
 			$data .= 'Content-Disposition: form-data; name="' . urlencode($name) . '"';
 			$data .= "\r\n\r\n";
@@ -252,7 +252,7 @@ 
 			$data .= "\r\n";
 		}
 		// populate file fields
-		foreach ($fileFields as $name => $file) {
+		foreach($fileFields as $name => $file) {
 			$data .= "--" . $delimiter . "\r\n";
 			// "filename" attribute is not essential; server-side scripts may use it
 			$data .= 'Content-Disposition: form-data; name="' . urlencode($name) . '";' .
@@ -282,13 +282,13 @@ 
   public function doGetRequest($params = array())
   {
     // add the sid, if it is already set
-    if ($this->sid != '0000000000000000')
+    if($this->sid != '0000000000000000')
     {
       $params['sid'] = $this->sid;
     }    
   
     $ch = curl_init();
-    if ( strpos($params['getpage'], '.lua') > 0 )
+    if(strpos($params['getpage'], '.lua') > 0)
     {
       $getpage = $params['getpage'] . '?';
       unset($params['getpage']);
@@ -300,13 +300,13 @@ 
     curl_setopt($ch, CURLOPT_URL, $this->config->getItem('fritzbox_url') . $getpage . http_build_query($params));
     curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
     curl_setopt($ch, CURLOPT_HTTPGET, 1);
-    if ( $this->config->getItem('enable_remote_config') )
+    if($this->config->getItem('enable_remote_config'))
     {
       curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
       curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
 
       // support for pre FRITZ!OS 5.50 remote config
-      if ( !$this->config->getItem('use_lua_login_method') )
+      if(!$this->config->getItem('use_lua_login_method'))
       {
         curl_setopt($ch, CURLOPT_USERPWD, $this->config->getItem('remote_config_user') . ':' . $this->config->getItem('remote_config_password'));
       }
@@ -327,7 +327,7 @@ 
   protected function initSID()
   {
     // determine, wich login type we have to use
-    if ( $this->config->getItem('use_lua_login_method') == true )
+    if($this->config->getItem('use_lua_login_method') == true)
     {
       $loginpage = '/login_sid.lua';
     }
@@ -339,13 +339,13 @@ 
     // read the current status
     $session_status_simplexml = simplexml_load_string($this->doGetRequest(array('getpage' => $loginpage)));
     
-    if ( !is_object($session_status_simplexml) || get_class($session_status_simplexml) != 'SimpleXMLElement' )
+    if(!is_object($session_status_simplexml) || get_class($session_status_simplexml) != 'SimpleXMLElement')
     {
       $this->error('Response of initialization call ' . $loginpage . ' in ' . __FUNCTION__ . ' was not xml-formatted.');
     }
     
     // perhaps we already have a SID (i.e. when no password is set)
-    if ( $session_status_simplexml->SID != '0000000000000000' )
+    if($session_status_simplexml->SID != '0000000000000000')
     {
       return $session_status_simplexml->SID;
     }
@@ -359,16 +359,16 @@ 
       $formfields = array(
         'getpage' => $loginpage,
       );
-      if ( $this->config->getItem('use_lua_login_method') )
+      if($this->config->getItem('use_lua_login_method'))
       {
-        if ( $this->config->getItem('enable_remote_config') )
+        if($this->config->getItem('enable_remote_config'))
         {
           $formfields['username'] = $this->config->getItem('remote_config_user');
           $response = $challenge . '-' . md5(mb_convert_encoding($challenge . '-' . $this->config->getItem('remote_config_password'), "UCS-2LE", "UTF-8"));
         }
         else
         {
-          if ( $this->config->getItem('username') )
+          if($this->config->getItem('username'))
           {
             $formfields['username'] = $this->config->getItem('username');
           }
@@ -385,12 +385,12 @@ 
       
       // finger out the SID from the response
       $session_status_simplexml = simplexml_load_string($output);
-      if ( !is_object($session_status_simplexml) || get_class($session_status_simplexml) != 'SimpleXMLElement' )
+      if(!is_object($session_status_simplexml) || get_class($session_status_simplexml) != 'SimpleXMLElement')
       {
         $this->error('Response of login call to ' . $loginpage . ' in ' . __FUNCTION__ . ' was not xml-formatted.');
       }
       
-      if ( $session_status_simplexml->SID != '0000000000000000' )
+      if($session_status_simplexml->SID != '0000000000000000')
       {
         return (string)$session_status_simplexml->SID;
       }
@@ -408,7 +408,7 @@ 
     */
   protected function logout()
   {
-    if ( $this->config->getItem('use_lua_login_method') == true )
+    if($this->config->getItem('use_lua_login_method') == true)
     {
       $this->doGetRequest(array('getpage' => '/home/home.lua', 'logout' => '1'));
     }
@@ -451,22 +451,22 @@ 
     */
   public function logMessage($message)
   {
-    if ( $this->config->getItem('newline') == false )
+    if($this->config->getItem('newline') == false)
     {
       $this->config->setItem('newline', (PHP_OS == 'WINNT') ? "\r\n" : "\n");
     }
   
-    if ( $this->config->getItem('logging') == 'console' )
+    if($this->config->getItem('logging') == 'console')
     {
       echo $message;
     }
-    else if ( $this->config->getItem('logging') == 'silent' || $this->config->getItem('logging') == false )
+    else if($this->config->getItem('logging') == 'silent' || $this->config->getItem('logging') == false)
     {
       // do nothing
     }
     else
     {
-      if ( is_writable($this->config->getItem('logging')) || is_writable(dirname($this->config->getItem('logging'))) )
+      if(is_writable($this->config->getItem('logging')) || is_writable(dirname($this->config->getItem('logging'))))
       {
         file_put_contents($this->config->getItem('logging'), $message . $this->config->getItem('newline'), FILE_APPEND);
       }
@@ -516,11 +516,11 @@ 
    */
   public function getItem($item = 'all')
   {
-    if ( $item == 'all' )
+    if($item == 'all')
     {
       return $this->config;
     }
-    elseif ( isset($this->config[$item]) )
+    elseif(isset($this->config[$item]))
     {
       return $this->config[$item];
     }

carddav2fb.php

Braces +222 added lines, -98 removed lines

@@ -38,9 +38,12 @@ 
 require_once('lib/fritzbox_api_php/fritzbox_api.class.php');
 
 if($argc == 2)
+{
   $config_file_name = $argv[1];
-else
+}
+else {
   $config_file_name = __DIR__ . '/config.php';
+}
 
 // default/fallback config options
 $config['tmp_dir'] = sys_get_temp_dir();
@@ -60,7 +63,9 @@ 
 $config['quickdial_keyword'] = 'Quickdial:';
 
 if(is_file($config_file_name))
+{
   require($config_file_name);
+}
 else
 {
   print 'ERROR: No ' . $config_file_name . ' found, please take a look at config.example.php and create a ' . $config_file_name . ' file!' . PHP_EOL;
@@ -91,9 +96,12 @@ 
 // upload the XML-file to the FRITZ!Box (CAUTION: this will overwrite all current entries in the phone book!!)
 print 'Upload data to FRITZ!Box @ ' . $config['fritzbox_ip'] . PHP_EOL;
 if($client->upload_to_fb())
+{
   print 'Done.' . PHP_EOL;
-else
+}
+else {
   exit(1);
+}
 
 flush(); // in case this script runs by php-cgi
 
@@ -124,7 +132,9 @@ 
   public function mktemp($dir, $prefix = '', $mode = 0700)
   {
     if(substr($dir, -1) != '/')
-      $dir .= '/';
+    {
+          $dir .= '/';
+    }
 
     do
     {
@@ -145,7 +155,12 @@ 
         if($object != "." && $object != "..")
         {
           if(filetype($dir . "/" . $object) == "dir")
-            rrmdir($dir . "/" . $object); else unlink($dir . "/" . $object);
+          {
+                      rrmdir($dir . "/" . $object);
+          }
+          else {
+              unlink($dir . "/" . $object);
+            }
         }
       }
       reset($objects);
@@ -159,18 +174,25 @@ 
     {
       // Check if there are valid base64 characters
       if(!preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $str))
-        return false;
+      {
+              return false;
+      }
 
       // Decode the string in strict mode and check the results
       $decoded = base64_decode($str, true);
       if($decoded === false)
-        return false;
+      {
+              return false;
+      }
 
       // Encode the string again
       if(base64_encode($decoded) === $str)
-        return true;
-      else
-        return false;
+      {
+              return true;
+      }
+      else {
+              return false;
+      }
     }
     catch(Exception $e)
     {
@@ -211,7 +233,9 @@ 
         // set the vcard extension in case the user
         // defined it in the config
         if(isset($conf['extension']))
-          $carddav->setVcardExtension($conf['extension']);
+        {
+                  $carddav->setVcardExtension($conf['extension']);
+        }
 
         // retrieve data from the CardDAV server now
         $xmldata = $carddav->get();
@@ -220,7 +244,9 @@ 
         // CardDAV server and if not reencode it since the FRITZ!Box
         // requires UTF-8 encoded data
         if(iconv('utf-8', 'utf-8//IGNORE', $xmldata) != $xmldata)
-          $xmldata = utf8_encode($xmldata);
+        {
+                  $xmldata = utf8_encode($xmldata);
+        }
 
         // read raw_vcard data from xml response
         $raw_vcards = array();
@@ -242,10 +268,14 @@ 
           $vcard_obj = new vCard(false, $v);
           $name_arr = null;
           if(isset($vcard_obj->n[0]))
-            $name_arr = $vcard_obj->n[0];
+          {
+                      $name_arr = $vcard_obj->n[0];
+          }
           $org_arr = null;
           if(isset($vcard_obj->org[0]))
-            $org_arr = $vcard_obj->org[0];
+          {
+                      $org_arr = $vcard_obj->org[0];
+          }
           $addnames = '';
           $prefix = '';
           $suffix = '';
@@ -254,19 +284,29 @@ 
 
           // Build name Parts if existing ans switch to true in config
           if(isset($name_arr['prefixes']) and $this->config['prefix'])
-            $prefix = trim($name_arr['prefixes']);
+          {
+                      $prefix = trim($name_arr['prefixes']);
+          }
 
           if(isset($name_arr['suffixes']) and $this->config['suffix'])
-            $suffix = trim($name_arr['suffixes']);
+          {
+                      $suffix = trim($name_arr['suffixes']);
+          }
 
           if(isset($name_arr['additionalnames']) and $this->config['addnames'])
-            $addnames = trim($name_arr['additionalnames']);
+          {
+                      $addnames = trim($name_arr['additionalnames']);
+          }
 
           if(isset($org_arr['name']) and $this->config['orgname'])
-            $orgname = trim($org_arr['name']);
+          {
+                      $orgname = trim($org_arr['name']);
+          }
 
           if (isset($vcard_obj->fn[0]))
-            $formattedname = $vcard_obj->fn[0];
+          {
+                      $formattedname = $vcard_obj->fn[0];
+          }
 
           $firstname = trim($name_arr['firstname']);
           $lastname = trim($name_arr['lastname']);
@@ -286,78 +326,106 @@ 
 
           // Prefix
           if(!empty($prefix))
-            $name .= $prefix;
+          {
+                      $name .= $prefix;
+          }
 
           if($format == 0)
           {
             // Lastname
             if(!empty($name) and !empty($lastname))
-              $name .= ' ' . $lastname;
-            else
-              $name .= $lastname;
+            {
+                          $name .= ' ' . $lastname;
+            }
+            else {
+                          $name .= $lastname;
+            }
           }
           else
           {
             // Firstname
             if(!empty($name) and !empty($firstname))
-              $name .= ' ' . $firstname;
-            else
-              $name .= $firstname;
+            {
+                          $name .= ' ' . $firstname;
+            }
+            else {
+                          $name .= $firstname;
+            }
           }
 
           if($format == 2)
           {
             // AdditionalNames
             if(!empty($name) and !empty($addnames))
-              $name .= ' ' . $addnames;
-            else
-              $name .= $addnames;
+            {
+                          $name .= ' ' . $addnames;
+            }
+            else {
+                          $name .= $addnames;
+            }
           }
 
           if($format == 0)
           {
             // Firstname
             if(!empty($name) and !empty($firstname))
-              $name .= ', ' . $firstname;
-            else
-              $name .= $firstname;
+            {
+                          $name .= ', ' . $firstname;
+            }
+            else {
+                          $name .= $firstname;
+            }
           }
           else
           {
             // Lastname
             if(!empty($name) and !empty($lastname))
-              $name .= ' ' . $lastname;
-            else
-              $name .= $lastname;
+            {
+                          $name .= ' ' . $lastname;
+            }
+            else {
+                          $name .= $lastname;
+            }
           }
 
           if($format != 2)
           {
             // AdditionalNames
             if(!empty($name) and !empty($addnames))
-              $name .= ' ' . $addnames;
-            else
-              $name .= $addnames;
+            {
+                          $name .= ' ' . $addnames;
+            }
+            else {
+                          $name .= $addnames;
+            }
           }
 
           // Suffix
           if(!empty($name) and !empty($suffix))
-            $name .= ' ' . $suffix;
-          else
-            $name .= $suffix;
+          {
+                      $name .= ' ' . $suffix;
+          }
+          else {
+                      $name .= $suffix;
+          }
 
           // OrgName
           if(!empty($name) and !empty($orgname))
-            $name .= ' (' . $orgname . ')';
-          else
-            $name .= $orgname;
+          {
+                      $name .= ' (' . $orgname . ')';
+          }
+          else {
+                      $name .= $orgname;
+          }
 
           // make sure to trim whitespaces and double spaces
           $name = trim(str_replace('  ', ' ', $name));
 
           // perform a fallback to formatted name, if we don't have any name and formatted name is available
           if(empty($name) and !empty($formattedname))
-            $name = $formattedname;
+          {
+                      $name = $formattedname;
+          }
 
           if(empty($name))
           {
@@ -371,15 +439,19 @@ 
             $photo = str_replace(array(',', '&', ' ', '/', 'ä', 'ö', 'ü', 'Ä', 'Ö', 'Ü', 'ß', 'á', 'à', 'ó', 'ò', 'ú', 'ù', 'í', 'ø'),
             array('', '_', '_', '_', 'ae', 'oe', 'ue', 'Ae', 'Oe', 'Ue', 'ss', 'a', 'a', 'o', 'o', 'u', 'u', 'i', 'oe'), $name);
           }
-          else
-            $photo = '';
+          else {
+                      $photo = '';
+          }
 
           // phone
           $phone_no = array();
           if($vcard_obj->categories)
-            $categories = $vcard_obj->categories[0];
-          else
-            $categories = array();
+          {
+                      $categories = $vcard_obj->categories[0];
+          }
+          else {
+                      $categories = array();
+          }
 
           // check for quickdial entry
           if(isset($vcard_obj->note[0]))
@@ -414,9 +486,10 @@ 
                 break;
               }
             }
-          } 
-          else
-            $add_entry = 1;
+          }
+          else {
+                      $add_entry = 1;
+          }
 
           if($add_entry == 1)
           {
@@ -441,9 +514,13 @@ 
                   {
                     //Set quickdial
                     if($value == 1)
-                      print "\nWARNING: Quickdial value 1 (**701) is not possible but used! \n";
+                    {
+                                          print "\nWARNING: Quickdial value 1 (**701) is not possible but used! \n";
+                    }
                     elseif($value >= 100)
-                      print "\nWARNING: Quickdial value bigger than 99 (**799) is not possible but used! \n";
+                    {
+                                          print "\nWARNING: Quickdial value bigger than 99 (**799) is not possible but used! \n";
+                    }
 
                     $quickdial = $value;
                   }
@@ -453,23 +530,38 @@ 
 
                 // find out priority
                 if(in_array("pref", $typearr_lower))
-                  $prio = 1;
+                {
+                                  $prio = 1;
+                }
 
                 // set the proper type
                 if(in_array("cell", $typearr_lower))
-                  $type = "mobile";
+                {
+                                  $type = "mobile";
+                }
                 elseif(in_array("home", $typearr_lower))
-                  $type = "home";
+                {
+                                  $type = "home";
+                }
                 elseif(in_array("fax", $typearr_lower))
-                  $type = "fax_work";
+                {
+                                  $type = "fax_work";
+                }
                 elseif(in_array("work", $typearr_lower))
-                  $type = "work";
+                {
+                                  $type = "work";
+                }
                 elseif(in_array("other", $typearr_lower))
-                  $type = "other";
+                {
+                                  $type = "other";
+                }
                 elseif(in_array("dom", $typearr_lower))
-                  $type = "other";
-                else
-                  continue;
+                {
+                                  $type = "other";
+                }
+                else {
+                                  continue;
+                }
               }
               $phone_no[] = array("type"=>$type, "prio"=>$prio, "quickdial"=>$quickdial, "value" => $this->_clear_phone_number($phone_number));
             }
@@ -489,13 +581,20 @@ 
                   $email = $e['value'];
                   $typearr_lower = unserialize(strtolower(serialize($e['type'])));
                   if(in_array("work", $typearr_lower))
-                    $type_email = "work";
+                  {
+                                      $type_email = "work";
+                  }
                   elseif(in_array("home", $typearr_lower))
-                    $type_email = "home";
+                  {
+                                      $type_email = "home";
+                  }
                   elseif(in_array("other", $typearr_lower))
-                    $type_email = "other";
-                  else
-                    continue;
+                  {
+                                      $type_email = "other";
+                  }
+                  else {
+                                      continue;
+                  }
                 }
 
                 // DEBUG: print out the email address on the console
@@ -523,7 +622,9 @@ 
   public function build_fb_xml()
   {
     if(empty($this->entries))
-      throw new Exception('No entries available! Call get_carddav_entries or set $this->entries manually!');
+    {
+          throw new Exception('No entries available! Call get_carddav_entries or set $this->entries manually!');
+    }
 
     // create FB XML in utf-8 format
     $root = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8"?><phonebooks><phonebook></phonebook></phonebooks>');
@@ -562,7 +663,9 @@ 
 
       // output a warning if no telephone number was found
       if($id == 0)
-        print "  WARNING: no phone entry found. VCard will be ignored." . PHP_EOL;
+      {
+              print "  WARNING: no phone entry found. VCard will be ignored." . PHP_EOL;
+      }
 
       // email: put the email addresses into the fritzbox xml file
       $email = $contact->addChild("services");
@@ -612,8 +715,9 @@ 
 
             print "  Added photo: " . basename($photo_file) . PHP_EOL;
           }
-          else
-           print "  WARNING: Only jpg contact photos are currently supported." . PHP_EOL;
+          else {
+                     print "  WARNING: Only jpg contact photos are currently supported." . PHP_EOL;
+          }
         }
         elseif(substr($entry['photo_data'][0], 0, 4) == 'http')
         {
@@ -622,8 +726,9 @@ 
 
           print "  Added photo: " . $entry['photo_data'][0] . PHP_EOL;
         }
-        else
-          print "  WARNING: Only VCard embedded photo data or a reference URL is currently supported." . PHP_EOL;
+        else {
+                  print "  WARNING: Only VCard embedded photo data or a reference URL is currently supported." . PHP_EOL;
+        }
       }
 
       $contact->addChild("services");
@@ -632,7 +737,9 @@ 
     }
 
     if($root->asXML() !== false)
-      $this->fbxml = $root->asXML();
+    {
+          $this->fbxml = $root->asXML();
+    }
     else
     {
       print "  ERROR: created XML data isn't well-formed." . PHP_EOL;
@@ -649,19 +756,27 @@ 
   public function _concat($text1, $text2)
   {
     if($text1 == '')
-      return $text2;
+    {
+          return $text2;
+    }
     elseif($text2 == '')
-      return $text1;
-    else
-      return $text1 . ", " . $text2;
+    {
+          return $text1;
+    }
+    else {
+          return $text1 . ", " . $text2;
+    }
   }
 
   public function _parse_fb_result($text)
   {
     if(preg_match("/\<h2\>([^\<]+)\<\/h2\>/", $text, $matches) == 1 && !empty($matches))
-      return $matches[1];
-    else
-      return "Error while uploading xml to fritzbox";
+    {
+          return $matches[1];
+    }
+    else {
+          return "Error while uploading xml to fritzbox";
+    }
   }
 
   public function upload_to_fb()
@@ -683,15 +798,17 @@ 
 	  	$newphonebhash = md5(preg_replace("/<mod_time>(\\d{10})/","",file_get_contents($this->config['output_file'],'r'),-1,$debugnewtsreplace));
 	  	print " INFO: Compare old and new phonebook file versions." . PHP_EOL . " INFO: old version: " . $oldphonebhash . PHP_EOL . " INFO: new version: " . $newphonebhash . PHP_EOL;
 	  	if($oldphonebhash === $newphonebhash)
-      	{
+	  	{
       	print " INFO: Same versions ==> No changes in phonebook or images" . PHP_EOL . " EXIT: No need to upload phonebook to the FRITZ!Box.". PHP_EOL;
       	return 0;
       	}
-      	else
-      	print " INFO: Different versions ==> Changes in phonebook." . PHP_EOL . " INFO: Changes dedected! Continue with upload." . PHP_EOL;
+      	else {
+      	      	print " INFO: Different versions ==> Changes in phonebook." . PHP_EOL . " INFO: Changes dedected! Continue with upload." . PHP_EOL;
+      	}
       }
-	  else
-      return 0;  
+      else {
+	        return 0;
+	  }
     }
     // now we upload the photo jpgs first being stored in the
     // temp directory.
@@ -761,12 +878,16 @@ 
 
                   ftp_pasv($conn_id, true);
                   if(!ftp_put($conn_id, $remote_path . "/" . $file, $fileinfo->getPathname(), FTP_BINARY))
-                    print " ERROR: while uploading file " . $fileinfo->getFilename() . PHP_EOL;
-                  else
-                    print " ok." . PHP_EOL;
+                  {
+                                      print " ERROR: while uploading file " . $fileinfo->getFilename() . PHP_EOL;
+                  }
+                  else {
+                                      print " ok." . PHP_EOL;
+                  }
+                }
+                else {
+                                  print " ok." . PHP_EOL;
                 }
-                else
-                  print " ok." . PHP_EOL;
 
                 // cleanup old files
                 foreach($all_existing_files as $existing_file)
@@ -778,20 +899,23 @@ 
                   }
                 }
               }
-              else
-                print " already exists." . PHP_EOL;
+              else {
+                              print " already exists." . PHP_EOL;
+              }
             }
           }
         }
       }
-      else
-        print " ERROR: couldn't login to FTP-server '" . $ftp_server . "' with provided username/password settings." . PHP_EOL;
+      else {
+              print " ERROR: couldn't login to FTP-server '" . $ftp_server . "' with provided username/password settings." . PHP_EOL;
+      }
 
       // close ftp connection
       ftp_close($conn_id);
     }
-    else
-      print " ERROR: couldn't connect to FTP server '" . $ftp_server . "'." . PHP_EOL;
+    else {
+          print " ERROR: couldn't connect to FTP server '" . $ftp_server . "'." . PHP_EOL;
+    }
     
     // lets post the phonebook xml to the FRITZ!Box
     print " Uploading Phonebook XML to " . $this->config['fritzbox_ip'] . PHP_EOL;