java/com/google/gerrit/server/restapi/config/ListTasks.java

// Copyright (C) 2014 The Android Open Source Project
//
// Licensed 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.google.gerrit.server.restapi.config;

import static java.util.Comparator.comparing;
import static java.util.stream.Collectors.toList;

import com.google.common.base.Ascii;
import com.google.common.collect.ImmutableMap;
import com.google.gerrit.entities.Project;
import com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.Response;
import com.google.gerrit.extensions.restapi.RestReadView;
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.config.ConfigResource;
import com.google.gerrit.server.git.WorkQueue;
import com.google.gerrit.server.git.WorkQueue.ProjectTask;
import com.google.gerrit.server.git.WorkQueue.Task;
import com.google.gerrit.server.ioutil.HexFormat;
import com.google.gerrit.server.permissions.GlobalPermission;
import com.google.gerrit.server.permissions.PermissionBackend;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.permissions.ProjectPermission;
import com.google.gerrit.server.project.ProjectCache;
import com.google.gerrit.server.project.ProjectState;
import com.google.inject.Inject;
import com.google.inject.Provider;
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.TimeUnit;
import java.util.function.Predicate;
import org.kohsuke.args4j.CmdLineException;
import org.kohsuke.args4j.CmdLineParser;
import org.kohsuke.args4j.Option;
import org.kohsuke.args4j.OptionDef;
import org.kohsuke.args4j.spi.EnumOptionHandler;
import org.kohsuke.args4j.spi.Parameters;
import org.kohsuke.args4j.spi.Setter;

public class ListTasks implements RestReadView<ConfigResource> {
  private final PermissionBackend permissionBackend;
  private final WorkQueue workQueue;
  private final Provider<CurrentUser> self;
  private final ProjectCache projectCache;

  private final EnumSet<Task.State> states = EnumSet.noneOf(Task.State.class);

  @Option(
      name = "--state",
      aliases = {"-s"},
      handler = StateHandler.class,
      usage = "only show tasks in the specified state")
  void addState(Task.State state) {
    states.add(state);
  }

  @Inject
  public ListTasks(
      PermissionBackend permissionBackend,
      WorkQueue workQueue,
      Provider<CurrentUser> self,
      ProjectCache projectCache) {
    this.permissionBackend = permissionBackend;
    this.workQueue = workQueue;
    this.self = self;
    this.projectCache = projectCache;
  }

  @Override
  public Response<List<TaskInfo>> apply(ConfigResource resource)
      throws AuthException, PermissionBackendException {
    CurrentUser user = self.get();
    if (!user.isIdentifiedUser()) {
      throw new AuthException("Authentication required");
    }

    List<TaskInfo> allTasks = getTasks();
    if (permissionBackend.user(user).test(GlobalPermission.VIEW_QUEUE)) {
      return Response.ok(allTasks);
    }

    Map<String, Boolean> visibilityCache = new HashMap<>();
    List<TaskInfo> visibleTasks = new ArrayList<>();
    for (TaskInfo task : allTasks) {
      if (task.projectName != null) {
        Boolean visible = visibilityCache.get(task.projectName);
        if (visible == null) {
          Project.NameKey nameKey = Project.nameKey(task.projectName);
          Optional<ProjectState> state = projectCache.get(nameKey);
          if (!state.isPresent() || !state.get().statePermitsRead()) {
            visible = false;
          } else {
            if (permissionBackend.user(user).project(nameKey).test(ProjectPermission.ACCESS)) {
              visible = true;
            } else {
              visible = false;
            }
          }
          visibilityCache.put(task.projectName, visible);
        }
        if (visible) {
          visibleTasks.add(task);
        }
      }
    }
    return Response.ok(visibleTasks);
  }

  private List<TaskInfo> getTasks() {
    Predicate<Task<?>> filter = states.isEmpty() ? t -> true : t -> states.contains(t.getState());
    return workQueue.getTaskInfos(filter, TaskInfo::new).stream()
        .sorted(
            comparing((TaskInfo t) -> t.state.ordinal())
                .thenComparing(t -> t.delay)
                .thenComparing(t -> t.command))
        .collect(toList());
  }

  public static class TaskInfo {
    public String id;
    public Task.State state;
    public Timestamp startTime;
    public long delay;
    public String command;
    public String remoteName;
    public String projectName;
    public String queueName;

    public TaskInfo(Task<?> task) {
      this.id = HexFormat.fromInt(task.getTaskId());
      this.state = task.getState();
      this.startTime = Timestamp.from(task.getStartTime());
      this.delay = task.getDelay(TimeUnit.MILLISECONDS);
      this.command = task.toString();
      this.queueName = task.getQueueName();

      if (task instanceof ProjectTask<?> projectTask) {
        Project.NameKey name = projectTask.getProjectNameKey();
        if (name != null) {
          this.projectName = name.get();
        }
        this.remoteName = projectTask.getRemoteName();
      }
    }
  }

  public static class StateHandler extends EnumOptionHandler<Task.State> {
    private static final ImmutableMap<String, Task.State> ALIASES =
        ImmutableMap.of(
            "WAITING", Task.State.READY,
            "KILLED", Task.State.CANCELLED);

    public StateHandler(CmdLineParser parser, OptionDef option, Setter<? super Task.State> setter) {
      super(parser, option, setter, Task.State.class);
    }

    @Override
    public int parseArguments(Parameters params) throws CmdLineException {
      String param = params.getParameter(0);
      Task.State alias = ALIASES.get(Ascii.toUpperCase(param));
      if (alias != null) {
        setter.addValue(alias);
        return 1;
      }
      try {
        return super.parseArguments(params);
      } catch (CmdLineException e) {
        throw new CmdLineException(owner, String.format("%s is not a valid task state", param), e);
      }
    }
  }
}