add siteappsettings plugin and form (#1304)

CHANGELOG.rst

@@ -25,6 +25,8 @@ Added
     - ``PermissionTestMixin.set_site_read_only()`` helper (#24)
     - ``PROJECTROLES_READ_ONLY_MSG`` setting (#24)
     - ``SiteReadOnlySettingAjaxView`` Ajax view (#24)
+    - ``siteappsettings`` site app plugin (#1304)
+    - ``SiteAppSettingsFormView`` view (#1304)
 
 Changed
 -------

docs/source/app_projectroles_basics.rst

@@ -168,7 +168,7 @@ Other Features
 
 Other features in the projectroles app:
 
-- **App settings**: Setting values for project or user specific variables,
+- **App settings**: Setting values for project, user or site specific variables,
   which can be defined in project and site app plugins
 - **Project starring**: Ability for users to star projects as their favourites
 - **Project search**: Functionality for searching data within projects using
@@ -178,7 +178,7 @@ Other features in the projectroles app:
 - **Custom user model**: Additions to the standard Django user model
 - **Multi-domain LDAP/AD support**: Support for LDAP/AD users from multiple
   domains
-- **SODAR Timeline integration**: Included but disabled unless the backend app
+- **Timeline integration**: Included but disabled unless the backend app
   for Timeline is enabled in your Django site
 
 

docs/source/app_projectroles_settings.rst

@@ -179,7 +179,7 @@ organizations, etc.
 Projectroles Settings
 =====================
 
-**Mandatory** projectroles app settings are explained below:
+**Mandatory** projectroles Django settings are explained below:
 
 ``PROJECTROLES_SITE_MODE``
     Site mode for remote project metadata synchronization, either ``SOURCE``
@@ -204,19 +204,22 @@ Projectroles Settings
 ``PROJECTROLES_TEMPLATE_INCLUDE_PATH``
     Full system path for custom template includes. The default path is
     ``{APPS_DIR}/templates/include`` (string)
+``PROJECTROLES_READ_ONLY_MSG``
+    Custom message to be displayed if site read-only mode is enabled (string)
 
 Example:
 
 .. code-block:: python
 
-    # Projectroles app settings
+    # Projectroles Django settings
     PROJECTROLES_SITE_MODE = env.str('PROJECTROLES_SITE_MODE', 'TARGET')
     PROJECTROLES_TARGET_CREATE = env.bool('PROJECTROLES_TARGET_CREATE', True)
     PROJECTROLES_INVITE_EXPIRY_DAYS = env.int('PROJECTROLES_INVITE_EXPIRY_DAYS', 14)
     PROJECTROLES_SEND_EMAIL = env.bool('PROJECTROLES_SEND_EMAIL', False)
     PROJECTROLES_EMAIL_SENDER_REPLY = env.bool('PROJECTROLES_EMAIL_SENDER_REPLY', False)
     PROJECTROLES_ENABLE_SEARCH = True
     PROJECTROLES_DEFAULT_ADMIN = env.str('PROJECTROLES_DEFAULT_ADMIN', 'admin')
+    PROJECTROLES_READ_ONLY_MSG = env.str('PROJECTROLES_READ_ONLY_MSG', None)
 
 
 Optional Projectroles Settings
@@ -280,7 +283,7 @@ Example:
 
 .. code-block:: python
 
-    # Projectroles app settings
+    # Projectroles Django settings
     # ...
     PROJECTROLES_EMAIL_HEADER = 'This email has been sent by X from Y'
     PROJECTROLES_EMAIL_FOOTER = 'For assistance contact admin@example.com'

docs/source/app_projectroles_usage.rst

@@ -50,8 +50,8 @@ Upon logging into a SODAR Core based Django site using default templates and CSS
 the general view of your site is split into the following elements:
 
 - **Top navigation bar**: Contains the site logo and title, search element, link
-  to advanced search, help link and the user dropdown menu.
-- **User dropdown menu**: Contains links to user management, admin site and
+  to advanced search, help link and the user dropdown.
+- **User dropdown**: Contains links to user management, admin site and
   site-wide apps the user has access to.
 - **Project sidebar**: Shortcuts to project apps and project management pages
 - **Project navigation**: Project structure breadcrumb (disabled for site apps)
@@ -364,6 +364,38 @@ out of the LDAP server. Use the ``-h`` flag to see additional options.
     $ ./manage.py checkusers
 
 
+Site App Settings
+=================
+
+Site-wide app settings, which are not tied to any project or user, can be
+altered by administrators by opening the :guilabel:`Site App Settings` view from
+their user dropdown. The form works similarly to the project app settings in the
+project creation and updating view.
+
+.. figure:: _static/app_projectroles/site_app_settings.png
+    :align: center
+    :scale: 60%
+
+    Site app settings view
+
+
+Site Read-Only Mode
+===================
+
+In :guilabel:`Site App Settings`, an administrator can temporarily set the site
+to read-only mode. When this mode is enabled, all data on the site is only
+accessible for reading. No project or user data should be modifiable. Once
+enabled, the mode must be explicitly disabled from the same form.
+
+While the mode is active, an alert will be displayed to all users that site data
+can currently not be modified.
+
+Once the mode has been disabled, the alert on existing browser views will be
+changed into one prompting the user to reload the current view. Reloading
+ensures all the UI elements are active in case not everything is updated on the
+client side.
+
+
 .. _app_projectroles_usage_remote:
 
 Remote Projects

docs/source/glossary.rst

@@ -11,8 +11,10 @@ Glossary
         including content and functionality from apps in SODAR Core views.
 
     App Settings
-        Project or user specific settings defined in SODAR Core app plugins.
-        Different from e.g. Django settings used to configure the web site.
+        Project, user or site specific settings defined in SODAR Core app
+        plugins. Different from e.g. Django settings used to configure the web
+        site in that they can be modified in runtime and from the SODAR Core UI
+        or REST API.
 
     Backend App
         SODAR Core application which is used to provide additional functionality

docs/source/major_changes.rst

@@ -17,6 +17,7 @@ Release Highlights
 ==================
 
 - Add site read-only mode
+- Add siteappsettings site app plugin
 - Add removeroles management command
 - Add app setting type constants
 - Add app setting definition as objects

projectroles/app_settings.py

@@ -138,7 +138,7 @@
         default=False,
         label='Site read-only mode',
         description='Set site in read-only mode. Data altering operations will '
-        'be prohibited. Mode must be explicitly unset to allow data'
+        'be prohibited. Mode must be explicitly unset to allow data '
         'modification.',
         user_modifiable=True,
         global_edit=False,