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
|
/*
* Copyright (C) 2015-2018 "IoT.bzh"
* Author José Bollo <jose.bollo@iot.bzh>
*
* 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.
*/
#define _GNU_SOURCE
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <getopt.h>
#include <limits.h>
#include <unistd.h>
#include "verbose.h"
#include "afs-config.h"
#if !defined(AFB_VERSION)
# error "you should define AFB_VERSION"
#endif
#if !defined(AFS_SUPERVISOR_TOKEN)
# define AFS_SUPERVISOR_TOKEN ""
#endif
#if !defined(AFS_SUPERVISOR_PORT)
# define AFS_SUPERVISOR_PORT 1619
#endif
#define _STRINGIFY_(x) #x
#define STRINGIFY(x) _STRINGIFY_(x)
// default
#define DEFLT_CNTX_TIMEOUT 32000000 // default Client Connection
// Timeout: few more than one year
#define DEFLT_API_TIMEOUT 20 // default Plugin API Timeout [0=NoLimit
// for Debug Only]
#define DEFLT_CACHE_TIMEOUT 100000 // default Static File Chache
// [Client Side Cache
// 100000~=1day]
#define CTX_NBCLIENTS 10 // allow a default of 10 authenticated
// clients
// Define command line option
#define SET_ROOT_DIR 6
#define SET_ROOT_BASE 7
#define SET_ROOT_API 8
#define SET_CACHE_TIMEOUT 10
#define SET_SESSION_DIR 11
#define SET_APITIMEOUT 14
#define SET_CNTXTIMEOUT 15
#define SET_SESSIONMAX 23
#define SET_ROOT_HTTP 26
#define DISPLAY_HELP 'h'
#define SET_NAME 'n'
#define SET_TCP_PORT 'p'
#define SET_QUIET 'q'
#define SET_AUTH_TOKEN 't'
#define SET_UPLOAD_DIR 'u'
#define DISPLAY_VERSION 'V'
#define SET_VERBOSE 'v'
#define SET_WORK_DIR 'w'
const char shortopts[] =
"hn:p:qrt:u:Vvw:"
;
// Command line structure hold cli --command + help text
typedef struct {
int val; // command number within application
int has_arg; // command number within application
char *name; // command as used in --xxxx cli
char *help; // help text
} AFB_options;
// Supported option
static AFB_options cliOptions[] = {
/* *INDENT-OFF* */
{SET_VERBOSE, 0, "verbose", "Verbose Mode, repeat to increase verbosity"},
{SET_QUIET, 0, "quiet", "Quiet Mode, repeat to decrease verbosity"},
{SET_NAME, 1, "name", "Set the visible name"},
{SET_TCP_PORT, 1, "port", "HTTP listening TCP port [default " STRINGIFY(AFS_SUPERVISOR_PORT) "]"},
{SET_ROOT_HTTP, 1, "roothttp", "HTTP Root Directory [default no root http (files not served but apis still available)]"},
{SET_ROOT_BASE, 1, "rootbase", "Angular Base Root URL [default /opa]"},
{SET_ROOT_API, 1, "rootapi", "HTML Root API URL [default /api]"},
{SET_APITIMEOUT, 1, "apitimeout", "Binding API timeout in seconds [default 10]"},
{SET_CNTXTIMEOUT, 1, "cntxtimeout", "Client Session Context Timeout [default 900]"},
{SET_CACHE_TIMEOUT, 1, "cache-eol", "Client cache end of live [default 3600]"},
{SET_WORK_DIR, 1, "workdir", "Set the working directory [default: $PWD or current working directory]"},
{SET_UPLOAD_DIR, 1, "uploaddir", "Directory for uploading files [default: workdir]"},
{SET_ROOT_DIR, 1, "rootdir", "Root Directory of the application [default: workdir]"},
{SET_SESSION_DIR, 1, "sessiondir", "OBSOLETE (was: Sessions file path)"},
{SET_AUTH_TOKEN, 1, "token", "Initial Secret [default=" AFS_SUPERVISOR_TOKEN ", use --token="" to allow any token]"},
{DISPLAY_VERSION, 0, "version", "Display version and copyright"},
{DISPLAY_HELP, 0, "help", "Display this help"},
{SET_SESSIONMAX, 1, "session-max", "Max count of session simultaneously [default 10]"},
{0, 0, NULL, NULL}
/* *INDENT-ON* */
};
struct enumdesc
{
const char *name;
int value;
};
/*----------------------------------------------------------
| printversion
| print version and copyright
+--------------------------------------------------------- */
static void printVersion(FILE * file)
{
static const char version[] =
"\n"
" afs-supervisor [Application Framework Supervisor] version="AFB_VERSION"\n"
"\n"
" Copyright (C) 2015-2018 \"IoT.bzh\"\n"
" afs-supervisor comes with ABSOLUTELY NO WARRANTY.\n"
" Licence Apache 2\n"
"\n";
fprintf(file, "%s", version);
}
/*----------------------------------------------------------
| printHelp
| print information from long option array
+--------------------------------------------------------- */
static void printHelp(FILE * file, const char *name)
{
int ind;
char command[50];
fprintf(file, "%s:\nallowed options\n", name);
for (ind = 0; cliOptions[ind].name != NULL; ind++) {
strcpy(command, cliOptions[ind].name);
if (cliOptions[ind].has_arg)
strcat(command, "=xxxx");
fprintf(file, " --%-15s %s\n", command, cliOptions[ind].help);
}
fprintf(file,
"Example:\n %s --verbose --port=1234 --token='azerty'\n",
name);
}
/*---------------------------------------------------------
| helpers for argument scanning
+--------------------------------------------------------- */
static const char *name_of_option(int optc)
{
AFB_options *o = cliOptions;
while (o->name && o->val != optc)
o++;
return o->name ? : "<unknown-option-name>";
}
static const char *current_argument(int optc)
{
if (optarg == 0) {
ERROR("option [--%s] needs a value i.e. --%s=xxx",
name_of_option(optc), name_of_option(optc));
exit(1);
}
return optarg;
}
static char *argvalstr(int optc)
{
char *result = strdup(current_argument(optc));
if (result == NULL) {
ERROR("can't alloc memory");
exit(1);
}
return result;
}
static int argvalint(int optc, int mini, int maxi, int base)
{
const char *beg, *end;
long int val;
beg = current_argument(optc);
val = strtol(beg, (char**)&end, base);
if (*end || end == beg) {
ERROR("option [--%s] requires a valid integer (found %s)",
name_of_option(optc), beg);
exit(1);
}
if (val < (long int)mini || val > (long int)maxi) {
ERROR("option [--%s] value out of bounds (not %d<=%ld<=%d)",
name_of_option(optc), mini, val, maxi);
exit(1);
}
return (int)val;
}
static int argvalintdec(int optc, int mini, int maxi)
{
return argvalint(optc, mini, maxi, 10);
}
static void noarg(int optc)
{
if (optarg != 0) {
ERROR("option [--%s] need no value (found %s)", name_of_option(optc), optarg);
exit(1);
}
}
/*---------------------------------------------------------
| Parse option and launch action
+--------------------------------------------------------- */
static void parse_arguments(int argc, char **argv, struct afs_config *config)
{
char *programName = argv[0];
int optc, ind;
int nbcmd;
struct option *gnuOptions;
// ------------------ Process Command Line -----------------------
// build GNU getopt info from cliOptions
nbcmd = sizeof(cliOptions) / sizeof(AFB_options);
gnuOptions = malloc(sizeof(*gnuOptions) * (unsigned)nbcmd);
for (ind = 0; ind < nbcmd; ind++) {
gnuOptions[ind].name = cliOptions[ind].name;
gnuOptions[ind].has_arg = cliOptions[ind].has_arg;
gnuOptions[ind].flag = 0;
gnuOptions[ind].val = cliOptions[ind].val;
}
// get all options from command line
while ((optc = getopt_long(argc, argv, shortopts, gnuOptions, NULL)) != EOF) {
switch (optc) {
case SET_VERBOSE:
verbosity++;
break;
case SET_QUIET:
verbosity--;
break;
case SET_TCP_PORT:
config->httpdPort = argvalintdec(optc, 1024, 32767);
break;
case SET_APITIMEOUT:
config->apiTimeout = argvalintdec(optc, 0, INT_MAX);
break;
case SET_CNTXTIMEOUT:
config->cntxTimeout = argvalintdec(optc, 0, INT_MAX);
break;
case SET_ROOT_DIR:
config->rootdir = argvalstr(optc);
INFO("Forcing Rootdir=%s", config->rootdir);
break;
case SET_ROOT_HTTP:
config->roothttp = argvalstr(optc);
INFO("Forcing Root HTTP=%s", config->roothttp);
break;
case SET_ROOT_BASE:
config->rootbase = argvalstr(optc);
INFO("Forcing Rootbase=%s", config->rootbase);
break;
case SET_ROOT_API:
config->rootapi = argvalstr(optc);
INFO("Forcing Rootapi=%s", config->rootapi);
break;
case SET_AUTH_TOKEN:
config->token = argvalstr(optc);
break;
case SET_UPLOAD_DIR:
config->uploaddir = argvalstr(optc);
break;
case SET_WORK_DIR:
config->workdir = argvalstr(optc);
break;
case SET_CACHE_TIMEOUT:
config->cacheTimeout = argvalintdec(optc, 0, INT_MAX);
break;
case SET_SESSIONMAX:
config->nbSessionMax = argvalintdec(optc, 1, INT_MAX);
break;
case SET_NAME:
config->name = argvalstr(optc);
break;
case DISPLAY_VERSION:
noarg(optc);
printVersion(stdout);
exit(0);
case DISPLAY_HELP:
printHelp(stdout, programName);
exit(0);
default:
exit(1);
}
}
free(gnuOptions);
}
static void fulfill_config(struct afs_config *config)
{
// default HTTP port
if (config->httpdPort == 0)
config->httpdPort = AFS_SUPERVISOR_PORT;
// default binding API timeout
if (config->apiTimeout == 0)
config->apiTimeout = DEFLT_API_TIMEOUT;
// cache timeout default one hour
if (config->cacheTimeout == 0)
config->cacheTimeout = DEFLT_CACHE_TIMEOUT;
// cache timeout default one hour
if (config->cntxTimeout == 0)
config->cntxTimeout = DEFLT_CNTX_TIMEOUT;
// max count of sessions
if (config->nbSessionMax == 0)
config->nbSessionMax = CTX_NBCLIENTS;
/* set directories */
if (config->workdir == NULL)
config->workdir = ".";
if (config->rootdir == NULL)
config->rootdir = ".";
if (config->uploaddir == NULL)
config->uploaddir = ".";
// if no Angular/HTML5 rootbase let's try '/' as default
if (config->rootbase == NULL)
config->rootbase = "/opa";
if (config->rootapi == NULL)
config->rootapi = "/api";
if (config->token == NULL)
config->token = AFS_SUPERVISOR_TOKEN;
}
void afs_config_dump(struct afs_config *config)
{
#define NN(x) (x)?:""
#define P(...) fprintf(stderr, __VA_ARGS__)
#define PF(x) P("-- %15s: ", #x)
#define PE P("\n")
#define S(x) PF(x);P("%s",NN(config->x));PE;
#define D(x) PF(x);P("%d",config->x);PE;
P("---BEGIN-OF-CONFIG---\n");
S(rootdir)
S(roothttp)
S(rootbase)
S(rootapi)
S(workdir)
S(uploaddir)
S(token)
S(name)
D(httpdPort)
D(cacheTimeout)
D(apiTimeout)
D(cntxTimeout)
D(nbSessionMax)
P("---END-OF-CONFIG---\n");
#undef V
#undef E
#undef L
#undef B
#undef D
#undef S
#undef PE
#undef PF
#undef P
#undef NN
}
static void parse_environment(struct afs_config *config)
{
}
struct afs_config *afs_config_parse_arguments(int argc, char **argv)
{
struct afs_config *result;
result = calloc(1, sizeof *result);
parse_environment(result);
parse_arguments(argc, argv, result);
fulfill_config(result);
if (verbosity >= 3)
afs_config_dump(result);
return result;
}
|