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
|
# Copyright 2013 Facundo Batista
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 3, as published
# by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranties of
# MERCHANTABILITY, SATISFACTORY QUALITY, 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 this program. If not, see <http://www.gnu.org/licenses/>.
#
# For further info, check https://launchpad.net/encuentro
"""Classes to interface to and persist the episodes data."""
import cgi
import logging
import os
import pickle
from unicodedata import normalize
from encuentro.ui import dialogs
logger = logging.getLogger('encuentro.data')
class Status(object):
"""Status constants."""
none = 'none'
waiting = 'waiting'
downloading = 'downloading'
downloaded = 'downloaded'
_normalize_cache = {}
def _search_normalizer(char):
"""Normalize always to one char length."""
try:
return _normalize_cache[char]
except KeyError:
norm = normalize('NFKD', char).encode('ASCII', 'ignore').lower()
if not norm:
norm = '?'
_normalize_cache[char] = norm
return norm
def prepare_to_filter(text):
"""Prepare a text to filter.
It receives unicode, but return simple lowercase ascii.
"""
return ''.join(_search_normalizer(c) for c in text)
class EpisodeData(object):
"""Episode data."""
# these is for the attributes to be here when unpickling old instances
image_url = None
downtype = None
def __init__(self, channel, section, title, duration, description,
episode_id, url, image_url, state=None, progress=None,
filename=None, downtype=None):
self.channel = channel
self.section = section
self.title = cgi.escape(title)
self.duration = duration
self.description = description
self.episode_id = episode_id
# urls are bytes!
self.url = str(url)
self.image_url = str(image_url)
self.state = Status.none if state is None else state
self.progress = progress
self.filename = filename
self.to_filter = None
self.downtype = downtype
# cache the processed title
self._normalized_title = prepare_to_filter(self.title)
@property
def normalized_title(self):
"""Get the normalized title, if already have it, or calculate it.
This attribute may not be present because old pickled instances didn't
have it.
"""
if not hasattr(self, '_normalized_title'):
self._normalized_title = prepare_to_filter(self.title)
return self._normalized_title
def update(self, channel, section, title, duration, description,
episode_id, url, image_url, state=None, progress=None,
filename=None, downtype=None):
"""Update the episode data."""
self.channel = channel
self.section = section
self.title = cgi.escape(title)
self.duration = duration
self.description = description
self.episode_id = episode_id
# urls are bytes!
self.url = str(url)
self.image_url = str(image_url)
self.state = Status.none if state is None else state
self.progress = progress
self.filename = filename
self.downtype = downtype
def filter_params(self, text, only_downloaded):
"""Return the filtering params.
If should filter, it will return (pos1, pos2) (both in None if it only
filters by only_downloaded). If it should not filter, will return None.
"""
if only_downloaded and self.state != Status.downloaded:
# need downloaded ones, sorry
return
t = self.normalized_title
pos1 = t.find(text)
if pos1 == -1:
# need to match text, sorry
return
# return boundaries
pos2 = pos1 + len(text)
return (pos1, pos2)
def __str__(self):
args = (self.episode_id, self.state, self.channel,
self.section, self.title)
return "<EpisodeData [%s] (%s) %r (%r): %r>" % args
class ProgramsData(object):
"""Holder / interface for programs data."""
# more recent version of the in-disk data
last_programs_version = 1
def __init__(self, main_window, filename):
self.main_window = main_window
self.filename = filename
print "Using data file:", repr(filename)
logger.info("Using data file: %r", filename)
self.version = None
self.data = None
self.reset_config_from_migration = False
self.load()
self.migrate()
logger.info("Episodes metadata loaded (total %d)", len(self.data))
def merge(self, new_data, episodes_widget):
"""Merge new data to current programs data."""
for d in new_data:
# v2 of json file
names = ['channel', 'section', 'title', 'duration', 'description',
'episode_id', 'url', 'image_url', 'downtype']
values = dict((name, d[name]) for name in names)
episode_id = d['episode_id']
try:
ed = self.data[episode_id]
except KeyError:
ed = EpisodeData(**values)
episodes_widget.add_episode(ed)
self.data[episode_id] = ed
else:
ed.update(**values)
episodes_widget.update_episode(ed)
self.save()
def load(self):
"""Load the data from the file."""
# if not file, all empty
if not os.path.exists(self.filename):
self.data = {}
self.version = self.last_programs_version
return
# get from the file
with open(self.filename, 'rb') as fh:
try:
loaded_programs_data = pickle.load(fh)
except Exception, err:
logger.warning("ERROR while opening the pickled data: %s", err)
self.data = {}
self.version = self.last_programs_version
return
# check pre-versioned data
if isinstance(loaded_programs_data, dict):
# pre-versioned data
self.version = 0
self.data = loaded_programs_data
else:
self.version, self.data = loaded_programs_data
def migrate(self):
"""Migrate metadata if needed."""
if self.version == self.last_programs_version:
# all updated, nothing to migrate
return
if self.version > self.last_programs_version:
raise ValueError("Data is newer than code! %s" % (self.version,))
# migrate
if self.version == 0:
# actually, from 0, no migration is possible, we
# need to tell the user the ugly truth
dlg = dialogs.ForceUpgradeDialog()
should_quit = dlg.exec_()
if should_quit:
self.main_window.shutdown()
return
# if user accessed to go on, don't really need to migrate
# anything, as *all* the code is to support the new metadata
# version only, so just remove it and mark the usr/pass config
# to be removed
self.version = self.last_programs_version
self.reset_config_from_migration = True
self.data = {}
return
raise ValueError("Don't know how to migrate from %r" % (self.version,))
def __str__(self):
return "<ProgramsData ver=%r len=%d>" % (self.version, len(self.data))
def __nonzero__(self):
return bool(self.data)
def __getitem__(self, pos):
return self.data[pos]
def __setitem__(self, pos, value):
self.data[pos] = value
def values(self):
"""Return the iter values of the data."""
return self.data.itervalues()
def __len__(self):
"""The length."""
return len(self.data)
def items(self):
"""Return the iter items of the data."""
return self.data.iteritems()
def save(self):
"""Save to disk."""
to_save = (self.last_programs_version, self.data)
with open(self.filename, 'wb') as fh:
pickle.dump(to_save, fh)
|