X-Git-Url: https://git.cweiske.de/linksys-wrt3g-tools.git/blobdiff_plain/2d190be44338e3674336943d366c739c55a273f5..04776d8e9a6eeb0371cdb7d61074850e3bf45994:/Wrt3g.php

diff --git a/Wrt3g.php b/Wrt3g.php
index a14adf5..2fe0db8 100644
--- a/Wrt3g.php
+++ b/Wrt3g.php
@@ -11,8 +11,9 @@
  * @link     http://cweiske.de/linksys-wrt3g-tools.htm
  */
 require_once 'HTTP/Request2.php';
+require_once 'Wrt3g/Config.php';
 require_once 'Wrt3g/HtmlParser.php';
-
+require_once 'Wrt3g/RequestObserver.php';
 
 /**
  * Main class to interact with the router.
@@ -26,35 +27,47 @@ require_once 'Wrt3g/HtmlParser.php';
 class Wrt3g
 {
     /**
-     * Router hostname/IP
+     * Logging verbosity
+     * 0 - no debug logging
+     * 1 - show important details (connected URLs)
+     * 2 - show internal details
+     * 3 - show HTTP requests and responses
      *
-     * @var string
+     * @var integer
      */
-    public $host;
+    public $verbosity = 0;
 
     /**
-     * Name of user with administration privileges
+     * Class to send HTTP Requests with.
+     * Needs to be compatible with HTTP_Request2
      *
      * @var string
      */
-    public $user;
+    public $requestClass = 'HTTP_Request2';
 
     /**
-     * Password for $user
+     * Configuration object
      *
-     * @var string
+     * @var Wrt3g_Config
      */
-    public $password;
+    public $config;
+
+
 
     /**
-     * Logging verbosity
-     * 0 - no debug logging
-     * 1 - show important details (connected URLs)
-     * 2 - show internal details
+     * Loads the configuration from file and cmdline options
      *
-     * @var integer
+     * @param array $options Command line options array
+     *
+     * @return void
+     *
+     * @see Wrt3g_Config
      */
-    public $verbosity = 0;
+    public function loadConfig($options = array())
+    {
+        $this->config = new Wrt3g_Config($this);
+        $this->config->load($options);
+    }
 
 
 
@@ -67,9 +80,9 @@ class Wrt3g
     protected function getAuthBaseUrl()
     {
         return 'http://'
-            . $this->user
-            . ':' . $this->password
-            . '@' . $this->host;
+            . $this->config->user
+            . ':' . $this->config->password
+            . '@' . $this->config->host;
     }
 
 
@@ -82,7 +95,25 @@ class Wrt3g
      */
     protected function getAnonBaseUrl()
     {
-        return 'http://' . $this->host;
+        return 'http://' . $this->config->host;
+    }
+
+
+
+    /**
+     * Creates a new HTTP_Request2 object, attaches an observer
+     * if necessary and returns it.
+     *
+     * @return HTTP_Request2
+     */
+    protected function createRequest()
+    {
+        $r = new $this->requestClass();
+        if ($this->verbosity >= 3) {
+            //register observer
+            $r->attach(new Wrt3g_RequestObserver($this));
+        }
+        return $r;
     }
 
 
@@ -99,7 +130,7 @@ class Wrt3g
         $url = $this->getAuthBaseUrl() . '/apply.cgi';
         $this->log('Connecting to ' . $url);
 
-        $r = new HTTP_Request2();
+        $r = $this->createRequest();
         $r->setMethod(HTTP_Request2::METHOD_POST);
         $r->setUrl($url);
         $r->addPostParameter('action', 'Reboot');
@@ -107,6 +138,7 @@ class Wrt3g
         $r->addPostParameter('wait_time', 1);
 
         $resp = $r->send();
+        $this->checkResponseStatus($resp);
         return $resp;
     }//public function reboot()
 
@@ -120,7 +152,7 @@ class Wrt3g
      *
      * @throws Exception When the router can't be reached, or unauthorized
      */
-    public function getStatus()
+    public function getConnectionStatus()
     {
         $arRetval = array();
 
@@ -130,12 +162,12 @@ class Wrt3g
         /**
          * Connection status
          */
-        $r = new HTTP_Request2();
+        $r = $this->createRequest();
         $r->setMethod(HTTP_Request2::METHOD_GET);
         $r->setUrl($strUrlBase . '/index_wstatus2.asp');
         $this->log('Connecting to ' . $strUrlBase . '/index_wstatus2.asp', 1);
         $resp = $r->send();
-        $this->log($resp->getStatus() . ' ' . $resp->getReasonPhrase(), 1);
+        $this->checkResponseStatus($resp);
         $arRetval = $parser->index_wstatus2($resp->getBody());
 
         /**
@@ -144,40 +176,82 @@ class Wrt3g
         $r->setUrl($strUrlBase . '/index_wstatus1.asp');
         $this->log('Connecting to ' . $strUrlBase . '/index_wstatus1.asp', 1);
         $resp = $r->send();
+        $this->checkResponseStatus($resp);
         $body = $resp->getBody();
         $arRetval = array_merge($arRetval, $parser->index_wstatus1($body));
 
         return $arRetval;
-    }//public function getStatus()
+    }//public function getConnectionStatus()
 
 
 
     /**
-     * Retrieves pc card/SIM status information
+     * Loads "Status_NoAuth.asp" page and parses the body.
      *
-     * @return array Array with several key-value pairs
-     *               connection => connecting, disconnected, connected
+     * @return array Associative array with connection status.
      *
-     * @throws Exception When the router can't be reached
+     * @throws Exception When something goes wrong, i.e. router not
+     *                   reachable
      */
-    public function getCardStatus()
+    protected function loadStatus_NoAuth()
     {
-        $arRetval = array();
-
-        $strUrlBase = $this->getAuthBaseUrl();
+        $strUrlBase = $this->getAnonBaseUrl();
 
         $url = $strUrlBase . '/Status_NoAuth.asp';
         $this->log('Connecting to ' . $url, 1);
 
-        $r = new HTTP_Request2();
+        $r = $this->createRequest();
         $r->setMethod(HTTP_Request2::METHOD_GET);
         $r->setUrl($url);
         $resp = $r->send();
-        $this->log($resp->getStatus() . ' ' . $resp->getReasonPhrase(), 1);
-        //FIXME: check status
+        $this->checkResponseStatus($resp);
 
         $parser = new Wrt3g_HtmlParser();
-        $arRetval = $parser->status_noauth($resp->getBody());
+
+        return $parser->status_noauth(
+            $resp->getBody()
+        );
+    }
+
+
+
+    /**
+     * Checks the HTTP response code and throws an exception if it
+     * is not in the 200 range.
+     *
+     * @param HTTP_Request2_Response $resp HTTP response object
+     *
+     * @return void
+     *
+     * @throws Exception When the status is not 200-299
+     */
+    protected function checkResponseStatus(HTTP_Request2_Response $resp)
+    {
+        $nStatus = $resp->getStatus();
+        $this->log($nStatus . ' ' . $resp->getReasonPhrase(), 1);
+        if (intval($nStatus / 100) == 2) {
+            //2xx status is fine
+            return;
+        }
+
+        throw new Exception(
+            'HTTP Error: ' . $nStatus . ' ' . $resp->getReasonPhrase()
+        );
+    }
+
+
+
+    /**
+     * Retrieves pc card/SIM status information
+     *
+     * @return array Array with several key-value pairs
+     *               connection => connecting, disconnected, connected
+     *
+     * @throws Exception When the router can't be reached
+     */
+    public function getCardStatus()
+    {
+        $arRetval = $this->loadStatus_NoAuth();
 
         return array_intersect_key(
             $arRetval,
@@ -192,11 +266,27 @@ class Wrt3g
 
 
 
+    /**
+     * Retrieves all status information one can get.
+     *
+     * @return array Array with several key-value pairs
+     *               connection => connecting, disconnected, connected
+     *
+     * @throws Exception When the router can't be reached
+     */
+    public function getFullStatus()
+    {
+        return $this->loadStatus_NoAuth();
+    }
+
+
+
     /**
      * Log a message to stdout.
      *
-     * @param string  $msg   Message to display
-     * @param integer $level Log level, see $verbosity
+     * @param string|object $msg   Message to display. May even be a response
+     *                             object
+     * @param integer       $level Log level, see $verbosity
      *
      * @return void
      */