org.nuiton.topia.service.migration.TopiaMigrationServiceContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of topia-extension-migration Show documentation
ObServe ToPIA Migration service module
The newest version!
package org.nuiton.topia.service.migration;

/*-
 * #%L
 * ObServe Toolkit :: ToPIA Migration service
 * %%
 * Copyright (C) 2017 - 2018 IRD, Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.hibernate.SessionFactory;
import org.nuiton.topia.persistence.TopiaApplicationContext;
import org.nuiton.topia.persistence.support.TopiaSqlSupport;
import org.nuiton.topia.service.migration.resources.MigrationVersionResource;
import org.nuiton.topia.service.migration.resources.MigrationVersionResourceProvider;
import org.nuiton.topia.service.migration.version.TMSVersion;
import org.nuiton.topia.service.migration.version.TMSVersionHibernateDao;
import org.nuiton.version.Version;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Optional;

/**
 * Contains all states of the migration service.
 * 
 * Created by tchemit on 05/05/2018.
 *
 * @author Tony Chemit - [email protected]
 */
@SuppressWarnings("WeakerAccess")
public class TopiaMigrationServiceContext {

    private static final Log log = LogFactory.getLog(TopiaMigrationServiceContext.class);

    /**
     * Service configuration.
     */
    protected final TopiaMigrationServiceConfiguration configuration;
    /**
     * Dao.
     */
    protected final TMSVersionHibernateDao dao;
    /**
     * Available migration resources found in class-path.
     */
    protected final MigrationVersionResourceProvider resources;
    /**
     * Is database is versioned?
     */
    protected final boolean dbNotVersioned;
    /**
     * Path where to store sql scripts.
     */
    protected final Path scriptPath;
    /**
     * Is TMSVersion table exists?
     */
    protected boolean versionTableExist;
    /**
     * Current database version.
     */
    protected Version dbVersion;

    protected TopiaMigrationServiceContext(TopiaMigrationServiceConfiguration configuration, boolean versionTableExist, boolean dbNotVersioned, Version dbVersion, MigrationVersionResourceProvider resources, TMSVersionHibernateDao dao) {
        this.configuration = configuration;
        this.versionTableExist = versionTableExist;
        this.dbNotVersioned = dbNotVersioned;
        this.dbVersion = dbVersion;
        this.resources = resources;
        this.dao = dao;
        try {
            this.scriptPath = Files.createTempDirectory("topia-migration-service");
        } catch (IOException e) {
            throw new IllegalStateException("Can't create scripts path", e);
        }
    }

    public static TopiaMigrationServiceContext of(TopiaMigrationServiceConfiguration configuration) {

        TopiaApplicationContext topiaApplicationContext = configuration.getApplicationContext();

        boolean versionTableExist;
        boolean dbNotVersioned = false;
        Version dbVersion;
        Version v = null;

        TMSVersionHibernateDao dao = new TMSVersionHibernateDao(topiaApplicationContext);

        try {

            versionTableExist = dao.isTableExists();
            if (versionTableExist) {

                Optional tmsVersion = dao.getVersion();

                if (tmsVersion.isPresent()) {
                    v = tmsVersion.get().toVersion();
                }

                if (v == null) {
                    log.warn(String.format("Version not found on table %s", TMSVersionHibernateDao.TABLE_NAME));
                }
            } else if (topiaApplicationContext.getConfiguration().isInitSchema()) {
                dao.createSchemaIfNotExist();
            }

        } finally {

            if (v == null) {
                // la base dans ce cas n'est pas versionee.
                // On dit que la version de la base est 0
                // et les schema de cette version 0 doivent
                // etre detenu en local
                v = Version.VZERO;
                dbNotVersioned = true;
                log.info("Database version not found, so database schema is considered as V0");
            } else {
                log.info(String.format("Detected database version: %s", v));
            }
            dbVersion = v;
        }

        return new TopiaMigrationServiceContext(configuration, versionTableExist, dbNotVersioned, dbVersion, MigrationVersionResourceProvider.get(), dao);
    }

    public Path getScriptPath() {
        return scriptPath;
    }

    public boolean isVersionTableExist() {
        return versionTableExist;
    }

    public boolean isDbNotVersioned() {
        return dbNotVersioned;
    }

    public Version getModelVersion() {
        return configuration.getModelVersion();
    }

    public Version getDbVersion() {
        return dbVersion;
    }

    public MigrationVersionResourceProvider getResources() {
        return resources;
    }

    public void createSchemaIfNotExist() {
        dao.createSchemaIfNotExist();
        versionTableExist = true;
    }

    public void saveModelVersion() {
        saveVersion(getModelVersion());
    }

    public Optional getAskUserToMigrate() {
        return Optional.ofNullable(configuration.getCallback());
    }

    protected void saveVersion(Version version) {
        log.info(String.format("[ Version %s ] Saving new database version.", version));
        dao.save(version.getVersion());
        dbVersion = version;
    }

    public SessionFactory newSessionFactory() {
        return dao.newSessionFactory();
    }

    public MigrationVersionResource getResource(Version version) {
        return resources.getResource(version);
    }

    public TopiaMigrationServiceExecutor newExecutor(Version version, TopiaSqlSupport sqlSupport) {
        return new TopiaMigrationServiceExecutor(version, sqlSupport, configuration.getClassifier(), getScriptPath());
    }

}