OpenSlides/openslides/utils/main.py

345 lines
12 KiB
Python
Raw Normal View History

import argparse
import ctypes
import os
import sys
2013-10-12 21:30:34 +02:00
import tempfile
import threading
import time
import webbrowser
2017-08-24 12:26:55 +02:00
from typing import Dict, Optional
from django.conf import ENVIRONMENT_VARIABLE
from django.core.exceptions import ImproperlyConfigured
from django.utils.crypto import get_random_string
2017-08-24 12:26:55 +02:00
from mypy_extensions import NoReturn
2015-01-16 14:18:34 +01:00
DEVELOPMENT_VERSION = 'Development Version'
UNIX_VERSION = 'Unix Version'
WINDOWS_VERSION = 'Windows Version'
WINDOWS_PORTABLE_VERSION = 'Windows Portable Version'
2013-10-12 21:30:34 +02:00
class PortableDirNotWritable(Exception):
pass
2013-11-06 17:49:41 +01:00
class PortIsBlockedError(Exception):
pass
class DatabaseInSettingsError(Exception):
pass
2015-01-16 14:18:34 +01:00
class UnknownCommand(Exception):
pass
class ExceptionArgumentParser(argparse.ArgumentParser):
2017-08-24 12:26:55 +02:00
def error(self, message: str) -> NoReturn:
2015-01-16 14:18:34 +01:00
raise UnknownCommand(message)
2017-08-24 12:26:55 +02:00
def detect_openslides_type() -> str:
"""
Returns the type of this OpenSlides version.
"""
if sys.platform == 'win32':
if os.path.basename(sys.executable).lower() == 'openslides.exe':
# Note: sys.executable is the path of the *interpreter*
# the portable version embeds python so it *is* the interpreter.
# The wrappers generated by pip and co. will spawn the usual
# python(w).exe, so there is no danger of mistaking them
# for the portable even though they may also be called
# openslides.exe
openslides_type = WINDOWS_PORTABLE_VERSION
else:
openslides_type = WINDOWS_VERSION
else:
openslides_type = UNIX_VERSION
return openslides_type
2018-08-08 21:09:22 +02:00
def get_default_settings_dir(openslides_type: str = None) -> str:
"""
Returns the default settings path according to the OpenSlides type.
The argument 'openslides_type' has to be one of the three types mentioned in
openslides.utils.main.
"""
2015-01-16 14:18:34 +01:00
if openslides_type is None:
openslides_type = detect_openslides_type()
if openslides_type == UNIX_VERSION:
parent_directory = os.environ.get(
2015-01-16 14:18:34 +01:00
'XDG_CONFIG_HOME', os.path.expanduser('~/.config'))
elif openslides_type == WINDOWS_VERSION:
parent_directory = get_win32_app_data_dir()
elif openslides_type == WINDOWS_PORTABLE_VERSION:
parent_directory = get_win32_portable_dir()
else:
raise TypeError('%s is not a valid OpenSlides type.' % openslides_type)
return os.path.join(parent_directory, 'openslides')
def get_local_settings_dir() -> str:
2015-01-16 14:18:34 +01:00
"""
Returns the path to a local settings.
2015-01-16 14:18:34 +01:00
On Unix systems: 'personal_data/var/'
2015-01-16 14:18:34 +01:00
"""
return os.path.join('personal_data', 'var')
2015-01-16 14:18:34 +01:00
2018-08-08 21:09:22 +02:00
def setup_django_settings_module(settings_path: str = None, local_installation: bool = False) -> None:
"""
Sets the environment variable ENVIRONMENT_VARIABLE, that means
'DJANGO_SETTINGS_MODULE', to the given settings.
2015-01-16 14:18:34 +01:00
If no settings_path is given and the environment variable is already set,
then this function does nothing.
If the argument settings_path is set, then the environment variable is
always overwritten.
"""
2017-08-24 12:26:55 +02:00
if settings_path is None and os.environ.get(ENVIRONMENT_VARIABLE, ""):
2015-01-16 14:18:34 +01:00
return
if settings_path is None:
if local_installation:
settings_dir = get_local_settings_dir()
2015-01-16 14:18:34 +01:00
else:
settings_dir = get_default_settings_dir()
settings_path = os.path.join(settings_dir, 'settings.py')
2015-01-16 14:18:34 +01:00
settings_file = os.path.basename(settings_path)
settings_module_name = ".".join(settings_file.split('.')[:-1])
if '.' in settings_module_name:
raise ImproperlyConfigured("'.' is not an allowed character in the settings-file")
2015-01-16 14:18:34 +01:00
# Change the python path. Also set the environment variable python path, so
# change of the python path also works after a reload
settings_module_dir = os.path.abspath(os.path.dirname(settings_path))
sys.path.insert(0, settings_module_dir)
try:
os.environ['PYTHONPATH'] = os.pathsep.join((settings_module_dir, os.environ['PYTHONPATH']))
except KeyError:
# The environment variable is empty
os.environ['PYTHONPATH'] = settings_module_dir
2015-01-16 14:18:34 +01:00
# Set the environment variable to the settings module
os.environ[ENVIRONMENT_VARIABLE] = settings_module_name
2018-08-08 21:09:22 +02:00
def get_default_settings_context(user_data_dir: str = None) -> Dict[str, str]:
"""
Returns the default context values for the settings template:
'openslides_user_data_path', 'import_function' and 'debug'.
The argument 'user_data_path' is a given path for user specific data or None.
"""
# Setup path for user specific data (SQLite3 database, media, ...):
# Take it either from command line or get default path
default_context = {}
if user_data_dir:
default_context['openslides_user_data_dir'] = repr(user_data_dir)
default_context['import_function'] = ''
else:
openslides_type = detect_openslides_type()
if openslides_type == WINDOWS_PORTABLE_VERSION:
default_context['openslides_user_data_dir'] = 'get_win32_portable_user_data_dir()'
default_context['import_function'] = 'from openslides.utils.main import get_win32_portable_user_data_dir'
else:
data_dir = get_default_user_data_dir(openslides_type)
default_context['openslides_user_data_dir'] = repr(os.path.join(data_dir, 'openslides'))
default_context['import_function'] = ''
default_context['debug'] = 'False'
return default_context
def get_default_user_data_dir(openslides_type: str) -> str:
"""
Returns the default directory for user specific data according to the OpenSlides
type.
The argument 'openslides_type' has to be one of the three types mentioned
in openslides.utils.main.
"""
if openslides_type == UNIX_VERSION:
default_user_data_dir = os.environ.get(
2015-01-16 14:18:34 +01:00
'XDG_DATA_HOME', os.path.expanduser('~/.local/share'))
elif openslides_type == WINDOWS_VERSION:
default_user_data_dir = get_win32_app_data_dir()
elif openslides_type == WINDOWS_PORTABLE_VERSION:
default_user_data_dir = get_win32_portable_dir()
else:
raise TypeError('%s is not a valid OpenSlides type.' % openslides_type)
return default_user_data_dir
def get_win32_app_data_dir() -> str:
"""
Returns the directory of Windows' AppData directory.
"""
shell32 = ctypes.WinDLL('shell32.dll') # type: ignore
SHGetFolderPath = shell32.SHGetFolderPathW
SHGetFolderPath.argtypes = (
ctypes.c_void_p, ctypes.c_int, ctypes.c_void_p, ctypes.c_uint32,
ctypes.c_wchar_p)
SHGetFolderPath.restype = ctypes.c_uint32
CSIDL_LOCAL_APPDATA = 0x001c
MAX_PATH = 260
buf = ctypes.create_unicode_buffer(MAX_PATH)
res = SHGetFolderPath(0, CSIDL_LOCAL_APPDATA, 0, 0, buf)
if res != 0:
# TODO: Write other exception
raise Exception("Could not determine Windows' APPDATA path")
2018-08-20 21:01:30 +02:00
return buf.value # type: ignore
def get_win32_portable_dir() -> str:
"""
Returns the directory of the Windows portable version.
"""
# NOTE: sys.executable will be the path to openslides.exe
# since it is essentially a small wrapper that embeds the
# python interpreter
portable_dir = os.path.dirname(os.path.abspath(sys.executable))
try:
fd, test_file = tempfile.mkstemp(dir=portable_dir)
except OSError:
2013-10-12 21:30:34 +02:00
raise PortableDirNotWritable(
'Portable directory is not writeable. '
'Please choose another directory for settings and data files.')
2013-10-12 21:30:34 +02:00
else:
os.close(fd)
os.unlink(test_file)
return portable_dir
def get_win32_portable_user_data_dir() -> str:
"""
Returns the user data directory to the Windows portable version.
"""
return os.path.join(get_win32_portable_dir(), 'openslides')
2018-08-08 21:09:22 +02:00
def write_settings(settings_dir: str = None, settings_filename: str = 'settings.py', template: str = None, **context: str) -> str:
"""
Creates the settings file at the given dir using the given values for the
file template.
2015-01-16 14:18:34 +01:00
Retuns the path to the created settings.
"""
if settings_dir is None:
settings_dir = get_default_settings_dir()
settings_path = os.path.join(settings_dir, settings_filename)
2015-01-16 14:18:34 +01:00
if template is None:
with open(os.path.join(os.path.dirname(__file__), 'settings.py.tpl')) as template_file:
template = template_file.read()
# Create a random SECRET_KEY to put it in the settings.
# from django.core.management.commands.startproject
chars = 'abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)'
context.setdefault('secret_key', get_random_string(50, chars))
2015-01-16 14:18:34 +01:00
for key, value in get_default_settings_context().items():
context.setdefault(key, value)
content = template % context
settings_module = os.path.realpath(settings_dir)
if not os.path.exists(settings_module):
os.makedirs(settings_module)
with open(settings_path, 'w') as settings_file:
settings_file.write(content)
if context['openslides_user_data_dir'] == 'get_win32_portable_user_data_dir()':
openslides_user_data_dir = get_win32_portable_user_data_dir()
else:
openslides_user_data_dir = context['openslides_user_data_dir'].strip("'")
os.makedirs(os.path.join(openslides_user_data_dir, 'static'), exist_ok=True)
2015-01-16 14:18:34 +01:00
return os.path.realpath(settings_path)
2017-08-24 12:26:55 +02:00
def open_browser(host: str, port: int) -> None:
"""
Launches the default web browser at the given host and port and opens
the webinterface. Uses start_browser internally.
"""
if host == '0.0.0.0':
# Windows does not support 0.0.0.0, so use 'localhost' instead
start_browser('http://localhost:%s' % port)
else:
start_browser('http://%s:%s' % (host, port))
2017-08-24 12:26:55 +02:00
def start_browser(browser_url: str) -> None:
"""
Launches the default web browser at the given url and opens the
webinterface.
"""
try:
browser = webbrowser.get()
except webbrowser.Error:
print('Could not locate runnable browser: Skipping start')
else:
2017-08-24 12:26:55 +02:00
def function() -> None:
# TODO: Use a nonblocking sleep event here. Tornado has such features.
time.sleep(1)
browser.open(browser_url)
thread = threading.Thread(target=function)
thread.start()
2017-08-24 12:26:55 +02:00
def get_database_path_from_settings() -> Optional[str]:
"""
Retrieves the database path out of the settings file. Returns None,
if it is not a SQLite3 database.
2015-01-16 14:18:34 +01:00
Needed for the backupdb command.
"""
from django.conf import settings as django_settings
from django.db import DEFAULT_DB_ALIAS
db_settings = django_settings.DATABASES
default = db_settings.get(DEFAULT_DB_ALIAS)
if not default:
raise DatabaseInSettingsError("Default databases is not configured")
database_path = default.get('NAME')
if not database_path:
raise DatabaseInSettingsError('No path or name specified for default database.')
if default.get('ENGINE') != 'django.db.backends.sqlite3':
database_path = None
return database_path
2017-08-24 12:26:55 +02:00
def is_local_installation() -> bool:
2015-01-16 14:18:34 +01:00
"""
Returns True if the command is called for a local installation
2015-01-16 14:18:34 +01:00
This is the case if manage.py is used, or when the --local-installation flag is set.
2015-01-16 14:18:34 +01:00
"""
return True if '--local-installation' in sys.argv or 'manage.py' in sys.argv[0] else False
2017-08-24 12:26:55 +02:00
def get_geiss_path() -> str:
"""
Returns the path and file to the Geiss binary.
"""
from django.conf import settings
download_dir = getattr(settings, 'OPENSLIDES_USER_DATA_PATH', '')
bin_name = 'geiss.exe' if is_windows() else 'geiss'
return os.path.join(download_dir, bin_name)
2017-08-24 12:26:55 +02:00
def is_windows() -> bool:
"""
Returns True if the current system is Windows. Returns False otherwise.
"""
return sys.platform == 'win32'