aboutsummaryrefslogtreecommitdiff
path: root/allium/allium.py
blob: 9da4c00487340bb673010cc89de65c02dd114d2c (plain)
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
#!/usr/bin/env python3

'''
File: allium.py (executable)

Generate complete set of relay HTML pages and copy static files to the
output_dir

Default output directory: ./www
'''

import argparse
import os
import pkg_resources
import sys
from shutil import copytree
from lib.relays import Relays

jinja_version = pkg_resources.parse_version(
        pkg_resources.get_distribution('jinja2').version)

if jinja_version < pkg_resources.parse_version("2.11.2"):
    sys.exit('Jinja2>=2.11.2 required')

ABS_PATH = os.path.dirname(os.path.abspath(__file__))

if __name__ == '__main__':
    desc = 'allium: generate static tor relay metrics and statistics'
    parser = argparse.ArgumentParser(description=desc)
    parser.add_argument('--out', dest='output_dir', action='store_true',
                        default="./www",
                        help='directory to store rendered files (default "./www")',
                        required=False)
    parser.add_argument('--onionoo-url', dest='onionoo_url', action='store_true',
                        default="https://onionoo.torproject.org/details",
                        help='onionoo HTTP URL (default '\
                             '"https://onionoo.torproject.org/details")',
                        required=False)
    args = parser.parse_args()

    # object containing onionoo data and processing routines
    RELAY_SET = Relays(args.output_dir, args.onionoo_url)
    RELAY_SET.create_output_dir()

    # index and "all" HTML relay sets; index set limited to 500 relays
    RELAY_SET.write_misc(
        template    = 'index.html',
        path        = 'index.html',
        path_prefix = './',
        is_index    = True,
    )
    RELAY_SET.write_misc(
        template  = 'all.html',
        path      = 'misc/all.html'
    )

    # miscellaneous page filename suffixes and sorted-by keys
    misc_pages = {
        'by-bandwidth':    '1.bandwidth',
        'by-exit-count':   '1.exit_count,1.bandwidth',
        'by-middle-count': '1.middle_count,1.bandwidth',
        'by-first-seen':   '1.first_seen,1.bandwidth'
    }

    # miscellaneous-sorted (per misc_pages k/v) HTML pages
    for k, v in misc_pages.items():
        RELAY_SET.write_misc(
            template  = 'misc-families.html',
            path      = 'misc/families-{}.html'.format(k),
            sorted_by = v
        )
        RELAY_SET.write_misc(
            template  = 'misc-networks.html',
            path      = 'misc/networks-{}.html'.format(k),
            sorted_by = v
        )

    # onionoo keys used to generate pages by unique value; e.g. AS43350
    keys = ['as', 'contact', 'country', 'family', 'flag', 'platform',
            'first_seen']

    for k in keys:
        RELAY_SET.write_pages_by_key(k)

    # per-relay info pages
    RELAY_SET.write_relay_info()

    # copy static directory and its contents if it doesn't exist
    if not os.path.exists(os.path.join(args.output_dir, 'static')):
        copytree(os.path.join(ABS_PATH, 'static'),
            os.path.join(args.output_dir, 'static'))