com.google.gerrit.server.account.AccountDeactivator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation
API for Gerrit Plugins
There is a newer version: 3.11.0-rc3
// Copyright (C) 2017 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.account;

import com.google.common.flogger.FluentLogger;
import com.google.gerrit.extensions.events.LifecycleListener;
import com.google.gerrit.extensions.restapi.ResourceConflictException;
import com.google.gerrit.lifecycle.LifecycleModule;
import com.google.gerrit.server.config.GerritServerConfig;
import com.google.gerrit.server.config.ScheduleConfig;
import com.google.gerrit.server.config.ScheduleConfig.Schedule;
import com.google.gerrit.server.git.WorkQueue;
import com.google.gerrit.server.query.account.AccountPredicates;
import com.google.gerrit.server.query.account.InternalAccountQuery;
import com.google.inject.Inject;
import com.google.inject.Provider;
import java.util.Optional;
import org.eclipse.jgit.lib.Config;

/** Runnable to enable scheduling account deactivations to run periodically */
public class AccountDeactivator implements Runnable {
  private static final FluentLogger logger = FluentLogger.forEnclosingClass();

  public static class AccountDeactivatorModule extends LifecycleModule {
    @Override
    protected void configure() {
      listener().to(Lifecycle.class);
    }
  }

  static class Lifecycle implements LifecycleListener {
    private final WorkQueue queue;
    private final AccountDeactivator deactivator;
    private final boolean supportAutomaticAccountActivityUpdate;
    private final Optional schedule;

    @Inject
    Lifecycle(WorkQueue queue, AccountDeactivator deactivator, @GerritServerConfig Config cfg) {
      this.queue = queue;
      this.deactivator = deactivator;
      schedule = ScheduleConfig.createSchedule(cfg, "accountDeactivation");
      supportAutomaticAccountActivityUpdate =
          cfg.getBoolean("auth", "autoUpdateAccountActiveStatus", false);
    }

    @Override
    public void start() {
      if (schedule.isPresent()) {
        if (supportAutomaticAccountActivityUpdate) {
          queue.scheduleAtFixedRate(deactivator, schedule.get());
        } else {
          logger.atWarning().log(
              "Not scheduling AccountDeactivator because auth.autoUpdateAccountActiveStatus is false");
        }
      }
    }

    @Override
    public void stop() {
      // handled by WorkQueue.stop() already
    }
  }

  private final Provider accountQueryProvider;
  private final Realm realm;
  private final SetInactiveFlag sif;

  @Inject
  AccountDeactivator(
      Provider accountQueryProvider, SetInactiveFlag sif, Realm realm) {
    this.accountQueryProvider = accountQueryProvider;
    this.sif = sif;
    this.realm = realm;
  }

  @Override
  public void run() {
    logger.atInfo().log("Running account deactivations");
    try {
      int numberOfAccountsDeactivated = 0;
      for (AccountState acc : accountQueryProvider.get().query(AccountPredicates.isActive())) {
        if (processAccount(acc)) {
          numberOfAccountsDeactivated++;
        }
      }
      logger.atInfo().log(
          "Deactivations complete, %d account(s) were deactivated", numberOfAccountsDeactivated);
    } catch (Exception e) {
      logger.atSevere().withCause(e).log(
          "Failed to complete deactivation of accounts: %s", e.getMessage());
    }
  }

  private boolean processAccount(AccountState accountState) {
    if (!accountState.userName().isPresent()) {
      return false;
    }

    String userName = accountState.userName().get();
    logger.atFine().log("processing account %s", userName);
    try {
      if (realm.accountBelongsToRealm(accountState.externalIds()) && !realm.isActive(userName)) {
        sif.deactivate(accountState.account().id());
        logger.atInfo().log("deactivated account %s", userName);
        return true;
      }
    } catch (ResourceConflictException e) {
      logger.atInfo().withCause(e).log("Account %s already deactivated, continuing...", userName);
    } catch (Exception e) {
      logger.atSevere().withCause(e).log(
          "Error deactivating account: %s (%s) %s",
          userName, accountState.account().id(), e.getMessage());
    }
    return false;
  }

  @Override
  public String toString() {
    return "account deactivator";
  }
}