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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
###############################################################################
# plugin_rhythmbox.py is a plugin for gnome-desktop-info to display song info
# and cover art, when playing music in rhythmbox
#
# Author: Kaivalagi
# Created: 23/11/2008
from optparse import OptionParser
from plugin_common import getHTMLText, getTypedValue, getFormattedDuration, isNumeric, getLyrics
import codecs
import fileinput
import logging
import os
import re
import shutil
import traceback
import urllib
import urllib2
try:
import dbus
DBUS_AVAIL = True
except ImportError:
# Dummy D-Bus library
class _Connection:
get_object = lambda *a: object()
class _Interface:
__init__ = lambda *a: None
ListNames = lambda *a: []
class Dummy: pass
dbus = Dummy()
dbus.Interface = _Interface
dbus.service = Dummy()
dbus.service.method = lambda *a: lambda f: f
dbus.service.Object = object
dbus.SessionBus = _Connection
DBUS_AVAIL = False
app_name = "gtk-desktop-info"
app_path = os.path.dirname(os.path.abspath(__file__))
module_name = __file__.replace(os.path.dirname (__file__) + "/", "").replace(".pyc","").replace(".py", "")
class MusicData:
def __init__(self,status,coverart,title,album,length,artist,tracknumber,genre,year,filename,current_position_percent,current_position,rating,volume):
self.status = status
self.coverart = coverart
self.title = title
self.album = album
self.length = length
self.artist = artist
self.tracknumber = tracknumber
self.genre = genre
self.year = year
self.filename = filename
self.current_position_percent = current_position_percent
self.current_position = current_position
self.rating = rating
self.volume = volume
class BansheeConfig:
HEADERTEMPLATE = None
TEMPLATE = None
STATUSTEXT = "Playing,Paused,Stopped"
NOUNKNOWNOUTPUT = False
class Output:
options = None
output = u""
error = u""
musicData = None
def __init__(self, options):
self.bus = None
self.options = options
self.logger = logging.getLogger(app_name+"."+module_name)
self.loadConfigData()
def loadConfigData(self):
try:
self.config = BansheeConfig()
if self.options.config != None:
# load the config based on options passed in from the main app
configfilepath = self.options.config
else:
# load plugin config from home directory of the user
configfilepath = os.path.join(os.path.expanduser('~'), ".config/"+app_name+"/"+module_name+".config")
if os.path.exists(configfilepath):
self.logger.info("Loading config settings from \"%s\""%configfilepath)
for line in fileinput.input(os.path.expanduser(configfilepath)):
line = line.strip()
if len(line) > 0 and line[0:1] != "#": # ignore commented lines or empty ones
splitpos = line.find("=")
name = line[:splitpos-1].strip().upper() # config setting name on the left of =
value = line[splitpos+1:].split("#")[0].strip()
if len(value) > 0:
if name == "HEADERTEMPLATE":
self.config.HEADERTEMPLATE = getTypedValue(value, "string")
elif name == "TEMPLATE":
self.config.TEMPLATE = getTypedValue(value, "string")
elif name == "STATUSTEXT":
self.config.STATUSTEXT = getTypedValue(value, "string")
elif name == "NOUNKNOWNOUTPUT":
self.config.NOUNKNOWNOUTPUT = getTypedValue(value, "boolean")
else:
self.logger.error("Unknown option in config file: " + name)
else:
self.logger.info("Config data file %s not found, using defaults and setting up config file for next time" % configfilepath)
userconfigpath = os.path.join(os.path.expanduser('~'), ".config/"+app_name+"/")
configsource = os.path.join(app_path, "config/"+module_name+".config")
if os.path.exists(userconfigpath) == False:
os.makedirs(userconfigpath)
shutil.copy(configsource, configfilepath)
except Exception, e:
self.logger.error(e.__str__()+"\n"+traceback.format_exc())
def getTypedValue(self, value, expectedtype):
try:
if len(value.strip(" ")) == 0:
return None
elif value.lower() == "true":
if expectedtype == "boolean":
return True
else:
self.logger.error("Expected type was '%s', but the value '%s' was given"%(expectedtype, value))
elif value.lower() == "false":
if expectedtype == "boolean":
return False
else:
self.logger.error("Expected type was '%s', but the value '%s' was given"%(expectedtype, value))
elif isNumeric(value) == True:
if expectedtype == "integer":
return int(value)
else:
self.logger.error("Expected type was '%s', but the value '%s' was given"%(expectedtype, value))
else:
return value
except (TypeError, ValueError):
self.logger.error("Cannot convert '%s' to expected type of '%s'"%(value,expectedtype))
return value
def testDBus(self, bus, interface):
obj = bus.get_object('org.freedesktop.DBus', '/org/freedesktop/DBus')
dbus_iface = dbus.Interface(obj, 'org.freedesktop.DBus')
avail = dbus_iface.ListNames()
return interface in avail
def getOutputData(self, datatype, statustext, nounknownoutput):
output = u""
if DBUS_AVAIL == True:
if nounknownoutput == True:
unknown_time = ""
unknown_number = ""
unknown_string = ""
unknown_coverart = "file://"+urllib.quote(os.path.join(app_path,"images/spacer.png"))
unknown_rating = "file://"+urllib.quote(os.path.join(app_path,"images/spacer.png"))
else:
unknown_time = "0:00"
unknown_number = "0"
unknown_string = "Unknown"
unknown_coverart = "file://"+urllib.quote(os.path.join(app_path,"images/"+module_name+".png"))
unknown_rating = "file://"+urllib.quote(os.path.join(app_path,"images/ratingicons/0.png"))
try:
bus = dbus.SessionBus()
if self.musicData == None:
if self.testDBus(bus, 'org.bansheeproject.Banshee'):
self.logger.info("Calling dbus interface for music data")
try:
self.logger.info("Setting up dbus interface")
# setup dbus hooks
remote_player = bus.get_object('org.bansheeproject.Banshee', '/org/bansheeproject/Banshee/PlayerEngine')
iface_player = dbus.Interface(remote_player, 'org.bansheeproject.Banshee.PlayerEngine')
self.logger.info("Calling dbus interface for music data")
# prepare song properties for data retrieval
volume = str(iface_player.GetVolume())
status = self.getStatusText(iface_player.GetCurrentState(), statustext)
# grab the data into variables
location = iface_player.GetCurrentUri()
# handle a file or stream differently for filename
if location.find("file://") != -1:
filename = location[location.rfind("/")+1:]
elif len(location) > 0:
filename = location
else:
filename = ""
# try to get all the normal stuff...the props return an empty string if nothing is available
props = iface_player.GetCurrentTrack()
if "name" in props:
title = props["name"]
else:
title = None
if "album" in props:
album = props["album"]
else:
album = None
if "artist" in props:
artist = props["artist"]
else:
artist = None
if "year" in props:
year = str(props["year"])
else:
year = None
if "track-number" in props:
tracknumber = str(props["track-number"])
else:
tracknumber = None
if year == "0": year = None
if tracknumber == "0": tracknumber = None
# TODO: get album art working for internet based (if feasible)...
# get coverart url or file link
if "artwork-id" in props:
coverart = os.path.join(os.path.expanduser("~/.cache/album-art/"),str(props["artwork-id"]) +".jpg")
if coverart.find("http://") != -1:
coverart = coverart.encode("utf-8")
else:
coverart = "file://"+urllib.quote(coverart.encode("utf-8"))
else:
# default coverart image for this plugin if none found
coverart = unknown_coverart
# common details
if "genre" in props:
genre = props["genre"]
else:
genre = None
length_seconds = int(iface_player.GetLength() / 1000)
current_seconds = int(iface_player.GetPosition() / 1000)
current_position = str(int(current_seconds/60%60)).rjust(1,"0")+":"+str(int(current_seconds%60)).rjust(2,"0")
if length_seconds > 0:
length = getFormattedDuration(length_seconds)
current_position_percent = str(int((float(current_seconds) / float(length_seconds))*100))
else:
length = None
current_position_percent = None
rating = "0" # not supported
volume = str(iface_player.GetVolume())
self.musicData = MusicData(status,coverart,title,album,length,artist,tracknumber,genre,year,filename,current_position_percent,current_position,rating,volume)
except Exception, e:
self.logger.info("Issue calling the dbus service:"+e.__str__()+"\n"+traceback.format_exc())
if self.musicData != None:
self.logger.info("Preparing output for datatype:"+datatype)
if datatype == "ST": #status
if self.musicData.status == None or len(self.musicData.status) == 0:
output = None
else:
output = getHTMLText(self.musicData.status)
elif datatype == "CA": #coverart
if self.musicData.coverart == None or len(self.musicData.coverart) == 0:
output = None
else:
output = self.musicData.coverart
elif datatype == "TI": #title
if self.musicData.title == None or len(self.musicData.title) == 0:
output = None
else:
output = getHTMLText(self.musicData.title)
elif datatype == "AL": #album
if self.musicData.album == None or len(self.musicData.album) == 0:
output = None
else:
output = getHTMLText(self.musicData.album)
elif datatype == "AR": #artist
if self.musicData.artist == None or len(self.musicData.artist) == 0:
output = None
else:
output = getHTMLText(self.musicData.artist)
elif datatype == "TN": #tracknumber
if self.musicData.tracknumber == None or len(self.musicData.tracknumber) == 0:
output = None
else:
output = self.musicData.tracknumber
elif datatype == "GE": #genre
if self.musicData.title == genre or len(self.musicData.genre) == 0:
output = None
else:
output = getHTMLText(self.musicData.genre)
elif datatype == "YR": #year
if self.musicData.year == None or len(self.musicData.year) == 0:
output = None
else:
output = self.musicData.year
elif datatype == "FN": #filename
if self.musicData.filename == None or len(self.musicData.filename) == 0:
output = None
else:
output = getHTMLText(self.musicData.filename)
elif datatype == "LE": # length
if self.musicData.length == None or len(self.musicData.length) == 0:
output = None
else:
output = self.musicData.length
elif datatype == "PP": #current position in percent
if self.musicData.current_position_percent == None or len(self.musicData.current_position_percent) == 0:
output = None
else:
output = self.musicData.current_position_percent
elif datatype == "PT": #current position in time
if self.musicData.current_position == None or len(self.musicData.current_position) == 0:
output = None
else:
output = self.musicData.current_position
elif datatype == "VO": #volume
if self.musicData.volume == None or len(self.musicData.volume) == 0:
output = None
else:
output = self.musicData.volume
elif datatype == "RT": #rating
if self.musicData.rating == None or isNumeric(self.musicData.rating) == False:
output = None
else:
rating = int(self.musicData.rating)
if rating >= 0:
output = "file://"+urllib.quote(os.path.join(app_path,"images/ratingicons/"+str(rating)+".png"))
else:
output = None
elif datatype == "TL": #track lyrics
output = getLyrics(self.musicData.artist, self.musicData.title)
else:
self.logger.error("Unknown datatype provided: " + datatype)
return u""
except Exception, e:
self.logger.error(e.__str__()+"\n"+traceback.format_exc())
if output == None or self.musicData == None:
if datatype in ["LE","PT"]:
output = unknown_time
elif datatype in ["PP","VO","YR","TN"]:
output = unknown_number
elif datatype == "CA":
output = unknown_coverart
elif datatype == "RT":
output = unknown_rating
else:
output = unknown_string
return output
def getStatusText(self, status, statustext):
if status != None:
statustextparts = statustext.split(",")
if status == "playing":
return statustextparts[0]
elif status == "paused":
return statustextparts[1]
elif status == "stopped":
return statustextparts[2]
else:
return status
def getTemplateItemOutput(self, template_text):
# keys to template data
DATATYPE_KEY = "datatype"
STATUSTEXT_KEY = "statustext"
NOUNKNOWNOUTPUT_KEY = "nounknownoutput"
datatype = None
statustext = self.config.STATUSTEXT #default to command line option
nounknownoutput = self.config.NOUNKNOWNOUTPUT #default to command line option
for option in template_text.split('--'):
if len(option) == 0 or option.isspace():
continue
# not using split here...it can't assign both key and value in one call, this should be faster
x = option.find('=')
if (x != -1):
key = option[:x].strip()
value = option[x + 1:].strip()
if value == "":
value = None
else:
key = option.strip()
value = None
try:
if key == DATATYPE_KEY:
datatype = getTypedValue(value, "string")
elif key == STATUSTEXT_KEY:
statustext = getTypedValue(value, "string")
elif key == NOUNKNOWNOUTPUT_KEY:
nounknownoutput = True
else:
self.logger.info("Unknown template option: " + option)
except (TypeError, ValueError):
self.logger.info("Cannot convert option argument to number: " + option)
return u""
if datatype != None:
return self.getOutputData(datatype, statustext, nounknownoutput)
else:
self.logger.info("Template item does not have datatype defined")
return u""
def getOutputFromTemplate(self, template):
output = u""
end = False
a = 0
# a and b are indexes in the template string
# moving from left to right the string is processed
# b is index of the opening bracket and a of the closing bracket
# everything between b and a is a template that needs to be parsed
while not end:
b = template.find('[', a)
if b == -1:
b = len(template)
end = True
# if there is something between a and b, append it straight to output
if b > a:
output += template[a : b]
# check for the escape char (if we are not at the end)
if template[b - 1] == '\\' and not end:
# if its there, replace it by the bracket
output = output[:-1] + '['
# skip the bracket in the input string and continue from the beginning
a = b + 1
continue
if end:
break
a = template.find(']', b)
if a == -1:
self.logger.info("Missing terminal bracket (]) for a template item")
return u""
# if there is some template text...
if a > b + 1:
output += self.getTemplateItemOutput(template[b + 1 : a])
a = a + 1
return output
def getOutput(self):
if self.options.noheader == True:
headertemplatefilepath = app_path+"/templates/nullheader.template"
self.logger.info("Using custom header template file '%s'"%headertemplatefilepath)
elif self.options.headertemplate != None and os.path.exists(os.path.expanduser(self.options.headertemplate)) == True:
headertemplatefilepath = self.options.headertemplate
self.logger.info("Using custom header template file '%s'"%headertemplatefilepath)
elif self.config.HEADERTEMPLATE != None and os.path.exists(os.path.expanduser(self.config.HEADERTEMPLATE)) == True:
headertemplatefilepath = self.config.HEADERTEMPLATE
self.logger.info("Using custom header template file '%s'"%headertemplatefilepath)
else:
headertemplatefilepath = app_path+"/templates/bansheeheader.template"
self.logger.info("Using default header template")
# load the file
try:
inputfile = codecs.open(os.path.expanduser(headertemplatefilepath), encoding='utf-8')
except Exception, e:
self.logger.error("Error loading header template file: " + e.__str__()+"\n"+traceback.format_exc())
else:
headertemplate = inputfile.read()
finally:
inputfile.close()
if self.options.template != None:
templatefilepath = self.options.template
self.logger.info("Using custom template file '%s'"%templatefilepath)
elif self.config.TEMPLATE != None and os.path.exists(os.path.expanduser(self.config.TEMPLATE)) == True:
templatefilepath = self.config.TEMPLATE
self.logger.info("Using custom template file '%s'"%templatefilepath)
else:
templatefilepath = app_path+"/templates/banshee.template"
self.logger.info("Using default template")
#load the file
try:
inputfile = codecs.open(os.path.expanduser(templatefilepath), encoding='utf-8')
except Exception, e:
self.logger.error("Error loading template file: " + e.__str__()+"\n"+traceback.format_exc())
else:
template = inputfile.read()
finally:
inputfile.close()
output = headertemplate
output = output + self.getOutputFromTemplate(template)
return output.encode("utf-8")
def getHTML(options):
output = Output(options)
html = output.getOutput()
del output
return html
# to enable testing in isolation
if __name__ == "__main__":
parser = OptionParser()
parser.add_option("--noheader", dest="noheader", default=False, action="store_true", help=u"Turn off header output. This will override any header template setting to be nothing")
parser.add_option("--headertemplate", dest="headertemplate", type="string", metavar="FILE", help=u"Override the header template for the plugin, default or config based template ignored.")
parser.add_option("--template", dest="template", type="string", metavar="FILE", help=u"Override the template for the plugin, default or config based template ignored.")
parser.add_option("--verbose", dest="verbose", default=False, action="store_true", help=u"Outputs verbose info to the terminal")
parser.add_option("--version", dest="version", default=False, action="store_true", help=u"Displays the version of the script.")
parser.add_option("--logfile", dest="logfile", type="string", metavar="FILE", help=u"If a filepath is set, the script logs to the filepath.")
(options, args) = parser.parse_args()
output = Output(options)
html = output.getOutput()
del output
print html
|