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
|
/***************************************************************************
* Copyright (C) 2009 by Peter Penz <[email protected]> *
* *
* This program 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 2 of the License, or *
* (at your option) any later version. *
* *
* This program 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, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
***************************************************************************/
#ifndef REVISIONCONTROLPLUGIN_H
#define REVISIONCONTROLPLUGIN_H
#include <libdolphin_export.h>
#include <QDateTime>
#include <QString>
#include <QObject>
class KFileItem;
class KFileItemList;
class QAction;
/**
* @brief Base class for version control plugins.
*
* Enables the file manager to show the version state
* of a versioned file.
*/
class LIBDOLPHINPRIVATE_EXPORT KVersionControlPlugin : public QObject
{
Q_OBJECT
public:
enum VersionState
{
/** The file is not under version control. */
UnversionedVersion,
/**
* The file is under version control and represents
* the latest version.
*/
NormalVersion,
/**
* The file is under version control and a newer
* version exists on the main branch.
*/
UpdateRequiredVersion,
/**
* The file is under version control and has been
* modified locally.
*/
LocallyModifiedVersion,
/**
* The file has not been under version control but
* has been marked to get added with the next commit.
*/
AddedVersion,
/**
* The file is under version control but has been marked
* for getting removed with the next commit.
*/
RemovedVersion,
/**
* The file is under version control and has been locally
* modified. A modification has also been done on the main
* branch.
*/
ConflictingVersion
};
KVersionControlPlugin();
virtual ~KVersionControlPlugin();
/**
* Returns the name of the file which stores
* the version control informations.
* (e. g. .svn, .cvs, .git).
*/
virtual QString fileName() const = 0;
/**
* Is invoked whenever the version control
* information will get retrieved for the directory
* \p directory. It is assured that the directory
* contains a trailing slash.
*/
virtual bool beginRetrieval(const QString& directory) = 0;
/**
* Is invoked after the version control information has been
* received. It is assured that
* KVersionControlPlugin::beginInfoRetrieval() has been
* invoked before.
*/
virtual void endRetrieval() = 0;
/**
* Returns the version state for the file \p item.
* It is assured that KVersionControlPlugin::beginInfoRetrieval() has been
* invoked before and that the file is part of the directory specified
* in beginInfoRetrieval().
*/
virtual VersionState versionState(const KFileItem& item) = 0;
/**
* Returns the list of actions that should be shown in the context menu
* for the files \p items. It is assured that the passed list is not empty.
* If an action triggers a change of the versions, the signal
* KVersionControlPlugin::versionStatesChanged() must be emitted.
*/
virtual QList<QAction*> contextMenuActions(const KFileItemList& items) = 0;
/**
* Returns the list of actions that should be shown in the context menu
* for the directory \p directory. If an action triggers a change of the versions,
* the signal KVersionControlPlugin::versionStatesChanged() must be emitted.
*/
virtual QList<QAction*> contextMenuActions(const QString& directory) = 0;
signals:
/**
* Should be emitted when the version state of files might have been changed
* after the last retrieval (e. g. by executing a context menu action
* of the version control plugin). The file manager will be triggered to
* update the version states of the directory \p directory by invoking
* KVersionControlPlugin::beginRetrieval(),
* KVersionControlPlugin::versionState() and
* KVersionControlPlugin::endRetrieval().
*/
void versionStatesChanged();
/**
* Is emitted if an information message with the content \a msg
* should be shown.
*/
void infoMessage(const QString& msg);
/**
* Is emitted if an error message with the content \a msg
* should be shown.
*/
void errorMessage(const QString& msg);
/**
* Is emitted if an "operation completed" message with the content \a msg
* should be shown.
*/
void operationCompletedMessage(const QString& msg);
};
// TODO: This is just a temporary test class. It will be made available as
// plugin outside Dolphin later.
#include <kfileitem.h>
#include <QHash>
#include <QTemporaryFile>
class LIBDOLPHINPRIVATE_EXPORT SubversionPlugin : public KVersionControlPlugin
{
Q_OBJECT
public:
SubversionPlugin();
virtual ~SubversionPlugin();
virtual QString fileName() const;
virtual bool beginRetrieval(const QString& directory);
virtual void endRetrieval();
virtual KVersionControlPlugin::VersionState versionState(const KFileItem& item);
virtual QList<QAction*> contextMenuActions(const KFileItemList& items);
virtual QList<QAction*> contextMenuActions(const QString& directory);
private slots:
void updateFiles();
void showLocalChanges();
void commitFiles();
void addFiles();
void removeFiles();
void slotOperationCompleted();
void slotOperationError();
private:
/**
* Executes the command "svn {svnCommand}" for the files that have been
* set by getting the context menu actions (see contextMenuActions()).
* @param infoMsg Message that should be shown before the command is executed.
* @param errorMsg Message that should be shown if the execution of the command
* has been failed.
* @param operationCompletedMsg
* Message that should be shown if the execution of the command
* has been completed successfully.
*/
void execSvnCommand(const QString& svnCommand,
const QString& infoMsg,
const QString& errorMsg,
const QString& operationCompletedMsg);
void startSvnCommandProcess();
private:
QHash<QString, VersionState> m_versionInfoHash;
QList<QString> m_versionInfoKeys; // cache for accessing the keys of the hash
QAction* m_updateAction;
QAction* m_showLocalChangesAction;
QAction* m_commitAction;
QAction* m_addAction;
QAction* m_removeAction;
QString m_command;
QString m_errorMsg;
QString m_operationCompletedMsg;
QString m_contextDir;
KFileItemList m_contextItems;
QTemporaryFile m_tempFile;
};
#endif // REVISIONCONTROLPLUGIN_H
|
