mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-11-20 15:06:19 -05:00
commit 26bde0fb48d59a86c2fb9f53a7218d49f22d4860
Author: Roland <roland@learningselfreliance.com>
Date: Tue Mar 8 13:25:56 2022 -0700
Using osm2pgsql append to preserve other imported maps.
commit c6c52623eaf02e691b1e75dcf39c3a8334ead55a
Author: Roland <roland@learningselfreliance.com>
Date: Tue Mar 8 08:20:38 2022 -0700
Using placeholder instead of loader when table is loading.
commit 44fec6490e26603c88a98f6bc70fc18686e17f09
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 20:58:34 2022 -0700
Simplifying tableRow function.
commit 11b8b57f1fa59556397620f3cad9a33a0237501d
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 20:53:51 2022 -0700
Removing scientific humanFileSize.
commit 0a09d0a6963afebed7f388aad71bbdd3151d2e9e
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 20:46:22 2022 -0700
Fixing active loader.
commit 07f4deeac861351d7483ef57278eb2e0941e31fb
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 20:40:44 2022 -0700
Increasing recommended map file size.
commit af3ac492c81f4c8f84563a448bc272ae9334d32d
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 20:35:13 2022 -0700
Reworking logic order for simplicity. Fetching downloads on interval.
commit 3d9d31fcec87ed02ced7f67c34907faa5a3b54e5
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 20:24:39 2022 -0700
Handling when pbf import status are loading.
commit 3798961a48e7c9eb165ca4e4051f239dbb088d0c
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 19:53:50 2022 -0700
Fetching import status every 30 seconds.
commit f7a8193b0955d14ead8090aa74ce3c5a681b57ec
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 19:33:17 2022 -0700
Stopping renderd during installation.
commit 5bf050b59e0a6e391184596f5e6f0737dea1221d
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 19:26:59 2022 -0700
Removing duplciate serve.
commit 892e3315eeeb5d2516996b901a32a73a66dae078
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 19:22:14 2022 -0700
Setting bash flags in sub-install script.
commit d5d2acd2cd85e089c78aa85a27c5d966222a1347
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 19:20:19 2022 -0700
Moving bulk of installation script into separate script so the latest code will be used during initial installation.
commit ab030d8af834a4a8772edd06df360c51e72fbb02
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 18:40:34 2022 -0700
Removing mod_tile/ajt directory instead of entire contents of mod_tile. Showing import as relative to media directory.
commit c05199db4ecf56f4d096051b58689457882af12a
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 18:39:59 2022 -0700
Remvoing marker from map.
commit ba5df4cf62d61b55281277a6254836e973c766ae
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 11:57:41 2022 -0700
Creating import_map.sh script.
commit 1a16e46130e775efe375adb22917ba12e44855cd
Author: Roland <roland@learningselfreliance.com>
Date: Mon Mar 7 11:11:01 2022 -0700
Increasing ram usage during import to avoid hanging import.
commit 0f5ce1a9f806f1c0878dd804b04587b6340ffd16
Author: Roland <roland@learningselfreliance.com>
Date: Sat Mar 5 19:19:47 2022 -0700
Increasing map_file.size size.
commit eb6e01512af59fb4a18ab15643c7bc61f3d48e53
Author: Roland <roland@learningselfreliance.com>
Date: Sat Mar 5 18:55:55 2022 -0700
Copying leaflet js/css files into docker container and to Apache directory so they will be available offline.
commit 5b687324e119f021673f42e8d079b83034b70d53
Author: Roland <roland@learningselfreliance.com>
Date: Sat Mar 5 18:36:06 2022 -0700
Matching tab height on Map page.
commit 8031786d672e18366e9a2eb2d7bdfcd8611d27f3
Author: Roland <roland@learningselfreliance.com>
Date: Sat Mar 5 18:34:20 2022 -0700
Shrinking HelpPopup Icon.
commit 5ea94488e43bbc5c414e61c9173a3cfa908c7104
Author: Roland <roland@learningselfreliance.com>
Date: Sat Mar 5 18:31:30 2022 -0700
Testing if no PBFs are requested to be imported.
commit c4e86be1faed78bd3af1f3487471c01a1958a433
Author: Roland <roland@learningselfreliance.com>
Date: Sat Mar 5 18:18:48 2022 -0700
Using Icon instead of Button for HelpPopup.
commit 51d94f6d85885803813544fea16a56372babaa82
Author: Roland <roland@learningselfreliance.com>
Date: Sat Mar 5 18:07:03 2022 -0700
PBF files are sorted by the api.
commit 40f3a7ff04a83db0153f64a88a37f1d56ce043aa
Author: Roland <roland@learningselfreliance.com>
Date: Fri Mar 4 18:35:51 2022 -0700
Adding help popup.
commit 1da8d9fa403ec2a3b3c16c11a3937de37c895a35
Author: Roland <roland@learningselfreliance.com>
Date: Fri Mar 4 09:41:01 2022 -0700
Moving message up. Clearing cached tiles after import.
commit 3192adf95192554c194c9e0a8aeb149822462682
Author: Roland <roland@learningselfreliance.com>
Date: Thu Mar 3 21:37:13 2022 -0700
Removing osm2pgsql from api docker because it seems to be unsupported.
commit 0e10522f3cdc7edd374c14f230bb2dbd68ab1a94
Author: Roland <roland@learningselfreliance.com>
Date: Thu Mar 3 21:36:39 2022 -0700
Disabling import button for docker. Adding download instructions.
commit e1d8f55d159fb4d4ef2ece859ef7cc1059885791
Author: Roland <roland@learningselfreliance.com>
Date: Thu Mar 3 21:14:55 2022 -0700
Map files can be imported on RPi.
commit 3128530e09968430a71b27cd2e75a567f85a708b
Author: Roland <roland@learningselfreliance.com>
Date: Thu Mar 3 15:31:54 2022 -0700
Adding shm_size to increase size to render large map tiles.
commit f3cf80fae0ce46f44ea9ac5033f68a32d0197ae3
Author: Roland <roland@learningselfreliance.com>
Date: Wed Mar 2 10:39:18 2022 -0700
Can get status of map imports.
commit 3b7bbce004cd55a5d89980c2c09124b72c450bc6
Author: Roland <roland@learningselfreliance.com>
Date: Tue Mar 1 20:51:13 2022 -0700
Adding map link to 50x.html. Swapping links using hostname to make it easier on the user.
commit a8b6b60fe182233f40c2f1ecd825636c3d37fd23
Author: Roland <roland@learningselfreliance.com>
Date: Tue Mar 1 12:01:50 2022 -0700
Moving Inventory link to end.
commit c5346b8dc2ff83262d6fd153130912809dfd7574
Author: Roland <roland@learningselfreliance.com>
Date: Tue Mar 1 12:00:47 2022 -0700
Squashed commit of the following:
commit 39f0b8f3fc049fffd140d551cd91d7d9dba6d416
Author: Roland <roland@learningselfreliance.com>
Date: Tue Mar 1 12:00:13 2022 -0700
Starting map refresh function.
commit 2fac9ddf07e378389ddd85ca972f33b3323d30ac
Author: Roland <roland@learningselfreliance.com>
Date: Mon Feb 28 16:43:47 2022 -0700
Updating readme with map requirements.
commit 8325e1ea89537128329e313ab4b5588f8809d1c9
Author: Roland <roland@learningselfreliance.com>
Date: Mon Feb 28 16:05:35 2022 -0700
Fixing order of map db init scripts. Creating index.html to display map. Using :8084 index file to display the map.
commit 8f81539dd9d25fc26607f472c156d41ddcfc11f5
Author: Roland <roland@learningselfreliance.com>
Date: Sun Feb 27 19:17:14 2022 -0700
Installing apache2.
commit c7aaef07f8291070aeaf5e7df553e34aca0719ec
Author: Roland <roland@learningselfreliance.com>
Date: Sun Feb 27 18:41:07 2022 -0700
Always configure postgres extensions. Initialize gis with dc.
commit aa725ed4b8ec46d17accebd96dd41508ea2d9caf
Author: Roland <roland@learningselfreliance.com>
Date: Sun Feb 27 15:48:20 2022 -0700
Map is displayed as iframe.
commit de9bb92dcaf44996e7727adce7774f01895ddf52
Author: Roland <roland@learningselfreliance.com>
Date: Sun Feb 27 12:16:56 2022 -0700
Running script in openstreetmap directory.
commit f277388095d2221aa6407643ab655f26dc349eb7
Author: Roland <roland@learningselfreliance.com>
Date: Sun Feb 27 12:06:41 2022 -0700
Bumping version for map.
commit afd4aaeffb2aced2dc5c1a8f94038885c8287265
Author: Roland <roland@learningselfreliance.com>
Date: Sun Feb 27 11:59:31 2022 -0700
Checking that the installation script is on an rpi.
commit a799382ceac3c201fc01d41fd63e37607282831a
Author: Roland <roland@learningselfreliance.com>
Date: Sun Feb 27 11:49:21 2022 -0700
Only running mod_tile install once.
commit 0b98bb19cd4d86c9630a863cab4eb46410d1c9d1
Author: Roland <roland@learningselfreliance.com>
Date: Fri Feb 25 11:31:21 2022 -0700
Building out map install script.
commit 7c799775c11df573fa6cd65451adea28c0832cb0
Author: Roland <roland@learningselfreliance.com>
Date: Thu Feb 24 12:16:53 2022 -0700
Creating OSM installation script.
commit d3b93a3ee97d1ae4a00b6a0423ed59ea8b897ccd
Author: Roland <roland@learningselfreliance.com>
Date: Tue Feb 22 15:39:04 2022 -0700
Removing unused map module.
340 lines
11 KiB
Python
340 lines
11 KiB
Python
import json
|
|
import multiprocessing
|
|
import re
|
|
from datetime import datetime, date
|
|
from decimal import Decimal
|
|
from functools import wraps
|
|
from http import HTTPStatus
|
|
from pathlib import Path
|
|
from typing import Union
|
|
|
|
from pytz import UnknownTimeZoneError
|
|
from sanic import Sanic, response, Blueprint, __version__ as sanic_version
|
|
from sanic.blueprint_group import BlueprintGroup
|
|
from sanic.request import Request
|
|
from sanic.response import HTTPResponse
|
|
from sanic_ext import validate
|
|
from sanic_ext.extensions.openapi import openapi
|
|
|
|
from wrolpi import admin
|
|
from wrolpi.common import set_sanic_url_parts, logger, get_config, wrol_mode_enabled, Base, get_media_directory, \
|
|
wrol_mode_check, native_only, set_wrol_mode
|
|
from wrolpi.dates import set_timezone
|
|
from wrolpi.downloader import download_manager
|
|
from wrolpi.errors import WROLModeEnabled, InvalidTimezone, API_ERRORS, APIError, ValidationError, HotspotError
|
|
from wrolpi.media_path import MediaPath
|
|
from wrolpi.schema import RegexRequest, RegexResponse, SettingsRequest, SettingsResponse, DownloadRequest, EchoResponse
|
|
from wrolpi.vars import DOCKERIZED
|
|
from wrolpi.version import __version__
|
|
|
|
logger = logger.getChild(__name__)
|
|
|
|
api_app = Sanic(name='api_app')
|
|
|
|
DEFAULT_HOST, DEFAULT_PORT = '127.0.0.1', '8081'
|
|
|
|
root_api = Blueprint('RootAPI', url_prefix='/api')
|
|
|
|
BLUEPRINTS = [root_api, ]
|
|
|
|
|
|
def get_blueprint(name: str, url_prefix: str) -> Blueprint:
|
|
"""
|
|
Create a new Sanic blueprint. This will be attached to the app just before run. See `root_api.run_webserver`.
|
|
"""
|
|
bp = Blueprint(name, url_prefix)
|
|
add_blueprint(bp)
|
|
return bp
|
|
|
|
|
|
def add_blueprint(bp: Union[Blueprint, BlueprintGroup]):
|
|
BLUEPRINTS.append(bp)
|
|
|
|
|
|
def run_webserver(loop, host: str, port: int, workers: int = 8):
|
|
set_sanic_url_parts(host, port)
|
|
|
|
# Attach all blueprints after they have been defined.
|
|
for bp in BLUEPRINTS:
|
|
api_app.blueprint(bp)
|
|
|
|
# TODO remove the auto reload when development is stable
|
|
kwargs = dict(host=host, port=port, workers=workers, auto_reload=DOCKERIZED)
|
|
logger.debug(f'Running Sanic {sanic_version} with kwargs {kwargs}')
|
|
return api_app.run(**kwargs)
|
|
|
|
|
|
def init_parser(parser):
|
|
# Called by WROLPI's main() function
|
|
parser.add_argument('-H', '--host', default=DEFAULT_HOST, help='What network interface to connect webserver')
|
|
parser.add_argument('-p', '--port', default=DEFAULT_PORT, type=int, help='What port to connect webserver')
|
|
parser.add_argument('-w', '--workers', default=multiprocessing.cpu_count(), type=int,
|
|
help='How many web workers to run')
|
|
|
|
|
|
def main(loop, args):
|
|
return run_webserver(loop, args.host, args.port, args.workers)
|
|
|
|
|
|
index_html = '''
|
|
<html>
|
|
<body>
|
|
<p>
|
|
This is a WROLPi API.
|
|
<ul>
|
|
<li>You can test it at this endpoint <a href="/api/echo">/api/echo</a></li>
|
|
<li>You can view the docs at <a href="/docs">/docs</a></li>
|
|
</ul>
|
|
</p>
|
|
</body>
|
|
</html>
|
|
'''
|
|
|
|
|
|
@api_app.get('/')
|
|
def index(_):
|
|
return response.html(index_html)
|
|
|
|
|
|
@root_api.route('/echo', methods=['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS'])
|
|
@openapi.description('Echo whatever is sent to this.')
|
|
@openapi.response(HTTPStatus.OK, EchoResponse)
|
|
async def echo(request: Request):
|
|
ret = dict(
|
|
form=request.form,
|
|
headers=dict(request.headers),
|
|
json=request.json,
|
|
method=request.method,
|
|
args=request.args,
|
|
)
|
|
return response.json(ret)
|
|
|
|
|
|
@root_api.route('/settings', methods=['GET', 'OPTIONS'])
|
|
@openapi.description('Get WROLPi settings')
|
|
@openapi.response(HTTPStatus.OK, SettingsResponse)
|
|
def get_settings(_: Request):
|
|
config = get_config()
|
|
|
|
settings = {
|
|
'download_on_startup': config.download_on_startup,
|
|
'hotspot_on_startup': config.hotspot_on_startup,
|
|
'hotspot_status': admin.hotspot_status().name,
|
|
'media_directory': get_media_directory(),
|
|
'throttle_on_startup': config.throttle_on_startup,
|
|
'throttle_status': admin.throttle_status().name,
|
|
'timezone': config.timezone,
|
|
'version': __version__,
|
|
'wrol_mode': config.wrol_mode,
|
|
}
|
|
return json_response(settings)
|
|
|
|
|
|
@root_api.patch('/settings')
|
|
@openapi.description('Update WROLPi settings')
|
|
@validate(json=SettingsRequest)
|
|
def update_settings(_: Request, body: SettingsRequest):
|
|
if wrol_mode_enabled() and body.wrol_mode is None:
|
|
# Cannot update settings while WROL Mode is enabled, unless you want to disable WROL Mode.
|
|
raise WROLModeEnabled()
|
|
|
|
if body.wrol_mode is False:
|
|
# Disable WROL Mode
|
|
set_wrol_mode(False)
|
|
return response.empty()
|
|
elif body.wrol_mode is True:
|
|
# Enable WROL Mode
|
|
set_wrol_mode(True)
|
|
return response.empty()
|
|
|
|
try:
|
|
if body.timezone:
|
|
set_timezone(body.timezone)
|
|
except UnknownTimeZoneError:
|
|
raise InvalidTimezone(f'Invalid timezone: {body.timezone}')
|
|
|
|
# Remove any keys with None values, then save the config.
|
|
config = {k: v for k, v in body.__dict__.items() if v is not None}
|
|
wrolpi_config = get_config()
|
|
wrolpi_config.update(config)
|
|
|
|
if body.wrol_mode:
|
|
download_manager.kill()
|
|
|
|
if body.hotspot_status is True:
|
|
# Turn on Hotspot
|
|
if admin.enable_hotspot() is False:
|
|
raise HotspotError('Could not turn on hotspot')
|
|
elif body.hotspot_status is False:
|
|
# Turn off Hotspot
|
|
if admin.disable_hotspot() is False:
|
|
raise HotspotError('Could not turn off hotspot')
|
|
|
|
return response.empty()
|
|
|
|
|
|
@root_api.post('/valid_regex')
|
|
@openapi.description('Check if the regex is valid.')
|
|
@openapi.response(HTTPStatus.OK, RegexResponse)
|
|
@openapi.response(HTTPStatus.BAD_REQUEST, RegexResponse)
|
|
@validate(RegexRequest)
|
|
def valid_regex(_: Request, body: RegexRequest):
|
|
try:
|
|
re.compile(body.regex)
|
|
return response.json({'valid': True, 'regex': body.regex})
|
|
except re.error:
|
|
return response.json({'valid': False, 'regex': body.regex}, HTTPStatus.BAD_REQUEST)
|
|
|
|
|
|
@root_api.post('/download')
|
|
@openapi.description('Download the many URLs that are provided.')
|
|
@validate(DownloadRequest)
|
|
@wrol_mode_check
|
|
async def post_download(_: Request, body: DownloadRequest):
|
|
# URLs are provided in a textarea, lets split all lines.
|
|
urls = [i.strip() for i in str(body.urls).strip().splitlines()]
|
|
downloader = body.downloader
|
|
if not downloader or downloader in ('auto', 'None', 'null'):
|
|
downloader = None
|
|
download_manager.create_downloads(urls, downloader=downloader, reset_attempts=True)
|
|
return response.empty()
|
|
|
|
|
|
@root_api.get('/download')
|
|
@openapi.description('Get all Downloads that need to be processed.')
|
|
async def get_downloads(_: Request):
|
|
data = download_manager.get_fe_downloads()
|
|
return json_response(data)
|
|
|
|
|
|
@root_api.post('/download/<download_id:int>/kill')
|
|
@openapi.description('Kill a download. It will be stopped if it is pending.')
|
|
async def kill_download(_: Request, download_id: int):
|
|
download_manager.kill_download(download_id)
|
|
return response.empty()
|
|
|
|
|
|
@root_api.post('/download/kill')
|
|
@openapi.description('Kill all downloads. Disable downloading.')
|
|
async def kill_downloads(_: Request):
|
|
download_manager.kill()
|
|
return response.empty()
|
|
|
|
|
|
@root_api.post('/download/enable')
|
|
@openapi.description('Enable and start downloading.')
|
|
async def enable_downloads(_: Request):
|
|
download_manager.enable()
|
|
return response.empty()
|
|
|
|
|
|
@root_api.delete('/download/<download_id:integer>')
|
|
@openapi.description('Delete a download')
|
|
@wrol_mode_check
|
|
async def delete_download(_: Request, download_id: int):
|
|
deleted = download_manager.delete_download(download_id)
|
|
return response.empty(HTTPStatus.NO_CONTENT if deleted else HTTPStatus.NOT_FOUND)
|
|
|
|
|
|
@root_api.get('/downloaders')
|
|
@openapi.description('List all Downloaders that can be specified by the user.')
|
|
async def get_downloaders(_: Request):
|
|
downloaders = download_manager.list_downloaders()
|
|
downloaders.insert(0, dict(name='auto', pretty_name='Automatic'))
|
|
disabled = download_manager.disabled.is_set()
|
|
ret = dict(downloaders=downloaders, manager_disabled=disabled)
|
|
return json_response(ret)
|
|
|
|
|
|
@root_api.post('/hotspot/on')
|
|
@openapi.description('Turn on the hotspot')
|
|
@native_only
|
|
async def hotspot_on(_: Request):
|
|
result = admin.enable_hotspot()
|
|
if result:
|
|
return response.empty()
|
|
return response.empty(HTTPStatus.INTERNAL_SERVER_ERROR)
|
|
|
|
|
|
@root_api.post('/hotspot/off')
|
|
@openapi.description('Turn off the hotspot')
|
|
@native_only
|
|
async def hotspot_off(_: Request):
|
|
result = admin.disable_hotspot()
|
|
if result:
|
|
return response.empty()
|
|
return response.empty(HTTPStatus.INTERNAL_SERVER_ERROR)
|
|
|
|
|
|
@root_api.post('/throttle/on')
|
|
@openapi.description('Turn on CPU throttling')
|
|
@native_only
|
|
async def throttle_on(_: Request):
|
|
result = admin.throttle_cpu_on()
|
|
if result:
|
|
return response.empty()
|
|
return response.empty(HTTPStatus.INTERNAL_SERVER_ERROR)
|
|
|
|
|
|
@root_api.post('/throttle/off')
|
|
@openapi.description('Turn off CPU throttling')
|
|
@native_only
|
|
async def throttle_off(_: Request):
|
|
result = admin.throttle_cpu_off()
|
|
if result:
|
|
return response.empty()
|
|
return response.empty(HTTPStatus.INTERNAL_SERVER_ERROR)
|
|
|
|
|
|
class CustomJSONEncoder(json.JSONEncoder):
|
|
|
|
def default(self, obj):
|
|
try:
|
|
if hasattr(obj, '__json__'):
|
|
# Get __json__ before others.
|
|
return obj.__json__()
|
|
elif isinstance(obj, datetime):
|
|
return obj.timestamp()
|
|
elif isinstance(obj, date):
|
|
return datetime(obj.year, obj.month, obj.day).timestamp()
|
|
elif isinstance(obj, Decimal):
|
|
return str(obj)
|
|
elif isinstance(obj, Base):
|
|
if hasattr(obj, 'dict'):
|
|
return obj.dict()
|
|
elif isinstance(obj, Path):
|
|
return str(obj)
|
|
elif isinstance(obj, MediaPath):
|
|
media_directory = get_media_directory()
|
|
path = obj.path.relative_to(media_directory)
|
|
if str(path) == '.':
|
|
return ''
|
|
return str(path)
|
|
return super(CustomJSONEncoder, self).default(obj)
|
|
except Exception as e:
|
|
logger.fatal(f'Failed to JSON encode {obj}', exc_info=e)
|
|
raise
|
|
|
|
|
|
@wraps(response.json)
|
|
def json_response(*a, **kwargs) -> HTTPResponse:
|
|
"""
|
|
Handles encoding date/datetime in JSON.
|
|
"""
|
|
resp = response.json(*a, **kwargs, cls=CustomJSONEncoder, dumps=json.dumps)
|
|
return resp
|
|
|
|
|
|
def json_error_handler(request, exception: Exception):
|
|
error = API_ERRORS[type(exception)]
|
|
if isinstance(exception, ValidationError):
|
|
body = dict(error='Could not validate the contents of the request', code=error['code'])
|
|
else:
|
|
body = dict(message=str(exception), api_error=error['message'], code=error['code'])
|
|
if cause := exception.__cause__:
|
|
cause = API_ERRORS[type(cause)]
|
|
body['cause'] = dict(error=cause['message'], code=cause['code'])
|
|
return json_response(body, error['status'])
|
|
|
|
|
|
api_app.error_handler.add(APIError, json_error_handler)
|