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
|
##########################################################################
# Copyright 2010 Edward G. Bruck <ed.bruck1@gmail.com>
# Copyright 2009 Carlos Ribeiro
#
# This file is part of Radio Tray
#
# Radio Tray is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 1 of the License, or
# (at your option) any later version.
#
# Radio Tray is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Radio Tray. If not, see <http://www.gnu.org/licenses/>.
#
##########################################################################
import os
from lxml import etree
import gtk
import logging
class XmlDataProvider:
def __init__(self, filename):
self.log = logging.getLogger('radiotray')
if os.access(filename, os.R_OK): #if can read, then use.
self.filename = filename
else: # if can't read, give error.
raise Exception('Bookmarks file not found: ' + filename)
def loadFromFile(self):
self.log.info('Loading bookmarks file: %s', self.filename)
self.root = etree.parse(self.filename).getroot()
# this is necessary for the transition from the old xml to the new one
groupRoot = self.root.xpath("//group[@name='root']")
if len(groupRoot) == 0:
new_group = etree.Element('group')
new_group.set("name", "root")
for child in self.root:
child.getparent().remove(child)
new_group.append(child)
self.root.append(new_group)
self.saveToFile()
self.log.debug('Bookmarks file loaded with success')
def saveToFile(self):
self.log.info('Saving bookmarks file: %s', self.filename)
out_file = open(self.filename, "w")
out_file.write(etree.tostring(self.root, method='xml', encoding='UTF-8', pretty_print=True))
out_file.close()
self.log.debug('Bookmarks file save with success')
def listRadioNames(self):
return [a for a in self.root.xpath("//bookmark/@name") if not a.startswith('[separator')]
def listGroupNames(self):
return self.root.xpath("//group/@name")
def listRadiosInGroup(self, group):
return self.root.xpath("//group[@name=$var]/bookmark/@name", var=group)
def getRadioUrl(self, name):
result = self.root.xpath("//bookmark[@name=$var]/@url", var=name)
if(len(result) >= 1):
return result[0]
def addGroup(self, parent_group_name, new_group_name):
# gettting parent group
self.log.debug('Adding group %s to parent group %s ...', new_group_name, parent_group_name)
parent_group = self.root.xpath("//group[@name=$var]", var=parent_group_name)
if parent_group != None:
group = self.root.xpath("//group[@name=$var]", var=new_group_name)
if group == None or len(group) == 0:
self.log.debug('Group is new. Saving with name %s', new_group_name)
new_group = etree.SubElement(parent_group[0], 'group')
new_group.set("name", unicode(new_group_name))
self.saveToFile()
return True
self.log.warn('A group with the name "%s" already exists.', new_group_name)
return False
self.log.error('Error: a parent group with the name "%s" does not exist.', parent_group_name)
return False
def addRadio(self, rawName, url, group_name='root'):
name = unicode(rawName)
self.log.info('Adding radio "%s" to group %s', name, group_name)
self.log.debug('Radio URL: %s', url)
group = self.root.xpath("//group[@name=$var]", var=group_name)
if group != None:
# First, let us check this name hasn't been used yet.
result = self._radioExists(name)
if result is None:
radio = etree.SubElement(group[0], 'bookmark')
radio.set("name", unicode(name))
radio.set("url", unicode(url))
self.log.debug('Radio added with success')
self.saveToFile()
return True
self.log.warn('A radio with the name "%s" already exists.', name)
else:
self.log.error('A group with the name "%s" does not exist.', group_name)
return False
def updateRadio(self, oldName, newName, url):
self.log.info('Updating radio %s', oldName)
self.log.debug('Radio %s changed to radio %s with URL %s', oldName, newName, url)
# Flag used to determine if a radio gets added or not
radioAdded = None
result = self._radioExists(oldName)
if result is None:
self.log.error('Could not find a radio with the name "%s"', oldName)
radioAdded = False
else:
if oldName == newName:
result.set("url", unicode(url))
self.saveToFile()
radioAdded = True
self.log.debug('Radio updated with success')
else:
radioXml = self._radioExists(newName)
if radioXml is not None:
self.log.warn('A radio with the name "%s" already exists.', newName)
radioAdded = False
else:
result.set("name", unicode(newName))
result.set("url", unicode(url))
self.saveToFile()
radioAdded = True
self.log.debug('Radio updated with success')
return radioAdded
def updateGroup(self, oldName, newName):
self.log.info('Updating group %s to %s', oldName, newName)
groupAdded = None
newNameStr = unicode(newName)
result = self._groupExists(oldName)
if result is None:
self.log.error('Could not find a group with the name "%s"', oldName)
groupAdded = False
else:
if oldName != newNameStr:
groupEx = self._groupExists(newNameStr)
if groupEx is not None:
self.log.warn('A group with the name "%s" already exists.', newName)
groupAdded = False
else:
result.set("name", unicode(newNameStr))
self.saveToFile()
groupAdded = True
self.log.debug('Group updated with success')
return groupAdded
def removeRadio(self, name):
self.log.info('Removing "%s" ...', name)
radio = self._radioExists(name)
if radio != None:
self.log.debug('Removing radio with name %s', name)
radio.getparent().remove(radio)
self.log.info('Radio removed with success')
else:
group = self._groupExists(name)
if group != None:
self.log.debug('Removing group with name %s', name)
group.getparent().remove(group)
self.log.info('Group removed with success')
self.saveToFile()
def moveRadio(self, name, old_group_name, new_group_name):
self.log.info('Moving "%s" from %s to %s ...', name, old_group_name, new_group_name)
old_group = self.root.xpath("//group[@name=$var]", var=old_group_name)
new_group = self.root.xpath("//group[@name=$var]", var=new_group_name)
if old_group != None and new_group != None:
radioXml = self._radioExists(name)
if radioXml is None:
self.log.error('Could not find a radio with the name "%s"', name)
else:
old_group[0].remove(radioXml)
radio = etree.SubElement(new_group[0], 'bookmark')
radio.set("name", name)
radio.set("url", radioXml.get('url'))
self.log.debug('%s moved with success', name)
self.saveToFile()
return True
self.log.error('Could not find given groups')
return False
def moveUp(self, name):
self.log.info('Moving "%s" up...', name)
radio = self._radioExists(name)
if radio != None:
group = radio.getparent()
previous = radio.getprevious()
if previous != None:
index=self.root.xpath("count(//bookmark[@name=$var]/preceding-sibling::*)+1", var=name)
group.remove(radio)
group.insert(int(index)-2,radio)
self.log.debug('%s moved with success', name)
self.saveToFile()
return True
else:
# could be a group?
group = self.root.xpath("//group[@name=$var]", var=name)
if group:
parent_group = group[0].getparent()
index=self.root.xpath("count(//group[@name=$var]/preceding-sibling::*)+1", var=name)
parent_group.remove(group[0])
parent_group.insert(int(index)-2,group[0])
self.log.debug('%s moved with success', name)
self.saveToFile()
return True
return False
def moveDown(self, name):
self.log.info('Moving "%s" down...', name)
radio = self._radioExists(name)
if radio != None:
next = radio.getnext()
if next != None:
group = radio.getparent()
index=self.root.xpath("count(//bookmark[@name=$var]/preceding-sibling::*)+1", var=name)
group.remove(radio)
group.insert(int(index),radio)
self.log.debug('%s moved with success', name)
self.saveToFile()
return True
else:
# could be a group?
group = self.root.xpath("//group[@name=$var]", var=name)
if group:
parent_group = group[0].getparent()
index=self.root.xpath("count(//group[@name=$var]/preceding-sibling::*)+1", var=name)
parent_group.remove(group[0])
parent_group.insert(int(index),group[0])
self.log.debug('%s moved with success', name)
self.saveToFile()
return True
return False
def moveToPosition(self, source, target, position):
self.log.info('Moving "%s" to target "%s"...', str(source), str(target))
itemToMove = self._radioExists(source)
if itemToMove == None:
itemToMove = self._groupExists(source)
itemTarget = self._radioExists(target)
if itemTarget == None:
itemTarget = self._groupExists(target)
if itemToMove != None and itemTarget != None:
index = itemTarget.getparent().index(itemTarget)
if (position == gtk.TREE_VIEW_DROP_INTO_OR_BEFORE or position == gtk.TREE_VIEW_DROP_INTO_OR_AFTER):
itemTarget.append(itemToMove)
elif position == gtk.TREE_VIEW_DROP_BEFORE:
itemTarget.getparent().insert(index, itemToMove)
elif position == gtk.TREE_VIEW_DROP_AFTER:
itemTarget.getparent().insert(index+1, itemToMove)
self.log.debug('%s moved with success', str(source))
self.saveToFile()
def _radioExists(self, name):
radio = None
try:
radio = self.root.xpath("//bookmark[@name=$var]", var=name)[0]
except IndexError, e:
# No radio was found
self.log.warn('Could not find a radio with the name "%s".', name)
return radio
def _groupExists(self, name):
group = None
try:
group = self.root.xpath("//group[@name=$var]", var=name)[0]
except IndexError, e:
# No group was found
self.log.warn('Could not find a group with the name "%s".', name)
return group
def walk_bookmarks(self, group_func, bookmark_func, user_data, group=""):
children = self.root.xpath("/bookmarks" + group + "/group | " + "/bookmarks" + group + "/bookmark")
for child in children:
child_name = child.get('name')
if child_name == None:
continue
if child.tag == 'group':
new_user_data = group_func(child_name, user_data)
self.walk_bookmarks(group_func, bookmark_func, new_user_data, group + "/group[@name='"+ child_name +"']")
else:
bookmark_func(child_name, user_data)
def getRootGroup(self):
return self.root.xpath("//group[@name='root']")[0]
def updateElementGroup(self, element, group_name):
group = self._groupExists(group_name)
if group != None:
old_group = element.getparent()
old_group.remove(element)
group.append(element)
self.saveToFile()
else:
self.log.warn('Could not move element group')
def isBookmarkWritable(self):
return os.access(self.filename, os.W_OK)
|
