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
|
/*
* This file is part of the KFTPGrabber project
*
* Copyright (C) 2003-2006 by the KFTPGrabber developers
* Copyright (C) 2003-2006 Jernej Kos <kostko@jweb-network.net>
*
* 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
* is provided AS IS, WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, and
* NON-INFRINGEMENT. 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 Steet, Fifth Floor, Boston,
* MA 02110-1301, USA.
*
* In addition, as a special exception, the copyright holders give
* permission to link the code of portions of this program with the
* OpenSSL library under certain conditions as described in each
* individual source file, and distribute linked combinations
* including the two.
*
* You must obey the GNU General Public License in all respects
* for all of the code used other than OpenSSL. If you modify
* file(s) with this exception, you may extend this exception to your
* version of the file(s), but you are not obligated to do so. If you
* do not wish to do so, delete this exception statement from your
* version. If you delete this exception statement from all source
* files in the program, then also delete it here.
*/
#ifndef KFTPCORE_CUSTOMCOMMANDS_HANDLERSHANDLERS_H
#define KFTPCORE_CUSTOMCOMMANDS_HANDLERSHANDLERS_H
#include <ntqstring.h>
#include <ntqdom.h>
namespace KFTPCore {
namespace CustomCommands {
namespace Handlers {
/**
* The handler class is an abstract class which every actual handler
* must implement.
*
* @author Jernej Kos
*/
class Handler {
public:
/**
* Class constructor.
*
* @param name Handler name
*/
Handler(const TQString &name);
/**
* Returns the handler's name.
*/
TQString name() const { return m_name; }
/**
* This method should be implemented by actual handlers to handler the
* server response.
*
* @param raw Raw FTP response
* @param arguments Any argument nodes supplied in the XML file
* @return This method should return a formatted string
*/
virtual TQString handleResponse(const TQString &raw, TQDomNode arguments) const = 0;
private:
TQString m_name;
};
/**
* The Raw handler accepts no arguments and simply passes on raw data.
*
* @author Jernej Kos
*/
class RawHandler : public Handler {
public:
/**
* Class constructor.
*/
RawHandler();
/**
* @overload
* Reimplemented from Handler.
*/
TQString handleResponse(const TQString &raw, TQDomNode) const { return raw; }
};
/**
* The Substitue handler always returns a predefined value when the
* operation is completed successfully. %1 can be used in place of the
* raw data received from the server.
*
* @author Jernej Kos
*/
class SubstituteHandler : public Handler {
public:
/**
* Class constructor.
*/
SubstituteHandler();
/**
* @overload
* Reimplemented from Handler.
*/
TQString handleResponse(const TQString &raw, TQDomNode arguments) const;
};
/**
* The Regexp handler enables custom response parsing using regular
* expressions.
*
* @author Jernej Kos
*/
class RegexpHandler : public Handler {
public:
/**
* Class constructor.
*/
RegexpHandler();
/**
* @overload
* Reimplemented from Handler.
*/
TQString handleResponse(const TQString &raw, TQDomNode arguments) const;
};
}
}
}
#endif
|
