source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2023 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.server.qualityprofile.ws;
  21
  22 import org.sonar.api.server.ws.Change;
  23 import org.sonar.api.server.ws.Request;
  24 import org.sonar.api.server.ws.Response;
  25 import org.sonar.api.server.ws.WebService;
  26 import org.sonar.db.DbClient;
  27 import org.sonar.db.DbSession;
  28 import org.sonar.db.qualityprofile.QProfileDto;
  29 import org.sonar.server.qualityprofile.BulkChangeResult;
  30 import org.sonar.server.qualityprofile.QProfileRules;
  31 import org.sonar.server.rule.index.RuleQuery;
  32 import org.sonar.server.rule.ws.RuleQueryFactory;
  33 import org.sonar.server.user.UserSession;
  34
  35 import static org.sonar.core.util.Uuids.UUID_EXAMPLE_04;
  36 import static org.sonar.server.qualityprofile.ws.BulkChangeWsResponse.writeResponse;
  37 import static org.sonar.server.rule.ws.RuleWsSupport.defineGenericRuleSearchParameters;
  38 import static org.sonarqube.ws.client.qualityprofile.QualityProfileWsParameters.ACTION_DEACTIVATE_RULES;
  39 import static org.sonarqube.ws.client.qualityprofile.QualityProfileWsParameters.PARAM_TARGET_KEY;
  40
  41 public class DeactivateRulesAction implements QProfileWsAction {
  42
  43   private final RuleQueryFactory ruleQueryFactory;
  44   private final UserSession userSession;
  45   private final QProfileRules ruleActivator;
  46   private final QProfileWsSupport wsSupport;
  47   private final DbClient dbClient;
  48
  49   public DeactivateRulesAction(RuleQueryFactory ruleQueryFactory, UserSession userSession, QProfileRules ruleActivator, QProfileWsSupport wsSupport, DbClient dbClient) {
  50     this.ruleQueryFactory = ruleQueryFactory;
  51     this.userSession = userSession;
  52     this.ruleActivator = ruleActivator;
  53     this.wsSupport = wsSupport;
  54     this.dbClient = dbClient;
  55   }
  56
  57   public void define(WebService.NewController controller) {
  58     WebService.NewAction deactivate = controller
  59       .createAction(ACTION_DEACTIVATE_RULES)
  60       .setDescription("Bulk deactivate rules on Quality profiles.<br>" +
  61         "Requires one of the following permissions:" +
  62         "<ul>" +
  63         "  <li>'Administer Quality Profiles'</li>" +
  64         "  <li>Edit right on the specified quality profile</li>" +
  65         "</ul>")
  66       .setPost(true)
  67       .setSince("4.4")
  68       .setChangelog(new Change("10.0", "Parameter 'sansTop25' is deprecated"))
  69       .setHandler(this);
  70
  71     defineGenericRuleSearchParameters(deactivate);
  72
  73     deactivate.createParam(PARAM_TARGET_KEY)
  74       .setDescription("Quality Profile key on which the rule deactivation is done. To retrieve a profile key please see <code>api/qualityprofiles/search</code>")
  75       .setRequired(true)
  76       .setExampleValue(UUID_EXAMPLE_04);
  77   }
  78
  79   @Override
  80   public void handle(Request request, Response response) throws Exception {
  81     String qualityProfileKey = request.mandatoryParam(PARAM_TARGET_KEY);
  82     userSession.checkLoggedIn();
  83     BulkChangeResult result;
  84     try (DbSession dbSession = dbClient.openSession(false)) {
  85       QProfileDto profile = wsSupport.getProfile(dbSession, QProfileReference.fromKey(qualityProfileKey));
  86       wsSupport.checkCanEdit(dbSession, profile);
  87       RuleQuery ruleQuery = ruleQueryFactory.createRuleQuery(dbSession, request);
  88       ruleQuery.setIncludeExternal(false);
  89       result = ruleActivator.bulkDeactivateAndCommit(dbSession, profile, ruleQuery);
  90     }
  91     writeResponse(result, response);
  92   }
  93 }