Dépôt officiel du code source de l'ERP OpenConcerto

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2011 OpenConcerto, by ILM Informatique. All rights reserved.

 *

 * The contents of this file are subject to the terms of the GNU General Public License Version 3

 * only ("GPL"). You may not use this file except in compliance with the License. You can obtain a

 * copy of the License at http://www.gnu.org/licenses/gpl-3.0.html See the License for the specific

 * language governing permissions and limitations under the License.

 *

 * When distributing the software, include this License Header Notice in each file.

 */

 /*

 * Créé le 18 avr. 2005

 */

package org.openconcerto.sql;

import org.openconcerto.sql.element.SQLElement;

import org.openconcerto.sql.element.SQLElementDirectory;

import org.openconcerto.sql.model.DBFileCache;

import org.openconcerto.sql.model.DBItemFileCache;

import org.openconcerto.sql.model.DBRoot;

import org.openconcerto.sql.model.DBStructureItem;

import org.openconcerto.sql.model.DBSystemRoot;

import org.openconcerto.sql.model.FieldMapper;

import org.openconcerto.sql.model.SQLBase;

import org.openconcerto.sql.model.SQLFilter;

import org.openconcerto.sql.model.SQLRow;

import org.openconcerto.sql.model.SQLRowListRSH;

import org.openconcerto.sql.model.SQLSelect;

import org.openconcerto.sql.model.SQLTable;

import org.openconcerto.sql.model.Where;

import org.openconcerto.sql.request.SQLFieldTranslator;

import org.openconcerto.utils.BaseDirs;

import org.openconcerto.utils.FileUtils;

import org.openconcerto.utils.StringUtils;

import java.io.File;

import java.io.IOException;

import java.io.StringReader;

import java.util.List;

import java.util.concurrent.Executor;

import java.util.concurrent.ExecutorService;

import java.util.concurrent.Executors;

import javax.xml.parsers.DocumentBuilder;

import javax.xml.parsers.DocumentBuilderFactory;

import javax.xml.parsers.ParserConfigurationException;

import org.w3c.dom.Document;

import org.xml.sax.InputSource;

import org.xml.sax.SAXException;

import net.jcip.annotations.GuardedBy;

/**

 * Regroupe les objets nécessaires au framework.

 *

 * @author Sylvain CUAZ

 */

public abstract class Configuration {

    public static File getDefaultConfDir() {

        return new File(System.getProperty("user.home"), ".java/ilm/sql-config/");

    }

    @GuardedBy("this")

    private static Configuration instance;

    public static SQLFieldTranslator getTranslator(SQLTable t) {

        // FIXME : Parametre inutile...

        return getInstance().getTranslator();

    }

    public synchronized static Configuration getInstance() {

        return instance;

    }

    public static final void setInstance(Configuration instance) {

        setInstance(instance, false);

    }

    public static final Configuration setInstance(final Configuration instance, final boolean destroyPrevious) {

        final Configuration prev;

        synchronized (Configuration.class) {

            prev = Configuration.instance;

            // don't destroy new instance

            if (prev == instance)

                return prev;

            Configuration.instance = instance;

            if (instance != null) {

                try {

                    instance.migrateToNewDBConfDir();

                } catch (IOException e) {

                    throw new IllegalStateException("Couldn't migrate");

                }

            }

        }

        if (prev != null && destroyPrevious)

            prev.destroy();

        return prev;

    }

    static public final void migrateToNewDir(final File oldDir, final File newDir) throws IOException {

        if (oldDir.exists() && !newDir.exists()) {

            if (!oldDir.isDirectory())

                throw new IOException("Old file isn't a directory : " + oldDir);

            FileUtils.mkdir_p(newDir.getParentFile());

            final String err = FileUtils.mv(oldDir, newDir);

            if (err != null)

                throw new IOException("Couldn't migrate from " + oldDir + " : " + err);

        }

    }

    @GuardedBy("this")

    private ExecutorService nonInteractiveSQLExecutor;

    public abstract ShowAs getShowAs();

    public abstract SQLBase getBase();

    public abstract DBRoot getRoot();

    public abstract DBSystemRoot getSystemRoot();

    public abstract SQLFilter getFilter();

    public final SQLFieldTranslator getTranslator() {

        return this.getDirectory().getTranslator();

    }

    public abstract SQLElementDirectory getDirectory();

    public abstract FieldMapper getFieldMapper();

    public abstract File getWD();

    // abstract :

    // - we can't return a default name as we don't know how to localize it

    // - avoid that 2 different application share the same name (and perhaps configuration)

    public abstract String getAppName();

    /**

     * A string that should be unique to an application and this configuration. E.g. allow to store

     * different settings for different uses of a same application.

     *

     * @return a string beginning with {@link #getAppName()}, <code>null</code> if appName is

     *         <code>null</code> or empty.

     */

    public final String getAppID() {

        final String appName = this.getAppName();

        if (StringUtils.isEmpty(appName))

            return null;

        final String variant = this.getAppVariant();

        if (StringUtils.isEmpty(variant, true))

            return appName;

        return appName + '-' + variant;

    }

    public String getAppVariant() {

        return null;

    }

    public abstract BaseDirs getBaseDirs();

    public final File getConfDir() {

        return getBaseDirs().getPreferencesFolder();

    }

    // for migration use

    @Deprecated

    protected File getOldConfDir() {

        return new File(getDefaultConfDir(), this.getAppID());

    }

    /**

     * A directory to store data depending on this {@link #getRoot() root}.

     *

     * @return a directory for this root.

     */

    public final File getConfDirForRoot() {

        return getConfDir(getRoot());

    }

    public final void migrateToNewDBConfDir() throws IOException {

        final File oldFile = getOldDBConfDir();

        final File newFile = getDBConfDir();

        migrateToNewDir(oldFile, newFile);

    }

    // for migration use

    private File getOldDBConfDir() {

        return new File(getOldConfDir(), "dataDepedent");

    }

    // for migration use

    @Deprecated

    protected final File getOldConfDir(DBStructureItem<?> db) {

        return DBItemFileCache.getDescendant(getOldDBConfDir(), DBFileCache.getJDBCAncestorNames(db, true));

    }

    private File getDBConfDir() {

        return new File(getConfDir(), "dataDependent");

    }

    public final File getConfDir(DBStructureItem<?> db) {

        return DBItemFileCache.getDescendant(getDBConfDir(), DBFileCache.getJDBCAncestorNames(db, true));

    }

    /**

     * Add the directory of <code>o</code> to this.

     *

     * @param o the configuration to add.

     * @return this.

     * @see SQLElementDirectory#putAll(SQLElementDirectory)

     */

    public Configuration add(Configuration o) {

        this.getDirectory().putAll(o.getDirectory());

        return this;

    }

    /**

     * Signal that this conf will not be used anymore.

     */

    public void destroy() {

        synchronized (this) {

            if (this.nonInteractiveSQLExecutor != null) {

                this.nonInteractiveSQLExecutor.shutdown();

            }

        }

    }

    /**

     * Get xml value from table FWK_LIST_PREFS for an user and a table.

     *

     * @param userId - Id of user

     * @param idTable - Id of table

     *

     * @throws IllegalStateException

     * @throws IllegalArgumentException

     */

    public Document getXMLConf(final Number userId, final String idTable) throws IllegalStateException, IllegalArgumentException {

        final SQLElement element = this.getDirectory().getElement("FWK_LIST_PREFS");

        final SQLTable columnPrefsTable = element.getTable();

        final SQLSelect select = new SQLSelect();

        select.addSelectStar(columnPrefsTable);

        select.setWhere((new Where(columnPrefsTable.getField("ID_USER"), "=", userId)).and(new Where(columnPrefsTable.getField("ID_TABLE"), "=", idTable)));

        final List<SQLRow> rqResult = SQLRowListRSH.execute(select);

        if (rqResult != null && !rqResult.isEmpty()) {

            final DocumentBuilderFactory docFactory = DocumentBuilderFactory.newInstance();

            DocumentBuilder docBuilder;

            try {

                docBuilder = docFactory.newDocumentBuilder();

            } catch (final ParserConfigurationException ex) {

                throw new IllegalStateException("Impossible to create new XML document", ex);

            }

            try {

                return docBuilder.parse(new InputSource(new StringReader(rqResult.get(0).getString("VALUE"))));

            } catch (final SAXException ex) {

                throw new IllegalArgumentException("Impossible to parse XML from database", ex);

            } catch (final IOException ex) {

                throw new IllegalStateException("Impossible to read content of database", ex);

            }

        }

        return null;

    }

    /**

     * Remove XML value from table FWK_LIST_PREFS for an user and a table.

     *

     * @param userId - Id of user

     * @param idTable - Id of table

     *

     * @throws IllegalStateException

     * @throws IllegalArgumentException

     */

    public void removeXMLConf(final Number userId, final String idTable) throws IllegalStateException, IllegalArgumentException {

        final SQLElement element = this.getDirectory().getElement("FWK_LIST_PREFS");

        final SQLTable columnPrefsTable = element.getTable();

        this.getRoot().getDBSystemRoot().getDataSource().execute("DELETE FROM " + columnPrefsTable.getSQLName().quote() + " WHERE \"ID_USER\" = " + userId + " AND \"ID_TABLE\" = '" + idTable + "'");

    }

    /**

     * An executor that should be used for background SQL requests. It can be used to limit the

     * concurrent number of database connections (as establishing a connection is expensive and the

     * server might have restrictions).

     *

     * @return a SQL executor.

     */

    public synchronized final Executor getNonInteractiveSQLExecutor() {

        if (this.nonInteractiveSQLExecutor == null) {

            this.nonInteractiveSQLExecutor = createNonInteractiveSQLExecutor();

        }

        return this.nonInteractiveSQLExecutor;

    }

    protected ExecutorService createNonInteractiveSQLExecutor() {

        return Executors.newFixedThreadPool(2);

    }

}