/
_PluginDependencies.groovy
363 lines (317 loc) · 13.1 KB
/
_PluginDependencies.groovy
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
/*
* Copyright 2004-2005 the original author or authors.
*
* 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.
*/
import grails.util.BuildSettings
import grails.util.GrailsNameUtils
import grails.util.GrailsUtil
import grails.util.PluginBuildSettings
import groovy.xml.MarkupBuilder
import org.codehaus.groovy.grails.compiler.support.*
import org.apache.commons.io.FilenameUtils
import org.codehaus.groovy.control.CompilationUnit
import org.codehaus.groovy.grails.commons.DefaultGrailsApplication
import org.codehaus.groovy.grails.documentation.DocumentationContext
import org.codehaus.groovy.grails.documentation.DocumentedMethod
import org.codehaus.groovy.grails.documentation.DocumentedProperty
import org.codehaus.groovy.grails.plugins.DefaultGrailsPluginManager
import org.codehaus.groovy.grails.plugins.PluginManagerHolder
import org.codehaus.groovy.grails.resolve.IvyDependencyManager
import org.codehaus.groovy.grails.commons.ApplicationHolder
import org.codehaus.groovy.grails.resolve.GrailsRepoResolver
import org.codehaus.groovy.grails.resolve.PluginInstallEngine
import org.codehaus.groovy.grails.plugins.GrailsPluginManager
import org.codehaus.groovy.grails.plugins.ProfilingGrailsPluginManager
import org.springframework.core.io.Resource
import org.codehaus.groovy.grails.plugins.GrailsPluginUtils
import org.codehaus.groovy.grails.plugins.GrailsPlugin
import org.codehaus.groovy.grails.plugins.publishing.PluginDescriptorGenerator
/**
* Plugin stuff. If included, must be included after "_ClasspathAndEvents".
*
* @author Graeme Rocher
*
* @since 1.1
*/
if (getBinding().variables.containsKey("_plugin_dependencies_called")) return
_plugin_dependencies_called = true
includeTargets << grailsScript("_GrailsClean")
includeTargets << grailsScript("_GrailsArgParsing")
includeTargets << grailsScript("_GrailsProxy")
// Properties
pluginsList = null
globalInstall = false
pluginsBase = "${grailsWorkDir}/plugins".toString().replaceAll('\\\\','/')
// Targets
target(resolveDependencies:"Resolve plugin dependencies") {
depends(parseArguments, initInplacePlugins)
def pluginZips = grailsSettings.pluginDependencies
def installEngine = createPluginInstallEngine()
for (zip in pluginZips) {
installEngine.installResolvedPlugin(zip)
}
installEngine.checkPluginsToUninstall()
}
target(initInplacePlugins: "Generates the plugin.xml descriptors for inplace plugins.") {
depends(classpath)
}
/**
* Generates the 'plugin.xml' file for a plugin. Returns an instance
* of the plugin descriptor.
*/
generatePluginXml = { File descriptor, boolean compilePlugin = true ->
def pluginBaseDir = descriptor.parentFile
def pluginProps = pluginSettings.getPluginInfo(pluginBaseDir.absolutePath)
def plugin
pluginGrailsVersion = "${GrailsUtil.grailsVersion} > *"
if (compilePlugin) {
try {
// Rather than compiling the descriptor via Ant, we just load
// the Groovy file into a GroovyClassLoader. We add the classes
// directory to the class loader in case it didn't exist before
// the associated plugin's sources were compiled.
def gcl = new GroovyClassLoader(classLoader)
gcl.addURL(grailsSettings.classesDir.toURI().toURL())
pluginClass = gcl.parseClass(descriptor)
plugin = pluginClass.newInstance()
pluginProps = plugin.properties
}
catch (Throwable t) {
event("StatusError", [t.message])
t.printStackTrace(System.out)
ant.fail("Cannot instantiate plugin file")
}
}
if (pluginProps != null && pluginProps["grailsVersion"]) {
pluginGrailsVersion = pluginProps["grailsVersion"]
}
def resourceList = pluginSettings.getArtefactResourcesForOne(descriptor.parentFile.absolutePath)
// Work out what the name of the plugin is from the name of the descriptor file.
pluginName = GrailsNameUtils.getPluginName(descriptor.name)
// Remove the existing 'plugin.xml' if there is one.
def pluginXml = new File(pluginBaseDir, "plugin.xml")
pluginXml.delete()
// Use MarkupBuilder with indenting to generate the file.
pluginXml.withWriter { writer ->
def generator = new PluginDescriptorGenerator(grailsSettings, pluginName, resourceList)
pluginProps["type"] = descriptor.name - '.groovy'
generator.generatePluginXml(pluginProps, writer)
return compilePlugin ? plugin : pluginProps
}
}
target(loadPluginsAsync:"Asynchronously loads plugins") {
Thread.start {
loadPlugins()
}
}
target(loadPlugins:"Loads Grails' plugins") {
if (PluginManagerHolder.pluginManager) {
// Add the plugin manager to the binding so that it can be accessed from any target.
pluginManager = PluginManagerHolder.pluginManager
}
PluginManagerHolder.inCreation = true
def pluginFiles = pluginSettings.getPluginDescriptorsForCurrentEnvironment()
try {
def application
def pluginClasses = []
profile("construct plugin manager with ${pluginFiles.inspect()}") {
for (plugin in pluginFiles) {
def className = plugin.file.name - '.groovy'
pluginClasses << classLoader.loadClass(className)
}
profile("creating plugin manager with classes ${pluginClasses}") {
if (grailsApp == null) {
grailsApp = new DefaultGrailsApplication(new Class[0], new GroovyClassLoader(classLoader))
ApplicationHolder.application = grailsApp
}
if (enableProfile) {
pluginManager = new ProfilingGrailsPluginManager(pluginClasses as Class[], grailsApp)
}
else {
pluginManager = new DefaultGrailsPluginManager(pluginClasses as Class[], grailsApp)
}
pluginSettings.pluginManager = pluginManager
}
}
profile("loading plugins") {
event("PluginLoadStart", [pluginManager])
pluginManager.loadPlugins()
PluginManagerHolder.setPluginManager(pluginManager)
def baseDescriptor = pluginSettings.basePluginDescriptor
if (baseDescriptor) {
def baseName = FilenameUtils.getBaseName(baseDescriptor.filename)
def plugin = pluginManager.getGrailsPluginForClassName(baseName)
if (plugin) {
plugin.basePlugin = true
}
}
if (pluginManager.failedLoadPlugins) {
event("StatusError", ["Error: The following plugins failed to load due to missing dependencies: ${pluginManager.failedLoadPlugins*.name}"])
for (p in pluginManager.failedLoadPlugins) {
println "- Plugin: $p.name"
println " - Dependencies:"
for (depName in p.dependencyNames) {
GrailsPlugin depInfo = pluginManager.getGrailsPlugin(depName)
def specifiedVersion = p.getDependentVersion(depName)
def invalid = depInfo && GrailsPluginUtils.isValidVersion(depInfo.version, specifiedVersion) ? '' : '[INVALID]'
println " ${invalid ? '!' :'-' } ${depName} (Required: ${specifiedVersion}, Found: ${depInfo?.version ?: 'Not Installed'}) ${invalid}"
}
}
exit(1)
}
pluginManager.doArtefactConfiguration()
grailsApp.initialise()
/* if (org.springframework.util.ClassUtils.isPresent("com.springsource.loaded.Plugins", rootLoader)) {
org.codehaus.groovy.grails.cli.agent.GrailsPluginManagerReloadPlugin.register()
}*/
event("PluginLoadEnd", [pluginManager])
}
}
catch (Exception e) {
PluginManagerHolder.inCreation = false
grailsConsole.error "Error loading plugin manager: " + e.message , e
exit(1)
}
}
/**
* Reads a plugin.xml descriptor for the given plugin name
*/
readPluginXmlMetadata = { String pluginName ->
def pluginDir = getPluginDirForName(pluginName)?.file
new XmlSlurper().parse(new File("${pluginDir}/plugin.xml"))
}
/**
* Reads all installed plugin descriptors returning a list
*/
readAllPluginXmlMetadata = {->
pluginSettings.pluginXmlMetadata.findAll { it.file.exists() }.collect { new XmlSlurper().parse(it.file) }
}
/**
* Runs a script contained within a plugin
*/
runPluginScript = { File scriptFile, fullPluginName, msg ->
if (!scriptFile.exists()) {
return
}
// instrumenting plugin scripts adding 'pluginBasedir' variable
try {
def instrumentedInstallScript = "def pluginBasedir = '${pluginsHome}/${fullPluginName}'\n".toString().replaceAll('\\\\','/') + scriptFile.text
// we are using text form of script here to prevent Gant caching
includeTargets << instrumentedInstallScript
}
catch(e) {
grailsConsole.error "Error executing plugin $fullPluginName script: $scriptFile"
exit 1
}
}
readMetadataFromZip = { String zipLocation, pluginFile=zipLocation ->
def installEngine = createPluginInstallEngine()
installEngine.readMetadataFromZip(zipLocation)
}
/**
* Uninstalls a plugin for the given name and version
*/
uninstallPluginForName = { name, version=null ->
def pluginInstallEngine = createPluginInstallEngine()
pluginInstallEngine.uninstallPlugin name, version
}
/**
* Installs a plugin for the given name and optional version
*/
installPluginForName = { String name, String version = null ->
PluginInstallEngine pluginInstallEngine = createPluginInstallEngine()
if (name) {
event("InstallPluginStart", ["$name-$version"])
pluginInstallEngine.installPlugin(name, version, globalInstall)
}
}
private PluginInstallEngine createPluginInstallEngine() {
def pluginInstallEngine = new PluginInstallEngine(grailsSettings, pluginSettings, metadata, ant)
pluginInstallEngine.eventHandler = { eventName, msg -> event(eventName, [msg]) }
pluginInstallEngine.errorHandler = { msg ->
event("StatusError", [msg])
for (pluginDir in pluginInstallEngine.installedPlugins) {
if (pluginInstallEngine.isNotInlinePluginLocation(new File(pluginDir.toString()))) {
ant.delete(dir: pluginDir, failonerror: false)
}
}
exit(1)
}
pluginInstallEngine.postUninstallEvent = {
resetClasspath()
}
pluginInstallEngine.postInstallEvent = { pluginInstallPath ->
File pluginEvents = new File("${pluginInstallPath}/scripts/_Events.groovy")
if (pluginEvents.exists()) {
eventListener.loadEventsScript(pluginEvents)
}
try {
clean()
}
catch (e) {
// ignore
}
resetClasspath()
}
pluginInstallEngine.isInteractive = isInteractive
pluginInstallEngine.pluginDirVariableStore = binding
pluginInstallEngine.pluginScriptRunner = runPluginScript
return pluginInstallEngine
}
protected void resetClasspath() {
classpathSet = false
classpath()
PluginManagerHolder.pluginManager = null
GrailsResourceLoaderHolder.resourceLoader = new GrailsResourceLoader(pluginSettings.getArtefactResourcesForCurrentEnvironment())
}
doInstallPluginFromURL = { URL url ->
withPluginInstall {
def installEngine = createPluginInstallEngine()
installEngine.installPlugin url, globalInstall
}
}
doInstallPluginZip = { File file ->
withPluginInstall {
def installEngine = createPluginInstallEngine()
installEngine.installPlugin file, globalInstall, true
}
}
doInstallPlugin = { pluginName, pluginVersion = null ->
withPluginInstall {
def installEngine = createPluginInstallEngine()
installEngine.installPlugin pluginName, pluginVersion, globalInstall
}
}
eachRepository = { Closure callable ->
IvyDependencyManager dependencyManager = grailsSettings.dependencyManager
for (resolver in dependencyManager.chainResolver.resolvers) {
if (resolver instanceof GrailsRepoResolver) {
pluginsList = resolver.getPluginList(new File("${grailsWorkDir}/plugins-list-${resolver.name}.xml"))
if(pluginsList != null) {
callable(resolver.name, resolver.repositoryRoot)
} else {
grailsConsole.error "An error occurred resolving plugin list from resolver [${resolver.name} - ${resolver.repositoryRoot}]."
}
}
}
}
private withPluginInstall(Closure callable) {
try {
fullPluginName = callable.call()
}
catch (e) {
logError("Error installing plugin: ${e.message}", e)
exit(1)
}
}