mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-28 08:03:36 +00:00
559a4c30e8
This serves two purposes: 1. Upstream's website cannot track the IP addresses of FreedomBox users. 2. We can update the versions of the empty quine files without making code changes in FreedomBox. Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net> [sunil: Update description to reflect the change in upstream URL] Signed-off-by: Sunil Mohan Adapa <sunil@medhas.or>g Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
93 lines
2.5 KiB
Python
93 lines
2.5 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""Configure Feather Wiki."""
|
|
|
|
import pathlib
|
|
import re
|
|
import shutil
|
|
import tempfile
|
|
import urllib.request
|
|
|
|
from plinth.actions import privileged
|
|
|
|
EMPTY_WIKI_FILE = 'https://ftp.freedombox.org/pub/featherwiki/empty.html'
|
|
|
|
wiki_dir = pathlib.Path('/var/lib/featherwiki')
|
|
|
|
|
|
def _set_ownership(path: pathlib.Path):
|
|
"""Makes www-data:www-data the owner of the give path."""
|
|
shutil.chown(path, user='www-data', group='www-data')
|
|
|
|
|
|
@privileged
|
|
def setup():
|
|
"""Setup wiki dir and CGI script."""
|
|
wiki_dir.mkdir(parents=True, exist_ok=True)
|
|
_set_ownership(wiki_dir)
|
|
|
|
|
|
def _normalize_wiki_file_name(name):
|
|
"""Return a normalized file name from a wiki name."""
|
|
file_name = name.replace(' ', '_')
|
|
invalid_characters = r'[\/\\\:\*\?\"\'\<\>\|]'
|
|
file_name = re.sub(invalid_characters, '', file_name)
|
|
if not file_name.endswith('.html'):
|
|
return file_name + '.html'
|
|
|
|
return file_name
|
|
|
|
|
|
@privileged
|
|
def create_wiki(file_name: str):
|
|
"""Initialize wiki with the latest version of Feather Wiki."""
|
|
file_name = _normalize_wiki_file_name(file_name)
|
|
response = urllib.request.urlopen(EMPTY_WIKI_FILE)
|
|
file_path = wiki_dir / file_name
|
|
if file_path.exists():
|
|
raise ValueError('Wiki exists')
|
|
|
|
file_path.write_bytes(response.read())
|
|
_set_ownership(file_path)
|
|
|
|
|
|
@privileged
|
|
def add_wiki_file(upload_file: str):
|
|
"""Add an uploaded wiki file."""
|
|
upload_file_path = pathlib.Path(upload_file)
|
|
temp_dir = tempfile.gettempdir()
|
|
if not upload_file_path.is_relative_to(temp_dir):
|
|
raise Exception('Uploaded file is not in expected temp directory.')
|
|
|
|
file_name = _normalize_wiki_file_name(upload_file_path.name)
|
|
file_path = wiki_dir / file_name
|
|
if file_path.exists():
|
|
raise ValueError('Wiki exists')
|
|
|
|
shutil.move(upload_file_path, file_path)
|
|
_set_ownership(file_path)
|
|
|
|
|
|
@privileged
|
|
def rename_wiki(old_name: str, new_name: str):
|
|
"""Rename wiki file."""
|
|
old_name = _normalize_wiki_file_name(old_name)
|
|
new_name = _normalize_wiki_file_name(new_name)
|
|
file_path = wiki_dir / new_name
|
|
if file_path.exists():
|
|
raise ValueError('Wiki exists')
|
|
|
|
(wiki_dir / old_name).rename(file_path)
|
|
|
|
|
|
@privileged
|
|
def delete_wiki(file_name: str):
|
|
"""Delete one wiki file by name."""
|
|
file_name = _normalize_wiki_file_name(file_name)
|
|
(wiki_dir / file_name).unlink(missing_ok=True)
|
|
|
|
|
|
@privileged
|
|
def uninstall():
|
|
"""Delete all the wiki content."""
|
|
shutil.rmtree(wiki_dir)
|