univention.portal package

class univention.portal.Plugin(name, bases, attrs)

Bases: type

Meta class for plugins.

class univention.portal.Plugins(python_path: str)

Bases: object

Register Plugin subclasses and iterate over them.

Parameters:

python_path (str) – fully dotted Python path that the plugins will be found below

classmethod add_plugin(plugin: Plugin) → None

Called by Plugin meta class to register a new Plugin subclass.

Parameters:

plugin (type) – a Plugin subclass

load() → None

Load plugins.

univention.portal.get_all_dynamic_classes() → Iterator[Plugin]

univention.portal.get_dynamic_classes(klass_name: str) → Plugin

Subpackages

• univention.portal.extensions package
  • Submodules
  • univention.portal.extensions.authenticator module
    • Session
      • Session.is_valid()
    • Authenticator
      • Authenticator.get_auth_mode()
      • Authenticator.login_request()
      • Authenticator.login_user()
      • Authenticator.logout_user()
      • Authenticator.get_user()
      • Authenticator.refresh()
    • UMCAuthenticator
      • UMCAuthenticator.get_auth_mode()
      • UMCAuthenticator.refresh()
      • UMCAuthenticator.get_user()
    • UMCAndSecretAuthenticator
      • UMCAndSecretAuthenticator.get_user()
  • univention.portal.extensions.cache module
    • Cache
      • Cache.get_id()
      • Cache.get()
      • Cache.refresh()
    • PortalFileCache
      • PortalFileCache.get_user_links()
      • PortalFileCache.get_entries()
      • PortalFileCache.get_folders()
      • PortalFileCache.get_portal()
      • PortalFileCache.get_categories()
      • PortalFileCache.get_menu_links()
      • PortalFileCache.get_announcements()
    • GroupFileCache
  • univention.portal.extensions.demo_reloader module
    • DemoPortalReloader
  • univention.portal.extensions.portal module
    • Portal
      • Portal.get_cache_id()
      • Portal.get_user()
      • Portal.login_user()
      • Portal.login_request()
      • Portal.logout_user()
      • Portal.get_visible_content()
      • Portal.get_user_links()
      • Portal.get_menu_links()
      • Portal.get_entries()
      • Portal.get_folders()
      • Portal.get_categories()
      • Portal.auth_mode()
      • Portal.may_be_edited()
      • Portal.get_meta()
      • Portal.get_announcements()
      • Portal.refresh()
      • Portal.score()
    • UMCPortal
      • UMCPortal.auth_mode()
      • UMCPortal.may_be_edited()
      • UMCPortal.get_visible_content()
      • UMCPortal.get_user_links()
      • UMCPortal.get_menu_links()
      • UMCPortal.get_entries()
      • UMCPortal.get_folders()
      • UMCPortal.get_categories()
      • UMCPortal.get_meta()
      • UMCPortal.get_announcements()
      • UMCPortal.refresh()
      • UMCPortal.get_cache_id()
  • univention.portal.extensions.reloader module
    • Reloader
      • Reloader.refresh()
    • MtimeBasedLazyFileReloader
      • MtimeBasedLazyFileReloader.refresh()
    • PortalReloaderUDM
    • GroupsReloaderLDAP
  • univention.portal.extensions.scorer module
    • Scorer
      • Scorer.score()
    • DomainScorer
      • DomainScorer.score()
    • PathScorer
      • PathScorer.score()
• univention.portal.handlers package
  • Submodules
  • univention.portal.handlers.auth_handlers module
    • LoginHandler
      • LoginHandler.post()
      • LoginHandler.get()
    • LogoutHandler
      • LogoutHandler.get()
  • univention.portal.handlers.navigation_handler module
    • NavigationHandler
      • NavigationHandler.get()
  • univention.portal.handlers.portal_entries_handler module
    • PortalEntriesHandler
      • PortalEntriesHandler.get()
  • univention.portal.handlers.portal_resource module
    • PortalResource
      • PortalResource.initialize()
      • PortalResource.prepare()
      • PortalResource.write_error()
      • PortalResource.find_portal()
      • PortalResource.reverse_abs_url()

Submodules

univention.portal.config module

univention.portal.config.load()

univention.portal.config.fetch(key)

univention.portal.factory module

univention.portal.factory.make_arg(arg_definition)

univention.portal.factory.make_portal(portal_definition)

univention.portal.log module

class univention.portal.log.ShortNameFormatter(fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)

Bases: Formatter

Initialize the formatter with specified format strings.

Initialize the formatter either with the specified format string, or a default as described above. Allow for specialized date formatting with the optional datefmt argument. If datefmt is omitted, you get an ISO8601-like (or RFC 3339-like) format.

Use a style parameter of ‘%’, ‘{’ or ‘$’ to specify that you want to use one of %-formatting, str.format() ({}) formatting or string.Template formatting in your format string.

Changed in version 3.2: Added the style parameter.

shorten = 'univention.portal'

format(record)

Format the specified record as text.

The record’s attribute dictionary is used as the operand to a string formatting operation which yields the returned string. Before formatting the dictionary, a couple of preparatory steps are carried out. The message attribute of the record is computed using LogRecord.getMessage(). If the formatting string uses the time (as determined by a call to usesTime(), formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message.

univention.portal.log.setup_logger(logfile='/var/log/univention/portal.log', stream=True)

univention.portal.log.get_logger(name)

univention.portal.main module

univention.portal.main.make_app(portal_definitions)

univention.portal.main.build_routes(portals)

univention.portal.user module

class univention.portal.user.User(username, display_name, groups, headers)

Bases: object

is_admin()

is_anonymous()

is_member_of(group)

univention.portal.util module

univention.portal.util.is_current_time_between(start_iso_datetime_str: str, end_iso_datetime_str: str) → bool

Return if the current system time (datetime.now()) lies within the given range. In case, start is later than end, ignore both.

start_iso_datetime_strstr

the first point in time that is in range

end_iso_datetime_strstr

the last point in time that is in range

return: bool

is datetime.now() between start_iso_datetime_str and end_iso_datetime_str, including boundaries