org.sonar.server.user.ws.CurrentAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-server Show documentation
There is a newer version: 7.2.1
/*
 * SonarQube
 * Copyright (C) 2009-2016 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.server.user.ws;

import com.google.common.base.Optional;
import java.util.Collection;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.Response;
import org.sonar.api.server.ws.WebService.NewController;
import org.sonar.api.utils.text.JsonWriter;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.user.UserDto;
import org.sonar.server.user.UserSession;

import static com.google.common.base.Strings.isNullOrEmpty;
import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
import static org.sonar.server.user.ws.UserJsonWriter.FIELD_EXTERNAL_IDENTITY;
import static org.sonar.server.user.ws.UserJsonWriter.FIELD_EXTERNAL_PROVIDER;

public class CurrentAction implements UsersWsAction {
  private final UserSession userSession;
  private final DbClient dbClient;

  public CurrentAction(UserSession userSession, DbClient dbClient) {
    this.userSession = userSession;
    this.dbClient = dbClient;
  }

  @Override
  public void define(NewController context) {
    context.createAction("current")
      .setDescription("Get the details of the current authenticated user.")
      .setHandler(this)
      .setInternal(true)
      .setResponseExample(getClass().getResource("current-example.json"))
      .setSince("5.2");
  }

  @Override
  public void handle(Request request, Response response) throws Exception {
    DbSession dbSession = dbClient.openSession(false);
    try {
      Optional user = Optional.absent();
      Collection groups = emptyList();
      if (userSession.isLoggedIn()) {
        user = selectCurrentUser(dbSession);
        groups = selectGroups(dbSession);
      }
      writeResponse(response, user, groups);
    } finally {
      dbClient.closeSession(dbSession);
    }
  }

  private Optional selectCurrentUser(DbSession dbSession) {
    return Optional.fromNullable(dbClient.userDao().selectActiveUserByLogin(dbSession, userSession.getLogin()));
  }

  private Collection selectGroups(DbSession dbSession) {
    return dbClient.groupMembershipDao().selectGroupsByLogins(dbSession, singletonList(userSession.getLogin()))
      .get(userSession.getLogin());
  }

  private void writeResponse(Response response, Optional user, Collection groups) {
    JsonWriter json = response.newJsonWriter().beginObject();
    writeUserDetails(json, user, groups);
    json.endObject().close();
  }

  private void writeUserDetails(JsonWriter json, Optional optionalUser, Collection groups) {
    json
      .prop("isLoggedIn", userSession.isLoggedIn())
      .prop("login", userSession.getLogin())
      .prop("name", userSession.getName());
    if (optionalUser.isPresent()) {
      UserDto user = optionalUser.get();
      if (!isNullOrEmpty(user.getEmail())) {
        json.prop("email", user.getEmail());
      }
      json.prop("local", user.isLocal());
      json.prop(FIELD_EXTERNAL_IDENTITY, user.getExternalIdentity());
      json.prop(FIELD_EXTERNAL_PROVIDER, user.getExternalIdentityProvider());
    }

    writeScmAccounts(json, optionalUser);
    writeGroups(json, groups);
    writePermissions(json, userSession);
  }

  private static void writeScmAccounts(JsonWriter json, Optional optionalUser) {
    json.name("scmAccounts");
    json.beginArray();
    if (optionalUser.isPresent()) {
      for (String scmAccount : optionalUser.get().getScmAccountsAsList()) {
        json.value(scmAccount);
      }
    }
    json.endArray();
  }

  private static void writeGroups(JsonWriter json, Collection groups) {
    json.name("groups");
    json.beginArray();
    for (String group : groups) {
      json.value(group);
    }
    json.endArray();
  }

  private static void writePermissions(JsonWriter json, UserSession session) {
    json.name("permissions").beginObject();
    writeGlobalPermissions(json, session);
    json.endObject();
  }

  private static void writeGlobalPermissions(JsonWriter json, UserSession session) {
    json.name("global").beginArray();
    for (String permission : session.globalPermissions()) {
      json.value(permission);
    }
    json.endArray();
  }

}