summaryrefslogtreecommitdiff
path: root/library/processXml.h
blob: 1597228914b29d8ed64d93af6b6214aa0780541e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
#ifndef PROCESSXML_H_INCLUDED
#define PROCESSXML_H_INCLUDED

#include "../structures.h"
#include "fileHandling.h"

namespace xmlAccess
{
    enum OnError
    {
        ON_ERROR_POPUP,
        ON_ERROR_IGNORE,
        ON_ERROR_EXIT
    };

    enum XmlType
    {
        XML_GUI_CONFIG,
        XML_BATCH_CONFIG,
        XML_GLOBAL_SETTINGS,
        XML_OTHER
    };

    enum ColumnTypes
    {
        DIRECTORY,
        FULL_PATH,
        REL_PATH,
        FILENAME,
        SIZE,
        DATE
    };
    const unsigned COLUMN_TYPE_COUNT = 6;

    struct ColumnAttrib
    {
        ColumnTypes type;
        bool         visible;
        unsigned int position;
        int          width;
    };
    typedef std::vector<ColumnAttrib> ColumnAttributes;

    XmlType getXmlType(const wxString& filename);
//---------------------------------------------------------------------

    struct XmlGuiConfig
    {
        XmlGuiConfig() :
                hideFilteredElements(false),
                ignoreErrors(false),
                syncPreviewEnabled(true) {} //initialize values

        FreeFileSync::MainConfiguration mainCfg;
        std::vector<FreeFileSync::FolderPair> directoryPairs;

        bool hideFilteredElements;
        bool ignoreErrors; //reaction on error situation during synchronization
        bool syncPreviewEnabled;

        bool operator==(const XmlGuiConfig& other) const
        {
            return mainCfg              == other.mainCfg              &&
                   directoryPairs       == other.directoryPairs       &&
                   hideFilteredElements == other.hideFilteredElements &&
                   ignoreErrors         == other.ignoreErrors         &&
                   syncPreviewEnabled   == other.syncPreviewEnabled;
        }

        bool operator!=(const XmlGuiConfig& other) const
        {
            return !(*this == other);
        }
    };


    struct XmlBatchConfig
    {
        XmlBatchConfig() : silent(false), handleError(ON_ERROR_POPUP) {}

        FreeFileSync::MainConfiguration mainCfg;
        std::vector<FreeFileSync::FolderPair> directoryPairs;

        bool silent;
        OnError handleError;       //reaction on error situation during synchronization
        wxString logFileDirectory; //
    };

    int retrieveSystemLanguage();
    bool supportForSymbolicLinks();


    struct WarningMessages
    {
        WarningMessages()
        {
            resetWarnings();
        }

        void resetWarnings();

        bool warningDependentFolders;
        bool warningSignificantDifference;
        bool warningNotEnoughDiskSpace;
        bool warningUnresolvedConflicts;
        bool warningInvalidDate;
        bool warningSameDateDiffSize;
        bool warningDSTChangeWithinHour;
    };


    struct XmlGlobalSettings
    {
//---------------------------------------------------------------------
        //Shared (GUI/BATCH) settings
        XmlGlobalSettings() :
                programLanguage(retrieveSystemLanguage()),
                fileTimeTolerance(2),  //default 2s: FAT vs NTFS
                ignoreOneHourDiff(true),
                traverseDirectorySymlinks(false),
                copyFileSymlinks(supportForSymbolicLinks()),
                lastUpdateCheck(0) {}

        int programLanguage;
        unsigned int fileTimeTolerance; //max. allowed file time deviation
        bool ignoreOneHourDiff; //ignore +/- 1 hour due to DST change
        bool traverseDirectorySymlinks;
        bool copyFileSymlinks; //copy symbolic link instead of target file
        long lastUpdateCheck; //time of last update check

        WarningMessages warnings;

//---------------------------------------------------------------------
        struct _Gui
        {
            _Gui() :
                    widthNotMaximized(wxDefaultCoord),
                    heightNotMaximized(wxDefaultCoord),
                    posXNotMaximized(wxDefaultCoord),
                    posYNotMaximized(wxDefaultCoord),
                    isMaximized(false),
#ifdef FFS_WIN
                    commandLineFileManager(wxT("explorer /select, %name")),
#elif defined FFS_LINUX
                    commandLineFileManager(wxT("konqueror \"%path\"")),
#endif
                    cfgHistoryMax(10),
                    folderHistLeftMax(12),
                    folderHistRightMax(12),
                    selectedTabBottomLeft(0),
                    deleteOnBothSides(false),
                    useRecyclerForManualDeletion(FreeFileSync::recycleBinExists()), //enable if OS supports it; else user will have to activate first and then get an error message
                    showFileIconsLeft(true),
                    showFileIconsRight(true),
                    popupOnConfigChange(true),
                    showSummaryBeforeSync(true) {}

            int widthNotMaximized;
            int heightNotMaximized;
            int posXNotMaximized;
            int posYNotMaximized;
            bool isMaximized;

            ColumnAttributes columnAttribLeft;
            ColumnAttributes columnAttribRight;

            wxString commandLineFileManager;

            std::vector<wxString> cfgFileHistory;
            unsigned int cfgHistoryMax;

            std::vector<wxString> folderHistoryLeft;
            unsigned int folderHistLeftMax;

            std::vector<wxString> folderHistoryRight;
            unsigned int folderHistRightMax;

            int selectedTabBottomLeft;

            bool deleteOnBothSides;
            bool useRecyclerForManualDeletion;
            bool showFileIconsLeft;
            bool showFileIconsRight;
            bool popupOnConfigChange;
            bool showSummaryBeforeSync;
        } gui;

//---------------------------------------------------------------------
        //struct _Batch
    };


    inline
    bool sortByType(const ColumnAttrib& a, const ColumnAttrib& b)
    {
        return a.type < b.type;
    }


    inline
    bool sortByPositionOnly(const ColumnAttrib& a, const ColumnAttrib& b)
    {
        return a.position < b.position;
    }


    inline
    bool sortByPositionAndVisibility(const ColumnAttrib& a, const ColumnAttrib& b)
    {
        if (a.visible == false) //hidden elements shall appear at end of vector
            return false;
        if (b.visible == false)
            return true;
        return a.position < b.position;
    }


    XmlGuiConfig readGuiConfig(const wxString& filename);
    XmlBatchConfig readBatchConfig(const wxString& filename);
    XmlGlobalSettings readGlobalSettings();   //used for both GUI and batch mode, independent from configuration instance

    void writeGuiConfig(const wxString& filename, const XmlGuiConfig& outputCfg);
    void writeBatchConfig(const wxString& filename, const XmlBatchConfig& outputCfg);
    void writeGlobalSettings(const XmlGlobalSettings& outputCfg);

}


#endif // PROCESSXML_H_INCLUDED
bgstack15