summaryrefslogtreecommitdiffstats
path: root/src/kernel/qnetworkprotocol.h
blob: ab59985180913826075e1bd40351d4bd3f918401 (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
/****************************************************************************
**
** Definition of TQNetworkProtocol class
**
** Created : 950429
**
** Copyright (C) 1992-2008 Trolltech ASA.  All rights reserved.
**
** This file is part of the kernel module of the TQt GUI Toolkit.
**
** This file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free
** Software Foundation and appearing in the files LICENSE.GPL2
** and LICENSE.GPL3 included in the packaging of this file.
** Alternatively you may (at your option) use any later version
** of the GNU General Public License if such license has been
** publicly approved by Trolltech ASA (or its successors, if any)
** and the KDE Free TQt Foundation.
**
** Please review the following information to ensure GNU General
** Public Licensing retquirements will be met:
** http://trolltech.com/products/qt/licenses/licensing/opensource/.
** If you are unsure which license is appropriate for your use, please
** review the following information:
** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
** or contact the sales department at sales@trolltech.com.
**
** This file may be used under the terms of the Q Public License as
** defined by Trolltech ASA and appearing in the file LICENSE.TQPL
** included in the packaging of this file.  Licensees holding valid TQt
** Commercial licenses may use this file in accordance with the TQt
** Commercial License Agreement provided with the Software.
**
** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
** herein.
**
**********************************************************************/

#ifndef TQNETWORKPROTOCOL_H
#define TQNETWORKPROTOCOL_H

#ifndef QT_H
#include "qurlinfo.h"
#include "qstring.h"
#include "qdict.h"
#include "qobject.h"
#endif // QT_H

#ifndef QT_NO_NETWORKPROTOCOL

#if __GNUC__ - 0 > 3
#pragma GCC system_header
#endif

class TQNetworkProtocol;
class TQNetworkOperation;
class TQTimer;
class TQUrlOperator;
class TQNetworkProtocolPrivate;
template <class T> class TQValueList;

class Q_EXPORT TQNetworkProtocolFactoryBase
{
public:
   virtual TQNetworkProtocol *createObject() = 0;

};

template< class T >
class TQNetworkProtocolFactory : public TQNetworkProtocolFactoryBase
{
public:
    TQNetworkProtocol *createObject() {
	return new T;
    }

};

typedef TQDict< TQNetworkProtocolFactoryBase > TQNetworkProtocolDict;

class Q_EXPORT TQNetworkProtocol : public TQObject
{
    Q_OBJECT

public:
    enum State {
	StWaiting = 0,
	StInProgress,
	StDone,
	StFailed,
	StStopped
    };

    enum Operation {
	OpListChildren = 1,
	OpMkDir = 2,
	OpMkdir = OpMkDir, // ### remove in 4.0
	OpRemove = 4,
	OpRename = 8,
	OpGet = 32,
	OpPut = 64
    };

    enum ConnectionState {
	ConHostFound,
	ConConnected,
	ConClosed
    };

    enum Error {
	// no error
	NoError = 0,
	// general errors
	ErrValid,
	ErrUnknownProtocol,
	ErrUnsupported,
	ErrParse,
	// errors on connect
	ErrLoginIncorrect,
	ErrHostNotFound,
	// protocol errors
	ErrListChildren,
	ErrListChlidren = ErrListChildren, // ### remove in 4.0
	ErrMkDir,
	ErrMkdir = ErrMkDir, // ### remove in 4.0
	ErrRemove,
	ErrRename,
	ErrGet,
	ErrPut,
	ErrFileNotExisting,
	ErrPermissionDenied
    };

    TQNetworkProtocol();
    virtual ~TQNetworkProtocol();

    virtual void setUrl( TQUrlOperator *u );

    virtual void setAutoDelete( bool b, int i = 10000 );
    bool autoDelete() const;

    static void registerNetworkProtocol( const TQString &protocol,
					 TQNetworkProtocolFactoryBase *protocolFactory );
    static TQNetworkProtocol *getNetworkProtocol( const TQString &protocol );
    static bool hasOnlyLocalFileSystem();

    virtual int supportedOperations() const;
    virtual void addOperation( TQNetworkOperation *op );

    TQUrlOperator *url() const;
    TQNetworkOperation *operationInProgress() const;
    virtual void clearOperationQueue();
    virtual void stop();

signals:
    void data( const TQByteArray &, TQNetworkOperation *res );
    void connectionStateChanged( int state, const TQString &data );
    void finished( TQNetworkOperation *res );
    void start( TQNetworkOperation *res );
    void newChildren( const TQValueList<TQUrlInfo> &, TQNetworkOperation *res );
    void newChild( const TQUrlInfo &, TQNetworkOperation *res );
    void createdDirectory( const TQUrlInfo &, TQNetworkOperation *res );
    void removed( TQNetworkOperation *res );
    void itemChanged( TQNetworkOperation *res );
    void dataTransferProgress( int bytesDone, int bytesTotal, TQNetworkOperation *res );

protected:
    virtual void processOperation( TQNetworkOperation *op );
    virtual void operationListChildren( TQNetworkOperation *op );
    virtual void operationMkDir( TQNetworkOperation *op );
    virtual void operationRemove( TQNetworkOperation *op );
    virtual void operationRename( TQNetworkOperation *op );
    virtual void operationGet( TQNetworkOperation *op );
    virtual void operationPut( TQNetworkOperation *op );
    virtual void operationPutChunk( TQNetworkOperation *op );
    virtual bool checkConnection( TQNetworkOperation *op );

private:
    TQNetworkProtocolPrivate *d;

private slots:
    void processNextOperation( TQNetworkOperation *old );
    void startOps();
    void emitNewChildren( const TQUrlInfo &i, TQNetworkOperation *op );

    void removeMe();

private:	// Disabled copy constructor and operator=
#if defined(Q_DISABLE_COPY)
    TQNetworkProtocol( const TQNetworkProtocol & );
    TQNetworkProtocol &operator=( const TQNetworkProtocol & );
#endif
};

class TQNetworkOperationPrivate;

class Q_EXPORT TQNetworkOperation : public TQObject
{
    Q_OBJECT
    friend class TQUrlOperator;

public:
    TQNetworkOperation( TQNetworkProtocol::Operation operation,
		    const TQString &arg0, const TQString &arg1,
		    const TQString &arg2 );
    TQNetworkOperation( TQNetworkProtocol::Operation operation,
		    const TQByteArray &arg0, const TQByteArray &arg1,
		    const TQByteArray &arg2 );
    ~TQNetworkOperation();

    void setState( TQNetworkProtocol::State state );
    void setProtocolDetail( const TQString &detail );
    void setErrorCode( int ec );
    void setArg( int num, const TQString &arg );
    void setRawArg( int num, const TQByteArray &arg );

    TQNetworkProtocol::Operation operation() const;
    TQNetworkProtocol::State state() const;
    TQString arg( int num ) const;
    TQByteArray rawArg( int num ) const;
    TQString protocolDetail() const;
    int errorCode() const;

    void free();

private slots:
    void deleteMe();

private:
    TQByteArray &raw( int num ) const;
    TQNetworkOperationPrivate *d;

private:	// Disabled copy constructor and operator=
#if defined(Q_DISABLE_COPY)
    TQNetworkOperation( const TQNetworkOperation & );
    TQNetworkOperation &operator=( const TQNetworkOperation & );
#endif
};

#endif // QT_NO_NETWORKPROTOCOL

#endif // TQNETWORKPROTOCOL_H