Fix compiler warning.
[tinc] / src / script.c
1 /*
2     script.c -- call an external script
3     Copyright (C) 1999-2005 Ivo Timmermans,
4                   2000-2022 Guus Sliepen <guus@tinc-vpn.org>
5
6     This program is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     This program is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License along
17     with this program; if not, write to the Free Software Foundation, Inc.,
18     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 */
20
21 #include "system.h"
22
23 #include "conf.h"
24 #include "device.h"
25 #include "logger.h"
26 #include "names.h"
27 #include "script.h"
28 #include "xalloc.h"
29
30 #ifdef HAVE_PUTENV
31 static void unputenv(const char *p) {
32         const char *e = strchr(p, '=');
33
34         if(!e) {
35                 return;
36         }
37
38         ptrdiff_t len = e - p;
39 #ifndef HAVE_UNSETENV
40 #ifdef HAVE_MINGW
41         // Windows requires putenv("FOO=") to unset %FOO%
42         len++;
43 #endif
44 #endif
45         char var[len + 1];
46         strncpy(var, p, len);
47         var[len] = 0;
48 #ifdef HAVE_UNSETENV
49         unsetenv(var);
50 #else
51         // We must keep what we putenv() around in memory.
52         // To do this without memory leaks, keep things in a list and reuse if possible.
53         static list_t list = {0};
54
55         for list_each(char, data, &list) {
56                 if(!strcmp(data, var)) {
57                         putenv(data);
58                         return;
59                 }
60         }
61
62         char *data = xstrdup(var);
63         list_insert_tail(&list, data);
64         putenv(data);
65 #endif
66 }
67 #else
68 static void putenv(const char *p) {}
69 static void unputenv(const char *p) {}
70 #endif
71
72 static const int min_env_size = 10;
73
74 int environment_add(environment_t *env, const char *format, ...) {
75         if(env->n >= env->size) {
76                 env->size = env->n ? env->n * 2 : min_env_size;
77                 env->entries = xrealloc(env->entries, env->size * sizeof(*env->entries));
78         }
79
80         if(format) {
81                 va_list ap;
82                 va_start(ap, format);
83
84                 if(vasprintf(&env->entries[env->n], format, ap) == -1) {
85                         // Assume we are out of memory.
86                         abort();
87                 }
88
89                 va_end(ap);
90         } else {
91                 env->entries[env->n] = NULL;
92         }
93
94         return env->n++;
95 }
96
97 void environment_update(environment_t *env, int pos, const char *format, ...) {
98         free(env->entries[pos]);
99         va_list ap;
100         va_start(ap, format);
101
102         if(vasprintf(&env->entries[pos], format, ap) == -1) {
103                 abort();
104         }
105
106         va_end(ap);
107 }
108
109 void environment_init(environment_t *env) {
110         env->n = 0;
111         env->size = min_env_size;
112         env->entries = xzalloc(env->size * sizeof(*env->entries));
113
114         if(netname) {
115                 environment_add(env, "NETNAME=%s", netname);
116         }
117
118         if(myname) {
119                 environment_add(env, "NAME=%s", myname);
120         }
121
122         if(device) {
123                 environment_add(env, "DEVICE=%s", device);
124         }
125
126         if(iface) {
127                 environment_add(env, "INTERFACE=%s", iface);
128         }
129
130         if(debug_level >= 0) {
131                 environment_add(env, "DEBUG=%d", debug_level);
132         }
133 }
134
135 void environment_exit(environment_t *env) {
136         for(int i = 0; i < env->n; i++) {
137                 free(env->entries[i]);
138         }
139
140         free(env->entries);
141 }
142
143 bool execute_script(const char *name, environment_t *env) {
144         char scriptname[PATH_MAX];
145         char *command;
146
147         snprintf(scriptname, sizeof(scriptname), "%s" SLASH "%s%s", confbase, name, scriptextension);
148
149         /* First check if there is a script */
150
151 #ifdef HAVE_MINGW
152
153         if(!*scriptextension) {
154                 const char *pathext = getenv("PATHEXT");
155
156                 if(!pathext) {
157                         pathext = ".COM;.EXE;.BAT;.CMD";
158                 }
159
160                 size_t pathlen = strlen(pathext);
161                 size_t scriptlen = strlen(scriptname);
162                 char fullname[scriptlen + pathlen + 1];
163                 char *ext = fullname + scriptlen;
164                 strncpy(fullname, scriptname, sizeof(fullname));
165
166                 const char *p = pathext;
167                 bool found = false;
168
169                 while(p && *p) {
170                         const char *q = strchr(p, ';');
171
172                         if(q) {
173                                 memcpy(ext, p, q - p);
174                                 ext[q - p] = 0;
175                                 q++;
176                         } else {
177                                 strncpy(ext, p, pathlen + 1);
178                         }
179
180                         if((found = !access(fullname, F_OK))) {
181                                 break;
182                         }
183
184                         p = q;
185                 }
186
187                 if(!found) {
188                         return true;
189                 }
190         } else
191 #endif
192
193                 if(access(scriptname, F_OK)) {
194                         return true;
195                 }
196
197         logger(DEBUG_STATUS, LOG_INFO, "Executing script %s", name);
198
199         /* Set environment */
200
201         for(int i = 0; i < env->n; i++) {
202                 putenv(env->entries[i]);
203         }
204
205         if(scriptinterpreter) {
206                 xasprintf(&command, "%s \"%s\"", scriptinterpreter, scriptname);
207         } else {
208                 xasprintf(&command, "\"%s\"", scriptname);
209         }
210
211         int status = system(command);
212
213         free(command);
214
215         /* Unset environment */
216
217         for(int i = 0; i < env->n; i++) {
218                 unputenv(env->entries[i]);
219         }
220
221         if(status != -1) {
222 #ifdef WEXITSTATUS
223
224                 if(WIFEXITED(status)) {          /* Child exited by itself */
225                         if(WEXITSTATUS(status)) {
226                                 logger(DEBUG_ALWAYS, LOG_ERR, "Script %s exited with non-zero status %d",
227                                        name, WEXITSTATUS(status));
228                                 return false;
229                         }
230                 } else if(WIFSIGNALED(status)) { /* Child was killed by a signal */
231                         logger(DEBUG_ALWAYS, LOG_ERR, "Script %s was killed by signal %d (%s)",
232                                name, WTERMSIG(status), strsignal(WTERMSIG(status)));
233                         return false;
234                 } else {                         /* Something strange happened */
235                         logger(DEBUG_ALWAYS, LOG_ERR, "Script %s terminated abnormally", name);
236                         return false;
237                 }
238
239 #endif
240         } else {
241                 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "system", strerror(errno));
242                 return false;
243         }
244
245         return true;
246 }