Merge lp:~andrea.corbellini/beeseek/error-page into lp:beeseek/1.0

[Andrea Corbellini]

[Andrea Corbellini (andrea.corbellini)]

This branch adds a web page that is shown to the user when an error in the proxy occurs.

Currently it is only displayed when the host that the user is trying to connect to cannot be found, but in the future it will be used for any error.

How to test this change:

1. Start the server with 'beeseek-server start -t';
2. Start the peer with 'beeseek-peer start -t' and set it as your proxy;
3. Visit a URL that doesn't exist (e.g. <http://something/>)

You should see a page telling you that the host cannot be found.

[Jacopo Moretto (jak-o)]

review: Approve

[Jacopo Moretto (jak-o)]

review: Approve

[Andrea Colangelo (warp10)]

review: Approve (ui)

=== modified file 'beeseek/app/log.py'
--- beeseek/app/log.py	2009-10-21 15:39:48 +0000
+++ beeseek/app/log.py	2009-11-12 13:55:22 +0000
@@ -141,7 +141,7 @@
         for name in dir(self_obj):
             try:
                 value = getattr(self_obj, name)
-            except StandardError:
+            except Exception:
                 # XXX We can use somewhat better.
                 value = NotImplementedError
             f_self[name] = value

=== modified file 'beeseek/template/css.py'
--- beeseek/template/css.py	2009-09-15 13:40:21 +0000
+++ beeseek/template/css.py	2009-11-12 13:55:22 +0000
@@ -20,3 +20,5 @@
 #pylint: disable-msg=C0103
 style = Template('css/style.css', dont_parse=True,
     tags={'content-type': 'text/css'})
+style_error = Template('css/style-error.css', dont_parse=True,
+    tags={'content-type': 'text/css'})

=== modified file 'beeseek/template/html.py'
--- beeseek/template/html.py	2009-10-24 12:25:08 +0000
+++ beeseek/template/html.py	2009-11-12 13:55:22 +0000
@@ -21,3 +21,4 @@
 start_page = Template('html/home.html')
 search_page = Template('html/search.html')
 configuration_page = Template('html/configuration.html')
+error_page = Template('html/error.html')

=== modified file 'beeseek/template/images.py'
--- beeseek/template/images.py	2009-09-15 13:40:21 +0000
+++ beeseek/template/images.py	2009-11-12 13:55:22 +0000
@@ -20,3 +20,5 @@
 #pylint: disable-msg=C0103
 logo = Template('images/logo.png', dont_parse=True,
     tags={'content-type': 'image/png'})
+bars = Template('images/bars.png', dont_parse=True,
+    tags={'content-type': 'image/png'})

=== modified file 'beeseek/ui/__init__.py'
--- beeseek/ui/__init__.py	2009-10-24 12:54:21 +0000
+++ beeseek/ui/__init__.py	2009-11-12 13:55:22 +0000
@@ -33,6 +33,10 @@
             template = css.style
         elif page == '/beeseek:logo.png':
             template = images.logo
+        elif page == '/beeseek:style-error.css':
+            template = css.style_error
+        elif page == '/beeseek:bars.png':
+            template = images.bars
         else:
             return False
         data = template.format()

=== modified file 'beeseek/web/servers/baseserver.py'
--- beeseek/web/servers/baseserver.py	2009-10-21 17:05:04 +0000
+++ beeseek/web/servers/baseserver.py	2009-11-12 13:55:22 +0000
@@ -191,9 +191,9 @@
             except StopServing:
                 self.stop_serving()
                 return
-            except StandardError:
+            except Exception, exc:
                 try:
-                    self.handle_error(client, requestdata)
+                    self.handle_error(client, requestdata, exc)
                 except StopProcessing, exc:
                     close = exc.close
                 except StopServing:
@@ -220,7 +220,8 @@
         client.close()
 
     @Method.with_default
-    def handle_error(self, client, requestdata): #pylint: disable-msg=W0613
+    def handle_error(
+        self, client, requestdata, exc): #pylint: disable-msg=W0613
         """Called by serve_request() when an exception is raised.
 
         By default, this function raises the exception.

=== modified file 'beeseek/web/servers/http.py'
--- beeseek/web/servers/http.py	2009-10-21 17:02:40 +0000
+++ beeseek/web/servers/http.py	2009-11-12 13:55:22 +0000
@@ -30,8 +30,9 @@
 from beeseek.web.protocols.http import (
     HTTPMethods, HTTPServerApplication, HTTPClientApplication,
     get_host_port_and_page)
-from beeseek.web.protocols.lowlevel import SSLContext
+from beeseek.web.protocols.lowlevel import SocketError, SSLContext
 from beeseek.web.servers.baseserver import BaseServer, StopProcessing
+from beeseek.template.html import error_page
 from beeseek.template.javascript import pac
 
 
@@ -51,13 +52,11 @@
         method, page = requestline[:2]
 
         if show_page(client, page):
-            return
+            pass
         elif page in ('/search', '/search/'):
             show_start_page(client, method)
-            return True
         elif page.startswith('/search/'):
             show_results(client, page)
-            return True
         elif page == '/submit-oops' and method == HTTPMethods.POST:
             self._save_oops_report(client, headers)
         else:
@@ -240,7 +239,17 @@
         client.end_response()
         client.flush()
 
-    def handle_capacity_limit(self, client):
-        """See `BaseServer`."""
-        # TODO Show a message and log the error
-        raise NotImplementedError
+    def handle_error(self, client, requestdata, exc):
+        """Show a page describing the error with some useful information."""
+        if isinstance(exc, SocketError):
+            data = error_page.format(
+                errorname='server-not-found', details=str(exc))
+            headers = instance.http_response_headers.copy()
+            headers['Content-Length'] = str(len(data))
+            headers['Content-Type'] = error_page.template_tags['content-type']
+            client.start_response(404, 'Not found', headers)
+            client.write(data)
+            client.end_response()
+            client.flush()
+        else:
+            raise

=== added file 'templates/css/style-error.css'
--- templates/css/style-error.css	1970-01-01 00:00:00 +0000
+++ templates/css/style-error.css	2009-11-12 13:55:22 +0000
@@ -0,0 +1,47 @@
+body {
+    background-color: #EFEFEF;
+    font-family: sans-serif;
+    font-size: 12pt;
+}
+
+.details {
+    font-size: 9pt;
+}
+
+div#actions {
+    text-align: center;
+}
+
+div#details {
+    /* By default details are hidden. */
+    display: none;
+}
+
+div#warning {
+    border: 2px solid #FAC232;
+    background: #FFFFFF url(/beeseek:bars.png) repeat-x;
+    left: 20%;
+    padding: 0.5em 0 0.5em 1.2em;
+    position: absolute;
+    top: 10%;
+    width: 60%;
+
+    /* Display a round border. */
+    /* TODO The following properties are not W3 standard (and therefore not
+     * TODO supported on all browsers). It may be better to use images. */
+    -moz-border-radius: 30px;
+    -o-border-radius: 30px;
+    -webkit-border-radius: 30px;
+    -ktml-border-radius: 30px;
+}
+
+div#warning h1 {
+    color: #EE8A03;
+    font-size: 20pt;
+}
+
+div#warning a {
+    color: #556D7A;
+    text-decoration: none;
+    font-weight: bold;
+}

=== added file 'templates/html/error-messages.xml'
--- templates/html/error-messages.xml	1970-01-01 00:00:00 +0000
+++ templates/html/error-messages.xml	2009-11-12 13:55:22 +0000
@@ -0,0 +1,18 @@
+<beeseek:template content-type="text/html">
+  <beeseek:container id="server-not-found">
+    <beeseek:object id="title">Cannot connect to server</beeseek:object>
+    <beeseek:object id="message">Unable to establish a connection with the server.</beeseek:object>
+    <beeseek:object id="rationale">
+      <p>Possible causes of this issue:</p>
+      <ul>
+        <li>The site could be temporarily unavailable or too busy. Try again
+        in a few moments.</li>
+        <li>If you are unable to load any pages, check your computer's network
+        connection.</li>
+        <li>If your computer or network is protected by a firewall or proxy,
+        make sure that <beeseek:insert type="variable" name="instance.appname" />
+        is permitted to access the Net.</li>
+      </ul>
+    </beeseek:object>
+  </beeseek:container>
+</beeseek:template>

=== modified file 'templates/html/error.html'
--- templates/html/error.html	2008-08-27 13:51:34 +0000
+++ templates/html/error.html	2009-11-12 13:55:22 +0000
@@ -1,87 +1,44 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
+<beeseek:template content-type="text/html"><?xml version="1.0" encoding="UTF-8"?>
+<html>
   <head>
-    <title>
-      Error
-    </title>
-    <meta http-equiv="Content-type" content='text/html; charset="UTF-8"' />
-    <style type="text/css">
-      body{
-        margin: 0;
-        padding: 0;
-        background: #fff;
-        font-family: "Bitstream Vera Sans", "Trebuchet MS", "Trebuchet", "Verdana", "Arial", "Sans-serif";
-        font-size: 9pt;
-        color: #121212;
-      }
-
-      h3 {
-        font-size: 140%;
-      }
-
-      #logo h1{
-        position: relative;
-        width: 250px;
-        left: 50%;
-        margin: 0 0 0 -125px;
-        padding: 10px 0 0 0;
-        color: #000;
-        font-size: 20pt;
-      }
-
-      #howto{
-        background: #e6eed3;
-        border: #ffc90f 1px solid;
-        padding: 10px;
-        margin: 20px;
-        font-weight: bold;
-      }
-
-      #howto a{
-        color: #556d7a;
-      }
-
-      #content{
-        border: #ffc90f 1px solid;
-        margin: 0 20px;
-        padding: 0px 20px 0 20px;
-      }
-
-      #traceback{
-        background: #f8f8f8;
-        border: #cccccc 1px solid;
-        margin: 0 0 10px 0;
-        padding: 10px;
-        font-size: 8pt;
-      }
-
-      textarea{
-        background: #f8f8f8;
-        border: none;
-        width:100%;
-        min-height: 300px;
-      }
-    </style>
+    <title><beeseek:insert type="object" file="html/error-messages.xml" id="%(errorname)s.title" /></title>
+    <link rel="stylesheet" type="text/css" media="screen" href="/beeseek:style-error.css" />
+    <script type="text/javascript">
+        function toggle_details() {
+            var box_style;
+            var label;
+
+            box_style = document.getElementById('details').style;
+            label = document.getElementById('details-label');
+
+            if (box_style.display == 'block') {
+                label.innerHTML = 'Technical details';
+                box_style.display = 'none';
+            } else {
+                label.innerHTML = 'Hide technical details';
+                box_style.display = 'block';
+            }
+        }
+    </script>
   </head>
   <body>
-    <div id="header">
-      <div id="logo">
-        <h1>
-          Error
-        </h1>
+    <div id="warning">
+      <h1><beeseek:insert type="object" file="html/error-messages.xml" id="%(errorname)s.title" /></h1>
+      <p><strong><beeseek:insert type="object" file="html/error-messages.xml" id="%(errorname)s.message" /></strong></p>
+      <beeseek:insert type="object" file="html/error-messages.xml" id="%(errorname)s.rationale" />
+      <div id="actions">
+        <button id="try-again">Try again</button>
+        <button id="search">Search in the Web</button>
       </div>
-    </div>
-    <div id="howto">
-      Sorry, an error has occurred. Try to reload this page to solve the problem. If it still occurs, please <a href="https://launchpad.net/honeybee/+filebug">report this bug</a> including the following information. Thanks for your patient!
-    </div>
-    <div id="content">
-      <h3>
-        Traceback:
-      </h3>
-      <div id="traceback">
-        <textarea rows="1" cols="1" readonly="readonly"><![CDATA[$traceback]]></textarea>
+      <p class="details">
+        <a id="details-label" href="#details" onclick="toggle_details()">Technical details</a>
+      </p>
+      <div id="details" class="details">
+        <pre>
+<beeseek:insert type="variable" name="details" />
+        </pre>
       </div>
     </div>
   </body>
 </html>
+</beeseek:template>

=== added file 'templates/images/bars.png'
Binary files templates/images/bars.png	1970-01-01 00:00:00 +0000 and templates/images/bars.png	2009-11-12 13:55:22 +0000 differ