Robots/bkmk_rsimple.py

   1 """
   2    Simple, strightforward robot
   3
   4    Written by Oleg Broytman. Copyright (C) 2000-2010 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    # Error 307 -- also relocated (temporary)
  44    http_error_307 = http_error_302
  45
  46    # Error 401 -- authentication required
  47    def http_error_401(self, url, fp, errcode, errmsg, headers, data=None):
  48       raise IOError, ('http error', errcode, "Authentication required ", headers)
  49
  50    def http_error_default(self, url, fp, errcode, errmsg, headers):
  51       if fp:
  52          void = fp.read()
  53          fp.close()
  54       raise IOError, ('http error', errcode, errmsg, headers)
  55
  56
  57 urllib._urlopener = MyURLopener()
  58
  59 # Fake headers to pretend this is a real browser
  60 _version = "Mozilla/5.0 (X11; U; Linux 2.6 i686; en) Gecko/20001221 Firefox/2.0.0"
  61 urllib._urlopener.addheaders[0] = ('User-Agent', _version)
  62 _version = "bookmarks_db (Python %d.%d.%d; urllib/%s)" % (
  63    sys.version_info[0], sys.version_info[1], sys.version_info[2], urllib.__version__)
  64 urllib._urlopener.addheader('X-User-Agent', _version)
  65 urllib._urlopener.addheader('Referer', '')
  66
  67 urllib._urlopener.addheader('Connection', 'close')
  68 urllib._urlopener.addheader('Accept', '*/*')
  69 urllib._urlopener.addheader('Accept-Language', 'ru,en')
  70 urllib._urlopener.addheader('Cache-Control', 'max-age=300')
  71
  72
  73 def get_error(msg):
  74    if isinstance(msg, str):
  75       return msg
  76
  77    else:
  78       s = []
  79       for i in msg:
  80          s.append("'%s'" % str(i).replace('\n', "\\n"))
  81       return "(%s)" % ' '.join(s)
  82
  83
  84 urllib_ftpwrapper = urllib.ftpwrapper
  85 ftpcache_key = None
  86
  87 class myftpwrapper(urllib_ftpwrapper):
  88    def __init__(self, user, passwd, host, port, dirs):
  89       urllib_ftpwrapper.__init__(self, user, passwd, host, port, dirs)
  90       global ftpcache_key
  91       ftpcache_key = (user, host, port, '/'.join(dirs))
  92
  93 urllib.ftpwrapper = myftpwrapper
  94
  95 def get_welcome():
  96    global ftpcache_key
  97    _welcome = urllib._urlopener.ftpcache[ftpcache_key].ftp.welcome
  98    ftpcache_key = None # I am assuming there are no duplicate ftp URLs in db.
  99                        # If there are - ftpcache_key in prev line is invalid.
 100    return _welcome
 101
 102
 103 icons = {} # Icon cache; maps URL to a tuple (content type, data)
 104            # or None if there is no icon.
 105
 106 class robot_simple(Robot):
 107    def check_url(self, bookmark):
 108       try:
 109          self.start = int(time.time())
 110          bookmark.icon = None
 111
 112          url_type, url_rest = urllib.splittype(bookmark.href)
 113          url_host, url_path = urllib.splithost(url_rest)
 114          url_path, url_tag  = urllib.splittag(url_path)
 115
 116          # Set fake referer to the root of the site
 117          urllib._urlopener.addheaders[2] = ('Referer', "%s://%s%s" % (url_type, url_host, url_path))
 118
 119          if bookmark.charset: urllib._urlopener.addheader('Accept-Charset', bookmark.charset)
 120          fname, headers = urllib.urlretrieve("%s://%s%s" % (url_type, url_host, url_path))
 121          if bookmark.charset: del urllib._urlopener.addheaders[-1]
 122
 123          size = 0
 124          last_modified = None
 125
 126          if headers:
 127             try:
 128                size = headers["Content-Length"]
 129             except KeyError:
 130                pass
 131
 132             try:
 133                last_modified = headers["Last-Modified"]
 134             except KeyError:
 135                pass
 136
 137             if last_modified:
 138                last_modified = parse_time(last_modified)
 139
 140          if last_modified:
 141             last_modified = str(int(last_modified))
 142          else:
 143             last_modified = bookmark.last_visit
 144
 145          bookmark.size = size
 146          bookmark.last_modified = last_modified
 147
 148          md5 = md5wrapper()
 149          if urllib._urlopener.type == "ftp": # Pass welcome message through MD5
 150             md5.update(get_welcome())
 151
 152          md5.md5file(fname)
 153          bookmark.md5 = str(md5)
 154
 155          if headers:
 156             try:
 157                content_type = headers["Content-Type"]
 158                self.log("   Content-Type: %s" % content_type)
 159                try:
 160                   # extract charset from "text/html; foo; charset=UTF-8, bar; baz;"
 161                   content_type, charset = content_type.split(';', 1)
 162                   content_type = content_type.strip()
 163                   charset = charset.split('=')[1].strip().split(',')[0]
 164                   self.log("   HTTP charset   : %s" % charset)
 165                except (ValueError, IndexError):
 166                   charset = None
 167                   self.log("   no charset in Content-Type header")
 168                for ctype in ("text/html", "application/xhtml+xml"):
 169                   if content_type.startswith(ctype):
 170                       html = True
 171                       break
 172                else:
 173                   html = False
 174                if html:
 175                   parser = parse_html(fname, charset, self.log)
 176                   if parser:
 177                       bookmark.real_title = parser.title
 178                       if parser.refresh:
 179                          refresh = parser.refresh
 180                          try:
 181                             url = refresh.split('=', 1)[1]
 182                          except IndexError:
 183                             url = "self"
 184                          try:
 185                             timeout = float(refresh.split(';')[0])
 186                          except (IndexError, ValueError):
 187                             raise RedirectException("html", "Bad redirect to %s (%s)" % (url, refresh))
 188                          else:
 189                             try:
 190                                timeout = int(refresh.split(';')[0])
 191                             except ValueError:
 192                                pass # float timeout
 193                             raise RedirectException("html", "%s (%s sec)" % (url, timeout))
 194
 195                       # Get favicon.ico
 196                       icon = parser.icon
 197                   else:
 198                      icon = None
 199                   if not icon:
 200                      icon = "/favicon.ico"
 201                   icon = urljoin("%s://%s%s" % (url_type, url_host, url_path), icon)
 202                   self.log("   looking for icon at: %s" % icon)
 203                   if icon in icons:
 204                      if icons[icon]:
 205                         bookmark.icon_href = icon
 206                         content_type, bookmark.icon = icons[icon]
 207                         self.log("       cached icon: %s" % content_type)
 208                      else:
 209                         self.log("       cached icon: no icon")
 210                   else:
 211                      try:
 212                         _icon = icon
 213                         for i in range(8):
 214                            try:
 215                               icon_fname, headers = urllib.urlretrieve(_icon)
 216                            except RedirectException, e:
 217                               _icon = e.url
 218                               self.log("       redirect to : %s" % _icon)
 219                            else:
 220                               break
 221                         else:
 222                            raise IOError("Too many redirects")
 223                      except:
 224                         etype, emsg, tb = sys.exc_info()
 225                         self.log("   no icon        : %s %s" % (etype, emsg))
 226                         etype = None
 227                         emsg = None
 228                         tb = None
 229                         icons[icon] = None
 230                      else:
 231                         content_type = headers["Content-Type"]
 232                         if content_type.startswith("image/"):
 233                            icon_file = open(icon_fname, "rb")
 234                            icon_data = icon_file.read()
 235                            icon_file.close()
 236                            bookmark.icon_href = icon
 237                            bookmark.icon = "data:%s;base64,%s" % (content_type, b64encode(icon_data))
 238                            self.log("   got icon       : %s" % content_type)
 239                            icons[icon] = (content_type, bookmark.icon)
 240                         else:
 241                            self.log("   no icon        : bad content type '%s'" % content_type)
 242                            icons[icon] = None
 243                         os.remove(icon_fname)
 244
 245             except KeyError, key:
 246                self.log("   no header: %s" % key)
 247
 248       except IOError, msg:
 249          if (msg[0] == "http error") and (msg[1] == -1):
 250             bookmark.no_error = "The server did not return any header - it is not an error, actually"
 251             self.log('   no headers: %s' % bookmark.no_error)
 252          else:
 253             bookmark.error = get_error(msg)
 254             self.log('   Error: %s' % bookmark.error)
 255
 256       except EOFError:
 257          bookmark.error = "Unexpected EOF (FTP server closed connection)"
 258          self.log('   EOF: %s' % bookmark.error)
 259
 260       except RedirectException, msg:
 261          bookmark.moved = str(msg)
 262          self.log('   Moved: %s' % bookmark.moved)
 263
 264       except KeyboardInterrupt:
 265          self.log("Keyboard interrupt (^C)")
 266          return 0
 267
 268       except:
 269          import traceback
 270          traceback.print_exc()
 271          bookmark.error = "Exception!"
 272          self.log('   Exception: %s' % bookmark.error)
 273
 274       finally:
 275          self.finish_check_url(bookmark, fname)
 276
 277       # Tested
 278       return 1
 279
 280
 281    def finish_check_url(self, bookmark, fname=None):
 282       # Calculate these attributes even in case of an error
 283       if fname and os.path.exists(fname):
 284          size = str(os.path.getsize(fname))
 285          if size[-1] == 'L':
 286             size = size[:-1]
 287          bookmark.size = size
 288
 289       start = self.start
 290       bookmark.last_tested = str(start)
 291
 292       now = int(time.time())
 293       bookmark.test_time = str(now - start)