hudson.model.View Maven / Gradle / Ivy
package hudson.model;
import hudson.Util;
import hudson.security.AccessControlled;
import hudson.security.Permission;
import hudson.security.ACL;
import hudson.security.PermissionGroup;
import hudson.scm.ChangeLogSet.Entry;
import hudson.search.CollectionSearchIndex;
import hudson.search.SearchIndexBuilder;
import hudson.util.RunList;
import org.kohsuke.stapler.Stapler;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.Exported;
import org.kohsuke.stapler.export.ExportedBean;
import javax.servlet.ServletException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.GregorianCalendar;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Encapsulates the rendering of the list of {@link TopLevelItem}s
* that {@link Hudson} owns.
*
* @author Kohsuke Kawaguchi
*/
@ExportedBean
public abstract class View extends AbstractModelObject implements AccessControlled {
/**
* Gets all the items in this collection in a read-only view.
*/
@Exported(name="jobs")
public abstract Collection getItems();
/**
* Gets the {@link TopLevelItem} of the given name.
*/
public abstract TopLevelItem getItem(String name);
/**
* Checks if the job is in this collection.
*/
public abstract boolean contains(TopLevelItem item);
/**
* Gets the name of all this collection.
*/
@Exported(visibility=2,name="name")
public abstract String getViewName();
/**
* Message displayed in the top page. Can be null. Includes HTML.
*/
@Exported
public abstract String getDescription();
/**
* Returns the path relative to the context root.
*
* Doesn't start with '/' but ends with '/'. (except when this is
* Hudson,
*/
public abstract String getUrl();
public String getSearchUrl() {
return getUrl();
}
/**
* Gets the absolute URL of this view.
*/
@Exported(visibility=2,name="url")
public String getAbsoluteUrl() {
return Stapler.getCurrentRequest().getRootPath()+'/'+getUrl();
}
public Api getApi(final StaplerRequest req) {
return new Api(this);
}
/**
* Returns the {@link ACL} for this object.
*/
public ACL getACL() {
return Hudson.getInstance().getAuthorizationStrategy().getACL(this);
}
public void checkPermission(Permission p) {
getACL().checkPermission(p);
}
public boolean hasPermission(Permission p) {
return getACL().hasPermission(p);
}
@ExportedBean(defaultVisibility=2)
public static final class UserInfo implements Comparable {
private final User user;
/**
* When did this user made a last commit on any of our projects? Can be null.
*/
private Calendar lastChange;
/**
* Which project did this user commit? Can be null.
*/
private AbstractProject project;
UserInfo(User user, AbstractProject p, Calendar lastChange) {
this.user = user;
this.project = p;
this.lastChange = lastChange;
}
@Exported
public User getUser() {
return user;
}
@Exported
public Calendar getLastChange() {
return lastChange;
}
@Exported
public AbstractProject getProject() {
return project;
}
/**
* Returns a human-readable string representation of when this user was last active.
*/
public String getLastChangeTimeString() {
if(lastChange==null) return "N/A";
long duration = new GregorianCalendar().getTimeInMillis()- ordinal();
return Util.getTimeSpanString(duration);
}
public String getTimeSortKey() {
if(lastChange==null) return "-";
return Util.XS_DATETIME_FORMATTER.format(lastChange.getTime());
}
public int compareTo(UserInfo that) {
long rhs = that.ordinal();
long lhs = this.ordinal();
if(rhs>lhs) return 1;
if(rhs p = (AbstractProject) job;
for (AbstractBuild 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 People getPeople() {
return new People();
}
@ExportedBean
public final class People {
@Exported
public final List users;
public People() {
Map users = new HashMap();
for (Item item : getItems()) {
for (Job job : item.getAllJobs()) {
if (job instanceof AbstractProject) {
AbstractProject p = (AbstractProject) job;
for (AbstractBuild 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();
}
}
}
}
}
}
if(View.this==Hudson.getInstance()) {
// for Hudson, really load all users
User unknown = User.getUnknown();
for(User u : User.getAll()) {
if(u==unknown) continue; // skip the special 'unknown' user
UserInfo info = users.get(u);
if(info==null)
users.put(u,new UserInfo(u,null,null));
}
}
ArrayList list = new ArrayList();
list.addAll(users.values());
Collections.sort(list);
this.users = Collections.unmodifiableList(list);
}
public View getParent() {
return View.this;
}
public Api getApi() {
return new Api(this);
}
}
@Override
public SearchIndexBuilder makeSearchIndex() {
return super.makeSearchIndex()
.add(new CollectionSearchIndex() {// for jobs in the view
protected TopLevelItem get(String key) { return getItem(key); }
protected Collection all() { return getItems(); }
});
}
/**
* Creates a new {@link Item} in this collection.
*
* @return
* null if fails.
*/
public abstract Item doCreateItem( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException;
public void doRssAll( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
rss(req, rsp, " all builds", getBuilds());
}
public void doRssFailed( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
rss(req, rsp, " failed builds", getBuilds().failureOnly());
}
public RunList getBuilds() {
return new RunList(this);
}
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 void doRssLatest( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
List lastBuilds = new ArrayList();
for (TopLevelItem item : getItems()) {
if (item instanceof Job) {
Job job = (Job) item;
Run lb = job.getLastBuild();
if(lb!=null) lastBuilds.add(lb);
}
}
RSS.forwardToRss(getDisplayName()+" last builds only", getUrl(),
lastBuilds, Run.FEED_ADAPTER_LATEST, req, rsp );
}
public static final Comparator SORTER = new Comparator() {
public int compare(View lhs, View rhs) {
return lhs.getViewName().compareTo(rhs.getViewName());
}
};
public static final PermissionGroup PERMISSIONS = new PermissionGroup(View.class,Messages._View_Permissions_Title());
/**
* Permission to create new jobs.
*/
public static final Permission CREATE = new Permission(PERMISSIONS,"Create", Permission.CREATE);
public static final Permission DELETE = new Permission(PERMISSIONS,"Delete", Permission.DELETE);
public static final Permission CONFIGURE = new Permission(PERMISSIONS,"Configure", Permission.CONFIGURE);
// to simplify access from Jelly
public static Permission getItemCreatePermission() {
return Item.CREATE;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy