aboutsummaryrefslogtreecommitdiff
path: root/fietsboek/views/admin.py
blob: 14e4306bbdff459d33a0ffd4e834ee1f78f2467b (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
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
"""Admin views."""

import datetime
import platform
import stat
from dataclasses import dataclass
from pathlib import Path

from pyramid.httpexceptions import HTTPFound
from pyramid.i18n import TranslationString as _
from pyramid.request import Request
from pyramid.view import view_config
from sqlalchemy import func, select, text

from .. import models, util

GOOD_CRON_THRESHOLD = datetime.timedelta(hours=1)


def _safe_size(path: Path) -> int:
    try:
        res = path.stat()
        if stat.S_ISDIR(res.st_mode):
            return util.recursive_size(path)
        if stat.S_ISREG(res.st_mode):
            return res.st_size
        return 0
    except FileNotFoundError:
        return 0


@dataclass
class SizeBreakdown:
    """A breakdown of what objects take how much storage."""

    track_data: int = 0
    backups: int = 0
    image_files: int = 0
    preview_files: int = 0
    user_maps: int = 0


def _get_size_breakdown(dbsession, data_manager):
    breakdown = SizeBreakdown()

    dialect = dbsession.bind.dialect.name
    if dialect == "sqlite":
        query = text("""SELECT SUM("pgsize") FROM "dbstat" WHERE name='track_points';""")
        result = dbsession.execute(query).scalar_one()
        breakdown.track_data += result
    elif dialect == "postgresql":
        query = text(f"""SELECT pg_relation_size('track_points');""")
        result = dbsession.execute(query).scalar_one()
        breakdown.track_data += result

    for track_id in data_manager.list_tracks():
        track = data_manager.open(track_id)
        breakdown.backups += _safe_size(track.backup_path())
        breakdown.preview_files += _safe_size(track.preview_path())
        for image_id in track.images():
            breakdown.image_files += _safe_size(track.image_path(image_id))

    for user_id in data_manager.list_users():
        user = data_manager.open_user(user_id)
        breakdown.user_maps += _safe_size(user.heatmap_path())
        breakdown.user_maps += _safe_size(user.tilehunt_path())

    return breakdown


def _get_db_size(dbsession):
    dialect = dbsession.bind.dialect.name
    if dialect == "sqlite":
        query = text(
            """SELECT page_size * page_count FROM pragma_page_count(), pragma_page_size();"""
        )
        result = dbsession.execute(query).scalar_one()
        return result
    if dialect == "postgresql":
        database_name = dbsession.bind.url.database
        query = text(f"""SELECT pg_database_size('{database_name}');""")
        result = dbsession.execute(query).scalar_one()
        return result
    return 0


def _get_fietsboek_version():
    # pylint: disable=import-outside-toplevel
    from fietsboek import __VERSION__

    return __VERSION__


@view_config(
    route_name="admin",
    renderer="fietsboek:templates/admin_overview.jinja2",
    request_method="GET",
    permission="admin",
)
def admin(request: Request):
    """Renders the admin overview.

    :param request: The Pyramid request.
    :return: The HTTP response.
    """
    # False-positive with func.count()
    # pylint: disable=not-callable
    user_count = request.dbsession.execute(select(func.count()).select_from(models.User)).scalar()
    track_count = request.dbsession.execute(select(func.count()).select_from(models.Track)).scalar()
    size_total = request.data_manager.size() + _get_db_size(request.dbsession)
    size_breakdown = _get_size_breakdown(request.dbsession, request.data_manager)

    try:
        distro = platform.freedesktop_os_release()["PRETTY_NAME"]
    except OSError:
        distro = None

    try:
        last_cronjob_timestamp = float(request.redis.get("last-cronjob"))
    except (TypeError, ValueError):
        last_cronjob = None
        cron_good = False
    else:
        last_cronjob = datetime.datetime.fromtimestamp(last_cronjob_timestamp, datetime.UTC)
        cron_good = (datetime.datetime.now(datetime.UTC) - last_cronjob) < GOOD_CRON_THRESHOLD

    versions = {
        "fietsboek": _get_fietsboek_version(),
        "python": platform.python_version(),
        "linux": platform.platform(),
        "distro": distro,
    }

    return {
        "user_count": user_count,
        "track_count": track_count,
        "total_size": size_total,
        "size_breakdown": size_breakdown,
        "versions": versions,
        "last_cronjob": last_cronjob,
        "cron_good": cron_good,
    }


@view_config(
    route_name="admin-badge",
    renderer="fietsboek:templates/admin_badges.jinja2",
    request_method="GET",
    permission="admin",
)
def admin_badges(request):
    """Renders the badges editor.

    :param request: The Pyramid request.
    :type request: pyramid.request.Request
    :return: The HTTP response.
    :rtype: pyramid.response.Response
    """
    badges = request.dbsession.execute(select(models.Badge)).scalars()
    return {
        "badges": badges,
    }


@view_config(route_name="admin-badge-add", permission="admin", request_method="POST")
def do_badge_add(request):
    """Adds a badge.

    This is the endpoint of a form on the admin overview.

    :param request: The Pyramid request.
    :type request: pyramid.request.Request
    :return: The HTTP response.
    :rtype: pyramid.response.Response
    """

    image = request.params["badge-image"].file.read()
    title = request.params["badge-title"]

    badge = models.Badge(title=title, image=image)
    request.dbsession.add(badge)

    request.session.flash(request.localizer.translate(_("flash.badge_added")))
    return HTTPFound(request.route_url("admin-badge"))


@view_config(route_name="admin-badge-edit", permission="admin", request_method="POST")
def do_badge_edit(request):
    """Modifies an already existing badge.

    This is the endpoint of a form on the admin overview.

    :param request: The Pyramid request.
    :type request: pyramid.request.Request
    :return: The HTTP response.
    :rtype: pyramid.response.Response
    """
    badge = request.dbsession.execute(
        select(models.Badge).filter_by(id=request.params["badge-edit-id"])
    ).scalar_one()
    try:
        badge.image = request.params["badge-image"].file.read()
    except AttributeError:
        pass
    badge.title = request.params["badge-title"]

    request.session.flash(request.localizer.translate(_("flash.badge_modified")))
    return HTTPFound(request.route_url("admin-badge"))


@view_config(route_name="admin-badge-delete", permission="admin", request_method="POST")
def do_badge_delete(request):
    """Removes a badge.

    This is the endpoint of a form on the admin overview.

    :param request: The Pyramid request.
    :type request: pyramid.request.Request
    :return: The HTTP response.
    :rtype: pyramid.response.Response
    """
    badge = request.dbsession.execute(
        select(models.Badge).filter_by(id=request.params["badge-delete-id"])
    ).scalar_one()
    request.dbsession.delete(badge)

    request.session.flash(request.localizer.translate(_("flash.badge_deleted")))
    return HTTPFound(request.route_url("admin-badge"))


__all__ = ["admin", "admin_badges", "do_badge_add", "do_badge_edit", "do_badge_delete"]