Skip to content

Commit

Permalink
[FIXED JENKINS-10678] integrated the patch to improve the tag paramet…
Browse files Browse the repository at this point in the history 
…er drop-down list. apologies for the delay.
  • Loading branch information
kohsuke committed Aug 23, 2011
1 parent c54e086 commit b1fabc3
Show file tree
Hide file tree
Showing 2 changed files with 208 additions and 55 deletions.
167 changes: 157 additions & 10 deletions src/main/java/hudson/scm/listtagsparameter/ListSubversionTagsParameterDefinition.java
View file
Expand Up @@ -47,12 +47,16 @@
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
import org.tmatesoft.svn.core.SVNDirEntry;
import org.tmatesoft.svn.core.SVNException;
import org.tmatesoft.svn.core.SVNURL;
import org.tmatesoft.svn.core.auth.ISVNAuthenticationManager;
import org.tmatesoft.svn.core.auth.ISVNAuthenticationProvider;
import org.tmatesoft.svn.core.io.SVNRepository;
import org.tmatesoft.svn.core.io.SVNRepositoryFactory;
import org.tmatesoft.svn.core.wc.SVNLogClient;
import org.tmatesoft.svn.core.wc.SVNRevision;
import org.apache.commons.lang.StringUtils;

/**
* Defines a new {@link ParameterDefinition} to be displayed at the top of the
Expand All @@ -74,6 +78,12 @@ public class ListSubversionTagsParameterDefinition extends ParameterDefinition i
private final String tagsFilter;
private final boolean reverseByDate;
private final boolean reverseByName;
private final String defaultValue;
private final String maxTags;
private static final String SVN_BRANCHES = "branches";
private static final String SVN_TAGS = "tags";
private static final String SVN_TRUNK = "trunk";

/**
* We use a UUID to uniquely identify each use of this parameter: We need this
* to find the project using this parameter in the getTags() method (which is
Expand All @@ -82,12 +92,14 @@ public class ListSubversionTagsParameterDefinition extends ParameterDefinition i
private final UUID uuid;

@DataBoundConstructor
public ListSubversionTagsParameterDefinition(String name, String tagsDir, String tagsFilter, boolean reverseByDate, boolean reverseByName, String uuid) {
public ListSubversionTagsParameterDefinition(String name, String tagsDir, String tagsFilter, String defaultValue, String maxTags, boolean reverseByDate, boolean reverseByName, String uuid) {
super(name, ResourceBundleHolder.get(ListSubversionTagsParameterDefinition.class).format("TagDescription"));
this.tagsDir = Util.removeTrailingSlash(tagsDir);
this.tagsFilter = tagsFilter;
this.reverseByDate = reverseByDate;
this.reverseByName = reverseByName;
this.defaultValue = defaultValue;
this.maxTags = maxTags;

if(uuid == null || uuid.length() == 0) {
this.uuid = UUID.randomUUID();
Expand All @@ -102,9 +114,7 @@ public ListSubversionTagsParameterDefinition(String name, String tagsDir, String
public ParameterValue createValue(StaplerRequest req) {
String[] values = req.getParameterValues(getName());
if(values == null || values.length != 1) {
// the parameter is mandatory, the build has to fail if it's not there (we
// can't assume a default value)
return null;
return this.getDefaultParameterValue();
}
else {
return new ListSubversionTagsParameterValue(getName(), getTagsDir(), values[0]);
Expand All @@ -121,6 +131,14 @@ public ParameterValue createValue(StaplerRequest req, JSONObject formData) {
// still goes on...
return value;
}

@Override
public ParameterValue getDefaultParameterValue() {
if (StringUtils.isEmpty(this.defaultValue)) {
return null;
}
return new ListSubversionTagsParameterValue(getName(), getTagsDir(), this.defaultValue);
}

@Override
public DescriptorImpl getDescriptor() {
Expand Down Expand Up @@ -159,16 +177,23 @@ public List<String> getTags() {
}

SimpleSVNDirEntryHandler dirEntryHandler = new SimpleSVNDirEntryHandler(tagsFilter);
List<String> dirs = new ArrayList<String>();

try {
ISVNAuthenticationProvider authProvider = getDescriptor().createAuthenticationProvider(context);

ISVNAuthenticationManager authManager = SubversionSCM.createSvnAuthenticationManager(authProvider);

SVNURL repoURL = SVNURL.parseURIDecoded(getTagsDir());

SVNRepository repo = SVNRepositoryFactory.create(repoURL);
repo.setAuthenticationManager(authManager);
SVNLogClient logClient = new SVNLogClient(authManager, null);
logClient.doList(repoURL, SVNRevision.HEAD, SVNRevision.HEAD, false, false, dirEntryHandler);

if (isSVNRepositoryProjectRoot(repo)) {
dirs = this.getSVNRootRepoDirectories(logClient, repoURL);
} else {
logClient.doList(repoURL, SVNRevision.HEAD, SVNRevision.HEAD, false, false, dirEntryHandler);
dirs = dirEntryHandler.getDirs(isReverseByDate(), isReverseByName());
}
}
catch(SVNException e) {
// logs are not translated (IMO, this is a bad idea to translate logs)
Expand All @@ -183,8 +208,6 @@ public List<String> getTags() {
}};
}

List<String> dirs = dirEntryHandler.getDirs(isReverseByDate(), isReverseByName());

// SVNKit's doList() method returns also the parent dir, so we need to remove it
if(dirs != null) {
removeParentDir(dirs);
Expand All @@ -200,6 +223,12 @@ public List<String> getTags() {
add("&lt;" + ResourceBundleHolder.get(ListSubversionTagsParameterDefinition.class).format("NoDirectoryEntriesFound") + "&gt;");
}};
}

// Conform list to the maxTags option.
Integer max = (isInt(this.maxTags) ? Integer.parseInt(this.maxTags) : null);
if((max != null) && (dirs.size() > max)) {
dirs = dirs.subList(0, max);
}

return dirs;
}
Expand All @@ -219,7 +248,125 @@ public boolean isReverseByDate() {
public boolean isReverseByName() {
return reverseByName;
}

public String getDefaultValue() {
return defaultValue;
}

public String getMaxTags() {
return maxTags;
}

/**
* Checks to see if given repository contains a trunk, branches, and tags
* directories.
*
* @param repo
* Repository to check.
* @return True if trunk, branches, and tags exist.
*/
private boolean isSVNRepositoryProjectRoot(SVNRepository repo) {
try {
SVNDirEntry trunkEntry = repo.info("./" + SVN_TRUNK, SVNRevision.HEAD.getNumber());
SVNDirEntry branchesEntry = repo.info("./" + SVN_BRANCHES, SVNRevision.HEAD.getNumber());
SVNDirEntry tagsEntry = repo.info("./" + SVN_TAGS, SVNRevision.HEAD.getNumber());

if ((trunkEntry != null) && (branchesEntry != null) && (tagsEntry != null)) {
return true;
}

} catch (SVNException e) {
return false;
}
return false;
}

/**
* Appends the target directory to all entries in a list. I.E. 1.2 -->
* branches/1.2
*
* @param targetDir
* The target directory to append.
* @param dirs
* List of directory entries
*/
private void appendTargetDir(String targetDir, List<String> dirs) {
if ((targetDir != null) && (dirs != null) && (dirs.size() > 0)) {
for (int i = 0; i < dirs.size(); i++) {
dirs.set(i, targetDir + System.getProperty("file.separator") + dirs.get(i));
}
}
}

private boolean isInt(String value) {
boolean isInteger = false;
try {
Integer.parseInt(value);
isInteger = true;
} catch (NumberFormatException e) {
isInteger = false;
}
return isInteger;
}

/**
* Returns a list of contents from the trunk, branches, and tags
* directories.
*
* @param logClient
* @param repoURL
* @return List of directories.
* @throws SVNException
*/
private List<String> getSVNRootRepoDirectories(SVNLogClient logClient, SVNURL repoURL) throws SVNException {

// Get the branches repository contents
List<String> dirs = null;
SVNURL branchesRepo = repoURL.appendPath(SVN_BRANCHES, true);
SimpleSVNDirEntryHandler branchesEntryHandler = new SimpleSVNDirEntryHandler(null);
logClient.doList(branchesRepo, SVNRevision.HEAD, SVNRevision.HEAD, false, false, branchesEntryHandler);
List<String> branches = branchesEntryHandler.getDirs(isReverseByDate(), isReverseByName());
branches.remove(SVN_BRANCHES);
appendTargetDir(SVN_BRANCHES, branches);

// Get the tags repository contents
SVNURL tagsRepo = repoURL.appendPath(SVN_TAGS, true);
SimpleSVNDirEntryHandler tagsEntryHandler = new SimpleSVNDirEntryHandler(null);
logClient.doList(tagsRepo, SVNRevision.HEAD, SVNRevision.HEAD, false, false, tagsEntryHandler);
List<String> tags = tagsEntryHandler.getDirs(isReverseByDate(), isReverseByName());
tags.remove(SVN_TAGS);
appendTargetDir(SVN_TAGS, tags);

// Merge trunk with the contents of branches and tags.
dirs = new ArrayList<String>();
dirs.add(SVN_TRUNK);

if (branches != null) {
dirs.addAll(branches);
}

if (tags != null) {
dirs.addAll(tags);
}

// Filter out any unwanted repository locations.
if (StringUtils.isNotBlank(tagsFilter)) {
Pattern filterPattern = Pattern.compile(tagsFilter);

if ((dirs != null) && (dirs.size() > 0) && (filterPattern != null)) {
List<String> temp = new ArrayList<String>();
for (String dir : dirs) {
if (filterPattern.matcher(dir).matches()) {
temp.add(dir);
}
}
dirs = temp;
}
}

return dirs;
}

/**
* Removes the parent directory (that is, the tags directory) from a list of
* directories.
Expand Down Expand Up @@ -286,4 +433,4 @@ public SubversionSCM.DescriptorImpl getSubversionSCMDescriptor() {

private final static Logger LOGGER = Logger.getLogger(ListSubversionTagsParameterDefinition.class.getName());

}
}
96 changes: 51 additions & 45 deletions ...resources/hudson/scm/listtagsparameter/ListSubversionTagsParameterDefinition/config.jelly
View file
@@ -1,45 +1,51 @@
<!--
- The MIT License
-
- Copyright (c) 2010-2011, Manufacture Francaise des Pneumatiques Michelin,
- Romain Seguy
-
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to deal
- in the Software without restriction, including without limitation the rights
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in
- all copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- THE SOFTWARE.
-->

<!-- this is the page fragment displayed to set up a job -->
<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form">
<f:entry title="${%Name}" field="name">
<f:textbox name="parameter.name" value="${instance.name}" />
</f:entry>
<f:entry title="${%Repository URL}" field="tagsDir">
<f:textbox name="parameter.tagsDir" value="${instance.tagsDir}" />
</f:entry>
<f:entry title="${%Tags filter}" field="tagsFilter">
<f:textbox field="tagsFilter"/>
</f:entry>
<f:entry field="reverseByDate">
<f:checkbox name="reverseByDate" checked="${instance.reverseByDate}"/>
<label class="attach-previous">${%Sort newest first}</label>
</f:entry>
<f:entry field="reverseByName">
<f:checkbox name="reverseByName" checked="${instance.reverseByName}"/>
<label class="attach-previous">${%Sort Z to A}</label>
</f:entry>
</j:jelly>
<!--
- The MIT License
-
- Copyright (c) 2010-2011, Manufacture Francaise des Pneumatiques Michelin,
- Romain Seguy
-
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to deal
- in the Software without restriction, including without limitation the rights
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in
- all copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- THE SOFTWARE.
-->

<!-- this is the page fragment displayed to set up a job -->
<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form">
<f:entry title="${%Name}" field="name">
<f:textbox name="parameter.name" value="${instance.name}" />
</f:entry>
<f:entry title="${%Repository URL}" field="tagsDir">
<f:textbox name="parameter.tagsDir" value="${instance.tagsDir}" />
</f:entry>
<f:entry title="${%Tags filter}" field="tagsFilter">
<f:textbox field="tagsFilter"/>
</f:entry>
<f:entry title="${%Default Value}" field="defaultValue">
<f:textbox field="parameter.defaultValue" value="${instance.defaultValue}" />
</f:entry>
<f:entry title="${%Maximum Tags to Display}" field="maxTags">
<f:textbox field="parameter.maxTags" value="${instance.maxTags}" />
</f:entry>
<f:entry field="reverseByDate">
<f:checkbox name="reverseByDate" checked="${instance.reverseByDate}"/>
<label class="attach-previous">${%Sort newest first}</label>
</f:entry>
<f:entry field="reverseByName">
<f:checkbox name="reverseByName" checked="${instance.reverseByName}"/>
<label class="attach-previous">${%Sort Z to A}</label>
</f:entry>
</j:jelly>

0 comments on commit b1fabc3

Please sign in to comment.