-
Notifications
You must be signed in to change notification settings - Fork 2
/
Mu.HttpClient--.pas
1348 lines (1176 loc) · 45.5 KB
/
Mu.HttpClient--.pas
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
unit Mu.HttpClient;
interface
{$IFDEF MSWINDOWS}
{$HPPEMIT '#pragma comment(lib, "winhttp")'}
{$HPPEMIT '#pragma comment(lib, "crypt32")'}
{$ENDIF}
{$SCOPEDENUMS ON}
uses
windows,
System.Sysutils, System.Classes, System.Generics.Collections,
System.Net.URLClient, System.Net.HttpClient, System.Net.Mime,
Mu.HttpClientHelper
;
type
// ------------------------------------------------------------------------------------------------------------------ //
// ------------------------------------------------------------------------------------------------------------------ //
/// <summary> Request completion Event signature</summary>
/// <param name="Sender"> HTTPClientComponent that invoked the Event</param>
/// <param name="AResponse">Response generated by the request</param>
TRequestCompletedEvent = procedure(const Sender: TObject;
const AResponse: IHTTPResponse) of object;
/// <summary> Request error Event signature</summary>
/// <param name="Sender"> HTTPClientComponent that invoked the Event</param>
/// <param name="AError">Error generated by the request</param>
TRequestErrorEvent = procedure(const Sender: TObject; const AError: string)
of object;
// ------------------------------------------------------------------------------------------------------------------ //
// ------------------------------------------------------------------------------------------------------------------ //
/// <summary>Component to Manage an HTTPClient</summary>
TMuHTTPClient = class(TComponent)
private
FHttpClient: THttpClient;
FOnRequestCompleted: TRequestCompletedEvent;
FOnRequestError: TRequestErrorEvent;
FOnReceiveData: TReceiveDataEvent;
FURI: TURI;
procedure DoOnRequestCompleted(const Sender: TObject;
const AResponse: IHTTPResponse);
procedure DoOnRequestError(const Sender: TObject; const AError: string);
procedure DoOnReceiveData(const Sender: TObject; AContentLength: Int64;
AReadCount: Int64; var Abort: Boolean);
function GetMaxRedirects: Integer;
procedure SetMaxRedirects(const Value: Integer);
procedure SetAuthEvent(const Value
: TCredentialsStorage.TCredentialAuthevent);
procedure SetOnNeedClientCertificate(const Value
: TNeedClientCertificateEvent);
procedure SetOnValidateServerCertificate(const Value
: TValidateCertificateEvent);
function GetAuthEvent: TCredentialsStorage.TCredentialAuthevent;
function GetOnNeedClientCertificate: TNeedClientCertificateEvent;
function GetOnValidateServerCertificate: TValidateCertificateEvent;
function GetProxySettings: TProxySettings;
procedure SetProxySettings(const Value: TProxySettings);
function GetAllowCookies: Boolean;
procedure SetAllowCookies(const Value: Boolean);
function GetCookieManager: TCookieManager;
procedure SetCookieManager(const Value: TCookieManager);
function GetHandleRedirects: Boolean;
procedure SetHandleRedirects(const Value: Boolean);
function GetCustomHeaderValue(const AName: string): string;
procedure SetCustomHeaderValue(const AName, Value: string);
function GetAccept: string;
function GetAcceptCharSet: string;
function GetAcceptEncoding: string;
function GetAcceptLanguage: string;
function GetContentType: string;
procedure SetAccept(const Value: string);
procedure SetAcceptCharSet(const Value: string);
procedure SetAcceptEncoding(const Value: string);
procedure SetAcceptLanguage(const Value: string);
procedure SetContentType(const Value: string);
function GetCredentialsStorage: TCredentialsStorage;
procedure SetCredentialsStorage(const Value: TCredentialsStorage);
function GetUserAgent: string;
procedure SetUserAgent(const Value: string);
function getReferer(): String;
procedure setReferer(aValue: string);
function GetLastURL(): String;
function GetDirectTimes(): Integer;
public
/// <summary> Initializes the HTTPComponent </summary>
constructor Create(AOwner: TComponent); override;
destructor Destroy; override;
// ------------------------------------------- //
// Standard HTTP Methods
// ------------------------------------------- //
/// <summary>Send 'DELETE' command to url</summary>
function Delete(const AURL: string; const AResponseContent: TStream = nil;
const AHeaders: TNetHeaders = nil): IHTTPResponse;
/// <summary>Send 'OPTIONS' command to url</summary>
function Options(const AURL: string; const AResponseContent: TStream = nil;
const AHeaders: TNetHeaders = nil): IHTTPResponse;
/// <summary>Send 'GET' command to url</summary>
function Get(const AURL: string; const AResponseContent: TStream = nil;
const AHeaders: TNetHeaders = nil): IHTTPResponse;
/// <summary>Send 'TRACE' command to url</summary>
function Trace(const AURL: string; const AResponseContent: TStream = nil;
const AHeaders: TNetHeaders = nil): IHTTPResponse;
/// <summary>Send 'HEAD' command to url</summary>
function Head(const AURL: string; const AHeaders: TNetHeaders = nil)
: IHTTPResponse;
/// <summary>Send 'GET' command to url adding Range header</summary>
/// <remarks>It's used for resume downloads</remarks>
function GetRange(const AURL: string; AStart: Int64; AnEnd: Int64 = -1;
const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse;
/// <summary>Post a raw file without multipart info</summary>
function Post(const AURL: string; const ASourceFile: string;
const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse; overload;
/// <summary>Post TStrings values adding multipart info</summary>
function Post(const AURL: string; const ASource: TStrings;
const AResponseContent: TStream = nil; const AEncoding: TEncoding = nil;
const AHeaders: TNetHeaders = nil): IHTTPResponse; overload;
/// <summary>Post a stream without multipart info</summary>
function Post(const AURL: string; const ASource: TStream;
const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse; overload;
/// <summary>Post a multipart form data object</summary>
function Post(const AURL: string; const ASource: TMultipartFormData;
const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse; overload;
/// <summary>Send 'PUT' command to url</summary>
function Put(const AURL: string; const ASource: TStream = nil;
const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse;
// Non standard command procedures ...
/// <summary>Send 'MERGE' command to url</summary>
function Merge(const AURL: string; const ASource: TStream;
const AHeaders: TNetHeaders = nil): IHTTPResponse;
/// <summary>Send a special 'MERGE' command to url. Command based on a 'PUT' + 'x-method-override' </summary>
function MergeAlternative(const AURL: string; const ASource: TStream;
const AHeaders: TNetHeaders = nil): IHTTPResponse;
/// <summary>Send 'PATCH' command to url</summary>
function Patch(const AURL: string; const ASource: TStream = nil;
const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse; overload;
/// <summary>Send a special 'PATCH' command to url. Command based on a 'PUT' + 'x-method-override' </summary>
function PatchAlternative(const AURL: string; const ASource: TStream = nil;
const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse; overload;
/// <summary>You have to use this function to Execute a given Request</summary>
/// <param name="ARequest">The request that is going to be Executed</param>
/// <param name="AContentStream">The stream to store the response data. If provided the user is responsible
/// of releasing it. If not provided will be created internally and released when not needed.</param>
/// <returns>The platform dependant response object associated to the given request. It's an Interfaced object and
/// It's released automatically.</returns>
function Execute(const ARequest: IHTTPRequest;
const AContentStream: TStream = nil): IHTTPResponse; overload;
/// <summary>You have to use this function to Execute a Request</summary>
/// <remarks></remarks>
/// <param name="ARequestMethod">The request method that is going to be Executed</param>
/// <param name="AURI">The URI that contains the information for the request that is going to be Executed</param>
/// <param name="ASourceStream">The stream to provide the request data.</param>
/// <param name="AContentStream">The stream to store the response data. If provided the user is responsible
/// of releasing it. If not provided will be created internally and released when not needed.</param>
/// <param name="AHeaders">Additions headers to be passed to the request that is going to be Executed</param>
/// <returns>The platform dependant response object associated to the given request. It's an Interface and It's
/// released automatically.</returns>
function Execute(const ARequestMethod: string; const AURI: TURI;
const ASourceStream: TStream = nil; const AContentStream: TStream = nil;
const AHeaders: TNetHeaders = nil): IHTTPResponse; overload;
/// <summary>You have to use this function to Execute a given Request</summary>
/// <remarks></remarks>
/// <param name="ARequestMethod">The request method that is going to be Executed</param>
/// <param name="AURIStr">The URI string that contains the information for the request that is going to be Executed</param>
/// <param name="ASourceStream">The stream to provide the request data.</param>
/// <param name="AContentStream">The stream to store the response data. If provided the user is responsible
/// of releasing it. If not provided will be created internally and released when not needed.</param>
/// <param name="AHeaders">Additions headers to be passed to the request that is going to be Executed</param>
/// <returns>The platform dependant response object associated to the given request. It's an Interface and It's
/// released automatically.</returns>
function Execute(const ARequestMethod: string; const AURIStr: string;
const ASourceStream: TStream = nil; const AContentStream: TStream = nil;
const AHeaders: TNetHeaders = nil): IHTTPResponse; overload; inline;
/// <summary> Cookie manager object to be used by the client.</summary>
property CookieManager: TCookieManager read GetCookieManager
write SetCookieManager;
/// <summary> CustomHeaders to be used by the client.</summary>
property CustomHeaders[const AName: string]: string
read GetCustomHeaderValue write SetCustomHeaderValue;
/// <summary> Credentials Storage to be used by the client</summary>
property CredentialsStorage: TCredentialsStorage read GetCredentialsStorage
write SetCredentialsStorage;
/// <summary> Proxy Settings to be used by the client.</summary>
property ProxySettings: TProxySettings read GetProxySettings
write SetProxySettings;
property URI: TURI read FURI write FURI;
Property LastURL: string read GetLastURL;
property DirectTimes: Integer read GetDirectTimes;
published
/// <summary> Cookies policy to be used by the client.</summary>
/// <remarks>If false the cookies from server will not be accepted,
/// but the cookies in the cookie manager will be sent.</remarks>
property AllowCookies: Boolean read GetAllowCookies write SetAllowCookies;
/// <summary> Redirection policy to be used by the client.</summary>
property HandleRedirects: Boolean read GetHandleRedirects
write SetHandleRedirects;
/// <summary> Maximum number of redirects</summary>
property MaxRedirects: Integer read GetMaxRedirects write SetMaxRedirects
default 5;
/// <summary>Property to manage the 'Accept' header</summary>
property Accept: string read GetAccept write SetAccept;
/// <summary>Property to manage the 'Accept-CharSet' header</summary>
property AcceptCharSet: string read GetAcceptCharSet write SetAcceptCharSet;
/// <summary>Property to manage the 'Accept-Encoding' header</summary>
property AcceptEncoding: string read GetAcceptEncoding
write SetAcceptEncoding;
/// <summary>Property to manage the 'Accept-Language' header</summary>
property AcceptLanguage: string read GetAcceptLanguage
write SetAcceptLanguage;
/// <summary>Property to manage the 'Content-Type' header</summary>
property ContentType: string read GetContentType write SetContentType;
/// <summary> Property to set the UserAgent sent with the request </summary>
property UserAgent: string read GetUserAgent write SetUserAgent;
property Referer: string read getReferer write setReferer;
/// <summary> Event fired when a ClientCertificate is needed</summary>
property OnNeedClientCertificate: TNeedClientCertificateEvent
read GetOnNeedClientCertificate write SetOnNeedClientCertificate;
/// <summary> Event fired when checking the validity of a Server Certificate</summary>
property OnValidateServerCertificate: TValidateCertificateEvent
read GetOnValidateServerCertificate write SetOnValidateServerCertificate;
/// <summary> UserName needed to be authenticated to the proxy</summary>
property OnAuthEvent: TCredentialsStorage.TCredentialAuthevent
read GetAuthEvent write SetAuthEvent;
/// <summary> Event fired when a request finishes</summary>
property OnRequestCompleted: TRequestCompletedEvent read FOnRequestCompleted
write FOnRequestCompleted;
/// <summary> Event fired when a request has an error</summary>
property OnRequestError: TRequestErrorEvent read FOnRequestError
write FOnRequestError;
/// <summary>Property to manage the ReceiveData Event</summary>
property OnReceiveData: TReceiveDataEvent read FOnReceiveData
write FOnReceiveData;
end;
// ------------------------------------------------------------------------------------------------------------------ //
// ------------------------------------------------------------------------------------------------------------------ //
/// <summary>Component to handle HTTP Requests</summary>
TMuHTTPRequest = class(TComponent)
private
FClient: TMuHTTPClient;
FContentStream: TStream;
FSourceStream: TStream;
FURL: string;
FMethodString: string;
FHttpRequest: IHTTPRequest;
FHttpResponse: IHTTPResponse;
FOnNeedClientCertificate: TNeedClientCertificateEvent;
FOnValidateServerCertificate: TValidateCertificateEvent;
FOnRequestCompleted: TRequestCompletedEvent;
FOnRequestError: TRequestErrorEvent;
FOnReceiveData: TReceiveDataEvent;
FCustomHeaders: TNetHeaders;
procedure DoOnRequestCompleted(const Sender: TObject;
const AResponse: IHTTPResponse);
procedure DoOnRequestError(const Sender: TObject; const AError: string);
procedure DoOnReceiveData(const Sender: TObject; AContentLength: Int64;
AReadCount: Int64; var Abort: Boolean);
function GetMethodString: string;
procedure SetMethodString(const Value: string);
function GetURL: string;
procedure SetURL(const Value: string);
function GetClient: TMuHTTPClient;
procedure SetClient(const Value: TMuHTTPClient);
procedure SetOnNeedClientCertificate(const Value
: TNeedClientCertificateEvent);
procedure SetOnValidateServerCertificate(const Value
: TValidateCertificateEvent);
function GetOnReceiveData: TReceiveDataEvent;
procedure SetOnReceiveData(const Value: TReceiveDataEvent);
function GetRequest(const AMethod: string; const AURL: string;
const ASourceStream: TStream): IHTTPRequest;
function GetAccept: string;
function GetAcceptCharSet: string;
function GetAcceptEncoding: string;
function GetAcceptLanguage: string;
procedure SetAccept(const Value: string);
procedure SetAcceptCharSet(const Value: string);
procedure SetAcceptEncoding(const Value: string);
procedure SetAcceptLanguage(const Value: string);
function GetCustomHeaderValue(const AName: string): string;
procedure SetCustomHeaderValue(const AName, Value: string);
protected
/// <summary> Notification method to process component adding or removal from a form/datamodule</summary>
procedure Notification(AComponent: TComponent;
Operation: TOperation); override;
/// <summary>You have to use this function to Execute the internal Request</summary>
function DoExecute(const ARequest: IHTTPRequest;
const AResponseContent: TStream; const AHeaders: TNetHeaders)
: IHTTPResponse;
public
constructor Create(AOwner: TComponent); override;
// ------------------------------------------- //
// Standard HTTP Methods
// ------------------------------------------- //
/// <summary>Send 'DELETE' command to url</summary>
function Delete(const AURL: string; const AResponseContent: TStream = nil;
const AHeaders: TNetHeaders = nil): IHTTPResponse;
/// <summary>Send 'OPTIONS' command to url</summary>
function Options(const AURL: string; const AResponseContent: TStream = nil;
const AHeaders: TNetHeaders = nil): IHTTPResponse;
/// <summary>Send 'GET' command to url</summary>
function Get(const AURL: string; const AResponseContent: TStream = nil;
const AHeaders: TNetHeaders = nil): IHTTPResponse;
/// <summary>Send 'TRACE' command to url</summary>
function Trace(const AURL: string; const AResponseContent: TStream = nil;
const AHeaders: TNetHeaders = nil): IHTTPResponse;
/// <summary>Send 'HEAD' command to url</summary>
function Head(const AURL: string; const AHeaders: TNetHeaders = nil)
: IHTTPResponse;
/// <summary>Send 'GET' command to url adding Range header</summary>
/// <remarks>It's used for resume downloads</remarks>
function GetRange(const AURL: string; AStart: Int64; AnEnd: Int64 = -1;
const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse;
/// <summary>Post a raw file without multipart info</summary>
function Post(const AURL: string; const ASourceFile: string;
AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse; overload;
/// <summary>Post TStrings values adding multipart info</summary>
function Post(const AURL: string; const ASource: TStrings;
const AResponseContent: TStream = nil; const AEncoding: TEncoding = nil;
const AHeaders: TNetHeaders = nil): IHTTPResponse; overload;
/// <summary>Post a stream without multipart info</summary>
function Post(const AURL: string; const ASource: TStream;
const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse; overload;
/// <summary>Post a multipart form data object</summary>
function Post(const AURL: string; const ASource: TMultipartFormData;
const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse; overload;
/// <summary>Send 'PUT' command to url</summary>
function Put(const AURL: string; const ASource: TStream = nil;
const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse;
// Non standard command procedures ...
/// <summary>Send 'MERGE' command to url</summary>
function Merge(const AURL: string; const ASource: TStream;
const AHeaders: TNetHeaders = nil): IHTTPResponse;
/// <summary>Send 'MERGE' command to url</summary>
function MergeAlternative(const AURL: string; const ASource: TStream;
const AHeaders: TNetHeaders = nil): IHTTPResponse;
/// <summary>Send 'PATCH' command to url</summary>
function Patch(const AURL: string; const ASource: TStream = nil;
const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse;
/// <summary>Send 'PATCH' command to url</summary>
function PatchAlternative(const AURL: string; const ASource: TStream = nil;
const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil)
: IHTTPResponse;
/// <summary>You have to use this function to Execute the internal Request</summary>
function Execute(const AHeaders: TNetHeaders = nil): IHTTPResponse;
/// <summary> CustomHeaders to be used by the client.</summary>
property CustomHeaders[const AName: string]: string
read GetCustomHeaderValue write SetCustomHeaderValue;
/// <summary> Content stream associated with the request component</summary>
property ContentStream: TStream read FContentStream write FContentStream;
/// <summary> Source stream associated with the request component</summary>
property SourceStream: TStream read FSourceStream write FSourceStream;
published
/// <summary>Property to manage the 'Accept' header</summary>
property Accept: string read GetAccept write SetAccept;
/// <summary>Property to manage the 'Accept-CharSet' header</summary>
property AcceptCharSet: string read GetAcceptCharSet write SetAcceptCharSet;
/// <summary>Property to manage the 'Accept-Encoding' header</summary>
property AcceptEncoding: string read GetAcceptEncoding
write SetAcceptEncoding;
/// <summary>Property to manage the 'Accept-Language' header</summary>
property AcceptLanguage: string read GetAcceptLanguage
write SetAcceptLanguage;
/// <summary> Property to access the MethodString from the request</summary>
property MethodString: string read GetMethodString write SetMethodString;
/// <summary> URL to be accessed</summary>
property URL: string read GetURL write SetURL;
/// <summary> Client component associated with the request component</summary>
property Client: TMuHTTPClient read GetClient write SetClient;
/// <summary> Event fired when a ClientCertificate is needed</summary>
property OnNeedClientCertificate: TNeedClientCertificateEvent
read FOnNeedClientCertificate write SetOnNeedClientCertificate;
/// <summary> Event fired when checking the validity of a Server Certificate</summary>
property OnValidateServerCertificate: TValidateCertificateEvent
read FOnValidateServerCertificate write SetOnValidateServerCertificate;
/// <summary> Event fired when a request finishes</summary>
property OnRequestCompleted: TRequestCompletedEvent read FOnRequestCompleted
write FOnRequestCompleted;
/// <summary> Event fired when a request has an error</summary>
property OnRequestError: TRequestErrorEvent read FOnRequestError
write FOnRequestError;
/// <summary>Property to manage the ReceiveData Event</summary>
property OnReceiveData: TReceiveDataEvent read GetOnReceiveData
write SetOnReceiveData;
end;
// ------------------------------------------------------------------------------------------------------------------ //
// ------------------------------------------------------------------------------------------------------------------ //
implementation
uses
System.NetConsts;
{ TMuHTTPClient }
constructor TMuHTTPClient.Create(AOwner: TComponent);
begin
inherited;
FHttpClient := THttpClient.Create;
FHttpClient.OnReceiveData := DoOnReceiveData;
end;
function TMuHTTPClient.Delete(const AURL: string;
const AResponseContent: TStream; const AHeaders: TNetHeaders): IHTTPResponse;
begin
try
Result := FHttpClient.Delete(AURL, AResponseContent, AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
destructor TMuHTTPClient.Destroy;
begin
FHttpClient.Free;
inherited;
end;
procedure TMuHTTPClient.DoOnReceiveData(const Sender: TObject;
AContentLength, AReadCount: Int64; var Abort: Boolean);
var
LAbort: Boolean;
begin
if assigned(FOnReceiveData) then
begin
LAbort := Abort;
TThread.Synchronize(nil,
procedure
begin
FOnReceiveData(Sender, AContentLength, AReadCount, LAbort);
end);
Abort := LAbort;
end;
end;
procedure TMuHTTPClient.DoOnRequestCompleted(const Sender: TObject;
const AResponse: IHTTPResponse);
begin
if assigned(FOnRequestCompleted) then
TThread.Synchronize(nil,
procedure
begin
FOnRequestCompleted(Sender, AResponse);
end);
end;
procedure TMuHTTPClient.DoOnRequestError(const Sender: TObject;
const AError: string);
begin
if assigned(FOnRequestError) then
TThread.Synchronize(nil,
procedure
begin
FOnRequestError(Sender, AError);
end)
else
raise ENetHTTPClientException.Create(AError);
end;
function TMuHTTPClient.Execute(const ARequestMethod: string; const AURI: TURI;
const ASourceStream, AContentStream: TStream; const AHeaders: TNetHeaders)
: IHTTPResponse;
begin
try
Result := IHTTPResponse(FHttpClient.Execute(ARequestMethod, AURI,
ASourceStream, AContentStream, AHeaders));
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.Execute(const ARequestMethod, AURIStr: string;
const ASourceStream, AContentStream: TStream; const AHeaders: TNetHeaders)
: IHTTPResponse;
begin
Result := Execute(ARequestMethod, TURI.Create(AURIStr), ASourceStream,
AContentStream, AHeaders);
end;
function TMuHTTPClient.Execute(const ARequest: IHTTPRequest;
const AContentStream: TStream): IHTTPResponse;
begin
try
Result := FHttpClient.Execute(ARequest, AContentStream);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.Get(const AURL: string; const AResponseContent: TStream;
const AHeaders: TNetHeaders): IHTTPResponse;
begin
try
Result := FHttpClient.Get(AURL, AResponseContent, AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.GetAccept: string;
begin
Result := FHttpClient.Accept;
end;
function TMuHTTPClient.GetAcceptCharSet: string;
begin
Result := FHttpClient.AcceptCharSet;
end;
function TMuHTTPClient.GetAcceptEncoding: string;
begin
Result := FHttpClient.AcceptEncoding;
end;
function TMuHTTPClient.GetAcceptLanguage: string;
begin
Result := FHttpClient.AcceptLanguage;
end;
function TMuHTTPClient.GetAllowCookies: Boolean;
begin
Result := FHttpClient.AllowCookies;
end;
function TMuHTTPClient.GetAuthEvent: TCredentialsStorage.TCredentialAuthevent;
begin
Result := FHttpClient.AuthEvent;
end;
function TMuHTTPClient.GetContentType: string;
begin
Result := FHttpClient.ContentType;
end;
function TMuHTTPClient.GetCookieManager: TCookieManager;
begin
Result := FHttpClient.CookieManager;
end;
function TMuHTTPClient.GetCustomHeaderValue(const AName: string): string;
begin
Result := FHttpClient.CustomHeaders[AName];
end;
function TMuHTTPClient.GetDirectTimes: Integer;
begin
result:=FhttpClient.DirectTimes;
end;
function TMuHTTPClient.GetHandleRedirects: Boolean;
begin
Result := FHttpClient.HandleRedirects;
end;
function TMuHTTPClient.GetLastURL: String;
begin
Result := FHttpClient.URL;
end;
function TMuHTTPClient.GetCredentialsStorage: TCredentialsStorage;
begin
Result := FHttpClient.CredentialsStorage;
end;
function TMuHTTPClient.GetMaxRedirects: Integer;
begin
Result := FHttpClient.MaxRedirects;
end;
function TMuHTTPClient.GetOnNeedClientCertificate: TNeedClientCertificateEvent;
begin
Result := FHttpClient.OnNeedClientCertificate;
end;
function TMuHTTPClient.GetOnValidateServerCertificate
: TValidateCertificateEvent;
begin
Result := FHttpClient.OnValidateServerCertificate;
end;
function TMuHTTPClient.GetProxySettings: TProxySettings;
begin
Result := FHttpClient.ProxySettings;
end;
function TMuHTTPClient.GetRange(const AURL: string; AStart, AnEnd: Int64;
const AResponseContent: TStream; const AHeaders: TNetHeaders): IHTTPResponse;
begin
try
Result := FHttpClient.GetRange(AURL, AStart, AnEnd, AResponseContent,
AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.getReferer: String;
begin
Result := FHttpClient.Referer;
end;
function TMuHTTPClient.GetUserAgent: string;
begin
Result := FHttpClient.UserAgent;
end;
function TMuHTTPClient.Head(const AURL: string; const AHeaders: TNetHeaders)
: IHTTPResponse;
begin
try
Result := FHttpClient.Head(AURL, AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.Merge(const AURL: string; const ASource: TStream;
const AHeaders: TNetHeaders): IHTTPResponse;
begin
try
Result := FHttpClient.Merge(AURL, ASource, AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.MergeAlternative(const AURL: string;
const ASource: TStream; const AHeaders: TNetHeaders): IHTTPResponse;
begin
try
Result := FHttpClient.MergeAlternative(AURL, ASource, AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.Options(const AURL: string;
const AResponseContent: TStream; const AHeaders: TNetHeaders): IHTTPResponse;
begin
try
Result := FHttpClient.Options(AURL, AResponseContent, AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.Patch(const AURL: string;
const ASource, AResponseContent: TStream; const AHeaders: TNetHeaders)
: IHTTPResponse;
begin
try
Result := FHttpClient.Patch(AURL, ASource, AResponseContent, AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.PatchAlternative(const AURL: string;
const ASource, AResponseContent: TStream; const AHeaders: TNetHeaders)
: IHTTPResponse;
begin
try
Result := FHttpClient.PatchAlternative(AURL, ASource, AResponseContent,
AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.Post(const AURL: string; const ASource: TStrings;
const AResponseContent: TStream; const AEncoding: TEncoding;
const AHeaders: TNetHeaders): IHTTPResponse;
begin
try
Result := FHttpClient.Post(AURL, ASource, AResponseContent, AEncoding,
AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.Post(const AURL: string;
const ASource, AResponseContent: TStream; const AHeaders: TNetHeaders)
: IHTTPResponse;
begin
try
Result := FHttpClient.Post(AURL, ASource, AResponseContent, AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.Post(const AURL: string;
const ASource: TMultipartFormData; const AResponseContent: TStream;
const AHeaders: TNetHeaders): IHTTPResponse;
begin
try
Result := FHttpClient.Post(AURL, ASource, AResponseContent, AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.Post(const AURL, ASourceFile: string;
const AResponseContent: TStream; const AHeaders: TNetHeaders): IHTTPResponse;
begin
try
Result := FHttpClient.Post(AURL, ASourceFile, AResponseContent, AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
function TMuHTTPClient.Put(const AURL: string;
const ASource, AResponseContent: TStream; const AHeaders: TNetHeaders)
: IHTTPResponse;
begin
try
Result := FHttpClient.Put(AURL, ASource, AResponseContent, AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
procedure TMuHTTPClient.SetAccept(const Value: string);
begin
FHttpClient.Accept := Value;
end;
procedure TMuHTTPClient.SetAcceptCharSet(const Value: string);
begin
FHttpClient.AcceptCharSet := Value;
end;
procedure TMuHTTPClient.SetAcceptEncoding(const Value: string);
begin
FHttpClient.AcceptEncoding := Value;
end;
procedure TMuHTTPClient.SetAcceptLanguage(const Value: string);
begin
FHttpClient.AcceptLanguage := Value;
end;
procedure TMuHTTPClient.SetAllowCookies(const Value: Boolean);
begin
FHttpClient.AllowCookies := Value;
end;
procedure TMuHTTPClient.SetAuthEvent(const Value
: TCredentialsStorage.TCredentialAuthevent);
begin
FHttpClient.AuthEvent := Value;
end;
procedure TMuHTTPClient.SetContentType(const Value: string);
begin
FHttpClient.ContentType := Value;
end;
procedure TMuHTTPClient.SetCookieManager(const Value: TCookieManager);
begin
FHttpClient.CookieManager := Value;
end;
procedure TMuHTTPClient.SetCredentialsStorage(const Value: TCredentialsStorage);
begin
FHttpClient.CredentialsStorage := Value;
end;
procedure TMuHTTPClient.SetCustomHeaderValue(const AName, Value: string);
begin
FHttpClient.CustomHeaders[AName] := Value;
end;
procedure TMuHTTPClient.SetHandleRedirects(const Value: Boolean);
begin
FHttpClient.HandleRedirects := Value;
end;
procedure TMuHTTPClient.SetMaxRedirects(const Value: Integer);
begin
FHttpClient.MaxRedirects := Value;
end;
procedure TMuHTTPClient.SetOnNeedClientCertificate
(const Value: TNeedClientCertificateEvent);
begin
FHttpClient.OnNeedClientCertificate := Value;
end;
procedure TMuHTTPClient.SetOnValidateServerCertificate
(const Value: TValidateCertificateEvent);
begin
FHttpClient.OnValidateServerCertificate := Value;
end;
procedure TMuHTTPClient.SetProxySettings(const Value: TProxySettings);
begin
FHttpClient.ProxySettings := Value;
end;
procedure TMuHTTPClient.setReferer(aValue: string);
begin
FHttpClient.Referer := aValue;
end;
procedure TMuHTTPClient.SetUserAgent(const Value: string);
begin
FHttpClient.UserAgent := Value;
end;
function TMuHTTPClient.Trace(const AURL: string;
const AResponseContent: TStream; const AHeaders: TNetHeaders): IHTTPResponse;
begin
try
Result := FHttpClient.Trace(AURL, AResponseContent, AHeaders);
DoOnRequestCompleted(self, Result);
except
on E: Exception do
DoOnRequestError(self, E.Message);
end;
end;
// ------------------------------------------------------------------------------------------------------------------ //
// ------------------------------------------------------------------------------------------------------------------ //
// ------------------------------------------------------------------------------------------------------------------ //
{ TMuHTTPRequest }
constructor TMuHTTPRequest.Create(AOwner: TComponent);
begin
inherited;
end;
procedure TMuHTTPRequest.DoOnReceiveData(const Sender: TObject;
AContentLength, AReadCount: Int64; var Abort: Boolean);
var
LAbort: Boolean;
begin
if assigned(FOnReceiveData) then
begin
LAbort := Abort;
TThread.Synchronize(nil,
procedure
begin
FOnReceiveData(Sender, AContentLength, AReadCount, LAbort);
end);
Abort := LAbort;
end
else
FClient.DoOnReceiveData(self, AContentLength, AReadCount, Abort);
end;
procedure TMuHTTPRequest.DoOnRequestCompleted(const Sender: TObject;
const AResponse: IHTTPResponse);
begin
if assigned(FOnRequestCompleted) then
TThread.Synchronize(nil,
procedure
begin
FOnRequestCompleted(Sender, AResponse);
end)
else
FClient.DoOnRequestCompleted(self, AResponse);
end;
procedure TMuHTTPRequest.DoOnRequestError(const Sender: TObject;
const AError: string);
begin
if assigned(FOnRequestError) then
TThread.Synchronize(nil,
procedure
begin
FOnRequestError(Sender, AError);
end)
else
FClient.DoOnRequestError(self, AError);
end;
function TMuHTTPRequest.Delete(const AURL: string;
const AResponseContent: TStream; const AHeaders: TNetHeaders): IHTTPResponse;
begin
FHttpRequest := GetRequest(sHTTPMethodDelete, AURL, nil);
Result := DoExecute(FHttpRequest, AResponseContent, AHeaders);
end;
function TMuHTTPRequest.Execute(const AHeaders: TNetHeaders = nil)
: IHTTPResponse;
begin
FHttpRequest := GetRequest(FMethodString, FURL, nil);
Result := DoExecute(FHttpRequest, FContentStream, AHeaders);
end;
function TMuHTTPRequest.DoExecute(const ARequest: IHTTPRequest;
const AResponseContent: TStream; const AHeaders: TNetHeaders): IHTTPResponse;