/**************************************************************************
 OmegaT - Computer Assisted Translation (CAT) tool
          with fuzzy matching, translation memory, keyword search,
          glossaries, and translation leveraging into updated projects.

 Copyright (C) 2012 Alex Buloichik
               2014 Alex Buloichik
               Home page: http://www.omegat.org/
               Support center: http://groups.yahoo.com/group/OmegaT/

 This file is part of OmegaT.

 OmegaT 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.

 OmegaT 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 <http://www.gnu.org/licenses/>.
 **************************************************************************/

package org.omegat.core.team2;

import java.io.File;

import gen.core.project.RepositoryDefinition;

/**
 * Interface for any remote repository implementation.
 *
 * @author Alex Buloichik (alex73mail@gmail.com)
 */
public interface IRemoteRepository2 {
    /**
     * Initialize repository provider.
     *
     * @param repo
     *            repository description instance
     * @param dir
     *            directory for store files
     * @param teamSettings
     *            team settings object for project
     */
    void init(RepositoryDefinition repo, File dir, ProjectTeamSettings teamSettings) throws Exception;

    /**
     * Get file version.
     */
    String getFileVersion(String file) throws Exception;

    void switchToVersion(String version) throws Exception;

    /**
     * Add the specified file in preparation for commit (e.g.
     * <code>git add</code>, <code>svn add</code>).
     *
     * @param path
     *            The relative path of the item from the root of the repo
     *            (should not start with a <code>/</code>)
     * @throws Exception
     */
    void addForCommit(String path) throws Exception;

    /**
     * Commit to repository after specified version, or after any version if 'null' specified.
     *
     * @param path
     *            path for commit
     * @param onVersions
     *            if version defined, then commit must be just after this version. Otherwise(if remote repository was
     *            updated after rebase), commit shouldn't be processed and should return null. If version is null, then
     *            commit can be after any version, i.e. previous version shouldn't be checked. It can be several
     *            versions defined since glossary will be committed after project_save.tmx.
     * @param comment
     *            comment for commit
     * @return new version if commit was processed, or null if remote repository was updated by other user
     */
    String commit(String[] onVersions, String comment) throws Exception;

    /**
     * Given repository does not exist on the remote machine
     *
     */
    @SuppressWarnings("serial")
    public static class BadRepositoryException extends Exception {
        public BadRepositoryException(String message) {
            super(message);
        }
    }

    /**
     * Network problems. E.g. no internet available.
     */
    @SuppressWarnings("serial")
    public static class NetworkException extends Exception {
        public NetworkException(Throwable ex) {
            super(ex);
        }
    }
}