Changeset 3535

Timestamp:

02/22/07 15:28:26 (6 years ago)

Author:

francois

Message:

sfWebBrowserPlugin: 0.9.6 (beta) release (see changelog in README)

Files:

• plugins/sfWebBrowserPlugin/README (modified) (3 diffs)
• plugins/sfWebBrowserPlugin/lib/sfCurlAdapter.class.php (modified) (1 diff)
• plugins/sfWebBrowserPlugin/lib/sfFopenAdapter.class.php (modified) (2 diffs)
• plugins/sfWebBrowserPlugin/lib/sfWebBrowser.class.php (modified) (3 diffs)
• plugins/sfWebBrowserPlugin/package.xml (modified) (1 diff)
• plugins/sfWebBrowserPlugin/test/unit/sfWebBrowserTest.php (modified) (4 diffs)

plugins/sfWebBrowserPlugin/README

@@ -79 +79 @@
-Gzip and deflate content-encoded response bodies are also supported, provided that you have the [http://php.net/zlib zlib extention] enabled.
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-$b = new sfWebBrowser(array(), 'sfCurlAdapter');
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-== Installation ==
@@ -102 +144 @@
-== Known limitations ==
-
-The web request is made via `fopen()`, so this will only work if PHP is compiled with sockets support and if `allow_url_fopen` is defined to `true` in the `php.ini`
+If `allow_url_fopen` is not defined to `true` and if the curl extension cannot be activated in the `php.ini` file, the browser can't fetch pages. Workaround (todo): use a sockets adapter
-
-Cookies are not handled yet.
@@ -110 +152 @@
-== Changelog ==
-
+=== 2007-02-22 | 0.9.6 Beta ===
+
+ * bmeynell, tristan: Allowed for requests with any method in `sfCurlAdapter`
+ * tristan: Added `sfWebBrowser::responseIsError()`
+ * tristan: Added `sfWebBrowser::getResponseMessage()`
+ * tristan: Refactored error management in `sfFopenAdapter`
+
-=== 2007-02-21 | 0.9.5 Beta ===
-
-f
-f
-c
-r
-a
-a
-a
-a
+F
+F
+C
+R
+A
+A
+A
+A
-
-=== 2007-02-16 | 0.9.4 Beta ===
-
-r
+R
- * francois: '''BC break''' constructor signature changed : `new sfWebBrowser(array $headers, string $adapter_class, array $adapter_options)` 
-f
-f
-t
-f
-f
+F
+F
+T
+F
+F
-
-=== 2007-02-16 | 0.9.3 Beta ===

plugins/sfWebBrowserPlugin/lib/sfCurlAdapter.class.php

@@ -69 +69 @@
-    curl_setopt($curl, CURLOPT_HEADERFUNCTION, array($this, 'read_header'));
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-    }
-
+
-    $response = curl_exec($curl);
-

plugins/sfWebBrowserPlugin/lib/sfFopenAdapter.class.php

@@ -20 +20 @@
-{ 
-  protected
-
+
+
+
-    
-  public function __construct($options = array())
@@ -51 +53 @@
-      array('header' => $request_headers)
-    )));
+
+    // Custom error handler
+    // -- browser instance must be accessible from handleRuntimeError()
+    $this->browser = $browser;
+    set_error_handler(array($this, 'handleRuntimeError'), E_WARNING);
+    if($handle = fopen($uri, 'r', false, $context))
+    {
+      $response_headers = stream_get_meta_data($handle);
+      $browser->setResponseCode(array_shift($response_headers['wrapper_data']));
+      $browser->setResponseHeaders($response_headers['wrapper_data']);
+      $browser->setResponseText(stream_get_contents($handle));
+      fclose($handle);
+    }
+
+    restore_error_handler();
-    
-(!$handle = @fopen($uri, 'r', false, $context)
+ ($this->adapterErrorMessage == true
-    {
-
-
+
+
+
-    }
-    
-    $response_headers = stream_get_meta_data($handle);
-
-    $browser->setResponseCode(array_shift($response_headers['wrapper_data']));
-    $browser->setResponseHeaders($response_headers['wrapper_data']);
-    $browser->setResponseText(stream_get_contents($handle));
-    fclose($handle);
-
-    return $browser;
-  }
-  
+  /**
+   * Handles PHP runtime error.
+   * 
+   * This handler is used to catch any warnigns sent by fopen($url) and reformat them to something
+   * usable.
+   *
+   * @see  http://php.net/set_error_handler
+   */
+  function handleRuntimeError($errno, $errstr, $errfile = null, $errline = null, $errcontext = array() )
+  {
+    $msg = sprintf('%s : "%s" occured in %s on line %d',
+                   $error_types[$errno], $errstr, $errfile, $errline);
+
+    $matches = array();
+    if (preg_match('/HTTP\/\d\.\d (\d{3}) (.*)$/', $errstr, $matches))
+    {
+      $this->browser->setResponseCode($matches[1]);
+      $this->browser->setResponseMessage($matches[2]);
+      $body = sprintf('The %s adapter cannot handle error responses body. Try using another adapter.', __CLASS__);
+      $this->browser->setResponseText($body);
+    }
+    else
+    {
+      $this->adapterErrorMessage = $msg;
+    }
+  }
-}

plugins/sfWebBrowserPlugin/lib/sfWebBrowser.class.php

@@ -26 +26 @@
-    $responseHeaders         = array(),
-    $responseCode            = '',
+    $responseMessage         = '',
-    $responseText            = '',
-    $responseDom             = null,
@@ -642 +643 @@
-
-  /**
+   * Returns true if server response is an error.
+   * 
+   * @return   bool
+   */
+  public function responseIsError()
+  {
+    return in_array((int)($this->getResponseCode() / 100), array(4, 5)); 
+  }
+
+  /**
-   * Get the response headers
-   *
@@ -696 +707 @@
-  }
-  
+  /**
+   * Returns the response message (the 'Not Found' part in  'HTTP/1.1 404 Not Found')
+   * 
+   * @return   string 
+   */
+  public function getResponseMessage()
+  {
+    return $this->responseMessage;    
+  }
+  
+  /**
+   * Sets response message.
+   * 
+   * @param    string    $message
+   */
+  public function setResponseMessage($msg)
+  {
+    $this->responseMessage = $msg;
+  }
+  
-  public function getUrlInfo()
-  {

plugins/sfWebBrowserPlugin/package.xml

@@ -11 +11 @@
-  <active>yes</active>
- </lead>
-1
+2
- <version>
-5
-5
+6
+6
- </version>
- <stability>

plugins/sfWebBrowserPlugin/test/unit/sfWebBrowserTest.php

@@ -21 +21 @@
-require_once($sf_symfony_lib_dir.'/util/sfToolkit.class.php');
-
-1
+4
-
-$t->diag('initialization');
@@ -52 +52 @@
-}
-
-try
-{
-  $b->get('http://www.4Z5erg7fs.com');
-  $t->fail('get() throws an exception when the host is not found');
-}
-catch (Exception $e)
-{
-  $t->pass('get() throws an exception when the host is not found');
-}
-
-$t->diag('simple GET request');
-$t->like($b->get($dump_headers_url)->getResponseText(), '/\[REQUEST_METHOD\] => GET/', 'get() performs a GET request');
@@ -79 +69 @@
-$t->diag('simple DELETE request');
-$t->like($b->delete($dump_headers_url)->getResponseText(), '/\[REQUEST_METHOD\] => DELETE/', 'delete() performs a DELETE request');
+
+$t->diag('arbitrary request');
+$t->like($b->call($dump_headers_url, 'MICHEL')->getResponseText(), '/\[REQUEST_METHOD\] => MICHEL/', 'call() supports any HTTP methods');
+
-
-$t->diag('Response formats methods');
@@ -190 +184 @@
-  $t->fail(sprintf('%s : skipping tests that need it', $e->getMessage()));  
-}
+
+$t->diag('Error management');
+try
+{
+  $b->get('http://nonexistent');
+  $t->fail('an exception is thrown when an adapter error occurs');
+}
+catch (Exception $e)
+{
+  $t->pass('an exception is thrown when an adapter error occurs');
+}
+
+$t->diag('responseIsError()');
+$t->is($b->get($example_site_url . '/nonexistentpage.html')->responseIsError(), true, 'responseIsError() returns true when response is an error');
+$t->is($b->get($example_site_url)->responseIsError(), false, 'responseIsError() returns false when response is not an error');
-
-$t->diag('history methods');