magpie.ui.utils =============== .. py:module:: magpie.ui.utils Attributes ---------- .. autoapisummary:: magpie.ui.utils.LOGGER Classes ------- .. autoapisummary:: magpie.ui.utils._ReContainsWrapper magpie.ui.utils.BaseViews magpie.ui.utils.AdminRequests Functions --------- .. autoapisummary:: magpie.ui.utils.check_response magpie.ui.utils.request_api magpie.ui.utils.redirect_error magpie.ui.utils.handle_errors Module Contents --------------- .. py:data:: LOGGER .. py:function:: check_response(response: magpie.typedefs.AnyResponseType) -> magpie.typedefs.AnyResponseType :returns: response if the HTTP status code is successful. :raises HTTPError: (of appropriate type) if the response corresponds to an HTTP error code .. py:function:: request_api(request: pyramid.request.Request, path: magpie.typedefs.Str, method: magpie.typedefs.Str = 'GET', data: Optional[Union[magpie.typedefs.JSON, magpie.typedefs.Str]] = None, headers: Optional[magpie.typedefs.HeadersType] = None, cookies: Optional[magpie.typedefs.CookiesType] = None) -> magpie.typedefs.AnyResponseType Use a pyramid sub-request to request Magpie API routes via the UI. This avoids max retries and closed connections when using 1 worker (eg: during tests). Some information is retrieved from :paramref:`request` to pass down to the sub-request (eg: cookies). If they are passed as argument, corresponding values will override the ones found in :paramref:`request`. All sub-requests to the API are assumed to be :py:data:`magpie.common.CONTENT_TYPE_JSON` unless explicitly overridden with :paramref:`headers`. Headers are also looked for additional ``Set-Cookie`` header in case they need to be passed down to :paramref:`cookies`. :param request: incoming Magpie UI request that requires sub-request to Magpie API, to retrieve required details. :param path: local Magpie API path (relative to root without URL). :param method: HTTP method to send the API sub-request. :param data: JSON dictionary or literal string content of the request body. :param headers: override headers to employ for the API sub-request. Defaults to JSON Accept & Content-Type headers. :param cookies: Override cookies to employ for the API sub-request. Defaults to current logged user. For empty cookies (no user), explicitly provide an empty dictionary. .. py:function:: redirect_error(request: pyramid.request.Request, code: int = None, content: Optional[magpie.typedefs.JSON] = None) -> magpie.typedefs.AnyResponseType Redirects the contents to be rendered by the UI 'error' page. :param request: incoming request that resulted into some kind of error. :param code: explicit HTTP status code for the error response, extracted from contents if otherwise available. :param content: any body content provided as error response from the API. .. py:function:: handle_errors(func: Callable) -> Callable Decorator that encapsulates the operation in a try/except block, and redirects the response to the UI error page with API error contents. In worst case scenario where the operation cannot figure out what to do with the exception response, raise the most basic :class:`HTTPInternalServerError` that can be formulated from available details. .. seealso:: :func:`redirect_error` .. py:class:: _ReContainsWrapper(regex='x^') Bases: :py:obj:`object` Class that wraps the re.search function with the __contains__ method. Used in BaseViews so that code in mako templates can continue to use syntax like: .. code-block:: python user_name in MAGPIE_FIXED_USERS .. py:attribute:: regex :value: 'x^' .. py:method:: __contains__(item: Any) -> bool .. py:class:: BaseViews(request) Bases: :py:obj:`object` Base methods for Magpie UI pages. .. py:attribute:: MAGPIE_FIXED_GROUP_MEMBERSHIPS Special :term:`Group` memberships that cannot be edited. .. py:attribute:: MAGPIE_FIXED_GROUP_EDITS Special :term:`Group` details that cannot be edited. .. py:attribute:: MAGPIE_FIXED_USERS Special :term:`User` details that cannot be edited. .. py:attribute:: MAGPIE_FIXED_USERS_REFS Special :term:`User` that cannot have any relationship edited. This includes both :term:`Group` memberships and :term:`Permission` references. .. py:attribute:: MAGPIE_USER_PWD_LOCKED Special :term:`User` that *could* self-edit themselves, but is disabled since conflicting with other policies. .. py:attribute:: MAGPIE_USER_PWD_DISABLED Special :term:`User` where password cannot be edited (managed by `Magpie` configuration settings). .. py:attribute:: MAGPIE_ANONYMOUS_GROUP :value: None Reference to :py:data:`magpie.constants.MAGPIE_ANONYMOUS_GROUP` for convenience in UI pages. .. py:attribute:: request .. py:attribute:: magpie_url .. py:attribute:: ui_theme .. py:attribute:: logged_user .. py:method:: add_template_data(data: Optional[Dict[magpie.typedefs.Str, Any]] = None) -> Dict[magpie.typedefs.Str, Any] Adds required template data for the 'heading' mako template applied to every UI page. .. py:method:: render(template: magpie.typedefs.Str, data: Optional[Dict[magpie.typedefs.Str, Any]] = None) -> pyramid.response.Response Render the response with an explicit Mako template reference. Views that are decorated by :func:`pyramid.view.view_config` or registered by :meth:`pyramid.config.Configurator.add_view` with a ``renderer`` parameter do not require to call this function as it is auto-resolved with the submitted :paramref:`data`. .. py:class:: AdminRequests(request) Bases: :py:obj:`BaseViews` Regroups multiple administration-level operations to be dispatched to the API requests. .. py:method:: create_user_default_template_data(data) Generates all the default values for the various fields employed for display purposes of the user creation form. :param data: any template data that should override the defaults. :return: updated template data with defaults and overridden values. .. seealso: :meth:`create_user` .. py:method:: get_admin_session() -> magpie.typedefs.CookiesType Temporarily login as default administrator to execute an elevated operation that the current user cannot make. .. warning:: Cookies *MUST NOT* be preserved or memorized, to avoid user gaining restricted access. This is intended only for basic operations such as validating information. Care must be taken such information retrieved this way do not provide a way of non-administrator to indirectly infer some otherwise protected information. User sparingly. :returns: Cookies of the administrator login. .. py:method:: get_all_groups(first_default_group=None) .. py:method:: get_group_info(group_name: magpie.typedefs.Str) -> magpie.typedefs.JSON .. py:method:: get_group_users(group_name: magpie.typedefs.Str, user_group_status: magpie.models.UserGroupStatus = UserGroupStatus.ACTIVE) -> List[magpie.typedefs.Str] .. py:method:: update_group_info(group_name: magpie.typedefs.Str, group_info: magpie.typedefs.JSON) -> magpie.typedefs.JSON .. py:method:: delete_group(group_name: magpie.typedefs.Str) -> magpie.typedefs.JSON .. py:method:: get_user_groups(user_name: magpie.typedefs.Str, user_group_status: magpie.models.UserGroupStatus = UserGroupStatus.ACTIVE) -> List[magpie.typedefs.Str] .. py:method:: get_user_names() Obtains all user names. .. py:method:: get_user_statuses(status: Union[magpie.typedefs.Str, int] = 0) -> List[magpie.typedefs.Str] Obtains all user names that have the corresponding status value. .. py:method:: get_user_emails() .. py:method:: get_user_details(status: Optional[Union[str, int]] = None, cookies: Optional[magpie.typedefs.CookiesType] = None) -> List[magpie.typedefs.JSON] Obtains all user details, optionally filtered to by corresponding status value. Employ this method to avoid multiple requests fetching individual information. .. seealso:: - :meth:`get_user_emails` - :meth:`get_user_names` - :meth:`get_user_statuses` .. py:method:: get_resource_types() :return: dictionary of all resources as {id: 'resource_type'} :rtype: dict .. py:method:: flatten_tree_resource(resource_node, resource_dict) :staticmethod: :param resource_node: any-level dictionary composing the resources tree :param resource_dict: reference of flattened dictionary across levels :return: flattened dictionary `resource_dict` of all {id: 'resource_type'} :rtype: dict .. py:method:: get_services(cur_svc_type) .. py:method:: get_service_data(service_name) .. py:method:: get_service_types() .. py:method:: update_service_name(old_service_name, new_service_name, service_push) .. py:method:: update_service_url(service_name, new_service_url, service_push) .. py:method:: create_user(data) Processes the user creation form with fields input data. All the fields are pre- and post-validated according to expected behaviour by the API. Pre-validations attempt *soft* checks to detect as many potential errors such that they can all be simultaneously displayed on the form, to avoid back-and-forth erroneous submissions by the user. Post-validations are the *hard* checks imposed by the API, which include some of the pre-checks. Whenever some failure occurs, returned data will contain ``is_error`` with ``True`` or ``False`` accordingly. Following successful request without error, the :term:`User` will be created. It is up to the calling function to redirect the response and further process the returned data as needed. :param data: initial templated data overrides according to who is initiation the user creation. :return: updated template data with any relevant error messages and statuses if applicable. :raises HTTPException: any unhandled or unknown HTTP error received from the API. .. seealso: :meth:`create_user_default_template_data`