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

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2024 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.platform;
  21
  22 import java.util.Optional;
  23 import org.sonar.api.Startable;
  24 import org.sonar.api.config.Configuration;
  25 import org.sonar.api.utils.MessageException;
  26 import org.sonar.api.utils.log.Logger;
  27 import org.sonar.api.utils.log.Loggers;
  28 import org.sonar.process.ProcessProperties;
  29 import org.sonar.server.platform.db.migration.version.DatabaseVersion;
  30
  31 import static org.sonar.server.log.ServerProcessLogging.STARTUP_LOGGER_NAME;
  32
  33 public class DatabaseServerCompatibility implements Startable {
  34
  35   private static final String HIGHLIGHTER = "################################################################################";
  36
  37   private final DatabaseVersion version;
  38   private final Configuration configuration;
  39
  40   public DatabaseServerCompatibility(DatabaseVersion version, Configuration configuration) {
  41     this.version = version;
  42     this.configuration = configuration;
  43   }
  44
  45   @Override
  46   public void start() {
  47     DatabaseVersion.Status status = version.getStatus();
  48     if (status == DatabaseVersion.Status.REQUIRES_DOWNGRADE) {
  49       throw MessageException.of("Database was upgraded to a more recent version of SonarQube. "
  50         + "A backup must probably be restored or the DB settings are incorrect.");
  51     }
  52     if (status == DatabaseVersion.Status.REQUIRES_UPGRADE) {
  53       Optional<Long> currentVersion = this.version.getVersion();
  54       if (currentVersion.isPresent() && currentVersion.get() < DatabaseVersion.MIN_UPGRADE_VERSION) {
  55         throw MessageException.of("Current version is too old. Please upgrade to Long Term Support version firstly.");
  56       }
  57       boolean blueGreen = configuration.getBoolean(ProcessProperties.Property.BLUE_GREEN_ENABLED.getKey()).orElse(false);
  58       if (!blueGreen) {
  59         String msg = "The database must be manually upgraded. Please backup the database and browse /setup. "
  60           + "For more information: https://docs.sonarqube.org/latest/setup/upgrading";
  61         Loggers.get(DatabaseServerCompatibility.class).warn(msg);
  62         Logger logger = Loggers.get(STARTUP_LOGGER_NAME);
  63         logger.warn(HIGHLIGHTER);
  64         logger.warn(msg);
  65         logger.warn(HIGHLIGHTER);
  66       }
  67     }
  68   }
  69
  70   @Override
  71   public void stop() {
  72     // do nothing
  73   }
  74 }