[FIXED JENKINS-17565] allow to address jobs by displayName in bot com…

…mands
jenkinsci · May 26, 2013 · 579d105 · 579d105
1 parent fa839a2
commit 579d105
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 3 deletions.
diff --git a/src/main/java/hudson/plugins/im/bot/AbstractMultipleJobCommand.java b/src/main/java/hudson/plugins/im/bot/AbstractMultipleJobCommand.java
@@ -109,7 +109,7 @@ Pair<Mode, String> getProjects(Sender sender, String[] args, Collection<Abstract
                 mode = Mode.SINGLE;
                 String jobName = MessageHelper.getJoinedName(args, 1);
 
-                AbstractProject<?, ?> project = getJobProvider().getJobByName(jobName);
+                AbstractProject<?, ?> project = getJobProvider().getJobByNameOrDisplayName(jobName);
                 if (project != null) {
                     projects.add(project);
                 } else {

diff --git a/src/main/java/hudson/plugins/im/bot/AbstractSingleJobCommand.java b/src/main/java/hudson/plugins/im/bot/AbstractSingleJobCommand.java
@@ -55,7 +55,7 @@ protected String getReply(Bot bot, Sender sender, String[] args) {
                 jobName = args[1].replace("\"", "");
                 remainingArgs = MessageHelper.copyOfRange(args, 2, args.length);
             }
-            AbstractProject<?, ?> job = getJobProvider().getJobByName(jobName);
+            AbstractProject<?, ?> job = getJobProvider().getJobByNameOrDisplayName(jobName);
             if (job != null) {
                 if (!job.hasPermission(getRequiredPermission())) {
                     return "You don't have the permissions to perform this command on this job.";

diff --git a/src/main/java/hudson/plugins/im/bot/BuildCommand.java b/src/main/java/hudson/plugins/im/bot/BuildCommand.java
@@ -62,7 +62,7 @@ public String getReply(Bot bot, Sender sender, String args[]) {
 		if (args.length >= 2) {
 			String jobName = args[1];
 			jobName = jobName.replaceAll("\"", "");
-    		AbstractProject<?, ?> project = getJobProvider().getJobByName(jobName);
+    		AbstractProject<?, ?> project = getJobProvider().getJobByNameOrDisplayName(jobName);
 			if (project != null) {
 
 			    String checkPermission = checkPermission(sender, project);

diff --git a/src/main/java/hudson/plugins/im/bot/DefaultJobProvider.java b/src/main/java/hudson/plugins/im/bot/DefaultJobProvider.java
@@ -18,6 +18,25 @@ public class DefaultJobProvider implements JobProvider {
     public AbstractProject<?, ?> getJobByName(String name) {
         return Jenkins.getInstance().getItemByFullName(name, AbstractProject.class);
     }
+
+
+    @SuppressWarnings("rawtypes")
+    @Override
+    public AbstractProject<?, ?> getJobByDisplayName(String displayName) {
+        List<AbstractProject> allItems = Jenkins.getInstance().getAllItems(AbstractProject.class);
+        for (AbstractProject job : allItems) {
+            if (displayName.equals(job.getDisplayName())) {
+                return job;
+            }
+        }
+        return null;
+    }
+
+    @Override
+    public AbstractProject<?, ?> getJobByNameOrDisplayName(String name) {
+        AbstractProject<?,?> jobByName = getJobByName(name);
+        return jobByName != null ? jobByName : getJobByDisplayName(name);
+    }
 
     @SuppressWarnings("unchecked")
     @Override

diff --git a/src/main/java/hudson/plugins/im/bot/JobProvider.java b/src/main/java/hudson/plugins/im/bot/JobProvider.java
@@ -16,6 +16,21 @@ public interface JobProvider {
     @CheckForNull
     AbstractProject<?, ?> getJobByName(String name);
 
+    /**
+     * Returns the Jenkins job with the given display name or null
+     * if no job with that display name exists.
+     * <p>
+     * Attention: this might be relativley expensive, if you've a lot of Jenkins jobs!
+     */
+    @CheckForNull
+    AbstractProject<?, ?> getJobByDisplayName(String displayName);
+
+    /**
+     * Convenience method to 1st try to get by name and then by display name.
+     */
+    @CheckForNull
+    AbstractProject<?, ?> getJobByNameOrDisplayName(String displayName);
+
     /**
      * Returns all Jenkins jobs.
      *