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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
|
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the Qt3Support module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "q3networkprotocol.h"
#ifndef QT_NO_NETWORKPROTOCOL
#include "q3localfs.h"
#include "q3urloperator.h"
#include "qtimer.h"
#include "qmap.h"
#include "q3ptrqueue.h"
#include "q3valuelist.h"
#include "qurlinfo.h"
#include <private/qobject_p.h>
QT_BEGIN_NAMESPACE
//#define Q3NETWORKPROTOCOL_DEBUG
#define NETWORK_OP_DELAY 1000
extern Q_COMPAT_EXPORT Q3NetworkProtocolDict *q3networkProtocolRegister;
Q3NetworkProtocolDict *q3networkProtocolRegister = 0;
class Q3NetworkProtocolPrivate
{
public:
Q3NetworkProtocolPrivate( Q3NetworkProtocol *p )
{
url = 0;
opInProgress = 0;
opStartTimer = new QTimer( p );
removeTimer = new QTimer( p );
operationQueue.setAutoDelete( false );
autoDelete = false;
removeInterval = 10000;
oldOps.setAutoDelete( false );
}
~Q3NetworkProtocolPrivate()
{
removeTimer->stop();
if ( opInProgress ) {
if ( opInProgress == operationQueue.head() )
operationQueue.dequeue();
opInProgress->free();
}
while ( operationQueue.head() ) {
operationQueue.head()->free();
operationQueue.dequeue();
}
while ( oldOps.first() ) {
oldOps.first()->free();
oldOps.removeFirst();
}
delete opStartTimer;
}
Q3UrlOperator *url;
Q3PtrQueue< Q3NetworkOperation > operationQueue;
Q3NetworkOperation *opInProgress;
QTimer *opStartTimer, *removeTimer;
int removeInterval;
bool autoDelete;
Q3PtrList< Q3NetworkOperation > oldOps;
};
/*!
\class Q3NetworkProtocol
\brief The Q3NetworkProtocol class provides a common API for network protocols.
\compat
This is a base class which should be used for network protocols
implementations that can then be used in Qt (e.g. in the file
dialog) together with the Q3UrlOperator.
The easiest way to implement a new network protocol is to
reimplement the operation*() methods, e.g. operationGet(), etc.
Only the supported operations should be reimplemented. To specify
which operations are supported, also reimplement
supportedOperations() and return an int that is OR'd together
using the supported operations from the \l
Q3NetworkProtocol::Operation enum.
When you implement a network protocol this way, it is important to
emit the correct signals. Also, always emit the finished() signal
when an operation is done (on success \e and on failure). Qt
relies on correctly emitted finished() signals.
*/
/*!
\fn void Q3NetworkProtocol::newChildren( const Q3ValueList<QUrlInfo> &i, Q3NetworkOperation *op )
This signal is emitted after listChildren() was called and new
children (files) have been read from the list of files. \a i holds
the information about the new children. \a op is the pointer to
the operation object which contains all the information about the
operation, including the state, etc.
When a protocol emits this signal, Q3NetworkProtocol is smart
enough to let the Q3UrlOperator, which is used by the network
protocol, emit its corresponding signal.
When implementing your own network protocol and reading children,
you usually don't read one child at once, but rather a list of
them. That's why this signal takes a list of QUrlInfo objects. If
you prefer to read just one child at a time you can use the
convenience signal newChild(), which takes a single QUrlInfo
object.
*/
/*!
\fn void Q3NetworkProtocol::newChild( const QUrlInfo &i, Q3NetworkOperation *op )
This signal is emitted if a new child (file) has been read.
Q3NetworkProtocol automatically connects it to a slot which creates
a list of QUrlInfo objects (with just one QUrlInfo \a i) and emits
the newChildren() signal with this list. \a op is the pointer to
the operation object which contains all the information about the
operation that has finished, including the state, etc.
This is just a convenience signal useful for implementing your own
network protocol. In all other cases connect to the newChildren()
signal with its list of QUrlInfo objects.
*/
/*!
\fn void Q3NetworkProtocol::finished( Q3NetworkOperation *op )
This signal is emitted when an operation finishes. This signal is
always emitted, for both success and failure. \a op is the pointer
to the operation object which contains all the information about
the operation, including the state, etc. Check the state and error
code of the operation object to determine whether or not the
operation was successful.
When a protocol emits this signal, Q3NetworkProtocol is smart
enough to let the Q3UrlOperator, which is used by the network
protocol, emit its corresponding signal.
*/
/*!
\fn void Q3NetworkProtocol::start( Q3NetworkOperation *op )
Some operations (such as listChildren()) emit this signal when
they start processing the operation. \a op is the pointer to the
operation object which contains all the information about the
operation, including the state, etc.
When a protocol emits this signal, Q3NetworkProtocol is smart
enough to let the Q3UrlOperator, which is used by the network
protocol, emit its corresponding signal.
*/
/*!
\fn void Q3NetworkProtocol::createdDirectory( const QUrlInfo &i, Q3NetworkOperation *op )
This signal is emitted when mkdir() has been successful and the
directory has been created. \a i holds the information about the
new directory. \a op is the pointer to the operation object which
contains all the information about the operation, including the
state, etc. Using op->arg( 0 ), you can get the file name of the
new directory.
When a protocol emits this signal, Q3NetworkProtocol is smart
enough to let the Q3UrlOperator, which is used by the network
protocol, emit its corresponding signal.
*/
/*!
\fn void Q3NetworkProtocol::removed( Q3NetworkOperation *op )
This signal is emitted when remove() has been succesiisful and the
file has been removed. \a op holds the file name of the removed
file in the first argument, accessible with op->arg( 0 ). \a op is
the pointer to the operation object which contains all the
information about the operation, including the state, etc.
When a protocol emits this signal, Q3NetworkProtocol is smart
enough to let the Q3UrlOperator, which is used by the network
protocol, emit its corresponding signal.
*/
/*!
\fn void Q3NetworkProtocol::itemChanged( Q3NetworkOperation *op )
This signal is emitted whenever a file which is a child of this
URL has been changed, e.g. by successfully calling rename(). \a op
holds the original and the new file names in the first and second
arguments, accessible with op->arg( 0 ) and op->arg( 1 )
respectively. \a op is the pointer to the operation object which
contains all the information about the operation, including the
state, etc.
When a protocol emits this signal, Q3NetworkProtocol is smart
enough to let the Q3UrlOperator, which is used by the network
protocol, emit its corresponding signal.
*/
/*!
\fn void Q3NetworkProtocol::data( const QByteArray &data,
Q3NetworkOperation *op )
This signal is emitted when new \a data has been received after
calling get() or put(). \a op holds the name of the file from
which data is retrieved or uploaded in its first argument, and the
(raw) data in its second argument. You can get them with
op->arg( 0 ) and op->rawArg( 1 ). \a op is the pointer to the
operation object, which contains all the information about the
operation, including the state, etc.
When a protocol emits this signal, Q3NetworkProtocol is smart
enough to let the Q3UrlOperator (which is used by the network
protocol) emit its corresponding signal.
*/
/*!
\fn void Q3NetworkProtocol::dataTransferProgress( int bytesDone, int bytesTotal, Q3NetworkOperation *op )
This signal is emitted during the transfer of data (using put() or
get()). \a bytesDone is how many bytes of \a bytesTotal have been
transferred. \a bytesTotal may be -1, which means that the total
number of bytes is not known. \a op is the pointer to the
operation object which contains all the information about the
operation, including the state, etc.
When a protocol emits this signal, Q3NetworkProtocol is smart
enough to let the Q3UrlOperator, which is used by the network
protocol, emit its corresponding signal.
*/
/*!
\fn void Q3NetworkProtocol::connectionStateChanged( int state, const QString &data )
This signal is emitted whenever the state of the connection of the
network protocol is changed. \a state describes the new state,
which is one of, \c ConHostFound, \c ConConnected or \c ConClosed.
\a data is a message text.
*/
/*!
\enum Q3NetworkProtocol::State
This enum contains the state that a Q3NetworkOperation can have.
\value StWaiting The operation is in the Q3NetworkProtocol's queue
waiting to be prcessed.
\value StInProgress The operation is being processed.
\value StDone The operation has been processed successfully.
\value StFailed The operation has been processed but an error occurred.
\value StStopped The operation has been processed but has been
stopped before it finished, and is waiting to be processed.
*/
/*!
\enum Q3NetworkProtocol::Operation
This enum lists the possible operations that a network protocol
can support. supportedOperations() returns an int of these that is
OR'd together. Also, the type() of a Q3NetworkOperation is always
one of these values.
\value OpListChildren List the children of a URL, e.g. of a directory.
\value OpMkDir Create a directory.
\value OpRemove Remove a child (e.g. a file).
\value OpRename Rename a child (e.g. a file).
\value OpGet Get data from a location.
\value OpPut Put data to a location.
\omitvalue OpMkdir
*/
/*!
\enum Q3NetworkProtocol::ConnectionState
When the connection state of a network protocol changes it emits
the signal connectionStateChanged(). The first argument is one of
the following values:
\value ConHostFound Host has been found.
\value ConConnected Connection to the host has been established.
\value ConClosed Connection has been closed.
*/
/*!
\enum Q3NetworkProtocol::Error
When an operation fails (finishes unsuccessfully), the
Q3NetworkOperation of the operation returns an error code which has
one of the following values:
\value NoError No error occurred.
\value ErrValid The URL you are operating on is not valid.
\value ErrUnknownProtocol There is no protocol implementation
available for the protocol of the URL you are operating on (e.g.
if the protocol is http and no http implementation has been
registered).
\value ErrUnsupported The operation is not supported by the
protocol.
\value ErrParse The URL could not be parsed correctly.
\value ErrLoginIncorrect You needed to login but the username
or password is wrong.
\value ErrHostNotFound The specified host (in the URL) couldn't
be found.
\value ErrListChildren An error occurred while listing the
children (files).
\value ErrMkDir An error occurred when creating a directory.
\value ErrRemove An error occurred when removing a child (file).
\value ErrRename An error occurred when renaming a child (file).
\value ErrGet An error occurred while getting (retrieving) data.
\value ErrPut An error occurred while putting (uploading) data.
\value ErrFileNotExisting A file which is needed by the operation
doesn't exist.
\value ErrPermissionDenied Permission for doing the operation has
been denied.
\omitvalue ErrMkdir
\omitvalue ErrListChlidren
You should also use these error codes when implementing custom
network protocols. If this is not possible, you can define your own
error codes by using integer values that don't conflict with any
of these values.
*/
/*!
Constructor of the network protocol base class. Does some
initialization and connecting of signals and slots.
*/
Q3NetworkProtocol::Q3NetworkProtocol()
: QObject()
{
d = new Q3NetworkProtocolPrivate( this );
connect( d->opStartTimer, SIGNAL(timeout()),
this, SLOT(startOps()) );
connect( d->removeTimer, SIGNAL(timeout()),
this, SLOT(removeMe()) );
if ( url() ) {
connect( this, SIGNAL(data(QByteArray,Q3NetworkOperation*)),
url(), SIGNAL(data(QByteArray,Q3NetworkOperation*)) );
connect( this, SIGNAL(finished(Q3NetworkOperation*)),
url(), SIGNAL(finished(Q3NetworkOperation*)) );
connect( this, SIGNAL(start(Q3NetworkOperation*)),
url(), SIGNAL(start(Q3NetworkOperation*)) );
connect( this, SIGNAL(newChildren(Q3ValueList<QUrlInfo>,Q3NetworkOperation*)),
url(), SIGNAL(newChildren(Q3ValueList<QUrlInfo>,Q3NetworkOperation*)) );
connect( this, SIGNAL(newChildren(Q3ValueList<QUrlInfo>,Q3NetworkOperation*)),
url(), SLOT(addEntry(Q3ValueList<QUrlInfo>)) );
connect( this, SIGNAL(createdDirectory(QUrlInfo,Q3NetworkOperation*)),
url(), SIGNAL(createdDirectory(QUrlInfo,Q3NetworkOperation*)) );
connect( this, SIGNAL(removed(Q3NetworkOperation*)),
url(), SIGNAL(removed(Q3NetworkOperation*)) );
connect( this, SIGNAL(itemChanged(Q3NetworkOperation*)),
url(), SIGNAL(itemChanged(Q3NetworkOperation*)) );
connect( this, SIGNAL(dataTransferProgress(int,int,Q3NetworkOperation*)),
url(), SIGNAL(dataTransferProgress(int,int,Q3NetworkOperation*)) );
connect( this, SIGNAL(connectionStateChanged(int,QString)),
url(), SIGNAL(connectionStateChanged(int,QString)) );
}
connect( this, SIGNAL(finished(Q3NetworkOperation*)),
this, SLOT(processNextOperation(Q3NetworkOperation*)) );
connect( this, SIGNAL(newChild(QUrlInfo,Q3NetworkOperation*)),
this, SLOT(emitNewChildren(QUrlInfo,Q3NetworkOperation*)) );
}
/*!
Destructor.
*/
Q3NetworkProtocol::~Q3NetworkProtocol()
{
delete d;
}
/*!
Sets the Q3UrlOperator, on which the protocol works, to \a u.
\sa Q3UrlOperator
*/
void Q3NetworkProtocol::setUrl( Q3UrlOperator *u )
{
if ( url() ) {
disconnect( this, SIGNAL(data(QByteArray,Q3NetworkOperation*)),
url(), SIGNAL(data(QByteArray,Q3NetworkOperation*)) );
disconnect( this, SIGNAL(finished(Q3NetworkOperation*)),
url(), SIGNAL(finished(Q3NetworkOperation*)) );
disconnect( this, SIGNAL(start(Q3NetworkOperation*)),
url(), SIGNAL(start(Q3NetworkOperation*)) );
disconnect( this, SIGNAL(newChildren(Q3ValueList<QUrlInfo>,Q3NetworkOperation*)),
url(), SIGNAL(newChildren(Q3ValueList<QUrlInfo>,Q3NetworkOperation*)) );
disconnect( this, SIGNAL(newChildren(Q3ValueList<QUrlInfo>,Q3NetworkOperation*)),
url(), SLOT(addEntry(Q3ValueList<QUrlInfo>)) );
disconnect( this, SIGNAL(createdDirectory(QUrlInfo,Q3NetworkOperation*)),
url(), SIGNAL(createdDirectory(QUrlInfo,Q3NetworkOperation*)) );
disconnect( this, SIGNAL(removed(Q3NetworkOperation*)),
url(), SIGNAL(removed(Q3NetworkOperation*)) );
disconnect( this, SIGNAL(itemChanged(Q3NetworkOperation*)),
url(), SIGNAL(itemChanged(Q3NetworkOperation*)) );
disconnect( this, SIGNAL(dataTransferProgress(int,int,Q3NetworkOperation*)),
url(), SIGNAL(dataTransferProgress(int,int,Q3NetworkOperation*)) );
disconnect( this, SIGNAL(connectionStateChanged(int,QString)),
url(), SIGNAL(connectionStateChanged(int,QString)) );
}
// ### if autoDelete is true, we should delete the Q3UrlOperator (something
// like below; but that is not possible since it would delete this, too).
//if ( d->autoDelete && (d->url!=u) ) {
// delete d->url; // destructor deletes the network protocol
//}
d->url = u;
if ( url() ) {
connect( this, SIGNAL(data(QByteArray,Q3NetworkOperation*)),
url(), SIGNAL(data(QByteArray,Q3NetworkOperation*)) );
connect( this, SIGNAL(finished(Q3NetworkOperation*)),
url(), SIGNAL(finished(Q3NetworkOperation*)) );
connect( this, SIGNAL(start(Q3NetworkOperation*)),
url(), SIGNAL(start(Q3NetworkOperation*)) );
connect( this, SIGNAL(newChildren(Q3ValueList<QUrlInfo>,Q3NetworkOperation*)),
url(), SIGNAL(newChildren(Q3ValueList<QUrlInfo>,Q3NetworkOperation*)) );
connect( this, SIGNAL(newChildren(Q3ValueList<QUrlInfo>,Q3NetworkOperation*)),
url(), SLOT(addEntry(Q3ValueList<QUrlInfo>)) );
connect( this, SIGNAL(createdDirectory(QUrlInfo,Q3NetworkOperation*)),
url(), SIGNAL(createdDirectory(QUrlInfo,Q3NetworkOperation*)) );
connect( this, SIGNAL(removed(Q3NetworkOperation*)),
url(), SIGNAL(removed(Q3NetworkOperation*)) );
connect( this, SIGNAL(itemChanged(Q3NetworkOperation*)),
url(), SIGNAL(itemChanged(Q3NetworkOperation*)) );
connect( this, SIGNAL(dataTransferProgress(int,int,Q3NetworkOperation*)),
url(), SIGNAL(dataTransferProgress(int,int,Q3NetworkOperation*)) );
connect( this, SIGNAL(connectionStateChanged(int,QString)),
url(), SIGNAL(connectionStateChanged(int,QString)) );
}
if ( !d->opInProgress && !d->operationQueue.isEmpty() )
d->opStartTimer->start( 0, true );
}
/*!
For processing operations the network protocol base class calls
this method quite often. This should be reimplemented by new
network protocols. It should return true if the connection is OK
(open); otherwise it should return false. If the connection is not
open the protocol should open it.
If the connection can't be opened (e.g. because you already tried
but the host couldn't be found), set the state of \a op to
Q3NetworkProtocol::StFailed and emit the finished() signal with
this Q3NetworkOperation as argument.
\a op is the operation that needs an open connection.
*/
bool Q3NetworkProtocol::checkConnection( Q3NetworkOperation * )
{
return true;
}
/*!
Returns an int that is OR'd together using the enum values of
\l{Q3NetworkProtocol::Operation}, which describes which operations
are supported by the network protocol. Should be reimplemented by
new network protocols.
*/
int Q3NetworkProtocol::supportedOperations() const
{
return 0;
}
/*!
Adds the operation \a op to the operation queue. The operation
will be processed as soon as possible. This method returns
immediately.
*/
void Q3NetworkProtocol::addOperation( Q3NetworkOperation *op )
{
#ifdef Q3NETWORKPROTOCOL_DEBUG
qDebug( "Q3NetworkOperation: addOperation: %p %d", op, op->operation() );
#endif
d->operationQueue.enqueue( op );
if ( !d->opInProgress )
d->opStartTimer->start( 0, true );
}
/*!
Static method to register a network protocol for Qt. For example,
if you have an implementation of NNTP (called Nntp) which is
derived from Q3NetworkProtocol, call:
\snippet doc/src/snippets/code/src_qt3support_network_q3networkprotocol.cpp 0
after which your implementation is registered for future nntp
operations.
The name of the protocol is given in \a protocol and a pointer to
the protocol factory is given in \a protocolFactory.
*/
void Q3NetworkProtocol::registerNetworkProtocol( const QString &protocol,
Q3NetworkProtocolFactoryBase *protocolFactory )
{
if ( !q3networkProtocolRegister ) {
q3networkProtocolRegister = new Q3NetworkProtocolDict;
Q3NetworkProtocol::registerNetworkProtocol( QLatin1String("file"), new Q3NetworkProtocolFactory< Q3LocalFs > );
}
q3networkProtocolRegister->insert( protocol, protocolFactory );
}
/*!
Static method to get a new instance of the network protocol \a
protocol. For example, if you need to do some FTP operations, do
the following:
\snippet doc/src/snippets/code/src_qt3support_network_q3networkprotocol.cpp 1
This returns a pointer to a new instance of an ftp implementation
or null if no protocol for ftp was registered. The ownership of
the pointer is transferred to you, so you must delete it if you
don't need it anymore.
Normally you should not work directly with network protocols, so
you will not need to call this method yourself. Instead, use
Q3UrlOperator, which makes working with network protocols much more
convenient.
\sa Q3UrlOperator
*/
Q3NetworkProtocol *Q3NetworkProtocol::getNetworkProtocol( const QString &protocol )
{
if ( !q3networkProtocolRegister ) {
q3networkProtocolRegister = new Q3NetworkProtocolDict;
Q3NetworkProtocol::registerNetworkProtocol( QLatin1String("file"), new Q3NetworkProtocolFactory< Q3LocalFs > );
}
if ( protocol.isNull() )
return 0;
Q3NetworkProtocolFactoryBase *factory = q3networkProtocolRegister->find( protocol );
if ( factory )
return factory->createObject();
return 0;
}
/*!
Returns true if the only protocol registered is for working on the
local filesystem; returns false if other network protocols are
also registered.
*/
bool Q3NetworkProtocol::hasOnlyLocalFileSystem()
{
if ( !q3networkProtocolRegister )
return false;
Q3DictIterator< Q3NetworkProtocolFactoryBase > it( *q3networkProtocolRegister );
for ( ; it.current(); ++it )
if ( it.currentKey() != QLatin1String("file") )
return false;
return true;
}
/*!
\internal
Starts processing network operations.
*/
void Q3NetworkProtocol::startOps()
{
#ifdef Q3NETWORKPROTOCOL_DEBUG
qDebug( "Q3NetworkOperation: start processing operations" );
#endif
processNextOperation( 0 );
}
/*!
\internal
Processes the operation \a op. It calls the
corresponding operation[something]( Q3NetworkOperation * )
methods.
*/
void Q3NetworkProtocol::processOperation( Q3NetworkOperation *op )
{
if ( !op )
return;
switch ( op->operation() ) {
case OpListChildren:
operationListChildren( op );
break;
case OpMkDir:
operationMkDir( op );
break;
case OpRemove:
operationRemove( op );
break;
case OpRename:
operationRename( op );
break;
case OpGet:
operationGet( op );
break;
case OpPut:
operationPut( op );
break;
}
}
/*!
When implementing a new network protocol, this method should be
reimplemented if the protocol supports listing children (files);
this method should then process this Q3NetworkOperation.
\a op is the pointer to the operation object which contains all
the information on the operation that has finished, including the
state, etc.
*/
void Q3NetworkProtocol::operationListChildren( Q3NetworkOperation * )
{
}
/*!
When implementing a new network protocol, this method should be
reimplemented if the protocol supports making directories; this
method should then process this Q3NetworkOperation.
\a op is the pointer to the operation object which contains all
the information on the operation that has finished, including the
state, etc.
*/
void Q3NetworkProtocol::operationMkDir( Q3NetworkOperation * )
{
}
/*!
When implementing a new network protocol, this method should be
reimplemented if the protocol supports removing children (files);
this method should then process this Q3NetworkOperation.
\a op is the pointer to the operation object which contains all
the information on the operation that has finished, including the
state, etc.
*/
void Q3NetworkProtocol::operationRemove( Q3NetworkOperation * )
{
}
/*!
When implementing a new network protocol, this method should be
reimplemented if the protocol supports renaming children (files);
this method should then process this Q3NetworkOperation.
\a op is the pointer to the operation object which contains all
the information on the operation that has finished, including the
state, etc.
*/
void Q3NetworkProtocol::operationRename( Q3NetworkOperation * )
{
}
/*!
When implementing a new network protocol, this method should be
reimplemented if the protocol supports getting data; this method
should then process the Q3NetworkOperation.
\a op is the pointer to the operation object which contains all
the information on the operation that has finished, including the
state, etc.
*/
void Q3NetworkProtocol::operationGet( Q3NetworkOperation * )
{
}
/*!
When implementing a new network protocol, this method should be
reimplemented if the protocol supports putting (uploading) data;
this method should then process the Q3NetworkOperation.
\a op is the pointer to the operation object which contains all
the information on the operation that has finished, including the
state, etc.
*/
void Q3NetworkProtocol::operationPut( Q3NetworkOperation * )
{
}
/*! \internal
*/
void Q3NetworkProtocol::operationPutChunk( Q3NetworkOperation * )
{
}
/*!
\internal
Handles operations. Deletes the previous operation object and
tries to process the next operation. It also checks the connection state
and only processes the next operation, if the connection of the protocol
is open. Otherwise it waits until the protocol opens the connection.
*/
void Q3NetworkProtocol::processNextOperation( Q3NetworkOperation *old )
{
#ifdef Q3NETWORKPROTOCOL_DEBUG
qDebug( "Q3NetworkOperation: process next operation, old: %p", old );
#endif
d->removeTimer->stop();
if ( old )
d->oldOps.append( old );
if ( d->opInProgress && d->opInProgress!=old )
d->oldOps.append( d->opInProgress );
if ( d->operationQueue.isEmpty() ) {
d->opInProgress = 0;
if ( d->autoDelete )
d->removeTimer->start( d->removeInterval, true );
return;
}
Q3NetworkOperation *op = d->operationQueue.head();
d->opInProgress = op;
if ( !checkConnection( op ) ) {
if ( op->state() != Q3NetworkProtocol::StFailed ) {
d->opStartTimer->start( 0, true );
} else {
d->operationQueue.dequeue();
clearOperationQueue();
emit finished( op );
}
return;
}
d->opInProgress = op;
d->operationQueue.dequeue();
processOperation( op );
}
/*!
Returns the Q3UrlOperator on which the protocol works.
*/
Q3UrlOperator *Q3NetworkProtocol::url() const
{
return d->url;
}
/*!
Returns the operation, which is being processed, or 0 of no
operation is being processed at the moment.
*/
Q3NetworkOperation *Q3NetworkProtocol::operationInProgress() const
{
return d->opInProgress;
}
/*!
Clears the operation queue.
*/
void Q3NetworkProtocol::clearOperationQueue()
{
d->operationQueue.dequeue();
d->operationQueue.setAutoDelete( true );
d->operationQueue.clear();
}
/*!
Stops the current operation that is being processed and clears all
waiting operations.
*/
void Q3NetworkProtocol::stop()
{
Q3NetworkOperation *op = d->opInProgress;
clearOperationQueue();
if ( op ) {
op->setState( StStopped );
op->setProtocolDetail( tr( "Operation stopped by the user" ) );
emit finished( op );
setUrl( 0 );
op->free();
}
}
/*!
Because it's sometimes hard to take care of removing network
protocol instances, Q3NetworkProtocol provides an auto-delete
mechanism. If you set \a b to true, the network protocol instance
is removed after it has been inactive for \a i milliseconds (i.e.
\a i milliseconds after the last operation has been processed).
If you set \a b to false the auto-delete mechanism is switched
off.
If you switch on auto-delete, the Q3NetworkProtocol also deletes
its Q3UrlOperator.
*/
void Q3NetworkProtocol::setAutoDelete( bool b, int i )
{
d->autoDelete = b;
d->removeInterval = i;
}
/*!
Returns true if auto-deleting is enabled; otherwise returns false.
\sa Q3NetworkProtocol::setAutoDelete()
*/
bool Q3NetworkProtocol::autoDelete() const
{
return d->autoDelete;
}
/*!
\internal
*/
void Q3NetworkProtocol::removeMe()
{
if ( d->autoDelete ) {
#ifdef Q3NETWORKPROTOCOL_DEBUG
qDebug( "Q3NetworkOperation: autodelete of Q3NetworkProtocol %p", this );
#endif
delete d->url; // destructor deletes the network protocol
}
}
void Q3NetworkProtocol::emitNewChildren( const QUrlInfo &i, Q3NetworkOperation *op )
{
Q3ValueList<QUrlInfo> lst;
lst << i;
emit newChildren( lst, op );
}
class Q3NetworkOperationPrivate
{
public:
Q3NetworkProtocol::Operation operation;
Q3NetworkProtocol::State state;
QMap<int, QString> args;
QMap<int, QByteArray> rawArgs;
QString protocolDetail;
int errorCode;
QTimer *deleteTimer;
};
/*!
\class Q3NetworkOperation
\brief The Q3NetworkOperation class provides common operations for network protocols.
\compat
An object is created to describe the operation and the current
state for each operation that a network protocol should process.
\sa Q3NetworkProtocol
*/
/*!
Constructs a network operation object. \a operation is the type of
the operation, and \a arg0, \a arg1 and \a arg2 are the first
three arguments of the operation. The state is initialized to
Q3NetworkProtocol::StWaiting.
\sa Q3NetworkProtocol::Operation Q3NetworkProtocol::State
*/
Q3NetworkOperation::Q3NetworkOperation( Q3NetworkProtocol::Operation operation,
const QString &arg0, const QString &arg1,
const QString &arg2 )
{
d = new Q3NetworkOperationPrivate;
d->deleteTimer = new QTimer( this );
connect( d->deleteTimer, SIGNAL(timeout()),
this, SLOT(deleteMe()) );
d->operation = operation;
d->state = Q3NetworkProtocol::StWaiting;
d->args[ 0 ] = arg0;
d->args[ 1 ] = arg1;
d->args[ 2 ] = arg2;
d->rawArgs[ 0 ] = QByteArray( 0 );
d->rawArgs[ 1 ] = QByteArray( 0 );
d->rawArgs[ 2 ] = QByteArray( 0 );
d->protocolDetail.clear();
d->errorCode = (int)Q3NetworkProtocol::NoError;
}
/*!
Constructs a network operation object. \a operation is the type of
the operation, and \a arg0, \a arg1 and \a arg2 are the first
three raw data arguments of the operation. The state is
initialized to Q3NetworkProtocol::StWaiting.
\sa Q3NetworkProtocol::Operation Q3NetworkProtocol::State
*/
Q3NetworkOperation::Q3NetworkOperation( Q3NetworkProtocol::Operation operation,
const QByteArray &arg0, const QByteArray &arg1,
const QByteArray &arg2 )
{
d = new Q3NetworkOperationPrivate;
d->deleteTimer = new QTimer( this );
connect( d->deleteTimer, SIGNAL(timeout()),
this, SLOT(deleteMe()) );
d->operation = operation;
d->state = Q3NetworkProtocol::StWaiting;
d->args[ 0 ].clear();
d->args[ 1 ].clear();
d->args[ 2 ].clear();
d->rawArgs[ 0 ] = arg0;
d->rawArgs[ 1 ] = arg1;
d->rawArgs[ 2 ] = arg2;
d->protocolDetail.clear();
d->errorCode = (int)Q3NetworkProtocol::NoError;
}
/*!
Destructor.
*/
Q3NetworkOperation::~Q3NetworkOperation()
{
qDeleteInEventHandler(d->deleteTimer);
delete d;
}
/*!
Sets the \a state of the operation object. This should be done by
the network protocol during processing; at the end it should be
set to Q3NetworkProtocol::StDone or Q3NetworkProtocol::StFailed,
depending on success or failure.
\sa Q3NetworkProtocol::State
*/
void Q3NetworkOperation::setState( Q3NetworkProtocol::State state )
{
if ( d->deleteTimer->isActive() ) {
d->deleteTimer->stop();
d->deleteTimer->start( NETWORK_OP_DELAY );
}
d->state = state;
}
/*!
If the operation failed, the error message can be specified as \a
detail.
*/
void Q3NetworkOperation::setProtocolDetail( const QString &detail )
{
if ( d->deleteTimer->isActive() ) {
d->deleteTimer->stop();
d->deleteTimer->start( NETWORK_OP_DELAY );
}
d->protocolDetail = detail;
}
/*!
Sets the error code to \a ec.
If the operation failed, the protocol should set an error code to
describe the error in more detail. If possible, one of the error
codes defined in Q3NetworkProtocol should be used.
\sa setProtocolDetail() Q3NetworkProtocol::Error
*/
void Q3NetworkOperation::setErrorCode( int ec )
{
if ( d->deleteTimer->isActive() ) {
d->deleteTimer->stop();
d->deleteTimer->start( NETWORK_OP_DELAY );
}
d->errorCode = ec;
}
/*!
Sets the network operation's \a{num}-th argument to \a arg.
*/
void Q3NetworkOperation::setArg( int num, const QString &arg )
{
if ( d->deleteTimer->isActive() ) {
d->deleteTimer->stop();
d->deleteTimer->start( NETWORK_OP_DELAY );
}
d->args[ num ] = arg;
}
/*!
Sets the network operation's \a{num}-th raw data argument to \a arg.
*/
void Q3NetworkOperation::setRawArg( int num, const QByteArray &arg )
{
if ( d->deleteTimer->isActive() ) {
d->deleteTimer->stop();
d->deleteTimer->start( NETWORK_OP_DELAY );
}
d->rawArgs[ num ] = arg;
}
/*!
Returns the type of the operation.
*/
Q3NetworkProtocol::Operation Q3NetworkOperation::operation() const
{
if ( d->deleteTimer->isActive() ) {
d->deleteTimer->stop();
d->deleteTimer->start( NETWORK_OP_DELAY );
}
return d->operation;
}
/*!
Returns the state of the operation. You can determine whether an
operation is still waiting to be processed, is being processed,
has been processed successfully, or failed.
*/
Q3NetworkProtocol::State Q3NetworkOperation::state() const
{
if ( d->deleteTimer->isActive() ) {
d->deleteTimer->stop();
d->deleteTimer->start( NETWORK_OP_DELAY );
}
return d->state;
}
/*!
Returns the operation's \a{num}-th argument. If this argument was
not already set, an empty string is returned.
*/
QString Q3NetworkOperation::arg( int num ) const
{
if ( d->deleteTimer->isActive() ) {
d->deleteTimer->stop();
d->deleteTimer->start( NETWORK_OP_DELAY );
}
return d->args[ num ];
}
/*!
Returns the operation's \a{num}-th raw data argument. If this
argument was not already set, an empty bytearray is returned.
*/
QByteArray Q3NetworkOperation::rawArg( int num ) const
{
if ( d->deleteTimer->isActive() ) {
d->deleteTimer->stop();
d->deleteTimer->start( NETWORK_OP_DELAY );
}
return d->rawArgs[ num ];
}
/*!
Returns a detailed error message for the last error. This must
have been set using setProtocolDetail().
*/
QString Q3NetworkOperation::protocolDetail() const
{
if ( d->deleteTimer->isActive() ) {
d->deleteTimer->stop();
d->deleteTimer->start( NETWORK_OP_DELAY );
}
return d->protocolDetail;
}
/*!
Returns the error code for the last error that occurred.
*/
int Q3NetworkOperation::errorCode() const
{
if ( d->deleteTimer->isActive() ) {
d->deleteTimer->stop();
d->deleteTimer->start( NETWORK_OP_DELAY );
}
return d->errorCode;
}
/*!
\internal
*/
QByteArray& Q3NetworkOperation::raw( int num ) const
{
if ( d->deleteTimer->isActive() ) {
d->deleteTimer->stop();
d->deleteTimer->start( NETWORK_OP_DELAY );
}
return d->rawArgs[ num ];
}
/*!
Sets this object to delete itself when it hasn't been used for one
second.
Because Q3NetworkOperation pointers are passed around a lot the
Q3NetworkProtocol generally does not have enough knowledge to
delete these at the correct time. If a Q3NetworkProtocol doesn't
need an operation any more it will call this function instead.
Note: you should never need to call the method yourself.
*/
void Q3NetworkOperation::free()
{
d->deleteTimer->start( NETWORK_OP_DELAY );
}
/*!
\internal
Internal slot for auto-deletion.
*/
void Q3NetworkOperation::deleteMe()
{
delete this;
}
QT_END_NAMESPACE
#include "moc_q3networkprotocol.cpp"
#endif
|