org.sonar.server.branch.ws.DeleteAction.java Source code

Introduction

Here is the source code for org.sonar.server.branch.ws.DeleteAction.java

Source

/*
 * 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.branch.ws;

import com.google.common.io.Resources;
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.NewController;
import org.sonar.api.web.UserRole;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.component.BranchDto;
import org.sonar.db.component.ComponentDto;
import org.sonar.server.component.ComponentCleanerService;
import org.sonar.server.component.ComponentFinder;
import org.sonar.server.user.UserSession;

import static org.sonar.server.branch.ws.BranchesWs.addBranchParam;
import static org.sonar.server.branch.ws.BranchesWs.addProjectParam;
import static org.sonar.server.ws.WsUtils.checkFoundWithOptional;
import static org.sonar.server.branch.ws.ProjectBranchesParameters.ACTION_DELETE;
import static org.sonar.server.branch.ws.ProjectBranchesParameters.PARAM_BRANCH;
import static org.sonar.server.branch.ws.ProjectBranchesParameters.PARAM_PROJECT;

public class DeleteAction implements BranchWsAction {
    private final DbClient dbClient;
    private final UserSession userSession;
    private final ComponentCleanerService componentCleanerService;
    private final ComponentFinder componentFinder;

    public DeleteAction(DbClient dbClient, ComponentFinder componentFinder, UserSession userSession,
            ComponentCleanerService componentCleanerService) {
        this.dbClient = dbClient;
        this.componentFinder = componentFinder;
        this.userSession = userSession;
        this.componentCleanerService = componentCleanerService;
    }

    @Override
    public void define(NewController context) {
        WebService.NewAction action = context.createAction(ACTION_DELETE).setSince("6.6")
                .setDescription("Delete a non-main branch of a project.<br/>"
                        + "Requires 'Administer' rights on the specified project.")
                .setResponseExample(Resources.getResource(getClass(), "list-example.json")).setPost(true)
                .setHandler(this);

        addProjectParam(action);
        addBranchParam(action);
    }

    @Override
    public void handle(Request request, Response response) throws Exception {
        userSession.checkLoggedIn();
        String projectKey = request.mandatoryParam(PARAM_PROJECT);
        String branchKey = request.mandatoryParam(PARAM_BRANCH);

        try (DbSession dbSession = dbClient.openSession(false)) {
            ComponentDto project = componentFinder.getRootComponentByUuidOrKey(dbSession, null, projectKey);
            checkPermission(project);

            BranchDto branch = checkFoundWithOptional(
                    dbClient.branchDao().selectByKey(dbSession, project.uuid(), branchKey),
                    "Branch '%s' not found for project '%s'", branchKey, projectKey);

            if (branch.isMain()) {
                throw new IllegalArgumentException("Only non-main branches can be deleted");
            }
            ComponentDto branchComponent = componentFinder.getByKeyAndBranch(dbSession, projectKey, branchKey);
            componentCleanerService.deleteBranch(dbSession, branchComponent);
            response.noContent();
        }
    }

    private void checkPermission(ComponentDto project) {
        userSession.checkComponentPermission(UserRole.ADMIN, project);
    }

}