path: root/structures.cpp

// **************************************************************************
// * This file is part of the FreeFileSync project. It is distributed under *
// * GNU General Public License: http://www.gnu.org/licenses/gpl.html       *
// * Copyright (C) 2008-2011 ZenJu (zhnmju123 AT gmx.de)                    *
// **************************************************************************
//
#include "structures.h"
#include <wx/intl.h>
//#include <stdexcept>

using namespace ffs3;


Zstring ffs3::standardExcludeFilter()
{
#ifdef FFS_WIN
    static Zstring exclude(wxT("\
\\System Volume Information\\\n\
\\RECYCLER\\\n\
\\RECYCLED\\\n\
\\$Recycle.Bin\\")); //exclude Recycle Bin
#elif defined FFS_LINUX
    static Zstring exclude; //exclude nothing
#endif
    return exclude;
}


wxString ffs3::getVariantName(CompareVariant var)
{
    switch (var)
    {
    case CMP_BY_CONTENT:
        return _("File content");
    case CMP_BY_TIME_SIZE:
        return _("File size and date");
    }

    assert(false);
    return wxEmptyString;
}


wxString ffs3::getVariantName(const SyncConfiguration& syncCfg)
{
    switch (getVariant(syncCfg))
    {
    case SyncConfiguration::AUTOMATIC:
        return _("<Automatic>");
    case SyncConfiguration::MIRROR:
        return _("Mirror ->>");
    case SyncConfiguration::UPDATE:
        return _("Update ->");
    case SyncConfiguration::CUSTOM:
        return _("Custom");
    }
    return _("Error");
}


void ffs3::setTwoWay(SyncConfiguration& syncCfg) //helper method used by <Automatic> mode fallback to overwrite old with newer files
{
    syncCfg.automatic = false;
    syncCfg.exLeftSideOnly  = SYNC_DIR_RIGHT;
    syncCfg.exRightSideOnly = SYNC_DIR_LEFT;
    syncCfg.leftNewer       = SYNC_DIR_RIGHT;
    syncCfg.rightNewer      = SYNC_DIR_LEFT;
    syncCfg.different       = SYNC_DIR_NONE;
    syncCfg.conflict        = SYNC_DIR_NONE;
}


SyncConfiguration::Variant ffs3::getVariant(const SyncConfiguration& syncCfg)
{
    if (syncCfg.automatic == true)
        return SyncConfiguration::AUTOMATIC;  //automatic mode

    if (    syncCfg.exLeftSideOnly  == SYNC_DIR_RIGHT &&
            syncCfg.exRightSideOnly == SYNC_DIR_RIGHT &&
            syncCfg.leftNewer       == SYNC_DIR_RIGHT &&
            syncCfg.rightNewer      == SYNC_DIR_RIGHT &&
            syncCfg.different       == SYNC_DIR_RIGHT &&
            syncCfg.conflict        == SYNC_DIR_RIGHT)
        return SyncConfiguration::MIRROR;    //one way ->

    else if (syncCfg.exLeftSideOnly  == SYNC_DIR_RIGHT &&
             syncCfg.exRightSideOnly == SYNC_DIR_NONE  &&
             syncCfg.leftNewer       == SYNC_DIR_RIGHT &&
             syncCfg.rightNewer      == SYNC_DIR_NONE  &&
             syncCfg.different       == SYNC_DIR_RIGHT  &&
             syncCfg.conflict        == SYNC_DIR_NONE)
        return SyncConfiguration::UPDATE;    //Update ->
    else
        return SyncConfiguration::CUSTOM;    //other
}


void ffs3::setVariant(SyncConfiguration& syncCfg, const SyncConfiguration::Variant var)
{
    switch (var)
    {
    case SyncConfiguration::AUTOMATIC:
        syncCfg.automatic = true;
        break;
    case SyncConfiguration::MIRROR:
        syncCfg.automatic = false;
        syncCfg.exLeftSideOnly  = SYNC_DIR_RIGHT;
        syncCfg.exRightSideOnly = SYNC_DIR_RIGHT;
        syncCfg.leftNewer       = SYNC_DIR_RIGHT;
        syncCfg.rightNewer      = SYNC_DIR_RIGHT;
        syncCfg.different       = SYNC_DIR_RIGHT;
        syncCfg.conflict        = SYNC_DIR_RIGHT;
        break;
    case SyncConfiguration::UPDATE:
        syncCfg.automatic = false;
        syncCfg.exLeftSideOnly  = SYNC_DIR_RIGHT;
        syncCfg.exRightSideOnly = SYNC_DIR_NONE;
        syncCfg.leftNewer       = SYNC_DIR_RIGHT;
        syncCfg.rightNewer      = SYNC_DIR_NONE;
        syncCfg.different       = SYNC_DIR_RIGHT;
        syncCfg.conflict        = SYNC_DIR_NONE;
        break;
    case SyncConfiguration::CUSTOM:
        assert(false);
        break;
    }
}



wxString MainConfiguration::getSyncVariantName()
{
    const SyncConfiguration firstSyncCfg =
        firstPair.altSyncConfig.get() ?
        firstPair.altSyncConfig->syncConfiguration :
        syncConfiguration; //fallback to main sync cfg

    const SyncConfiguration::Variant firstVariant = getVariant(firstSyncCfg);

    //test if there's a deviating variant within the additional folder pairs
    for (std::vector<FolderPairEnh>::const_iterator i = additionalPairs.begin(); i != additionalPairs.end(); ++i)
    {
        const SyncConfiguration::Variant thisVariant =
            i->altSyncConfig.get() ?
            getVariant(i->altSyncConfig->syncConfiguration) :
            getVariant(syncConfiguration);

        if (thisVariant != firstVariant)
            return _("Multiple...");
    }

    //seems to be all in sync...
    return getVariantName(firstSyncCfg);
}


wxString ffs3::getDescription(CompareFilesResult cmpRes)
{
    switch (cmpRes)
    {
    case FILE_LEFT_SIDE_ONLY:
        return _("Files/folders that exist on left side only");
    case FILE_RIGHT_SIDE_ONLY:
        return _("Files/folders that exist on right side only");
    case FILE_LEFT_NEWER:
        return _("Files that exist on both sides, left one is newer");
    case FILE_RIGHT_NEWER:
        return _("Files that exist on both sides, right one is newer");
    case FILE_DIFFERENT:
        return _("Files that have different content");
    case FILE_EQUAL:
        return _("Files that are equal on both sides");
    case FILE_DIFFERENT_METADATA:
        return _("Files/folders that differ in attributes only");
    case FILE_CONFLICT:
        return _("Conflicts/files that cannot be categorized");
    }

    assert(false);
    return wxEmptyString;
}


wxString ffs3::getSymbol(CompareFilesResult cmpRes)
{
    switch (cmpRes)
    {
    case FILE_LEFT_SIDE_ONLY:
        return wxT("<|");
    case FILE_RIGHT_SIDE_ONLY:
        return wxT("|>");
    case FILE_LEFT_NEWER:
        return wxT("<<");
    case FILE_RIGHT_NEWER:
        return wxT(">>");
    case FILE_DIFFERENT:
        return wxT("!=");
    case FILE_EQUAL:
        return wxT("'=="); //added quotation mark to avoid error in Excel cell when exporting to *.cvs
    case FILE_CONFLICT:
    case FILE_DIFFERENT_METADATA:
        return wxT("\\/\\->");
    }

    assert(false);
    return wxEmptyString;
}


wxString ffs3::getDescription(SyncOperation op)
{
    switch (op)
    {
    case SO_CREATE_NEW_LEFT:
        return _("Copy from right to left");
    case SO_CREATE_NEW_RIGHT:
        return _("Copy from left to right");
    case SO_DELETE_LEFT:
        return _("Delete files/folders existing on left side only");
    case SO_DELETE_RIGHT:
        return _("Delete files/folders existing on right side only");
    case SO_OVERWRITE_LEFT:
        return _("Copy from right to left overwriting");
    case SO_OVERWRITE_RIGHT:
        return _("Copy from left to right overwriting");
    case SO_DO_NOTHING:
        return _("Do nothing");
    case SO_EQUAL:
        return _("Files that are equal on both sides");
    case SO_COPY_METADATA_TO_LEFT:
        return _("Copy attributes only from right to left");
    case SO_COPY_METADATA_TO_RIGHT:
        return _("Copy attributes only from left to right");
    case SO_UNRESOLVED_CONFLICT:
        return _("Conflicts/files that cannot be categorized");
    };

    assert(false);
    return wxEmptyString;
}


wxString ffs3::getSymbol(SyncOperation op)
{
    switch (op)
    {
    case SO_CREATE_NEW_LEFT:
        return wxT("*-");
    case SO_CREATE_NEW_RIGHT:
        return wxT("-*");
    case SO_DELETE_LEFT:
        return wxT("D-");
    case SO_DELETE_RIGHT:
        return wxT("-D");
    case SO_OVERWRITE_LEFT:
    case SO_COPY_METADATA_TO_LEFT:
        return wxT("<-");
    case SO_OVERWRITE_RIGHT:
    case SO_COPY_METADATA_TO_RIGHT:
        return wxT("->");
    case SO_DO_NOTHING:
        return wxT(" -");
    case SO_EQUAL:
        return wxT("'=="); //added quotation mark to avoid error in Excel cell when exporting to *.cvs
    case SO_UNRESOLVED_CONFLICT:
        return wxT("\\/\\->");
    };

    assert(false);
    return wxEmptyString;
}


namespace
{
bool sameFilterConfig(const std::vector<FolderPairEnh>& folderPairs)
{
    if (folderPairs.empty())
        return true;

    for (std::vector<FolderPairEnh>::const_iterator fp = folderPairs.begin(); fp != folderPairs.end(); ++fp)
        if (!(fp->localFilter == folderPairs[0].localFilter))
            return false;

    return true;
}
}


ffs3::MainConfiguration ffs3::merge(const std::vector<MainConfiguration>& mainCfgs)
{
    assert(!mainCfgs.empty());
    if (mainCfgs.empty())
        return ffs3::MainConfiguration();

    if (mainCfgs.size() == 1) //mergeConfigFilesImpl relies on this!
        return mainCfgs[0];   //

    //merge folder pair config
    std::vector<FolderPairEnh> fpMerged;
    for (std::vector<MainConfiguration>::const_iterator i = mainCfgs.begin(); i != mainCfgs.end(); ++i)
    {
        std::vector<FolderPairEnh> fpTmp;
        fpTmp.push_back(i->firstPair);
        fpTmp.insert(fpTmp.end(), i->additionalPairs.begin(), i->additionalPairs.end());

        //move all configuration to item level
        for (std::vector<FolderPairEnh>::iterator fp = fpTmp.begin(); fp != fpTmp.end(); ++fp)
        {
            if (!fp->altSyncConfig.get())
                fp->altSyncConfig.reset(
                    new AlternateSyncConfig(i->syncConfiguration,
                                            i->handleDeletion,
                                            i->customDeletionDirectory));

            //pragmatism: if both global and local include filter contain data, only local filter is preserved
            if (fp->localFilter.includeFilter == FilterConfig().includeFilter)
                fp->localFilter.includeFilter = i->globalFilter.includeFilter;

            fp->localFilter.excludeFilter.Trim(true, false);
            fp->localFilter.excludeFilter = i->globalFilter.excludeFilter + Zstr("\n") + fp->localFilter.excludeFilter;
            fp->localFilter.excludeFilter.Trim(true, false);
        }

        fpMerged.insert(fpMerged.end(), fpTmp.begin(), fpTmp.end());
    }

    //optimization: remove redundant configuration
    FilterConfig newGlobalFilter;

    const bool sameLocalFilter = sameFilterConfig(fpMerged);
    if (sameLocalFilter)
        newGlobalFilter = fpMerged[0].localFilter;

    for (std::vector<FolderPairEnh>::iterator fp = fpMerged.begin(); fp != fpMerged.end(); ++fp)
    {
        //if local config matches output global config we don't need local one
        if (    fp->altSyncConfig &&
                *fp->altSyncConfig ==
                AlternateSyncConfig(mainCfgs[0].syncConfiguration,
                                    mainCfgs[0].handleDeletion,
                                    mainCfgs[0].customDeletionDirectory))
            fp->altSyncConfig.reset();

        if (sameLocalFilter) //use global filter in this case
            fp->localFilter = FilterConfig();
    }


    //final assembly
    ffs3::MainConfiguration cfgOut = mainCfgs[0];
    cfgOut.globalFilter            = newGlobalFilter;
    cfgOut.firstPair               = fpMerged[0];
    cfgOut.additionalPairs.assign(fpMerged.begin() + 1, fpMerged.end());

    return cfgOut;
}