-
Notifications
You must be signed in to change notification settings - Fork 0
/
opds.py
372 lines (297 loc) · 11.7 KB
/
opds.py
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
import logging
import re
from collections import defaultdict
from datetime import datetime
from nose.tools import set_trace
from flask import url_for
from sqlalchemy.orm import lazyload
from core.app_server import cdn_url_for
from core.classifier import Classifier
from core.lane import Facets
from core.opds import (
AcquisitionFeed,
OPDSFeed,
UnfulfillableWork,
VerboseAnnotator,
)
from core.model import (
Identifier,
Resource,
Session,
Subject,
Work,
Edition,
LicensePool,
)
from core.util import slugify
from config import Configuration
class ContentServerAnnotator(VerboseAnnotator):
@classmethod
def annotate_work_entry(cls, work, active_license_pool, edition, identifier, feed, entry):
"""Annotate the feed with all open-access links for this book."""
if not active_license_pool.open_access:
return
rel = OPDSFeed.OPEN_ACCESS_REL
fulfillable = False
for resource in active_license_pool.open_access_links:
if not resource.representation:
continue
url = resource.representation.mirror_url
if not url:
logging.warn(
"Problem with %r: open-access link %s not mirrored!",
identifier,
resource.representation.url
)
continue
type = resource.representation.media_type
feed.add_link_to_entry(
entry, rel=rel, href=url, type=type
)
fulfillable = True
if not fulfillable:
# This open-access work has no usable open-access links.
# Don't show it in the OPDS feed.
raise UnfulfillableWork()
VerboseAnnotator.annotate_work_entry(
work, active_license_pool, edition, identifier, feed, entry
)
@classmethod
def default_lane_url(cls):
return cdn_url_for("feed", _external=True)
def top_level_title(self):
return "All Books"
def feed_url(self, lane, facets, pagination):
kwargs = dict(facets.items())
kwargs.update(dict(pagination.items()))
if lane.license_source:
view = "feed_from_license_source"
kwargs['license_source_name'] = lane.license_source.name
else:
view = "feed"
kwargs['lane'] = lane.name
kwargs['languages'] = lane.languages
return cdn_url_for(view, _external=True, **kwargs)
class AllCoverLinksAnnotator(ContentServerAnnotator):
@classmethod
def cover_links(cls, work):
"""The content server sends out _all_ cover links for the work.
For books covered by Gutenberg Illustrated, this can be over a
hundred cover links.
"""
_db = Session.object_session(work)
ids = work.all_identifier_ids()
image_resources = Identifier.resources_for_identifier_ids(
_db, ids, Resource.IMAGE)
thumbnails = []
full = []
for cover in image_resources:
if cover.mirrored_path:
full.append(cover.mirrored_path)
if cover.scaled_path:
thumbnails.append(cover.scaled_path)
return thumbnails, full
class StaticFeedAnnotator(ContentServerAnnotator):
"""An Annotator to work with static feeds generated via script"""
TOP_LEVEL_LANE_NAME = u'All Books'
HOME_FILENAME = u'index'
# Feeds ordered by this facet will be considered the default.
DEFAULT_ORDER = Facets.ORDER_TITLE
DEFAULT_LANE_ORDER = [
'Short Stories', 'Fiction', 'Nonfiction', 'Spanish', 'French'
]
@classmethod
def slugify_feed_title(cls, feed_title):
return slugify(feed_title)
def __init__(self, base_url, lane=None, prefix=None, include_search=None,
license_link=None):
if not base_url.endswith('/'):
base_url += '/'
self.base_url = base_url
self.prefix = prefix or ''
self.lane = lane
self.include_search = include_search
self.license_link = license_link
self.lanes_by_work = defaultdict(list)
def reset(self, lane):
self.lanes_by_work = defaultdict(list)
self.lane = lane
def default_lane_url(self):
return self.base_url + self.prefix + self.HOME_FILENAME + '.xml'
def search_url(self):
return self.base_url + 'search'
def lane_filename(self, lane=None):
lane = lane or self.lane
if lane.name == self.TOP_LEVEL_LANE_NAME:
# This is the home lane.
# Could be a COPPA navigation feed or an "All Books" lane
# if a there aren't feeds for multiple age groups.
return self.prefix + self.HOME_FILENAME
if not lane.parent:
# When there is a COPPA navigation feed, this creates a
# filename for the top of the youth and adult feeds.
return self.prefix + self.slugify_feed_title(lane.name)
path = list()
while lane.parent:
path.insert(0, self.slugify_feed_title(lane.name))
lane = lane.parent
return self.prefix + '_'.join(path)
def filename_facet_segment(self, facets):
ordered_by = list(facets.items())[0][1]
if ordered_by != self.DEFAULT_ORDER:
return '_' + ordered_by
return ''
def facet_url(self, facets):
"""Incoporate order facets into filenames for static feeds"""
if not self.lane:
# Due to constraints in AcquisitionFeed, this method
# is the only one that relies on a lane being set at
# initialization.
raise ValueError(
"StaticFeedAnnotator can't create a facet URL without"\
" a selected lane."
)
filename = self.lane_filename()
filename += self.filename_facet_segment(facets)
return self.base_url + filename + '.xml'
def feed_url(self, lane, facets, pagination):
"""Incorporate pages into filenames for static feeds"""
filename = self.lane_filename(lane)
filename += self.filename_facet_segment(facets)
page_number = (pagination.offset / pagination.size) + 1
if page_number > 1:
filename += ('_%i' % page_number)
return self.base_url + filename + '.xml'
def group_uri(self, work, license_pool, identifier):
if not work in self.lanes_by_work:
return None, ""
lane = self.lanes_by_work[work][0]['lane']
self.lanes_by_work[work] = self.lanes_by_work[work][1:]
return self.lane_url(lane), lane.display_name
def groups_url(self, lane):
if lane:
filename = self.lane_filename(lane)
else:
filename = self.HOME_FILENAME
return self.base_url + filename + '.xml'
def lane_url(self, lane):
return self.groups_url(lane)
def sort_works_for_groups_feed(self, works, lane_order=None):
"""Sorts lanes_by_work by the preferred list order of lanes in
the feed
"""
lane_order = lane_order or self.DEFAULT_LANE_ORDER
lane_names = set([])
for work, lanes in self.lanes_by_work.items():
for lane_dict in lanes:
lane = lane_dict['lane']
lane_names.add(lane.name)
missing_names = lane_names.difference(lane_order)
for name in missing_names:
# This is a lane that wasn't added to the preference
# list. Add it to the end so it can be sorted against
# without an error.
lane_order.append(name)
def sort_key(work):
lanes = [l.get('lane') for l in self.lanes_by_work[work]]
key = None
if len(lanes) > 1:
lanes_by_key = dict()
for lane in lanes:
lane_key = lane_order.index(lane.name)
lanes_by_key[lane_key] = lane
# Get the lowest key
key = sorted(lanes_by_key)[0]
lane = lanes_by_key[key]
else:
lane = lanes[0]
key = lane_order.index(lane.name)
if (lane.name.startswith('General ') or
lane.name.startswith('All ')):
# Force general lanes to the bottom of the feed.
return 50
return key
return sorted(works, key=sort_key)
def annotate_feed(self, feed, lane):
if self.include_search:
OPDSFeed.add_link_to_feed(
feed.feed,
rel='search',
href=self.search_url(),
type='application/opensearchdescription+xml')
if self.license_link:
OPDSFeed.add_link_to_feed(
feed.feed,
rel='license',
href=self.license_link,
type='text/html'
)
class StaticFeedCOPPAAnnotator(StaticFeedAnnotator):
TOP_LEVEL_LANE_NAME = u'Instant Classics'
COPPA_RESTRICTION = u'http://librarysimplified.org/terms/restrictions/coppa'
def add_gate(self, youth_lane, full_lane, feed_obj):
details = {
'restriction' : self.COPPA_RESTRICTION,
'restriction-not-met' : self.lane_url(youth_lane),
'restriction-met' : self.lane_url(full_lane)
}
gate_tag = OPDSFeed.makeelement(
"{%s}gate" % OPDSFeed.SIMPLIFIED_NS, details
)
feed_obj.feed.append(gate_tag)
class StaticCOPPANavigationFeed(OPDSFeed):
"""Creates an OPDS navigation feed to guide between AcquisitionFeeds
representing the full 13+ collection and the <13 childrens collection,
in accordance with COPPA
"""
@classmethod
def content(cls, *args, **kwargs):
kwargs['type'] = 'text'
return cls.E.content(*args, **kwargs)
@classmethod
def childrens_entry(cls, lane_url):
audience = Classifier.AUDIENCE_CHILDREN
category_details = cls.audience_details(audience)
return cls.entry(
cls.id(lane_url),
cls.title("I'm Under 13"),
cls.updated(cls._strftime(datetime.utcnow())),
cls.content("Read children's books"),
cls.category(category_details)
)
@classmethod
def full_collection_entry(cls, lane_url):
audience = Classifier.AUDIENCE_ADULT
category_details = cls.audience_details(audience)
return cls.entry(
cls.id(lane_url),
cls.title("I'm 13 or Older"),
cls.updated(cls._strftime(datetime.utcnow())),
cls.content('See the full collection'),
cls.category(category_details)
)
@classmethod
def audience_details(cls, audience):
return dict(
term=audience, label=audience, scheme='%saudience' % cls.SCHEMA_NS
)
def __init__(self, title, base_url, youth_lane, full_lane, **kwargs):
"""Turn a list of lanes into a feed."""
annotator = StaticFeedCOPPAAnnotator(base_url, **kwargs)
lane_url = annotator.default_lane_url()
super(StaticCOPPANavigationFeed, self).__init__(title, lane_url)
self.create_entry(youth_lane, annotator, youth=True)
self.create_entry(full_lane, annotator)
annotator.add_gate(youth_lane, full_lane, self)
def create_entry(self, lane, annotator, youth=False):
annotator.reset(lane)
lane_url = annotator.lane_url(lane)
if youth:
entry = self.childrens_entry(lane_url)
else:
entry = self.full_collection_entry(lane_url)
link = dict(
type=self.ACQUISITION_FEED_TYPE, href=lane_url, rel='subsection'
)
self.add_link_to_entry(entry, **link)
self.feed.append(entry)