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 )