mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
56250562d4
Tests performed: - Print the calls to _mount_static_directory() before and after the changes. They should print the same. - With English as the preferred language, visit the user manual. Images should be visible. Visit MediaWiki manual page with learn more link in MediaWiki. Images should be visible. - Repeat with Spanish as the preferred language. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: Veiko Aasa <veiko17@disroot.org>
130 lines
4.2 KiB
Python
130 lines
4.2 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""
|
|
Setup CherryPy web server.
|
|
"""
|
|
|
|
import logging
|
|
import os
|
|
|
|
import cherrypy
|
|
|
|
from . import app, cfg, log, module_loader, web_framework
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def _mount_static_directory(static_dir, static_url):
|
|
config = {
|
|
'/': {
|
|
'tools.staticdir.root': static_dir,
|
|
'tools.staticdir.on': True,
|
|
'tools.staticdir.dir': '.'
|
|
}
|
|
}
|
|
app = cherrypy.tree.mount(None, static_url, config)
|
|
log.setup_cherrypy_static_directory(app)
|
|
|
|
|
|
def init():
|
|
"""Setup CherryPy server"""
|
|
logger.info('Setting up CherryPy server')
|
|
|
|
# Configure default server
|
|
cherrypy.config.update({
|
|
'server.max_request_body_size': 0,
|
|
'server.socket_host': cfg.host,
|
|
'server.socket_port': cfg.port,
|
|
'server.thread_pool': 10,
|
|
# Avoid stating files once per second in production
|
|
'engine.autoreload.on': cfg.develop,
|
|
})
|
|
|
|
application = web_framework.get_wsgi_application()
|
|
cherrypy.tree.graft(application, cfg.server_dir)
|
|
|
|
static_dir = os.path.join(cfg.file_root, 'static')
|
|
_mount_static_directory(static_dir, web_framework.get_static_url())
|
|
|
|
custom_static_dir = cfg.custom_static_dir
|
|
custom_static_url = '/plinth/custom/static'
|
|
if os.path.exists(custom_static_dir):
|
|
_mount_static_directory(custom_static_dir, custom_static_url)
|
|
else:
|
|
logger.debug(
|
|
'Not serving custom static directory %s on %s, '
|
|
'directory does not exist', custom_static_dir, custom_static_url)
|
|
|
|
_mount_static_directory('/usr/share/javascript', '/javascript')
|
|
|
|
for module_name, module in module_loader.loaded_modules.items():
|
|
module_path = os.path.dirname(module.__file__)
|
|
static_dir = os.path.join(module_path, 'static')
|
|
if not os.path.isdir(static_dir):
|
|
continue
|
|
|
|
urlprefix = "%s%s" % (web_framework.get_static_url(), module_name)
|
|
_mount_static_directory(static_dir, urlprefix)
|
|
|
|
for component in StaticFiles.list():
|
|
component.mount()
|
|
|
|
cherrypy.engine.signal_handler.subscribe()
|
|
|
|
|
|
def run(on_web_server_stop):
|
|
"""Start the web server and block it until exit."""
|
|
cherrypy.engine.start()
|
|
cherrypy.engine.subscribe('stop', on_web_server_stop)
|
|
cherrypy.engine.block()
|
|
|
|
|
|
class StaticFiles(app.FollowerComponent):
|
|
"""Component to serve static files shipped with an app.
|
|
|
|
Any files in <app>/static directory will be automatically served on
|
|
/static/<app>/ directory by FreedomBox. This allows each app to ship custom
|
|
static files that are served by the web server.
|
|
|
|
However, in some rare circumstances, a system folder will need to be served
|
|
on a path for the app to work. This component allows declaring such
|
|
directories and the web paths they should be served on.
|
|
|
|
"""
|
|
|
|
_all_instances = {}
|
|
|
|
def __init__(self, component_id, directory_map=None):
|
|
"""Initialize the component.
|
|
|
|
component_id should be a unique ID across all components of an app and
|
|
across all components.
|
|
|
|
directory_map should be a dictionary with keys to be web paths and
|
|
values to be absolute path of the directory on disk to serve. The
|
|
static files from the directory are served over the given web path. The
|
|
web path will be prepended with the FreedomBox's configured base web
|
|
path. For example, {'/foo': '/usr/share/foo'} means that
|
|
'/usr/share/foo/bar.png' will be served over '/plinth/foo/bar.png' if
|
|
FreedomBox is configured to be served on '/plinth'.
|
|
|
|
"""
|
|
super().__init__(component_id)
|
|
self.directory_map = directory_map
|
|
self._all_instances[component_id] = self
|
|
|
|
@classmethod
|
|
def list(cls):
|
|
"""Return a list of all instances."""
|
|
return cls._all_instances.values()
|
|
|
|
def mount(self):
|
|
"""Perform configuration of the web server to handle static files.
|
|
|
|
Called by web server abstraction layer after web server has been setup.
|
|
|
|
"""
|
|
if self.directory_map:
|
|
for web_path, file_path in self.directory_map.items():
|
|
web_path = '%s%s' % (cfg.server_dir, web_path)
|
|
_mount_static_directory(file_path, web_path)
|