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):
  87       if not self.tempfname:
  88          self.tempfname = bookmark.tempfname
  89
  90       try:
  91          try:
  92             self.start = int(time.time())
  93             bookmark.icon = None
  94
  95             url_type, url_rest = urllib.splittype(bookmark.href)
  96             url_host, url_path = urllib.splithost(url_rest)
  97             url_path, url_tag  = urllib.splittag(url_path)
  98
  99             if bookmark.charset: urllib._urlopener.addheader('Accept-Charset', bookmark.charset)
 100             fname, headers = urllib.urlretrieve("%s://%s%s" % (url_type, url_host, url_path), self.tempfname)
 101             if bookmark.charset: del urllib._urlopener.addheaders[-1]
 102
 103             size = 0
 104             last_modified = None
 105
 106             if headers:
 107                try:
 108                   size = headers["Content-Length"]
 109                except KeyError:
 110                   pass
 111
 112                try:
 113                   last_modified = headers["Last-Modified"]
 114                except KeyError:
 115                   pass
 116
 117                if last_modified:
 118                   last_modified = parse_time(last_modified)
 119
 120             if last_modified:
 121                last_modified = str(int(last_modified))
 122             else:
 123                last_modified = bookmark.last_visit
 124
 125             bookmark.size = size
 126             bookmark.last_modified = last_modified
 127
 128             md5 = md5wrapper()
 129             if urllib._urlopener.type == "ftp": # Pass welcome message through MD5
 130                md5.update(get_welcome())
 131
 132             md5.md5file(self.tempfname)
 133             bookmark.md5 = str(md5)
 134
 135             if headers:
 136                try:
 137                   content_type = headers["Content-Type"]
 138                   try:
 139                      content_type, charset = content_type.split(';')
 140                      content_type = content_type.strip()
 141                      charset = charset.split('=')[1].strip()
 142                      if self.log: self.log("   HTTP charset   : %s" % charset)
 143                   except (ValueError, IndexError):
 144                      charset = None
 145                      if self.log: self.log("   no charset in Content-Type header")
 146                   if content_type == "text/html":
 147                      parser = parse_html(fname, charset, self.log)
 148                      title = parser.title.replace('\r', '').replace('\n', ' ').strip()
 149                      bookmark.real_title = parser.unescape(title)
 150                      if self.log: self.log("   final title    : %s" % bookmark.real_title)
 151                      if parser.refresh:
 152                         refresh = parser.refresh
 153                         try:
 154                            url = refresh.split('=', 1)[1]
 155                         except IndexError:
 156                            url = "self"
 157                         try:
 158                            timeout = int(refresh.split(';')[0])
 159                         except (IndexError, ValueError):
 160                            timeout = None
 161                         if timeout is None:
 162                            raise RedirectException("html", "Bad redirect to %s (%s)" % (url, refresh))
 163                         else:
 164                            raise RedirectException("html", "%s (%d sec)" % (url, timeout))
 165
 166                      # Get favicon.ico
 167                      icon = parser.icon
 168                      if not icon:
 169                         icon = "/favicon.ico"
 170                      icon = urljoin("%s://%s%s" % (url_type, url_host, url_path), icon)
 171                      if self.log: self.log("   icon           : %s" % icon)
 172                      try:
 173                         fname, headers = urllib.urlretrieve(icon)
 174                      except:
 175                         etype, emsg, tb = sys.exc_info()
 176                         if self.log: self.log("   no icon        : %s %s" % (etype, emsg))
 177                         etype = None
 178                         emsg = None
 179                         tb = None
 180                      else:
 181                         content_type = headers["Content-Type"]
 182                         if content_type.startswith("image/"):
 183                            icon_file = open(fname, "rb")
 184                            icon = icon_file.read()
 185                            icon_file.close()
 186                            bookmark.icon = "data:%s;base64,%s" % (content_type, b64encode(icon))
 187                         else:
 188                            if self.log: self.log("   no icon        : %s" % content_type)
 189                         os.remove(fname)
 190
 191                except KeyError:
 192                   pass
 193
 194          except IOError, msg:
 195             if (msg[0] == "http error") and (msg[1] == -1):
 196                bookmark.no_error = "The server did not return any header - it is not an error, actually"
 197             else:
 198                bookmark.error = get_error(msg)
 199
 200          except EOFError:
 201             bookmark.error = "Unexpected EOF (FTP server closed connection)"
 202
 203          except RedirectException, msg:
 204             bookmark.moved = str(msg)
 205
 206          except KeyboardInterrupt:
 207             return 0
 208
 209       finally:
 210          self.finish_check_url(bookmark)
 211
 212       # Tested
 213       return 1
 214
 215
 216    def finish_check_url(self, bookmark):
 217       # Calculate these attributes even in case of an error
 218       if os.path.exists(self.tempfname):
 219          size = str(os.path.getsize(self.tempfname))
 220          if size[-1] == 'L':
 221             size = size[:-1]
 222          bookmark.size = size
 223
 224       start = self.start
 225       bookmark.last_tested = str(start)
 226
 227       now = int(time.time())
 228       bookmark.test_time = str(now - start)