Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.sonar.server.component.ComponentFinder Maven / Gradle / Ivy
/*
* SonarQube
* Copyright (C) 2009-2018 SonarSource SA
* mailto:info 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.component;
import com.google.common.base.Optional;
import java.util.Collection;
import java.util.Set;
import javax.annotation.Nullable;
import org.sonar.api.resources.Qualifiers;
import org.sonar.api.resources.ResourceType;
import org.sonar.api.resources.ResourceTypes;
import org.sonar.api.resources.Scopes;
import org.sonar.core.util.stream.MoreCollectors;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.component.ComponentDto;
import org.sonar.db.organization.OrganizationDto;
import org.sonar.server.exceptions.NotFoundException;
import static com.google.common.base.Preconditions.checkArgument;
import static java.lang.String.format;
import static org.sonar.server.ws.WsUtils.checkFoundWithOptional;
import static org.sonar.server.ws.WsUtils.checkRequest;
public class ComponentFinder {
private static final String MSG_COMPONENT_ID_OR_KEY_TEMPLATE = "Either '%s' or '%s' must be provided";
private static final String MSG_PARAMETER_MUST_NOT_BE_EMPTY = "The '%s' parameter must not be empty";
private static final String LABEL_PROJECT = "Project";
private static final String LABEL_COMPONENT = "Component";
private final DbClient dbClient;
private final ResourceTypes resourceTypes;
public ComponentFinder(DbClient dbClient, ResourceTypes resourceTypes) {
this.dbClient = dbClient;
this.resourceTypes = resourceTypes;
}
public ComponentDto getByUuidOrKey(DbSession dbSession, @Nullable String componentUuid, @Nullable String componentKey, ParamNames parameterNames) {
checkByUuidOrKey(componentUuid, componentKey, parameterNames);
if (componentUuid != null) {
return getByUuid(dbSession, checkParamNotEmpty(componentUuid, parameterNames.getUuidParam()));
}
return getByKey(dbSession, checkParamNotEmpty(componentKey, parameterNames.getKeyParam()));
}
public ComponentDto getRootComponentByUuidOrKey(DbSession dbSession, @Nullable String componentUuid, @Nullable String componentKey, ParamNames parameterNames) {
checkByUuidOrKey(componentUuid, componentKey, parameterNames);
if (componentUuid != null) {
return checkIsProject(getByUuid(dbSession, checkParamNotEmpty(componentUuid, parameterNames.getUuidParam()), LABEL_PROJECT));
}
return checkIsProject(getByKey(dbSession, checkParamNotEmpty(componentKey, parameterNames.getKeyParam()), LABEL_PROJECT));
}
private static String checkParamNotEmpty(String value, String param) {
checkArgument(!value.isEmpty(), MSG_PARAMETER_MUST_NOT_BE_EMPTY, param);
return value;
}
private static void checkByUuidOrKey(@Nullable String componentUuid, @Nullable String componentKey, ParamNames parameterNames) {
checkArgument(componentUuid != null ^ componentKey != null, MSG_COMPONENT_ID_OR_KEY_TEMPLATE, parameterNames.getUuidParam(), parameterNames.getKeyParam());
}
public ComponentDto getByKey(DbSession dbSession, String key) {
return getByKey(dbSession, key, LABEL_COMPONENT);
}
private ComponentDto getByKey(DbSession dbSession, String key, String label) {
return checkComponent(dbClient.componentDao().selectByKey(dbSession, key), "%s key '%s' not found", label, key);
}
public ComponentDto getByUuid(DbSession dbSession, String uuid) {
return getByUuid(dbSession, uuid, LABEL_COMPONENT);
}
private ComponentDto getByUuid(DbSession dbSession, String uuid, String label) {
return checkComponent(dbClient.componentDao().selectByUuid(dbSession, uuid), "%s id '%s' not found", label, uuid);
}
private static ComponentDto checkComponent(Optional componentDto, String message, Object... messageArguments) {
if (componentDto.isPresent() && componentDto.get().isEnabled() && componentDto.get().getMainBranchProjectUuid() == null) {
return componentDto.get();
}
throw new NotFoundException(format(message, messageArguments));
}
public ComponentDto getRootComponentByUuidOrKey(DbSession dbSession, @Nullable String projectUuid, @Nullable String projectKey) {
ComponentDto project;
if (projectUuid != null) {
project = getByUuid(dbSession, projectUuid, LABEL_PROJECT);
} else {
project = getByKey(dbSession, projectKey, LABEL_PROJECT);
}
checkIsProject(project);
return project;
}
private ComponentDto checkIsProject(ComponentDto component) {
Set rootQualifiers = getRootQualifiers(resourceTypes);
checkRequest(component.scope().equals(Scopes.PROJECT) && rootQualifiers.contains(component.qualifier()),
format(
"Component '%s' (id: %s) must be a project%s.",
component.getDbKey(), component.uuid(),
rootQualifiers.contains(Qualifiers.VIEW) ? " or a view" : ""));
return component;
}
private static Set getRootQualifiers(ResourceTypes resourceTypes) {
Collection rootTypes = resourceTypes.getRoots();
return rootTypes
.stream()
.map(ResourceType::getQualifier)
.collect(MoreCollectors.toSet(rootTypes.size()));
}
public OrganizationDto getOrganization(DbSession dbSession, ComponentDto component) {
String organizationUuid = component.getOrganizationUuid();
java.util.Optional organizationDto = dbClient.organizationDao().selectByUuid(dbSession, organizationUuid);
return checkFoundWithOptional(organizationDto, "Organization with uuid '%s' not found", organizationUuid);
}
/**
* Components of the main branch won't be found
*/
public ComponentDto getByKeyAndBranch(DbSession dbSession, String key, String branch) {
java.util.Optional componentDto = dbClient.componentDao().selectByKeyAndBranch(dbSession, key, branch);
if (componentDto.isPresent() && componentDto.get().isEnabled()) {
return componentDto.get();
}
throw new NotFoundException(format("Component '%s' on branch '%s' not found", key, branch));
}
public ComponentDto getByKeyAndOptionalBranch(DbSession dbSession, String key, @Nullable String branch) {
return branch == null ? getByKey(dbSession, key) : getByKeyAndBranch(dbSession, key, branch);
}
public enum ParamNames {
PROJECT_ID_AND_KEY("projectId", "projectKey"),
PROJECT_UUID_AND_KEY("projectUuid", "projectKey"),
PROJECT_UUID_AND_PROJECT("projectUuid", "project"),
UUID_AND_KEY("uuid", "key"),
ID_AND_KEY("id", "key"),
COMPONENT_ID_AND_KEY("componentId", "componentKey"),
BASE_COMPONENT_ID_AND_KEY("baseComponentId", "baseComponentKey"),
DEVELOPER_ID_AND_KEY("developerId", "developerKey"),
COMPONENT_ID_AND_COMPONENT("componentId", "component"),
PROJECT_ID_AND_PROJECT("projectId", "project"),
PROJECT_ID_AND_FROM("projectId", "from");
private final String uuidParamName;
private final String keyParamName;
ParamNames(String uuidParamName, String keyParamName) {
this.uuidParamName = uuidParamName;
this.keyParamName = keyParamName;
}
public String getUuidParam() {
return uuidParamName;
}
public String getKeyParam() {
return keyParamName;
}
}
}
