Check-in [bd1a9cba05]
Overview
Comment: | Move `favicon` module into extension/feature plugin. Simplify row["favicon"] cache filename pregeneration; separate from favicon module (but basically duplicated code there). Refactor most internal favicon+banner processing, rename methods for clarity. Plugin registers itself as .hooks["play"] callback. Uses main.thread() now instead of custom variant. Create icon cache dir on initialiation rather. Use combined row_to_fn() for cache filename generation instead of domain(), url(), file(), etc. Previous banner downloads are ignored, because the filename normalization is more in line with domain favicons now. Only update pixstore on successful downloads. Pre-check the content type per binary regex now, before saving image files. Combine resizing into store_image() function as well. Even PNG files will be piped through PIL (for sanitization). Completely got rid of urllib usage. Homepage/HTML extraction got rewritten, simpler, still inexact; but works now for most webpages. Favicon homepage downloading checks both returned MIME type and actual file content prior saving. Shorten timeouts to 2-3 seconds for Google and custom favicon retrieval. |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA1: |
bd1a9cba051a8ffbbc33fbc5892a6807 |
User & Date: | mario on 2015-05-10 19:20:49 |
Other Links: | manifest | tags |
Context
2015-05-10
| ||
19:45 | Work atop Python3 by using io.BytesIO rather than compat2and3 module. check-in: 7ec987b9ba user: mario tags: trunk | |
19:20 | Move `favicon` module into extension/feature plugin. Simplify row["favicon"] cache filename pregeneration; separate from favicon module (but basically duplicated code there). Refactor most internal favicon+banner processing, rename methods for clarity. Plugin registers itself as .hooks["play"] callback. Uses main.thread() now instead of custom variant. Create icon cache dir on initialiation rather. Use combined row_to_fn() for cache filename generation instead of domain(), url(), file(), etc. Previous banner downloads are ignored, because the filename normalization is more in line with domain favicons now. Only update pixstore on successful downloads. Pre-check the content type per binary regex now, before saving image files. Combine resizing into store_image() function as well. Even PNG files will be piped through PIL (for sanitization). Completely got rid of urllib usage. Homepage/HTML extraction got rewritten, simpler, still inexact; but works now for most webpages. Favicon homepage downloading checks both returned MIME type and actual file content prior saving. Shorten timeouts to 2-3 seconds for Google and custom favicon retrieval. check-in: bd1a9cba05 user: mario tags: trunk | |
19:12 | Create stub plugins/__init__.py in any case. check-in: a6b4b00c41 user: mario tags: trunk | |
Changes
Modified channels/__init__.py from [33bbfd495e] to [50c58e1601].
︙ | ︙ | |||
30 31 32 33 34 35 36 | import gtk from uikit import uikit, ver as gtk_ver from config import * import ahttp import action | < | 30 31 32 33 34 35 36 37 38 39 40 41 42 43 | import gtk from uikit import uikit, ver as gtk_ver from config import * import ahttp import action import os.path import xml.sax.saxutils import re import copy import inspect |
︙ | ︙ | |||
371 372 373 374 375 376 377 | # state icon: INFO or DELETE if (not row.get("state")): if row.get("favourite"): streams[i]["state"] = gtk.STOCK_ABOUT if conf.retain_deleted and row.get("deleted"): streams[i]["state"] = gtk.STOCK_DELETE | | | | | > | | | < < < < < < | 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 | # state icon: INFO or DELETE if (not row.get("state")): if row.get("favourite"): streams[i]["state"] = gtk.STOCK_ABOUT if conf.retain_deleted and row.get("deleted"): streams[i]["state"] = gtk.STOCK_DELETE # Favicons? construct local cache filename, basically reimplements favicon.row_to_fn() if conf.show_favicons and "favicon" in self.parent.features: url = row.get("img") or row.get("homepage") if url: # Normalize by stripping proto:// and non-alphanumeric chars url = re.sub("[^\w._-]", "_", re.sub("^\w+://|/$", "", url.lower())) streams[i]["favicon"] = "{}/icons/{}.png".format(conf.dir, url) return streams # data preparations directly after reload # # - drop shoutcast homepage links # - or find homepage name in title |
︙ | ︙ |
Modified channels/favicon.py from [9ae90f0624] to [444cf2c952].
1 2 | # encoding: utf-8 # api: streamtuner2 | | | | < | > > | > > | < > > | < | > > > | < | > | > > > > > | > | < | > > > | < < < | | > > | > | > > > | | | | | > > > | > > > > > | | > > > > | | > > | > > > | > | | > | | > > > > > | < > > > > | > > > > > > | > > > > | > | > | > > > | > > | | | | | | > > > > | > | | | < > > | | > > > > | > > > > > > | > | < | | | | | | | | | | | | > | > | < < > > > > | < < < | < < < < < < < | < > | < | | < < < | < < | | > | < | < < | < < | | | > < < < < > > | | > > | | | < < > > | < < | < < < < | | < | | | < < < | < < | < < < | | < | | > < < < < < < < < < | | | < | < | < | < | < < < | | < < < < | > > | < < < | < | | < | | < < | > | < < < < | | < < < > > > | | > > | | | < | | > | | | < < | > > | | > > | < | > | < < < < < < | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 | # encoding: utf-8 # api: streamtuner2 # title: Favicons # description: Display station favicons/logos. Instantly download them when โธplaying. # config: # { name: favicon_google_first, type: bool, value: 1, description: "Prefer faster Google favicon to PNG conversion service." } # { name: favicon_delete_stub , type: bool, value: 1, description: "Don't accept any placeholder favicons." } # [ main-name: google_homepage ] # [ main-name: load_favicon ] # type: feature # category: ui # version: 1.7 # depends: streamtuner2 >= 2.1.9, python:pil # priority: standard # # This module fetches a favicon for each station, or a small banner # or logo for some channel modules. It converts .ico image files and # sanitizes .png or .jpeg images even prior display. # # It prepares cache files in ~/.config/streamtuner2/icons/ in agreement # with the station list display logic. Either uses station "homepage" # or "img" URLs from entry rows{}. # # While it can often discover favicons directly from station homepages, # it's often speedier to user the Google PNG conversion service. Both # depend on a recent Pillow2 python module (superseding the PIL module). # Else may display images with fragments if converted from ICO files. # # Has recently been rewritten, is somewhat less entangled with other # modules now: # ยท GenericChannel presets row["favicon"] with cache image filename # in any case, uses row["homepage"] or row["img"] as template # ยท the filename shortening functionality must be shared between # favicon and genericchannel.prepare() code # ยท uikit.columns() merely checks row["favicon"] for file existence # on redraws # ยท main.play() only calls .update_playing() or .update_all() # ยท urllib is no longer required, uses the main ahttp/requests API # ยท still might need unhtml() from channels/__init__ later # ยท Reduce config options โ move main favicon options here? import os, os.path from compat2and3 import StringIO import re from config import * import ahttp from PIL import Image from uikit import gtk # Ensure that we don't try to download a single favicon twice per session. # If it's not available the first time, we won't get it after switching # stations back and forth either. So URLs are skipped simply. tried_urls = [] # Hook up as feature plugin # class favicon(object): # plugin attributes module = "favicon" meta = plugin_meta() # Register with main def __init__(self, parent): # Reference main, and register hook self.parent, self.main = parent, parent parent.hooks["play"].append(self.update_playing) # Prepare favicon cache directory conf.icon_dir = conf.dir + "/icons" if not os.path.exists(conf.icon_dir): os.mkdir(conf.icon_dir) open(icon_dir+"/.nobackup", "a").close() # Main callback: update favicon cache for complete list of station rows def update_all(self, *args, **kwargs): #kwargs[pixstore] = self.parent.channel()._ls, ... self.parent.thread(self.update_rows, *args, **kwargs) # Main callback for a single play() event def update_playing(self, row, pixstore=None): # Homepage search if conf.google_homepage and not len(row.get("homepage", "")): google_find_homepage(row) # Favicon only for currently playing station if conf.load_favicon: if row.get("homepage") or row.get("img"): self.update_all([row], pixstore=pixstore) # Run through rows[] to update "favicon" from "homepage" or "img", # optionally display new image right away in ListStore def update_rows(self, entries, pixstore=None): for i,row in enumerate(entries): ok = False # Try just once if row.get("homepage") in tried_urls: continue # Ignore existing ["favicon"] filename if row.get("favicon") and False: pass # Cache image filename: have or can't have favicon_fn = row_to_fn(row) if not favicon_fn: continue if os.path.exists(favicon_fn): continue # Custom "img" banner/logo as favicon if row.get("img"): tried_urls.append(row["img"]) ok = banner_localcopy(row["img"], favicon_fn) # Homepage to favicon elif row.get("homepage"): tried_urls.append(row["homepage"]) if conf.favicon_google_first: ok = fav_google_ico2png(row["homepage"], favicon_fn) else: ok = fav_from_homepage(row["homepage"], favicon_fn) # Update TreeView if ok: self.update_pixstore(row, pixstore, i) pass # Update favicon in treeview/liststore def update_pixstore(self, row, pixstore=None, row_i=None): log.FAVICON_UPDATE_PIXSTORE(pixstore, row_i) if not pixstore: return # Unpack ListStore, pixbuf column no, preset rowno ls, pix_entry, i = pixstore # Else rows-iteration rowno if i is None: i = row_i # Existing "favicon" cache filename if row.get("favicon"): fn = row["favicon"] else: fn = row_to_fn(row) # Update pixbuf in active station liststore if fn and os.path.exists(fn): try: p = gtk.gdk.pixbuf_new_from_file(fn) ls[i][pix_entry] = p except Exception as e: log.ERR("Update_pixstore image", fn, "error:", e) #--- somewhat unrelated --- # # Should become a distinct feature plugin. - It just depends on correct # invocation order for plugins to work. # Googling is often blocked anyway, because this is clearly a bot request. # Tag requests with ?client=streamtuner2 purposefully still. # def google_find_homepage(self, row): """ Searches for missing homepage URL via Google. """ if row.get("url") not in tried_urls: tried_urls.append(row.get("url")) if row.get("title"): rx_t = re.compile('^(([^-:]+.?){1,2})') rx_u = re.compile(r'/url\?q=(https?://[^"&/]+)') # Use literal station title now title = row["title"] #title = title.group(0).replace(" ", "%20") # Do 'le google search html = ahttp.get("http://www.google.com/search", params=dict(hl="en", q=title, client="streamtuner2"), ajax=1) # Find first URL hit url = rx_u.findall(html) if url: row["homepage"] = ahttp.fix_url(url[0]) pass #----------------- # Convert row["img"] or row["homepage"] into local favicon cache filename def row_to_fn(row): url = row.get("img") or row.get("homepage") or None if url: url = url.lower() url = re.sub("^\w+://|/$", "", url) # strip proto:// and trailing / url = re.sub("[^\w._-]", "_", url) # remove any non-word characters url = "{}/{}.png".format(conf.icon_dir, url) return url # Copy banner row["img"] into icons/ directory def banner_localcopy(url, fn): # Check URL and target filename if not re.match("^https?://[\w.-]{10}", url): return False # Fetch and save imgdata = ahttp.get(url, binary=1, verify=False) if imgdata: return store_image(imgdata, fn) # Check valid image, possibly convert, and save to cache filename def store_image(imgdata, fn, resize=None): # Convert accepted formats -- even PNG for filtering now if re.match(br'^(.PNG|GIF\d+|.{0,15}JFIF|\x00\x00\x01\x00|.{0,255}<svg[^>]+svg)', imgdata): try: # Read from byte/str image = Image.open(StringIO(imgdata)) log.FAVICON_IMAGE_TO_PNG(image, resize) # Resize if resize and image.size[0] > resize: image.resize((resize, resize), Image.ANTIALIAS) # Convert to PNG via string buffer out = StringIO() image.save(out, "PNG", quality=98) imgdata = out.getvalue() except Exception as e: return log.ERR("favicon/logo conversion error:", e) and False else: log.WARN("couldn't detect mime type") # PNG already? if re.match(b"^.(PNG)", imgdata): try: with open(fn, "wb") as f: f.write(imgdata) return True except Exception as e: log.ERR("favicon.store_image() failure:", e) # PNG via Google ico2png def fav_google_ico2png(url, fn): log.FAVICON("google ico2png") # Download from service domain = re.sub("^\w+://|/.*$", "", url).lower() geturl = "http://www.google.com/s2/favicons?domain={}".format(domain) imgdata = ahttp.get(geturl, binary=1, timeout=2.5) # Check for stub sizes if conf.favicon_delete_stub and len(imgdata) in (726,896): # google_placeholder_filesizes log.FAVICON("placeholder size, skipping") return False # Save else: return store_image(imgdata, fn) # Peek at homepage URL, download favicon.ico <link rel>, convert to PNG file, resize to 16x16 def fav_from_homepage(url, fn): # Check for <link rel=icon> img = html_link_icon(url) if not img: return False # Fetc image, verify MIMEE type r = ahttp.get(img, binary=1, content=0, timeout=2.75) if not re.match('image/(png|jpe?g|png|ico|x-ico|vnd.microsoft.ico)', r.headers["content-type"], re.I): log.WARN("content-type wrong", r.headers) return False # Convert, resize and save return store_image(r.content, fn, resize=16) # Download HTML, look for favicon name in <link rel=shortcut icon>. # # Very rough, doesn't respect any <base href=> and manually patches # icon path to homepage url; nor does any entity decoding. # def html_link_icon(url, href="/favicon.png"): html = ahttp.get(url, encoding="iso-8859-1", timeout=3.5) # Extract for link in re.findall(r""" <link ([^<>]+) > """, html, re.X): pair = re.findall(r""" \b(rel|href) \s*=\s* ["']? ([^<>"']+) ["']? """, link, re.X) pair = { name: val for name, val in pair } for name in ("shortcut icon", "favicon", "icon", "icon shortcut"): if name == pair.get("rel", "ignore") and pair.get("href"): href = pair["href"] # unhtml() break # Patch URL together (strip double proto/domain, or double slash) return re.sub("^(https?://\w[^/]+\w)?/?(https?://\w[^/]+\w)/?(/.+)$", "\g<2>\g<3>", url+href) #-- test if __name__ == "__main__": import sys favicon(None).download(sys.argv[1]) |
Modified st2.py from [7768280a8d] to [35aa375d2a].
︙ | ︙ | |||
52 53 54 55 56 57 58 | # gtk modules from uikit import pygtk, gtk, gobject, uikit, ui_xml, gui_startup, AboutStreamtuner2 # custom modules import ahttp import action import logo | < | | 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 | # gtk modules from uikit import pygtk, gtk, gobject, uikit, ui_xml, gui_startup, AboutStreamtuner2 # custom modules import ahttp import action import logo import channels import channels.bookmarks import channels.configwin import channels.streamedit import channels.search # This represents the main window, dispatches Gtk events, # and shares most application behaviour with the channel modules. class StreamTunerTwo(gtk.Builder): # object containers widgets = {} # non-glade widgets (any manually instantiated ones) channels = {} # channel modules features = {} # non-channel plugins working = [] # threads hooks = { "play": [], # observers queue here "record": [], "init": [], "quit": [action.cleanup_tmp_files], "config_load": [], "config_save": [], } meta = plugin_meta() |
︙ | ︙ | |||
118 119 120 121 122 123 124 | self.init_app_state() # and late plugin initializations [callback(self) for callback in self.hooks["init"]] # display current open channel/notebook tab gui_startup(18/20.0) self.current_channel = self.current_channel_gtk() | > | > | | 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 | self.init_app_state() # and late plugin initializations [callback(self) for callback in self.hooks["init"]] # display current open channel/notebook tab gui_startup(18/20.0) self.current_channel = self.current_channel_gtk() try: self.channel().first_show() except Exception as e: log.INIT("main.__init__: current_channel.first_show() initialization error:", e) # bind gtk/glade event names to functions gui_startup(19.75/20.0) self.connect_signals({ "gtk_main_quit" : self.gtk_main_quit, # close window # treeviews / notebook |
︙ | ︙ | |||
293 294 295 296 297 298 299 | category = self.channel().current self.thread( #@TODO: should get a wrapper, for HTTP errors, and optionalize bookamrks lambda: ( self.channel().load(category,reload), reload and self.bookmarks.heuristic_update(self.current_channel,category) ) ) # Thread a function, add to worker pool (for utilizing stop button) | | | | | 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 | category = self.channel().current self.thread( #@TODO: should get a wrapper, for HTTP errors, and optionalize bookamrks lambda: ( self.channel().load(category,reload), reload and self.bookmarks.heuristic_update(self.current_channel,category) ) ) # Thread a function, add to worker pool (for utilizing stop button) def thread(self, target, *args, **kwargs): if conf.nothreads: return target(*args, **kwargs) thread = Thread(target=target, args=args, kwargs=kwargs) thread.start() self.working.append(thread) # Click in category list def on_category_clicked(self, widget, event, *more): category = self.channel().currentcat() |
︙ | ︙ | |||
321 322 323 324 325 326 327 | # Reload category tree def update_categories(self, widget): Thread(target=self.channel().reload_categories).start() # Menu invocation: refresh favicons for all stations in current streams category def update_favicons(self, widget): | > | | | 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 | # Reload category tree def update_categories(self, widget): Thread(target=self.channel().reload_categories).start() # Menu invocation: refresh favicons for all stations in current streams category def update_favicons(self, widget): if "favicon" in self.features: ch = self.channel() self.features["favicon"].update_all(entries=ch.stations(), pixstore=[ch._ls, ch._pix_entry, None]) # Save stream to file (.m3u) def save_as(self, widget): row = self.row() default_fn = row["title"] + ".m3u" fn = uikit.save_file("Save Stream", None, default_fn, [(".m3u","*m3u"),(".pls","*pls"),(".xspf","*xspf"),(".jspf","*jspf"),(".smil","*smil"),(".asx","*asx"),("all files","*")]) if fn: |
︙ | ︙ |