registry.cpp 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817
  1. #include "nssm.h"
  2. extern const TCHAR *exit_action_strings[];
  3. int create_messages() {
  4. HKEY key;
  5. TCHAR registry[KEY_LENGTH];
  6. if (_sntprintf_s(registry, _countof(registry), _TRUNCATE, _T("SYSTEM\\CurrentControlSet\\Services\\EventLog\\Application\\%s"), NSSM) < 0) {
  7. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("eventlog registry"), _T("create_messages()"), 0);
  8. return 1;
  9. }
  10. if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, KEY_WRITE, 0, &key, 0) != ERROR_SUCCESS) {
  11. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);
  12. return 2;
  13. }
  14. /* Get path of this program */
  15. const TCHAR *path = nssm_imagepath();
  16. /* Try to register the module but don't worry so much on failure */
  17. RegSetValueEx(key, _T("EventMessageFile"), 0, REG_SZ, (const unsigned char *) path, (unsigned long) (_tcslen(path) + 1) * sizeof(TCHAR));
  18. unsigned long types = EVENTLOG_INFORMATION_TYPE | EVENTLOG_WARNING_TYPE | EVENTLOG_ERROR_TYPE;
  19. RegSetValueEx(key, _T("TypesSupported"), 0, REG_DWORD, (const unsigned char *) &types, sizeof(types));
  20. return 0;
  21. }
  22. int create_parameters(nssm_service_t *service, bool editing) {
  23. /* Try to open the registry */
  24. HKEY key = open_registry(service->name, KEY_WRITE);
  25. if (! key) return 1;
  26. /* Try to create the parameters */
  27. if (set_expand_string(key, NSSM_REG_EXE, service->exe)) {
  28. RegDeleteKey(HKEY_LOCAL_MACHINE, NSSM_REGISTRY);
  29. RegCloseKey(key);
  30. return 2;
  31. }
  32. if (set_expand_string(key, NSSM_REG_FLAGS, service->flags)) {
  33. RegDeleteKey(HKEY_LOCAL_MACHINE, NSSM_REGISTRY);
  34. RegCloseKey(key);
  35. return 3;
  36. }
  37. if (set_expand_string(key, NSSM_REG_DIR, service->dir)) {
  38. RegDeleteKey(HKEY_LOCAL_MACHINE, NSSM_REGISTRY);
  39. RegCloseKey(key);
  40. return 4;
  41. }
  42. /* Other non-default parameters. May fail. */
  43. if (service->priority != NORMAL_PRIORITY_CLASS) set_number(key, NSSM_REG_PRIORITY, service->priority);
  44. else if (editing) RegDeleteValue(key, NSSM_REG_PRIORITY);
  45. if (service->affinity) {
  46. TCHAR *string;
  47. if (! affinity_mask_to_string(service->affinity, &string)) {
  48. if (RegSetValueEx(key, NSSM_REG_AFFINITY, 0, REG_SZ, (const unsigned char *) string, (unsigned long) (_tcslen(string) + 1) * sizeof(TCHAR)) != ERROR_SUCCESS) {
  49. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_AFFINITY, error_string(GetLastError()), 0);
  50. HeapFree(GetProcessHeap(), 0, string);
  51. return 5;
  52. }
  53. }
  54. if (string) HeapFree(GetProcessHeap(), 0, string);
  55. }
  56. else if (editing) RegDeleteValue(key, NSSM_REG_AFFINITY);
  57. unsigned long stop_method_skip = ~service->stop_method;
  58. if (stop_method_skip) set_number(key, NSSM_REG_STOP_METHOD_SKIP, stop_method_skip);
  59. else if (editing) RegDeleteValue(key, NSSM_REG_STOP_METHOD_SKIP);
  60. if (service->default_exit_action < NSSM_NUM_EXIT_ACTIONS) create_exit_action(service->name, exit_action_strings[service->default_exit_action], editing);
  61. if (service->restart_delay) set_number(key, NSSM_REG_RESTART_DELAY, service->restart_delay);
  62. else if (editing) RegDeleteValue(key, NSSM_REG_RESTART_DELAY);
  63. if (service->throttle_delay != NSSM_RESET_THROTTLE_RESTART) set_number(key, NSSM_REG_THROTTLE, service->throttle_delay);
  64. else if (editing) RegDeleteValue(key, NSSM_REG_THROTTLE);
  65. if (service->kill_console_delay != NSSM_KILL_CONSOLE_GRACE_PERIOD) set_number(key, NSSM_REG_KILL_CONSOLE_GRACE_PERIOD, service->kill_console_delay);
  66. else if (editing) RegDeleteValue(key, NSSM_REG_KILL_CONSOLE_GRACE_PERIOD);
  67. if (service->kill_window_delay != NSSM_KILL_WINDOW_GRACE_PERIOD) set_number(key, NSSM_REG_KILL_WINDOW_GRACE_PERIOD, service->kill_window_delay);
  68. else if (editing) RegDeleteValue(key, NSSM_REG_KILL_WINDOW_GRACE_PERIOD);
  69. if (service->kill_threads_delay != NSSM_KILL_THREADS_GRACE_PERIOD) set_number(key, NSSM_REG_KILL_THREADS_GRACE_PERIOD, service->kill_threads_delay);
  70. else if (editing) RegDeleteValue(key, NSSM_REG_KILL_THREADS_GRACE_PERIOD);
  71. if (! service->kill_process_tree) set_number(key, NSSM_REG_KILL_PROCESS_TREE, 0);
  72. else if (editing) RegDeleteValue(key, NSSM_REG_KILL_PROCESS_TREE);
  73. if (service->stdin_path[0] || editing) {
  74. if (service->stdin_path[0]) set_expand_string(key, NSSM_REG_STDIN, service->stdin_path);
  75. else if (editing) RegDeleteValue(key, NSSM_REG_STDIN);
  76. if (service->stdin_sharing != NSSM_STDIN_SHARING) set_createfile_parameter(key, NSSM_REG_STDIN, NSSM_REG_STDIO_SHARING, service->stdin_sharing);
  77. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDIN, NSSM_REG_STDIO_SHARING);
  78. if (service->stdin_disposition != NSSM_STDIN_DISPOSITION) set_createfile_parameter(key, NSSM_REG_STDIN, NSSM_REG_STDIO_DISPOSITION, service->stdin_disposition);
  79. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDIN, NSSM_REG_STDIO_DISPOSITION);
  80. if (service->stdin_flags != NSSM_STDIN_FLAGS) set_createfile_parameter(key, NSSM_REG_STDIN, NSSM_REG_STDIO_FLAGS, service->stdin_flags);
  81. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDIN, NSSM_REG_STDIO_FLAGS);
  82. }
  83. if (service->stdout_path[0] || editing) {
  84. if (service->stdout_path[0]) set_expand_string(key, NSSM_REG_STDOUT, service->stdout_path);
  85. else if (editing) RegDeleteValue(key, NSSM_REG_STDOUT);
  86. if (service->stdout_sharing != NSSM_STDOUT_SHARING) set_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_SHARING, service->stdout_sharing);
  87. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_SHARING);
  88. if (service->stdout_disposition != NSSM_STDOUT_DISPOSITION) set_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_DISPOSITION, service->stdout_disposition);
  89. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_DISPOSITION);
  90. if (service->stdout_flags != NSSM_STDOUT_FLAGS) set_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_FLAGS, service->stdout_flags);
  91. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_FLAGS);
  92. if (service->stdout_copy_and_truncate) set_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_COPY_AND_TRUNCATE, 1);
  93. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_COPY_AND_TRUNCATE);
  94. }
  95. if (service->stderr_path[0] || editing) {
  96. if (service->stderr_path[0]) set_expand_string(key, NSSM_REG_STDERR, service->stderr_path);
  97. else if (editing) RegDeleteValue(key, NSSM_REG_STDERR);
  98. if (service->stderr_sharing != NSSM_STDERR_SHARING) set_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_SHARING, service->stderr_sharing);
  99. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_SHARING);
  100. if (service->stderr_disposition != NSSM_STDERR_DISPOSITION) set_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_DISPOSITION, service->stderr_disposition);
  101. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_DISPOSITION);
  102. if (service->stderr_flags != NSSM_STDERR_FLAGS) set_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_FLAGS, service->stderr_flags);
  103. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_FLAGS);
  104. if (service->stderr_copy_and_truncate) set_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_COPY_AND_TRUNCATE, 1);
  105. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_COPY_AND_TRUNCATE);
  106. }
  107. if (service->rotate_files) set_number(key, NSSM_REG_ROTATE, 1);
  108. else if (editing) RegDeleteValue(key, NSSM_REG_ROTATE);
  109. if (service->rotate_stdout_online) set_number(key, NSSM_REG_ROTATE_ONLINE, 1);
  110. else if (editing) RegDeleteValue(key, NSSM_REG_ROTATE_ONLINE);
  111. if (service->rotate_seconds) set_number(key, NSSM_REG_ROTATE_SECONDS, service->rotate_seconds);
  112. else if (editing) RegDeleteValue(key, NSSM_REG_ROTATE_SECONDS);
  113. if (service->rotate_bytes_low) set_number(key, NSSM_REG_ROTATE_BYTES_LOW, service->rotate_bytes_low);
  114. else if (editing) RegDeleteValue(key, NSSM_REG_ROTATE_BYTES_LOW);
  115. if (service->rotate_bytes_high) set_number(key, NSSM_REG_ROTATE_BYTES_HIGH, service->rotate_bytes_high);
  116. else if (editing) RegDeleteValue(key, NSSM_REG_ROTATE_BYTES_HIGH);
  117. if (service->rotate_delay != NSSM_ROTATE_DELAY) set_number(key, NSSM_REG_ROTATE_DELAY, service->rotate_delay);
  118. else if (editing) RegDeleteValue(key, NSSM_REG_ROTATE_DELAY);
  119. if (service->no_console) set_number(key, NSSM_REG_NO_CONSOLE, 1);
  120. else if (editing) RegDeleteValue(key, NSSM_REG_NO_CONSOLE);
  121. /* Environment */
  122. if (service->env) {
  123. if (RegSetValueEx(key, NSSM_REG_ENV, 0, REG_MULTI_SZ, (const unsigned char *) service->env, (unsigned long) service->envlen * sizeof(TCHAR)) != ERROR_SUCCESS) {
  124. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_ENV, error_string(GetLastError()), 0);
  125. }
  126. }
  127. else if (editing) RegDeleteValue(key, NSSM_REG_ENV);
  128. if (service->env_extra) {
  129. if (RegSetValueEx(key, NSSM_REG_ENV_EXTRA, 0, REG_MULTI_SZ, (const unsigned char *) service->env_extra, (unsigned long) service->env_extralen * sizeof(TCHAR)) != ERROR_SUCCESS) {
  130. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_ENV_EXTRA, error_string(GetLastError()), 0);
  131. }
  132. }
  133. else if (editing) RegDeleteValue(key, NSSM_REG_ENV_EXTRA);
  134. /* Close registry. */
  135. RegCloseKey(key);
  136. return 0;
  137. }
  138. int create_exit_action(TCHAR *service_name, const TCHAR *action_string, bool editing) {
  139. /* Get registry */
  140. TCHAR registry[KEY_LENGTH];
  141. if (_sntprintf_s(registry, _countof(registry), _TRUNCATE, NSSM_REGISTRY _T("\\%s"), service_name, NSSM_REG_EXIT) < 0) {
  142. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("NSSM_REG_EXIT"), _T("create_exit_action()"), 0);
  143. return 1;
  144. }
  145. /* Try to open the registry */
  146. HKEY key;
  147. unsigned long disposition;
  148. if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, KEY_WRITE, 0, &key, &disposition) != ERROR_SUCCESS) {
  149. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);
  150. return 2;
  151. }
  152. /* Do nothing if the key already existed */
  153. if (disposition == REG_OPENED_EXISTING_KEY && ! editing) {
  154. RegCloseKey(key);
  155. return 0;
  156. }
  157. /* Create the default value */
  158. if (RegSetValueEx(key, 0, 0, REG_SZ, (const unsigned char *) action_string, (unsigned long) (_tcslen(action_string) + 1) * sizeof(TCHAR)) != ERROR_SUCCESS) {
  159. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_EXIT, error_string(GetLastError()), 0);
  160. RegCloseKey(key);
  161. return 3;
  162. }
  163. /* Close registry */
  164. RegCloseKey(key);
  165. return 0;
  166. }
  167. int get_environment(TCHAR *service_name, HKEY key, TCHAR *value, TCHAR **env, unsigned long *envlen) {
  168. unsigned long type = REG_MULTI_SZ;
  169. /* Dummy test to find buffer size */
  170. unsigned long ret = RegQueryValueEx(key, value, 0, &type, NULL, envlen);
  171. if (ret != ERROR_SUCCESS) {
  172. *env = 0;
  173. *envlen = 0;
  174. /* The service probably doesn't have any environment configured */
  175. if (ret == ERROR_FILE_NOT_FOUND) return 0;
  176. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);
  177. return 1;
  178. }
  179. if (type != REG_MULTI_SZ) {
  180. *env = 0;
  181. *envlen = 0;
  182. log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_INVALID_ENVIRONMENT_STRING_TYPE, value, service_name, 0);
  183. return 2;
  184. }
  185. /* Probably not possible */
  186. if (! *envlen) return 0;
  187. /* Previously initialised? */
  188. if (*env) HeapFree(GetProcessHeap(), 0, *env);
  189. *env = (TCHAR *) HeapAlloc(GetProcessHeap(), 0, *envlen);
  190. if (! *env) {
  191. *envlen = 0;
  192. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, value, _T("get_environment()"), 0);
  193. return 3;
  194. }
  195. /* Actually get the strings */
  196. ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) *env, envlen);
  197. if (ret != ERROR_SUCCESS) {
  198. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);
  199. HeapFree(GetProcessHeap(), 0, *env);
  200. *env = 0;
  201. *envlen = 0;
  202. return 4;
  203. }
  204. return 0;
  205. }
  206. int get_string(HKEY key, TCHAR *value, TCHAR *data, unsigned long datalen, bool expand, bool sanitise, bool must_exist) {
  207. TCHAR *buffer = (TCHAR *) HeapAlloc(GetProcessHeap(), 0, datalen);
  208. if (! buffer) {
  209. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, value, _T("get_string()"), 0);
  210. return 1;
  211. }
  212. ZeroMemory(data, datalen);
  213. unsigned long type = REG_EXPAND_SZ;
  214. unsigned long buflen = datalen;
  215. unsigned long ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) buffer, &buflen);
  216. if (ret != ERROR_SUCCESS) {
  217. unsigned long error = GetLastError();
  218. HeapFree(GetProcessHeap(), 0, buffer);
  219. if (ret == ERROR_FILE_NOT_FOUND) {
  220. if (! must_exist) return 0;
  221. }
  222. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(error), 0);
  223. return 2;
  224. }
  225. /* Paths aren't allowed to contain quotes. */
  226. if (sanitise) PathUnquoteSpaces(buffer);
  227. /* Do we want to expand the string? */
  228. if (! expand) {
  229. if (type == REG_EXPAND_SZ) type = REG_SZ;
  230. }
  231. /* Technically we shouldn't expand environment strings from REG_SZ values */
  232. if (type != REG_EXPAND_SZ) {
  233. memmove(data, buffer, buflen);
  234. HeapFree(GetProcessHeap(), 0, buffer);
  235. return 0;
  236. }
  237. ret = ExpandEnvironmentStrings((TCHAR *) buffer, data, datalen);
  238. if (! ret || ret > datalen) {
  239. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_EXPANDENVIRONMENTSTRINGS_FAILED, buffer, error_string(GetLastError()), 0);
  240. HeapFree(GetProcessHeap(), 0, buffer);
  241. return 3;
  242. }
  243. HeapFree(GetProcessHeap(), 0, buffer);
  244. return 0;
  245. }
  246. int get_string(HKEY key, TCHAR *value, TCHAR *data, unsigned long datalen, bool sanitise) {
  247. return get_string(key, value, data, datalen, false, sanitise, true);
  248. }
  249. int expand_parameter(HKEY key, TCHAR *value, TCHAR *data, unsigned long datalen, bool sanitise, bool must_exist) {
  250. return get_string(key, value, data, datalen, true, sanitise, must_exist);
  251. }
  252. int expand_parameter(HKEY key, TCHAR *value, TCHAR *data, unsigned long datalen, bool sanitise) {
  253. return expand_parameter(key, value, data, datalen, sanitise, true);
  254. }
  255. /*
  256. Sets a string in the registry.
  257. Returns: 0 if it was set.
  258. 1 on error.
  259. */
  260. int set_string(HKEY key, TCHAR *value, TCHAR *string, bool expand) {
  261. unsigned long type = expand ? REG_EXPAND_SZ : REG_SZ;
  262. if (RegSetValueEx(key, value, 0, type, (const unsigned char *) string, (unsigned long) (_tcslen(string) + 1) * sizeof(TCHAR)) == ERROR_SUCCESS) return 0;
  263. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, value, error_string(GetLastError()), 0);
  264. return 1;
  265. }
  266. int set_string(HKEY key, TCHAR *value, TCHAR *string) {
  267. return set_string(key, value, string, false);
  268. return 1;
  269. }
  270. int set_expand_string(HKEY key, TCHAR *value, TCHAR *string) {
  271. return set_string(key, value, string, true);
  272. return 1;
  273. }
  274. /*
  275. Set an unsigned long in the registry.
  276. Returns: 0 if it was set.
  277. 1 on error.
  278. */
  279. int set_number(HKEY key, TCHAR *value, unsigned long number) {
  280. if (RegSetValueEx(key, value, 0, REG_DWORD, (const unsigned char *) &number, sizeof(number)) == ERROR_SUCCESS) return 0;
  281. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, value, error_string(GetLastError()), 0);
  282. return 1;
  283. }
  284. /*
  285. Query an unsigned long from the registry.
  286. Returns: 1 if a number was retrieved.
  287. 0 if none was found and must_exist is false.
  288. -1 if none was found and must_exist is true.
  289. -2 otherwise.
  290. */
  291. int get_number(HKEY key, TCHAR *value, unsigned long *number, bool must_exist) {
  292. unsigned long type = REG_DWORD;
  293. unsigned long number_len = sizeof(unsigned long);
  294. int ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) number, &number_len);
  295. if (ret == ERROR_SUCCESS) return 1;
  296. if (ret == ERROR_FILE_NOT_FOUND) {
  297. if (! must_exist) return 0;
  298. }
  299. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);
  300. if (ret == ERROR_FILE_NOT_FOUND) return -1;
  301. return -2;
  302. }
  303. int get_number(HKEY key, TCHAR *value, unsigned long *number) {
  304. return get_number(key, value, number, true);
  305. }
  306. /* Replace NULL with CRLF. Leave NULL NULL as the end marker. */
  307. int format_double_null(TCHAR *dn, unsigned long dnlen, TCHAR **formatted, unsigned long *newlen) {
  308. unsigned long i, j;
  309. *newlen = dnlen;
  310. if (! *newlen) {
  311. *formatted = 0;
  312. return 0;
  313. }
  314. for (i = 0; i < dnlen; i++) if (! dn[i] && dn[i + 1]) ++*newlen;
  315. *formatted = (TCHAR *) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, *newlen * sizeof(TCHAR));
  316. if (! *formatted) {
  317. *newlen = 0;
  318. return 1;
  319. }
  320. for (i = 0, j = 0; i < dnlen; i++) {
  321. (*formatted)[j] = dn[i];
  322. if (! dn[i]) {
  323. if (dn[i + 1]) {
  324. (*formatted)[j] = _T('\r');
  325. (*formatted)[++j] = _T('\n');
  326. }
  327. }
  328. j++;
  329. }
  330. return 0;
  331. }
  332. /* Strip CR and replace LF with NULL. */
  333. int unformat_double_null(TCHAR *dn, unsigned long dnlen, TCHAR **unformatted, unsigned long *newlen) {
  334. unsigned long i, j;
  335. *newlen = 0;
  336. if (! dnlen) {
  337. *unformatted = 0;
  338. return 0;
  339. }
  340. for (i = 0; i < dnlen; i++) if (dn[i] != _T('\r')) ++*newlen;
  341. /* Skip blank lines. */
  342. for (i = 0; i < dnlen; i++) {
  343. if (dn[i] == _T('\r') && dn[i + 1] == _T('\n')) {
  344. /* This is the last CRLF. */
  345. if (i >= dnlen - 2) break;
  346. /*
  347. Strip at the start of the block or if the next characters are
  348. CRLF too.
  349. */
  350. if (! i || (dn[i + 2] == _T('\r') && dn[i + 3] == _T('\n'))) {
  351. for (j = i + 2; j < dnlen; j++) dn[j - 2] = dn[j];
  352. dn[dnlen--] = _T('\0');
  353. dn[dnlen--] = _T('\0');
  354. i--;
  355. --*newlen;
  356. }
  357. }
  358. }
  359. /* Must end with two NULLs. */
  360. *newlen += 2;
  361. *unformatted = (TCHAR *) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, *newlen * sizeof(TCHAR));
  362. if (! *unformatted) return 1;
  363. for (i = 0, j = 0; i < dnlen; i++) {
  364. if (dn[i] == _T('\r')) continue;
  365. if (dn[i] == _T('\n')) (*unformatted)[j] = _T('\0');
  366. else (*unformatted)[j] = dn[i];
  367. j++;
  368. }
  369. return 0;
  370. }
  371. void override_milliseconds(TCHAR *service_name, HKEY key, TCHAR *value, unsigned long *buffer, unsigned long default_value, unsigned long event) {
  372. unsigned long type = REG_DWORD;
  373. unsigned long buflen = sizeof(unsigned long);
  374. bool ok = false;
  375. unsigned long ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) buffer, &buflen);
  376. if (ret != ERROR_SUCCESS) {
  377. if (ret != ERROR_FILE_NOT_FOUND) {
  378. if (type != REG_DWORD) {
  379. TCHAR milliseconds[16];
  380. _sntprintf_s(milliseconds, _countof(milliseconds), _TRUNCATE, _T("%lu"), default_value);
  381. log_event(EVENTLOG_WARNING_TYPE, event, service_name, value, milliseconds, 0);
  382. }
  383. else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);
  384. }
  385. }
  386. else ok = true;
  387. if (! ok) *buffer = default_value;
  388. }
  389. static int service_registry_path(const TCHAR *service_name, bool parameters, const TCHAR *sub, TCHAR *buffer, unsigned long buflen) {
  390. int ret;
  391. if (parameters) {
  392. if (sub) ret = _sntprintf_s(buffer, buflen, _TRUNCATE, NSSM_REGISTRY _T("\\") NSSM_REG_PARAMETERS _T("\\%s"), service_name, sub);
  393. else ret = _sntprintf_s(buffer, buflen, _TRUNCATE, NSSM_REGISTRY _T("\\") NSSM_REG_PARAMETERS, service_name);
  394. }
  395. else ret = _sntprintf_s(buffer, buflen, _TRUNCATE, NSSM_REGISTRY, service_name);
  396. return ret;
  397. }
  398. static HKEY open_registry_key(const TCHAR *registry, REGSAM sam, bool must_exist) {
  399. HKEY key;
  400. if (sam & KEY_SET_VALUE) {
  401. if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, sam, 0, &key, 0) != ERROR_SUCCESS) {
  402. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);
  403. return 0;
  404. }
  405. }
  406. else {
  407. long error = RegOpenKeyEx(HKEY_LOCAL_MACHINE, registry, 0, sam, &key);
  408. if (error != ERROR_SUCCESS) {
  409. if (error == ERROR_FILE_NOT_FOUND && ! must_exist) return 0;
  410. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);
  411. return 0;
  412. }
  413. }
  414. return key;
  415. }
  416. HKEY open_service_registry(const TCHAR *service_name, REGSAM sam, bool must_exist) {
  417. /* Get registry */
  418. TCHAR registry[KEY_LENGTH];
  419. if (service_registry_path(service_name, false, 0, registry, _countof(registry)) < 0) {
  420. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, NSSM_REGISTRY, _T("open_service_registry()"), 0);
  421. return 0;
  422. }
  423. return open_registry_key(registry, sam, must_exist);
  424. }
  425. HKEY open_registry(const TCHAR *service_name, const TCHAR *sub, REGSAM sam, bool must_exist) {
  426. /* Get registry */
  427. TCHAR registry[KEY_LENGTH];
  428. if (service_registry_path(service_name, true, sub, registry, _countof(registry)) < 0) {
  429. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, NSSM_REGISTRY, _T("open_registry()"), 0);
  430. return 0;
  431. }
  432. return open_registry_key(registry, sam, must_exist);
  433. }
  434. HKEY open_registry(const TCHAR *service_name, const TCHAR *sub, REGSAM sam) {
  435. return open_registry(service_name, sub, sam, true);
  436. }
  437. HKEY open_registry(const TCHAR *service_name, REGSAM sam) {
  438. return open_registry(service_name, 0, sam, true);
  439. }
  440. int get_io_parameters(nssm_service_t *service, HKEY key) {
  441. /* stdin */
  442. if (get_createfile_parameters(key, NSSM_REG_STDIN, service->stdin_path, &service->stdin_sharing, NSSM_STDIN_SHARING, &service->stdin_disposition, NSSM_STDIN_DISPOSITION, &service->stdin_flags, NSSM_STDIN_FLAGS, 0)) {
  443. service->stdin_sharing = service->stdin_disposition = service->stdin_flags = 0;
  444. ZeroMemory(service->stdin_path, _countof(service->stdin_path) * sizeof(TCHAR));
  445. return 1;
  446. }
  447. /* stdout */
  448. if (get_createfile_parameters(key, NSSM_REG_STDOUT, service->stdout_path, &service->stdout_sharing, NSSM_STDOUT_SHARING, &service->stdout_disposition, NSSM_STDOUT_DISPOSITION, &service->stdout_flags, NSSM_STDOUT_FLAGS, &service->stdout_copy_and_truncate)) {
  449. service->stdout_sharing = service->stdout_disposition = service->stdout_flags = 0;
  450. ZeroMemory(service->stdout_path, _countof(service->stdout_path) * sizeof(TCHAR));
  451. return 2;
  452. }
  453. /* stderr */
  454. if (get_createfile_parameters(key, NSSM_REG_STDERR, service->stderr_path, &service->stderr_sharing, NSSM_STDERR_SHARING, &service->stderr_disposition, NSSM_STDERR_DISPOSITION, &service->stderr_flags, NSSM_STDERR_FLAGS, &service->stderr_copy_and_truncate)) {
  455. service->stderr_sharing = service->stderr_disposition = service->stderr_flags = 0;
  456. ZeroMemory(service->stderr_path, _countof(service->stderr_path) * sizeof(TCHAR));
  457. return 3;
  458. }
  459. return 0;
  460. }
  461. int get_parameters(nssm_service_t *service, STARTUPINFO *si) {
  462. unsigned long ret;
  463. /* Try to open the registry */
  464. HKEY key = open_registry(service->name, KEY_READ);
  465. if (! key) return 1;
  466. /* Don't expand parameters when retrieving for the GUI. */
  467. bool expand = si ? true : false;
  468. /* Try to get environment variables - may fail */
  469. get_environment(service->name, key, NSSM_REG_ENV, &service->env, &service->envlen);
  470. /* Environment variables to add to existing rather than replace - may fail. */
  471. get_environment(service->name, key, NSSM_REG_ENV_EXTRA, &service->env_extra, &service->env_extralen);
  472. /* Set environment if we are starting the service. */
  473. if (si) set_service_environment(service);
  474. /* Try to get executable file - MUST succeed */
  475. if (get_string(key, NSSM_REG_EXE, service->exe, sizeof(service->exe), expand, false, true)) {
  476. RegCloseKey(key);
  477. return 3;
  478. }
  479. /* Try to get flags - may fail and we don't care */
  480. if (get_string(key, NSSM_REG_FLAGS, service->flags, sizeof(service->flags), expand, false, true)) {
  481. log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_NO_FLAGS, NSSM_REG_FLAGS, service->name, service->exe, 0);
  482. ZeroMemory(service->flags, sizeof(service->flags));
  483. }
  484. /* Try to get startup directory - may fail and we fall back to a default */
  485. if (get_string(key, NSSM_REG_DIR, service->dir, sizeof(service->dir), expand, true, true) || ! service->dir[0]) {
  486. _sntprintf_s(service->dir, _countof(service->dir), _TRUNCATE, _T("%s"), service->exe);
  487. strip_basename(service->dir);
  488. if (service->dir[0] == _T('\0')) {
  489. /* Help! */
  490. ret = GetWindowsDirectory(service->dir, sizeof(service->dir));
  491. if (! ret || ret > sizeof(service->dir)) {
  492. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_NO_DIR_AND_NO_FALLBACK, NSSM_REG_DIR, service->name, 0);
  493. RegCloseKey(key);
  494. return 4;
  495. }
  496. }
  497. log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_NO_DIR, NSSM_REG_DIR, service->name, service->dir, 0);
  498. }
  499. /* Try to get processor affinity - may fail. */
  500. TCHAR buffer[512];
  501. if (get_string(key, NSSM_REG_AFFINITY, buffer, sizeof(buffer), false, false, false) || ! buffer[0]) service->affinity = 0LL;
  502. else if (affinity_string_to_mask(buffer, &service->affinity)) {
  503. log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_BOGUS_AFFINITY_MASK, service->name, buffer);
  504. service->affinity = 0LL;
  505. }
  506. else {
  507. DWORD_PTR affinity, system_affinity;
  508. if (GetProcessAffinityMask(GetCurrentProcess(), &affinity, &system_affinity)) {
  509. _int64 effective_affinity = service->affinity & system_affinity;
  510. if (effective_affinity != service->affinity) {
  511. TCHAR *system = 0;
  512. if (! affinity_mask_to_string(system_affinity, &system)) {
  513. TCHAR *effective = 0;
  514. if (! affinity_mask_to_string(effective_affinity, &effective)) {
  515. log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_EFFECTIVE_AFFINITY_MASK, service->name, buffer, system, effective, 0);
  516. }
  517. HeapFree(GetProcessHeap(), 0, effective);
  518. }
  519. HeapFree(GetProcessHeap(), 0, system);
  520. }
  521. }
  522. }
  523. /* Try to get priority - may fail. */
  524. unsigned long priority;
  525. if (get_number(key, NSSM_REG_PRIORITY, &priority, false) == 1) {
  526. if (priority == (priority & priority_mask())) service->priority = priority;
  527. else log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_BOGUS_PRIORITY, service->name, NSSM_REG_PRIORITY, 0);
  528. }
  529. /* Try to get file rotation settings - may fail. */
  530. unsigned long rotate_files;
  531. if (get_number(key, NSSM_REG_ROTATE, &rotate_files, false) == 1) {
  532. if (rotate_files) service->rotate_files = true;
  533. else service->rotate_files = false;
  534. }
  535. else service->rotate_files = false;
  536. if (get_number(key, NSSM_REG_ROTATE_ONLINE, &rotate_files, false) == 1) {
  537. if (rotate_files) service->rotate_stdout_online = service->rotate_stderr_online = true;
  538. else service->rotate_stdout_online = service->rotate_stderr_online = false;
  539. }
  540. else service->rotate_stdout_online = service->rotate_stderr_online = false;
  541. if (get_number(key, NSSM_REG_ROTATE_SECONDS, &service->rotate_seconds, false) != 1) service->rotate_seconds = 0;
  542. if (get_number(key, NSSM_REG_ROTATE_BYTES_LOW, &service->rotate_bytes_low, false) != 1) service->rotate_bytes_low = 0;
  543. if (get_number(key, NSSM_REG_ROTATE_BYTES_HIGH, &service->rotate_bytes_high, false) != 1) service->rotate_bytes_high = 0;
  544. override_milliseconds(service->name, key, NSSM_REG_ROTATE_DELAY, &service->rotate_delay, NSSM_ROTATE_DELAY, NSSM_EVENT_BOGUS_THROTTLE);
  545. /* Try to get force new console setting - may fail. */
  546. if (get_number(key, NSSM_REG_NO_CONSOLE, &service->no_console, false) != 1) service->no_console = 0;
  547. /* Change to startup directory in case stdout/stderr are relative paths. */
  548. TCHAR cwd[PATH_LENGTH];
  549. GetCurrentDirectory(_countof(cwd), cwd);
  550. SetCurrentDirectory(service->dir);
  551. /* Try to get stdout and stderr */
  552. if (get_io_parameters(service, key)) {
  553. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_OUTPUT_HANDLES_FAILED, service->name, 0);
  554. RegCloseKey(key);
  555. SetCurrentDirectory(cwd);
  556. return 5;
  557. }
  558. /* Change back in case the startup directory needs to be deleted. */
  559. SetCurrentDirectory(cwd);
  560. /* Try to get mandatory restart delay */
  561. override_milliseconds(service->name, key, NSSM_REG_RESTART_DELAY, &service->restart_delay, 0, NSSM_EVENT_BOGUS_RESTART_DELAY);
  562. /* Try to get throttle restart delay */
  563. override_milliseconds(service->name, key, NSSM_REG_THROTTLE, &service->throttle_delay, NSSM_RESET_THROTTLE_RESTART, NSSM_EVENT_BOGUS_THROTTLE);
  564. /* Try to get service stop flags. */
  565. unsigned long type = REG_DWORD;
  566. unsigned long stop_method_skip;
  567. unsigned long buflen = sizeof(stop_method_skip);
  568. bool stop_ok = false;
  569. ret = RegQueryValueEx(key, NSSM_REG_STOP_METHOD_SKIP, 0, &type, (unsigned char *) &stop_method_skip, &buflen);
  570. if (ret != ERROR_SUCCESS) {
  571. if (ret != ERROR_FILE_NOT_FOUND) {
  572. if (type != REG_DWORD) {
  573. log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_BOGUS_STOP_METHOD_SKIP, service->name, NSSM_REG_STOP_METHOD_SKIP, NSSM, 0);
  574. }
  575. else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_STOP_METHOD_SKIP, error_string(GetLastError()), 0);
  576. }
  577. }
  578. else stop_ok = true;
  579. /* Try all methods except those requested to be skipped. */
  580. service->stop_method = ~0;
  581. if (stop_ok) service->stop_method &= ~stop_method_skip;
  582. /* Try to get kill delays - may fail. */
  583. override_milliseconds(service->name, key, NSSM_REG_KILL_CONSOLE_GRACE_PERIOD, &service->kill_console_delay, NSSM_KILL_CONSOLE_GRACE_PERIOD, NSSM_EVENT_BOGUS_KILL_CONSOLE_GRACE_PERIOD);
  584. override_milliseconds(service->name, key, NSSM_REG_KILL_WINDOW_GRACE_PERIOD, &service->kill_window_delay, NSSM_KILL_WINDOW_GRACE_PERIOD, NSSM_EVENT_BOGUS_KILL_WINDOW_GRACE_PERIOD);
  585. override_milliseconds(service->name, key, NSSM_REG_KILL_THREADS_GRACE_PERIOD, &service->kill_threads_delay, NSSM_KILL_THREADS_GRACE_PERIOD, NSSM_EVENT_BOGUS_KILL_THREADS_GRACE_PERIOD);
  586. /* Try to get process tree settings - may fail. */
  587. unsigned long kill_process_tree;
  588. if (get_number(key, NSSM_REG_KILL_PROCESS_TREE, &kill_process_tree, false) == 1) {
  589. if (kill_process_tree) service->kill_process_tree = true;
  590. else service->kill_process_tree = false;
  591. }
  592. else service->kill_process_tree = true;
  593. /* Try to get default exit action. */
  594. bool default_action;
  595. service->default_exit_action = NSSM_EXIT_RESTART;
  596. TCHAR action_string[ACTION_LEN];
  597. if (! get_exit_action(service->name, 0, action_string, &default_action)) {
  598. for (int i = 0; exit_action_strings[i]; i++) {
  599. if (! _tcsnicmp((const TCHAR *) action_string, exit_action_strings[i], ACTION_LEN)) {
  600. service->default_exit_action = i;
  601. break;
  602. }
  603. }
  604. }
  605. /* Close registry */
  606. RegCloseKey(key);
  607. return 0;
  608. }
  609. /*
  610. Sets the string for the exit action corresponding to the exit code.
  611. ret is a pointer to an unsigned long containing the exit code.
  612. If ret is NULL, we retrieve the default exit action unconditionally.
  613. action is a buffer which receives the string.
  614. default_action is a pointer to a bool which is set to false if there
  615. was an explicit string for the given exit code, or true if we are
  616. returning the default action.
  617. Returns: 0 on success.
  618. 1 on error.
  619. */
  620. int get_exit_action(const TCHAR *service_name, unsigned long *ret, TCHAR *action, bool *default_action) {
  621. /* Are we returning the default action or a status-specific one? */
  622. *default_action = ! ret;
  623. /* Try to open the registry */
  624. HKEY key = open_registry(service_name, NSSM_REG_EXIT, KEY_READ);
  625. if (! key) return 1;
  626. unsigned long type = REG_SZ;
  627. unsigned long action_len = ACTION_LEN;
  628. TCHAR code[16];
  629. if (! ret) code[0] = _T('\0');
  630. else if (_sntprintf_s(code, _countof(code), _TRUNCATE, _T("%lu"), *ret) < 0) {
  631. RegCloseKey(key);
  632. return get_exit_action(service_name, 0, action, default_action);
  633. }
  634. if (RegQueryValueEx(key, code, 0, &type, (unsigned char *) action, &action_len) != ERROR_SUCCESS) {
  635. RegCloseKey(key);
  636. /* Try again with * as the key if an exit code was defined */
  637. if (ret) return get_exit_action(service_name, 0, action, default_action);
  638. return 0;
  639. }
  640. /* Close registry */
  641. RegCloseKey(key);
  642. return 0;
  643. }
  644. int set_hook(const TCHAR *service_name, const TCHAR *hook_event, const TCHAR *hook_action, TCHAR *cmd) {
  645. /* Try to open the registry */
  646. TCHAR registry[KEY_LENGTH];
  647. if (_sntprintf_s(registry, _countof(registry), _TRUNCATE, _T("%s\\%s"), NSSM_REG_HOOK, hook_event) < 0) {
  648. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("hook registry"), _T("set_hook()"), 0);
  649. return 1;
  650. }
  651. HKEY key;
  652. long error;
  653. /* Don't create keys needlessly. */
  654. if (! _tcslen(cmd)) {
  655. key = open_registry(service_name, registry, KEY_READ, false);
  656. if (! key) return 0;
  657. error = RegQueryValueEx(key, hook_action, 0, 0, 0, 0);
  658. RegCloseKey(key);
  659. if (error == ERROR_FILE_NOT_FOUND) return 0;
  660. }
  661. key = open_registry(service_name, registry, KEY_WRITE);
  662. if (! key) return 1;
  663. int ret = 1;
  664. if (_tcslen(cmd)) ret = set_string(key, (TCHAR *) hook_action, cmd, true);
  665. else {
  666. error = RegDeleteValue(key, hook_action);
  667. if (error == ERROR_SUCCESS || error == ERROR_FILE_NOT_FOUND) ret = 0;
  668. }
  669. /* Close registry */
  670. RegCloseKey(key);
  671. return ret;
  672. }
  673. int get_hook(const TCHAR *service_name, const TCHAR *hook_event, const TCHAR *hook_action, TCHAR *buffer, unsigned long buflen) {
  674. /* Try to open the registry */
  675. TCHAR registry[KEY_LENGTH];
  676. if (_sntprintf_s(registry, _countof(registry), _TRUNCATE, _T("%s\\%s"), NSSM_REG_HOOK, hook_event) < 0) {
  677. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("hook registry"), _T("get_hook()"), 0);
  678. return 1;
  679. }
  680. HKEY key = open_registry(service_name, registry, KEY_READ, false);
  681. if (! key) return 1;
  682. int ret = expand_parameter(key, (TCHAR *) hook_action, buffer, buflen, true, false);
  683. /* Close registry */
  684. RegCloseKey(key);
  685. return ret;
  686. }