blob: bf07e1e819927904c2bf0f55f516fe53ae25a7e4 [file] [log] [blame]
Roger Meier3bef8c22012-10-06 06:58:00 +00001(*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *)
19unit Thrift.Transport.Pipes;
20
21{$WARN SYMBOL_PLATFORM OFF}
22
23interface
24
25uses
Jens Geyer06045cf2013-03-27 20:26:25 +020026 Windows, SysUtils, Math, AccCtrl, AclAPI, SyncObjs,
Roger Meier3bef8c22012-10-06 06:58:00 +000027 Thrift.Transport,
Roger Meier3bef8c22012-10-06 06:58:00 +000028 Thrift.Stream;
29
30const
31 DEFAULT_THRIFT_PIPE_TIMEOUT = 5 * 1000; // ms
32
33
34type
Roger Meier79655fb2012-10-20 20:59:41 +000035 //--- Pipe Streams ---
Roger Meier3bef8c22012-10-06 06:58:00 +000036
37
Jens Geyer06045cf2013-03-27 20:26:25 +020038 TPipeStreamBase = class( TThriftStreamImpl)
Roger Meier79655fb2012-10-20 20:59:41 +000039 strict protected
40 FPipe : THandle;
Roger Meier3bef8c22012-10-06 06:58:00 +000041 FTimeout : DWORD;
Roger Meier3bef8c22012-10-06 06:58:00 +000042
Roger Meier3bef8c22012-10-06 06:58:00 +000043 procedure Write( const buffer: TBytes; offset: Integer; count: Integer); override;
44 function Read( var buffer: TBytes; offset: Integer; count: Integer): Integer; override;
Roger Meier79655fb2012-10-20 20:59:41 +000045 //procedure Open; override; - see derived classes
Roger Meier3bef8c22012-10-06 06:58:00 +000046 procedure Close; override;
47 procedure Flush; override;
48
49 function IsOpen: Boolean; override;
50 function ToArray: TBytes; override;
51 public
Roger Meier79655fb2012-10-20 20:59:41 +000052 constructor Create( const aTimeOut : DWORD = DEFAULT_THRIFT_PIPE_TIMEOUT);
Roger Meier3bef8c22012-10-06 06:58:00 +000053 destructor Destroy; override;
54 end;
55
56
Jens Geyer06045cf2013-03-27 20:26:25 +020057 TNamedPipeStreamImpl = class sealed( TPipeStreamBase)
Roger Meier79655fb2012-10-20 20:59:41 +000058 private
59 FPipeName : string;
60 FShareMode : DWORD;
61 FSecurityAttribs : PSecurityAttributes;
Roger Meier3bef8c22012-10-06 06:58:00 +000062
Roger Meier79655fb2012-10-20 20:59:41 +000063 protected
64 procedure Open; override;
65
66 public
67 constructor Create( const aPipeName : string;
68 const aShareMode: DWORD = 0;
69 const aSecurityAttributes: PSecurityAttributes = nil;
70 const aTimeOut : DWORD = DEFAULT_THRIFT_PIPE_TIMEOUT); overload;
71 end;
72
73
Jens Geyer06045cf2013-03-27 20:26:25 +020074 THandlePipeStreamImpl = class sealed( TPipeStreamBase)
Roger Meier79655fb2012-10-20 20:59:41 +000075 private
76 FSrcHandle : THandle;
77
78 protected
79 procedure Open; override;
80
81 public
82 constructor Create( const aPipeHandle : THandle; aOwnsHandle : Boolean); overload;
83 destructor Destroy; override;
84 end;
85
86
87 //--- Pipe Transports ---
88
89
Jens Geyer06045cf2013-03-27 20:26:25 +020090 IPipeTransport = interface( IStreamTransport)
Roger Meier79655fb2012-10-20 20:59:41 +000091 ['{5E05CC85-434F-428F-BFB2-856A168B5558}']
92 end;
93
94
Jens Geyer06045cf2013-03-27 20:26:25 +020095 TPipeTransportBase = class( TStreamTransportImpl, IPipeTransport)
Roger Meier79655fb2012-10-20 20:59:41 +000096 public
97 // ITransport
98 function GetIsOpen: Boolean; override;
99 procedure Open; override;
100 procedure Close; override;
101 end;
102
103
Jens Geyer06045cf2013-03-27 20:26:25 +0200104 TNamedPipeTransportClientEndImpl = class( TPipeTransportBase)
Roger Meier79655fb2012-10-20 20:59:41 +0000105 public
Roger Meier3bef8c22012-10-06 06:58:00 +0000106 // Named pipe constructors
107 constructor Create( aPipe : THandle; aOwnsHandle : Boolean); overload;
108 constructor Create( const aPipeName : string;
109 const aShareMode: DWORD = 0;
110 const aSecurityAttributes: PSecurityAttributes = nil;
111 const aTimeOut : DWORD = DEFAULT_THRIFT_PIPE_TIMEOUT); overload;
Roger Meier3bef8c22012-10-06 06:58:00 +0000112 end;
113
114
Jens Geyer06045cf2013-03-27 20:26:25 +0200115 TNamedPipeTransportServerEndImpl = class( TNamedPipeTransportClientEndImpl)
Roger Meier79655fb2012-10-20 20:59:41 +0000116 strict private
117 FHandle : THandle;
Roger Meier3bef8c22012-10-06 06:58:00 +0000118 public
Roger Meier79655fb2012-10-20 20:59:41 +0000119 // ITransport
120 procedure Close; override;
121 constructor Create( aPipe : THandle; aOwnsHandle : Boolean); reintroduce;
122 end;
Roger Meier3bef8c22012-10-06 06:58:00 +0000123
Roger Meier79655fb2012-10-20 20:59:41 +0000124
Jens Geyer06045cf2013-03-27 20:26:25 +0200125 TAnonymousPipeTransportImpl = class( TPipeTransportBase)
Roger Meier79655fb2012-10-20 20:59:41 +0000126 public
Roger Meier3bef8c22012-10-06 06:58:00 +0000127 // Anonymous pipe constructor
128 constructor Create( const aPipeRead, aPipeWrite : THandle; aOwnsHandles : Boolean); overload;
Roger Meier3bef8c22012-10-06 06:58:00 +0000129 end;
130
131
Roger Meier79655fb2012-10-20 20:59:41 +0000132 //--- Server Transports ---
133
134
Jens Geyer06045cf2013-03-27 20:26:25 +0200135 IAnonymousPipeServerTransport = interface( IServerTransport)
Roger Meier3bef8c22012-10-06 06:58:00 +0000136 ['{7AEE6793-47B9-4E49-981A-C39E9108E9AD}']
137 // Server side anonymous pipe ends
Roger Meier79655fb2012-10-20 20:59:41 +0000138 function ReadHandle : THandle;
Roger Meier3bef8c22012-10-06 06:58:00 +0000139 function WriteHandle : THandle;
140 // Client side anonymous pipe ends
141 function ClientAnonRead : THandle;
142 function ClientAnonWrite : THandle;
143 end;
144
145
Jens Geyer06045cf2013-03-27 20:26:25 +0200146 INamedPipeServerTransport = interface( IServerTransport)
Roger Meier79655fb2012-10-20 20:59:41 +0000147 ['{9DF9EE48-D065-40AF-8F67-D33037D3D960}']
148 function Handle : THandle;
149 end;
Roger Meier3bef8c22012-10-06 06:58:00 +0000150
Roger Meier79655fb2012-10-20 20:59:41 +0000151
Jens Geyer06045cf2013-03-27 20:26:25 +0200152 TPipeServerTransportBase = class( TServerTransportImpl)
153 protected
154 FStopServer : Boolean;
155 procedure InternalClose; virtual; abstract;
Roger Meier79655fb2012-10-20 20:59:41 +0000156 public
157 procedure Listen; override;
Jens Geyer06045cf2013-03-27 20:26:25 +0200158 procedure Close; override;
Roger Meier79655fb2012-10-20 20:59:41 +0000159 end;
160
161
Jens Geyer06045cf2013-03-27 20:26:25 +0200162 TAnonymousPipeServerTransportImpl = class( TPipeServerTransportBase, IAnonymousPipeServerTransport)
Roger Meier79655fb2012-10-20 20:59:41 +0000163 private
164 FBufSize : DWORD;
165
166 // Server side anonymous pipe handles
167 FReadHandle,
Roger Meier3bef8c22012-10-06 06:58:00 +0000168 FWriteHandle : THandle;
169
170 //Client side anonymous pipe handles
171 FClientAnonRead,
172 FClientAnonWrite : THandle;
173
174 protected
175 function AcceptImpl: ITransport; override;
176
Roger Meier3bef8c22012-10-06 06:58:00 +0000177 function CreateAnonPipe : Boolean;
178
Jens Geyer06045cf2013-03-27 20:26:25 +0200179 // IAnonymousPipeServerTransport
Roger Meier79655fb2012-10-20 20:59:41 +0000180 function ReadHandle : THandle;
Roger Meier3bef8c22012-10-06 06:58:00 +0000181 function WriteHandle : THandle;
182 function ClientAnonRead : THandle;
183 function ClientAnonWrite : THandle;
184
Jens Geyer06045cf2013-03-27 20:26:25 +0200185 procedure InternalClose; override;
186
Roger Meier3bef8c22012-10-06 06:58:00 +0000187 public
Roger Meier79655fb2012-10-20 20:59:41 +0000188 constructor Create( aBufsize : Cardinal = 4096);
Roger Meier3bef8c22012-10-06 06:58:00 +0000189 end;
190
191
Jens Geyer06045cf2013-03-27 20:26:25 +0200192 TNamedPipeServerTransportImpl = class( TPipeServerTransportBase, INamedPipeServerTransport)
Roger Meier79655fb2012-10-20 20:59:41 +0000193 private
194 FPipeName : string;
195 FMaxConns : DWORD;
196 FBufSize : DWORD;
Jens Geyer0b20cc82013-03-07 20:47:01 +0100197 FTimeout : DWORD;
Jens Geyer06045cf2013-03-27 20:26:25 +0200198 FHandle : THandle;
199 FConnected : Boolean;
200
201 protected
Roger Meier79655fb2012-10-20 20:59:41 +0000202 function AcceptImpl: ITransport; override;
Jens Geyer06045cf2013-03-27 20:26:25 +0200203 function CreateNamedPipe : THandle;
204 function CreateTransportInstance : ITransport;
Roger Meier79655fb2012-10-20 20:59:41 +0000205
Jens Geyer06045cf2013-03-27 20:26:25 +0200206 // INamedPipeServerTransport
Roger Meier79655fb2012-10-20 20:59:41 +0000207 function Handle : THandle;
Jens Geyer06045cf2013-03-27 20:26:25 +0200208 procedure InternalClose; override;
Roger Meier79655fb2012-10-20 20:59:41 +0000209
210 public
211 constructor Create( aPipename : string; aBufsize : Cardinal = 4096;
Jens Geyer0b20cc82013-03-07 20:47:01 +0100212 aMaxConns : Cardinal = PIPE_UNLIMITED_INSTANCES;
213 aTimeOut : Cardinal = 0);
Roger Meier79655fb2012-10-20 20:59:41 +0000214 end;
Roger Meier3bef8c22012-10-06 06:58:00 +0000215
216
217implementation
218
219
Roger Meier79655fb2012-10-20 20:59:41 +0000220procedure ClosePipeHandle( var hPipe : THandle);
Roger Meier3bef8c22012-10-06 06:58:00 +0000221begin
Roger Meier79655fb2012-10-20 20:59:41 +0000222 if hPipe <> INVALID_HANDLE_VALUE
223 then try
224 CloseHandle( hPipe);
225 finally
226 hPipe := INVALID_HANDLE_VALUE;
227 end;
Roger Meier3bef8c22012-10-06 06:58:00 +0000228end;
229
230
Roger Meier79655fb2012-10-20 20:59:41 +0000231function DuplicatePipeHandle( const hSource : THandle) : THandle;
Roger Meier3bef8c22012-10-06 06:58:00 +0000232begin
Roger Meier79655fb2012-10-20 20:59:41 +0000233 if not DuplicateHandle( GetCurrentProcess, hSource,
234 GetCurrentProcess, @result,
235 0, FALSE, DUPLICATE_SAME_ACCESS)
236 then raise TTransportException.Create( TTransportException.TExceptionType.NotOpen,
237 'DuplicateHandle: '+SysErrorMessage(GetLastError));
Roger Meier3bef8c22012-10-06 06:58:00 +0000238end;
239
240
Roger Meier79655fb2012-10-20 20:59:41 +0000241
Jens Geyer06045cf2013-03-27 20:26:25 +0200242{ TPipeStreamBase }
Roger Meier79655fb2012-10-20 20:59:41 +0000243
244
Jens Geyer06045cf2013-03-27 20:26:25 +0200245constructor TPipeStreamBase.Create( const aTimeOut : DWORD = DEFAULT_THRIFT_PIPE_TIMEOUT);
Roger Meier79655fb2012-10-20 20:59:41 +0000246begin
247 inherited Create;
248 FPipe := INVALID_HANDLE_VALUE;
249 FTimeout := aTimeOut;
250end;
251
252
Jens Geyer06045cf2013-03-27 20:26:25 +0200253destructor TPipeStreamBase.Destroy;
Roger Meier3bef8c22012-10-06 06:58:00 +0000254begin
255 try
256 Close;
257 finally
258 inherited Destroy;
259 end;
260end;
261
262
Jens Geyer06045cf2013-03-27 20:26:25 +0200263procedure TPipeStreamBase.Close;
Roger Meier3bef8c22012-10-06 06:58:00 +0000264begin
Roger Meier79655fb2012-10-20 20:59:41 +0000265 ClosePipeHandle( FPipe);
Roger Meier3bef8c22012-10-06 06:58:00 +0000266end;
267
268
Jens Geyer06045cf2013-03-27 20:26:25 +0200269procedure TPipeStreamBase.Flush;
Roger Meier3bef8c22012-10-06 06:58:00 +0000270begin
271 // nothing to do
272end;
273
274
Jens Geyer06045cf2013-03-27 20:26:25 +0200275function TPipeStreamBase.IsOpen: Boolean;
Roger Meier3bef8c22012-10-06 06:58:00 +0000276begin
277 result := (FPipe <> INVALID_HANDLE_VALUE);
278end;
279
280
Jens Geyer06045cf2013-03-27 20:26:25 +0200281procedure TPipeStreamBase.Write(const buffer: TBytes; offset, count: Integer);
Roger Meier3bef8c22012-10-06 06:58:00 +0000282var cbWritten : DWORD;
283begin
284 if not IsOpen
285 then raise TTransportException.Create( TTransportException.TExceptionType.NotOpen,
286 'Called write on non-open pipe');
287
288 if not WriteFile( FPipe, buffer[offset], count, cbWritten, nil)
289 then raise TTransportException.Create( TTransportException.TExceptionType.NotOpen,
290 'Write to pipe failed');
291end;
292
293
Jens Geyer06045cf2013-03-27 20:26:25 +0200294function TPipeStreamBase.Read( var buffer: TBytes; offset, count: Integer): Integer;
Roger Meier79655fb2012-10-20 20:59:41 +0000295var cbRead, dwErr : DWORD;
Roger Meier3bef8c22012-10-06 06:58:00 +0000296 bytes, retries : LongInt;
297 bOk : Boolean;
298const INTERVAL = 10; // ms
299begin
300 if not IsOpen
301 then raise TTransportException.Create( TTransportException.TExceptionType.NotOpen,
302 'Called read on non-open pipe');
303
304 // MSDN: Handle can be a handle to a named pipe instance,
305 // or it can be a handle to the read end of an anonymous pipe,
306 // The handle must have GENERIC_READ access to the pipe.
307 if FTimeOut <> INFINITE then begin
308 retries := Max( 1, Round( 1.0 * FTimeOut / INTERVAL));
309 while TRUE do begin
310 if IsOpen
311 and PeekNamedPipe( FPipe, nil, 0, nil, @bytes, nil)
312 and (bytes > 0)
313 then Break; // there are data
314
Roger Meier79655fb2012-10-20 20:59:41 +0000315 dwErr := GetLastError;
Jens Geyer06045cf2013-03-27 20:26:25 +0200316 if (dwErr = ERROR_INVALID_HANDLE)
317 or (dwErr = ERROR_BROKEN_PIPE)
Roger Meier79655fb2012-10-20 20:59:41 +0000318 or (dwErr = ERROR_PIPE_NOT_CONNECTED)
319 then begin
320 result := 0; // other side closed the pipe
321 Exit;
322 end;
323
Roger Meier3bef8c22012-10-06 06:58:00 +0000324 Dec( retries);
325 if retries > 0
326 then Sleep( INTERVAL)
327 else raise TTransportException.Create( TTransportException.TExceptionType.TimedOut,
328 'Pipe read timed out');
329 end;
330 end;
331
332 // read the data (or block INFINITE-ly)
333 bOk := ReadFile( FPipe, buffer[offset], count, cbRead, nil);
334 if (not bOk) and (GetLastError() <> ERROR_MORE_DATA)
335 then result := 0 // No more data, possibly because client disconnected.
336 else result := cbRead;
337end;
338
339
Jens Geyer06045cf2013-03-27 20:26:25 +0200340function TPipeStreamBase.ToArray: TBytes;
Roger Meier3bef8c22012-10-06 06:58:00 +0000341var bytes : LongInt;
342begin
343 SetLength( result, 0);
344 bytes := 0;
345
346 if IsOpen
347 and PeekNamedPipe( FPipe, nil, 0, nil, @bytes, nil)
348 and (bytes > 0)
349 then begin
350 SetLength( result, bytes);
351 Read( result, 0, bytes);
352 end;
353end;
354
355
Roger Meier79655fb2012-10-20 20:59:41 +0000356{ TNamedPipeStreamImpl }
Roger Meier3bef8c22012-10-06 06:58:00 +0000357
358
Roger Meier79655fb2012-10-20 20:59:41 +0000359constructor TNamedPipeStreamImpl.Create( const aPipeName : string; const aShareMode: DWORD;
360 const aSecurityAttributes: PSecurityAttributes;
361 const aTimeOut : DWORD);
Roger Meier3bef8c22012-10-06 06:58:00 +0000362begin
Roger Meier79655fb2012-10-20 20:59:41 +0000363 inherited Create( aTimeout);
364
365 FPipeName := aPipeName;
366 FShareMode := aShareMode;
367 FSecurityAttribs := aSecurityAttributes;
368
369 if Copy(FPipeName,1,2) <> '\\'
370 then FPipeName := '\\.\pipe\' + FPipeName; // assume localhost
Roger Meier3bef8c22012-10-06 06:58:00 +0000371end;
372
373
Roger Meier79655fb2012-10-20 20:59:41 +0000374procedure TNamedPipeStreamImpl.Open;
375var hPipe : THandle;
376 dwMode : DWORD;
377begin
378 if IsOpen then Exit;
379
380 // open that thingy
381
382 if not WaitNamedPipe( PChar(FPipeName), FTimeout)
383 then raise TTransportException.Create( TTransportException.TExceptionType.NotOpen,
384 'Unable to open pipe, '+SysErrorMessage(GetLastError));
385
386 hPipe := CreateFile( PChar( FPipeName),
387 GENERIC_READ or GENERIC_WRITE,
388 FShareMode, // sharing
389 FSecurityAttribs, // security attributes
390 OPEN_EXISTING, // opens existing pipe
391 0, // default attributes
392 0); // no template file
393
394 if hPipe = INVALID_HANDLE_VALUE
395 then raise TTransportException.Create( TTransportException.TExceptionType.NotOpen,
396 'Unable to open pipe, '+SysErrorMessage(GetLastError));
397
398 // pipe connected; change to message-read mode.
399 dwMode := PIPE_READMODE_MESSAGE;
400 if not SetNamedPipeHandleState( hPipe, dwMode, nil, nil) then begin
401 Close;
402 raise TTransportException.Create( TTransportException.TExceptionType.NotOpen,
403 'SetNamedPipeHandleState failed');
404 end;
405
406 // everything fine
407 FPipe := hPipe;
408end;
409
410
411{ THandlePipeStreamImpl }
412
413
414constructor THandlePipeStreamImpl.Create( const aPipeHandle : THandle; aOwnsHandle : Boolean);
415begin
416 inherited Create( DEFAULT_THRIFT_PIPE_TIMEOUT);
417
418 if aOwnsHandle
419 then FSrcHandle := aPipeHandle
420 else FSrcHandle := DuplicatePipeHandle( aPipeHandle);
421
422 Open;
423end;
424
425
426destructor THandlePipeStreamImpl.Destroy;
427begin
428 try
429 ClosePipeHandle( FSrcHandle);
430 finally
431 inherited Destroy;
432 end;
433end;
434
435
436procedure THandlePipeStreamImpl.Open;
437begin
438 if not IsOpen
439 then FPipe := DuplicatePipeHandle( FSrcHandle);
440end;
441
442
Jens Geyer06045cf2013-03-27 20:26:25 +0200443{ TPipeTransportBase }
Roger Meier79655fb2012-10-20 20:59:41 +0000444
445
Jens Geyer06045cf2013-03-27 20:26:25 +0200446function TPipeTransportBase.GetIsOpen: Boolean;
Roger Meier79655fb2012-10-20 20:59:41 +0000447begin
Jens Geyer0b20cc82013-03-07 20:47:01 +0100448 result := (FInputStream <> nil) and (FInputStream.IsOpen)
449 and (FOutputStream <> nil) and (FOutputStream.IsOpen);
Roger Meier79655fb2012-10-20 20:59:41 +0000450end;
451
452
Jens Geyer06045cf2013-03-27 20:26:25 +0200453procedure TPipeTransportBase.Open;
Roger Meier79655fb2012-10-20 20:59:41 +0000454begin
455 FInputStream.Open;
456 FOutputStream.Open;
457end;
458
459
Jens Geyer06045cf2013-03-27 20:26:25 +0200460procedure TPipeTransportBase.Close;
Roger Meier79655fb2012-10-20 20:59:41 +0000461begin
462 FInputStream.Close;
463 FOutputStream.Close;
464end;
465
466
Jens Geyer06045cf2013-03-27 20:26:25 +0200467{ TNamedPipeTransportClientEndImpl }
Roger Meier79655fb2012-10-20 20:59:41 +0000468
469
Jens Geyer06045cf2013-03-27 20:26:25 +0200470constructor TNamedPipeTransportClientEndImpl.Create( const aPipeName : string; const aShareMode: DWORD;
Roger Meier3bef8c22012-10-06 06:58:00 +0000471 const aSecurityAttributes: PSecurityAttributes;
472 const aTimeOut : DWORD);
473// Named pipe constructor
474begin
Roger Meier79655fb2012-10-20 20:59:41 +0000475 inherited Create( nil, nil);
476 FInputStream := TNamedPipeStreamImpl.Create( aPipeName, aShareMode, aSecurityAttributes, aTimeOut);
Roger Meier3bef8c22012-10-06 06:58:00 +0000477 FOutputStream := FInputStream; // true for named pipes
Roger Meier3bef8c22012-10-06 06:58:00 +0000478end;
479
480
Jens Geyer06045cf2013-03-27 20:26:25 +0200481constructor TNamedPipeTransportClientEndImpl.Create( aPipe : THandle; aOwnsHandle : Boolean);
Roger Meier3bef8c22012-10-06 06:58:00 +0000482// Named pipe constructor
483begin
Roger Meier79655fb2012-10-20 20:59:41 +0000484 inherited Create( nil, nil);
485 FInputStream := THandlePipeStreamImpl.Create( aPipe, aOwnsHandle);
Roger Meier3bef8c22012-10-06 06:58:00 +0000486 FOutputStream := FInputStream; // true for named pipes
Roger Meier3bef8c22012-10-06 06:58:00 +0000487end;
488
489
Jens Geyer06045cf2013-03-27 20:26:25 +0200490{ TNamedPipeTransportServerEndImpl }
Roger Meier79655fb2012-10-20 20:59:41 +0000491
492
Jens Geyer06045cf2013-03-27 20:26:25 +0200493constructor TNamedPipeTransportServerEndImpl.Create( aPipe : THandle; aOwnsHandle : Boolean);
Roger Meier79655fb2012-10-20 20:59:41 +0000494// Named pipe constructor
Roger Meier3bef8c22012-10-06 06:58:00 +0000495begin
Roger Meier79655fb2012-10-20 20:59:41 +0000496 FHandle := DuplicatePipeHandle( aPipe);
497 inherited Create( aPipe, aOwnsHandle);
Roger Meier3bef8c22012-10-06 06:58:00 +0000498end;
499
500
Jens Geyer06045cf2013-03-27 20:26:25 +0200501procedure TNamedPipeTransportServerEndImpl.Close;
Roger Meier3bef8c22012-10-06 06:58:00 +0000502begin
Roger Meier79655fb2012-10-20 20:59:41 +0000503 FlushFileBuffers( FHandle);
504 DisconnectNamedPipe( FHandle); // force client off the pipe
505 ClosePipeHandle( FHandle);
Roger Meier3bef8c22012-10-06 06:58:00 +0000506
Roger Meier79655fb2012-10-20 20:59:41 +0000507 inherited Close;
Roger Meier3bef8c22012-10-06 06:58:00 +0000508end;
509
510
Jens Geyer06045cf2013-03-27 20:26:25 +0200511{ TAnonymousPipeTransportImpl }
Roger Meier3bef8c22012-10-06 06:58:00 +0000512
513
Jens Geyer06045cf2013-03-27 20:26:25 +0200514constructor TAnonymousPipeTransportImpl.Create( const aPipeRead, aPipeWrite : THandle; aOwnsHandles : Boolean);
Roger Meier3bef8c22012-10-06 06:58:00 +0000515// Anonymous pipe constructor
516begin
Roger Meier79655fb2012-10-20 20:59:41 +0000517 inherited Create( nil, nil);
518 FInputStream := THandlePipeStreamImpl.Create( aPipeRead, aOwnsHandles);
519 FOutputStream := THandlePipeStreamImpl.Create( aPipeWrite, aOwnsHandles);
Roger Meier3bef8c22012-10-06 06:58:00 +0000520end;
521
522
Jens Geyer06045cf2013-03-27 20:26:25 +0200523{ TPipeServerTransportBase }
Roger Meier79655fb2012-10-20 20:59:41 +0000524
525
Jens Geyer06045cf2013-03-27 20:26:25 +0200526procedure TPipeServerTransportBase.Listen;
Roger Meier3bef8c22012-10-06 06:58:00 +0000527begin
Jens Geyer06045cf2013-03-27 20:26:25 +0200528 FStopServer := FALSE;
Roger Meier3bef8c22012-10-06 06:58:00 +0000529end;
530
531
Jens Geyer06045cf2013-03-27 20:26:25 +0200532procedure TPipeServerTransportBase.Close;
533begin
534 FStopServer := TRUE;
535 InternalClose;
536end;
Roger Meier3bef8c22012-10-06 06:58:00 +0000537
538
Jens Geyer06045cf2013-03-27 20:26:25 +0200539{ TAnonymousPipeServerTransportImpl }
540
541
542constructor TAnonymousPipeServerTransportImpl.Create( aBufsize : Cardinal);
Roger Meier3bef8c22012-10-06 06:58:00 +0000543// Anonymous pipe CTOR
544begin
545 inherited Create;
Roger Meier3bef8c22012-10-06 06:58:00 +0000546 FBufsize := aBufSize;
Roger Meier79655fb2012-10-20 20:59:41 +0000547 FReadHandle := INVALID_HANDLE_VALUE;
Roger Meier3bef8c22012-10-06 06:58:00 +0000548 FWriteHandle := INVALID_HANDLE_VALUE;
549 FClientAnonRead := INVALID_HANDLE_VALUE;
550 FClientAnonWrite := INVALID_HANDLE_VALUE;
551
552 // The anonymous pipe needs to be created first so that the server can
553 // pass the handles on to the client before the serve (acceptImpl)
554 // blocking call.
555 if not CreateAnonPipe
556 then raise TTransportException.Create( TTransportException.TExceptionType.NotOpen,
557 ClassName+'.Create() failed');
558end;
559
560
Jens Geyer06045cf2013-03-27 20:26:25 +0200561function TAnonymousPipeServerTransportImpl.AcceptImpl: ITransport;
Roger Meier3bef8c22012-10-06 06:58:00 +0000562var buf : Byte;
563 br : DWORD;
Roger Meier3bef8c22012-10-06 06:58:00 +0000564begin
Roger Meier79655fb2012-10-20 20:59:41 +0000565 // This 0-byte read serves merely as a blocking call.
566 if not ReadFile( FReadHandle, buf, 0, br, nil)
567 and (GetLastError() <> ERROR_MORE_DATA)
568 then raise TTransportException.Create( TTransportException.TExceptionType.NotOpen,
569 'TServerPipe unable to initiate pipe communication');
Jens Geyer06045cf2013-03-27 20:26:25 +0200570
571 // create the transport impl
572 result := TAnonymousPipeTransportImpl.Create( FReadHandle, FWriteHandle, FALSE);
Roger Meier3bef8c22012-10-06 06:58:00 +0000573end;
574
575
Jens Geyer06045cf2013-03-27 20:26:25 +0200576procedure TAnonymousPipeServerTransportImpl.InternalClose;
Roger Meier3bef8c22012-10-06 06:58:00 +0000577begin
Roger Meier79655fb2012-10-20 20:59:41 +0000578 ClosePipeHandle( FReadHandle);
579 ClosePipeHandle( FWriteHandle);
580 ClosePipeHandle( FClientAnonRead);
581 ClosePipeHandle( FClientAnonWrite);
Roger Meier3bef8c22012-10-06 06:58:00 +0000582end;
583
584
Jens Geyer06045cf2013-03-27 20:26:25 +0200585function TAnonymousPipeServerTransportImpl.ReadHandle : THandle;
Roger Meier3bef8c22012-10-06 06:58:00 +0000586begin
Roger Meier79655fb2012-10-20 20:59:41 +0000587 result := FReadHandle;
Roger Meier3bef8c22012-10-06 06:58:00 +0000588end;
589
590
Jens Geyer06045cf2013-03-27 20:26:25 +0200591function TAnonymousPipeServerTransportImpl.WriteHandle : THandle;
Roger Meier3bef8c22012-10-06 06:58:00 +0000592begin
593 result := FWriteHandle;
594end;
595
596
Jens Geyer06045cf2013-03-27 20:26:25 +0200597function TAnonymousPipeServerTransportImpl.ClientAnonRead : THandle;
Roger Meier3bef8c22012-10-06 06:58:00 +0000598begin
599 result := FClientAnonRead;
600end;
601
602
Jens Geyer06045cf2013-03-27 20:26:25 +0200603function TAnonymousPipeServerTransportImpl.ClientAnonWrite : THandle;
Roger Meier3bef8c22012-10-06 06:58:00 +0000604begin
605 result := FClientAnonWrite;
606end;
607
608
Jens Geyer06045cf2013-03-27 20:26:25 +0200609function TAnonymousPipeServerTransportImpl.CreateAnonPipe : Boolean;
Roger Meier79655fb2012-10-20 20:59:41 +0000610var sd : PSECURITY_DESCRIPTOR;
611 sa : SECURITY_ATTRIBUTES; //TSecurityAttributes;
612 hCAR, hPipeW, hCAW, hPipe : THandle;
613begin
614 result := FALSE;
615
616 sd := PSECURITY_DESCRIPTOR( LocalAlloc( LPTR,SECURITY_DESCRIPTOR_MIN_LENGTH));
Jens Geyerb64a7742013-01-23 20:58:47 +0100617 try
618 Win32Check( InitializeSecurityDescriptor( sd, SECURITY_DESCRIPTOR_REVISION));
619 Win32Check( SetSecurityDescriptorDacl( sd, TRUE, nil, FALSE));
Roger Meier79655fb2012-10-20 20:59:41 +0000620
Jens Geyerb64a7742013-01-23 20:58:47 +0100621 sa.nLength := sizeof( sa);
622 sa.lpSecurityDescriptor := sd;
623 sa.bInheritHandle := TRUE; //allow passing handle to child
Roger Meier79655fb2012-10-20 20:59:41 +0000624
Jens Geyerb64a7742013-01-23 20:58:47 +0100625 if not CreatePipe( hCAR, hPipeW, @sa, FBufSize) then begin //create stdin pipe
Jens Geyer06045cf2013-03-27 20:26:25 +0200626 raise TTransportException.Create( TTransportException.TExceptionType.NotOpen,
627 'TServerPipe CreatePipe (anon) failed, '+SysErrorMessage(GetLastError));
Jens Geyerb64a7742013-01-23 20:58:47 +0100628 Exit;
629 end;
630
631 if not CreatePipe( hPipe, hCAW, @sa, FBufSize) then begin //create stdout pipe
Jens Geyerb64a7742013-01-23 20:58:47 +0100632 CloseHandle( hCAR);
633 CloseHandle( hPipeW);
Jens Geyer06045cf2013-03-27 20:26:25 +0200634 raise TTransportException.Create( TTransportException.TExceptionType.NotOpen,
635 'TServerPipe CreatePipe (anon) failed, '+SysErrorMessage(GetLastError));
Jens Geyerb64a7742013-01-23 20:58:47 +0100636 Exit;
637 end;
638
639 FClientAnonRead := hCAR;
640 FClientAnonWrite := hCAW;
641 FReadHandle := hPipe;
642 FWriteHandle := hPipeW;
643
644 result := TRUE;
645
646 finally
647 if sd <> nil then LocalFree( Cardinal(sd));
Roger Meier79655fb2012-10-20 20:59:41 +0000648 end;
Roger Meier79655fb2012-10-20 20:59:41 +0000649end;
650
651
Jens Geyer06045cf2013-03-27 20:26:25 +0200652{ TNamedPipeServerTransportImpl }
Roger Meier79655fb2012-10-20 20:59:41 +0000653
654
Jens Geyer06045cf2013-03-27 20:26:25 +0200655constructor TNamedPipeServerTransportImpl.Create( aPipename : string; aBufsize, aMaxConns, aTimeOut : Cardinal);
Roger Meier79655fb2012-10-20 20:59:41 +0000656// Named Pipe CTOR
657begin
658 inherited Create;
Jens Geyer06045cf2013-03-27 20:26:25 +0200659 FPipeName := aPipename;
660 FBufsize := aBufSize;
661 FMaxConns := Max( 1, Min( PIPE_UNLIMITED_INSTANCES, aMaxConns));
662 FHandle := INVALID_HANDLE_VALUE;
663 FTimeout := aTimeOut;
664 FConnected := FALSE;
Roger Meier79655fb2012-10-20 20:59:41 +0000665
666 if Copy(FPipeName,1,2) <> '\\'
667 then FPipeName := '\\.\pipe\' + FPipeName; // assume localhost
668end;
669
670
Jens Geyer06045cf2013-03-27 20:26:25 +0200671function TNamedPipeServerTransportImpl.AcceptImpl: ITransport;
672var dwError, dwWait, dwDummy : DWORD;
673 overlapped : TOverlapped;
674 event : TEvent;
675begin
676 FillChar( overlapped, SizeOf(overlapped), 0);
677 event := TEvent.Create( nil, TRUE, FALSE, ''); // always ManualReset, see MSDN
678 try
679 overlapped.hEvent := event.Handle;
680
681 ASSERT( not FConnected);
682 while not FConnected do begin
683 InternalClose;
684 if FStopServer then Abort;
685 CreateNamedPipe;
Roger Meier79655fb2012-10-20 20:59:41 +0000686
Jens Geyer06045cf2013-03-27 20:26:25 +0200687 // Wait for the client to connect; if it succeeds, the
688 // function returns a nonzero value. If the function returns
689 // zero, GetLastError should return ERROR_PIPE_CONNECTED.
690 if ConnectNamedPipe( Handle, @overlapped)
691 then FConnected := TRUE
692 else begin
693 // ConnectNamedPipe() returns FALSE for OverlappedIO, even if connected.
694 // We have to check GetLastError() explicitly to find out
695 dwError := GetLastError;
696 case dwError of
697 ERROR_PIPE_CONNECTED : begin
698 FConnected := TRUE; // special case: pipe immediately connected
699 end;
700
701 ERROR_IO_PENDING : begin
702 dwWait := WaitForSingleObject( overlapped.hEvent, DEFAULT_THRIFT_PIPE_TIMEOUT);
703 FConnected := (dwWait = WAIT_OBJECT_0)
704 and GetOverlappedResult( Handle, overlapped, dwDummy, TRUE);
705 end;
706
707 else
708 InternalClose;
709 raise TTransportException.Create( TTransportException.TExceptionType.NotOpen,
710 'Client connection failed');
711 end;
712 end;
713 end;
Roger Meier79655fb2012-10-20 20:59:41 +0000714
Jens Geyer06045cf2013-03-27 20:26:25 +0200715 // create the transport impl
716 result := CreateTransportInstance;
Roger Meier79655fb2012-10-20 20:59:41 +0000717
Roger Meier79655fb2012-10-20 20:59:41 +0000718 finally
Jens Geyer06045cf2013-03-27 20:26:25 +0200719 event.Free;
Roger Meier79655fb2012-10-20 20:59:41 +0000720 end;
721end;
722
723
Jens Geyer06045cf2013-03-27 20:26:25 +0200724function TNamedPipeServerTransportImpl.CreateTransportInstance : ITransport;
725// create the transport impl
726var hPipe : THandle;
Roger Meier79655fb2012-10-20 20:59:41 +0000727begin
Jens Geyer06045cf2013-03-27 20:26:25 +0200728 hPipe := THandle( InterlockedExchangePointer( Pointer(FHandle), Pointer(INVALID_HANDLE_VALUE)));
729 try
730 FConnected := FALSE;
731 result := TNamedPipeTransportServerEndImpl.Create( hPipe, TRUE);
732 except
733 ClosePipeHandle(hPipe);
734 raise;
735 end;
Roger Meier79655fb2012-10-20 20:59:41 +0000736end;
737
738
Jens Geyer06045cf2013-03-27 20:26:25 +0200739procedure TNamedPipeServerTransportImpl.InternalClose;
740var hPipe : THandle;
741begin
742 hPipe := THandle( InterlockedExchangePointer( Pointer(FHandle), Pointer(INVALID_HANDLE_VALUE)));
743 if hPipe = INVALID_HANDLE_VALUE then Exit;
744
745 try
746 if FConnected
747 then FlushFileBuffers( hPipe)
748 else CancelIo( hPipe);
749 DisconnectNamedPipe( hPipe);
750 finally
751 ClosePipeHandle( hPipe);
752 FConnected := FALSE;
753 end;
754end;
755
756
757function TNamedPipeServerTransportImpl.Handle : THandle;
758begin
759 {$IFDEF WIN64}
760 result := THandle( InterlockedExchangeAdd64( Integer(FHandle), 0));
761 {$ELSE}
762 result := THandle( InterlockedExchangeAdd( Integer(FHandle), 0));
763 {$ENDIF}
764end;
765
766
767function TNamedPipeServerTransportImpl.CreateNamedPipe : THandle;
Roger Meier3bef8c22012-10-06 06:58:00 +0000768var SIDAuthWorld : SID_IDENTIFIER_AUTHORITY ;
769 everyone_sid : PSID;
770 ea : EXPLICIT_ACCESS;
771 acl : PACL;
772 sd : PSECURITY_DESCRIPTOR;
773 sa : SECURITY_ATTRIBUTES;
Roger Meier3bef8c22012-10-06 06:58:00 +0000774const
775 SECURITY_WORLD_SID_AUTHORITY : TSIDIdentifierAuthority = (Value : (0,0,0,0,0,1));
776 SECURITY_WORLD_RID = $00000000;
777begin
Jens Geyerb64a7742013-01-23 20:58:47 +0100778 sd := nil;
Roger Meier3bef8c22012-10-06 06:58:00 +0000779 everyone_sid := nil;
Jens Geyerb64a7742013-01-23 20:58:47 +0100780 try
Jens Geyer06045cf2013-03-27 20:26:25 +0200781 ASSERT( (FHandle = INVALID_HANDLE_VALUE) and not FConnected);
782
Jens Geyerb64a7742013-01-23 20:58:47 +0100783 // Windows - set security to allow non-elevated apps
784 // to access pipes created by elevated apps.
785 SIDAuthWorld := SECURITY_WORLD_SID_AUTHORITY;
786 AllocateAndInitializeSid( SIDAuthWorld, 1, SECURITY_WORLD_RID, 0, 0, 0, 0, 0, 0, 0, everyone_sid);
Roger Meier3bef8c22012-10-06 06:58:00 +0000787
Jens Geyerb64a7742013-01-23 20:58:47 +0100788 ZeroMemory( @ea, SizeOf(ea));
789 ea.grfAccessPermissions := GENERIC_ALL; //SPECIFIC_RIGHTS_ALL or STANDARD_RIGHTS_ALL;
790 ea.grfAccessMode := SET_ACCESS;
791 ea.grfInheritance := NO_INHERITANCE;
792 ea.Trustee.TrusteeForm := TRUSTEE_IS_SID;
793 ea.Trustee.TrusteeType := TRUSTEE_IS_WELL_KNOWN_GROUP;
794 ea.Trustee.ptstrName := PChar(everyone_sid);
Roger Meier3bef8c22012-10-06 06:58:00 +0000795
Jens Geyerb64a7742013-01-23 20:58:47 +0100796 acl := nil;
797 SetEntriesInAcl( 1, @ea, nil, acl);
Roger Meier3bef8c22012-10-06 06:58:00 +0000798
Jens Geyerb64a7742013-01-23 20:58:47 +0100799 sd := PSECURITY_DESCRIPTOR( LocalAlloc( LPTR,SECURITY_DESCRIPTOR_MIN_LENGTH));
800 Win32Check( InitializeSecurityDescriptor( sd, SECURITY_DESCRIPTOR_REVISION));
801 Win32Check( SetSecurityDescriptorDacl( sd, TRUE, acl, FALSE));
Roger Meier3bef8c22012-10-06 06:58:00 +0000802
Jens Geyerb64a7742013-01-23 20:58:47 +0100803 sa.nLength := SizeOf(sa);
804 sa.lpSecurityDescriptor := sd;
805 sa.bInheritHandle := FALSE;
Roger Meier3bef8c22012-10-06 06:58:00 +0000806
Jens Geyerb64a7742013-01-23 20:58:47 +0100807 // Create an instance of the named pipe
Jens Geyer06045cf2013-03-27 20:26:25 +0200808 result := Windows.CreateNamedPipe( PChar( FPipeName), // pipe name
809 PIPE_ACCESS_DUPLEX or // read/write access
810 FILE_FLAG_OVERLAPPED, // async mode
811 PIPE_TYPE_MESSAGE or // message type pipe
812 PIPE_READMODE_MESSAGE, // message-read mode
813 FMaxConns, // max. instances
814 FBufSize, // output buffer size
815 FBufSize, // input buffer size
816 FTimeout, // time-out, see MSDN
817 @sa); // default security attribute
Roger Meier3bef8c22012-10-06 06:58:00 +0000818
Jens Geyer06045cf2013-03-27 20:26:25 +0200819 if( result <> INVALID_HANDLE_VALUE)
820 then InterlockedExchangePointer( Pointer(FHandle), Pointer(result))
821 else raise TTransportException.Create( TTransportException.TExceptionType.NotOpen,
Jens Geyerb64a7742013-01-23 20:58:47 +0100822 'CreateNamedPipe() failed ' + IntToStr(GetLastError));
823
824 finally
825 if sd <> nil then LocalFree( Cardinal( sd));
826 if acl <> nil then LocalFree( Cardinal( acl));
827 if everyone_sid <> nil then FreeSid(everyone_sid);
Roger Meier3bef8c22012-10-06 06:58:00 +0000828 end;
Roger Meier3bef8c22012-10-06 06:58:00 +0000829end;
830
831
Roger Meier3bef8c22012-10-06 06:58:00 +0000832
833end.
834
835
836