|
| 1 | +import logging |
| 2 | + |
| 3 | +from django.conf import settings |
| 4 | + |
| 5 | +# Python 2.7 has an importlib with import_module. |
| 6 | +# For older Pythons, Django's bundled copy provides it. |
| 7 | +# For older Django's dajaxice reduced_import_module. |
| 8 | +try: |
| 9 | + from importlib import import_module |
| 10 | +except: |
| 11 | + try: |
| 12 | + from django.utils.importlib import import_module |
| 13 | + except: |
| 14 | + from dajaxice.utils import simple_import_module as import_module |
| 15 | + |
| 16 | +log = logging.getLogger('dajaxice.DajaxiceRequest') |
| 17 | + |
| 18 | + |
| 19 | +class DajaxiceFunction(object): |
| 20 | + |
| 21 | + def __init__(self, name, path, doc=None): |
| 22 | + self.name = name |
| 23 | + self.path = path |
| 24 | + self.doc = doc |
| 25 | + |
| 26 | + def get_callable_path(self): |
| 27 | + return '%s.%s' % (self.path.replace('.ajax', ''), self.name) |
| 28 | + |
| 29 | + def __cmp__(self, other): |
| 30 | + return (self.name == other.name and self.path == other.path) |
| 31 | + |
| 32 | + |
| 33 | +class DajaxiceModule(object): |
| 34 | + def __init__(self, module): |
| 35 | + self.functions = [] |
| 36 | + self.sub_modules = [] |
| 37 | + self.name = module[0] |
| 38 | + |
| 39 | + sub_module = module[1:] |
| 40 | + if len(sub_module) != 0: |
| 41 | + self.add_submodule(sub_module) |
| 42 | + |
| 43 | + def get_module(self, module): |
| 44 | + """ |
| 45 | + Recursively get_module util we found it. |
| 46 | + """ |
| 47 | + if len(module) == 0: |
| 48 | + return self |
| 49 | + |
| 50 | + for dajaxice_module in self.sub_modules: |
| 51 | + if dajaxice_module.name == module[0]: |
| 52 | + return dajaxice_module.get_module(module[1:]) |
| 53 | + return None |
| 54 | + |
| 55 | + def add_function(self, function): |
| 56 | + self.functions.append(function) |
| 57 | + |
| 58 | + def has_sub_modules(self): |
| 59 | + return len(self.sub_modules) > 0 |
| 60 | + |
| 61 | + def add_submodule(self, module): |
| 62 | + """ |
| 63 | + Recursively add_submodule, if it's not registered, create it. |
| 64 | + """ |
| 65 | + if len(module) == 0: |
| 66 | + return |
| 67 | + else: |
| 68 | + sub_module = self.exist_submodule(module[0]) |
| 69 | + |
| 70 | + if type(sub_module) == int: |
| 71 | + self.sub_modules[sub_module].add_submodule(module[1:]) |
| 72 | + else: |
| 73 | + self.sub_modules.append(DajaxiceModule(module)) |
| 74 | + |
| 75 | + def exist_submodule(self, name): |
| 76 | + """ |
| 77 | + Check if submodule name was already registered. |
| 78 | + """ |
| 79 | + for module in self.sub_modules: |
| 80 | + if module.name == name: |
| 81 | + return self.sub_modules.index(module) |
| 82 | + return False |
| 83 | + |
| 84 | + |
| 85 | +class Dajaxice(object): |
| 86 | + def __init__(self): |
| 87 | + self._registry = [] |
| 88 | + self._callable = [] |
| 89 | + |
| 90 | + for function in getattr(settings, 'DAJAXICE_FUNCTIONS', ()): |
| 91 | + function = function.rsplit('.', 1) |
| 92 | + self.register_function(function[0], function[1]) |
| 93 | + |
| 94 | + def register(self, function): |
| 95 | + self.register_function(function.__module__, function.__name__, function.__doc__) |
| 96 | + |
| 97 | + def register_function(self, module, name, doc=None): |
| 98 | + """ |
| 99 | + Register function at 'module' depth |
| 100 | + """ |
| 101 | + #Create the dajaxice function. |
| 102 | + function = DajaxiceFunction(name=name, path=module, doc=doc) |
| 103 | + |
| 104 | + #Check for already registered functions. |
| 105 | + full_path = '%s.%s' % (module, name) |
| 106 | + if full_path in self._callable: |
| 107 | + log.warning('%s already registered as dajaxice function.' % full_path) |
| 108 | + return |
| 109 | + |
| 110 | + self._callable.append(full_path) |
| 111 | + |
| 112 | + #Dajaxice path without ajax. |
| 113 | + module_without_ajax = module.replace('.ajax', '').split('.') |
| 114 | + |
| 115 | + #Register module if necessary. |
| 116 | + exist_module = self._exist_module(module_without_ajax[0]) |
| 117 | + |
| 118 | + if type(exist_module) == int: |
| 119 | + self._registry[exist_module].add_submodule(module_without_ajax[1:]) |
| 120 | + else: |
| 121 | + self._registry.append(DajaxiceModule(module_without_ajax)) |
| 122 | + |
| 123 | + #Register Function |
| 124 | + module = self.get_module(module_without_ajax) |
| 125 | + if module: |
| 126 | + module.add_function(function) |
| 127 | + |
| 128 | + def get_module(self, module): |
| 129 | + """ |
| 130 | + Recursively get module from registry |
| 131 | + """ |
| 132 | + for dajaxice_module in self._registry: |
| 133 | + if dajaxice_module.name == module[0]: |
| 134 | + return dajaxice_module.get_module(module[1:]) |
| 135 | + return None |
| 136 | + |
| 137 | + def is_callable(self, name): |
| 138 | + return name in self._callable |
| 139 | + |
| 140 | + def _exist_module(self, module_name): |
| 141 | + for module in self._registry: |
| 142 | + if module.name == module_name: |
| 143 | + return self._registry.index(module) |
| 144 | + return False |
| 145 | + |
| 146 | + def get_functions(self): |
| 147 | + return self._registry |
| 148 | + |
| 149 | + |
| 150 | +LOADING_DAJAXICE = False |
| 151 | + |
| 152 | + |
| 153 | +def dajaxice_autodiscover(): |
| 154 | + """ |
| 155 | + Auto-discover INSTALLED_APPS ajax.py modules and fail silently when |
| 156 | + not present. |
| 157 | + NOTE: dajaxice_autodiscover was inspired/copied from django.contrib.admin autodiscover |
| 158 | + """ |
| 159 | + global LOADING_DAJAXICE |
| 160 | + if LOADING_DAJAXICE: |
| 161 | + return |
| 162 | + LOADING_DAJAXICE = True |
| 163 | + |
| 164 | + import imp |
| 165 | + from django.conf import settings |
| 166 | + |
| 167 | + for app in settings.INSTALLED_APPS: |
| 168 | + |
| 169 | + try: |
| 170 | + app_path = import_module(app).__path__ |
| 171 | + except AttributeError: |
| 172 | + continue |
| 173 | + |
| 174 | + try: |
| 175 | + imp.find_module('ajax', app_path) |
| 176 | + except ImportError: |
| 177 | + continue |
| 178 | + |
| 179 | + import_module("%s.ajax" % app) |
| 180 | + |
| 181 | + LOADING_DAJAXICE = False |
0 commit comments