summaryrefslogtreecommitdiff
path: root/library/process_xml.h
blob: 24a2fe9b9c2d2455cf5a963d8de2692115f81f85 (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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
// **************************************************************************
// * 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-2010 ZenJu (zhnmju123 AT gmx.de)                    *
// **************************************************************************
//
#ifndef PROCESSXML_H_INCLUDED
#define PROCESSXML_H_INCLUDED

#include "../structures.h"
#include "../shared/xml_error.h"


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

enum ColumnTypes
{
    DIRECTORY, //this needs to begin with 0 and be continuous (some code relies on it)
    FULL_PATH,
    REL_PATH,
    FILENAME,
    SIZE,
    DATE,
    EXTENSION
};
const size_t COLUMN_TYPE_COUNT = 7;

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


typedef wxString Description;
typedef wxString Commandline;
typedef std::vector<std::pair<Description, Commandline> > ExternalApps;

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

    ffs3::MainConfiguration mainCfg;

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

    bool operator==(const XmlGuiConfig& other) const
    {
        return mainCfg                == other.mainCfg               &&
               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) {}

    ffs3::MainConfiguration mainCfg;

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


int retrieveSystemLanguage();


struct OptionalDialogs
{
    OptionalDialogs()
    {
        resetDialogs();
    }

    void resetDialogs();

    bool warningDependentFolders;
    bool warningSignificantDifference;
    bool warningNotEnoughDiskSpace;
    bool warningUnresolvedConflicts;
    bool warningSyncDatabase;
    bool popupOnConfigChange;
    bool showSummaryBeforeSync;
};


wxString getGlobalConfigFile();

struct XmlGlobalSettings
{
//---------------------------------------------------------------------
    //Shared (GUI/BATCH) settings
    XmlGlobalSettings() :
        programLanguage(retrieveSystemLanguage()),
        copyLockedFiles(true),
        copyFilePermissions(false),
        fileTimeTolerance(2),  //default 2s: FAT vs NTFS
        verifyFileCopy(false) {}

    int programLanguage;
    bool copyLockedFiles;          //VSS usage
    bool copyFilePermissions;

    size_t fileTimeTolerance; //max. allowed file time deviation
    bool verifyFileCopy;   //verify copied files

    OptionalDialogs optDialogs;

//---------------------------------------------------------------------
    struct _Gui
    {
        _Gui() :
            widthNotMaximized( wxDefaultCoord),
            heightNotMaximized(wxDefaultCoord),
            posXNotMaximized(  wxDefaultCoord),
            posYNotMaximized(  wxDefaultCoord),
            isMaximized(false),
            autoAdjustColumnsLeft(false),
            autoAdjustColumnsRight(false),
            cfgHistoryMax(10),
            folderHistLeftMax(12),
            folderHistRightMax(12),
            selectedTabBottomLeft(0),
            deleteOnBothSides(false),
            useRecyclerForManualDeletion(true), //enable if OS supports it; else user will have to activate first and then get an error message
#ifdef FFS_WIN
            textSearchRespectCase(false),
#elif defined FFS_LINUX
            textSearchRespectCase(true),
#endif
            showFileIconsLeft(true),
            showFileIconsRight(true),
            addFolderPairCountMax(5),
            lastUpdateCheck(0)
        {
            //default external apps will be translated "on the fly"!!!
#ifdef FFS_WIN
            externelApplications.push_back(std::make_pair(wxT("Open with Explorer"), //mark for extraction: _("Open with Explorer")
                                           wxT("explorer /select, \"%name\"")));
            externelApplications.push_back(std::make_pair(wxT("Open with default application"), //mark for extraction: _("Open with default application")
                                           wxT("cmd /c start \"\" \"%name\"")));
#elif defined FFS_LINUX
            externelApplications.push_back(std::make_pair(wxT("Browse directory"), //mark for extraction: _("Browse directory")
                                           wxT("xdg-open \"%dir\"")));
            externelApplications.push_back(std::make_pair(wxT("Open with default application"), //mark for extraction: _("Open with default application")
                                           wxT("xdg-open \"%name\"")));
#endif
        }

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

        ColumnAttributes columnAttribLeft;
        ColumnAttributes columnAttribRight;

        bool autoAdjustColumnsLeft;
        bool autoAdjustColumnsRight;

        ExternalApps externelApplications;

        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 textSearchRespectCase;
        bool showFileIconsLeft;
        bool showFileIconsRight;

        size_t addFolderPairCountMax;
        long lastUpdateCheck;          //time of last update check
    } 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;
}

void readConfig(const wxString& filename, XmlGuiConfig&      config); //throw (xmlAccess::XmlError)
void readConfig(const wxString& filename, XmlBatchConfig&    config); //throw (xmlAccess::XmlError)
void readConfig(                          XmlGlobalSettings& config); //throw (xmlAccess::XmlError)

void writeConfig(const XmlGuiConfig&      outputCfg, const wxString& filename); //throw (xmlAccess::XmlError)
void writeConfig(const XmlBatchConfig&    outputCfg, const wxString& filename); //throw (xmlAccess::XmlError)
void writeConfig(const XmlGlobalSettings& outputCfg);                           //throw (xmlAccess::XmlError)

//config conversion utilities
XmlGuiConfig   convertBatchToGui(const XmlBatchConfig& batchCfg);
XmlBatchConfig convertGuiToBatch(const XmlGuiConfig&   guiCfg);


//convert (multiple) *.ffs_gui, *.ffs_batch files or combinations of both into target config structure:
enum MergeType
{
    MERGE_GUI,       //pure gui config files
    MERGE_BATCH,     //  " batch   "
    MERGE_GUI_BATCH, //gui and batch files
    MERGE_OTHER
};
MergeType getMergeType(const std::vector<wxString>& filenames);   //throw ()

void convertConfig(const std::vector<wxString>& filenames, XmlGuiConfig&   config); //throw (xmlAccess::XmlError)
void convertConfig(const std::vector<wxString>& filenames, XmlBatchConfig& config); //throw (xmlAccess::XmlError)
}


#endif // PROCESSXML_H_INCLUDED
bgstack15