Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

#!/usr/bin/env python 

# -*- coding: utf-8 -*- 

 

############################################################################### 

#  Copyright Kitware Inc. 

# 

#  Licensed under the Apache License, Version 2.0 ( the "License" ); 

#  you may not use this file except in compliance with the License. 

#  You may obtain a copy of the License at 

# 

#    http://www.apache.org/licenses/LICENSE-2.0 

# 

#  Unless required by applicable law or agreed to in writing, software 

#  distributed under the License is distributed on an "AS IS" BASIS, 

#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 

#  See the License for the specific language governing permissions and 

#  limitations under the License. 

############################################################################### 

 

""" 

The purpose of this module is to provide utility functions related to loading 

and registering plugins into the system. The "loadPlugins" and "loadPlugin" 

functions are used by the core system to actually load the plugins and create 

the pseudo-packages required for easily referencing them. The other functions 

in this class are general utility functions designed to be used within the 

plugins themselves to help them register with the application. 

""" 

 

import functools 

import imp 

import json 

import os 

import sys 

import traceback 

 

from girder.constants import ROOT_DIR, ROOT_PLUGINS_PACKAGE, TerminalColor 

from girder.utility import mail_utils 

 

 

def loadPlugins(plugins, root, appconf): 

    """ 

    Loads a set of plugins into the application. The list passed in should not 

    already contain dependency information; dependent plugins will be loaded 

    automatically. 

 

    :param plugins: The set of plugins to load, by directory name. 

    :type plugins: list 

    :param root: The root node of the server tree. 

    :param appconf: The server's cherrypy configuration object. 

    :type appconf: dict 

    :returns: A list of plugins that were actually loaded, once dependencies 

              were resolved and topological sort was performed. 

    """ 

    # Register a pseudo-package for the root of all plugins. This must be 

    # present in the system module list in order to avoid import warnings. 

    if ROOT_PLUGINS_PACKAGE not in sys.modules: 

        sys.modules[ROOT_PLUGINS_PACKAGE] = type('', (), { 

            '__path__': os.path.join(ROOT_DIR, 'plugins'), 

            '__package__': ROOT_PLUGINS_PACKAGE, 

            '__name__': ROOT_PLUGINS_PACKAGE 

        })() 

 

    print TerminalColor.info('Resolving plugin dependencies...') 

 

    filteredDepGraph = {pluginName: info['dependencies'] 

                        for pluginName, info in findAllPlugins().iteritems() 

                        if pluginName in plugins} 

 

    for pset in toposort(filteredDepGraph): 

        for plugin in pset: 

            try: 

                loadPlugin(plugin, root, appconf) 

                print TerminalColor.success('Loaded plugin "{}"'.format(plugin)) 

            except: 

                print TerminalColor.error( 

                    'ERROR: Failed to load plugin "{}":'.format(plugin)) 

                traceback.print_exc() 

 

 

def loadPlugin(name, root, appconf): 

    """ 

    Loads a plugin into the application. This means allowing it to create 

    endpoints within its own web API namespace, and to register its event 

    listeners, and do anything else it might want to do. 

 

    :param name: The name of the plugin (i.e. its directory name) 

    :type name: str 

    :param root: The root node of the web API. 

    :param appconf: The cherrypy configuration for the server. 

    :type appconf: dict 

    """ 

    pluginDir = os.path.join(ROOT_DIR, 'plugins', name) 

    isPluginDir = os.path.isdir(os.path.join(pluginDir, 'server')) 

    isPluginFile = os.path.isfile(os.path.join(pluginDir, 'server.py')) 

    if not os.path.exists(pluginDir): 

        raise Exception('Plugin directory does not exist: {}'.format(pluginDir)) 

    if not isPluginDir and not isPluginFile: 

        # This plugin does not have any server-side python code. 

        return 

 

    mailTemplatesDir = os.path.join(pluginDir, 'server', 'mail_templates') 

    if os.path.isdir(mailTemplatesDir): 

        # If the plugin has mail templates, add them to the lookup path 

        mail_utils.addTemplateDirectory(mailTemplatesDir) 

 

    moduleName = '.'.join((ROOT_PLUGINS_PACKAGE, name)) 

 

    if moduleName not in sys.modules: 

        fp = None 

        try: 

            fp, pathname, description = imp.find_module('server', [pluginDir]) 

            module = imp.load_module(moduleName, fp, pathname, description) 

            setattr(module, 'PLUGIN_ROOT_DIR', pluginDir) 

 

            if hasattr(module, 'load'): 

                module.load({ 

                    'name': name, 

                    'config': appconf, 

                    'serverRoot': root, 

                    'apiRoot': root.api.v1 

                }) 

        finally: 

            if fp: 

                fp.close() 

 

 

def findAllPlugins(): 

    """ 

    Walks the plugins directory to find all of the plugins. If the plugin has 

    a plugin.json file, this reads that file to determine dependencies. 

    """ 

    allPlugins = {} 

    pluginsDir = os.path.join(ROOT_DIR, 'plugins') 

    dirs = [dir for dir in os.listdir(pluginsDir) if os.path.isdir( 

            os.path.join(pluginsDir, dir))] 

 

    for plugin in dirs: 

        data = {} 

        configFile = os.path.join(pluginsDir, plugin, 'plugin.json') 

        if os.path.isfile(configFile): 

            with open(configFile) as conf: 

                data = json.load(conf) 

 

        allPlugins[plugin] = { 

            'name': data.get('name', plugin), 

            'description': data.get('description', ''), 

            'dependencies': set(data.get('dependencies', [])) 

        } 

 

    return allPlugins 

 

 

def toposort(data): 

    """ 

    General-purpose topoligical sort function. Dependencies are expressed as a 

    dictionary whose keys are items and whose values are a set of dependent 

    items. Output is a list of sets in topological order. This is a generator 

    function that returns a sequence of sets in topological order. 

 

    :param data: The dependency information. 

    :type data: dict 

    :returns: Yields a list of sorted sets representing the sorted order. 

    """ 

    if not data: 

        return 

 

    # Ignore self dependencies. 

    for k, v in data.items(): 

        v.discard(k) 

 

    # Find all items that don't depend on anything. 

    extra = functools.reduce( 

        set.union, data.itervalues()) - set(data.iterkeys()) 

    # Add empty dependences where needed 

    data.update({item: set() for item in extra}) 

 

    # Perform the toposort. 

    while True: 

        ordered = set(item for item, dep in data.iteritems() if not dep) 

        if not ordered: 

            break 

        yield ordered 

        data = {item: (dep - ordered) 

                for item, dep in data.iteritems() if item not in ordered} 

    # Detect any cycles in the dependency graph. 

    if data: 

        raise Exception('Cyclic dependencies detected:\n%s' % '\n'.join( 

                        repr(x) for x in data.iteritems())) 

 

 

def addChildNode(node, name, obj=None): 

    """ 

    Use this to build paths to your plugin's endpoints. 

 

    :param node: The parent node to add the child node to. 

    :param name: The name of the child node in the URL path. 

    :type name: str 

    :param obj: The object to place at this new node, or None if this child 

                should not be exposed as an endpoint, instead just used as 

                an intermediary hidden node. 

    :type obj: object or None 

    :returns: The node that was created. 

    """ 

    if obj: 

        setattr(node, name, obj) 

        return obj 

    else: 

        hiddenNode = type('', (), dict(exposed=False))() 

        setattr(node, name, hiddenNode) 

        return hiddenNode