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.
/*
* 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.project.ws;
import com.google.common.io.Resources;
import java.util.Date;
import java.util.List;
import java.util.Set;
import javax.annotation.Nullable;
import org.sonar.api.server.ws.Change;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.Response;
import org.sonar.api.server.ws.WebService;
import org.sonar.api.server.ws.WebService.Param;
import org.sonar.api.utils.text.JsonWriter;
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.es.SearchOptions;
import org.sonar.server.organization.DefaultOrganizationProvider;
import org.sonar.server.user.UserSession;
import static com.google.common.collect.Sets.newHashSet;
import static org.sonar.db.permission.OrganizationPermission.ADMINISTER;
import static org.sonar.server.es.SearchOptions.MAX_LIMIT;
import static org.sonar.server.project.Visibility.PRIVATE;
import static org.sonar.server.project.Visibility.PUBLIC;
import static org.sonar.server.ws.WsUtils.checkFoundWithOptional;
public class GhostsAction implements ProjectsWsAction {
private static final String PARAM_ORGANIZATION = "organization";
private static final String ACTION = "ghosts";
private static final Set POSSIBLE_FIELDS = newHashSet("uuid", "key", "name", "creationDate", "visibility");
private final DbClient dbClient;
private final UserSession userSession;
private final DefaultOrganizationProvider defaultOrganizationProvider;
public GhostsAction(DbClient dbClient, UserSession userSession, DefaultOrganizationProvider defaultOrganizationProvider) {
this.dbClient = dbClient;
this.userSession = userSession;
this.defaultOrganizationProvider = defaultOrganizationProvider;
}
@Override
public void define(WebService.NewController context) {
WebService.NewAction action = context.createAction(ACTION);
action.setChangelog(new Change("6.4", "The 'uuid' field is deprecated in the response"));
action
.setDescription("List ghost projects. " +
"With the current architecture, it's no more possible to have invisible ghost projects. Therefore, the web service is deprecated. " +
"Requires 'Administer System' permission.")
.setResponseExample(Resources.getResource(getClass(), "ghosts-example.json"))
.setSince("5.2")
.setDeprecatedSince("6.6")
.addPagingParams(100, MAX_LIMIT)
.addFieldsParam(POSSIBLE_FIELDS)
.addSearchQuery("sonar", "names", "keys")
.setHandler(this);
action.createParam(PARAM_ORGANIZATION)
.setDescription("Organization key")
.setRequired(false)
.setInternal(true)
.setSince("6.3");
}
@Override
public void handle(Request request, Response response) throws Exception {
userSession.checkLoggedIn();
SearchOptions searchOptions = new SearchOptions()
.setPage(request.mandatoryParamAsInt(Param.PAGE),
request.mandatoryParamAsInt(Param.PAGE_SIZE));
Set desiredFields = fieldsToReturn(request.paramAsStrings(Param.FIELDS));
String query = request.param(Param.TEXT_QUERY);
try (DbSession dbSession = dbClient.openSession(false)) {
OrganizationDto organization = getOrganization(dbSession, request);
userSession.checkPermission(ADMINISTER, organization);
long nbOfProjects = dbClient.componentDao().countGhostProjects(dbSession, organization.getUuid(), query);
List projects = dbClient.componentDao().selectGhostProjects(dbSession, organization.getUuid(), query,
searchOptions.getOffset(), searchOptions.getLimit());
try (JsonWriter json = response.newJsonWriter()) {
json.beginObject();
writeProjects(json, projects, desiredFields);
searchOptions.writeJson(json, nbOfProjects);
json.endObject();
}
}
}
private OrganizationDto getOrganization(DbSession dbSession, Request request) {
String organizationKey = request.getParam(PARAM_ORGANIZATION)
.or(defaultOrganizationProvider.get()::getKey);
return checkFoundWithOptional(
dbClient.organizationDao().selectByKey(dbSession, organizationKey),
"No organization for key '%s'", organizationKey);
}
private static void writeProjects(JsonWriter json, List projects, Set fieldsToReturn) {
json.name("projects");
json.beginArray();
for (ComponentDto project : projects) {
json.beginObject();
json.prop("uuid", project.uuid());
writeIfWished(json, "key", project.getDbKey(), fieldsToReturn);
writeIfWished(json, "name", project.name(), fieldsToReturn);
writeIfWished(json, "creationDate", project.getCreatedAt(), fieldsToReturn);
writeIfWished(json, "visibility", project.isPrivate() ? PRIVATE.getLabel() : PUBLIC.getLabel(), fieldsToReturn);
json.endObject();
}
json.endArray();
}
private static void writeIfWished(JsonWriter json, String key, String value, Set fieldsToReturn) {
if (fieldsToReturn.contains(key)) {
json.prop(key, value);
}
}
private static void writeIfWished(JsonWriter json, String key, Date value, Set desiredFields) {
if (desiredFields.contains(key)) {
json.propDateTime(key, value);
}
}
private static Set fieldsToReturn(@Nullable List desiredFieldsFromRequest) {
if (desiredFieldsFromRequest == null) {
return POSSIBLE_FIELDS;
}
return newHashSet(desiredFieldsFromRequest);
}
}
