Robots/bkmk_rsimple.py

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