/*
 * Copyright 2000-2018 JetBrains s.r.o.
 *
 * 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 jetbrains.buildServer.usageStatistics.impl.providers;

import jetbrains.buildServer.serverSide.SBuildServer;
import jetbrains.buildServer.serverSide.ServerPaths;
import jetbrains.buildServer.serverSide.auth.AuthenticatedUserInfo;
import jetbrains.buildServer.serverSide.auth.UserAuthListener;
import jetbrains.buildServer.usageStatistics.presentation.UsageStatisticsGroupPosition;
import jetbrains.buildServer.users.SUser;
import jetbrains.buildServer.users.UserModelEx;
import jetbrains.buildServer.util.EventDispatcher;
import jetbrains.buildServer.util.TimeService;
import jetbrains.buildServer.util.positioning.PositionAware;
import org.jetbrains.annotations.NotNull;

public class AuthModuleUsageStatisticsProvider extends BaseToolUsersUsageStatisticsProvider implements UserAuthListener {

  @NotNull
  private final UserModelEx myUserModel;

  public AuthModuleUsageStatisticsProvider(@NotNull final SBuildServer server,
                                           @NotNull final ServerPaths serverPaths,
                                           @NotNull final UserModelEx userModel,
                                           @NotNull final EventDispatcher<UserAuthListener> userAuthDispatcher,
                                           @NotNull final TimeService timeService) {
    super(server, serverPaths, createDWMPeriodDescriptions(), timeService);
    myUserModel = userModel;
    userAuthDispatcher.addListener(this);
  }

  @NotNull
  @Override
  protected PositionAware getGroupPosition() {
    return UsageStatisticsGroupPosition.AUTH_MODULES;
  }

  public void userLoggedIn(@NotNull final AuthenticatedUserInfo authenticatedUserInfo) {
    final SUser user = authenticatedUserInfo.getUser();
    if (!myUserModel.isSpecialUser(user)) {
      addUsage(authenticatedUserInfo.getAuthModule().getType().getDisplayName(), user.getId());
    }
  }

  @NotNull
  @Override
  protected String getExternalId() {
    return "authModulesUsage";
  }

  @NotNull
  @Override
  protected String getToolName() {
    return "authModule";
  }

  @NotNull
  @Override
  protected String getToolIdName() {
    return "name";
  }

  @Override
  protected boolean publishToolUsages(@NotNull final String path) {
    return true;
  }

  @Override
  protected int getTotalUsersCount(final long startDate) {
    return myUserModel.getAllUsers().getUsers().size();
  }

  @NotNull
  @Override
  protected String getValueTooltip() {
    return "User count (% of all users)";
  }
}