-
-
Notifications
You must be signed in to change notification settings - Fork 324
/
mORMotService.pas
2798 lines (2607 loc) · 99 KB
/
mORMotService.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
/// daemon managment classes for mORMot, including low-level Win NT Service
// - this unit is a part of the freeware Synopse mORMot framework,
// licensed under a MPL/GPL/LGPL tri-license; version 1.18
unit mORMotService;
{
This file is part of Synopse mORMot framework.
Synopse mORMot framework. Copyright (c) Arnaud Bouchez
Synopse Informatique - https://synopse.info
*** BEGIN LICENSE BLOCK *****
Version: MPL 1.1/GPL 2.0/LGPL 2.1
The contents of this file are subject to the Mozilla Public License Version
1.1 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.mozilla.org/MPL
Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
for the specific language governing rights and limitations under the License.
The Original Code is Synopse mORMot framework.
The Initial Developer of the Original Code is Arnaud Bouchez.
Portions created by the Initial Developer are Copyright (c)
the Initial Developer. All Rights Reserved.
Contributor(s):
- Eric Grange
- Leander007
- Maciej Izak (hnb)
Alternatively, the contents of this file may be used under the terms of
either the GNU General Public License Version 2 or later (the "GPL"), or
the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
in which case the provisions of the GPL or the LGPL are applicable instead
of those above. If you wish to allow use of your version of this file only
under the terms of either the GPL or the LGPL, and not to allow others to
use your version of this file under the terms of the MPL, indicate your
decision by deleting the provisions above and replace them with the notice
and other provisions required by the GPL or the LGPL. If you do not delete
the provisions above, a recipient may use your version of this file under
the terms of any one of the MPL, the GPL or the LGPL.
***** END LICENSE BLOCK *****
}
interface
{$I Synopse.inc}
uses
{$ifdef MSWINDOWS}
Windows,
Messages,
{$else}
{$ifdef FPC}
SynFPCLinux,
BaseUnix,
Unix,
{$else}
Types,
LibC, // Kylix
{$endif FPC}
{$endif MSWINDOWS}
Classes,
SysUtils,
{$ifndef LVCL}
Contnrs,
{$endif}
SynCommons,
SynTable,
SynLog,
SynCrypto, // for executable MD5/SHA256 hashes
mORMot; // for TSynJsonFileSettings (i.e. JSON serialization)
{$ifdef MSWINDOWS}
{ *** some minimal Windows API definitions, replacing WinSvc.pas missing for FPC }
const
CM_SERVICE_CONTROL_CODE = WM_USER+1000;
SERVICE_QUERY_CONFIG = $0001;
SERVICE_CHANGE_CONFIG = $0002;
SERVICE_QUERY_STATUS = $0004;
SERVICE_ENUMERATE_DEPENDENTS = $0008;
SERVICE_START = $0010;
SERVICE_STOP = $0020;
SERVICE_PAUSE_CONTINUE = $0040;
SERVICE_INTERROGATE = $0080;
SERVICE_USER_DEFINED_CONTROL = $0100;
SERVICE_ALL_ACCESS = STANDARD_RIGHTS_REQUIRED or
SERVICE_QUERY_CONFIG or
SERVICE_CHANGE_CONFIG or
SERVICE_QUERY_STATUS or
SERVICE_ENUMERATE_DEPENDENTS or
SERVICE_START or
SERVICE_STOP or
SERVICE_PAUSE_CONTINUE or
SERVICE_INTERROGATE or
SERVICE_USER_DEFINED_CONTROL;
SC_MANAGER_CONNECT = $0001;
SC_MANAGER_CREATE_SERVICE = $0002;
SC_MANAGER_ENUMERATE_SERVICE = $0004;
SC_MANAGER_LOCK = $0008;
SC_MANAGER_QUERY_LOCK_STATUS = $0010;
SC_MANAGER_MODIFY_BOOT_CONFIG = $0020;
SC_MANAGER_ALL_ACCESS = STANDARD_RIGHTS_REQUIRED or
SC_MANAGER_CONNECT or
SC_MANAGER_CREATE_SERVICE or
SC_MANAGER_ENUMERATE_SERVICE or
SC_MANAGER_LOCK or
SC_MANAGER_QUERY_LOCK_STATUS or
SC_MANAGER_MODIFY_BOOT_CONFIG;
SERVICE_CONFIG_DESCRIPTION = $0001;
SERVICE_WIN32_OWN_PROCESS = $00000010;
SERVICE_WIN32_SHARE_PROCESS = $00000020;
SERVICE_INTERACTIVE_PROCESS = $00000100;
SERVICE_BOOT_START = $00000000;
SERVICE_SYSTEM_START = $00000001;
SERVICE_AUTO_START = $00000002;
SERVICE_DEMAND_START = $00000003;
SERVICE_DISABLED = $00000004;
SERVICE_ERROR_IGNORE = $00000000;
SERVICE_ERROR_NORMAL = $00000001;
SERVICE_ERROR_SEVERE = $00000002;
SERVICE_ERROR_CRITICAL = $00000003;
SERVICE_CONTROL_STOP = $00000001;
SERVICE_CONTROL_PAUSE = $00000002;
SERVICE_CONTROL_CONTINUE = $00000003;
SERVICE_CONTROL_INTERROGATE = $00000004;
SERVICE_CONTROL_SHUTDOWN = $00000005;
SERVICE_STOPPED = $00000001;
SERVICE_START_PENDING = $00000002;
SERVICE_STOP_PENDING = $00000003;
SERVICE_RUNNING = $00000004;
SERVICE_CONTINUE_PENDING = $00000005;
SERVICE_PAUSE_PENDING = $00000006;
SERVICE_PAUSED = $00000007;
type
PServiceStatus = ^TServiceStatus;
TServiceStatus = object
public
dwServiceType: DWORD;
dwCurrentState: DWORD;
dwControlsAccepted: DWORD;
dwWin32ExitCode: DWORD;
dwServiceSpecificExitCode: DWORD;
dwCheckPoint: DWORD;
dwWaitHint: DWORD;
end;
PServiceStatusProcess = ^TServiceStatusProcess;
TServiceStatusProcess = object(TServiceStatus)
public
dwProcessId: DWORD;
dwServiceFlags: DWORD;
end;
SC_HANDLE = THandle;
SERVICE_STATUS_HANDLE = THandle;
TServiceTableEntry = record
lpServiceName: PChar;
lpServiceProc: procedure(ArgCount: DWORD; Args: PPChar); stdcall;
end;
PServiceTableEntry = ^TServiceTableEntry;
{$Z4}
SC_STATUS_TYPE = (SC_STATUS_PROCESS_INFO);
{$Z1}
function OpenSCManager(lpMachineName, lpDatabaseName: PChar;
dwDesiredAccess: DWORD): SC_HANDLE; stdcall; external advapi32
name 'OpenSCManager'+{$ifdef UNICODE}'W'{$else}'A'{$endif};
function ChangeServiceConfig2(hService: SC_HANDLE; dwsInfoLevel: DWORD;
lpInfo: Pointer): BOOL; stdcall; external advapi32 name 'ChangeServiceConfig2W';
function StartService(hService: SC_HANDLE; dwNumServiceArgs: DWORD;
lpServiceArgVectors: Pointer): BOOL; stdcall; external advapi32
name 'StartService'+{$ifdef UNICODE}'W'{$else}'A'{$endif};
function CreateService(hSCManager: SC_HANDLE; lpServiceName, lpDisplayName: PChar;
dwDesiredAccess, dwServiceType, dwStartType, dwErrorControl: DWORD;
lpBinaryPathName, lpLoadOrderGroup: PChar; lpdwTagId: LPDWORD; lpDependencies,
lpServiceStartName, lpPassword: PChar): SC_HANDLE; stdcall; external advapi32
name 'CreateService'+{$ifdef UNICODE}'W'{$else}'A'{$endif};
function OpenService(hSCManager: SC_HANDLE; lpServiceName: PChar;
dwDesiredAccess: DWORD): SC_HANDLE; stdcall; external advapi32
name 'OpenService'+{$ifdef UNICODE}'W'{$else}'A'{$endif};
function DeleteService(hService: SC_HANDLE): BOOL; stdcall; external advapi32;
function CloseServiceHandle(hSCObject: SC_HANDLE): BOOL; stdcall; external advapi32;
function QueryServiceStatus(hService: SC_HANDLE;
var lpServiceStatus: TServiceStatus): BOOL; stdcall; external advapi32;
function QueryServiceStatusEx(hService: SC_HANDLE;
InfoLevel: SC_STATUS_TYPE; lpBuffer: Pointer; cbBufSize: DWORD;
var pcbBytesNeeded: DWORD): BOOL; stdcall; external advapi32;
function ControlService(hService: SC_HANDLE; dwControl: DWORD;
var lpServiceStatus: TServiceStatus): BOOL; stdcall; external advapi32;
function SetServiceStatus(hServiceStatus: SERVICE_STATUS_HANDLE;
var lpServiceStatus: TServiceStatus): BOOL; stdcall; external advapi32;
function RegisterServiceCtrlHandler(lpServiceName: PChar;
lpHandlerProc: TFarProc): SERVICE_STATUS_HANDLE; stdcall; external advapi32
name 'RegisterServiceCtrlHandler'+{$ifdef UNICODE}'W'{$else}'A'{$endif};
function StartServiceCtrlDispatcher(
lpServiceStartTable: PServiceTableEntry): BOOL; stdcall; external advapi32
name 'StartServiceCtrlDispatcher'+{$ifdef UNICODE}'W'{$else}'A'{$endif};
{ *** high level classes to define and manage Windows Services }
var
/// you can set this global variable to TSynLog or TSQLLog to enable logging
// - default is nil, i.e. disabling logging, since it may interfere with the
// logging process of the service itself
ServiceLog: TSynLogClass;
type
/// all possible states of the service
TServiceState =
(ssNotInstalled, ssStopped, ssStarting, ssStopping, ssRunning,
ssResuming, ssPausing, ssPaused, ssErrorRetrievingState);
/// TServiceControler class is intended to create a new service instance or
// to maintain (that is start, stop, pause, resume...) an existing service
// - to provide the service itself, use the TService class
TServiceController = class
protected
FSCHandle: THandle;
FHandle: THandle;
FStatus: TServiceStatus;
FName: RawUTF8;
private
function GetStatus: TServiceStatus;
function GetState: TServiceState;
public
/// Creates a new service and allows to control it and/or its configuration
// - TargetComputer - set it to empty string if local computer is the target.
// - DatabaseName - set it to empty string if the default database is supposed
// ('ServicesActive').
// - Name - name of a service.
// - DisplayName - display name of a service.
// - Path - a path to binary (executable) of the service created.
// - OrderGroup - an order group name (unnecessary)
// - Dependencies - string containing a list with names of services, which must
// start before (every name should be separated with #0, entire
// list should be separated with #0#0. Or, an empty string can be
// passed if there is no dependancy).
// - Username - login name. For service type SERVICE_WIN32_OWN_PROCESS, the
// account name in the form of "DomainName\Username"; If the account
// belongs to the built-in domain, ".\Username" can be specified;
// Services of type SERVICE_WIN32_SHARE_PROCESS are not allowed to
// specify an account other than LocalSystem. If '' is specified, the
// service will be logged on as the 'LocalSystem' account, in which
// case, the Password parameter must be empty too.
// - Password - a password for login name. If the service type is
// SERVICE_KERNEL_DRIVER or SERVICE_FILE_SYSTEM_DRIVER,
// this parameter is ignored.
// - DesiredAccess - a combination of following flags:
// SERVICE_ALL_ACCESS (default value), SERVICE_CHANGE_CONFIG,
// SERVICE_ENUMERATE_DEPENDENTS, SERVICE_INTERROGATE, SERVICE_PAUSE_CONTINUE,
// SERVICE_QUERY_CONFIG, SERVICE_QUERY_STATUS, SERVICE_START, SERVICE_STOP,
// SERVICE_USER_DEFINED_CONTROL
// - ServiceType - a set of following flags:
// SERVICE_WIN32_OWN_PROCESS (default value, which specifies a Win32 service
// that runs in its own process), SERVICE_WIN32_SHARE_PROCESS,
// SERVICE_KERNEL_DRIVER, SERVICE_FILE_SYSTEM_DRIVER,
// SERVICE_INTERACTIVE_PROCESS (default value, which enables a Win32 service
// process to interact with the desktop)
// - StartType - one of following values:
// SERVICE_BOOT_START, SERVICE_SYSTEM_START,
// SERVICE_AUTO_START (which specifies a device driver or service started by
// the service control manager automatically during system startup),
// SERVICE_DEMAND_START (default value, which specifies a service started by
// a service control manager when a process calls the StartService function,
// that is the TServiceController.Start method), SERVICE_DISABLED
// - ErrorControl - one of following:
// SERVICE_ERROR_IGNORE, SERVICE_ERROR_NORMAL (default value, by which
// the startup program logs the error and displays a message but continues
// the startup operation), SERVICE_ERROR_SEVERE,
// SERVICE_ERROR_CRITICAL
constructor CreateNewService(const TargetComputer, DatabaseName,
Name, DisplayName, Path: string;
const OrderGroup: string = ''; const Dependencies: string = '';
const Username: string = ''; const Password: string = '';
DesiredAccess: DWORD = SERVICE_ALL_ACCESS;
ServiceType: DWORD = SERVICE_WIN32_OWN_PROCESS or SERVICE_INTERACTIVE_PROCESS;
StartType: DWORD = SERVICE_DEMAND_START; ErrorControl: DWORD = SERVICE_ERROR_NORMAL);
/// wrapper around CreateNewService() to install the current executable as service
class function Install(const Name,DisplayName,Description: string;
AutoStart: boolean; ExeName: TFileName=''; Dependencies: string=''): TServiceState;
/// Opens an existing service, in order to control it or its configuration
// from your application. Parameters (strings are unicode-ready since Delphi 2009):
// - TargetComputer - set it to empty string if local computer is the target.
// - DatabaseName - set it to empty string if the default database is supposed
// ('ServicesActive').
// - Name - name of a service.
// - DesiredAccess - a combination of following flags:
// SERVICE_ALL_ACCESS, SERVICE_CHANGE_CONFIG, SERVICE_ENUMERATE_DEPENDENTS,
// SERVICE_INTERROGATE, SERVICE_PAUSE_CONTINUE, SERVICE_QUERY_CONFIG,
// SERVICE_QUERY_STATUS, SERVICE_START, SERVICE_STOP, SERVICE_USER_DEFINED_CONTROL
constructor CreateOpenService(const TargetComputer, DataBaseName, Name: String;
DesiredAccess: DWORD = SERVICE_ALL_ACCESS);
/// release memory and handles
destructor Destroy; override;
/// Handle of SC manager
property SCHandle: THandle read FSCHandle;
/// Handle of service opened or created
// - its value is 0 if something failed in any Create*() method
property Handle: THandle read FHandle;
/// Retrieve the Current status of the service
property Status: TServiceStatus read GetStatus;
/// Retrieve the Current state of the service
property State: TServiceState read GetState;
/// Requests the service to stop
function Stop: boolean;
/// Requests the service to pause
function Pause: boolean;
/// Requests the paused service to resume
function Resume: boolean;
/// Requests the service to update immediately its current status information
// to the service control manager
function Refresh: boolean;
/// Request the service to shutdown
// - this function always return false
function Shutdown: boolean;
/// Removes service from the system, i.e. close the Service
function Delete: boolean;
/// starts the execution of a service with some specified arguments
// - this version expect PChar pointers, either AnsiString (for FPC and old
// Delphi compiler), either UnicodeString (till Delphi 2009)
function Start(const Args: array of PChar): boolean;
/// try to define the description text of this service
procedure SetDescription(const Description: string);
/// this class method will check the command line parameters, and will let
// control the service according to it
// - MyServiceSetup.exe /install will install the service
// - MyServiceSetup.exe /start will start the service
// - MyServiceSetup.exe /stop will stop the service
// - MyServiceSetup.exe /uninstall will uninstall the service
// - so that you can write in the main block of your .dpr:
// !CheckParameters('MyService.exe',HTTPSERVICENAME,HTTPSERVICEDISPLAYNAME);
// - if ExeFileName='', it will install the current executable
// - optional Description and Dependencies text may be specified
class procedure CheckParameters(const ExeFileName: TFileName;
const ServiceName,DisplayName,Description: string; const Dependencies: string='');
end;
{$M+}
TService = class;
{$M-}
/// callback procedure for Windows Service Controller
TServiceControlHandler = procedure(CtrlCode: DWORD); stdcall;
/// event triggered for Control handler
TServiceControlEvent = procedure(Sender: TService; Code: DWORD) of object;
/// event triggered to implement the Service functionality
TServiceEvent = procedure(Sender: TService) of object;
/// TService is the class used to implement a service provided by an application
TService = class
protected
fSName: String;
fDName: String;
fStartType: DWORD;
fServiceType: DWORD;
fData: DWORD;
fControlHandler: TServiceControlHandler;
fOnControl: TServiceControlEvent;
fOnInterrogate: TServiceEvent;
fOnPause: TServiceEvent;
fOnShutdown: TServiceEvent;
fOnStart: TServiceEvent;
fOnExecute: TServiceEvent;
fOnResume: TServiceEvent;
fOnStop: TServiceEvent;
fStatusRec: TServiceStatus;
fArgsList: array of string;
fJumper: PByteArray;
fStatusHandle: THandle;
function GetArgCount: Integer;
function GetArgs(Idx: Integer): String;
function GetInstalled: boolean;
procedure SetStatus(const Value: TServiceStatus);
procedure CtrlHandle(Code: DWORD);
function GetControlHandler: TServiceControlHandler;
procedure SetControlHandler(const Value: TServiceControlHandler);
public
/// this method is the main service entrance, from the OS point of view
// - it will call OnControl/OnStop/OnPause/OnResume/OnShutdown events
// - and report the service status to the system (via ReportStatus method)
procedure DoCtrlHandle(Code: DWORD); virtual;
/// Creates the service
// - the service is added to the internal registered services
// - main application must call the global ServicesRun procedure to actually
// start the services
// - caller must free the TService instance when it's no longer used
constructor Create(const aServiceName, aDisplayName: String); reintroduce; virtual;
/// free memory and release handles
destructor Destroy; override;
/// Reports new status to the system
function ReportStatus(dwState, dwExitCode, dwWait: DWORD): BOOL;
/// Installs the service in the database
// - return true on success
// - create a local TServiceController with the current executable file,
// with the supplied command line parameters
function Install(const Params: string=''): boolean;
/// Removes the service from database
// - uses a local TServiceController with the current Service Name
procedure Remove;
/// Starts the service
// - uses a local TServiceController with the current Service Name
procedure Start;
/// Stops the service
// - uses a local TServiceController with the current Service Name
procedure Stop;
/// this is the main method, in which the Service should implement its run
procedure Execute; virtual;
/// Number of arguments passed to the service by the service controler
property ArgCount: Integer read GetArgCount;
/// List of arguments passed to the service by the service controler
property Args[Idx: Integer]: String read GetArgs;
/// Any data You wish to associate with the service object
property Data: DWORD read FData write FData;
/// Whether service is installed in DataBase
// - uses a local TServiceController to check if the current Service Name exists
property Installed: boolean read GetInstalled;
/// Current service status
// - To report new status to the system, assign another
// value to this record, or use ReportStatus method (preferred)
property Status: TServiceStatus read fStatusRec write SetStatus;
/// Callback handler for Windows Service Controller
// - if handler is not set, then auto generated handler calls DoCtrlHandle
// (note that this auto-generated stubb is... not working yet - so you should
// either set your own procedure to this property, or use TServiceSingle)
// - a typical control handler may be defined as such:
// ! var MyGlobalService: TService;
// !
// ! procedure MyServiceControlHandler(Opcode: LongWord); stdcall;
// ! begin
// ! if MyGlobalService<>nil then
// ! MyGlobalService.DoCtrlHandle(Opcode);
// ! end;
// !
// ! ...
// ! MyGlobalService := TService.Create(...
// ! MyGlobalService.ControlHandler := MyServiceControlHandler;
property ControlHandler: TServiceControlHandler
read GetControlHandler write SetControlHandler;
/// Start event is executed before the main service thread (i.e. in the Execute method)
property OnStart: TServiceEvent read fOnStart write fOnStart;
/// custom Execute event
// - launched in the main service thread (i.e. in the Execute method)
property OnExecute: TServiceEvent read fOnExecute write fOnExecute;
/// custom event triggered when a Control Code is received from Windows
property OnControl: TServiceControlEvent read fOnControl write fOnControl;
/// custom event triggered when the service is stopped
property OnStop: TServiceEvent read fOnStop write fOnStop;
/// custom event triggered when the service is paused
property OnPause: TServiceEvent read fOnPause write fOnPause;
/// custom event triggered when the service is resumed
property OnResume: TServiceEvent read fOnResume write fOnResume;
/// custom event triggered when the service receive an Interrogate
property OnInterrogate: TServiceEvent read fOnInterrogate write fOnInterrogate;
/// custom event triggered when the service is shut down
property OnShutdown: TServiceEvent read fOnShutdown write fOnShutdown;
published
/// Name of the service. Must be unique
property ServiceName: String read fSName;
/// Display name of the service
property DisplayName: String read fDName write fDName;
/// Type of service
property ServiceType: DWORD read fServiceType write fServiceType;
/// Type of start of service
property StartType: DWORD read fStartType write fStartType;
end;
/// inherit from this service if your application has a single service
// - note that TService jumper does not work well - so use this instead
TServiceSingle = class(TService)
public
/// will set a global function as service controller
constructor Create(const aServiceName, aDisplayName: String); override;
/// will release the global service controller
destructor Destroy; override;
end;
var
/// the internal list of Services handled by this unit
// - not to be accessed directly: create TService instances, and they will
// be added/registered to this list
// - then run the global ServicesRun procedure
// - every TService instance is to be freed by the main application, when
// it's no more used
Services: TSynList = nil;
/// the main TService instance running
ServiceSingle: TServiceSingle = nil;
/// launch the registered Services execution
// - the registered list of service provided by the aplication is sent
// to the operating system
// - returns TRUE on success
// - returns FALSE on error (to get extended information, call GetLastError)
function ServicesRun: boolean;
/// convert the Control Code retrieved from Windows into a service state
// enumeration item
function CurrentStateToServiceState(CurrentState: DWORD): TServiceState;
/// return the ready to be displayed text of a TServiceState value
function ServiceStateText(State: TServiceState): string;
/// return service PID
function GetServicePid(const aServiceName: string): DWORD;
/// kill Windows process
function KillProcess(pid: DWORD; waitseconds: integer = 30): boolean;
{$else}
/// low-level function able to properly run or fork the current process
// then execute the start/stop methods of a TSynDaemon / TDDDDaemon instance
// - fork will create a local /run/[ProgramName]-[ProgramPathHash].pid file name
procedure RunUntilSigTerminated(daemon: TObject; dofork: boolean;
const start, stop: TThreadMethod; log: TSynLog = nil; const servicename: string = '');
/// kill a process previously created by RunUntilSigTerminated(dofork=true)
// - will lookup a local /run/[ProgramName]-[ProgramPathHash].pid file name to
// retrieve the actual PID to be killed, then send a SIGTERM, and wait
// waitseconds for the .pid file to disapear
// - returns true on success, false on error (e.g. no valid .pid file or
// the file didn't disappear, which may mean that the daemon is broken)
function RunUntilSigTerminatedForKill(waitseconds: integer = 30): boolean;
/// local .pid file name as created by RunUntilSigTerminated(dofork=true)
function RunUntilSigTerminatedPidFile: TFileName;
var
/// once SynDaemonIntercept has been called, this global variable
// contains the SIGQUIT / SIGTERM / SIGINT received signal
SynDaemonTerminated: integer;
/// enable low-level interception of executable stop signals
// - any SIGQUIT / SIGTERM / SIGINT signal will set appropriately the global
// SynDaemonTerminated variable, with an optional logged entry to log
// - as called e.g. by RunUntilSigTerminated()
// - you can call this method several times with no issue
procedure SynDaemonIntercept(log: TSynLog=nil);
{$endif MSWINDOWS}
type
/// command line patterns recognized by ParseCommandArgs()
TParseCommand = (
pcHasRedirection, pcHasSubCommand, pcHasParenthesis,
pcHasJobControl, pcHasWildcard, pcHasShellVariable,
pcUnbalancedSingleQuote, pcUnbalancedDoubleQuote,
pcTooManyArguments, pcInvalidCommand, pcHasEndingBackSlash);
TParseCommands = set of TParseCommand;
PParseCommands = ^TParseCommands;
/// used to store references of arguments recognized by ParseCommandArgs()
TParseCommandsArgs = array[0..31] of PAnsiChar;
PParseCommandsArgs = ^TParseCommandsArgs;
const
/// identifies some bash-specific processing
PARSECOMMAND_BASH = [pcHasRedirection .. pcHasShellVariable];
/// identifies obvious invalid content
PARSECOMMAND_ERROR = [pcUnbalancedSingleQuote .. pcHasEndingBackSlash];
/// low-level parsing of a RunCommand() execution command
// - parse and fills argv^[0..argc^-1] with corresponding arguments, after
// un-escaping and un-quoting if applicable, using temp^ to store the content
// - if argv=nil, do only the parsing, not the argument extraction - could be
// used for fast validation of the command line syntax
// - you can force arguments OS flavor using the posix parameter - note that
// Windows parsing is not consistent by itself (e.g. double quoting or
// escaping depends on the actual executable called) so returned flags
// should be considered as indicative only with posix=false
function ParseCommandArgs(const cmd: RawUTF8; argv: PParseCommandsArgs = nil;
argc: PInteger = nil; temp: PRawUTF8 = nil;
posix: boolean = {$ifdef MSWINDOWS}false{$else}true{$endif}): TParseCommands;
function ToText(cmd: TParseCommands): shortstring; overload;
{$ifdef HASINLINE}inline;{$endif}
/// like SysUtils.ExecuteProcess, but allowing not to wait for the process to finish
// - optional env value follows 'n1=v1'#0'n2=v2'#0'n3=v3'#0#0 Windows layout
function RunProcess(const path, arg1: TFileName; waitfor: boolean;
const arg2: TFileName=''; const arg3: TFileName=''; const arg4: TFileName='';
const arg5: TFileName=''; const env: TFileName=''; envaddexisting: boolean=false): integer;
/// like fpSystem, but cross-platform
// - under POSIX, calls bash only if needed, after ParseCommandArgs() analysis
// - under Windows (especially Windows 10), creating a process can be dead slow
// https://randomascii.wordpress.com/2019/04/21/on2-in-createprocess
function RunCommand(const cmd: TFileName; waitfor: boolean;
const env: TFileName=''; envaddexisting: boolean=false;
parsed: PParseCommands=nil): integer;
{ *** cross-plaform high-level services/daemons }
type
/// abstract parent containing information able to initialize a TSynDaemon class
// - will handle persistence as JSON local files
// - you may consider using TDDDAppSettingsAbstract from dddInfraSettings
TSynDaemonSettings = class(TSynJsonFileSettings)
protected
fServiceName: string;
fServiceDisplayName: string;
fLog: TSynLogInfos;
fLogPath: TFileName;
fLogRotateFileCount: integer;
fLogClass: TSynLogClass;
fServiceDependencies: string;
public
/// initialize and set the default settings
constructor Create; override;
/// define the log information into the supplied TSynLog class
// - if you don't call this method, the logging won't be initiated
// - is to be called typically in the overriden Create constructor of the
// associated TSynDaemon class, just after "inherited Create"
procedure SetLog(aLogClass: TSynLogClass);
/// returns user-friendly description of the service, including version
// information and company copyright (if available)
function ServiceDescription: string;
/// read-only access to the TSynLog class, if SetLog() has been called
property LogClass: TSynLogClass read fLogClass;
/// optional service dependencies
// - not published by default: could be defined if needed, or e.g. set in
// overriden constructor
// - several depending services may be set by appending #0 between names
property ServiceDependencies: string read fServiceDependencies write fServiceDependencies;
published
/// the service name, as used internally by Windows or the TSynDaemon class
// - default is the executable name
property ServiceName: string read fServiceName write fServiceName;
/// the service name, as displayed by Windows or at the console level
// - default is the executable name
property ServiceDisplayName: string read fServiceDisplayName write fServiceDisplayName;
/// if not void, will enable the logs (default is LOG_STACKTRACE)
property Log: TSynLogInfos read fLog write fLog;
/// allow to customize where the logs should be written
property LogPath: TFileName read fLogPath write fLogPath;
/// how many files will be rotated (default is 2)
property LogRotateFileCount: integer read fLogRotateFileCount write fLogRotateFileCount;
end;
/// meta-class of TSynDaemon settings information
TSynDaemonSettingsClass = class of TSynDaemonSettings;
/// abstract parent to implements a daemon/service
// - inherit from this abstract class and override Start and Stop methods
// - you may consider using TDDDAdministratedDaemon from dddInfraApps
TSynDaemon = class(TSynPersistent)
protected
fConsoleMode: boolean;
fWorkFolderName: TFileName;
fSettings: TSynDaemonSettings;
function CustomCommandLineSyntax: string; virtual;
{$ifdef MSWINDOWS}
procedure DoStart(Sender: TService);
procedure DoStop(Sender: TService);
{$endif}
public
/// initialize the daemon, creating the associated settings
// - TSynDaemonSettings instance will be owned and freed by the daemon
// - any non supplied folder name will be replaced by a default value
// (executable folder under Windows, or /etc /var/log on Linux)
constructor Create(aSettingsClass: TSynDaemonSettingsClass;
const aWorkFolder, aSettingsFolder, aLogFolder: TFileName;
const aSettingsExt: TFileName = '.settings';
const aSettingsName: TFileName = ''); reintroduce;
/// main entry point of the daemon, to process the command line switches
// - aAutoStart is used only under Windows
procedure CommandLine(aAutoStart: boolean=true);
/// inherited class should override this abstract method with proper process
procedure Start; virtual; abstract;
/// inherited class should override this abstract method with proper process
// - should do nothing if the daemon was already stopped
procedure Stop; virtual; abstract;
/// call Stop, finalize the instance, and its settings
destructor Destroy; override;
published
/// if this instance was run as /console or /verb
property ConsoleMode: boolean read fConsoleMode;
/// the settings associated with this daemon
// - will be allocated in Create constructor, and released in Destroy
property Settings: TSynDaemonSettings read fSettings;
end;
{$ifdef MSWINDOWS}
/// Enum synchronized with WinAPI
// - see https://docs.microsoft.com/en-us/windows/desktop/secauthz/privilege-constants
TWinSystemPrivilege = (wspCreateToken, wspAssignPrimaryToken, wspLockMemory,
wspIncreaseQuota, wspUnsolicitedInput, wspMachineAccount, wspTCP, wspSecurity,
wspTakeOwnership, wspLoadDriver, wspSystemProfile, wspSystemTime, wspProfSingleProcess,
wspIncBasePriority, wspCreatePageFile, wspCreatePermanent, wspBackup, wspRestore,
wspShutdown, wspDebug, wspAudit, wspSystemEnvironment, wspChangeNotify,
wspRemoteShutdown, wspUndock, wspSyncAgent, wspEnableDelegation, wspManageVolume,
wspImpersonate, wspCreateGlobal, wspTrustedCredmanAccess, wspRelabel,
wspIncWorkingSet, wspTimeZone, wspCreateSymbolicLink);
TWinSystemPrivileges = set of TWinSystemPrivilege;
TPrivilegeTokenType = (pttProcess, pttThread);
/// object dedicated to management of available privileges for Windows platform
// - not all available privileges are active for process
// - for usage of more advanced WinAPI, explicit enabling of privilege is
// sometimes needed
TSynWindowsPrivileges = object
private
fAvailable: TWinSystemPrivileges;
fEnabled: TWinSystemPrivileges;
fDefEnabled: TWinSystemPrivileges;
function SetPrivilege(aPrivilege: Pointer; aEnablePrivilege: boolean): boolean;
procedure LoadPrivileges;
public
/// handle to privileges token
Token: THandle;
/// initialize the object dedicated to management of available privileges
// - aTokenPrivilege can be used for current process or current thread
procedure Init(aTokenPrivilege: TPrivilegeTokenType = pttProcess);
/// finalize the object and relese Token handle
// - aRestoreInitiallyEnabled parameter can be used to restore initially
// state of enabled privileges
procedure Done(aRestoreInitiallyEnabled: boolean = true);
/// enable privilege
// - if aPrivilege is already enabled return true, if operation is not
// possible (required privilege doesn't exist or API error) return false
function Enable(aPrivilege: TWinSystemPrivilege): boolean;
/// disable privilege
// - if aPrivilege is already disabled return true, if operation is not
// possible (required privilege doesn't exist or API error) return false
function Disable(aPrivilege: TWinSystemPrivilege): boolean;
/// set of available privileges for current process/thread
property Available: TWinSystemPrivileges read fAvailable;
/// set of enabled privileges for current process/thread
property Enabled: TWinSystemPrivileges read fEnabled;
end;
TWinProcessAvailableInfos = set of (wpaiPID, wpaiBasic, wpaiPEB, wpaiCommandLine, wpaiImagePath);
PWinProcessInfo = ^TWinProcessInfo;
TWinProcessInfo = record
AvailableInfo: TWinProcessAvailableInfos;
PID: Cardinal;
ParentPID: Cardinal;
SessionID: Cardinal;
PEBBaseAddress: Pointer;
AffinityMask: Cardinal;
BasePriority: LongInt;
ExitStatus: LongInt;
BeingDebugged: Byte;
ImagePath: SynUnicode;
CommandLine: SynUnicode;
end;
TWinProcessInfoDynArray = array of TWinProcessInfo;
procedure GetProcessInfo(aPid: Cardinal; out aInfo: TWinProcessInfo); overload;
procedure GetProcessInfo(const aPidList: TCardinalDynArray; out aInfo: TWinProcessInfoDynArray); overload;
{$endif MSWINDOWS}
const
/// text identifier typically used before command line switches
// - equals '/' on Windows, and '--' on POSIX systems
CMDLINESWITCH = {$ifdef MSWINDOWS}'/'{$else}'--'{$endif};
implementation
{$ifdef MSWINDOWS}
{ TServiceController }
constructor TServiceController.CreateNewService(const TargetComputer,
DatabaseName,Name,DisplayName,Path,OrderGroup,Dependencies,Username,Password: String;
DesiredAccess,ServiceType,StartType,ErrorControl: DWORD);
var Exe: TFileName;
backupError: cardinal;
begin
inherited Create;
if Path='' then begin
ServiceLog.Add.Log(sllError,'CreateNewService("%","%") with Path=""',
[Name,DisplayName]);
Exit;
end;
if TargetComputer='' then
if GetDriveType(pointer(ExtractFileDrive(Path)))=DRIVE_REMOTE then begin
Exe := ExpandUNCFileName(Path);
if (copy(Exe,1,12)<>'\\localhost\') or (Exe[14]<>'$') then begin
ServiceLog.Add.Log(sllError,'CreateNewService("%","%") on remote drive: Path="%" is %',
[Name,DisplayName,Path,Exe]);
Exit;
end;
system.delete(Exe,1,12); // \\localhost\c$\... -> c:\...
Exe[2] := ':';
end else
Exe := Path;
StringToUTF8(Name,FName);
FSCHandle := OpenSCManager(pointer(TargetComputer), pointer(DatabaseName),
SC_MANAGER_ALL_ACCESS);
if FSCHandle=0 then begin
backupError := GetLastError;
ServiceLog.Add.Log(sllLastError,'OpenSCManager(''%'',''%'') for [%]',
[TargetComputer,DatabaseName,FName]);
SetLastError(backupError);
Exit;
end;
FHandle := CreateService(FSCHandle, pointer(Name), pointer(DisplayName),
DesiredAccess, ServiceType, StartType, ErrorControl, pointer(Exe),
pointer(OrderGroup), nil, pointer(Dependencies),
pointer(Username), pointer(Password));
if FHandle=0 then begin
backupError := GetLastError;
ServiceLog.Add.Log(sllLastError,'CreateService("%","%","%")',[Name,DisplayName,Path]);
SetLastError(backupError);
end;
end;
constructor TServiceController.CreateOpenService(const TargetComputer,
DataBaseName, Name: String; DesiredAccess: DWORD);
var backupError: cardinal;
begin
inherited Create;
StringToUTF8(Name,FName);
FSCHandle := OpenSCManager(pointer(TargetComputer), pointer(DatabaseName),
GENERIC_READ);
if FSCHandle = 0 then begin
backupError := GetLastError;
ServiceLog.Add.Log(sllLastError,'OpenSCManager(''%'',''%'') for [%]',
[TargetComputer,DatabaseName,FName]);
SetLastError(backupError);
Exit;
end;
FHandle := OpenService(FSCHandle, pointer(Name), DesiredAccess);
if FHandle=0 then begin
backupError := GetLastError;
ServiceLog.Add.Log(sllLastError,'OpenService("%")',[Name]);
SetLastError(backupError);
end;
end;
function TServiceController.Delete: boolean;
begin
Result := FALSE;
if FHandle <> 0 then
if DeleteService(FHandle) then begin
Result := CloseServiceHandle(FHandle);
FHandle := 0;
end
else ServiceLog.Add.Log(sllLastError,'DeleteService("%")',[FName]);
end;
destructor TServiceController.Destroy;
begin
if FHandle <> 0 then
CloseServiceHandle(FHandle);
if FSCHandle <> 0 then
CloseServiceHandle(FSCHandle);
inherited;
end;
function TServiceController.GetState: TServiceState;
begin
if (self=nil) or (FSCHandle=0) or (FHandle=0) then
result := ssNotInstalled else
result := CurrentStateToServiceState(Status.dwCurrentState);
ServiceLog.Add.Log(sllTrace,FName,TypeInfo(TServiceState),result,self);
end;
function TServiceController.GetStatus: TServiceStatus;
begin
FillChar(FStatus, Sizeof(FStatus), 0);
QueryServiceStatus(FHandle, FStatus);
Result := FStatus;
end;
function TServiceController.Pause: boolean;
begin
Result := ControlService(FHandle, SERVICE_CONTROL_PAUSE, FStatus);
end;
function TServiceController.Refresh: boolean;
begin
Result := ControlService(FHandle, SERVICE_CONTROL_INTERROGATE, FStatus);
end;
function TServiceController.Resume: boolean;
begin
Result := ControlService(FHandle, SERVICE_CONTROL_CONTINUE, FStatus);
end;
function TServiceController.Shutdown: boolean;
begin
Result := ControlService(FHandle, SERVICE_CONTROL_SHUTDOWN, FStatus);
end;
function TServiceController.Start(const Args: array of PChar): boolean;
begin
if length(Args)=0 then
Result := StartService(FHandle, 0, nil) else
Result := StartService(FHandle, length(Args), @Args[0]);
end;
function TServiceController.Stop: boolean;
begin
Result := ControlService(FHandle, SERVICE_CONTROL_STOP, FStatus);
end;
procedure TServiceController.SetDescription(const Description: string);
var desc: SynUnicode;
begin
if Description='' then
exit;
StringToSynUnicode(Description, desc);
ChangeServiceConfig2(FHandle, SERVICE_CONFIG_DESCRIPTION, @desc);
end;
class procedure TServiceController.CheckParameters(const ExeFileName: TFileName;
const ServiceName, DisplayName, Description, Dependencies: string);
var param: string;
i: integer;
procedure ShowError(const Msg: RawUTF8);
begin
ServiceLog.Add.Log(sllLastError,'During % for %',[Msg,param]);
if not IsConsole then
exit;
{$I-} // ignore if no console has been allocated
writeln(ServiceName,': Error "',Msg,'" for ',param);
ioresult;
{$I+}
end;
begin
for i := 1 to ParamCount do begin
param := SysUtils.LowerCase(paramstr(i));
ServiceLog.Add.Log(sllInfo,'Controling % with command [%]',[ServiceName,param]);
if param='/install' then
TServiceController.Install(
ServiceName,DisplayName,Description,true,ExeFileName,Dependencies) else
with TServiceController.CreateOpenService('','',ServiceName) do
try
if State=ssErrorRetrievingState then
ShowError('State') else
if param='/uninstall' then begin
if not Stop then
ShowError('Stop');
if not Delete then
ShowError('Delete');
end else
if param='/stop' then begin
if not Stop then
ShowError('Stop');
end else
if param='/start' then begin
if not Start([]) then
ShowError('Start');
end;
finally
Free;
end;
end;
end;
class function TServiceController.Install(const Name, DisplayName,
Description: string; AutoStart: boolean; ExeName: TFileName; Dependencies: string): TServiceState;
var ctrl: TServiceController;
start: DWORD;
begin
if AutoStart then
start := SERVICE_AUTO_START else
start := SERVICE_DEMAND_START;
if ExeName='' then
ExeName := ExeVersion.ProgramFileName;
ctrl := TServiceController.CreateNewService('','',Name,DisplayName,ExeName,
'',Dependencies,'','',SERVICE_ALL_ACCESS,SERVICE_WIN32_OWN_PROCESS,start);
try
result := ctrl.State;
if result<>ssNotInstalled then
ctrl.SetDescription(Description);
finally
ctrl.Free;
end;
end;
{ TService }