Robots/bkmk_rsimple.py

   1 """
   2    Simple, strightforward robot
   3
   4    Written by Oleg BroytMann. Copyright (C) 2000-2007 PhiloSoft Design.
   5 """
   6
   7 import sys, os
   8 import time, urllib
   9 from base64 import b64encode
  10 from urlparse import urljoin
  11
  12 from m_lib.net.www.util import parse_time
  13 from m_lib.md5wrapper import md5wrapper
  14
  15 from bkmk_objects import Robot
  16 from parse_html import parse_html
  17
  18
  19 class RedirectException(Exception):
  20    reloc_dict = {
  21       301: "perm.",
  22       302: "temp.",
  23       "html": "html"
  24    }
  25    def __init__(self, errcode, newurl):
  26       Exception.__init__(self, "(%s) to %s" % (self.reloc_dict[errcode], newurl))
  27       self.url = newurl
  28
  29
  30 class MyURLopener(urllib.URLopener):
  31    # Error 302 -- relocated (temporarily)
  32    def http_error_302(self, url, fp, errcode, errmsg, headers, data=None):
  33       if headers.has_key('location'):
  34          newurl = headers['location']
  35       elif headers.has_key('uri'):
  36          newurl = headers['uri']
  37       else:
  38          newurl = "Nowhere"
  39       raise RedirectException(errcode, newurl)
  40
  41    # Error 301 -- also relocated (permanently)
  42    http_error_301 = http_error_302
  43
  44    # Error 401 -- authentication required
  45    def http_error_401(self, url, fp, errcode, errmsg, headers, data=None):
  46       raise IOError, ('http error', errcode, "Authentication required ", headers)
  47
  48
  49 urllib._urlopener = MyURLopener()
  50
  51 # Fake headers to pretend this is a real browser
  52 _version = "Mozilla/5.0 (X11; U; Linux 2.6 i686; en) Gecko/20001221 Firefox/2.0.0"
  53 urllib._urlopener.addheaders[0] = ('User-Agent', _version)
  54 _version = "bookmarks_db (Python %d.%d.%d; urllib/%s)" % (
  55    sys.version_info[0], sys.version_info[1], sys.version_info[2], urllib.__version__)
  56 urllib._urlopener.addheader('X-User-Agent', _version)
  57 urllib._urlopener.addheader('Referer', '')
  58
  59 urllib._urlopener.addheader('Connection', 'close')
  60 urllib._urlopener.addheader('Accept', '*/*')
  61 urllib._urlopener.addheader('Accept-Language', 'ru,en')
  62 urllib._urlopener.addheader('Cache-Control', 'max-age=300')
  63
  64
  65 def get_error(msg):
  66    if isinstance(msg, str):
  67       return msg
  68
  69    else:
  70       s = []
  71       for i in msg:
  72          s.append("'%s'" % str(i).replace('\n', "\\n"))
  73       return "(%s)" % ' '.join(s)
  74
  75
  76 urllib_ftpwrapper = urllib.ftpwrapper
  77 ftpcache_key = None
  78
  79 class myftpwrapper(urllib_ftpwrapper):
  80    def __init__(self, user, passwd, host, port, dirs):
  81       urllib_ftpwrapper.__init__(self, user, passwd, host, port, dirs)
  82       global ftpcache_key
  83       ftpcache_key = (user, host, port, tuple(dirs))
  84
  85 urllib.ftpwrapper = myftpwrapper
  86
  87 def get_welcome():
  88    global ftpcache_key
  89    _welcome = urllib._urlopener.ftpcache[ftpcache_key].ftp.welcome
  90    ftpcache_key = None # I am assuming there are no duplicate ftp URLs in db.
  91                        # If there are - ftpcache_key in prev line is invalid.
  92    return _welcome
  93
  94
  95 class robot_simple(Robot):
  96    def check_url(self, bookmark):
  97       if not self.tempfname:
  98          self.tempfname = bookmark.tempfname
  99
 100       try:
 101          try:
 102             self.start = int(time.time())
 103             bookmark.icon = None
 104
 105             url_type, url_rest = urllib.splittype(bookmark.href)
 106             url_host, url_path = urllib.splithost(url_rest)
 107             url_path, url_tag  = urllib.splittag(url_path)
 108
 109             # Set fake referer to the root of the site
 110             urllib._urlopener.addheaders[2] = ('Referer', "%s://%s%s" % (url_type, url_host, url_path))
 111
 112             if bookmark.charset: urllib._urlopener.addheader('Accept-Charset', bookmark.charset)
 113             fname, headers = urllib.urlretrieve("%s://%s%s" % (url_type, url_host, url_path), self.tempfname)
 114             if bookmark.charset: del urllib._urlopener.addheaders[-1]
 115
 116             size = 0
 117             last_modified = None
 118
 119             if headers:
 120                try:
 121                   size = headers["Content-Length"]
 122                except KeyError:
 123                   pass
 124
 125                try:
 126                   last_modified = headers["Last-Modified"]
 127                except KeyError:
 128                   pass
 129
 130                if last_modified:
 131                   last_modified = parse_time(last_modified)
 132
 133             if last_modified:
 134                last_modified = str(int(last_modified))
 135             else:
 136                last_modified = bookmark.last_visit
 137
 138             bookmark.size = size
 139             bookmark.last_modified = last_modified
 140
 141             md5 = md5wrapper()
 142             if urllib._urlopener.type == "ftp": # Pass welcome message through MD5
 143                md5.update(get_welcome())
 144
 145             md5.md5file(self.tempfname)
 146             bookmark.md5 = str(md5)
 147
 148             if headers:
 149                try:
 150                   content_type = headers["Content-Type"]
 151                   try:
 152                      content_type, charset = content_type.split(';')
 153                      content_type = content_type.strip()
 154                      charset = charset.split('=')[1].strip()
 155                      self.log("   HTTP charset   : %s" % charset)
 156                   except (ValueError, IndexError):
 157                      charset = None
 158                      self.log("   no charset in Content-Type header")
 159                   if content_type == "text/html":
 160                      parser = parse_html(fname, charset, self.log)
 161                      bookmark.real_title = parser.title
 162                      if parser.refresh:
 163                         refresh = parser.refresh
 164                         try:
 165                            url = refresh.split('=', 1)[1]
 166                         except IndexError:
 167                            url = "self"
 168                         try:
 169                            timeout = float(refresh.split(';')[0])
 170                         except (IndexError, ValueError):
 171                            raise RedirectException("html", "Bad redirect to %s (%s)" % (url, refresh))
 172                         else:
 173                            try:
 174                               timeout = int(refresh.split(';')[0])
 175                            except ValueError:
 176                               pass # float timeout
 177                            raise RedirectException("html", "%s (%s sec)" % (url, timeout))
 178
 179                      # Get favicon.ico
 180                      icon = parser.icon
 181                      if not icon:
 182                         icon = "/favicon.ico"
 183                      icon = urljoin("%s://%s%s" % (url_type, url_host, url_path), icon)
 184                      self.log("   looking for icon at: %s" % icon)
 185                      try:
 186                         for i in range(8):
 187                            try:
 188                               fname, headers = urllib.urlretrieve(icon)
 189                            except RedirectException, e:
 190                               icon = e.url
 191                               self.log("       redirect to : %s" % icon)
 192                            else:
 193                               break
 194                         else:
 195                            raise IOError("Too many redirects")
 196                      except:
 197                         etype, emsg, tb = sys.exc_info()
 198                         self.log("   no icon        : %s %s" % (etype, emsg))
 199                         etype = None
 200                         emsg = None
 201                         tb = None
 202                      else:
 203                         content_type = headers["Content-Type"]
 204                         if content_type.startswith("image/"):
 205                            icon_file = open(fname, "rb")
 206                            icon = icon_file.read()
 207                            icon_file.close()
 208                            bookmark.icon = "data:%s;base64,%s" % (content_type, b64encode(icon))
 209                            self.log("   got icon       : %s" % content_type)
 210                         else:
 211                            self.log("   no icon        : bad content type '%s'" % content_type)
 212                         os.remove(fname)
 213
 214                except KeyError:
 215                   pass
 216
 217          except IOError, msg:
 218             if (msg[0] == "http error") and (msg[1] == -1):
 219                bookmark.no_error = "The server did not return any header - it is not an error, actually"
 220             else:
 221                bookmark.error = get_error(msg)
 222
 223          except EOFError:
 224             bookmark.error = "Unexpected EOF (FTP server closed connection)"
 225
 226          except RedirectException, msg:
 227             bookmark.moved = str(msg)
 228
 229          except KeyboardInterrupt:
 230             return 0
 231
 232       finally:
 233          self.finish_check_url(bookmark)
 234
 235       # Tested
 236       return 1
 237
 238
 239    def finish_check_url(self, bookmark):
 240       # Calculate these attributes even in case of an error
 241       if os.path.exists(self.tempfname):
 242          size = str(os.path.getsize(self.tempfname))
 243          if size[-1] == 'L':
 244             size = size[:-1]
 245          bookmark.size = size
 246
 247       start = self.start
 248       bookmark.last_tested = str(start)
 249
 250       now = int(time.time())
 251       bookmark.test_time = str(now - start)