git.maemo.org Git - gc-dialer/blob - gc_dialer/browser_emu.py

   1 """
   2 @author:          Laszlo Nagy
   3 @copyright:   (c) 2005 by Szoftver Messias Bt.
   4 @licence:        BSD style
   5
   6 Objects of the MozillaEmulator class can emulate a browser that is capable of:
   7
   8         - cookie management
   9         - caching
  10         - configurable user agent string
  11         - GET and POST
  12         - multipart POST (send files)
  13         - receive content into file
  14         - progress indicator
  15
  16 I have seen many requests on the python mailing list about how to emulate a browser. I'm using this class for years now, without any problems. This is how you can use it:
  17
  18         1. Use firefox
  19         2. Install and open the livehttpheaders plugin
  20         3. Use the website manually with firefox
  21         4. Check the GET and POST requests in the livehttpheaders capture window
  22         5. Create an instance of the above class and send the same GET and POST requests to the server.
  23
  24 Optional steps:
  25
  26         - For testing, use a MozillaCacher instance - this will cache all pages and make testing quicker
  27         - You can change user agent string in the build_opened method
  28         - The "encode_multipart_formdata" function can be used alone to create POST data from a list of field values and files
  29
  30 TODO:
  31
  32 - should have a method to save/load cookies
  33 """
  34
  35 import os
  36 import urllib
  37 import urllib2
  38 import cookielib
  39 import warnings
  40
  41
  42 class MozillaEmulator(object):
  43
  44         def __init__(self, cacher=None, trycount=0):
  45                 """Create a new MozillaEmulator object.
  46
  47                 @param cacher: A dictionary like object, that can cache search results on a storage device.
  48                         You can use a simple dictionary here, but it is not recommended.
  49                         You can also put None here to disable caching completely.
  50                 @param trycount: The download() method will retry the operation if it fails. You can specify -1 for infinite retrying.
  51                          A value of 0 means no retrying. A value of 1 means one retry. etc."""
  52                 if cacher is None:
  53                         cacher = {}
  54                 self.cacher = cacher
  55                 self.cookies = cookielib.LWPCookieJar()
  56                 self.debug = False
  57                 self.trycount = trycount
  58
  59         def build_opener(self, url, postdata=None, extraheaders=None, forbid_redirect=False):
  60                 if extraheaders is None:
  61                         extraheaders = {}
  62
  63                 txheaders = {
  64                         'Accept':'text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png',
  65                         'Accept-Language':'en,en-us;q=0.5',
  66                         'Accept-Charset': 'ISO-8859-1,utf-8;q=0.7,*;q=0.7',
  67                 }
  68                 for key, value in extraheaders.iteritems():
  69                         txheaders[key] = value
  70                 req = urllib2.Request(url, postdata, txheaders)
  71                 self.cookies.add_cookie_header(req)
  72                 if forbid_redirect:
  73                         redirector = HTTPNoRedirector()
  74                 else:
  75                         redirector = urllib2.HTTPRedirectHandler()
  76
  77                 http_handler = urllib2.HTTPHandler(debuglevel=self.debug)
  78                 https_handler = urllib2.HTTPSHandler(debuglevel=self.debug)
  79
  80                 u = urllib2.build_opener(http_handler, https_handler, urllib2.HTTPCookieProcessor(self.cookies), redirector)
  81                 u.addheaders = [('User-Agent','Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.8) Gecko/20050511 Firefox/1.0.4')]
  82                 if not postdata is None:
  83                         req.add_data(postdata)
  84                 return (req, u)
  85
  86         def download(self, url, postdata=None, extraheaders=None, forbid_redirect=False,
  87                         trycount=None, fd=None, onprogress=None, only_head=False):
  88                 """Download an URL with GET or POST methods.
  89
  90                 @param postdata: It can be a string that will be POST-ed to the URL.
  91                         When None is given, the method will be GET instead.
  92                 @param extraheaders: You can add/modify HTTP headers with a dict here.
  93                 @param forbid_redirect: Set this flag if you do not want to handle
  94                         HTTP 301 and 302 redirects.
  95                 @param trycount: Specify the maximum number of retries here.
  96                         0 means no retry on error. Using -1 means infinite retring.
  97                         None means the default value (that is self.trycount).
  98                 @param fd: You can pass a file descriptor here. In this case,
  99                         the data will be written into the file. Please note that
 100                         when you save the raw data into a file then it won't be cached.
 101                 @param onprogress: A function that has two parameters:
 102                         the size of the resource and the downloaded size. This will be
 103                         called for each 1KB chunk. (If the HTTP header does not contain
 104                         the content-length field, then the size parameter will be zero!)
 105                 @param only_head: Create the openerdirector and return it. In other
 106                         words, this will not retrieve any content except HTTP headers.
 107
 108                 @return: The raw HTML page data, unless fd was specified. When fd
 109                         was given, the return value is undefined.
 110                 """
 111                 warnings.warn("Performing download of %s" % url, UserWarning, 2)
 112
 113                 if extraheaders is None:
 114                         extraheaders = {}
 115                 if trycount is None:
 116                         trycount = self.trycount
 117                 cnt = 0
 118                 while True:
 119                         try:
 120                                 req, u = self.build_opener(url, postdata, extraheaders, forbid_redirect)
 121                                 openerdirector = u.open(req)
 122                                 if self.debug:
 123                                         print req.get_method(), url
 124                                         print openerdirector.code, openerdirector.msg
 125                                         print openerdirector.headers
 126                                 self.cookies.extract_cookies(openerdirector, req)
 127                                 if only_head:
 128                                         return openerdirector
 129                                 return openerdirector.read()
 130                         except urllib2.URLError:
 131                                 cnt += 1
 132                                 if (trycount > -1) and (trycount < cnt):
 133                                         raise
 134                                 # Retry :-)
 135                                 if self.debug:
 136                                         print "MozillaEmulator: urllib2.URLError, retryting ", cnt
 137
 138
 139 class HTTPNoRedirector(urllib2.HTTPRedirectHandler):
 140         """This is a custom http redirect handler that FORBIDS redirection."""
 141
 142         def http_error_302(self, req, fp, code, msg, headers):
 143                 e = urllib2.HTTPError(req.get_full_url(), code, msg, headers, fp)
 144                 if e.code in (301, 302):
 145                         if 'location' in headers:
 146                                 newurl = headers.getheaders('location')[0]
 147                         elif 'uri' in headers:
 148                                 newurl = headers.getheaders('uri')[0]
 149                         e.newurl = newurl
 150                 raise e