Source code for projectroles.utils

"""General utility methods for projectroles and SODAR Core"""

import logging
import random
import string

from django.conf import settings
from django.urls import reverse

from projectroles.plugins import get_active_plugins
from projectroles.models import SODAR_CONSTANTS


logger = logging.getLogger(__name__)


# SODAR constants
PROJECT_TYPE_PROJECT = SODAR_CONSTANTS['PROJECT_TYPE_PROJECT']
PROJECT_TYPE_CATEGORY = SODAR_CONSTANTS['PROJECT_TYPE_CATEGORY']

# Local constants
APP_NAME = 'projectroles'
SIDEBAR_ICON_MIN_SIZE = 18
SIDEBAR_ICON_MAX_SIZE = 42
ROLE_URLS = [
    'roles',
    'role_create',
    'role_update',
    'role_delete',
    'invites',
    'invite_create',
    'invite_resend',
    'invite_revoke',
]
USER_DISPLAY_DEPRECATE_MSG = 'The get_user_display_name() utility method has been deprecated and will be removed in v1.2. Use User.get_display_name() instead.'




[docs]
def get_display_name(key, title=False, count=1, plural=False):
    """
    Return display name from SODAR_CONSTANTS.

    :param key: Key in SODAR_CONSTANTS['DISPLAY_NAMES'] to return (string)
    :param title: Return name in title case if true (boolean, optional)
    :param count: Item count for returning plural form, overrides plural=False
                  if not 1 (int, optional)
    :param plural: Return plural form if True, overrides count != 1 if True
                   (boolean, optional)
    :return: String
    """
    ret = SODAR_CONSTANTS['DISPLAY_NAMES'][key][
        'plural' if count != 1 or plural else 'default'
    ]
    return ret.lower() if not title else ret.title()




# TODO: Deprecated, remove in v1.2 (see #1488)


[docs]
def get_user_display_name(user, inc_user=False):
    """
    Return full name of user for displaying.

    :param user: User object
    :param inc_user: Include user name if true (boolean)
    :return: String
    """
    logger.warning(USER_DISPLAY_DEPRECATE_MSG)
    return user.get_display_name(inc_user)






[docs]
def build_secret(length=None):
    """
    Return secret string for e.g. public URLs.

    :param length: Length of string, use None for default (integer or None)
    :return: Randomized secret (string)
    """
    if not length:
        length = getattr(settings, 'PROJECTROLES_SECRET_LENGTH', 32)
    length = int(length) if int(length) <= 255 else 255
    return ''.join(
        random.SystemRandom().choice(string.ascii_lowercase + string.digits)
        for _ in range(length)
    )






[docs]
def get_app_names():
    """Return list of names for locally installed non-django apps"""
    ret = []
    for a in settings.INSTALLED_APPS:
        s = a.split('.')
        if s[0] not in ['django', settings.SITE_PACKAGE]:
            if len(s) > 1 and 'apps' in s:
                ret.append('.'.join(s[0 : s.index('apps')]))
            else:
                ret.append(s[0])
    return sorted(ret)






[docs]
class AppLinkContent:
    """Class for generating application links for the UI"""

    @classmethod
    def _is_active_projectroles(
        cls, app_name=None, url_name=None, link_names=None
    ):
        """Check if current URL is active under the projectroles app"""
        if not app_name and not url_name:
            return False
        # HACK: Avoid circular import
        from projectroles.urls import urlpatterns

        if app_name != APP_NAME:
            return False
        return url_name in [u.name for u in urlpatterns] and (
            not link_names or url_name in link_names
        )

    @classmethod
    def _is_active_plugin(cls, app_plugin, app_name=None, url_name=None):
        """Check if current URL is active for a specific app plugin"""
        if not app_name and not url_name:
            return False
        if app_plugin.name.startswith(app_name) and (
            not url_name
            or url_name in [u.name for u in getattr(app_plugin, 'urls', [])]
        ):
            return True
        # Remote site views, see issue #1336
        if (
            app_name == APP_NAME
            and app_plugin.name == 'remotesites'
            and url_name.startswith('remote_')
        ):
            return True
        # Site app settings view
        if (
            app_name == APP_NAME
            and app_plugin.name == 'siteappsettings'
            and url_name == 'site_app_settings'
        ):
            return True
        return False

    @classmethod
    def _is_app_visible(cls, plugin, project, user):
        """Check if app should be visible for user in a specific project"""
        can_view_app = user.has_perm(plugin.app_permission, project)
        app_hidden = False
        if plugin.name in getattr(
            settings, 'PROJECTROLES_HIDE_PROJECT_APPS', []
        ):
            app_hidden = True
        if (
            can_view_app
            and not app_hidden
            and (project.type == PROJECT_TYPE_PROJECT or plugin.category_enable)
        ):
            return True
        return False

    @classmethod
    def _allow_project_creation(cls):
        """Check whether creating a project is allowed on the site"""
        if (
            settings.PROJECTROLES_SITE_MODE
            == SODAR_CONSTANTS['SITE_MODE_TARGET']
            and not settings.PROJECTROLES_TARGET_CREATE
        ):
            return False
        return True