GroupsEndpoint.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community 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://opensource.org/licenses/ecl2.txt
 *
 * 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 org.opencastproject.adminui.endpoint;

import static com.entwinemedia.fn.data.json.Jsons.arr;
import static com.entwinemedia.fn.data.json.Jsons.f;
import static com.entwinemedia.fn.data.json.Jsons.obj;
import static com.entwinemedia.fn.data.json.Jsons.v;
import static javax.servlet.http.HttpServletResponse.SC_BAD_REQUEST;
import static javax.servlet.http.HttpServletResponse.SC_CREATED;
import static javax.servlet.http.HttpServletResponse.SC_FORBIDDEN;
import static javax.servlet.http.HttpServletResponse.SC_NOT_FOUND;
import static javax.servlet.http.HttpServletResponse.SC_OK;
import static org.apache.commons.lang3.StringUtils.trimToNull;
import static org.apache.http.HttpStatus.SC_CONFLICT;
import static org.apache.http.HttpStatus.SC_INTERNAL_SERVER_ERROR;
import static org.opencastproject.index.service.util.RestUtils.okJsonList;
import static org.opencastproject.util.doc.rest.RestParameter.Type.INTEGER;
import static org.opencastproject.util.doc.rest.RestParameter.Type.STRING;
import static org.opencastproject.util.doc.rest.RestParameter.Type.TEXT;

import org.opencastproject.adminui.impl.index.AdminUISearchIndex;
import org.opencastproject.adminui.util.QueryPreprocessor;
import org.opencastproject.index.service.api.IndexService;
import org.opencastproject.index.service.impl.index.group.Group;
import org.opencastproject.index.service.impl.index.group.GroupIndexSchema;
import org.opencastproject.index.service.impl.index.group.GroupSearchQuery;
import org.opencastproject.index.service.resources.list.query.GroupsListQuery;
import org.opencastproject.index.service.util.RestUtils;
import org.opencastproject.matterhorn.search.SearchIndexException;
import org.opencastproject.matterhorn.search.SearchResult;
import org.opencastproject.matterhorn.search.SearchResultItem;
import org.opencastproject.matterhorn.search.SortCriterion;
import org.opencastproject.security.api.SecurityService;
import org.opencastproject.security.api.User;
import org.opencastproject.security.api.UserDirectoryService;
import org.opencastproject.util.NotFoundException;
import org.opencastproject.util.RestUtil;
import org.opencastproject.util.data.Option;
import org.opencastproject.util.doc.rest.RestParameter;
import org.opencastproject.util.doc.rest.RestQuery;
import org.opencastproject.util.doc.rest.RestResponse;
import org.opencastproject.util.doc.rest.RestService;

import com.entwinemedia.fn.data.Opt;
import com.entwinemedia.fn.data.json.Field;
import com.entwinemedia.fn.data.json.JValue;
import com.entwinemedia.fn.data.json.Jsons;

import org.apache.commons.lang3.StringUtils;
import org.osgi.service.component.ComponentContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.ws.rs.DELETE;
import javax.ws.rs.FormParam;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;

@Path("/")
@RestService(name = "groups", title = "Group service",
  abstractText = "Provides operations for groups",
  notes = { "This service offers the default groups CRUD operations for the admin interface.",
            "<strong>Important:</strong> "
              + "<em>This service is for exclusive use by the module matterhorn-admin-ui-ng. Its API might change "
              + "anytime without prior notice. Any dependencies other than the admin UI will be strictly ignored. "
              + "DO NOT use this for integration of third-party applications.<em>"})
public class GroupsEndpoint {

  /** The logging facility */
  private static final Logger logger = LoggerFactory.getLogger(GroupsEndpoint.class);

  /** The admin UI search index */
  private AdminUISearchIndex searchIndex;

  /** The security service */
  private SecurityService securityService;

  /** The user directory service */
  private UserDirectoryService userDirectoryService;

  /** The index service */
  private IndexService indexService;

  /** OSGi callback for the security service. */
  public void setSecurityService(SecurityService securityService) {
    this.securityService = securityService;
  }

  /** OSGi callback for the index service. */
  public void setIndexService(IndexService indexService) {
    this.indexService = indexService;
  }

  /** OSGi callback for users services. */
  public void setUserDirectoryService(UserDirectoryService userDirectoryService) {
    this.userDirectoryService = userDirectoryService;
  }

  /** OSGi callback for the search index. */
  public void setSearchIndex(AdminUISearchIndex searchIndex) {
    this.searchIndex = searchIndex;
  }

  /** OSGi callback. */
  protected void activate(ComponentContext cc) {
    logger.info("Activate the Admin ui - Groups facade endpoint");
  }

  @GET
  @Produces(MediaType.APPLICATION_JSON)
  @Path("groups.json")
  @RestQuery(
    name = "allgroupsasjson",
    description = "Returns a list of groups",
    returnDescription = "List of groups for the current user's organization as JSON.",
    restParameters = {
      @RestParameter(name = "filter", isRequired = false, type = STRING,
        description = "Filter used for the query, formatted like: 'filter1:value1,filter2:value2'"),
      @RestParameter(name = "sort", isRequired = false, type = STRING,
        description = "The sort order. May include any of the following: NAME, DESCRIPTION, ROLE. "
        + "Add '_DESC' to reverse the sort order (e.g. NAME_DESC)."),
      @RestParameter(name = "limit", isRequired = false, type = INTEGER, defaultValue = "100",
        description = "The maximum number of items to return per page."),
      @RestParameter(name = "offset", isRequired = false, type = INTEGER, defaultValue = "0",
        description = "The page number.")},
    reponses = {
      @RestResponse(responseCode = SC_OK, description = "The groups.")})
  public Response getGroups(@QueryParam("filter") String filter, @QueryParam("sort") String sort,
          @QueryParam("offset") int offset, @QueryParam("limit") int limit) throws IOException {

    GroupSearchQuery query = new GroupSearchQuery(securityService.getOrganization().getId(),
            securityService.getUser());

    Opt<String> optSort = Opt.nul(trimToNull(sort));
    Option<Integer> optOffset = Option.option(offset);
    Option<Integer> optLimit = Option.option(limit);
    // If the limit is set to 0, this is not taken into account
    if (optLimit.isSome() && limit == 0) {
      optLimit = Option.none();
    }

    Map<String, String> filters = RestUtils.parseFilter(filter);
    for (String name : filters.keySet()) {
      if (GroupsListQuery.FILTER_NAME_NAME.equals(name)) {
        query.withName(filters.get(name));
      } else if (GroupsListQuery.FILTER_TEXT_NAME.equals(name)) {
        query.withText(QueryPreprocessor.sanitize(filters.get(name)));
      }
    }

    if (optSort.isSome()) {
      Set<SortCriterion> sortCriteria = RestUtils.parseSortQueryParameter(optSort.get());
      for (SortCriterion criterion : sortCriteria) {
        switch (criterion.getFieldName()) {
          case GroupIndexSchema.NAME:
            query.sortByName(criterion.getOrder());
            break;
          case GroupIndexSchema.DESCRIPTION:
            query.sortByDescription(criterion.getOrder());
            break;
          case GroupIndexSchema.ROLE:
            query.sortByRole(criterion.getOrder());
            break;
          case GroupIndexSchema.MEMBERS:
            query.sortByMembers(criterion.getOrder());
            break;
          case GroupIndexSchema.ROLES:
            query.sortByRoles(criterion.getOrder());
            break;
          default:
            throw new WebApplicationException(Status.BAD_REQUEST);
        }
      }
    }

    if (optLimit.isSome())
      query.withLimit(optLimit.get());
    if (optOffset.isSome())
      query.withOffset(optOffset.get());

    SearchResult<Group> results;
    try {
      results = searchIndex.getByQuery(query);
    } catch (SearchIndexException e) {
      logger.error("The External Search Index was not able to get the groups list.", e);
      return RestUtil.R.serverError();
    }

    List<JValue> groupsJSON = new ArrayList<>();
    for (SearchResultItem<Group> item : results.getItems()) {
      Group group = item.getSource();
      List<Field> fields = new ArrayList<>();
      fields.add(f("id", v(group.getIdentifier())));
      fields.add(f("name", v(group.getName(), Jsons.BLANK)));
      fields.add(f("description", v(group.getDescription(), Jsons.BLANK)));
      fields.add(f("role", v(group.getRole())));
      fields.add(f("users", membersToJSON(group.getMembers())));
      groupsJSON.add(obj(fields));
    }

    return okJsonList(groupsJSON, offset, limit, results.getHitCount());
  }

  @DELETE
  @Path("{id}")
  @RestQuery(
    name = "removegrouop",
    description = "Remove a group",
    returnDescription = "Returns no content",
    pathParameters = {
      @RestParameter(name = "id", description = "The group identifier", isRequired = true, type = STRING)},
    reponses = {
      @RestResponse(responseCode = SC_OK, description = "Group deleted"),
      @RestResponse(responseCode = SC_FORBIDDEN, description = "Not enough permissions to delete the group with admin role."),
      @RestResponse(responseCode = SC_NOT_FOUND, description = "Group not found."),
      @RestResponse(responseCode = SC_INTERNAL_SERVER_ERROR, description = "An internal server error occured.")})
  public Response removeGroup(@PathParam("id") String groupId) throws NotFoundException {
    return indexService.removeGroup(groupId);
  }

  @POST
  @Path("")
  @RestQuery(
    name = "createGroup",
    description = "Add a group",
    returnDescription = "Returns Created (201) if the group has been created",
    restParameters = {
      @RestParameter(name = "name", description = "The group name", isRequired = true, type = STRING),
      @RestParameter(name = "description", description = "The group description", isRequired = false, type = STRING),
      @RestParameter(name = "roles", description = "Comma seperated list of roles", isRequired = false, type = TEXT),
      @RestParameter(name = "users", description = "Comma seperated list of members", isRequired = false, type = TEXT)},
    reponses = {
      @RestResponse(responseCode = SC_CREATED, description = "Group created"),
      @RestResponse(responseCode = SC_BAD_REQUEST, description = "Name too long"),
      @RestResponse(responseCode = SC_FORBIDDEN, description = "Not enough permissions to create a group with admin role."),
      @RestResponse(responseCode = SC_CONFLICT, description = "An group with this name already exists.") })
  public Response createGroup(@FormParam("name") String name, @FormParam("description") String description,
          @FormParam("roles") String roles, @FormParam("users") String users) {
    return indexService.createGroup(name, description, roles, users);
  }

  @PUT
  @Path("{id}")
  @RestQuery(
    name = "updateGroup",
    description = "Update a group",
    returnDescription = "Return the status codes",
    pathParameters = {
      @RestParameter(name = "id", description = "The group identifier", isRequired = true, type = STRING) },
    restParameters = {
      @RestParameter(name = "name", description = "The group name", isRequired = true, type = STRING),
      @RestParameter(name = "description", description = "The group description", isRequired = false, type = STRING),
      @RestParameter(name = "roles", description = "Comma seperated list of roles", isRequired = false, type = TEXT),
      @RestParameter(name = "users", description = "Comma seperated list of members", isRequired = false, type = TEXT)},
    reponses = {
      @RestResponse(responseCode = SC_OK, description = "Group updated"),
      @RestResponse(responseCode = SC_FORBIDDEN, description = "Not enough permissions to update the group with admin role."),
      @RestResponse(responseCode = SC_NOT_FOUND, description = "Group not found"),
      @RestResponse(responseCode = SC_BAD_REQUEST, description = "Name too long")})
  public Response updateGroup(@PathParam("id") String groupId, @FormParam("name") String name,
          @FormParam("description") String description, @FormParam("roles") String roles,
          @FormParam("users") String users) throws NotFoundException {
    return indexService.updateGroup(groupId, name, description, roles, users);
  }

  @GET
  @Produces(MediaType.APPLICATION_JSON)
  @Path("{id}")
  @RestQuery(
    name = "getGroup",
    description = "Get a single group",
    returnDescription = "Return the status codes",
    pathParameters = {
      @RestParameter(name = "id", description = "The group identifier", isRequired = true, type = STRING)},
    reponses = {
      @RestResponse(responseCode = SC_OK, description = "Group found and returned as JSON"),
      @RestResponse(responseCode = SC_NOT_FOUND, description = "Group not found")})
  public Response getGroup(@PathParam("id") String groupId) throws NotFoundException, SearchIndexException {
    Opt<Group> groupOpt = indexService.getGroup(groupId, searchIndex);
    if (groupOpt.isNone())
      throw new NotFoundException("Group " + groupId + " does not exist.");

    Group group = groupOpt.get();
    return RestUtils.okJson(obj(f("id", v(group.getIdentifier())), f("name", v(group.getName(), Jsons.BLANK)),
            f("description", v(group.getDescription(), Jsons.BLANK)), f("role", v(group.getRole(), Jsons.BLANK)),
            f("roles", rolesToJSON(group.getRoles())), f("users", membersToJSON(group.getMembers()))));
  }

  /**
   * Generate a JSON array based on the given set of roles
   *
   * @param roles
   *          the roles source
   * @return a JSON array ({@link JValue}) with the given roles
   */
  private JValue rolesToJSON(Set<String> roles) {
    List<JValue> rolesJSON = new ArrayList<>();

    for (String role : roles) {
      rolesJSON.add(v(role));
    }
    return arr(rolesJSON);
  }

  /**
   * Generate a JSON array based on the given set of members
   *
   * @param members
   *          the members source
   * @return a JSON array ({@link JValue}) with the given members
   */
  private JValue membersToJSON(Set<String> members) {
    List<JValue> membersJSON = new ArrayList<>();

    for (String username : members) {
      User user = userDirectoryService.loadUser(username);
      String name = username;

      if (user != null && StringUtils.isNotBlank(user.getName())) {
        name = user.getName();
      }

      membersJSON.add(obj(f("username", v(username)), f("name", v(name))));
    }

    return arr(membersJSON);
  }
}