com.marvelution.hudson.plugins.apiv2.resources.impl.ActivityRestResourceImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hudson-apiv2-plugin Show documentation
This plugin features a Wink REST API application.
The newest version!
/*
 * Licensed to Marvelution under one or more contributor license
 * agreements.  See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Marvelution licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package com.marvelution.hudson.plugins.apiv2.resources.impl;

import hudson.model.AbstractBuild;
import hudson.model.Hudson;
import hudson.model.Project;

import java.net.URI;
import java.util.Collection;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.ws.rs.Path;

import org.apache.commons.lang.ArrayUtils;
import org.apache.wink.common.annotations.Parent;
import org.apache.wink.common.annotations.Scope;
import org.apache.wink.common.annotations.Scope.ScopeType;

import com.google.common.base.Predicate;
import com.google.common.collect.Collections2;
import com.google.common.collect.Lists;
import com.marvelution.hudson.plugins.apiv2.APIv2Plugin;
import com.marvelution.hudson.plugins.apiv2.cache.activity.ActivityCache;
import com.marvelution.hudson.plugins.apiv2.cache.activity.ActivityCachePredicates;
import com.marvelution.hudson.plugins.apiv2.cache.activity.BuildActivityCache;
import com.marvelution.hudson.plugins.apiv2.cache.activity.JobActivityCache;
import com.marvelution.hudson.plugins.apiv2.dozer.utils.DozerUtils;
import com.marvelution.hudson.plugins.apiv2.resources.ActivityResource;
import com.marvelution.hudson.plugins.apiv2.resources.model.HudsonSystem;
import com.marvelution.hudson.plugins.apiv2.resources.model.User;
import com.marvelution.hudson.plugins.apiv2.resources.model.activity.Activities;
import com.marvelution.hudson.plugins.apiv2.resources.model.activity.Activity;
import com.marvelution.hudson.plugins.apiv2.resources.model.activity.Activity.BuildActivity;
import com.marvelution.hudson.plugins.apiv2.resources.model.activity.Activity.JobActivity;
import com.marvelution.hudson.plugins.apiv2.resources.model.activity.ActivityType;
import com.marvelution.hudson.plugins.apiv2.resources.model.build.Build;
import com.marvelution.hudson.plugins.apiv2.resources.model.job.Job;

/**
 * The REST implementation of the {@link ActivityResource} interface
 * 
 * @author Mark Rekveld
 * @since 4.2.0
 */
@Scope(ScopeType.SINGLETON)
@Parent(BaseRestResource.class)
@Path("activity")
public class ActivityRestResourceImpl extends BaseRestResource implements ActivityResource {

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

	/**
	 * {@inheritDoc}
	 */
	@Override
	public Activities getActivities(ActivityType[] types, String[] jobs, String[] userIds, int maxResults) {
		Activities activities = new Activities();
		for (ActivityCache cache : getFilteredActivities(types, jobs, userIds)) {
			try {
				hudson.model.Job> job = getHudsonJob(cache.getJob());
				if (job.hasPermission(Project.READ)) {
					if (cache instanceof BuildActivityCache) {
						activities.add(getBuildActivityFromCache((BuildActivityCache) cache, job));
					} else if (cache instanceof JobActivityCache) {
						activities.add(getJobActivityFromCache((JobActivityCache) cache, job));
					}
					if (activities.size() == maxResults) {
						// We have the maximum number of results wanted
						break;
					}
				}
			} catch (Exception e) {
				LOGGER.log(Level.WARNING, "Failed to add ActivityCache object " + cache.toString() + ". Reason: "
					+ e.getMessage(), e);
			}
		}
		return activities;
	}

	/**
	 * Get the filtered activities
	 * 
	 * @param types the {@link ActivityType}s to filter by
	 * @param jobs the jobnames to filter by
	 * @param userIds the userIds to filter by
	 * @return the {@link List} of {@link ActivityCache}s
	 * @since 4.5.0
	 */
	@SuppressWarnings("unchecked")
	private Collection getFilteredActivities(ActivityType[] types, String[] jobs, String[] userIds) {
		if (ArrayUtils.isEmpty(types)) {
			types = ActivityType.values();
		}
		List> predicates = Lists.newArrayList(ActivityCachePredicates.isActivity(types));
		if (jobs != null && jobs.length > 0) {
			predicates.add(ActivityCachePredicates.relatesToJobs(jobs));
		}
		if (userIds != null && userIds.length > 0) {
			predicates.add(ActivityCachePredicates.relatesToUsers(userIds));
		}
		Predicate predicate = ActivityCachePredicates.getSimpelistAndPredicate(predicates);
		LOGGER.info("Filtering " + APIv2Plugin.getActivitiesCache().getSortedActivities().size()
			+ " activities with Predicate: " + predicate.toString());
		return Collections2.filter(APIv2Plugin.getActivitiesCache().getSortedActivities(), predicate);
	}

	/**
	 * Get a {@link JobActivity} object from the given {@link JobActivityCache} and {@link hudson.model.Job}
	 * 
	 * @param cache the {@link JobActivityCache}
	 * @param job the {@link hudson.model.Job}
	 * @return the {@link JobActivity}
	 */
	public Activity getJobActivityFromCache(JobActivityCache cache,
					hudson.model.Job> job) {
		JobActivity activity = new JobActivity();
		activity.setUri(URI.create(Hudson.getInstance().getRootUrl() + job.getUrl()));
		activity.setTimestamp(cache.getTimestamp());
		activity.setSystem(HudsonSystem.getHudsonSystem());
		activity.setUser(getUser(cache.getCulprit()));
		activity.setJob(DozerUtils.getMapper().map(job, Job.class, DozerUtils.ACTIVITY_MAP_ID));
		return activity;
	}

	/**
	 * Get a {@link BuildActivity} object from the given {@link BuildActivityCache} and {@link hudson.model.Job}
	 * 
	 * @param cache the {@link BuildActivityCache}
	 * @param job the {@link hudson.model.Job}
	 * @return the {@link BuildActivity}
	 */
	public Activity getBuildActivityFromCache(BuildActivityCache cache,
					hudson.model.Job> job) {
		AbstractBuild build = getHudsonBuild(job, cache.getBuild());
		BuildActivity activity = new BuildActivity();
		activity.setUri(URI.create(Hudson.getInstance().getRootUrl() + build.getUrl()));
		activity.setSystem(HudsonSystem.getHudsonSystem());
		activity.setBuild(DozerUtils.getMapper().map(build, Build.class));
		activity.setTimestamp(build.getTimeInMillis());
		User user = getUser(cache.getCulprit());
		if (User.UNKNOWN.equals(user)) {
			user = activity.getSystem().getSystemUser();
		}
		activity.setUser(user);
		return activity;
	}

	/**
	 * Get the {@link User} for a given userId or username
	 * 
	 * @param culprit the userId or username
	 * @return the {@link User}, can be {@link User#ANONYMOUS} or {@link User#UNKNOWN} but never null
	 */
	public User getUser(String culprit) {
		if (User.ANONYMOUS.getUserId().equals(culprit)) {
			return User.ANONYMOUS;
		}
		hudson.model.User user = hudson.model.User.get(culprit, false);
		if (user == null) {
			return User.UNKNOWN;
		} else {
			return DozerUtils.getMapper().map(user, User.class);
		}
	}

}