From 7c19d7930ed623dd57428df63c58e82d3e34fe2a Mon Sep 17 00:00:00 2001 From: Kohsuke Kawaguchi Date: Tue, 29 Mar 2011 16:49:44 -0700 Subject: [PATCH] added a new method to interpret the path with relative names --- .../java/hudson/model/AbstractProject.java | 10 +-- core/src/main/java/hudson/model/Hudson.java | 70 +++++++++++++++++++ core/src/main/java/hudson/model/Items.java | 12 +++- .../main/java/hudson/tasks/BuildTrigger.java | 35 ++++++++-- .../main/java/hudson/tasks/MailSender.java | 2 +- .../test/AggregatedTestResultPublisher.java | 2 +- 6 files changed, 115 insertions(+), 16 deletions(-) diff --git a/core/src/main/java/hudson/model/AbstractProject.java b/core/src/main/java/hudson/model/AbstractProject.java index b7c3cf1146..a5e1a3f889 100644 --- a/core/src/main/java/hudson/model/AbstractProject.java +++ b/core/src/main/java/hudson/model/AbstractProject.java @@ -627,7 +627,7 @@ public abstract class AbstractProject

,R extends A Set upstream = Collections.emptySet(); if(req.getParameter("pseudoUpstreamTrigger")!=null) { - upstream = new HashSet(Items.fromNameList(req.getParameter("upstreamProjects"),AbstractProject.class)); + upstream = new HashSet(Items.fromNameList(getParent(),req.getParameter("upstreamProjects"),AbstractProject.class)); } // dependency setting might have been changed by the user, so rebuild. @@ -645,7 +645,7 @@ public abstract class AbstractProject

,R extends A // does 'p' include us in its BuildTrigger? DescribableList> pl = p.getPublishersList(); BuildTrigger trigger = pl.get(BuildTrigger.class); - List newChildProjects = trigger == null ? new ArrayList():trigger.getChildProjects(); + List newChildProjects = trigger == null ? new ArrayList():trigger.getChildProjects(p); if(isUpstream) { if(!newChildProjects.contains(this)) newChildProjects.add(this); @@ -673,13 +673,13 @@ public abstract class AbstractProject

,R extends A pl.removeAll(BuildTrigger.class); Set combinedChildren = new HashSet(); for (BuildTrigger bt : existingList) - combinedChildren.addAll(bt.getChildProjects()); + combinedChildren.addAll(bt.getChildProjects(p)); existing = new BuildTrigger(new ArrayList(combinedChildren),existingList.get(0).getThreshold()); pl.add(existing); break; } - if(existing!=null && existing.hasSame(newChildProjects)) + if(existing!=null && existing.hasSame(p,newChildProjects)) continue; // no need to touch pl.replace(new BuildTrigger(newChildProjects, existing==null?Result.SUCCESS:existing.getThreshold())); @@ -1432,7 +1432,7 @@ public abstract class AbstractProject

,R extends A for (AbstractProject ap : getUpstreamProjects()) { BuildTrigger buildTrigger = ap.getPublishersList().get(BuildTrigger.class); if (buildTrigger != null) - if (buildTrigger.getChildProjects().contains(this)) + if (buildTrigger.getChildProjects(ap).contains(this)) result.add(ap); } return result; diff --git a/core/src/main/java/hudson/model/Hudson.java b/core/src/main/java/hudson/model/Hudson.java index b8f8d4725a..988625d2db 100644 --- a/core/src/main/java/hudson/model/Hudson.java +++ b/core/src/main/java/hudson/model/Hudson.java @@ -2060,6 +2060,76 @@ public final class Hudson extends Node implements ItemGroup, Stapl return item; } + /** + * Gets the item by its relative name from the given context + * + *

Relative Names

+ *

+ * If the name starts from '/', like "/foo/bar/zot", then it's interpreted as absolute. + * Otherwise, the name should be something like "../foo/bar" and it's interpreted like + * relative path name is, against the given context. + * + * @param context + * null is interpreted as {@link Hudson}. Base 'directory' of the interpretation. + * @since 1.406 + */ + public Item getItem(String relativeName, ItemGroup context) { + if (context==null) context = this; + + if (relativeName.startsWith("/")) // absolute + return getItemByFullName(relativeName); + + Object/*Item|ItemGroup*/ ctx = context; + + StringTokenizer tokens = new StringTokenizer(relativeName,"/"); + while (tokens.hasMoreTokens()) { + String s = tokens.nextToken(); + if (s.equals("..")) { + if (ctx instanceof Item) { + ctx = ((Item)ctx).getParent(); + continue; + } + + ctx=null; // can't go up further + break; + } + if (s.equals(".")) { + continue; + } + + if (ctx instanceof ItemGroup) { + ItemGroup g = (ItemGroup) ctx; + Item i = g.getItem(s); + if (i==null || !i.hasPermission(Item.READ)) { + ctx=null; // can't go up further + break; + } + ctx=i; + } + } + + if (ctx instanceof Item) + return (Item)ctx; + + // fall back to the classic interpretation + return getItemByFullName(relativeName); + } + + public final Item getItem(String relativeName, Item context) { + return getItem(relativeName,context!=null?context.getParent():null); + } + + public final T getItem(String relativeName, ItemGroup context, Class type) { + Item r = getItem(relativeName, context); + if (type.isInstance(r)) + return type.cast(r); + return null; + } + + public final T getItem(String relativeName, Item context, Class type) { + return getItem(relativeName,context!=null?context.getParent():null,type); + } + public File getRootDirFor(TopLevelItem child) { return getRootDirFor(child.getName()); } diff --git a/core/src/main/java/hudson/model/Items.java b/core/src/main/java/hudson/model/Items.java index 275aeb77b8..5ad8b14498 100644 --- a/core/src/main/java/hudson/model/Items.java +++ b/core/src/main/java/hudson/model/Items.java @@ -79,16 +79,24 @@ public class Items { } /** - * Does the opposite of {@link #toNameList(Collection)}. + * @deprecated as of 1.406 + * Use {@link #fromNameList(ItemGroup, String, Class)} */ public static List fromNameList(String list, Class type) { + return fromNameList(null,list,type); + } + + /** + * Does the opposite of {@link #toNameList(Collection)}. + */ + public static List fromNameList(ItemGroup context, String list, Class type) { Hudson hudson = Hudson.getInstance(); List r = new ArrayList(); StringTokenizer tokens = new StringTokenizer(list,","); while(tokens.hasMoreTokens()) { String fullName = tokens.nextToken().trim(); - T item = hudson.getItemByFullName(fullName,type); + T item = hudson.getItem(fullName, context, type); if(item!=null) r.add(item); } diff --git a/core/src/main/java/hudson/tasks/BuildTrigger.java b/core/src/main/java/hudson/tasks/BuildTrigger.java index 4d28f4dcea..55a9a3b3f3 100644 --- a/core/src/main/java/hudson/tasks/BuildTrigger.java +++ b/core/src/main/java/hudson/tasks/BuildTrigger.java @@ -37,6 +37,7 @@ import hudson.model.DependencyGraph; import hudson.model.DependencyGraph.Dependency; import hudson.model.Hudson; import hudson.model.Item; +import hudson.model.ItemGroup; import hudson.model.Items; import hudson.model.Job; import hudson.model.Project; @@ -125,8 +126,20 @@ public class BuildTrigger extends Recorder implements DependecyDeclarer { return threshold; } + /** + * @deprecated as of 1.406 + * Use {@link #getChildProjects(ItemGroup)} + */ public List getChildProjects() { - return Items.fromNameList(childProjects,AbstractProject.class); + return getChildProjects(Hudson.getInstance()); + } + + public List getChildProjects(AbstractProject owner) { + return getChildProjects(owner==null?null:owner.getParent()); + } + + public List getChildProjects(ItemGroup base) { + return Items.fromNameList(base,childProjects,AbstractProject.class); } public BuildStepMonitor getRequiredMonitorService() { @@ -136,11 +149,19 @@ public class BuildTrigger extends Recorder implements DependecyDeclarer { /** * Checks if this trigger has the exact same set of children as the given list. */ - public boolean hasSame(Collection projects) { - List children = getChildProjects(); + public boolean hasSame(AbstractProject owner, Collection projects) { + List children = getChildProjects(owner); return children.size()==projects.size() && children.containsAll(projects); } + /** + * @deprecated as of 1.406 + * Use {@link #hasSame(AbstractProject, Collection)} + */ + public boolean hasSame(Collection projects) { + return hasSame(null,projects); + } + @Override public boolean perform(AbstractBuild build, Launcher launcher, BuildListener listener) { return true; @@ -200,7 +221,7 @@ public class BuildTrigger extends Recorder implements DependecyDeclarer { } public void buildDependencyGraph(AbstractProject owner, DependencyGraph graph) { - for (AbstractProject p : getChildProjects()) + for (AbstractProject p : getChildProjects(owner)) graph.addDependency(new Dependency(owner, p) { @Override public boolean shouldTriggerBuild(AbstractBuild build, TaskListener listener, @@ -292,16 +313,16 @@ public class BuildTrigger extends Recorder implements DependecyDeclarer { /** * Form validation method. */ - public FormValidation doCheck(@AncestorInPath AccessControlled subject, @QueryParameter String value ) { + public FormValidation doCheck(@AncestorInPath Item project, @QueryParameter String value ) { // Require CONFIGURE permission on this project - if(!subject.hasPermission(Item.CONFIGURE)) return FormValidation.ok(); + if(!project.hasPermission(Item.CONFIGURE)) return FormValidation.ok(); StringTokenizer tokens = new StringTokenizer(Util.fixNull(value),","); boolean hasProjects = false; while(tokens.hasMoreTokens()) { String projectName = tokens.nextToken().trim(); if (StringUtils.isNotBlank(projectName)) { - Item item = Hudson.getInstance().getItemByFullName(projectName,Item.class); + Item item = Hudson.getInstance().getItem(projectName,project,Item.class); if(item==null) return FormValidation.error(Messages.BuildTrigger_NoSuchProject(projectName,AbstractProject.findNearest(projectName).getName())); if(!(item instanceof AbstractProject)) diff --git a/core/src/main/java/hudson/tasks/MailSender.java b/core/src/main/java/hudson/tasks/MailSender.java index 6695f5283b..efc3bbb070 100644 --- a/core/src/main/java/hudson/tasks/MailSender.java +++ b/core/src/main/java/hudson/tasks/MailSender.java @@ -315,7 +315,7 @@ public class MailSender { if(address.startsWith("upstream-individuals:")) { // people who made a change in the upstream String projectName = address.substring("upstream-individuals:".length()); - AbstractProject up = Hudson.getInstance().getItemByFullName(projectName,AbstractProject.class); + AbstractProject up = Hudson.getInstance().getItem(projectName,build.getProject(),AbstractProject.class); if(up==null) { listener.getLogger().println("No such project exist: "+projectName); continue; diff --git a/core/src/main/java/hudson/tasks/test/AggregatedTestResultPublisher.java b/core/src/main/java/hudson/tasks/test/AggregatedTestResultPublisher.java index 6ec7ee4616..fe63b9a650 100644 --- a/core/src/main/java/hudson/tasks/test/AggregatedTestResultPublisher.java +++ b/core/src/main/java/hudson/tasks/test/AggregatedTestResultPublisher.java @@ -335,7 +335,7 @@ public class AggregatedTestResultPublisher extends Recorder { for (String name : Util.tokenize(fixNull(value), ",")) { name = name.trim(); - if(Hudson.getInstance().getItemByFullName(name)==null) + if(Hudson.getInstance().getItem(name,project)==null) return FormValidation.error(hudson.tasks.Messages.BuildTrigger_NoSuchProject(name,AbstractProject.findNearest(name).getName())); }