/
routes.py
422 lines (361 loc) · 13.5 KB
/
routes.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
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
from pathlib import Path
from os.path import sep
from pkg_resources import require
from shutil import which
import frontmatter
from flask import (
render_template,
flash,
redirect,
request,
url_for,
send_file,
send_from_directory,
)
from flask_login import login_user, current_user, logout_user
from tinydb import Query
from werkzeug.security import check_password_hash, generate_password_hash
from archivy.models import DataObj, User
from archivy import data, app, forms, csrf
from archivy.helpers import get_db, write_config, is_safe_redirect_url
from archivy.tags import get_all_tags
from archivy.search import search, search_frontmatter_tags
from archivy.config import Config
import re
@app.context_processor
def pass_defaults():
dataobjs = data.get_items(load_content=False)
version = require("archivy")[0].version
SEP = sep
# check windows parsing for js (https://github.com/Uzay-G/archivy/issues/115)
if SEP == "\\":
SEP += "\\"
return dict(dataobjs=dataobjs, SEP=SEP, version=version)
@app.before_request
def check_perms():
allowed_path = (
request.path.startswith("/login")
or request.path.startswith("/static")
or request.path.startswith("/api/login")
)
if not current_user.is_authenticated and not allowed_path:
return redirect(url_for("login", next=request.path))
return
@app.route("/")
@app.route("/index")
def index():
path = request.args.get("path", "").lstrip("/")
try:
files = data.get_items(path=path)
except FileNotFoundError:
flash("Directory does not exist.", "error")
return redirect("/")
return render_template(
"home.html",
title=path or "root",
search_enabled=app.config["SEARCH_CONF"]["enabled"],
dir=files,
current_path=path,
new_folder_form=forms.NewFolderForm(),
delete_form=forms.DeleteFolderForm(),
rename_form=forms.RenameDirectoryForm(),
view_only=0,
search_engine=app.config["SEARCH_CONF"]["engine"],
)
# TODO: refactor two following methods
@app.route("/bookmarks/new", methods=["GET", "POST"])
def new_bookmark():
default_dir = app.config.get("DEFAULT_BOOKMARKS_DIR", "root directory")
form = forms.NewBookmarkForm(path=default_dir)
form.path.choices = [("", "root directory")] + [
(pathname, pathname) for pathname in data.get_dirs()
]
if form.validate_on_submit():
path = form.path.data
tags = form.tags.data.split(",") if form.tags.data != "" else []
tags = [tag.strip() for tag in tags]
bookmark = DataObj(url=form.url.data, tags=tags, path=path, type="bookmark")
bookmark.process_bookmark_url()
bookmark_id = bookmark.insert()
if bookmark_id:
flash("Bookmark Saved!", "success")
return redirect(f"/dataobj/{bookmark_id}")
else:
flash(bookmark.error, "error")
return redirect("/bookmarks/new")
# for bookmarklet
form.url.data = request.args.get("url", "")
path = request.args.get("path", default_dir).strip("/")
# handle empty argument
form.path.data = path
return render_template("dataobjs/new.html", title="New Bookmark", form=form)
@app.route("/notes/new", methods=["GET", "POST"])
def new_note():
form = forms.NewNoteForm()
default_dir = "root directory"
form.path.choices = [("", default_dir)] + [
(pathname, pathname) for pathname in data.get_dirs()
]
if form.validate_on_submit():
path = form.path.data
tags = form.tags.data.split(",") if form.tags.data != "" else []
tags = [tag.strip() for tag in tags]
note = DataObj(title=form.title.data, path=path, tags=tags, type="note")
note_id = note.insert()
if note_id:
flash("Note Saved!", "success")
return redirect(f"/dataobj/{note_id}")
path = request.args.get("path", default_dir).strip("/")
# handle empty argument
form.path.data = path
return render_template("/dataobjs/new.html", title="New Note", form=form)
@app.route("/tags")
def show_all_tags():
if not app.config["SEARCH_CONF"]["engine"] == "ripgrep" and not which("rg"):
flash("Ripgrep must be installed to view pages about embedded tags.", "error")
return redirect("/")
tags = sorted(get_all_tags(force=True))
return render_template("tags/all.html", title="All Tags", tags=tags)
@app.route("/tags/<tag_name>")
def show_tag(tag_name):
if not app.config["SEARCH_CONF"]["enabled"] and not which("rg"):
flash(
"Search (for example ripgrep) must be installed to view pages about embedded tags.",
"error",
)
return redirect("/")
results = search(f"#{tag_name}#", strict=True)
res_ids = set(
[item["id"] for item in results]
) # avoid duplication of results between context-aware embedded tags and metadata ones
for res in search_frontmatter_tags(tag_name):
if res["id"] not in res_ids:
results.append(res)
return render_template(
"tags/show.html",
title=f"Tags - {tag_name}",
tag_name=tag_name,
search_result=results,
)
@app.route("/dataobj/<int:dataobj_id>")
def show_dataobj(dataobj_id):
dataobj = data.get_item(dataobj_id)
get_title_id_pairs = lambda x: (x["title"], x["id"])
titles = list(
map(get_title_id_pairs, data.get_items(structured=False, load_content=False))
)
if not dataobj:
flash("Data could not be found!", "error")
return redirect("/")
if request.args.get("raw") == "1":
return frontmatter.dumps(dataobj)
backlinks = []
if app.config["SEARCH_CONF"]["enabled"]:
if app.config["SEARCH_CONF"]["engine"] == "ripgrep":
query = f"\|{dataobj_id}]]"
else:
query = f"|{dataobj_id})]]"
backlinks = search(query, strict=True)
# Form for moving data into another folder
move_form = forms.MoveItemForm()
move_form.path.choices = [("", "root directory")] + [
(pathname, pathname) for pathname in data.get_dirs()
]
post_title_form = forms.TitleForm()
post_title_form.title.data = dataobj["title"]
# Get all tags
tag_list = get_all_tags()
# and the ones present in this dataobj
embedded_tags = set()
PATTERN = r"(?:^|\n| )#(?:[-_a-zA-ZÀ-ÖØ-öø-ÿ0-9]+)#"
for match in re.finditer(PATTERN, dataobj.content):
embedded_tags.add(match.group(0).replace("#", "").lstrip())
return render_template(
"dataobjs/show.html",
title=dataobj["title"],
dataobj=dataobj,
backlinks=backlinks,
current_path=dataobj["dir"],
form=forms.DeleteDataForm(),
view_only=0,
search_enabled=app.config["SEARCH_CONF"]["enabled"],
post_title_form=post_title_form,
move_form=move_form,
tag_list=tag_list,
embedded_tags=embedded_tags,
titles=titles,
)
@app.route("/dataobj/move/<int:dataobj_id>", methods=["POST"])
def move_item(dataobj_id):
form = forms.MoveItemForm()
out_dir = form.path.data if form.path.data != "" else "root directory"
if form.path.data == None:
flash("No path specified.")
return redirect(f"/dataobj/{dataobj_id}")
try:
if data.move_item(dataobj_id, form.path.data):
flash(f"Data successfully moved to {out_dir}.", "success")
return redirect(f"/dataobj/{dataobj_id}")
else:
flash(f"Data could not be moved to {out_dir}.", "error")
return redirect(f"/dataobj/{dataobj_id}")
except FileNotFoundError:
flash("Data not found.", "error")
return redirect("/")
except FileExistsError:
flash("Data already in target directory.", "error")
return redirect(f"/dataobj/{dataobj_id}")
@app.route("/dataobj/delete/<int:dataobj_id>", methods=["POST"])
def delete_data(dataobj_id):
try:
data.delete_item(dataobj_id)
except BaseException:
flash("Data could not be found!", "error")
return redirect("/")
flash("Data deleted!", "success")
return redirect("/")
@app.route("/login", methods=["GET", "POST"])
def login():
form = forms.UserForm()
if form.validate_on_submit():
db = get_db()
user = db.search(
(Query().username == form.username.data) & (Query().type == "user")
)
if user and check_password_hash(user[0]["hashed_password"], form.password.data):
user = User.from_db(user[0])
login_user(user, remember=True)
flash("Login successful!", "success")
next_url = request.args.get("next")
if next_url and is_safe_redirect_url(next_url):
return redirect(next_url)
else:
return redirect("/")
flash("Invalid credentials", "error")
return redirect("/login")
return render_template("users/login.html", form=form, title="Login")
@app.route("/logout", methods=["DELETE", "GET"])
def logout():
logout_user()
flash("Logged out successfully", "success")
return redirect("/")
@app.route("/user/edit", methods=["GET", "POST"])
def edit_user():
form = forms.UserForm()
if form.validate_on_submit():
db = get_db()
db.update(
{
"username": form.username.data,
"hashed_password": generate_password_hash(form.password.data),
},
doc_ids=[current_user.id],
)
flash("Information saved!", "success")
return redirect("/")
form.username.data = current_user.username
return render_template("users/edit.html", form=form, title="Edit Profile")
@app.route("/folders/create", methods=["POST"])
def create_folder():
form = forms.NewFolderForm()
if form.validate_on_submit():
path = Path(form.parent_dir.data.strip("/")) / form.new_dir.data
new_path = data.create_dir(str(path))
flash("Folder successfully created.", "success")
return redirect(f"/?path={new_path}")
flash("Could not create folder.", "error")
return redirect(request.referrer or "/")
@app.route("/folders/delete", methods=["POST"])
def delete_folder():
form = forms.DeleteFolderForm()
if form.validate_on_submit():
if data.delete_dir(form.dir_name.data):
flash("Folder successfully deleted.", "success")
return redirect("/")
else:
flash("Folder not found.", "error")
return redirect(request.referrer or "/", 404)
flash("Could not delete folder.", "error")
return redirect(request.referrer or "/")
@app.route("/folders/rename", methods=["POST"])
def rename_folder():
form = forms.RenameDirectoryForm()
if form.validate_on_submit():
try:
new_path = data.rename_folder(form.current_path.data, form.new_name.data)
if not new_path:
flash("Invalid input.", "error")
else:
flash("Renamed successfully.", "success")
return redirect(f"/?path={new_path}")
except FileNotFoundError:
flash("Directory not found.", "error")
except FileExistsError:
flash("Target directory exists.", "error")
return redirect("/")
@app.route("/bookmarklet")
def bookmarklet():
return render_template("bookmarklet.html", title="Bookmarklet")
@app.route("/images/<filename>")
def serve_image(filename):
if filename and data.valid_image_filename(filename):
image_path = data.image_exists(filename)
if image_path:
return send_file(image_path)
else:
return "Image not found", 404
else:
return "Invalid file request", 413
@app.route("/static/custom.css")
def custom_css():
if not app.config["THEME_CONF"].get("use_custom_css", False):
return ""
return send_from_directory(
Path(app.config["USER_DIR"]) / "css",
app.config["THEME_CONF"]["custom_css_file"],
)
@app.route("/config", methods=["GET", "POST"])
def config():
"""
Web View to edit and update configuration.
"""
def update_config_value(key, val, dictionary):
if key != "SECRET_KEY":
if type(val) is dict:
for k, v in val.items():
update_config_value(k, v, dictionary[key])
else:
dictionary[key] = val
form = forms.config_form(app.config)
default = vars(Config())
if form.validate_on_submit():
changed_config = Config()
changed_config.override(form.data)
for k, v in vars(changed_config).items():
# propagate changes to configuration
update_config_value(k, v, app.config)
write_config(vars(changed_config)) # save to filesystem config
flash("Config successfully updated.", "success")
elif request.method == "POST":
flash("Could not update config.", "error")
return render_template(
"config.html", conf=form, default=default, title="Edit Config"
)
@csrf.exempt # exempt from CSRF to be able to submit info directly from bookmarklet
@app.route("/save_from_bookmarklet", methods=["POST"])
def save_raw_url():
"""
Used in the bookmarklet - Saves a URL by taking its raw HTML.
POST parameters:
- html
- url
"""
html = request.form.get("html")
if not html:
return "No HTML provided", 400
bookmark = DataObj(url=request.form.get("url"), type="bookmark")
bookmark.process_bookmark_url(html)
if bookmark.insert():
return redirect(f"/dataobj/{bookmark.id}")
else:
return "Could not save bookmark", 500