Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  package org.apache.maven.plugin.version;
  
  /*
   * Licensed to the Apache Software Foundation (ASF) under one
   * or more contributor license agreements.  See the NOTICE file
   * distributed with this work for additional information
   * regarding copyright ownership.  The ASF licenses this file
   * to you 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 java.io.File;
 import java.io.Writer;
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
 
     extends AbstractLogEnabled
     implements PluginVersionManager
 {
 
     private ArtifactFactory artifactFactory;
 
     private InputHandler inputHandler;
 
 
     // TODO: [jc] Revisit to remove this piece of state. PLUGIN REGISTRY MAY BE UPDATED ON DISK OUT-OF-PROCESS!
     private PluginRegistry pluginRegistry;
 
 
 
     // TODO: Revisit to remove this piece of state. PLUGIN REGISTRY MAY BE UPDATED ON DISK OUT-OF-PROCESS!
     private Map resolvedMetaVersions = new HashMap();
 
     public String resolvePluginVersionString groupIdString artifactIdMavenProject projectSettings settings,
                                         ArtifactRepository localRepository )
     {
         return resolvePluginVersiongroupIdartifactIdprojectsettingslocalRepositoryfalse );
     }
 
     public String resolveReportPluginVersionString groupIdString artifactIdMavenProject project,
                                               Settings settingsArtifactRepository localRepository )
     {
         return resolvePluginVersiongroupIdartifactIdprojectsettingslocalRepositorytrue );
     }
    private String resolvePluginVersionString groupIdString artifactIdMavenProject projectSettings settings,
                                         ArtifactRepository localRepositoryboolean resolveAsReportPlugin )
    {
        // first pass...if the plugin is specified in the pom, try to retrieve the version from there.
        String version = getVersionFromPluginConfiggroupIdartifactIdprojectresolveAsReportPlugin );
        // NOTE: We CANNOT check the current project version here, so delay it until later.
        // It will prevent plugins from building themselves, if they are part of the lifecycle mapping.
        // if there was no explicit version, try for one in the reactor
        if ( version == null )
        {
            if ( project.getProjectReferences() != null )
            {
                String refId = ArtifactUtils.versionlessKeygroupIdartifactId );
                MavenProject ref = (MavenProjectproject.getProjectReferences().getrefId );
                if ( ref != null )
                {
                    version = ref.getVersion();
                }
            }
        }
        // we're NEVER going to persist POM-derived plugin versions.
        String updatedVersion = null;
        // we're not going to prompt the user to accept a plugin update until we find one.
        boolean promptToPersist = false;
        RuntimeInfo settingsRTInfo = settings.getRuntimeInfo();
        // determine the behavior WRT prompting the user and installing plugin updates.
        Boolean pluginUpdateOverride = settingsRTInfo.getPluginUpdateOverride();
        // second pass...if we're using the plugin registry, and the plugin is listed in the plugin-registry.xml, use
        // the version from <useVersion/>.
        if ( StringUtils.isEmptyversion ) && settings.isUsePluginRegistry() )
        {
            // resolve existing useVersion.
            version = resolveExistingFromPluginRegistrygroupIdartifactId );
            if ( StringUtils.isNotEmptyversion ) )
            {
                // 2. check for updates. Determine whether this is the right time to attempt to update the version.
                // Only check for plugin updates if:
                //
                //  a. the CLI switch to force plugin updates is set, OR BOTH OF THE FOLLOWING:
                //  b. the CLI switch to suppress plugin updates is NOT set, AND
                //  c. the update interval for the plugin has triggered an update check.
                if ( ..equalspluginUpdateOverride ) ||
                    ( !..equalspluginUpdateOverride ) && shouldCheckForUpdatesgroupIdartifactId ) ) )
                {
                    updatedVersion =
                        resolveMetaVersiongroupIdartifactIdprojectlocalRepository. );
                    if ( StringUtils.isNotEmptyupdatedVersion ) && !updatedVersion.equalsversion ) )
                    {
                        // see if this version we've resolved is on our previously rejected list.
                        boolean isRejected = checkForRejectedStatusgroupIdartifactIdupdatedVersion );
                        // we should only prompt to use this version if the user has not previously rejected it.
                        promptToPersist = !isRejected;
                        // if we've rejected this version previously, forget about updating.
                        if ( isRejected )
                        {
                            updatedVersion = null;
                        }
                        else
                        {
                            getLogger().info(
                                "Plugin \'" + constructPluginKeygroupIdartifactId ) + "\' has updates." );
                        }
                    }
                }
            }
        }
        boolean forcePersist = false;
        // third pass...we're always checking for latest install/deploy, so retrieve the version for LATEST metadata and
        // also set that resolved version as the <useVersion/> in settings.xml.
        if ( StringUtils.isEmptyversion ) )
        {
            // 1. resolve the version to be used
            version = resolveMetaVersiongroupIdartifactIdprojectlocalRepository. );
            if ( version != null )
            {
                // 2. Set the updatedVersion so the user will be prompted whether to make this version permanent.
                updatedVersion = version;
                // 3. Persist this version without prompting.
                forcePersist = true;
                promptToPersist = false;
            }
        }
        // final pass...retrieve the version for RELEASE and also set that resolved version as the <useVersion/>
        // in settings.xml.
        if ( StringUtils.isEmptyversion ) )
        {
            // 1. resolve the version to be used
            version = resolveMetaVersiongroupIdartifactIdprojectlocalRepository. );
            if ( version != null )
            {
                // 2. Set the updatedVersion so the user will be prompted whether to make this version permanent.
                updatedVersion = version;
                // 3. Persist this version without prompting.
                forcePersist = true;
                promptToPersist = false;
            }
        }
        // if we're still empty here, and the current project matches the plugin in question, use the current project's
        // version, I guess...
        if ( StringUtils.isEmptyversion ) && project.getGroupId().equalsgroupId ) &&
            project.getArtifactId().equalsartifactId ) )
        {
            version = project.getVersion();
        }
        // if we still haven't found a version, then fail early before we get into the update goop.
        if ( StringUtils.isEmptyversion ) )
        {
            throw new PluginVersionNotFoundExceptiongroupIdartifactId );
        }
        // if the plugin registry is inactive, then the rest of this goop is useless...
        if ( settings.isUsePluginRegistry() )
        {
            // determine whether this build is running in interactive mode
            // If it's not, then we'll defer to the autoUpdate setting from the registry
            // for a decision on updating the plugin in the registry...rather than prompting
            // the user.
            boolean inInteractiveMode = settings.isInteractiveMode();
            // determines what should be done if we're in non-interactive mode.
            // if true, then just update the registry with the new versions.
            String s = getPluginRegistrygroupIdartifactId ).getAutoUpdate();
            boolean autoUpdate = true;
            if ( s != null )
            {
                autoUpdate = Boolean.valueOfs ).booleanValue();
            }
            // We should persist by default if:
            //
            // 0. RELEASE or LATEST was used to resolve the plugin version (it's not in the registry)
            //
            // -OR-
            //
            // 1. we detected a change in the plugin version from what was in the registry, or
            //      a. the plugin is not registered
            // 2. the pluginUpdateOverride flag has NOT been set to Boolean.FALSE (suppression mode)
            // 3. we're in interactive mode, or
            //      a. the registry is declared to be in autoUpdate mode
            //
            // NOTE: This is only the default value; it may be changed as the result of prompting the user.
            boolean persistUpdate = forcePersist || ( promptToPersist &&
                !..equalspluginUpdateOverride ) && ( inInteractiveMode || autoUpdate ) );
            // retrieve the apply-to-all flag, if it's been set previously.
            Boolean applyToAll = settings.getRuntimeInfo().getApplyToAllPluginUpdates();
            // Incorporate interactive-mode CLI overrides, and previous decisions on apply-to-all, if appropriate.
            //
            // don't prompt if RELEASE or LATEST was used to resolve the plugin version
            // don't prompt if not in interactive mode.
            // don't prompt if the CLI pluginUpdateOverride is set (either suppression or force mode will stop prompting)
            // don't prompt if the user has selected ALL/NONE previously in this session
            //
            // NOTE: We're incorporating here, to make the usages of this check more consistent and 
            // resistant to change.
            promptToPersist =
                promptToPersist && pluginUpdateOverride == null && applyToAll == null && inInteractiveMode;
            if ( promptToPersist )
            {
                persistUpdate = promptToPersistPluginUpdateversionupdatedVersiongroupIdartifactIdsettings );
            }
            // if it is determined that we should use this version, persist it as useVersion.
            // cases where this version will be persisted:
            // 1. the user is prompted and answers yes or all
            // 2. the user has previously answered all in this session
            // 3. the build is running in non-interactive mode, and the registry setting is for auto-update
            if ( !..equalsapplyToAll ) && persistUpdate )
            {
                updatePluginVersionInRegistrygroupIdartifactIdupdatedVersion );
                // we're using the updated version of the plugin in this session as well.
                version = updatedVersion;
            }
            // otherwise, if we prompted the user to update, we should treat this as a rejectedVersion, and
            // persist it iff the plugin pre-exists and is in the user-level registry.
            else if ( promptToPersist )
            {
                addNewVersionToRejectedListInExistinggroupIdartifactIdupdatedVersion );
            }
        }
        return version;
    }
    private boolean shouldCheckForUpdatesString groupIdString artifactId )
        throws PluginVersionResolutionException
    {
        PluginRegistry pluginRegistry = getPluginRegistrygroupIdartifactId );
        org.apache.maven.plugin.registry.Plugin plugin = getPlugingroupIdartifactIdpluginRegistry );
        if ( plugin == null )
        {
            return true;
        }
        else
        {
            String lastChecked = plugin.getLastChecked();
            if ( StringUtils.isEmptylastChecked ) )
            {
                return true;
            }
            else
            {
                SimpleDateFormat format =
                    new SimpleDateFormat...... );
                try
                {
                    Date lastCheckedDate = format.parselastChecked );
                    return IntervalUtils.isExpiredpluginRegistry.getUpdateInterval(), lastCheckedDate );
                }
                catch ( ParseException e )
                {
                    getLogger().warn"Last-checked date for plugin {" + constructPluginKeygroupIdartifactId ) +
                        "} is invalid. Checking for updates." );
                    return true;
                }
            }
        }
    }
    private boolean checkForRejectedStatusString groupIdString artifactIdString version )
        throws PluginVersionResolutionException
    {
        PluginRegistry pluginRegistry = getPluginRegistrygroupIdartifactId );
        org.apache.maven.plugin.registry.Plugin plugin = getPlugingroupIdartifactIdpluginRegistry );
        return plugin.getRejectedVersions().containsversion );
    }
    private boolean promptToPersistPluginUpdateString versionString updatedVersionString groupId,
                                                 String artifactIdSettings settings )
        throws PluginVersionResolutionException
    {
        try
        {
            StringBuffer message = new StringBuffer();
            // this means that the plugin is not registered.
            if ( version != null && version.equalsupdatedVersion ) )
            {
                message.append"Unregistered plugin detected.\n\n" );
            }
            else
            {
                message.append"New plugin version detected.\n\n" );
            }
            message.append"Group ID: " ).appendgroupId ).append"\n" );
            message.append"Artifact ID: " ).appendartifactId ).append"\n" );
            message.append"\n" );
            // this means that we've detected a new, non-rejected plugin version.
            if ( version != null && !version.equalsupdatedVersion ) )
            {
                message.append"Registered Version: " ).appendversion ).append"\n" );
            }
            message.append"Detected plugin version: " ).appendupdatedVersion ).append"\n" );
            message.append"\n" );
            message.append"Would you like to use this new version from now on? ( [Y]es, [n]o, [a]ll, n[o]ne ) " );
            // TODO: check the GUI-friendliness of this approach to collecting input.
            // If we can't port this prompt into a GUI, IDE-integration will not work well.
            getLogger().infomessage.toString() );
            String persistAnswer = .readLine();
            boolean shouldPersist = true;
            if ( !StringUtils.isEmptypersistAnswer ) )
            {
                persistAnswer = persistAnswer.toLowerCase();
                if ( persistAnswer.startsWith"y" ) )
                {
                    shouldPersist = true;
                }
                else if ( persistAnswer.startsWith"a" ) )
                {
                    shouldPersist = true;
                    settings.getRuntimeInfo().setApplyToAllPluginUpdates. );
                }
                else if ( persistAnswer.indexOf"o" ) > -1 )
                {
                    settings.getRuntimeInfo().setApplyToAllPluginUpdates. );
                }
                else if ( persistAnswer.startsWith"n" ) )
                {
                    shouldPersist = false;
                }
                else
                {
                    // default to yes.
                    shouldPersist = true;
                }
            }
            if ( shouldPersist )
            {
                getLogger().info"Updating plugin version to " + updatedVersion );
            }
            else
            {
                getLogger().info"NOT updating plugin version to " + updatedVersion );
            }
            return shouldPersist;
        }
        catch ( IOException e )
        {
            throw new PluginVersionResolutionExceptiongroupIdartifactId"Can't read user input."e );
        }
    }
    private void addNewVersionToRejectedListInExistingString groupIdString artifactIdString rejectedVersion )
        throws PluginVersionResolutionException
    {
        PluginRegistry pluginRegistry = getPluginRegistrygroupIdartifactId );
        org.apache.maven.plugin.registry.Plugin plugin = getPlugingroupIdartifactIdpluginRegistry );
        String pluginKey = constructPluginKeygroupIdartifactId );
        if ( plugin != null && !..equalsplugin.getSourceLevel() ) )
        {
            plugin.addRejectedVersionrejectedVersion );
            writeUserRegistrygroupIdartifactIdpluginRegistry );
            getLogger().warn"Plugin version: " + rejectedVersion + " added to your rejectedVersions list.\n" +
                "You will not be prompted for this version again.\n\nPlugin: " + pluginKey );
        }
        else
        {
            getLogger().warn(
                "Cannot add rejectedVersion entry for: " + rejectedVersion + ".\n\nPlugin: " + pluginKey );
        }
    }
    private String resolveExistingFromPluginRegistryString groupIdString artifactId )
        throws PluginVersionResolutionException
    {
        PluginRegistry pluginRegistry = getPluginRegistrygroupIdartifactId );
        org.apache.maven.plugin.registry.Plugin plugin = getPlugingroupIdartifactIdpluginRegistry );
        String version = null;
        if ( plugin != null )
        {
            version = plugin.getUseVersion();
        }
        return version;
    }
    private org.apache.maven.plugin.registry.Plugin getPluginString groupIdString artifactId,
                                                               PluginRegistry pluginRegistry )
    {
        Map pluginsByKey;
        if ( pluginRegistry != null )
        {
            pluginsByKey = pluginRegistry.getPluginsByKey();
        }
        else
        {
            pluginsByKey = new HashMap();
        }
        String pluginKey = constructPluginKeygroupIdartifactId );
        return (org.apache.maven.plugin.registry.PluginpluginsByKey.getpluginKey );
    }
    private String constructPluginKeyString groupIdString artifactId )
    {
        return groupId + ":" + artifactId;
    }
    private String getVersionFromPluginConfigString groupIdString artifactIdMavenProject project,
                                               boolean resolveAsReportPlugin )
    {
        String version = null;
        if ( resolveAsReportPlugin )
        {
            if ( project.getReportPlugins() != null )
            {
                for ( Iterator it = project.getReportPlugins().iterator(); it.hasNext() && version == null; )
                {
                    ReportPlugin plugin = (ReportPluginit.next();
                    if ( groupId.equalsplugin.getGroupId() ) && artifactId.equalsplugin.getArtifactId() ) )
                    {
                        version = plugin.getVersion();
                    }
                }
            }
        }
        else
        {
            if ( project.getBuildPlugins() != null )
            {
                for ( Iterator it = project.getBuildPlugins().iterator(); it.hasNext() && version == null; )
                {
                    Plugin plugin = (Pluginit.next();
                    if ( groupId.equalsplugin.getGroupId() ) && artifactId.equalsplugin.getArtifactId() ) )
                    {
                        version = plugin.getVersion();
                    }
                }
            }
        }
        return version;
    }
    private void updatePluginVersionInRegistryString groupIdString artifactIdString version )
        throws PluginVersionResolutionException
    {
        PluginRegistry pluginRegistry = getPluginRegistrygroupIdartifactId );
        org.apache.maven.plugin.registry.Plugin plugin = getPlugingroupIdartifactIdpluginRegistry );
        // if we can find the plugin, but we've gotten here, the useVersion must be missing; fill it in.
        if ( plugin != null )
        {
            if ( ..equalsplugin.getSourceLevel() ) )
            {
                // do nothing. We don't rewrite the globals, under any circumstances.
                getLogger().warn"Cannot update registered version for plugin {" + groupId + ":" + artifactId +
                    "}; it is specified in the global registry." );
            }
            else
            {
                plugin.setUseVersionversion );
                SimpleDateFormat format =
                    new SimpleDateFormat...... );
                plugin.setLastCheckedformat.formatnew Date() ) );
            }
        }
        else
        {
            plugin = new org.apache.maven.plugin.registry.Plugin();
            plugin.setGroupIdgroupId );
            plugin.setArtifactIdartifactId );
            plugin.setUseVersionversion );
            pluginRegistry.addPluginplugin );
            pluginRegistry.flushPluginsByKey();
        }
        writeUserRegistrygroupIdartifactIdpluginRegistry );
    }
    private void writeUserRegistryString groupIdString artifactIdPluginRegistry pluginRegistry )
    {
        File pluginRegistryFile = pluginRegistry.getRuntimeInfo().getFile();
        PluginRegistry extractedUserRegistry = PluginRegistryUtils.extractUserPluginRegistrypluginRegistry );
        // only rewrite the user-level registry if one existed before, or if we've created user-level data here.
        if ( extractedUserRegistry != null )
        {
            Writer fWriter = null;
            try
            {
                pluginRegistryFile.getParentFile().mkdirs();
                fWriter = WriterFactory.newXmlWriterpluginRegistryFile );
                PluginRegistryXpp3Writer writer = new PluginRegistryXpp3Writer();
                writer.writefWriterextractedUserRegistry );
            }
            catch ( IOException e )
            {
                getLogger().warn(
                    "Cannot rewrite user-level plugin-registry.xml with new plugin version of plugin: \'" + groupId +
                        ":" + artifactId + "\'."e );
            }
            finally
            {
                IOUtil.closefWriter );
            }
        }
    }
    private PluginRegistry getPluginRegistryString groupIdString artifactId )
        throws PluginVersionResolutionException
    {
        if (  == null )
        {
            try
            {
            }
            catch ( IOException e )
            {
                throw new PluginVersionResolutionExceptiongroupIdartifactId,
                                                            "Error reading plugin registry: " + e.getMessage(), e );
            }
            catch ( XmlPullParserException e )
            {
                throw new PluginVersionResolutionExceptiongroupIdartifactId,
                                                            "Error parsing plugin registry: " + e.getMessage(), e );
            }
            if (  == null )
            {
            }
        }
        return ;
    }
    private String resolveMetaVersionString groupIdString artifactIdMavenProject project,
                                       ArtifactRepository localRepositoryString metaVersionId )
    {
        Artifact artifact = .createProjectArtifactgroupIdartifactIdmetaVersionId );
        String key = artifact.getDependencyConflictId();
        if ( .containsKeykey ) )
        {
            return (String.getkey );
        }
        String version = null;
        // This takes the spec version and resolves a real version
        try
        {
            ResolutionGroup resolutionGroup =
                .retrieveartifactlocalRepositoryproject.getPluginArtifactRepositories() );
            // switching this out with the actual resolved artifact instance, since the MMSource re-creates the pom
            // artifact.
            artifact = resolutionGroup.getPomArtifact();
        }
        catch ( ArtifactMetadataRetrievalException e )
        {
            throw new PluginVersionResolutionExceptiongroupIdartifactIde.getMessage(), e );
        }
        String artifactVersion = artifact.getVersion();
        // make sure this artifact was actually resolved to a file in the repo...
        if ( artifact.getFile() != null )
        {
            boolean pluginValid = false;
            while ( !pluginValid && artifactVersion != null )
            {
                pluginValid = true;
                MavenProject pluginProject;
                try
                {
                    artifact = .createProjectArtifactgroupIdartifactIdartifactVersion );
                    pluginProject = .buildFromRepositoryartifact,
                                                                             project.getPluginArtifactRepositories(),
                                                                             localRepositoryfalse );
                }
                catch ( ProjectBuildingException e )
                {
                    throw new InvalidPluginException"Unable to build project information for plugin '" +
                        ArtifactUtils.versionlessKeygroupIdartifactId ) + "': " + e.getMessage(), e );
                }
                // if we don't have the required Maven version, then ignore an update
                if ( pluginProject.getPrerequisites() != null && pluginProject.getPrerequisites().getMaven() != null )
                {
                    DefaultArtifactVersion requiredVersion =
                        new DefaultArtifactVersionpluginProject.getPrerequisites().getMaven() );
                    if ( .getApplicationVersion().compareTorequiredVersion ) < 0 )
                    {
                        getLogger().info"Ignoring available plugin update: " + artifactVersion +
                            " as it requires Maven version " + requiredVersion );
                        VersionRange vr;
                        try
                        {
                            vr = VersionRange.createFromVersionSpec"(," + artifactVersion + ")" );
                        }
                        catch ( InvalidVersionSpecificationException e )
                        {
                            throw new PluginVersionResolutionExceptiongroupIdartifactId,
                                                                        "Error getting available plugin versions: " +
                                                                            e.getMessage(), e );
                        }
                        getLogger().debug"Trying " + vr );
                        try
                        {
                            List versions = .retrieveAvailableVersionsartifactlocalRepository,
                                                                                              project.getPluginArtifactRepositories() );
                            ArtifactVersion v = vr.matchVersionversions );
                            artifactVersion = v != null ? v.toString() : null;
                        }
                        catch ( ArtifactMetadataRetrievalException e )
                        {
                            throw new PluginVersionResolutionExceptiongroupIdartifactId,
                                                                        "Error getting available plugin versions: " +
                                                                            e.getMessage(), e );
                        }
                        if ( artifactVersion != null )
                        {
                            getLogger().debug"Found " + artifactVersion );
                            pluginValid = false;
                        }
                    }
                }
            }
        }
        if ( !metaVersionId.equalsartifactVersion ) )
        {
            version = artifactVersion;
            .putkeyversion );
        }
        return version;
    }
New to GrepCode? Check out our FAQ X