src/westferry/ui/base.py

   1 #!/usr/bin/python3
   2 ###############################################################################
   3 #                                                                             #
   4 # Westferry - The IPFire web user interface                                   #
   5 # Copyright (C) 2015 IPFire development team                                  #
   6 #                                                                             #
   7 # This program is free software: you can redistribute it and/or modify        #
   8 # it under the terms of the GNU General Public License as published by        #
   9 # the Free Software Foundation, either version 3 of the License, or           #
  10 # (at your option) any later version.                                         #
  11 #                                                                             #
  12 # This program is distributed in the hope that it will be useful,             #
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of              #
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
  15 # GNU General Public License for more details.                                #
  16 #                                                                             #
  17 # You should have received a copy of the GNU General Public License           #
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
  19 #                                                                             #
  20 ###############################################################################
  21
  22 import tornado.web
  23
  24 _ui_methods = {}
  25 _ui_modules = {}
  26
  27 class UIMethodsRegistration(type):
  28         def __init__(ui_method, name, bases, dict):
  29                 type.__init__(ui_method, name, bases, dict)
  30
  31                 # The main class from which is inherited is not registered
  32                 # as a plugin
  33                 if name == "BaseUIMethod":
  34                         return
  35
  36                 if ui_method.handle is None:
  37                         raise RuntimeError
  38
  39                 _ui_methods[ui_method.handle] = ui_method()
  40
  41         @staticmethod
  42         def get_ui_methods():
  43                 return _ui_methods
  44
  45
  46 class UIModulesRegistration(type):
  47         def __init__(ui_module, name, bases, dict):
  48                 type.__init__(ui_module, name, bases, dict)
  49
  50                 # The main class from which is inherited is not registered
  51                 # as a plugin
  52                 if name == "BaseUIModule":
  53                         return
  54
  55                 if name.endswith("Module"):
  56                         name = name[:-6]
  57
  58                 _ui_modules[name] = ui_module
  59
  60         @staticmethod
  61         def get_ui_modules():
  62                 return _ui_modules
  63
  64
  65 class BaseUIMethod(object, metaclass=UIMethodsRegistration):
  66         handle = None
  67
  68         def __call__(self, *args, **kwargs):
  69                 raise NotImplementedError
  70
  71
  72 class BaseUIModule(tornado.web.UIModule, metaclass=UIModulesRegistration):
  73         pass