# encoding: UTF-8
# api: streamtuner2
# title: Drag and Drop (experimental)
# description: Copy streams/stations from and to other applications.
# depends: uikit
# version: 0.5
# type: interface
# config:
# { name: dnd_format, type: select, value: xspf, select: "pls|m3u|xspf|jspf|asx|smil", description: "Default temporary file format for copying a station." }
# category: ui
# priority: default
# support: experimental
#
# Implements Gtk/X11 drag and drop support for station lists.
# Should allow to export either just stream URLs, or complete
# PLS, XSPF collections.
#
# Also used by the bookmarks channel to copy favourites around.
# Which perhaps should even be constrained to just the bookmarks
# tab.
import copy
from config import conf, json, log
from uikit import *
import action
# Welcome to my new blog.
#
# Now it's perhaps not even Gtks fault, but all the gory implementation
# details of XDND are pretty gory. Neither match up to reality anymore.
#
# Pretty much only the ridiculous `TEXT/URI-LIST` is used in practice.
# Without host names, of course, despite the spec saying otherwise. (It
# perhaps leaked into the Gnome UI, and they decreed it banished). And
# needless to say, there's no actual IRI/URI support in any file manager
# or pairing apps beyond local paths.
#
# Supporting PLS, XSPF, M3U as direct payload was a pointless exercise.
# It's not gonna get requested by anyone. Instead there's another config
# option now, which predefines the exchange format for temporary file:///
# dumps. Because, you know, there was never any point in type negotiation
# due to all the API overhead.
#
# What works, and what's widely used in practice instead, is declaring
# yet another custom type per application. Our row format is transferred
# unfiltered over the selection buffer as JSON. However, it's decidedly
# never exposed to other apps as x-special/x-custom whatever. (It's also
# not using the MIME 1.0 application/* trash bin for that very reason.)
# Drag and Drop support
class dnd(object):
module = "dnd"
meta = plugin_meta()
# Keeps selected row on starting DND event
row = None
# Buffer converted types
buf = {}
# Supported type map
drag_types = [
# internal
("json/vnd.streamtuner2.station", gtk.TARGET_SAME_APP, 51),
# literal exports
("audio/x-mpegurl", 0, 20),
("application/x-scpls", 0, 21),
("application/xspf+xml", 0, 22),
("application/smil", 0, 23),
("text/html", 0, 23),
("text/richtext", 0, 23),
("application/jspf+json", 0, 25),
# direct srv urls
("text/url", 0, 15), #@TODO: support in action.save_/convert_
("message/external-body", 0, 15),
("url/direct", 0, 15),
# filename, file:// IRL
("FILE_NAME", 0, 3),
("text/uri-list", 0, 4),
# url+comments
("TEXT", 0, 5),
("STRING", 0, 5),
("UTF8_STRING", 0, 5),
("text/plain", 0, 5),
]
# Map target/`info` integers to action. module identifiers
cnv_types = {
20: "m3u",
21: "pls",
22: "xspf",
23: "smil",
25: "jspf",
15: "srv",
4: "temp",
5: "srv",
51: "json",
}
# Hook to main, and extend channel tabs
def __init__(self, parent):
self.parent = parent
parent.hooks["init"].append(self.add_dnd)
conf.add_plugin_defaults(self.meta, self.module)
log.colors["DND"] = "1;33;41m"
# Attach drag and drop handlers to each channelsĀ“ station TreeView
def add_dnd(self, parent):
# visit each module
for cn,module in parent.channels.items():
w = module.gtk_list
# bind SOURCE events
w.enable_model_drag_source(gtk.gdk.BUTTON1_MASK, self.drag_types, gtk.gdk.ACTION_DEFAULT|gtk.gdk.ACTION_COPY)
w.connect('drag-begin', self.begin)
w.connect('drag-data-get', self.data_get)
# bind DESTINATION events
w.enable_model_drag_dest(self.drag_types, gtk.gdk.ACTION_DEFAULT|gtk.gdk.ACTION_COPY)
w.connect('drag-drop', self.drop)
w.connect('drag-data-received', self.data_received)
# -- SOURCE, drag'n'drop from ST2 to elsewhere --
# Starting to drag a row
def begin(self, widget, context):
log.DND("sourceāout: begin-drag, store current row")
self.row = self.treelist_row()
self.buf = {}
uikit.do(context.set_icon_stock, gtk.STOCK_ADD, 16, 16)
return "url" in self.row
# Keep currently selected row when source dragging starts
def treelist_row(self):
cn = self.parent.channel()
row = copy.copy(cn.row())
row.setdefault("format", cn.audioformat)
row.setdefault("listformat", cn.listformat)
row.setdefault("url", row.get("homepage"))
row.update({"_origin": [cn.module, cn.current, cn.rowno()]}) # internal: origin channel+genre+rowid
return row
# Target window/app requests data for offered drop
def data_get(self, widget, context, selection, info, time):
log.DND("sourceāout: data-get, send and convert to requested target type:", info, selection.get_target())
# Return prepared data
func, data = self.export_row(info, self.row)
if func.find("text") >= 0:
# Yay for trial and error. Nay for docs. PyGtks selection.set_text() doesn't
# actually work unless the requested target type is an Atom. Therefore "STRING".
selection.set("STRING", 8, data)
if func.find("uris") >= 0:
selection.set_uris(data)
return True
# Handles the conversion from the stored .row to the desired selection data
def export_row(self, info, r):
# Needs buffering because `data_get` gets called mercilessly along the dragging path
if info in self.buf:
return self.buf[info]
# Prepare new converter
cnv = action.save_playlist(source=r["listformat"], multiply=False)
# internal JSON row
if info >= 51:
buf = 'text', json.dumps(r)
# Pass M3U/PLS/XSPF as literal payload
elif info >= 20:
buf = 'text', cnv.export(urls=[r["url"]], row=r, dest=self.cnv_types[info])
# Direct server URL
elif info >= 10:
urls = action.convert_playlist(r["url"], r["listformat"], "srv", False, r)
#buf = 'uris', urls
buf = 'text', urls[0]
# Text sources are assumed to understand the literal URL or expect a description block
elif info >= 5:
buf = 'text', "{url}\n# Title: {title}\n# Homepage: {homepage}\n\n".format(**r)
# Create temporary PLS file, because "text/uri-list" is widely misunderstood and just implemented for file:// IRLs
else:
tmpfn = "{}/{}.{}".format(conf.tmp, re.sub("[^\w-]+", " ", r["title"]), conf.dnd_format)
cnv.file(rows=[r], dest=conf.dnd_format, fn=tmpfn)
buf = 'uris', ["file://{}".format(tmpfn)] if (info==4) else tmpfn
# Keep in type request buffer
self.buf[info] = buf
return buf
# -- DESTINATION, when playlist/file gets dragged in from other app --
# Just a notification for incoming drop
def drop(self, widget, context, x, y, time):
log.DND("destāin: drop-probing, possible targets:", context.targets)
# find a matching target
accept = [type[0] for type in self.drag_types if type[0] in context.targets]
context.drop_reply(len(accept) > 0, time)
if accept:
widget.drag_get_data(context, accept[0], time) or True
return True
# Actual data is being passed,
def data_received(self, widget, context, x, y, selection, info, time):
log.DND("destāin: data-receival", info, selection.get_text(), selection.get_uris())
# incoming data
data = selection.get_text()
urls = selection.get_uris()
any = (data or urls) and True
# Convert/Add
if any: self.import_row(info, urls, data, y)
else: log.DND("Abort, no urls/text.")
# Respond
context.drop_finish(any, time)
context.finish(any, False, time)
return True
# Received files or payload has to be converted, copied into streams
def import_row(self, info, urls, data, y=5000):
# Internal target dicts
cn = self.parent.channel()
rows = []
print info
# Direct/internal row import
if data and info >= 51:
log.DND("Received row, append, reload")
rows += [ json.loads(data) ]
# Convertible formats
elif data and info >= 5:
cnv = action.extract_playlist(data)
urls = cnv.format(self.cnv_types[info] if info>=20 else "raw")
rows += [ self.imported_row(urls[0], cnv.title()) ]
# Extract from playlist files, either passed as text/uri-list or FILE_NAME
elif urls:
for fn in [re.sub("^\w+://[^/]*", "", fn) for fn in urls or [data] if re.match("^(scp|file)://(localhost)?/|/", fn)]:
ext = action.probe_playlist_fn_ext(fn)
if ext: # don't import mp3s into stream lists directly
cnt = open(fn, "rt").read()
probe = action.probe_playlist_content(cnt)
if ext == probe:
cnv = action.extract_playlist(cnt)
urls = cnv.format(probe)
rows += [ self.imported_row(urls[0], cnv.title() or os.path.basename(fn)) ]
# Insert and update view
if rows:
# Inserting at correct row requires deducing index from dnd `y` position
streams = cn.streams[cn.current]
i_pos = (cn.gtk_list.get_path_at_pos(10, y) or [[len(streams) + 1]])[0][0]
for row in rows:
streams.insert(i_pos - 1, row)
i_pos = i_pos + 1
# Now appending to the liststore directly would be even nicer
uikit.do(lambda *x: cn.load(cn.current))#, cn.gtk_list.scroll_to_point(0, y))
if cn.module == "bookmarks":
cn.save()
#self.parent.streamedit()
else:
self.parent.status("Unsupported station format. Not imported.")
# Stub row for dragged entries.
# Which is a workaround for the missing full playlist conversion and literal URL input
def imported_row(self, url, title=None):
return {
"title": title or "",
"url": url,
"homepage": "",
"playling": "",
"listformat": action.probe_playlist_fn_ext(url) or "href",
"format": ",".join(re.findall("ogg|mpeg|mp\d+", url)),
"genre": "copy",
}