branch: master
tool_parsecfg.c
9968 bytesRaw
/***************************************************************************
* _ _ ____ _
* Project ___| | | | _ \| |
* / __| | | | |_) | |
* | (__| |_| | _ <| |___
* \___|\___/|_| \_\_____|
*
* Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
*
* This software is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at https://curl.se/docs/copyright.html.
*
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
* copies of the Software, and permit persons to whom the Software is
* furnished to do so, under the terms of the COPYING file.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
* SPDX-License-Identifier: curl
*
***************************************************************************/
#include "tool_setup.h"
#include "tool_cfgable.h"
#include "tool_getparam.h"
#include "tool_helpers.h"
#include "tool_findfile.h"
#include "tool_msgs.h"
#include "tool_parsecfg.h"
#include "tool_util.h"
/* only acknowledge colon or equals as separators if the option was not
specified with an initial dash! */
#define ISSEP(x, dash) (!(dash) && (((x) == '=') || ((x) == ':')))
/*
* Copies the string from line to the param dynbuf, unquoting backslash-quoted
* characters and null-terminating the output string. Stops at the first
* non-backslash-quoted double quote character or the end of the input string.
* param must be at least as long as the input string. Returns 0 on success.
*/
static int unslashquote(const char *line, struct dynbuf *param)
{
curlx_dyn_reset(param);
while(*line && (*line != '\"')) {
if(*line == '\\') {
char out;
line++;
/* default is to output the letter after the backslash */
switch(out = *line) {
case '\0':
continue; /* this breaks out of the loop */
case 't':
out = '\t';
break;
case 'n':
out = '\n';
break;
case 'r':
out = '\r';
break;
case 'v':
out = '\v';
break;
}
if(curlx_dyn_addn(param, &out, 1))
return 1;
line++;
}
else if(curlx_dyn_addn(param, line++, 1))
return 1;
}
return 0; /* ok */
}
/* return 0 on everything-is-fine, and non-zero otherwise */
ParameterError parseconfig(const char *filename, int max_recursive,
char **resolved)
{
FILE *file = NULL;
bool usedarg = FALSE;
ParameterError err = PARAM_OK;
struct OperationConfig *config = global->last;
char *pathalloc = NULL;
if(!filename) {
/* NULL means load .curlrc from homedir! */
char *curlrc = findfile(".curlrc", CURLRC_DOTSCORE);
if(curlrc) {
file = curlx_fopen(curlrc, FOPEN_READTEXT);
if(!file) {
curlx_free(curlrc);
return PARAM_READ_ERROR;
}
filename = pathalloc = curlrc;
}
#ifdef _WIN32
else {
char *fullp;
/* check for .curlrc then _curlrc in the directory of the executable */
file = tool_execpath(".curlrc", &fullp);
if(!file)
file = tool_execpath("_curlrc", &fullp);
if(file)
/* this is the filename we read from */
filename = fullp;
}
#endif
}
else {
if(strcmp(filename, "-"))
file = curlx_fopen(filename, FOPEN_READTEXT);
else
file = stdin;
}
if(file) {
char *line;
char *option;
char *param;
int lineno = 0;
bool dashed_option;
struct dynbuf buf;
struct dynbuf pbuf;
bool fileerror = FALSE;
curlx_dyn_init(&buf, MAX_CONFIG_LINE_LENGTH);
curlx_dyn_init(&pbuf, MAX_CONFIG_LINE_LENGTH);
DEBUGASSERT(filename);
while(!err && my_get_line(file, &buf, &fileerror)) {
ParameterError res;
lineno++;
line = curlx_dyn_ptr(&buf);
if(!line) {
err = PARAM_NO_MEM; /* out of memory */
break;
}
/* the option keywords starts here */
option = line;
/* the option starts with a dash? */
dashed_option = (option[0] == '-');
while(*line && !ISBLANK(*line) && !ISSEP(*line, dashed_option))
line++;
/* ... and has ended here */
if(*line)
*line++ = '\0'; /* null-terminate, we have a local copy of the data */
#ifdef DEBUG_CONFIG
curl_mfprintf(tool_stderr, "GOT: %s\n", option);
#endif
/* pass spaces and separator(s) */
while(ISBLANK(*line) || ISSEP(*line, dashed_option))
line++;
/* the parameter starts here (unless quoted) */
if(*line == '\"') {
/* quoted parameter, do the quote dance */
int rc = unslashquote(++line, &pbuf);
if(rc) {
err = PARAM_BAD_USE;
break;
}
param = curlx_dyn_len(&pbuf) ? curlx_dyn_ptr(&pbuf) : CURL_UNCONST("");
}
else {
if(*line == '\'') {
warnf("%s:%d Option '%s' uses argument with leading single quote. "
"It is probably a mistake. Consider double quotes.",
filename, lineno, option);
}
param = line; /* parameter starts here */
while(*line && !ISSPACE(*line)) /* stop also on CRLF */
line++;
if(*line) {
*line = '\0'; /* null-terminate */
/* to detect mistakes better, see if there is data following */
line++;
/* pass all spaces */
while(ISBLANK(*line))
line++;
switch(*line) {
case '\0':
case '\r':
case '\n':
case '#': /* comment */
break;
default:
warnf("%s:%d Option '%s' uses argument with unquoted whitespace. "
"This may cause side-effects. Consider double quotes.",
filename, lineno, option);
}
}
if(!*param)
/* do this so getparameter can check for required parameters.
Otherwise it always thinks there is a parameter. */
param = NULL;
}
#ifdef DEBUG_CONFIG
curl_mfprintf(tool_stderr, "PARAM: \"%s\"\n",
(param ? param : "(null)"));
#endif
res = getparameter(option, param, &usedarg, config, max_recursive);
config = global->last;
if(!res && param && *param && !usedarg)
/* we passed in a parameter that was not used! */
res = PARAM_GOT_EXTRA_PARAMETER;
if(res == PARAM_NEXT_OPERATION) {
if(config->url_list && config->url_list->url) {
/* Allocate the next config */
config->next = config_alloc();
if(config->next) {
/* Update the last operation pointer */
global->last = config->next;
/* Move onto the new config */
config->next->prev = config;
config = config->next;
}
else
res = PARAM_NO_MEM;
}
}
if(res != PARAM_OK && res != PARAM_NEXT_OPERATION) {
/* the help request is not really an error */
if(!strcmp(filename, "-")) {
filename = "<stdin>";
}
if(res != PARAM_HELP_REQUESTED &&
res != PARAM_MANUAL_REQUESTED &&
res != PARAM_VERSION_INFO_REQUESTED &&
res != PARAM_ENGINES_REQUESTED &&
res != PARAM_CA_EMBED_REQUESTED) {
const char *reason = param2text(res);
errorf("%s:%d config file option '%s' %s",
filename, lineno, option, reason);
if(res == PARAM_OPTION_UNKNOWN)
res = PARAM_CONFIG_OPTION_UNKNOWN;
err = res;
}
}
}
curlx_dyn_free(&buf);
curlx_dyn_free(&pbuf);
if(file != stdin)
curlx_fclose(file);
/* Silence false positive about failing to close stdin.
NOLINTNEXTLINE(clang-analyzer-unix.Stream) */
if(fileerror)
err = PARAM_READ_ERROR;
}
else
err = PARAM_READ_ERROR; /* could not open the file */
if((err == PARAM_READ_ERROR) && filename)
errorf("cannot read config from '%s'", filename);
if(!err && resolved) {
*resolved = curlx_strdup(filename);
if(!*resolved)
err = PARAM_NO_MEM;
}
curlx_free(pathalloc);
return err;
}
static bool get_line(FILE *input, struct dynbuf *buf, bool *error)
{
CURLcode result;
char buffer[128];
curlx_dyn_reset(buf);
while(1) {
const char *b = fgets(buffer, sizeof(buffer), input);
if(b) {
size_t rlen = strlen(b);
if(!rlen)
break;
result = curlx_dyn_addn(buf, b, rlen);
if(result) {
/* too long line or out of memory */
*error = TRUE;
return FALSE; /* error */
}
else if(b[rlen-1] == '\n') {
/* end of the line, drop the newline */
size_t len = curlx_dyn_len(buf);
if(len)
curlx_dyn_setlen(buf, len - 1);
return TRUE; /* all good */
}
else if(feof(input))
return TRUE; /* all good */
}
else if(curlx_dyn_len(buf))
return TRUE; /* all good */
else
break;
}
return FALSE;
}
/*
* Returns a line from the given file. Every line is null-terminated (no
* newline). Skips #-commented and space/tabs-only lines automatically.
*/
bool my_get_line(FILE *input, struct dynbuf *buf, bool *error)
{
bool retcode;
do {
retcode = get_line(input, buf, error);
if(!*error && retcode) {
size_t len = curlx_dyn_len(buf);
if(len) {
const char *line = curlx_dyn_ptr(buf);
while(ISBLANK(*line))
line++;
/* a line with # in the first non-blank column is a comment! */
if((*line == '#') || !*line)
continue;
}
else
continue; /* avoid returning an empty line */
}
break;
} while(retcode);
return retcode;
}