mirror of
https://github.com/jwinterm/modoboa.git
synced 2026-10-17 05:41:25 +02:00
138 lines
4.1 KiB
Python
138 lines
4.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""Extension management."""
|
|
|
|
from django.conf import settings
|
|
from django.conf.urls import include, url
|
|
from django.utils.encoding import smart_str
|
|
|
|
|
|
class ModoExtension(object):
|
|
"""
|
|
Base extension class.
|
|
|
|
Each Modoboa extension must inherit from this class to be
|
|
considered as valid.
|
|
"""
|
|
|
|
name = None
|
|
label = None
|
|
version = "NA"
|
|
description = ""
|
|
needs_media = False
|
|
always_active = False
|
|
url = None
|
|
topredirection_url = None
|
|
|
|
def get_url(self):
|
|
"""Return extension base url."""
|
|
if self.url is None:
|
|
return self.name
|
|
return self.url
|
|
|
|
def infos(self):
|
|
"""Information about this extension."""
|
|
return {
|
|
"name": self.name, "label": self.label, "version": self.version,
|
|
"description": self.description, "url": self.get_url(),
|
|
"topredirection_url": self.topredirection_url,
|
|
"always_active": self.always_active
|
|
}
|
|
|
|
def load_initial_data(self):
|
|
"""Declare extension data in this method."""
|
|
pass
|
|
|
|
def load(self):
|
|
"""Add extension loading tasks in this method."""
|
|
pass
|
|
|
|
|
|
class ExtensionsPool(object):
|
|
"""The extensions manager"""
|
|
|
|
def __init__(self):
|
|
self.extensions = {}
|
|
|
|
def register_extension(self, ext, show=True):
|
|
"""Register an extension.
|
|
|
|
:param ext: a class inheriting from ``Extension``
|
|
:param show: list the extension or not
|
|
"""
|
|
self.extensions[ext.name] = {"cls": ext, "show": show}
|
|
|
|
def get_extension(self, name):
|
|
"""Retrieve the current instance of an extension."""
|
|
if name not in self.extensions:
|
|
return None
|
|
if "instance" not in self.extensions[name]:
|
|
self.extensions[name]["instance"] = self.extensions[name]["cls"]()
|
|
return self.extensions[name]["instance"]
|
|
|
|
def get_extension_infos(self, name):
|
|
"""Return information about the specified extension."""
|
|
instance = self.get_extension(name)
|
|
if instance is None:
|
|
return None
|
|
return instance.infos()
|
|
|
|
def load_extension(self, name):
|
|
"""Load a registered extension."""
|
|
__import__(name, locals(), globals(), [smart_str("modo_extension")])
|
|
extinstance = self.get_extension(name)
|
|
if extinstance is None:
|
|
return None
|
|
extinstance.load()
|
|
return extinstance
|
|
|
|
def load_all(self):
|
|
"""Load all defined extensions.
|
|
|
|
Each extension must be loaded in order to integrate with
|
|
Modoboa. Only enabled and special extensions are loaded but
|
|
urls are always returned. The reason is urls are imported only
|
|
once so must know all of them when the python process
|
|
starts. Otherwise, it would lead to unexpected 404 errors :p
|
|
|
|
:return: a list of url maps
|
|
"""
|
|
for ext in settings.MODOBOA_APPS:
|
|
self.load_extension(ext)
|
|
|
|
def get_urls(self, category="app"):
|
|
"""Get all urls defined by extensions."""
|
|
result = []
|
|
for ext_name in list(self.extensions.keys()):
|
|
ext = self.get_extension(ext_name)
|
|
options = {}
|
|
if category == "api":
|
|
root = ""
|
|
pattern = "{}.urls_api"
|
|
else:
|
|
root = r"^{}/".format(ext.get_url())
|
|
options.update({"namespace": ext_name})
|
|
pattern = "{}.urls"
|
|
try:
|
|
result.append(
|
|
url(root, include(pattern.format(ext_name), **options))
|
|
)
|
|
except ImportError:
|
|
# No urls for this extension
|
|
pass
|
|
return result
|
|
|
|
def list_all(self):
|
|
"""List all defined extensions."""
|
|
result = []
|
|
for extname, extdef in list(self.extensions.items()):
|
|
if not extdef["show"]:
|
|
continue
|
|
infos = self.get_extension_infos(extname)
|
|
infos["id"] = extname
|
|
result += [infos]
|
|
return sorted(result, key=lambda i: i["name"])
|
|
|
|
|
|
exts_pool = ExtensionsPool()
|