~m-buck/+junk/gtk-desktop-info

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

Show diffs side-by-side

added added

removed removed

plugin_rhythmbox.py

# Author: Kaivalagi

# Created: 23/11/2008

from htmlentitydefs import name2codepoint, codepoint2name

from optparse import OptionParser

import traceback

from plugin_common import getHTMLText, getTypedValue, getFormattedDuration

import codecs

import fileinput

import logging

import os

import re

import shutil

import os

import traceback

import urllib

import re

import fileinput

import logging

try:

import dbus

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

class RhythmboxConfig:

HEADERTEMPLATE = None

TEMPLATE = None

STATUSTEXT = "Playing,Paused,Stopped"

NOUNKNOWNOUTPUT = False

class Output:

options = None

output = u""

error = u""

self.loadConfigData()

def loadConfigData(self):

try:

self.config = RhythmboxConfig()

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

name = line.split("=")[0].strip().upper() # config setting name on the left of =

value = line.split("=")[1].split("#")[0].strip() # config value on the right of = (minus any trailing comments)

100

101

if len(value) > 0:

102

if name == "HEADERTEMPLATE":

103

self.config.HEADERTEMPLATE = self.getTypedValue(value, "string")

103

self.config.HEADERTEMPLATE = getTypedValue(value, "string")

104

elif name == "TEMPLATE":

105

self.config.TEMPLATE = self.getTypedValue(value, "string")

105

self.config.TEMPLATE = getTypedValue(value, "string")

106

elif name == "STATUSTEXT":

107

self.config.STATUSTEXT = self.getTypedValue(value, "string")

107

self.config.STATUSTEXT = getTypedValue(value, "string")

108

elif name == "NOUNKNOWNOUTPUT":

109

self.config.NOUNKNOWNOUTPUT = self.getTypedValue(value, "boolean")

109

self.config.NOUNKNOWNOUTPUT = getTypedValue(value, "boolean")

110

else:

111

self.logger.error("Unknown option in config file: " + name)

111

self.logger.error("Unknown option in config file: " + name)

112

else:

113

self.logger.info("Config data file %s not found, using defaults and setting up config file for next time" % configfilepath)

114

115

userconfigpath = os.path.join(os.path.expanduser('~'), ".config/"+app_name+"/")

116

configsource = os.path.join(app_path, "config/"+module_name+".config")

117

118

if os.path.exists(userconfigpath) == False:

119

os.makedirs(userconfigpath)

120

124

self.logger.error(e.__str__()+"\n"+traceback.format_exc())

125

126

def getTypedValue(self, value, expectedtype):

127

128

try:

129

if len(value.strip(" ")) == 0:

130

return None

131

132

elif value.lower() == "true":

133

if expectedtype == "boolean":

134

return True

135

else:

136

self.logger.error("Expected type was '%s', but the value '%s' was given"%(expectedtype, value))

137

138

elif value.lower() == "false":

139

if expectedtype == "boolean":

140

return False

141

else:

142

self.logger.error("Expected type was '%s', but the value '%s' was given"%(expectedtype, value))

143

144

elif self.isNumeric(value) == True:

145

if expectedtype == "integer":

146

return int(value)

147

else:

148

self.logger.error("Expected type was '%s', but the value '%s' was given"%(expectedtype, value))

149

150

else:

151

return value

152

153

except (TypeError, ValueError):

154

self.logger.error("Cannot convert '%s' to expected type of '%s'"%(value,expectedtype))

155

return value

156

157

def testDBus(self, bus, interface):

158

obj = bus.get_object('org.freedesktop.DBus', '/org/freedesktop/DBus')

159

dbus_iface = dbus.Interface(obj, 'org.freedesktop.DBus')

160

avail = dbus_iface.ListNames()

161

return interface in avail

162

163

def getOutputData(self, datatype, statustext, nounknownoutput):

164

output = u""

165

166

if DBUS_AVAIL == True:

167

168

if nounknownoutput == True:

169

unknown_time = ""

170

unknown_number = ""

177

unknown_string = "Unknown"

178

unknown_coverart = "file://"+urllib.quote(os.path.join(app_path,"images/"+module_name+".png"))

179

unknown_rating = "file://"+urllib.quote(os.path.join(app_path,"images/ratingicons/0.png"))

180

181

try:

182

183

bus = dbus.SessionBus()

184

if self.musicData == None:

185

186

if self.testDBus(bus, 'org.gnome.Rhythmbox'):

187

188

self.logger.info("Calling dbus interface for music data")

189

190

try:

191

self.logger.info("Setting up dbus interface")

192

193

# setup dbus hooks

194

remote_object_shell = bus.get_object('org.gnome.Rhythmbox', '/org/gnome/Rhythmbox/Shell')

195

iface_shell = dbus.Interface(remote_object_shell, 'org.gnome.Rhythmbox.Shell')

196

remote_object_player = bus.get_object('org.gnome.Rhythmbox', '/org/gnome/Rhythmbox/Player')

197

iface_player = dbus.Interface(remote_object_player, 'org.gnome.Rhythmbox.Player')

198

199

self.logger.info("Calling dbus interface for music data")

200

201

# prepare song properties for data retrieval

202

203

volume = str(int(100*iface_player.getVolume()))

204

205

uri = iface_player.getPlayingUri()

206

if len(uri) == 0:

207

status = self.getStatusText("stopped", statustext)

208

self.musicData = MusicData(status,None,None,None,None,None,None,None,None,None,None,None,None,volume)

209

else:

210

status = self.getStatusText("playing", statustext)

211

212

props = iface_shell.getSongProperties(uri)

213

214

# grab the data into variables

215

location = props["location"]

216

217

# handle a file or stream differently for filename

218

if location.find("file://") != -1:

219

filename = location[location.rfind("/")+1:]

219

filename = location[location.rfind("/")+1:]

220

elif len(location) > 0:

221

filename = location

222

else:

223

filename = ""

224

225

# try to get all the normal stuff...the props return an empty string if nothing is available

226

title = props["title"]

227

album = props["album"]

228

artist = props["artist"]

229

year = str(props["year"])

230

tracknumber = str(props["track-number"])

231

232

if year == "0": year = "?"

233

if tracknumber == "0": tracknumber = "?"

234

235

# if no title and a stream song title then use that instead (internet radio)

236

if len(title) == 0 and "rb:stream-song-title" in props:

237

title = props["rb:stream-song-title"]

238

239

# get coverart url or file link

240

if "rb:coverArt-uri" in props:

241

coverart = props["rb:coverArt-uri"]

245

coverart = "file://"+urllib.quote(coverart.encode("utf-8"))

246

else:

247

# default coverart image for this plugin if none found

248

coverart = unknown_coverart

249

250

# common details

251

genre = props["genre"]

248

coverart = unknown_coverart

249

250

# common details

251

genre = props["genre"]

252

length_seconds = int(props["duration"])

253

current_seconds = int(iface_player.getElapsed())

254

current_position = str(int(current_seconds/60%60)).rjust(1,"0")+":"+str(int(current_seconds%60)).rjust(2,"0")

255

256

if length_seconds > 0:

257

length = str(length_seconds/60%60).rjust(1,"0")+":"+str(length_seconds%60).rjust(2,"0")

258

current_position_percent = str(int((float(current_seconds) / float(props["duration"]))*100))

257

length = getFormattedDuration(length_seconds)

258

current_position_percent = str(int((float(current_seconds) / float(props["duration"]))*100))

259

else:

260

length = "?:??"

261

current_position_percent = "?"

262

263

rating = str(int(props["rating"]))

264

265

volume = str(int(100*iface_player.getVolume()))

266

267

self.musicData = MusicData(status,coverart,title,album,length,artist,tracknumber,genre,year,filename,current_position_percent,current_position,rating,volume)

268

269

except Exception, e:

270

self.logger.info("Issue calling the dbus service:"+e.__str__()+"\n"+traceback.format_exc())

271

272

if self.musicData != None:

273

274

self.logger.info("Preparing output for datatype:"+datatype)

275

276

if datatype == "ST": #status

277

if self.musicData.status == None or len(self.musicData.status) == 0:

278

output = None

279

else:

280

output = self.getHTMLText(self.musicData.status)

281

280

output = getHTMLText(self.musicData.status)

281

282

elif datatype == "CA": #coverart

283

if self.musicData.coverart == None or len(self.musicData.coverart) == 0:

284

output = None

285

else:

286

output = self.musicData.coverart

287

288

elif datatype == "TI": #title

289

if self.musicData.title == None or len(self.musicData.title) == 0:

290

output = None

291

else:

292

output = self.getHTMLText(self.musicData.title)

293

292

output = getHTMLText(self.musicData.title)

293

294

elif datatype == "AL": #album

295

if self.musicData.album == None or len(self.musicData.album) == 0:

296

output = None

297

else:

298

output = self.getHTMLText(self.musicData.album)

299

298

output = getHTMLText(self.musicData.album)

299

300

elif datatype == "AR": #artist

301

if self.musicData.artist == None or len(self.musicData.artist) == 0:

302

output = None

303

else:

304

output = self.getHTMLText(self.musicData.artist)

304

output = getHTMLText(self.musicData.artist)

305

306

elif datatype == "TN": #tracknumber

307

if self.musicData.tracknumber == None or len(self.musicData.tracknumber) == 0:

308

output = None

309

else:

310

output = self.musicData.tracknumber

311

312

elif datatype == "GE": #genre

313

if self.musicData.title == genre or len(self.musicData.genre) == 0:

314

output = None

315

else:

316

output = self.getHTMLText(self.musicData.genre)

317

316

output = getHTMLText(self.musicData.genre)

317

318

elif datatype == "YR": #year

319

if self.musicData.year == None or len(self.musicData.year) == 0:

320

output = None

321

else:

322

output = self.musicData.year

323

324

elif datatype == "FN": #filename

325

if self.musicData.filename == None or len(self.musicData.filename) == 0:

326

output = None

327

else:

328

output = self.getHTMLText(self.musicData.filename)

329

328

output = getHTMLText(self.musicData.filename)

329

330

elif datatype == "LE": # length

331

if self.musicData.length == None or len(self.musicData.length) == 0:

332

output = None

333

else:

334

output = self.musicData.length

335

336

elif datatype == "PP": #current position in percent

337

if self.musicData.current_position_percent == None or len(self.musicData.current_position_percent) == 0:

338

output = None

339

else:

340

output = self.musicData.current_position_percent

341

342

elif datatype == "PT": #current position in time

343

if self.musicData.current_position == None or len(self.musicData.current_position) == 0:

344

output = None

345

else:

346

output = self.musicData.current_position

347

348

elif datatype == "VO": #volume

349

if self.musicData.volume == None or len(self.musicData.volume) == 0:

350

output = None

351

else:

352

output = self.musicData.volume

353

354

elif datatype == "RT": #rating

355

if self.musicData.rating == None or self.isNumeric(self.musicData.rating) == False:

356

output = None

378

output = unknown_rating

379

else:

380

output = unknown_string

381

382

return output

383

384

def getStatusText(self, status, statustext):

385

386

if status != None:

385

386

if status != None:

387

statustextparts = statustext.split(",")

388

389

if status == "playing":

390

return statustextparts[0]

391

elif status == "paused":

392

return statustextparts[1]

393

elif status == "stopped":

394

return statustextparts[2]

395

396

else:

397

return status

398

399

def getTemplateItemOutput(self, template_text):

400

401

# keys to template data

402

DATATYPE_KEY = "datatype"

403

STATUSTEXT_KEY = "statustext"

404

NOUNKNOWNOUTPUT_KEY = "nounknownoutput"

405

406

datatype = None

407

statustext = self.config.STATUSTEXT #default to command line option

408

nounknownoutput = self.config.NOUNKNOWNOUTPUT #default to command line option

409

410

for option in template_text.split('--'):

411

if len(option) == 0 or option.isspace():

412

continue

413

414

# not using split here...it can't assign both key and value in one call, this should be faster

415

x = option.find('=')

416

if (x != -1):

421

else:

422

key = option.strip()

423

value = None

424

425

try:

426

if key == DATATYPE_KEY:

427

datatype = self.getTypedValue(value, "string")

427

datatype = getTypedValue(value, "string")

428

elif key == STATUSTEXT_KEY:

429

statustext = self.getTypedValue(value, "string")

429

statustext = getTypedValue(value, "string")

430

elif key == NOUNKNOWNOUTPUT_KEY:

431

nounknownoutput = True

432

else:

433

self.logger.info("Unknown template option: " + option)

434

435

except (TypeError, ValueError):

436

self.logger.info("Cannot convert option argument to number: " + option)

437

return u""

438

439

if datatype != None:

440

return self.getOutputData(datatype, statustext, nounknownoutput)

441

else:

442

self.logger.info("Template item does not have datatype defined")

443

return u""

444

445

444

445

446

def getOutputFromTemplate(self, template):

447

output = u""

448

end = False

449

a = 0

450

451

# a and b are indexes in the template string

452

# moving from left to right the string is processed

453

# b is index of the opening bracket and a of the closing bracket

454

# everything between b and a is a template that needs to be parsed

455

while not end:

456

b = template.find('[', a)

457

458

if b == -1:

459

b = len(template)

460

end = True

461

462

# if there is something between a and b, append it straight to output

463

if b > a:

464

output += template[a : b]

469

# skip the bracket in the input string and continue from the beginning

470

a = b + 1

471

continue

472

473

if end:

474

break

475

476

a = template.find(']', b)

477

478

if a == -1:

479

self.logger.info("Missing terminal bracket (]) for a template item")

480

return u""

481

482

# if there is some template text...

483

if a > b + 1:

484

output += self.getTemplateItemOutput(template[b + 1 : a])

485

486

a = a + 1

487

488

return output

489

490

def getOutput(self):

491

492

if self.options.noheader == True:

511

headertemplate = inputfile.read()

512

finally:

513

inputfile.close()

514

515

if self.options.template != None:

516

templatefilepath = self.options.template

517

self.logger.info("Using custom template file '%s'"%templatefilepath)

521

else:

522

templatefilepath = app_path+"/templates/rhythmbox.template"

523

self.logger.info("Using default template")

524

525

#load the file

526

try:

527

inputfile = codecs.open(os.path.expanduser(templatefilepath), encoding='utf-8')

536

output = output + self.getOutputFromTemplate(template)

537

538

return output.encode("utf-8")

539

540

def isNumeric(self,value):

541

try:

542

temp = int(value)

543

return True

544

except:

545

return False

546

547

def getHTMLText(self,text):

548

try:

549

htmlentities = []

550

for char in text: #html:

551

if ord(char) < 128:

552

htmlentities.append(char)

553

else:

554

htmlentities.append('&%s;' % codepoint2name[ord(char)])

555

html = "".join(htmlentities)

556

557

html = html.replace("\n","<br>\n") # switch out new line for html breaks

558

return html

559

except:

560

return text

561

562

def getCleanText(self,html):

563

try:

564

text = str(html)

565

text = text.replace("\n","") # remove new lines from html

566

text = text.replace("'","'") # workaround for shitty xml codes not compliant with html

567

text = text.replace("<br>","\n") # switch out html breaks for new line

568

text = re.sub('<(.|\n)+?>','',text) # remove any html tags

569

text = re.sub('&(%s);' % '|'.join(name2codepoint), lambda m: chr(name2codepoint[m.group(1)]), text)

570

return text

571

except:

572

return html

573

539

574

540

def getHTML(options):

575

541

output = Output(options)

576

542

html = output.getOutput()

579

545

580

546

# to enable testing in isolation

581

547

if __name__ == "__main__":

582

548

583

549

parser = OptionParser()

584

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")

550

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")

585

551

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.")

586

552

parser.add_option("--template", dest="template", type="string", metavar="FILE", help=u"Override the template for the plugin, default or config based template ignored.")

587

553

parser.add_option("--verbose", dest="verbose", default=False, action="store_true", help=u"Outputs verbose info to the terminal")

588

554

parser.add_option("--version", dest="version", default=False, action="store_true", help=u"Displays the version of the script.")

589

parser.add_option("--logfile", dest="logfile", type="string", metavar="FILE", help=u"If a filepath is set, the script logs to the filepath.")

590

555

parser.add_option("--logfile", dest="logfile", type="string", metavar="FILE", help=u"If a filepath is set, the script logs to the filepath.")

556

591

557

(options, args) = parser.parse_args()

592

558

593

559

output = Output(options)

594

560

html = output.getOutput()

595

561

del output

Older »