home » zplus/dokk.org.git
ID: ed3d41766cd8a7add6e9f0081607dacacdaf7b05
470 lines — 12K — View raw


  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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
#!/usr/bin/env python3

import bottle
import datetime
import dateutil
import functools
import jinja2
import os
import pathlib
import pyld
import re
import requests

from bottle import jinja2_template as template, request, response
from string import Template

# Check that we have an endpoint for querying
FUSEKI_ENDPOINT = os.environ.get('FUSEKI_ENDPOINT')
if not FUSEKI_ENDPOINT:
    raise Exception('FUSEKI_ENDPOINT environment variable not set.')

# This only exists for exporting the bottle app object for a WSGI server such as Gunicorn
application = bottle.app()

# Directories to search for HTML templates
bottle.TEMPLATE_PATH = [ './pages' ]

def query(query_string, jsonld_frame=None):
    """
    Send query to Fuseki via HTTP.
    Return the query results.
    """

    http_request = requests.post(
        FUSEKI_ENDPOINT,
        data = { 'format': 'json', 'query': query_string})

    results = http_request.json()

    if jsonld_frame:
        results = pyld.jsonld.frame(results, jsonld_frame, options={'omitGraph':False})

    return results

def human_size(bytes, B=False):
    """
    Convert a file size in bytes to a human friendly form.
    This is only used in templates when showing file sizes.
    """

    for unit in [ 'B' if B else '', 'K', 'M', 'G', 'T', 'P' ]:
        if bytes < 1024: break
        bytes = bytes / 1024

    return '{}{}'.format(round(bytes), unit).rjust(5)

template = functools.partial(template, template_settings = {
    'filters': {
        'datetime': lambda date: dateutil.parser.parse(date).strftime('%b %-d, %Y - %H:%M%z%Z'),
        'human_size': human_size
    },
    'globals': {
        'now': lambda: datetime.datetime.now(datetime.timezone.utc),
        'query': query,
        'request': request,
        'url': application.get_url,
    },
    'autoescape': True
})

@bottle.error(404)
def error404(error):
    """
    Custom 404 page.

    :param error: bottle.HTTPError given by Bottle when calling abort(404).
    """

    return '[404] {}'.format(error.body)

@bottle.get('/favicon.ico')
def favicon():
    return bottle.static_file('favicon.ico', root='./')

@bottle.get('/robots.txt')
def robotstxt():
    response.content_type = 'text/plain; charset=UTF8'

    return """User-agent: *
Disallow:
"""

@bottle.get('/static/<filename:path>', name='static')
def static(filename):
    """
    Path for serving static files.
    """

    return bottle.static_file(filename, root='./static/')

@bottle.route('/library', method=['GET', 'POST'], name='library')
def library():
    """
    Library index
    """

    # Get a list of authors for searching
    authors = query("""
    PREFIX library: <dokk:library:>
    PREFIX license: <dokk:license:>

    SELECT DISTINCT ?name
    WHERE {
        [] library:author ?name
    }
    ORDER BY ?name
    """)['results']['bindings']

    # Get a list of licenses for searching
    licenses = query("""
    PREFIX library: <dokk:library:>
    PREFIX license: <dokk:license:>

    SELECT DISTINCT ?id
    WHERE {
        [] library:license [
            license:id ?id
        ] .
    }
    ORDER BY ?id
    """)['results']['bindings']

    # Retrieve filters selected by the user
    filters_author  = []
    filters_license = []
    query_filters = ''
    if request.method == 'POST':
        filters_author  = request.forms.getall('author')
        filters_license = request.forms.getall('license')

        if len(filters_author) > 0:
            query_filters_author  = ','.join([ '"'+i.replace('"', '\\"')+'"' for i in filters_author ])
            query_filters += f'FILTER(?author IN ({query_filters_author}))'

        if len(filters_license) > 0:
            query_filters_license = ','.join([ '"'+i.replace('"', '\\"')+'"' for i in filters_license ])
            query_filters += f'FILTER(?license_id IN ({query_filters_license}))'

    items = query(f"""
    PREFIX library: <dokk:library:>
    PREFIX license: <dokk:license:>

    CONSTRUCT {{
        ?item library:title ?title;
              library:author ?author ;
              library:license ?license .
        ?license license:id ?license_id ;
                 license:name ?license_name .
    }}
    WHERE {{
        ?item library:title ?title ;
                library:author ?author ;
                library:license ?license .

        OPTIONAL {{
        ?license license:id ?license_id_optional ;
                 license:name ?license_name_optional .
        }}

        BIND(COALESCE(?license_id_optional, SUBSTR(STR(?license), 14)) AS ?license_id)
        BIND(COALESCE(?license_name_optional, SUBSTR(STR(?license), 14)) AS ?license_name)

        {query_filters}
    }}
    ORDER BY UCASE(?title)
    """,
    {
        '@context': {
            'library': 'dokk:library:',
            'license': 'dokk:license:',
            'library:author': { '@container': '@set' },
            'library:license': { '@container': '@set' }
        },
        'library:title': {}
    })

    return template('library.html', authors=authors, licenses=licenses, items=items,
        filters_author=filters_author, filters_license=filters_license)

@bottle.get('/library/opds.xml', name='library_opds')
def library_opds():
    """
    Serve OPDS Atom RSS feeds
    """

    #response.content_type = 'text/xml; charset=utf-8'
    return template('templates/library/opds/root.tpl')

@bottle.get('/library/opds/books.xml', name='library_opds_books')
def library_opds_books():
    """
    Serve OPDS Atom RSS feeds.
    Items of type "books" only
    """

    #response.content_type = 'text/xml; charset=utf-8'
    return template('templates/library/opds/books.tpl')

@bottle.get('/library/opds/others.xml', name='library_opds_others')
def library_opds_others():
    """
    Serve OPDS Atom RSS feeds.
    Uncategorized items only
    """

    #response.content_type = 'text/xml; charset=utf-8'
    return template('templates/library/opds/others.tpl')

@bottle.get('/library/<item_id>', name='library_item')
def library_item(item_id):
    """
    """

    try:
        with open(f'../library_txt/{item_id}.txt', 'r') as file:
            item_plaintext = file.read()
    except:
        item_plaintext = ''

    return template('templates/library/item.tpl', item_id=item_id, plaintext=item_plaintext)

@bottle.get('/license', name='license_list')
def license_list():
    """
    List all licenses.
    """

    # TODO sanitize input
    data = query(f"""
        PREFIX license: <dokk:vocab:license:>

        SELECT *
        WHERE {{
            ?license license:id ?id ;
                     license:name ?name .
        }}
        ORDER BY ASC(UCASE(?name))
        """)

    return template('license.html', data=data)

@bottle.get('/license/<id>', name='license')
def license(id):
    """
    Show a single license
    """

    # TODO sanitize input
    data = query(f"""
        PREFIX license: <dokk:vocab:license:>

        DESCRIBE <dokk:license:{id}>
        """)

    return template('templates/license/license.tpl', data=data)

@bottle.get('/manpages/<distribution>/<version>', name='manpages_distribution')
def manpages_distribution(distribution, version):
    """
    List packages by distribution.
    """

    data = query(
    f'''
    PREFIX mp: <dokk:manpages:>

    SELECT DISTINCT ?name
    WHERE {{
        [] a mp:Distribution ;
            mp:name "{distribution}" ;
            mp:number {version} ;
            mp:package ?package .

        ?package a mp:Package ;
        mp:name ?name .
    }}
    ORDER BY ?name
    ''')

    return template('templates/manpages/distribution.tpl', data=data, distribution=distribution, version=version)

@bottle.get('/manpages/<distribution>/<version>/<package>', name='manpages_package')
def manpages_package(distribution, version, package):
    """
    List manpages by package.
    """

    data = query(
    f'''
    PREFIX mp: <dokk:manpages:>

    SELECT (?page as ?id) ?filename
    WHERE {{
        [] a mp:Distribution ;
            mp:name "{distribution}" ;
            mp:number {version} ;
            mp:package ?package .

        ?package a mp:Package ;
        mp:name "{package}" ;
        mp:page ?page .

  		?page a mp:Page ;
        mp:filename ?filename
    }}
    ORDER BY ?filename
    ''')

    return template('templates/manpages/package.tpl', data=data, distribution=distribution, version=version, package=package)

@bottle.get('/manpages/<name>.<section>', name='manpages_disambiguation')
def manpages_disambiguation(name, section):
    """
    Show a list of manpages that match <name> and <section>
    """

    data = query(
    f'''
    PREFIX mp: <dokk:manpages:>

    SELECT *
    WHERE {{
        ?page a mp:Page ;
        mp:filename ?filename ;
        mp:name_lowercase "{name}" ;
        mp:section_lowercase "{section}" .

        ?package a mp:Package ;
        mp:name ?package_name ;
        mp:page ?page .

        ?distro a mp:Distribution ;
        mp:name ?distro_name ;
        mp:number ?distro_number ;
        mp:package ?package .
    }}
    ORDER BY ?distro_name ?distro_number ?package_name
    ''')['results']['bindings']

    return template('templates/manpages/disambiguation.tpl', name=name, section=section, data=data)

@bottle.get('/manpages/<distro_name>/<distro_number>/<package>/<page>', name='manpages_page')
def manpages_page(distro_name, distro_number, package, page):
    """
    Display a single manpage.
    """

    data = query(
    f'''
    PREFIX mp: <dokk:manpages:>

    SELECT *
    WHERE {{
        ?page a mp:Page ;
        mp:filename "{page}" ;
        mp:name ?page_name ;
        mp:section ?page_section ;
        mp:html ?page_html .

        ?package a mp:Package ;
        mp:name "{package}" ;
        mp:page ?page .

        ?distro a mp:Distribution ;
        mp:name "{distro_name}" ;
        mp:number {distro_number} ;
        mp:package ?package .
    }}
    ''')['results']['bindings'][0]

    """
    Replace references to other manpages with links.
    Manpages have a section "See also" at the bottom where they suggest other pages.
    For example:
        SEE ALSO
        cdk(3), cdk_screen(3), cdk_display(3), cdk_binding(3), cdk_util(3)
    We convert these strings to links to other pages.
    Example: ls(1)  ->  <a href="...">ls(1)</a>
    regex explanation:
       - some manpages use a bold or italic name, so we match an optional <b>
         <i> tag
       - match valid characters for a manpage, assign name <page>
       - match optional closing </em> or </strong> tags
       - match '('
       - match number, assign name <section>
       - match ')'
    """

    html = data['page_html']['value']
    html = re.sub (
        '(?:<b>|<i>)?(?P<page>[\w_.:-]+)(?:</b>|</i>)?\((?P<section>[0-9]\w*)\)',
        lambda match:
            f'''<a href="{application.get_url('manpages_disambiguation',
                          name=match.group('page'), section=match.group('section')).lower()}"
            >{match.group('page')}({match.group('section')})</a>''',
        html)

    return template('templates/manpages/manpage.tpl',
        distro = {'name': distro_name, 'number': distro_number},
        package = package,
        page = {
            'filename': page,
            'name': data['page_name']['value'],
            'section': data['page_section']['value'],
            'html': html,
        })

@bottle.get('/mimi_and_eunice/<number>', name='mimi_and_eunice_strip')
def mimi_and_eunice_strip(number):
    """
    """

    iri = '<dokk:mimi_and_eunice:' + number + '>'

    data = query(Template(
    '''
    PREFIX license: <dokk:license:>
    PREFIX mimi_eunice: <dokk:mimi_and_eunice:>

    DESCRIBE $iri ?license
    WHERE {
        $iri mimi_eunice:license ?license
    }
    ''').substitute(iri=iri),
    {
        '@context': {
            'license': 'dokk:license:',
            'mimi_eunice': 'dokk:mimi_and_eunice:',
            'mimi_eunice:tag': { '@container': '@set' },
            'mimi_eunice:transcript': { '@container': '@set' }
        },
        'mimi_eunice:license': {},
        'mimi_eunice:transcript': {
            'mimi_eunice:order': {}
        }
    })

    return template('templates/mimi_and_eunice/strip.tpl', data=data['@graph'][0])

@bottle.get('/articles', name='articles')
def articles():
    """
    """

    pages = [ page.stem for page in sorted(pathlib.Path('./pages').glob('*.html')) ]
    pages.remove('.html')

    return template('templates/articles.tpl', pages=pages)

# TODO Make this obsolete. Replace with controllers
@bottle.get('/', name='homepage')
@bottle.get('/<page:path>', name='page')
def article(page=''):
    """
    Path for serving a "page".
    """

    page += '.html'

    return template(page)