FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
QuickCore/Quick.Core.Extensions.Service.Windows.pas at master · exilon/QuickCore · GitHub
exilon
/
QuickCore
Public
Notifications
You must be signed in to change notification settings
Fork
38
Star
164
Code
Issues
5
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
QuickCore
/
Quick.Core.Extensions.Service.Windows.pas
Copy path
More file actions
More file actions
Latest commit
History
History
History
485 lines (435 loc) · 14.6 KB
Breadcrumbs
QuickCore
/
Quick.Core.Extensions.Service.Windows.pas
Copy path
File metadata and controls
485 lines (435 loc) · 14.6 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
{
***************************************************************************
Copyright (c) 2016-2021 Kike Pérez
Unit : Quick.Core.Extensions.Service.Windows
Description : Allow run app as Windows service
Author : Kike Pérez
Version : 1.0
Created : 01/07/2021
Modified : 02/08/2021
This file is part of QuickLib: https://github.com/exilon/QuickCore
***************************************************************************
Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
***************************************************************************
}
unit
Quick.Core.Extensions.Service.Windows;
{
$i QuickLib.inc
}
interface
uses
System.SysUtils,
Windows,
Quick.Console,
{
$IFNDEF FPC
}
WinSvc,
{
$ENDIF
}
Registry,
Quick.Commons,
Quick.Core.Commandline,
Quick.Core.Extensions.Service.Abstractions;
const
DEF_SERVICENAME =
'
QuickCoreService
'
;
DEF_DISPLAYNAME =
'
QuickCoreService
'
;
NUM_OF_SERVICES =
2
;
type
TSvcStatus = (ssStopped = SERVICE_STOPPED,
ssStopping = SERVICE_STOP_PENDING,
ssStartPending = SERVICE_START_PENDING,
ssRunning = SERVICE_RUNNING,
ssPaused = SERVICE_PAUSED);
TSvcStartType = (stAuto = SERVICE_AUTO_START,
stManual = SERVICE_DEMAND_START,
stDisabled = SERVICE_DISABLED);
TWindowsHostService =
class
(THostService)
private
fParameters : TServiceParameters;
fSCMHandle : SC_HANDLE;
fSvHandle : SC_HANDLE;
fServiceName : string;
fDisplayName : string;
fWaitForKeyOnExit : Boolean;
fLoadOrderGroup : string;
fDependencies : string;
fDesktopInteraction : Boolean;
fUserName : string;
fUserPass : string;
fStartType : TSvcStartType;
fFileName : string;
fSilent : Boolean;
fStatus : TSvcStatus;
fCanInstallWithOtherName : Boolean;
fAfterRemove : TSvcRemoveEvent;
procedure
Execute
;
procedure
ReportSvcStatus
(dwCurrentState, dwWin32ExitCode, dwWaitHint: DWORD);
procedure
AddServiceDescription
;
public
constructor
Create;
destructor
Destroy; override;
property
DisplayName : string read fDisplayName write fDisplayName;
property
LoadOrderGroup : string read fLoadOrderGroup write fLoadOrderGroup;
property
Dependencies : string read fDependencies write fDependencies;
property
DesktopInteraction : Boolean read fDesktopInteraction write fDesktopInteraction;
property
UserName : string read fUserName write fUserName;
property
UserPass : string read fUserPass write fUserPass;
property
StartType : TSvcStartType read fStartType write fStartType;
property
FileName : string read fFileName;
property
Silent : Boolean read fSilent write fSilent;
property
CanInstallWithOtherName : Boolean read fCanInstallWithOtherName write fCanInstallWithOtherName;
property
Status : TSvcStatus read fStatus write fStatus;
property
AfterRemove : TSvcRemoveEvent read fAfterRemove write fAfterRemove;
procedure
Install
; override;
procedure
Remove
; override;
function
CheckParams
: Boolean; override;
function
InstallParamsPresent
: Boolean;
function
ConsoleParamPresent
: Boolean;
function
IsRunningAsService
: Boolean; override;
function
IsRunningAsConsole
: Boolean;
procedure
Start
; override;
procedure
Stop
; override;
end
;
var
ServiceStatus : TServiceStatus;
StatusHandle : SERVICE_STATUS_HANDLE;
ServiceTable :
array
[
0
..NUM_OF_SERVICES]
of
TServiceTableEntry;
ghSvcStopEvent: Cardinal;
AppService : TWindowsHostService;
implementation
constructor
TWindowsHostService.Create;
var
i : Integer;
parm : string;
parameters : string;
begin
fParameters := TServiceParameters.Create(False);
fServiceName := DEF_SERVICENAME;
fDisplayName := DEF_DISPLAYNAME;
fWaitForKeyOnExit := False;
fLoadOrderGroup :=
'
'
;
fDependencies :=
'
'
;
fDesktopInteraction := False;
UserName :=
'
'
;
fUserPass :=
'
'
;
fStartType := TSvcStartType.stAuto;
fFileName := ParamStr(
0
);
parameters :=
'
'
;
for
i :=
1
to
ParamCount -
1
do
begin
parm := ParamStr(i);
if
(parm.ToLower <>
'
/install
'
)
and
(parm.ToLower <>
'
/remove
'
)
and
(
not
parm.ToLower.StartsWith(
'
/instance:
'
))
then
begin
parameters := parameters +
'
'
+ parm;
end
;
end
;
if
not
parameters.IsEmpty
then
fFileName := Format(
'
"%s" %s
'
,[fFilename,parameters]);
fSilent := True;
fStatus := TSvcStatus.ssStopped;
fCanInstallWithOtherName := False;
OnExecute :=
nil
;
IsQuickServiceApp := True;
end
;
destructor
TWindowsHostService.Destroy;
begin
OnStart :=
nil
;
OnStop :=
nil
;
OnExecute :=
nil
;
if
fSCMHandle <>
0
then
CloseServiceHandle(fSCMHandle);
if
fSvHandle <>
0
then
CloseServiceHandle(fSvHandle);
if
Assigned(fParameters)
then
fParameters.Free;
fParameters :=
nil
;
inherited
;
end
;
procedure
ServiceCtrlHandler
(Control: DWORD); stdcall;
begin
case
Control
of
SERVICE_CONTROL_STOP:
begin
AppService.Status := TSvcStatus.ssStopping;
SetEvent(ghSvcStopEvent);
ServiceStatus.dwCurrentState := SERVICE_STOP_PENDING;
SetServiceStatus(StatusHandle, ServiceStatus);
end
;
SERVICE_CONTROL_PAUSE:
begin
AppService.Status := TSvcStatus.ssPaused;
ServiceStatus.dwcurrentstate := SERVICE_PAUSED;
SetServiceStatus(StatusHandle, ServiceStatus);
end
;
SERVICE_CONTROL_CONTINUE:
begin
AppService.Status := TSvcStatus.ssRunning;
ServiceStatus.dwCurrentState := SERVICE_RUNNING;
SetServiceStatus(StatusHandle, ServiceStatus);
end
;
SERVICE_CONTROL_INTERROGATE: SetServiceStatus(StatusHandle, ServiceStatus);
SERVICE_CONTROL_SHUTDOWN:
begin
AppService.Status := TSvcStatus.ssStopped;
AppService.Stop;
end
;
end
;
end
;
procedure
RegisterService
(dwArgc: DWORD;
var
lpszArgv: PChar); stdcall;
begin
ServiceStatus.dwServiceType := SERVICE_WIN32_OWN_PROCESS;
ServiceStatus.dwCurrentState := SERVICE_START_PENDING;
ServiceStatus.dwControlsAccepted := SERVICE_ACCEPT_STOP
or
SERVICE_ACCEPT_PAUSE_CONTINUE;
ServiceStatus.dwServiceSpecificExitCode :=
0
;
ServiceStatus.dwWin32ExitCode :=
0
;
ServiceStatus.dwCheckPoint :=
0
;
ServiceStatus.dwWaitHint :=
0
;
StatusHandle := RegisterServiceCtrlHandler(PChar(AppService.ServiceName), @ServiceCtrlHandler);
if
StatusHandle <>
0
then
begin
AppService.ReportSvcStatus(SERVICE_RUNNING, NO_ERROR,
0
);
try
AppService.Status := TSvcStatus.ssRunning;
AppService.Execute;
finally
AppService.ReportSvcStatus(SERVICE_STOPPED, NO_ERROR,
0
);
end
;
end
;
end
;
procedure
TWindowsHostService.ReportSvcStatus
(dwCurrentState, dwWin32ExitCode, dwWaitHint: DWORD);
begin
//
fill in the SERVICE_STATUS structure
ServiceStatus.dwCurrentState := dwCurrentState;
ServiceStatus.dwWin32ExitCode := dwWin32ExitCode;
ServiceStatus.dwWaitHint := dwWaitHint;
if
dwCurrentState = SERVICE_START_PENDING
then
ServiceStatus.dwControlsAccepted :=
0
else
ServiceStatus.dwControlsAccepted := SERVICE_ACCEPT_STOP;
case
(dwCurrentState = SERVICE_RUNNING)
or
(dwCurrentState = SERVICE_STOPPED)
of
True: ServiceStatus.dwCheckPoint :=
0
;
False: ServiceStatus.dwCheckPoint :=
1
;
end
;
//
report service status to SCM
SetServiceStatus(StatusHandle,ServiceStatus);
end
;
procedure
TWindowsHostService.Start
;
begin
//
initialize as console
if
not
IsRunningAsService
then
begin
if
Assigned(OnInitialize)
then
OnInitialize;
if
Assigned(OnStart)
then
OnStart;
if
Assigned(OnExecute)
then
OnExecute;
if
WaitForKeyOnExit
then
ConsoleWaitForEnterKey;
end
else
begin
//
initialize as a service
if
Assigned(OnInitialize)
then
OnInitialize;
ServiceTable[
0
].lpServiceName := PChar(ServiceName);
ServiceTable[
0
].lpServiceProc := @RegisterService;
ServiceTable[
1
].lpServiceName :=
nil
;
ServiceTable[
1
].lpServiceProc :=
nil
;
{
$IFDEF FPC
}
StartServiceCtrlDispatcher(@ServiceTable[
0
]);
{
$ELSE
}
StartServiceCtrlDispatcher(ServiceTable[
0
]);
{
$ENDIF
}
end
;
end
;
procedure
TWindowsHostService.Stop
;
begin
if
Assigned(OnStop)
then
OnStop;
end
;
procedure
TWindowsHostService.Execute
;
begin
//
we have to do something or service will stop
ghSvcStopEvent := CreateEvent(
nil
,True,False,
nil
);
if
ghSvcStopEvent =
0
then
begin
ReportSvcStatus(SERVICE_STOPPED,NO_ERROR,
0
);
Exit;
end
;
if
Assigned(OnStart)
then
OnStart;
//
report running status when initialization is complete
ReportSvcStatus(SERVICE_RUNNING,NO_ERROR,
0
);
//
perform work until service stops
while
True
do
begin
//
external callback process
if
Assigned(OnExecute)
then
OnExecute;
//
check whether to stop the service.
WaitForSingleObject(ghSvcStopEvent,INFINITE);
ReportSvcStatus(SERVICE_STOPPED,NO_ERROR,
0
);
Exit;
end
;
end
;
procedure
TWindowsHostService.Remove
;
const
cRemoveMsg =
'
Service "%s" removed successfully!
'
;
var
SCManager: SC_HANDLE;
Service: SC_HANDLE;
begin
SCManager := OpenSCManager(
nil
,
nil
, SC_MANAGER_ALL_ACCESS);
if
SCManager =
0
then
Exit;
try
Service := OpenService(SCManager,PChar(ServiceName),SERVICE_ALL_ACCESS);
ControlService(Service,SERVICE_CONTROL_STOP,ServiceStatus);
DeleteService(Service);
CloseServiceHandle(Service);
if
fSilent
then
Writeln(Format(cRemoveMsg,[ServiceName]))
else
MessageBox(
0
,PChar(Format(cRemoveMsg,[ServiceName])),PChar(ServiceName),MB_ICONINFORMATION
or
MB_OK
or
MB_TASKMODAL
or
MB_TOPMOST);
finally
CloseServiceHandle(SCManager);
if
Assigned(fAfterRemove)
then
fAfterRemove;
end
;
end
;
procedure
TWindowsHostService.Install
;
const
cInstallMsg =
'
Service "%s" installed successfully!
'
;
cSCMError =
'
Error trying to open SC Manager (you need admin permissions?)
'
;
var
servicetype : Cardinal;
svcloadgroup : PChar;
svcdependencies : PChar;
svcusername : PChar;
svcuserpass : PChar;
begin
fSCMHandle := OpenSCManager(
nil
,
nil
,SC_MANAGER_ALL_ACCESS);
if
fSCMHandle =
0
then
begin
if
fSilent
then
Writeln(cSCMError)
else
MessageBox(
0
,cSCMError,PChar(ServiceName),MB_ICONERROR
or
MB_OK
or
MB_TASKMODAL
or
MB_TOPMOST);
Exit;
end
;
//
service interacts with desktop
if
fDesktopInteraction
then
servicetype := SERVICE_WIN32_OWN_PROCESS
and
SERVICE_INTERACTIVE_PROCESS
else
servicetype := SERVICE_WIN32_OWN_PROCESS;
//
service load order
if
fLoadOrderGroup.IsEmpty
then
svcloadgroup :=
nil
else
svcloadgroup := PChar(fLoadOrderGroup);
//
service dependencies
if
fDependencies.IsEmpty
then
svcdependencies :=
nil
else
svcdependencies := PChar(fDependencies);
//
service user name
if
UserName.IsEmpty
then
svcusername :=
nil
else
svcusername := PChar(UserName);
//
service user password
if
fUserPass.IsEmpty
then
svcuserpass :=
nil
else
svcuserpass := PChar(fUserPass);
fSvHandle := CreateService(fSCMHandle,
PChar(ServiceName),
PChar(fDisplayName),
SERVICE_ALL_ACCESS,
servicetype,
Cardinal(fStartType),
SERVICE_ERROR_NORMAL,
PChar(fFileName),
svcloadgroup,
nil
,
svcdependencies,
svcusername,
//
user
svcuserpass);
//
password
if
fSvHandle <>
0
then
begin
AddServiceDescription;
if
fSilent
then
Writeln(Format(cInstallMsg,[ServiceName]))
else
MessageBox(
0
,PChar(Format(cInstallMsg,[ServiceName])),PChar(ServiceName),MB_ICONINFORMATION
or
MB_OK
or
MB_TASKMODAL
or
MB_TOPMOST);
end
else
begin
if
fSilent
then
Writeln(cSCMError)
else
MessageBox(
0
,cSCMError,PChar(ServiceName),MB_ICONERROR
or
MB_OK
or
MB_TASKMODAL
or
MB_TOPMOST);
Exit;
end
;
end
;
procedure
TWindowsHostService.AddServiceDescription
;
var
reg : TRegistry;
begin
reg := TRegistry.Create(KEY_READ
or
KEY_WRITE);
try
reg.RootKey := HKEY_LOCAL_MACHINE;
if
reg.OpenKey(
'
\SYSTEM\CurrentControlSet\Services\
'
+ ServiceName,False)
then
begin
reg.WriteString(
'
Description
'
,Description);
reg.CloseKey;
end
;
finally
reg.Free;
end
;
end
;
function
TWindowsHostService.CheckParams
: Boolean;
begin
Result := False;
fParameters.Description := Description;
if
ParamCount >
0
then
begin
fSilent := fParameters.Silent;
//
if fParameters.Help then
//
begin
//
fParameters.ShowHelp;
//
Result := True;
//
end
//
else
if
fParameters.Install
then
begin
if
fCanInstallWithOtherName
then
begin
if
fParameters.ExistsParam(
'
instance
'
)
then
begin
if
fParameters.Instance.IsEmpty
then
raise Exception.Create(
'
Service instance name not defined!
'
);
ServiceName := fParameters.Instance;
fDisplayName := fParameters.Instance;
end
;
end
;
Install;
Result := True;
end
else
if
fParameters.Remove
then
begin
if
fCanInstallWithOtherName
then
begin
if
fParameters.ExistsParam(
'
instance
'
)
then
begin
if
fParameters.Instance.IsEmpty
then
raise Exception.Create(
'
Service instance name not defined!
'
);
ServiceName := fParameters.Instance;
fDisplayName := fParameters.Instance;
end
;
end
;
Remove;
Result := True;
end
else
if
fParameters.Console
then
Writeln(
'
Forced console mode
'
);
end
;
//
else
//
begin
//
//Writeln('Unknow parameter specified!');
//
end;
//
if fSkipRun then
//
begin
//
if Assigned(OnStop) then OnStop;
//
Halt;
//
end;
end
;
function
TWindowsHostService.ConsoleParamPresent
: Boolean;
begin
Result := fParameters.Console;
end
;
function
TWindowsHostService.InstallParamsPresent
: Boolean;
begin
Result := (fParameters.Install
or
fParameters.Remove
or
fParameters.Help);
end
;
function
TWindowsHostService.IsRunningAsService
: Boolean;
begin
Result := (IsService
and
not
ConsoleParamPresent)
and
(
not
InstallParamsPresent);
end
;
function
TWindowsHostService.IsRunningAsConsole
: Boolean;
begin
Result := (
not
IsService)
or
(ConsoleParamPresent);
end
;
initialization
AppService := TWindowsHostService.Create;
finalization
//
if Assigned(AppService) then AppService.Free;
end
.
Back
|
FazBrowse Home
|
New Git URL