Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
tag: v1.2.2
Fetching contributors…

Cannot retrieve contributors at this time

1529 lines (1351 sloc) 58.497 kB
/*
* 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 groovy.xml.DOMBuilder
import groovy.xml.MarkupBuilder
import groovy.xml.dom.DOMCategory
import java.util.regex.Matcher
import java.util.zip.ZipFile
import java.util.zip.ZipEntry
import javax.xml.transform.OutputKeys
import javax.xml.transform.Transformer
import javax.xml.transform.TransformerFactory
import javax.xml.transform.dom.DOMSource
import javax.xml.transform.stream.StreamResult
import org.apache.commons.io.FilenameUtils
import org.apache.commons.lang.ArrayUtils
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.GrailsPluginUtils
import org.codehaus.groovy.grails.plugins.PluginManagerHolder
import org.codehaus.groovy.grails.resolve.IvyDependencyManager
import org.springframework.core.io.Resource
import org.tmatesoft.svn.core.*
import org.tmatesoft.svn.core.auth.*
import org.tmatesoft.svn.core.io.SVNRepositoryFactory
import org.tmatesoft.svn.core.internal.io.dav.DAVRepositoryFactory
import org.tmatesoft.svn.core.internal.io.fs.FSRepositoryFactory
import org.tmatesoft.svn.core.internal.io.svn.SVNRepositoryFactoryImpl
import org.tmatesoft.svn.core.wc.SVNWCUtil
import grails.util.PluginBuildSettings
import org.codehaus.groovy.control.MultipleCompilationErrorsException
import org.codehaus.groovy.control.CompilationFailedException
import org.codehaus.groovy.grails.commons.ApplicationHolder
/**
* 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")
CORE_PLUGIN_DIST = "http://svn.codehaus.org/grails/trunk/grails-plugins"
CORE_PUBLISH_URL = "https://svn.codehaus.org/grails/trunk/grails-plugins"
DEFAULT_PLUGIN_DIST = "http://plugins.grails.org"
DEFAULT_PUBLISH_URL = "https://svn.codehaus.org/grails-plugins"
// TODO: temporary until we refactor Grails core into real plugins
CORE_PLUGINS = ['core', 'i18n','converters','mimeTypes', 'controllers','webflow', 'dataSource', 'domainClass', 'filters','logging', 'groovyPages']
// Properties
pluginsList = null
globalInstall = false
pluginsBase = "${grailsWorkDir}/plugins".toString().replaceAll('\\\\','/')
// setup default plugin respositories for discovery
pluginDiscoveryRepositories = [core:CORE_PLUGIN_DIST, default:DEFAULT_PLUGIN_DIST]
if(grailsSettings?.config?.grails?.plugin?.repos?.discovery) {
pluginDiscoveryRepositories.putAll(grailsSettings?.config?.grails?.plugin?.repos?.discovery)
}
// setup default plugin respositories for publishing
pluginDistributionRepositories = [core:CORE_PUBLISH_URL, default:DEFAULT_PUBLISH_URL]
if(grailsSettings?.config?.grails?.plugin?.repos?.distribution) {
pluginDistributionRepositories.putAll(grailsSettings?.config?.grails?.plugin?.repos?.distribution)
}
KEY_URL = "url"
KEY_USER_NAME = "user"
KEY_USER_PASS = "pswd"
/**
* authentication manager Map
* EG : INIT CORE OR DEFAULT DISTRIBUTION REPOSITORY
* aMap = [url:CORE_PUBLISH_URL,user:"auser",pswd:"apswd"]
* ALLOWS ANT PROPERTIES DEFINITION
* aAuthManager = getAuthenticationManager("core", "distribution", aMap )
* authManagerMap.put("distribution.core", aAuthManager )
*/
authManagerMap = [:]
/**
* Break down url into separate authentication components from url
* @param url to be parsed
* @return broken down url in these parts (if exist) url, user and pswd
*/
public Map tokenizeUrl(String url) throws SVNException {
SVNURL aURL= SVNURL.parseURIDecoded(url)
def aHashMap = [:]
def userInfo = aURL.userInfo
if(userInfo) {
def userInfoArray = userInfo.split(":")
aHashMap[KEY_USER_NAME] = userInfoArray[0]
if (userInfoArray.length>1) {
aHashMap[KEY_USER_PASS] = userInfoArray[1]
}
}
if(aURL.port == 443) {
aHashMap[KEY_URL] = "${aURL.protocol}://${aURL.host}${aURL.path}".toString()
} else {
aHashMap[KEY_URL] = "${aURL.protocol}://${aURL.host}:${aURL.port}${aURL.path}".toString()
}
return aHashMap
}
//init SVN Kit one time
// support file based SVN
FSRepositoryFactory.setup()
// support the server http/https
DAVRepositoryFactory.setup()
// support svn protocol
SVNRepositoryFactoryImpl.setup()
/**
* Replace the url with authentication by url without in discovery and distribution
* repository and setup authentication instance in authManagerMap.
* if an url like :
* {protocol}://{user:password}@url is defined the promt does not occur.
* Else the user is prompted for user and password values.
* The repos "core" and "default" are ignored (see above for default configuration)
* For all other repo, a defultAuthenticationManager is created.
*/
public Map configureAuth(Map repoMap,String repoType) {
repoMapTmp = [:]
repoMap.each{
ISVNAuthenticationManager aAuthManager=SVNWCUtil.createDefaultAuthenticationManager()
if ("core"==it.key||"default"==it.key){
repoMapTmp[it.key] = it.value
if(!isSecureUrl(it.value)) {
authManagerMap[repoType+"."+it.key] = aAuthManager
}
// else no authentication manager provides to authManagerMap : case of CORE_PUBLISH_URL and DEFAULT_PUBLISH_URL
} else {
if(isSecureUrl(it.value)) {
event "StatusUpdate", ["Authentication for svn repo at ${it.key} ${repoType} is required."]
aMap = tokenizeUrl(it.value)
repoMapTmp[it.key] = aMap[KEY_URL]
aAuthManager = getAuthenticationManager(it.key, repoType, aMap)
authManagerMap[repoType+"."+it.key] = aAuthManager
} else {
repoMapTmp[it.key] = it.value
event "StatusUpdate", ["No authentication for svn repo at ${it.key}"]
authManagerMap[repoType+"."+it.key] = aAuthManager
}
}
}
return repoMapTmp
}
//configure authentication for discovery repository
pluginDiscoveryRepositories = configureAuth(pluginDiscoveryRepositories, "discovery")
//configure authentication for distribution repository
pluginDistributionRepositories = configureAuth(pluginDistributionRepositories, "distribution")
/**
* Provide an authentication manager object.
* This method tries to use the configuration in settings.groovy
* (see comment of configureAuth for configuration pattern). If
* there's no configuration the user is prompted.
* @param repoKey
* @param repoType discovery or distribution
* @param tokenizeUrl the broken down url
* @return an ISVNAuthenticationManager impl instance building
*/
private ISVNAuthenticationManager getAuthenticationManager(String repoKey, String repoType, Map tokenizeUrl) {
ISVNAuthenticationManager aAuthManager
usr = "user.svn.username.${repoType}.${repoKey}".toString()
psw = "user.svn.password.${repoType}.${repoKey}".toString()
if(tokenizeUrl[KEY_USER_NAME]) {
ant.antProject.setNewProperty usr, ""+tokenizeUrl[KEY_USER_NAME]
String pswd = tokenizeUrl[KEY_USER_PASS] ?: ""
ant.antProject.setNewProperty(psw,pswd)
}
//If no provided info, the user have to be prompt
ant.input(message:"Please enter your SVN username:", addproperty:usr)
ant.input(message:"Please enter your SVN password:", addproperty:psw)
def username = ant.antProject.getProperty(usr)
def password = ant.antProject.getProperty(psw)
authManager = SVNWCUtil.createDefaultAuthenticationManager( username , password )
//Test connection
aUrl = tokenizeUrl[KEY_URL]
def svnUrl = SVNURL.parseURIEncoded(aUrl)
def repo = SVNRepositoryFactory.create(svnUrl, null)
repo.authenticationManager = authManager
try {
repo.testConnection()
//only if it works...
repo.closeSession()
} catch (SVNAuthenticationException ex) {
//GRAVE BAD CONFIGURATION : EXITING
event("StatusError",["Bad authentication configuration for $aUrl"])
exit(1)
}
return authManager
}
/**
* Get an authenticationManager object starting from url
* @param url of SVN repo
* @param repoType discovery or distribution
* @return ISVNAuthenticationManager for SVN connection on on repo with auth
**/
private ISVNAuthenticationManager getAuthFromUrl(url, repoType) {
keyValue = repoType+"."+pluginDiscoveryRepositories.find { url.startsWith(it.value) }?.key
return authManagerMap[keyValue]
}
pluginResolveOrder = grailsSettings?.config?.grails?.plugin?.repos?.resolveOrder
if(!pluginResolveOrder) {
pluginResolveOrder = pluginDiscoveryRepositories.keySet()
}
else {
event("StatusUpdate", ["Using explicit plugin resolve order ${pluginResolveOrder}"])
}
installedPlugins = [] // a list of plugins that have been installed
boolean isCorePlugin(name) {
CORE_PLUGINS.contains(name)
}
configureRepository = { targetRepoURL, String alias = "default" ->
repositoryName = alias
pluginsList = null
pluginsListFile = new File(grailsSettings.grailsWorkDir, "plugins-list-${alias}.xml")
def namedPluginSVN = pluginDistributionRepositories.find { it.key == alias }?.value
if(namedPluginSVN) {
pluginSVN = namedPluginSVN
}
else {
pluginSVN = DEFAULT_PUBLISH_URL
}
pluginDistURL = targetRepoURL
pluginBinaryDistURL = "$targetRepoURL/dist"
remotePluginList = "$targetRepoURL/.plugin-meta/plugins-list.xml"
}
configureRepository(DEFAULT_PLUGIN_DIST)
configureRepositoryForName = { String targetRepository, type="discovery" ->
// Works around a bug in Groovy 1.5.6's DOMCategory that means get on Object returns null. Change to "pluginDiscoveryRepositories.targetRepository" when upgrading
def targetRepoURL = pluginDiscoveryRepositories.find { it.key == targetRepository }?.value
if(targetRepoURL) {
configureRepository(targetRepoURL, targetRepository)
}
else {
println "No repository configured for name ${targetRepository}. Set the 'grails.plugin.repos.${type}.${targetRepository}' variable to the location of the repository."
exit(1)
}
}
eachRepository = { Closure callable ->
for(repoName in pluginResolveOrder) {
configureRepositoryForName(repoName)
updatePluginsList()
if(!callable(repoName, pluginSVN)) {
break
}
}
}
// Targets
target(resolveDependencies:"Resolve plugin dependencies") {
depends(parseArguments, initInplacePlugins)
def plugins = metadata.findAll { it.key.startsWith("plugins.")}.collect {
[
name:it.key[8..-1],
version: it.value
]
}
boolean installedPlugins = false
for(p in plugins) {
def name = p.name
def version = p.version
def fullName = "$name-$version"
def pluginLoc = getPluginDirForName(name)
if(!pluginLoc?.exists()) {
println "Plugin [${fullName}] not installed, resolving.."
doInstallPluginFromGrailsHomeOrRepository name, version
installedPlugins = true
}
else if(pluginLoc) {
def dirName = pluginLoc.filename
PluginBuildSettings settings = pluginSettings
if(!dirName.endsWith(version) && !settings.isInlinePluginLocation(pluginLoc)) {
println "Upgrading plugin [$dirName] to [${fullName}], resolving.."
doInstallPluginFromGrailsHomeOrRepository name, version
installedPlugins = true
}
}
}
if(installedPlugins) {
resetClasspathAndState()
}
// Find out which plugins are in the search path but not in the
// metadata. We only check on the plugins in the project's "plugins"
// directory and the global "plugins" dir. Plugins loaded via an
// explicit path should be left alone.
def pluginDirs = pluginSettings.implicitPluginDirectories
def pluginsToUninstall = pluginDirs.findAll { Resource r -> !plugins.find { plugin ->
r.filename ==~ "$plugin.name-.+"
}}
for(Resource pluginDir in pluginsToUninstall) {
if(pluginSettings.isGlobalPluginLocation(pluginDir)) {
registerMetadataForPluginLocation(pluginDir)
}
else {
if(!isInteractive || confirmInput("Plugin [${pluginDir.filename}] is installed, but was not found in the application's metadata, do you want to uninstall?", "confirm.${pluginDir.filename}.uninstall")) {
uninstallPluginForName(pluginDir.filename)
}
else {
registerMetadataForPluginLocation(pluginDir)
}
}
}
}
target(initInplacePlugins: "Generates the plugin.xml descriptors for inplace plugins.") {
depends(classpath)
// Ensure that the "plugin.xml" is up-to-date for plugins
// that haven't been installed, i.e. their path is declared
// explicitly by the project.
// TODO: At the moment we simple check whether plugin.xml exists for each plugin
// TODO: otherwise fail
PluginBuildSettings settings = pluginSettings
Resource[] pluginDirs = settings.getInlinePluginDirectories()
pluginDirs.each { Resource r ->
def dir = r.file
def pluginXml = new File(dir, "plugin.xml")
if(!pluginXml.exists()) {
println "The inplace plugin at [$dir.absolutePath] does not have a plugin.xml. Please run the package-plugin command inside the plugin directory."
exit 1
}
}
// File pluginsDir = grailsSettings.projectPluginsDir.canonicalFile.absoluteFile
// File globalDir = grailsSettings.globalPluginsDir.canonicalFile.absoluteFile
// Resource basePluginDescriptor = pluginSettings.basePluginDescriptor
//
// pluginSettings.pluginDescriptors.findAll { Resource r ->
// pluginSettings.isInlinePluginLocation(r)
// }.each { Resource r ->
// compileInplacePlugin(r.file.parentFile)
// generatePluginXml(r.file)
// }
}
/**
* Compiles the sources for a single in-place plugin. A bit of a hack,
* but any other solution would require too much refactoring to make it
* into the 1.2 release.
*/
compileInplacePlugin = { File pluginDir ->
def classesDirPath = grailsSettings.classesDir.path
ant.mkdir(dir: classesDirPath)
profile("Compiling inplace plugin sources to location [$classesDirPath]") {
// First compile the plugins so that we can exclude any
// classes that might conflict with the project's.
def classpathId = "grails.compile.classpath"
def pluginResources = pluginSettings.getPluginSourceFiles(pluginDir)
if (pluginResources) {
// Only perform the compilation if there are some plugins
// installed or otherwise referenced.
try {
ant.groovyc(
destdir: classesDirPath,
classpathref: classpathId,
encoding:"UTF-8",
verbose: grailsSettings.verboseCompile,
listfiles: grailsSettings.verboseCompile) {
for(File dir in pluginResources.file) {
if (dir.exists() && dir.isDirectory()) {
src(path: dir.absolutePath)
}
}
exclude(name: "**/BootStrap.groovy")
exclude(name: "**/BuildConfig.groovy")
exclude(name: "**/Config.groovy")
exclude(name: "**/*DataSource.groovy")
exclude(name: "**/UrlMappings.groovy")
exclude(name: "**/resources.groovy")
javac(classpathref: classpathId, encoding: "UTF-8", debug: "yes")
}
}
catch (e) {
println "Failed to compile plugin at location [$pluginDir] with error: ${e.message}"
exit 1
}
}
}
}
private registerMetadataForPluginLocation(Resource pluginDir) {
def plugin = pluginSettings.getMetadataForPlugin(pluginDir.filename)
registerPluginWithMetadata(plugin.@name.text(), plugin.@version.text())
}
/**
* Generates the 'plugin.xml' file for a plugin. Returns an instance
* of the plugin descriptor.
*/
generatePluginXml = { File descriptor ->
// Load the plugin descriptor class and instantiate it so we can
// access its properties.
Class pluginClass
def plugin
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()
}
catch (Throwable t) {
event("StatusError", [ t.message])
t.printStackTrace(System.out)
ant.fail("Cannot instantiate plugin file")
}
// 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(descriptor.parentFile, "plugin.xml")
pluginXml.delete()
// Use MarkupBuilder with indenting to generate the file.
def writer = new IndentPrinter(new PrintWriter(new FileWriter(pluginXml)))
def xml = new MarkupBuilder(writer)
// Write the content!
def props = ['author','authorEmail','title','description','documentation']
def resourceList = pluginSettings.getArtefactResourcesForOne(descriptor.parentFile.absolutePath)
def rcComparator = [ compare: {a, b -> a.URI.compareTo(b.URI) } ] as Comparator
Arrays.sort(resourceList, rcComparator)
pluginGrailsVersion = "${GrailsUtil.grailsVersion} > *"
if(plugin.metaClass.hasProperty(plugin,"grailsVersion")) {
pluginGrailsVersion = plugin.grailsVersion
}
xml.plugin(name:"${pluginName}",version:"${plugin.version}", grailsVersion:pluginGrailsVersion) {
props.each {
if( plugin.properties[it] ) "${it}"(plugin.properties[it])
}
resources {
for(r in resourceList) {
def matcher = r.URL.toString() =~ artefactPattern
def name = matcher[0][1].replaceAll('/', /\./)
resource(name)
}
}
dependencies {
if(plugin.metaClass.hasProperty(plugin,'dependsOn')) {
for(d in plugin.dependsOn) {
delegate.plugin(name:d.key, version:d.value)
}
}
IvyDependencyManager dependencyManager = grailsSettings.dependencyManager
dependencyManager.serialize(delegate, false)
}
def docContext = DocumentationContext.instance
if(docContext) {
behavior {
for(DocumentedMethod m in docContext.methods) {
method(name:m.name, artefact:m.artefact, type:m.type?.name) {
description m.text
if(m.arguments) {
for(arg in m.arguments) {
argument type:arg.name
}
}
}
}
for(DocumentedMethod m in docContext.staticMethods) {
'static-method'(name:m.name, artefact:m.artefact, type:m.type?.name) {
description m.text
if(m.arguments) {
for(arg in m.arguments) {
argument type:arg.name
}
}
}
}
for(DocumentedProperty p in docContext.properties) {
property(name:p.name, type:p?.type?.name, artefact:p.artefact) {
description p.text
}
}
}
}
}
return plugin
}
target(loadPlugins:"Loads Grails' plugins") {
if(!PluginManagerHolder.pluginManager) { // plugin manager already loaded?
compConfig.setTargetDirectory(classesDir)
def unit = new CompilationUnit ( compConfig , null , new GroovyClassLoader(classLoader) )
def pluginFiles = pluginSettings.pluginDescriptors
for(plugin in pluginFiles) {
def pluginFile = plugin.file
def className = pluginFile.name - '.groovy'
def classFile = new File("${classesDirPath}/${className}.class")
if(pluginFile.lastModified() > classFile.lastModified()) {
unit.addSource ( pluginFile )
}
}
try {
profile("compiling plugins") {
unit.compile ()
}
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
}
pluginManager = new DefaultGrailsPluginManager(pluginClasses as Class[], grailsApp)
PluginManagerHolder.setPluginManager(pluginManager)
pluginSettings.pluginManager = pluginManager
}
}
profile("loading plugins") {
event("PluginLoadStart", [pluginManager])
pluginManager.loadPlugins()
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, Dependencies: $p.dependencyNames"
}
exit(1)
}
pluginManager.doArtefactConfiguration()
grailsApp.initialise()
event("PluginLoadEnd", [pluginManager])
}
}
catch (Exception e) {
GrailsUtil.deepSanitize(e).printStackTrace()
event("StatusFinal", [ "Error loading plugin manager: " + e.message ])
exit(1)
}
}
else {
// Add the plugin manager to the binding so that it can be accessed
// from any target.
pluginManager = PluginManagerHolder.pluginManager
}
}
target(updatePluginsList:"Updates the plugin list from the remote plugin-list.xml") {
try {
println "Reading remote plugin list ..."
if(!pluginsListFile.exists())
readRemotePluginList()
parsePluginList()
def localRevision = pluginsList ? new Integer(pluginsList.getAttribute('revision')) : -1
// extract plugins svn repository revision - used for determining cache up-to-date
def remoteRevision = 0
fetchPluginListFile(remotePluginList).withReader { Reader reader ->
def line = reader.readLine()
while(line) {
Matcher matcher = line =~ /<plugins revision="(\d+?)">/
if(matcher) {
remoteRevision = matcher.group(1).toInteger()
break
}
else {
line = reader.readLine()
}
}
}
profile("Updating plugin list if remote list [$remoteRevision] is newer than local ${localRevision}") {
if (remoteRevision > localRevision) {
println "Plugin list out-of-date, retrieving.."
readRemotePluginList()
// Load up the new plugin list.
pluginsList = null
parsePluginList()
}
}
} catch (Exception e) {
println "Error reading remote plugin list [${e.message}], building locally..."
updatePluginsListManually()
}
}
def resetClasspathAndState() {
// Update the cached dependencies in grailsSettings, and add new jars to the root loader
['compile', 'build', 'test', 'runtime'].each { type ->
def existing = grailsSettings."${type}Dependencies"
def all = grailsSettings.dependencyManager.resolveDependencies(IvyDependencyManager."${type.toUpperCase()}_CONFIGURATION").allArtifactsReports.localFile
def toAdd = all - existing
if (toAdd) {
existing.addAll(toAdd)
if (type in ['build', 'test']) {
toAdd.each {
grailsSettings.rootLoader.addURL(it.toURL())
}
}
}
}
pluginSettings.clearCache()
classpathSet = false
classpath()
PluginManagerHolder.pluginManager = null
}
def parsePluginList() {
if(pluginsList == null) {
profile("Reading local plugin list from $pluginsListFile") {
def document
try {
document = DOMBuilder.parse(new FileReader(pluginsListFile))
} catch (Exception e) {
println "Plugin list file corrupt, retrieving again.."
readRemotePluginList()
document = DOMBuilder.parse(new FileReader(pluginsListFile))
}
pluginsList = document.documentElement
}
}
}
def readRemotePluginList() {
ant.delete(file:pluginsListFile, failonerror:false)
ant.mkdir(dir:pluginsListFile.parentFile)
fetchRemoteFile(remotePluginList, pluginsListFile)
}
target(updatePluginsListManually: "Updates the plugin list by manually reading each URL, the slow way") {
depends(configureProxy)
try {
def recreateCache = false
document = null
if (!pluginsListFile.exists()) {
println "Plugins list cache doesn't exist creating.."
recreateCache = true
}
else {
try {
document = DOMBuilder.parse(new FileReader(pluginsListFile))
} catch (Exception e) {
recreateCache = true
println "Plugins list cache is corrupt [${e.message}]. Re-creating.."
}
}
if (recreateCache) {
document = DOMBuilder.newInstance().createDocument()
def root = document.createElement('plugins')
root.setAttribute('revision', '0')
document.appendChild(root)
}
pluginsList = document.documentElement
builder = new DOMBuilder(document)
def localRevision = pluginsList ? new Integer(pluginsList.getAttribute('revision')) : -1
// extract plugins svn repository revision - used for determining cache up-to-date
def remoteRevision = 0
try {
// determine if this is a secure plugin spot..
if (shouldUseSVNProtocol(pluginDistURL)) {
withSVNRepo(pluginDistURL) { repo ->
remoteRevision = repo.getLatestRevision()
if (remoteRevision > localRevision) {
// Plugins list cache is expired, need to update
event("StatusUpdate", ["Plugins list cache has expired. Updating, please wait"])
pluginsList.setAttribute('revision', remoteRevision as String)
repo.getDir('', -1,null,(Collection)null).each() { entry ->
final String PREFIX = "grails-"
if (entry.name.startsWith(PREFIX)) {
def pluginName = entry.name.substring(PREFIX.length())
buildPluginInfo(pluginsList, pluginName)
}
}
}
}
}
else {
new URL(pluginDistURL).withReader { Reader reader ->
def line = reader.readLine()
line.eachMatch(/Revision (.*):/) {
remoteRevision = it[1].toInteger()
}
if (remoteRevision > localRevision) {
// Plugins list cache is expired, need to update
event("StatusUpdate", ["Plugins list cache has expired. Updating, please wait"])
pluginsList.setAttribute('revision', remoteRevision as String)
// for each plugin directory under Grails Plugins SVN in form of 'grails-*'
while(line=reader.readLine()) {
line.eachMatch(/<li><a href="grails-(.+?)">/) {
// extract plugin name
def pluginName = it[1][0..-2]
// collect information about plugin
buildPluginInfo(pluginsList, pluginName)
}
}
}
}
}
}
catch(Exception e) {
event("StatusError", ["Unable to list plugins, please check you have a valid internet connection: ${e.message}" ])
}
// update plugins list cache file
writePluginsFile()
} catch (Exception e) {
event("StatusError", ["Unable to list plugins, please check you have a valid internet connection: ${e.message}" ])
}
}
shouldUseSVNProtocol = { pluginDistURL ->
return isSecureUrl(pluginDistURL) || pluginDistURL.startsWith("file://")
}
// Utility Closures
/**
* 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.collect { new XmlSlurper().parse(it.file) }
}
/**
* @deprecated Use "pluginSettings.pluginXmlMetadata" instead.
*/
getPluginXmlMetadata = {
pluginSettings.pluginXmlMetadata
}
/**
* Obtains the directory for the given plugin name
*/
getPluginDirForName = { String pluginName ->
pluginSettings.getPluginDirForName(pluginName)
}
/**
* Obtains all of the plugin directories
* @deprecated Use "pluginSettings.pluginDirectories".
*/
getPluginDirectories = {->
pluginSettings.pluginDirectories
}
/**
* Obtains an array of all plugin source files as Spring Resource objects
* @deprecated Use "pluginSettings.pluginSourceFiles".
*/
getPluginSourceFiles = {
pluginSettings.pluginSourceFiles
}
/**
* Obtains an array of all the plugin provides Gant scripts
* @deprecated Use "pluginSettings.pluginScripts".
*/
getPluginScripts = {
pluginSettings.pluginScripts
}
/**
* Gets a list of all scripts known to the application (excluding private scripts starting with _)
* @deprecated Use "pluginSettings.availableScripts".
*/
getAllScripts = {
pluginSettings.availableScripts
}
/**
* Obtains a list of all Grails plugin descriptor classes
* @deprecated Use "pluginSettings.pluginDescriptors".
*/
getPluginDescriptors = {
pluginSettings.pluginDescriptors
}
/**
* Gets the base plugin descriptor
* @deprecated Use "pluginSettings.basePluginDescriptor".
*/
getBasePluginDescriptor = {
pluginSettings.basePluginDescriptor
}
/**
* Runs a script contained within a plugin
*/
runPluginScript = { File scriptFile, fullPluginName, msg ->
if (scriptFile.exists()) {
event("StatusUpdate", ["Executing ${fullPluginName} plugin $msg"])
// instrumenting plugin scripts adding 'pluginBasedir' variable
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
}
}
/**
* Downloads a remote plugin zip into the plugins dir
*/
downloadRemotePlugin = { url, pluginsBase ->
def slash = url.file.lastIndexOf('/')
def fullPluginName = "${url.file[slash + 8..-5]}"
String zipLocation = "${pluginsBase}/grails-${fullPluginName}.zip"
fetchRemoteFile("${url}", zipLocation)
readMetadataFromZip(zipLocation, url)
return fullPluginName
}
/**
* Caches a local plugin into the plugins directory
*/
cacheLocalPlugin = { pluginFile ->
fullPluginName = "${pluginFile.name[7..-5]}"
String zipLocation = "${pluginsBase}/grails-${fullPluginName}.zip"
ant.copy(file: pluginFile, tofile: zipLocation)
readMetadataFromZip(zipLocation, pluginFile)
return fullPluginName
}
private readMetadataFromZip(String zipLocation, pluginFile) {
def zipFile = new ZipFile(zipLocation)
ZipEntry entry = zipFile.entries().find {ZipEntry entry -> entry.name == 'plugin.xml'}
if (entry) {
pluginXml = new XmlSlurper().parse(zipFile.getInputStream(entry))
currentPluginName = pluginXml.'@name'.text()
currentPluginRelease = pluginXml.'@version'.text()
fullPluginName = "$currentPluginName-$currentPluginRelease"
}
else {
cleanupPluginInstallAndExit("Plug-in $pluginFile is not a valid Grails plugin. No plugin.xml descriptor found!")
}
}
/**
* Searches the downloaded plugin-list.xml files for each repository for a plugin that matches the given name
*/
findPlugin = { pluginName ->
pluginName = pluginName?.toLowerCase()
plugin = null
if(pluginName) {
if(!plugin) {
eachRepository { name, url ->
plugin = pluginsList.'plugin'.find { it.'@name' == pluginName }
(!plugin)
}
}
return plugin
}
}
/**
* Stores a plugin from the plugin central repo into the local plugin cache
*/
cacheKnownPlugin = { String pluginName, String pluginRelease ->
def pluginDistName
def plugin
def fullPluginName
try {
use(DOMCategory) {
plugin = findPlugin(pluginName)
if (plugin) {
pluginRelease = pluginRelease ? pluginRelease : plugin.'@latest-release'
if (pluginRelease) {
def release = plugin.'release'.find {rel -> rel.'@version' == pluginRelease }
if (release) {
pluginDistName = release.'file'.text()
} else {
cleanupPluginInstallAndExit("Release ${pluginRelease} was not found for this plugin. Type 'grails plugin-info ${pluginName}'")
}
} else {
cleanupPluginInstallAndExit("Latest release information is not available for plugin '${pluginName}', specify concrete release to install")
}
} else {
cleanupPluginInstallAndExit("Plugin '${pluginName}' was not found in repository. If it is not stored in a configured repository you will need to install it manually. Type 'grails list-plugins' to find out what plugins are available.")
}
def pluginCacheFileName = "${pluginsBase}/grails-${plugin.'@name'}-${pluginRelease}.zip"
if (!new File(pluginCacheFileName).exists() || pluginRelease.endsWith("SNAPSHOT")) {
ant.mkdir(dir:pluginsBase)
if(!pluginDistName) {
cleanupPluginInstallAndExit("Plugin '${pluginName}' is in the [$repositoryName] repository, but contains no valid releases.")
}
else {
fetchRemoteFile("${pluginDistName}", pluginCacheFileName)
}
}
fullPluginName = "$pluginName-$pluginRelease"
currentPluginName = pluginName
currentPluginRelease = pluginRelease
ant.copy(file:"${pluginsBase}/grails-${fullPluginName}.zip",tofile:"${pluginsHome}/grails-${fullPluginName}.zip")
}
return fullPluginName
}
finally {
configureRepository(DEFAULT_PLUGIN_DIST)
}
}
cleanupPluginInstallAndExit = { message ->
event("StatusError", [message])
for(pluginDir in installedPlugins) {
if (checkPluginPath(pluginDir)) {
ant.delete(dir:pluginDir, failonerror:false)
}
}
exit(1)
}
/**
* Uninstalls a plugin for the given name and version
*/
uninstallPluginForName = { name, version=null ->
String pluginKey = "plugins.$name"
metadata.remove(pluginKey)
metadata.persist()
def pluginDir
if(name && version) {
pluginDir = new File("${pluginsHome}/$name-$version")
}
else {
pluginDir = getPluginDirForName(name)?.file
}
if(pluginDir?.exists()) {
def uninstallScript = new File("${pluginDir}/scripts/_Uninstall.groovy")
runPluginScript(uninstallScript, pluginDir.name, "uninstall script")
if (checkPluginPath(pluginDir)) {
ant.delete(dir:pluginDir, failonerror:true)
}
resetClasspathAndState()
}
else {
event("StatusError", ["No plugin [$name${version ? '-' + version : ''}] installed, cannot uninstall"])
}
}
/**
* Installs a plugin for the given name and optional version
*/
installPluginForName = { String fullPluginName ->
if (fullPluginName) {
event("InstallPluginStart", [fullPluginName])
def pluginInstallPath = "${globalInstall ? globalPluginsDirPath : pluginsHome}/${fullPluginName}"
def pluginReference = grailsSettings.config.grails.plugin.location[currentPluginName]
if(pluginReference) {
cleanupPluginInstallAndExit("""\
Plugin [$currentPluginName] is aliased as [grails.plugin.location.$currentPluginName] to the location [$pluginReference] in grails-app/conf/BuildConfig.groovy.
You cannot upgrade a plugin that is configured via BuildConfig.groovy, remove the configuration to continue.""" );
}
Resource currentInstall = getPluginDirForName(currentPluginName)
PluginBuildSettings pluginSettings = pluginSettings
if(currentInstall?.exists()) {
if(pluginSettings.isInlinePluginLocation(currentInstall)) {
cleanupPluginInstallAndExit("The plugin you are trying to install [${fullPluginName}] is already configured as an inplace plugin in grails-app/conf/BuildConfig.groovy. You cannot overwrite inplace plugins." );
}
else if(!isInteractive || confirmInput("You currently already have a version of the plugin installed [$currentInstall.filename]. Do you want to upgrade this version?", "upgrade.${fullPluginName}.plugin")) {
ant.delete(dir:currentInstall.file)
}
else {
cleanupPluginInstallAndExit("Plugin $fullPluginName install aborted" );
}
}
installedPlugins << pluginInstallPath
if (checkPluginPath(pluginInstallPath)) {
ant.delete(dir: pluginInstallPath, failonerror: false)
ant.mkdir(dir: pluginInstallPath)
ant.unzip(dest: pluginInstallPath, src: "${pluginsBase}/grails-${fullPluginName}.zip")
println "Installed plugin ${fullPluginName} to location ${pluginInstallPath}."
}
else {
println "Cannot install plugin. Plugin install would override inline plugin configuration which is not allowed."
exit 1
}
def pluginXmlFile = new File("${pluginInstallPath}/plugin.xml")
if (!pluginXmlFile.exists()) {
cleanupPluginInstallAndExit("Plugin $fullPluginName is not a valid Grails plugin. No plugin.xml descriptor found!")
}
def pluginXml = new XmlSlurper().parse(pluginXmlFile)
def pluginName = pluginXml.@name.toString()
def pluginVersion = pluginXml.@version.toString()
def pluginGrailsVersion = pluginXml.@grailsVersion.toString()
if(pluginGrailsVersion) {
if(!GrailsPluginUtils.isValidVersion(GrailsUtil.grailsVersion, pluginGrailsVersion)) {
cleanupPluginInstallAndExit("Plugin $fullPluginName requires version [${pluginGrailsVersion}] of Grails which your current Grails installation does not meet. Please try install a different version of the plugin or Grails.")
}
}
// Add the plugin's directory to the binding so that any event
// handlers in the plugin have access to it. Normally, this
// variable is added in GrailsScriptRunner, but this plugin
// hasn't been installed by that point.
binding.setVariable("${GrailsNameUtils.getPropertyNameForLowerCaseHyphenSeparatedName(pluginName)}PluginDir", new File(pluginInstallPath).absoluteFile)
def dependencies = [:]
for (dep in pluginXml.dependencies.plugin) {
def depName = dep.@name.toString()
String depVersion = dep.@version.toString()
if(isCorePlugin(depName)) {
def grailsVersion = GrailsUtil.getGrailsVersion()
if(!GrailsPluginUtils.isValidVersion(grailsVersion, depVersion ))
cleanupPluginInstallAndExit("Plugin requires version [$depVersion] of Grails core, but installed version is [${grailsVersion}]. Please upgrade your Grails installation and try again.")
}
else {
dependencies[depName] = depVersion
def depDirName = GrailsNameUtils.getScriptName(depName)
def depPluginDir = getPluginDirForName(depDirName)?.file
if (!depPluginDir?.exists()) {
event("StatusUpdate", ["Plugin dependency [$depName] not found. Attempting to resolve..."])
// recursively install dependent plugins
def upperVersion = GrailsPluginUtils.getUpperVersion(depVersion)
def installVersion = upperVersion
if(installVersion == '*') {
installVersion = grailsSettings.defaultPluginSet.contains(depDirName) ? GrailsUtil.getGrailsVersion() : null
}
def release = cacheKnownPlugin(depDirName, installVersion)
ant.copy(file:"${pluginsBase}/grails-${release}.zip",tofile:"${pluginsDirPath}/grails-${release}.zip")
installPluginForName(release)
dependencies.remove(depName)
}
else {
def dependency = readPluginXmlMetadata(depDirName)
def dependencyVersion = dependency.@version.toString()
if (!GrailsPluginUtils.isValidVersion(dependencyVersion, depVersion)) {
cleanupPluginInstallAndExit("Plugin requires version [$depVersion] of plugin [$depName], but installed version is [${dependencyVersion}]. Please upgrade this plugin and try again.")
}
else {
dependencies.remove(depName)
}
}
}
}
if (dependencies) {
ant.delete(dir: "${pluginInstallPath}", quiet: true, failOnError: false)
clean()
cleanupPluginInstallAndExit("Failed to install plugin [${fullPluginName}]. Missing dependencies: ${dependencies.inspect()}")
}
else {
def pluginDependencyDescriptor = new File("$pluginInstallPath/dependencies.groovy")
if(pluginDependencyDescriptor.exists()) {
println "Resolving plugin JAR dependencies"
BuildSettings settings = grailsSettings
def callable = settings.pluginDependencyHandler()
callable.call(new File("$pluginInstallPath"))
IvyDependencyManager dependencyManager = settings.dependencyManager
dependencyManager.resetGrailsPluginsResolver()
def resolveReport = dependencyManager.resolveDependencies(IvyDependencyManager.RUNTIME_CONFIGURATION)
if(resolveReport.hasError()) {
cleanupPluginInstallAndExit("Failed to install plugin [${fullPluginName}]. Plugin has missing JAR dependencies.")
}
}
else {
def pluginJars = resolveResources("file:${pluginInstallPath}/lib/*.jar")
for(jar in pluginJars) {
rootLoader.addURL(jar.URL)
}
}
// proceed _Install.groovy plugin script if exists
def installScript = new File("${pluginInstallPath}/scripts/_Install.groovy")
runPluginScript(installScript, fullPluginName, "post-install script")
registerPluginWithMetadata(pluginName, pluginVersion)
def providedScripts = resolveResources("file:${pluginInstallPath}/scripts/*.groovy").findAll { !it.filename.startsWith('_')}
event("StatusFinal", ["Plugin ${fullPluginName} installed"])
if (providedScripts) {
println "Plug-in provides the following new scripts:"
println "------------------------------------------"
providedScripts.file.each {file ->
def scriptName = GrailsNameUtils.getScriptName(file.name)
println "grails ${scriptName}"
}
}
File pluginEvents = new File("${pluginInstallPath}/scripts/_Events.groovy")
if (pluginEvents.exists()) {
println "Found events script in plugin ${pluginName}"
eventListener.loadEventsScript(pluginEvents)
}
event("PluginInstalled", [fullPluginName])
}
}
}
doInstallPluginFromURL = { URL url ->
withPluginInstall {
downloadRemotePlugin(url, pluginsBase)
}
}
doInstallPluginZip = { File file ->
withPluginInstall {
cacheLocalPlugin(file)
}
}
doInstallPlugin = { name, version = null ->
withPluginInstall {
cacheKnownPlugin(name,version)
}
}
doInstallPluginFromGrailsHomeOrRepository = { name, version = null ->
withPluginInstall {
boolean hasVersion = name && version
File pluginZip
if(hasVersion) {
def zipName = "grails-${name}-${version}"
pluginZip = new File("${grailsSettings.grailsHome}/plugins/${zipName}.zip")
if(!pluginZip.exists()) {
pluginZip = new File("${grailsSettings.grailsWorkDir}/plugins/${zipName}.zip")
}
}
else {
def zipNameNoVersion = "grails-${name}"
pluginZip = findZip(zipNameNoVersion,"${grailsSettings.grailsHome}/plugins")
if(!pluginZip?.exists()) {
pluginZip = findZip(zipNameNoVersion,"${grailsSettings.grailsWorkDir}/plugins")
}
}
if(pluginZip?.exists()) {
cacheLocalPlugin(pluginZip)
}
else {
cacheKnownPlugin(name,version)
}
}
}
File findZip(String name, String dir) {
new File(dir).listFiles().find {it.name.startsWith(name)}
}
private withPluginInstall(Closure callable) {
try {
fullPluginName = callable.call()
completePluginInstall(fullPluginName)
}
catch (e) {
logError("Error installing plugin: ${e.message}", e)
exit(1)
}
}
private completePluginInstall (fullPluginName) {
classpath ()
println "Installing plugin $fullPluginName"
installPluginForName(fullPluginName)
}
def registerPluginWithMetadata(String pluginName, pluginVersion) {
metadata['plugins.' + pluginName] = pluginVersion
metadata.persist()
}
def buildReleaseInfo(root, pluginName, releasePath, releaseTag) {
// quick exit nothing to do..
if (releaseTag == '..' || releaseTag == 'LATEST_RELEASE') {
return
}
// remove previous version..
def releaseNode = root.'release'.find() {
it.'@tag' == releaseTag && it.'&type' == 'svn'
}
if (releaseNode) {
root.removeChild(releaseNode)
}
try {
// copy the properties to the new node..
def releaseUrl = "${releasePath}/${releaseTag}"
def properties = ['title', 'author', 'authorEmail', 'description', 'documentation']
def releaseDescriptor = parseRemoteXML("${releaseUrl}/plugin.xml").documentElement
def version = releaseDescriptor.'@version'
releaseNode = builder.createNode('release', [tag: releaseTag, version: version, type: 'svn'])
root.appendChild(releaseNode)
properties.each {
if (releaseDescriptor."${it}") {
releaseNode.appendChild(builder.createNode(it, releaseDescriptor."${it}".text()))
}
}
releaseNode.appendChild(builder.createNode('file', "${releaseUrl}/grails-${pluginName}-${version}.zip"))
}
catch(e) {
// no release info available, probably an older plugin with no plugin.xml defined.
}
}
def writePluginsFile() {
pluginsListFile.parentFile.mkdirs()
Transformer transformer = TransformerFactory.newInstance().newTransformer()
transformer.setOutputProperty(OutputKeys.INDENT, "true")
transformer.transform(new DOMSource(document), new StreamResult(pluginsListFile))
}
def parseRemoteXML(url) {
fetchPluginListFile(url).withReader() { DOMBuilder.parse(it) }
}
def buildBinaryPluginInfo(root, pluginName ){
// split plugin name in form of 'plugin-name-0.1' to name ('plugin-name') and version ('0.1')
def matcher = (pluginName =~ /^([^\d]+)-(.++)/)
// convert to new plugin naming convention (MyPlugin -> my-plugin)
def name = GrailsNameUtils.getScriptName(matcher[0][1])
def release = matcher[0][2]
use(DOMCategory) {
def pluginNode = root.'plugin'.find {it.'@name' == name}
if (!pluginNode) {
pluginNode = builder.'plugin'(name: name)
root.appendChild(pluginNode)
}
def releaseNode = pluginNode.'release'.find {it.'@version' == release && it.'@type' == 'zip'}
// SVN releases have higher precedence than binary releases
if (pluginNode.'release'.find {it.'@version' == release && it.'@type' == 'svn'}) {
if (releaseNode) pluginNode.removeChild(releaseNode)
return
}
if (!releaseNode) {
releaseNode = builder.'release'(type: 'zip', version: release) {
title("This is a zip release, no info available for it")
file("${pluginBinaryDistURL}/grails-${pluginName}.zip")
}
pluginNode.appendChild(releaseNode)
}
}
}
def buildPluginInfo(root, pluginName) {
use(DOMCategory) {
// determine the plugin node..
def pluginNode = root.'plugin'.find {it.'@name' == pluginName}
if (!pluginNode) {
// add it if it doesn't exist..
pluginNode = builder.'plugin'(name: pluginName)
root.appendChild(pluginNode)
}
// add each of the releases..
event("StatusUpdate", ["Reading [$pluginName] plugin info"])
// determine if this is a secure plugin spot..
def tagsUrl = "${pluginDistURL}/grails-${pluginName}/tags"
try {
if (shouldUseSVNProtocol(pluginDistURL)) {
withSVNRepo(tagsUrl) { repo ->
repo.getDir('',-1,null,(Collection)null).each() { entry ->
buildReleaseInfo(pluginNode, pluginName, tagsUrl, entry.name)
}
}
}
else {
def releaseTagsList = new URL(tagsUrl).text
releaseTagsList.eachMatch(/<li><a href="(.+?)">/) {
def releaseTag = it[1][0..-2]
buildReleaseInfo(pluginNode, pluginName, tagsUrl, releaseTag)
}
}
}
catch(e) {
// plugin has not tags
println "Plugin [$pluginName] doesn't have any tags"
}
try {
def latestRelease = null
def url = "${pluginDistURL}/grails-${pluginName}/tags/LATEST_RELEASE/plugin.xml"
fetchPluginListFile(url).withReader {Reader reader ->
def line = reader.readLine()
line.eachMatch (/.+?version='(.+?)'.+/) {
latestRelease = it[1]
}
}
if (latestRelease && pluginNode.'release'.find {it.'@version' == latestRelease}) {
pluginNode.setAttribute('latest-release', latestRelease as String)
}
}
catch(e) {
// plugin doesn't have a latest release
println "Plugin [$pluginName] doesn't have a latest release"
}
}
}
fetchRemoteFile = { url, destfn ->
if (shouldUseSVNProtocol(pluginDistURL)) {
// fetch the remote file..
fetchRemote(url) { repo, file ->
// get the latest file from the repository..
def f = (destfn instanceof File) ? destfn : new File(destfn)
f.withOutputStream() { os ->
def props = new SVNProperties()
repo.getFile(file , (long)-1L, props , os)
}
}
} else {
ant.get(src:url, dest:destfn, verbose:"yes", usetimestamp:true)
}
}
/**
* Fetch the entire plugin list file.
*/
fetchPluginListFile = { url ->
// attempt to fetch the file using SVN.
if (shouldUseSVNProtocol(pluginDistURL)) {
def rdr = fetchRemote(url) { repo, file ->
// get the latest file from the repository..
def props = new SVNProperties()
def baos = new ByteArrayOutputStream()
def ver = repo.getFile(file , (long)-1L, props , baos)
def mimeType = props.getSVNPropertyValue(SVNProperty.MIME_TYPE)
if (!SVNProperty.isTextMimeType(mimeType)) {
throw new Exception("Must be a text file..")
}
def bytes = baos.toByteArray()
def str = new String(bytes, 'utf-8')
def r = new StringReader(str)
return r
}
return rdr
}
// attempt using URL
return new URL(url)
}
def fetchRemote(url, closure) {
def idx = url.lastIndexOf('/')
def svnUrl = url.substring(0,idx)
def file = url.substring(idx+1,url.length())
withSVNRepo(svnUrl) { repo ->
// determine if the file exists
SVNNodeKind nodeKind = repo.checkPath(file , -1)
if (nodeKind == SVNNodeKind.NONE) {
throw new Exception("The file does not exist.: " + url)
} else if (nodeKind != SVNNodeKind.FILE) {
throw new Exception("Error not a file..: " + url)
}
// present w/ file etc for repo extraction
closure.call(repo, file)
}
}
def isSecureUrl(Object url) {
url.startsWith('https://') || url.startsWith('svn://')
}
withSVNRepo = { url, closure ->
// create a authetication manager using the defaults
ISVNAuthenticationManager authMgr = getAuthFromUrl(url,"discovery")
// create the url
def svnUrl = SVNURL.parseURIEncoded(url)
def repo = SVNRepositoryFactory.create(svnUrl, null)
repo.authenticationManager = authMgr
// trigger authentication failure?.?.
try {
repo.getLatestRevision()
} catch (SVNAuthenticationException ex) {
event "StatusUpdate", ["Default authentication failed please enter credentials."]
// prompt for login information..
ant.input(message:"Please enter your SVN username:", addproperty:"user.svn.username")
ant.input(message:"Please enter your SVN password:", addproperty:"user.svn.password")
def username = ant.antProject.properties."user.svn.username"
def password = ant.antProject.properties."user.svn.password"
authMgr = SVNWCUtil.createDefaultAuthenticationManager( username , password )
repo.setAuthenticationManager(authMgr)
// don't bother to catch this one let it bubble up..
repo.getLatestRevision()
}
// make sure the closure return is returned..
closure.call(repo)
}
/**
* Check to see if the plugin directory is in plugins home.
*/
checkPluginPath = { pluginDir ->
// insure all the directory is in the pluginsHome
checkPluginPathWithPluginDir(pluginsHome, pluginDir) ||
checkPluginPathWithPluginDir(globalPluginsDirPath, pluginDir)
}
def checkPluginPathWithPluginDir (pluginsHome, pluginDir) {
def absPluginsHome = pluginsHome instanceof File ? pluginsHome : new File (pluginsHome).absolutePath
if (pluginDir instanceof File) {
pluginDir.absolutePath.startsWith(absPluginsHome)
}
else {
new File(pluginDir).absolutePath.startsWith(absPluginsHome)
}
}
Jump to Line
Something went wrong with that request. Please try again.