« back to all changes in this revision
Viewing changes to plugin_deluge.py
- browse files at revision 20
- compare with another revision
- download diff
- download tarball
- view history from revision 20
- Committer: Mark Buck (Kaivalagi)
- Date: 2009-06-19 17:13:00 UTC
- Revision ID: m_buck@hotmail.com-20090619171300-5cbhr90xwg62z27y
Added --backgroundblend and --backgroundcolour options for visual seperation of output from wallpaper if required, Fixed song length output in the rhythmbox plugin when songs are an hour long or more, Added copy option to right click, enabling the copying of html content to the clipboard for testing, Moved common functions into a plugin_common module
- files added:
- plugin_common.py
- files modified:
- CHANGELOG
added
removed
plugin_deluge.py
6
6
#
7
7
# Author: Kaivalagi
8
8
# Created: 23/11/2008
9
from htmlentitydefs import name2codepoint, codepoint2name
10
9
from optparse import OptionParser
11
import sys
10
from plugin_common import getHTMLText, getTypedValue
12
11
import codecs
12
import fileinput
13
import logging
13
14
import os
14
15
import shutil
15
import re
16
import sys
16
17
import traceback
17
import logging
18
import fileinput
19
18
20
19
try:
21
20
from deluge.log import LOG as delugelog
22
delugelog.setLevel(logging.FATAL) #disable logging within Deluge functions, only output info from this script
21
delugelog.setLevel(logging.FATAL) #disable logging within Deluge functions, only output info from this script
23
22
from deluge.ui.client import sclient
24
23
from deluge.common import ftime, fsize, fspeed
25
24
26
25
DELUGE_AVAIL = True
27
26
except ImportError:
28
27
DELUGE_AVAIL = False
32
31
module_name = __file__.replace(os.path.dirname (__file__) + "/", "").replace(".pyc","").replace(".py", "")
33
32
34
33
class TorrentData:
35
34
36
35
def __init__(self, name, state, statecode, totaldone, totalsize, progress, nofiles, downloadrate, uploadrate, eta, currentpeers, currentseeds, totalpeers, totalseeds, ratio):
37
36
self.name = name
38
37
self.state = state
49
48
self.totalpeers = totalpeers
50
49
self.totalseeds = totalseeds
51
50
self.ratio = ratio
52
51
53
52
def __cmp__(self, other):
54
53
return cmp(self.getOrder(self.statecode,self.progress) , self.getOrder(other.statecode,other.progress))
55
54
56
55
def __str__(self):
57
56
return str(self.name + " - " + self.eta)
58
57
59
58
def getOrder(self,statecode,progress):
60
59
return (statecode*1000.0)+float(progress.rstrip("%"))
61
60
62
61
class DelugeConfig:
63
62
SERVER = "127.0.0.1"
64
63
PORT = 58846
66
65
TORRENTTEMPLATE = None
67
66
SUMMARYTEMPLATE = None
68
67
SHOWSUMMARY = True
69
HIDETORRENTDETAIL = False
68
HIDETORRENTDETAIL = False
70
69
ACTIVEONLY = True
71
70
LIMIT = 0
72
71
73
72
class Output:
74
73
75
74
uri = None
76
75
options = None
77
76
sessionstate = None
78
77
sessionstatefound = False
79
78
logger = None
80
79
81
80
STATE_DOWNLOADING = 4
82
81
STATE_SEEDING = 3
83
82
STATE_QUEUED = 2
84
STATE_PAUSED = 1
83
STATE_PAUSED = 1
85
84
STATE_UNKNOWN = 0
86
85
87
86
def __init__(self, options):
88
87
89
88
try:
90
89
91
90
self.options = options
92
91
self.logger = logging.getLogger(app_name+"."+module_name)
93
92
self.loadConfigData()
94
93
95
94
if DELUGE_AVAIL == True:
96
95
97
96
# sort out the server option
98
97
self.config.SERVER = self.config.SERVER.replace("localhost", "127.0.0.1")
99
98
100
99
# create the uri for the rpc connection
101
100
self.uri = "http://"+self.config.SERVER+":"+str(self.config.PORT)
102
101
103
102
# create the rpc and client objects
104
103
sclient.set_core_uri(self.uri)
105
104
106
105
try:
107
106
# attempt to get the required data
108
107
self.sessionstate = sclient.get_session_state()
109
108
self.sessionstatefound = True
110
109
except:
111
110
self.sessionstatefound = False
112
111
113
112
else:
114
113
self.sessionstatefound = False
115
116
114
115
117
116
except Exception,e:
118
117
self.logger.error(e.__str__()+"\n"+traceback.format_exc())
119
118
120
119
def loadConfigData(self):
121
120
try:
122
121
123
122
self.config = DelugeConfig()
124
123
125
124
if self.options.config != None:
126
125
# load the config based on options passed in from the main app
127
126
configfilepath = self.options.config
128
127
else:
129
128
# load plugin config from home directory of the user
130
129
configfilepath = os.path.join(os.path.expanduser('~'), ".config/"+app_name+"/"+module_name+".config")
131
130
132
131
if os.path.exists(configfilepath):
133
132
134
133
self.logger.info("Loading config settings from \"%s\""%configfilepath)
135
134
136
135
for line in fileinput.input(os.path.expanduser(configfilepath)):
137
136
line = line.strip()
138
137
if len(line) > 0 and line[0:1] != "#": # ignore commented lines or empty ones
139
138
140
139
name = line.split("=")[0].strip().upper() # config setting name on the left of =
141
140
value = line.split("=")[1].split("#")[0].strip() # config value on the right of = (minus any trailing comments)
142
141
143
142
if len(value) > 0:
144
143
if name == "SERVER":
145
self.config.SERVER = self.getTypedValue(value, "string")
144
self.config.SERVER = getTypedValue(value, "string")
146
145
elif name == "PORT":
147
self.config.PORT = self.getTypedValue(value, "integer")
146
self.config.PORT = getTypedValue(value, "integer")
148
147
elif name == "HEADERTEMPLATE":
149
self.config.HEADERTEMPLATE = self.getTypedValue(value, "string")
148
self.config.HEADERTEMPLATE = getTypedValue(value, "string")
150
149
elif name == "TORRENTTEMPLATE":
151
self.config.TORRENTTEMPLATE = self.getTypedValue(value, "string")
150
self.config.TORRENTTEMPLATE = getTypedValue(value, "string")
152
151
elif name == "SUMMARYTEMPLATE":
153
self.config.SUMMARYTEMPLATE = self.getTypedValue(value, "string")
152
self.config.SUMMARYTEMPLATE = getTypedValue(value, "string")
154
153
elif name == "SHOWSUMMARY":
155
self.config.SHOWSUMMARY = self.getTypedValue(value, "boolean")
154
self.config.SHOWSUMMARY = getTypedValue(value, "boolean")
156
155
elif name == "HIDETORRENTDETAIL":
157
self.config.HIDETORRENTDETAIL = self.getTypedValue(value, "boolean")
156
self.config.HIDETORRENTDETAIL = getTypedValue(value, "boolean")
158
157
elif name == "ACTIVEONLY":
159
self.config.ACTIVEONLY = self.getTypedValue(value, "boolean")
158
self.config.ACTIVEONLY = getTypedValue(value, "boolean")
160
159
elif name == "LIMIT":
161
self.config.LIMIT = self.getTypedValue(value, "integer")
160
self.config.LIMIT = getTypedValue(value, "integer")
162
161
else:
163
162
self.logger.error("Unknown option in config file: " + name)
164
163
else:
165
164
self.logger.info("Config data file %s not found, using defaults and setting up config file for next time" % configfilepath)
166
165
167
166
userconfigpath = os.path.join(os.path.expanduser('~'), ".config/"+app_name+"/")
168
167
configsource = os.path.join(app_path, "config/"+module_name+".config")
169
168
170
169
if os.path.exists(userconfigpath) == False:
171
170
os.makedirs(userconfigpath)
172
171
175
174
except Exception, e:
176
175
self.logger.error(e.__str__()+"\n"+traceback.format_exc())
177
176
178
def getTypedValue(self, value, expectedtype):
179
180
try:
181
if len(value.strip(" ")) == 0:
182
return None
183
184
elif value.lower() == "true":
185
if expectedtype == "boolean":
186
return True
187
else:
188
self.logger.error("Expected type was '%s', but the value '%s' was given"%(expectedtype, value))
189
190
elif value.lower() == "false":
191
if expectedtype == "boolean":
192
return False
193
else:
194
self.logger.error("Expected type was '%s', but the value '%s' was given"%(expectedtype, value))
195
196
elif self.isNumeric(value) == True:
197
if expectedtype == "integer":
198
return int(value)
199
else:
200
self.logger.error("Expected type was '%s', but the value '%s' was given"%(expectedtype, value))
201
202
else:
203
return value
204
205
except (TypeError, ValueError):
206
self.logger.error("Cannot convert '%s' to expected type of '%s'"%(value,expectedtype))
207
return value
208
209
177
def getTorrentTemplateOutput(self, template, name, state, stateicon, totaldone, totalsize, progress, nofiles, downloadrate, uploadrate, eta, currentpeers, currentseeds, totalpeers, totalseeds, ratio):
210
178
211
179
try:
212
180
213
181
output = template
214
182
215
183
output = output.replace("[name]",name)
216
184
output = output.replace("[state]",state)
217
185
output = output.replace("[stateicon]",stateicon)
225
193
output = output.replace("[currentpeers]",currentpeers)
226
194
output = output.replace("[currentseeds]",currentseeds)
227
195
output = output.replace("[totalpeers]",totalpeers)
228
output = output.replace("[totalseeds]",totalseeds)
196
output = output.replace("[totalseeds]",totalseeds)
229
197
output = output.replace("[ratio]",ratio)
230
198
231
199
# get rid of any excess crlf's and add just one
232
200
output = output.rstrip(" \n")
233
201
output = output + "\n"
234
202
235
203
return output
236
204
237
205
except Exception,e:
238
206
self.logger.error(e.__str__()+"\n"+traceback.format_exc())
239
207
return ""
240
208
241
209
def getSummaryTemplateOutput(self, template, notorrents, totalprogress, totaldone, totalsize, totaldownloadrate, totaluploadrate, totaleta, currentpeers, currentseeds, totalpeers, totalseeds, totalratio):
242
210
243
211
try:
244
212
245
213
output = template
246
214
247
215
output = output.replace("[notorrents]",notorrents)
260
228
# get rid of any excess crlf's and add just one
261
229
output = output.rstrip(" \n")
262
230
output = output + "\n"
263
231
264
232
return output
265
233
266
234
except Exception,e:
267
235
self.logger.error(e.__str__()+"\n"+traceback.format_exc())
268
236
return ""
269
237
270
238
def getOutput(self):
271
239
272
240
try:
273
241
274
242
self.logger.info("Preparing header template...")
275
243
276
244
if self.options.noheader == True:
277
245
headertemplatefilepath = app_path+"/templates/nullheader.template"
278
246
self.logger.info("Using custom header template file '%s'"%headertemplatefilepath)
295
263
headertemplate = inputfile.read()
296
264
finally:
297
265
inputfile.close()
298
266
299
267
# define header in output
300
268
output = headertemplate
301
269
302
270
if self.sessionstatefound == True:
303
271
304
272
self.logger.info("Session state data is available, proceeding...")
305
273
306
274
torrentDataList = []
307
275
torrentItemList = ["num_peers","num_seeds","name","state","total_done","total_size","total_wanted","progress","files","eta","download_payload_rate","upload_payload_rate","total_peers","total_seeds","ratio"]
308
276
highesteta = 0
309
277
310
278
# summary variables
311
279
summary_notorrent = 0
312
280
summary_totaldone = 0
319
287
summary_totalpeers = 0
320
288
summary_totalseeds = 0
321
289
summary_totalratio = 0.0
322
290
323
291
self.logger.info("Preparing info templates...")
324
292
325
293
if self.config.SUMMARYTEMPLATE != None and os.path.exists(os.path.expanduser(self.config.SUMMARYTEMPLATE)) == True:
326
294
summarytemplatefilepath = self.config.SUMMARYTEMPLATE
327
295
self.logger.info("Using custom summary template file '%s'"%summarytemplatefilepath)
338
306
summarytemplate = inputfile.read()
339
307
finally:
340
308
inputfile.close()
341
309
342
310
if self.options.template != None:
343
311
torrenttemplatefilepath = self.options.template
344
312
self.logger.info("Using custom torrent template file '%s'"%torrenttemplatefilepath)
358
326
torrenttemplate = inputfile.read()
359
327
finally:
360
328
inputfile.close()
361
329
362
330
self.logger.info("Retrieving torrent session state data...")
363
331
364
332
#get list of torrents and display the 1ist.
365
333
#sessionstate = sclient.get_session_state()
366
334
if len(self.sessionstate) > 0:
367
335
368
336
self.logger.info("Processing %s torrent(s)..."%str(len(self.sessionstate)))
369
337
370
338
for torrent in self.sessionstate:
371
339
372
340
torrent_status = sclient.get_torrent_status(torrent, torrentItemList)
373
341
374
342
if torrent_status != None:
375
343
376
344
if self.config.ACTIVEONLY == True:
377
345
378
346
active = False
379
347
380
348
# check for activity
381
349
if "num_peers" in torrent_status:
382
350
if torrent_status["num_peers"] > 0:
383
351
active = True
384
352
385
353
if "num_seeds" in torrent_status:
386
354
if torrent_status["num_seeds"] > 0:
387
active = True
388
355
active = True
356
389
357
# output details if all required or if active
390
358
if self.config.ACTIVEONLY == False or active == True:
391
359
392
360
if "name" in torrent_status:
393
name = self.getHTMLText(torrent_status["name"])
361
name = getHTMLText(torrent_status["name"])
394
362
else:
395
363
name = "Unknown"
396
364
397
365
if "state" in torrent_status:
398
366
state = torrent_status["state"]
399
367
400
368
if state == "Downloading":
401
369
statecode = self.STATE_DOWNLOADING
402
370
elif state == "Seeding":
407
375
statecode = self.STATE_PAUSED
408
376
else:
409
377
statecode = self.STATE_UNKNOWN
410
378
411
379
else:
412
380
state = "Unknown"
413
381
statecode = self.STATE_UNKNOWN
414
382
415
383
if "total_done" in torrent_status:
416
384
totaldone = fsize(torrent_status["total_done"])
417
385
summary_totaldone = summary_totaldone + int(torrent_status["total_done"])
418
386
else:
419
totaldone = "??.? KiB"
420
387
totaldone = "??.? KiB"
388
421
389
if "total_size" in torrent_status:
422
390
totalsize = fsize(torrent_status["total_wanted"])
423
391
summary_totalsize = summary_totalsize + int(torrent_status["total_wanted"])
424
392
else:
425
totalsize = "??.? KiB"
426
393
totalsize = "??.? KiB"
394
427
395
if "progress" in torrent_status:
428
396
progress = str(round(torrent_status["progress"],2))+"%"
429
397
else:
430
progress = "?.?%"
431
398
progress = "?.?%"
399
432
400
if "files" in torrent_status:
433
401
nofiles = str(len(torrent_status["files"]))
434
402
else:
435
nofiles = "?"
436
403
nofiles = "?"
404
437
405
if "eta" in torrent_status:
438
406
eta = torrent_status["eta"]
439
407
440
408
if eta > highesteta:
441
409
highesteta = eta
442
410
443
411
eta = ftime(torrent_status["eta"])
444
412
else:
445
413
eta = "Unknown"
446
414
447
415
if "download_payload_rate" in torrent_status:
448
416
downloadrate = fspeed(torrent_status["download_payload_rate"])
449
417
summary_totaldownloadrate = summary_totaldownloadrate + float(torrent_status["download_payload_rate"])
450
418
else:
451
downloadrate = "?.? KiB/s"
452
419
downloadrate = "?.? KiB/s"
420
453
421
if "upload_payload_rate" in torrent_status:
454
422
uploadrate = fspeed(torrent_status["upload_payload_rate"])
455
423
summary_totaluploadrate = summary_totaluploadrate + float(torrent_status["upload_payload_rate"])
456
424
else:
457
uploadrate = "?.? KiB/s"
458
425
uploadrate = "?.? KiB/s"
426
459
427
if "num_peers" in torrent_status:
460
428
currentpeers = str(torrent_status["num_peers"])
461
429
summary_currentpeers = summary_currentpeers + int(torrent_status["num_peers"])
462
430
else:
463
431
currentpeers = "?"
464
432
465
433
if "num_seeds" in torrent_status:
466
434
currentseeds = str(torrent_status["num_seeds"])
467
435
summary_currentseeds = summary_currentseeds + int(torrent_status["num_seeds"])
468
436
else:
469
437
currentseeds = "?"
470
438
471
439
if "total_peers" in torrent_status:
472
440
totalpeers = str(torrent_status["total_peers"])
473
441
summary_totalpeers = summary_totalpeers + int(torrent_status["total_peers"])
474
442
else:
475
443
totalpeers = "?"
476
444
477
445
if "total_seeds" in torrent_status:
478
446
totalseeds = str(torrent_status["total_seeds"])
479
447
summary_totalseeds = summary_totalseeds + int(torrent_status["total_seeds"])
480
448
else:
481
449
totalseeds = "?"
482
450
483
451
if "ratio" in torrent_status:
484
452
ratio = str(round(torrent_status["ratio"],3)).ljust(5,"0")
485
453
else:
486
454
ratio = "?.???"
487
455
488
456
summary_notorrent = summary_notorrent + 1
489
457
490
458
# add torrent data to list
491
459
torrentData = TorrentData(name, state, statecode, totaldone, totalsize, progress, nofiles, downloadrate, uploadrate, eta, currentpeers, currentseeds, totalpeers, totalseeds, ratio)
492
460
torrentDataList.append(torrentData)
493
461
494
462
else:
495
463
self.logger.info("No torrent status data available")
496
464
497
465
if summary_notorrent > 0:
498
466
499
467
if self.config.SHOWSUMMARY == True:
500
468
501
469
# sort out summary data for output
502
470
summary_notorrent = str(summary_notorrent)
503
471
summary_totalprogress = str(round((float(summary_totaldone) / float(summary_totalsize)) *100,2))+"%"
504
472
summary_totaldone = fsize(summary_totaldone)
505
summary_totalsize = fsize(summary_totalsize)
473
summary_totalsize = fsize(summary_totalsize)
506
474
summary_totaldownloadrate = fspeed(summary_totaldownloadrate)
507
475
summary_totaluploadrate = fspeed(summary_totaluploadrate)
508
476
summary_totaleta = ftime(highesteta)
511
479
summary_totalpeers = str(summary_totalpeers)
512
480
summary_totalseeds = str(summary_totalseeds)
513
481
summary_totalratio = "?.???"
514
482
515
483
output = output + self.getSummaryTemplateOutput(summarytemplate, summary_notorrent, summary_totalprogress, summary_totaldone, summary_totalsize, summary_totaldownloadrate, summary_totaluploadrate, summary_totaleta, summary_currentpeers, summary_currentseeds, summary_totalpeers, summary_totalseeds, summary_totalratio)
516
484
#return output.encode("utf-8")
517
485
#else:
518
486
519
487
if self.config.HIDETORRENTDETAIL == False:
520
488
521
489
# torrent details
522
490
outputCount = 0
523
491
524
492
# sort list, eta based
525
493
torrentDataList.sort(reverse = True)
526
494
527
495
# output torrent data using the template
528
for torrentData in torrentDataList:
529
496
for torrentData in torrentDataList:
497
530
498
# keep a tally of torrent output, if past the limit then exit
531
499
if self.config.LIMIT <> 0:
532
500
outputCount = outputCount + 1
533
501
if outputCount > self.config.LIMIT:
534
502
sys.exit()
535
503
536
504
stateicon = self.getImageSrcForStateCode(torrentData.statecode)
537
505
538
506
#output = output + self.getTorrentTemplateOutput(torrenttemplate, torrentData.name, torrentData.state, torrentData.totaldone, torrentData.totalsize, torrentData.progress, torrentData.nofiles, torrentData.downloadrate, torrentData.uploadrate, torrentData.eta, torrentData.currentpeers, torrentData.currentseeds, torrentData.totalpeers, torrentData.totalseeds, torrentData.ratio)+"\n"
539
507
output = output + self.getTorrentTemplateOutput(torrenttemplate, torrentData.name, torrentData.state, stateicon, torrentData.totaldone, torrentData.totalsize, torrentData.progress, torrentData.nofiles, torrentData.downloadrate, torrentData.uploadrate, torrentData.eta, torrentData.currentpeers, torrentData.currentseeds, torrentData.totalpeers, torrentData.totalseeds, torrentData.ratio)+"\n"
540
508
541
509
return output.encode("utf-8")
542
510
543
511
else:
544
512
output = output + "<p>No torrent info to display</p>"
545
513
return output.encode("utf-8")
546
514
547
515
else:
548
516
self.logger.info("No torrents found")
549
517
output = output + "<p>No torrents found</p>"
553
521
self.logger.info("No session state data is available, nothing to output...")
554
522
output = output + "<p>No session state data is available, nothing to output...</p>"
555
523
return output.encode("utf-8")
556
524
557
525
except Exception,e:
558
526
self.logger.error(e.__str__()+"\n"+traceback.format_exc())
559
527
560
def getHTMLText(self,text):
561
try:
562
htmlentities = []
563
for char in text: #html:
564
if ord(char) < 128:
565
htmlentities.append(char)
566
else:
567
htmlentities.append('&%s;' % codepoint2name[ord(char)])
568
html = "".join(htmlentities)
569
570
html = html.replace("\n","<br>\n") # switch out new line for html breaks
571
return html
572
except:
573
return text
574
575
528
def getImageSrcForStateCode(self, statecode):
576
529
imagesrc = "file://%s/images/delugeicons/%s.png"%(app_path, str(statecode))
577
530
return imagesrc
578
579
def getCleanText(self,html):
580
try:
581
text = str(html)
582
text = text.replace("\n","") # remove new lines from html
583
text = text.replace("'","'") # workaround for shitty xml codes not compliant with html
584
text = text.replace("<br>","\n") # switch out html breaks for new line
585
text = re.sub('<(.|\n)+?>','',text) # remove any html tags
586
text = re.sub('&(%s);' % '|'.join(name2codepoint), lambda m: chr(name2codepoint[m.group(1)]), text)
587
return text
588
except:
589
return html
590
591
def isNumeric(self, string):
592
try:
593
dummy = float(string)
594
return True
595
except:
596
return False
597
531
598
532
def getHTML(options):
599
533
output = Output(options)
600
534
html = output.getOutput()
605
539
if __name__ == "__main__":
606
540
607
541
parser = OptionParser()
608
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")
542
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")
609
543
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.")
610
544
parser.add_option("--template", dest="template", type="string", metavar="FILE", help=u"Override the template for the plugin, default or config based template ignored.")
611
545
parser.add_option("--verbose", dest="verbose", default=False, action="store_true", help=u"Outputs verbose info to the terminal")
612
546
parser.add_option("--version", dest="version", default=False, action="store_true", help=u"Displays the version of the script.")
613
parser.add_option("--logfile", dest="logfile", type="string", metavar="FILE", help=u"If a filepath is set, the script logs to the filepath.")
614
547
parser.add_option("--logfile", dest="logfile", type="string", metavar="FILE", help=u"If a filepath is set, the script logs to the filepath.")
548
615
549
(options, args) = parser.parse_args()
616
550
617
551
output = Output(options)
618
552
html = output.getOutput()
619
553
del output
Loggerhead is a web-based interface for Breezy
Version: 2.0.1