Robots/bkmk_robot_base.py

   1 """Base class for robots
   2
   3 This file is a part of Bookmarks database and Internet robot.
   4
   5 """
   6
   7 __author__ = "Oleg Broytman <phd@phdru.name>"
   8 __copyright__ = "Copyright (C) 2000-2023 PhiloSoft Design"
   9 __license__ = "GNU GPL"
  10
  11 __all__ = ['robot_base', 'get_error']
  12
  13
  14 from base64 import b64encode
  15 import sys
  16 import socket
  17 import time
  18 try:
  19     from urllib.parse import splittype, splithost, splittag, urljoin
  20 except ImportError:
  21     from urllib import splittype, splithost, splittag
  22     from urlparse import urljoin
  23
  24 from m_lib.md5wrapper import md5wrapper
  25 from m_lib.net.www.util import parse_time
  26
  27 from bkmk_objects import Robot
  28 from parse_html import parse_html
  29
  30
  31 reloc_dict = {
  32   301: "perm.",
  33   302: "temp2.",
  34   303: "temp3.",
  35   307: "temp7.",
  36   "html": "html"
  37 }
  38
  39
  40 def get_error(e):
  41     if isinstance(e, str):
  42         return e
  43
  44     else:
  45         s = []
  46         for i in e:
  47             s.append("'%s'" % str(i).replace('\n', "\\n"))
  48         return "(%s)" % ' '.join(s)
  49
  50
  51 # Icon cache; maps URL to a tuple (content type, data)
  52 # or None if there is no icon.
  53 icons = {}
  54
  55
  56 class robot_base(Robot):
  57     timeout = 60
  58
  59     def __init__(self, *args, **kw):
  60         Robot.__init__(self, *args, **kw)
  61         socket.setdefaulttimeout(int(self.timeout))
  62
  63     def check_url(self, bookmark):
  64         try:
  65             self.start = int(time.time())
  66             bookmark.icon = None
  67
  68             url_type, url_rest = splittype(bookmark.href)
  69             url_host, url_path = splithost(url_rest)
  70             url_path, url_tag  = splittag(url_path)  # noqa: E221
  71             #                    multiple spaces before operator
  72
  73             url = "%s://%s%s" % (url_type, url_host, url_path)
  74             error, redirect_code, redirect_to, headers, content = \
  75                 self.get(bookmark, url, True)
  76
  77             if error:
  78                 bookmark.error = error
  79                 return 1
  80
  81             if redirect_code:
  82                 self.set_redirect(bookmark, redirect_code, redirect_to)
  83                 return 1
  84
  85             size = 0
  86             last_modified = None
  87
  88             if headers:
  89                 try:
  90                     size = headers["Content-Length"]
  91                 except KeyError:
  92                     size = len(content)
  93
  94                 try:
  95                     last_modified = headers["Last-Modified"]
  96                 except KeyError:
  97                     pass
  98
  99                 if last_modified:
 100                     last_modified = parse_time(last_modified)
 101             else:
 102                 size = len(content)
 103
 104             if last_modified:
 105                 last_modified = str(int(last_modified))
 106             else:
 107                 last_modified = bookmark.last_visit
 108
 109             bookmark.size = size
 110             bookmark.last_modified = last_modified
 111
 112             md5 = md5wrapper()
 113             if url_type == "ftp":  # Pass welcome message through MD5
 114                 md5.update(self.get_ftp_welcome())
 115
 116             md5.update(content)
 117             bookmark.md5 = str(md5)
 118
 119             if headers:
 120                 try:
 121                     content_type = headers["Content-Type"]
 122                     self.log("   Content-Type: %s" % content_type)
 123                     try:
 124                         # extract charset from
 125                         # "text/html; foo; charset=UTF-8, bar; baz;"
 126                         content_type, charset = content_type.split(';', 1)
 127                         content_type = content_type.strip()
 128                         charset = charset.split('=')[1].strip().split(',')[0]
 129                         self.log("   HTTP charset   : %s" % charset)
 130                     except (ValueError, IndexError):
 131                         charset = None
 132                         self.log("   no charset in Content-Type header")
 133                     for ctype in ("text/html", "application/xhtml+xml"):
 134                         if content_type.startswith(ctype):
 135                             html = True
 136                             break
 137                     else:
 138                         html = False
 139                     if html:
 140                         parser = parse_html(content, charset, self.log)
 141                         if parser:
 142                             bookmark.real_title = parser.title
 143                             icon = parser.icon
 144                         else:
 145                             icon = None
 146                         if not icon:
 147                             icon = "/favicon.ico"
 148                         icon_url = urljoin(
 149                             "%s://%s%s" % (url_type, url_host, url_path), icon)
 150                         self.log("   looking for icon at: %s" % icon_url)
 151                         if icon_url in icons:
 152                             if icons[icon_url]:
 153                                 bookmark.icon_href = icon_url
 154                                 content_type, bookmark.icon = icons[icon_url]
 155                                 self.log("   cached icon: %s" % content_type)
 156                             else:
 157                                 self.log("   cached icon: no icon")
 158                         else:
 159                             try:
 160                                 _icon_url = icon_url
 161                                 for i in range(8):
 162                                     error, icon_redirect_code, \
 163                                         icon_redirect_to, icon_headers, \
 164                                         icon_data = \
 165                                         self.get(bookmark, _icon_url)
 166                                     if icon_redirect_code:
 167                                         _icon_url = icon_redirect_to
 168                                         self.log("   redirect to : %s"
 169                                                  % _icon_url)
 170                                     else:
 171                                         if icon_data is None:
 172                                             raise IOError("No icon")
 173                                         break
 174                                 else:
 175                                     raise IOError("Too many redirects")
 176                             except:
 177                                 etype, emsg, _ = sys.exc_info()
 178                                 self.log("   no icon        : %s %s"
 179                                          % (etype, emsg))
 180                                 etype = emsg = _ = None
 181                                 icons[icon_url] = None
 182                             else:
 183                                 content_type = icon_headers["Content-Type"]
 184                                 if content_type.startswith("application/") \
 185                                    or content_type.startswith("image/") \
 186                                    or content_type.startswith("text/plain"):
 187                                     bookmark.icon_href = icon_url
 188                                     self.log("   got icon       : %s"
 189                                              % content_type)
 190                                     if (
 191                                         content_type.startswith("application/")
 192                                         or content_type.startswith(
 193                                             "text/plain")
 194                                     ):
 195                                         self.log("   non-image content type,"
 196                                                  " assume x-icon")
 197                                         content_type = 'image/x-icon'
 198                                     bookmark.icon = "data:%s;base64,%s" \
 199                                         % (content_type, b64encode(icon_data))
 200                                     icons[icon_url] = (content_type,
 201                                                        bookmark.icon
 202                                                        )
 203                                 else:
 204                                     self.log("   no icon        :"
 205                                              "bad content type '%s'"
 206                                              % content_type
 207                                              )
 208                                     icons[icon_url] = None
 209                         if parser and parser.refresh:
 210                             refresh = parser.refresh
 211                             try:
 212                                 url = refresh.split('=', 1)[1]
 213                             except IndexError:
 214                                 url = "self"
 215                             try:
 216                                 timeout = float(refresh.split(';')[0])
 217                             except (IndexError, ValueError):
 218                                 self.set_redirect(bookmark, "html",
 219                                                   "Bad redirect to %s (%s)"
 220                                                   % (url, refresh)
 221                                                   )
 222                             else:
 223                                 try:
 224                                     timeout = int(refresh.split(';')[0])
 225                                 except ValueError:
 226                                     pass  # float timeout
 227                                 self.set_redirect(bookmark, "html",
 228                                                   "%s (%s sec)"
 229                                                   % (url, timeout)
 230                                                   )
 231
 232                 except KeyError as key:
 233                     self.log("   no header: %s" % key)
 234
 235         except EOFError:
 236             bookmark.error = "Unexpected EOF (FTP server closed connection)"
 237             self.log('   EOF: %s' % bookmark.error)
 238
 239         except KeyboardInterrupt:
 240             self.log("Keyboard interrupt (^C)")
 241             return 0
 242
 243         except socket.error as e:
 244             bookmark.error = get_error(e)
 245             self.log(bookmark.error)
 246
 247         except:
 248             import traceback
 249             traceback.print_exc()
 250             bookmark.error = "Exception!"
 251             self.log('   Exception: %s' % bookmark.error)
 252
 253         finally:
 254             self.finish_check_url(bookmark)
 255
 256         # Tested
 257         return 1
 258
 259     def set_redirect(self, bookmark, errcode, newurl):
 260         bookmark.moved = "(%s) to %s" % (reloc_dict[errcode], newurl)
 261         self.log('   Moved: %s' % bookmark.moved)
 262
 263     def finish_check_url(self, bookmark):
 264         start = self.start
 265         bookmark.last_tested = str(start)
 266         now = int(time.time())
 267         bookmark.test_time = str(now - start)