hudson.model.JobCollection Maven / Gradle / Ivy

Go to download
package hudson.model;

import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;

import javax.servlet.ServletException;
import java.io.IOException;
import java.util.Collection;
import java.util.Comparator;
import java.util.List;
import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;
import java.util.ArrayList;
import java.util.Collections;
import java.util.GregorianCalendar;

import hudson.scm.ChangeLogSet.Entry;
import hudson.Util;
import hudson.util.RunList;

/**
 * Collection of {@link Job}s.
 *
 * @author Kohsuke Kawaguchi
 */
public abstract class JobCollection extends AbstractModelObject {

    /**
     * Gets all the jobs in this collection.
     */
    public abstract Collection getJobs();

    /**
     * Checks if the job is in this collection.
     */
    public abstract boolean containsJob(Job job);

    /**
     * Gets the name of all this collection.
     */
    public abstract String getViewName();

    /**
     * Message displayed in the top page. Can be null. Includes HTML.
     */
    public abstract String getDescription();

    /**
     * Returns the path relative to the context root.
     */
    public abstract String getUrl();

    public static final class UserInfo implements Comparable {
        private final User user;
        private Calendar lastChange;
        private Project project;

        UserInfo(User user, Project p, Calendar lastChange) {
            this.user = user;
            this.project = p;
            this.lastChange = lastChange;
        }

        public User getUser() {
            return user;
        }

        public Calendar getLastChange() {
            return lastChange;
        }

        public Project getProject() {
            return project;
        }

        /**
         * Returns a human-readable string representation of when this user was last active.
         */
        public String getLastChangeTimeString() {
            long duration = new GregorianCalendar().getTimeInMillis()-lastChange.getTimeInMillis();
            return Util.getTimeSpanString(duration);
        }

        public String getTimeSortKey() {
            return Util.XS_DATETIME_FORMATTER.format(lastChange.getTime());
        }

        public int compareTo(UserInfo that) {
            return that.lastChange.compareTo(this.lastChange);
        }
    }

    /**
     * Does this {@link JobCollection} has any associated user information recorded?
     */
    public final boolean hasPeople() {
        for (Job job : getJobs()) {
            if (job instanceof Project) {
                Project p = (Project) job;
                for (Build build : p.getBuilds()) {
                    for (Entry entry : build.getChangeSet()) {
                        User user = entry.getAuthor();
                        if(user!=null)
                            return true;
                    }
                }
            }
        }
        return false;
    }

    /**
     * Gets the users that show up in the changelog of this job collection.
     */
    public final List getPeople() {
        Map users = new HashMap();
        for (Job job : getJobs()) {
            if (job instanceof Project) {
                Project p = (Project) job;
                for (Build build : p.getBuilds()) {
                    for (Entry entry : build.getChangeSet()) {
                        User user = entry.getAuthor();

                        UserInfo info = users.get(user);
                        if(info==null)
                            users.put(user,new UserInfo(user,p,build.getTimestamp()));
                        else
                        if(info.getLastChange().before(build.getTimestamp())) {
                            info.project = p;
                            info.lastChange = build.getTimestamp(); 
                        }
                    }
                }
            }
        }

        List r = new ArrayList(users.values());
        Collections.sort(r);

        return r;
    }

    /**
     * Creates a job in this collection.
     *
     * @return
     *      null if fails.
     */
    public abstract Job doCreateJob( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException;

    public void doRssAll( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        rss(req, rsp, " all builds", new RunList(getJobs()));
    }

    public void doRssFailed( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        rss(req, rsp, " failed builds", new RunList(getJobs()).failureOnly());
    }

    private void rss(StaplerRequest req, StaplerResponse rsp, String suffix, RunList runs) throws IOException, ServletException {
        RSS.forwardToRss(getDisplayName()+ suffix, getUrl(),
            runs.newBuilds(), Run.FEED_ADAPTER, req, rsp );
    }

    public static final Comparator SORTER = new Comparator() {
        public int compare(JobCollection lhs, JobCollection rhs) {
            return lhs.getViewName().compareTo(rhs.getViewName());
        }
    };
}