2 * Copyright (C) 1986-2005 The Free Software Foundation, Inc.
4 * Portions Copyright (C) 1998-2005 Derek Price, Ximbiot <http://ximbiot.com>,
7 * Portions Copyright (C) 1992, Brian Berliner and Jeff Polk
8 * Portions Copyright (C) 1989-1992, Brian Berliner
10 * You may distribute under the terms of the GNU General Public License as
11 * specified in the README file that comes with the CVS source distribution.
19 * Parse the INFOFILE file for the specified REPOSITORY. Invoke CALLPROC for
20 * the first line in the file that matches the REPOSITORY, or if ALL != 0, any
21 * lines matching "ALL", or if no lines match, the last line matching
24 * Return 0 for success, -1 if there was not an INFOFILE, and >0 for failure.
27 Parse_Info (const char *infofile, const char *repository, CALLPROC callproc,
28 int opt, void *closure)
34 size_t line_allocated = 0;
35 char *default_value = NULL;
40 char *cp, *exp, *value;
42 const char *regex_err;
46 if (!current_parsed_root)
48 /* XXX - should be error maybe? */
49 error (0, 0, "CVSROOT variable not set");
53 /* find the info file and open it */
54 infopath = Xasprintf ("%s/%s/%s", current_parsed_root->directory,
55 CVSROOTADM, infofile);
56 fp_info = CVS_FOPEN (infopath, "r");
59 /* If no file, don't do anything special. */
60 if (!existence_error (errno))
61 error (0, errno, "cannot open %s", infopath);
66 /* strip off the CVSROOT if repository was absolute */
67 srepos = Short_Repository (repository);
69 TRACE (TRACE_FUNCTION, "Parse_Info (%s, %s, %s)",
70 infopath, srepos, (opt & PIOPT_ALL) ? "ALL" : "not ALL");
72 /* search the info file for lines that match */
73 callback_done = false;
75 while (getline (&line, &line_allocated, fp_info) >= 0)
79 /* skip lines starting with # */
83 /* skip whitespace at beginning of line */
84 for (cp = line; *cp && isspace ((unsigned char) *cp); cp++)
87 /* if *cp is null, the whole line was blank */
91 /* the regular expression is everything up to the first space */
92 for (exp = cp; *cp && !isspace ((unsigned char) *cp); cp++)
97 /* skip whitespace up to the start of the matching value */
98 while (*cp && isspace ((unsigned char) *cp))
101 /* no value to match with the regular expression is an error */
104 error (0, 0, "syntax error at line %d file %s; ignored",
105 line_number, infopath);
110 /* strip the newline off the end of the value */
111 cp = strrchr (value, '\n');
115 * At this point, exp points to the regular expression, and value
116 * points to the value to call the callback routine with. Evaluate
117 * the regular expression against srepos and callback with the value
121 /* save the default value so we have it later if we need it */
122 if (strcmp (exp, "DEFAULT") == 0)
126 error (0, 0, "Multiple `DEFAULT' lines (%d and %d) in %s file",
127 default_line, line_number, infofile);
128 free (default_value);
130 default_value = xstrdup (value);
131 default_line = line_number;
136 * For a regular expression of "ALL", do the callback always We may
137 * execute lots of ALL callbacks in addition to *one* regular matching
138 * callback or default
140 if (strcmp (exp, "ALL") == 0)
142 if (!(opt & PIOPT_ALL))
143 error (0, 0, "Keyword `ALL' is ignored at line %d in %s file",
144 line_number, infofile);
145 else if ((expanded_value =
146 expand_path (value, current_parsed_root->directory,
147 true, infofile, line_number)))
149 err += callproc (repository, expanded_value, closure);
150 free (expanded_value);
158 /* only first matching, plus "ALL"'s */
161 /* see if the repository matched this regular expression */
162 regex_err = re_comp (exp);
165 error (0, 0, "bad regular expression at line %d file %s: %s",
166 line_number, infofile, regex_err);
169 if (re_exec (srepos) == 0)
170 continue; /* no match */
172 /* it did, so do the callback and note that we did one */
173 expanded_value = expand_path (value, current_parsed_root->directory,
174 true, infofile, line_number);
177 err += callproc (repository, expanded_value, closure);
178 free (expanded_value);
182 callback_done = true;
184 if (ferror (fp_info))
185 error (0, errno, "cannot read %s", infopath);
186 if (fclose (fp_info) < 0)
187 error (0, errno, "cannot close %s", infopath);
189 /* if we fell through and didn't callback at all, do the default */
190 if (!callback_done && default_value)
192 expanded_value = expand_path (default_value,
193 current_parsed_root->directory,
194 true, infofile, line_number);
197 err += callproc (repository, expanded_value, closure);
198 free (expanded_value);
204 /* free up space if necessary */
205 if (default_value) free (default_value);
207 if (line) free (line);
214 /* Print a warning and return false if P doesn't look like a string specifying
215 * something that can be converted into a size_t.
217 * Sets *VAL to the parsed value when it is found to be valid. *VAL will not
218 * be altered when false is returned.
221 readSizeT (const char *infopath, const char *option, const char *p,
225 size_t num, factor = 1;
227 if (!strcasecmp ("unlimited", p))
233 /* Record the factor character (kilo, mega, giga, tera). */
234 if (!isdigit (p[strlen(p) - 1]))
236 switch (p[strlen(p) - 1])
239 factor = xtimes (factor, 1024);
241 factor = xtimes (factor, 1024);
243 factor = xtimes (factor, 1024);
245 factor = xtimes (factor, 1024);
249 "%s: Unknown %s factor: `%c'",
250 infopath, option, p[strlen(p)]);
253 TRACE (TRACE_DATA, "readSizeT(): Found factor %u for %s",
257 /* Verify that *q is a number. */
259 while (q < p + strlen(p) - 1 /* Checked last character above. */)
264 "%s: %s must be a postitive integer, not '%s'",
265 infopath, option, p);
271 /* Compute final value. */
272 num = strtoul (p, NULL, 10);
273 if (num == ULONG_MAX || num > SIZE_MAX)
274 /* Don't return an error, just max out. */
277 TRACE (TRACE_DATA, "readSizeT(): read number %u for %s", num, option);
278 *val = xtimes (strtoul (p, NULL, 10), factor);
279 TRACE (TRACE_DATA, "readSizeT(): returnning %u for %s", *val, option);
285 /* Allocate and initialize a new config struct. */
286 static inline struct config *
289 struct config *new = xcalloc (1, sizeof (struct config));
291 TRACE (TRACE_FLOW, "new_config ()");
293 new->logHistory = xstrdup (ALL_HISTORY_REC_TYPES);
294 new->RereadLogAfterVerify = LOGMSG_REREAD_ALWAYS;
295 new->UserAdminOptions = xstrdup ("k");
296 new->MaxCommentLeaderLength = 20;
297 #ifdef SERVER_SUPPORT
298 new->MaxCompressionLevel = 9;
299 #endif /* SERVER_SUPPORT */
301 new->MaxProxyBufferSize = (size_t)(8 * 1024 * 1024); /* 8 megabytes,
304 #endif /* PROXY_SUPPORT */
305 #ifdef AUTH_SERVER_SUPPORT
306 new->system_auth = true;
307 #endif /* AUTH_SERVER_SUPPORT */
315 free_config (struct config *data)
317 if (data->keywords) free_keywords (data->keywords);
323 /* Return true if this function has already been called for line LN of file
327 parse_error (const char *infopath, unsigned int ln)
329 static List *errors = NULL;
330 char *nodename = NULL;
335 nodename = Xasprintf ("%s/%u", infopath, ln);
336 if (findnode (errors, nodename))
342 push_string (errors, nodename);
348 #ifdef ALLOW_CONFIG_OVERRIDE
349 const char * const allowed_config_prefixes[] = { ALLOW_CONFIG_OVERRIDE };
350 #endif /* ALLOW_CONFIG_OVERRIDE */
354 /* Parse the CVS config file. The syntax right now is a bit ad hoc
355 * but tries to draw on the best or more common features of the other
356 * *info files and various unix (or non-unix) config file syntaxes.
357 * Lines starting with # are comments. Settings are lines of the form
358 * KEYWORD=VALUE. There is currently no way to have a multi-line
359 * VALUE (would be nice if there was, probably).
361 * CVSROOT is the $CVSROOT directory
362 * (current_parsed_root->directory might not be set yet, so this
363 * function takes the cvsroot as a function argument).
366 * Always returns a fully initialized config struct, which on error may
367 * contain only the defaults.
370 * Calls error(0, ...) on errors in addition to the return value.
372 * xmalloc() failures are fatal, per usual.
375 parse_config (const char *cvsroot, const char *path)
377 const char *infopath;
378 char *freeinfopath = NULL;
381 unsigned int ln; /* Input file line counter. */
383 size_t buf_allocated = 0;
386 struct config *retval;
388 /* PROCESSING Whether config keys are currently being processed for
390 * PROCESSED Whether any keys have been processed for this root.
391 * This is initialized to true so that any initial keys
392 * may be processed as global defaults.
394 bool processing = true;
395 bool processed = true;
397 TRACE (TRACE_FUNCTION, "parse_config (%s)", cvsroot);
399 #ifdef ALLOW_CONFIG_OVERRIDE
402 const char * const *prefix;
403 char *npath = xcanonicalize_file_name (path);
404 bool approved = false;
405 for (prefix = allowed_config_prefixes; *prefix != NULL; prefix++)
409 if (!isreadable (*prefix)) continue;
410 nprefix = xcanonicalize_file_name (*prefix);
411 if (!strncmp (nprefix, npath, strlen (nprefix))
412 && (((*prefix)[strlen (*prefix)] != '/'
413 && strlen (npath) == strlen (nprefix))
414 || ((*prefix)[strlen (*prefix)] == '/'
415 && npath[strlen (nprefix)] == '/')))
421 error (1, 0, "Invalid path to config file specified: `%s'",
428 infopath = freeinfopath =
429 Xasprintf ("%s/%s/%s", cvsroot, CVSROOTADM, CVSROOTADM_CONFIG);
431 retval = new_config ();
434 fp_info = CVS_FOPEN (infopath, "r");
437 /* If no file, don't do anything special. */
438 if (!existence_error (errno))
440 /* Just a warning message; doesn't affect return
441 value, currently at least. */
442 error (0, errno, "cannot open %s", infopath);
444 if (freeinfopath) free (freeinfopath);
448 ln = 0; /* Have not read any lines yet. */
449 while (getline (&buf, &buf_allocated, fp_info) >= 0)
451 ln++; /* Keep track of input file line number for error messages. */
455 /* Skip leading white space. */
456 while (isspace (*line)) line++;
462 /* Is there any kind of written standard for the syntax of this
463 sort of config file? Anywhere in POSIX for example (I guess
464 makefiles are sort of close)? Red Hat Linux has a bunch of
465 these too (with some GUI tools which edit them)...
467 Along the same lines, we might want a table of keywords,
468 with various types (boolean, string, &c), as a mechanism
469 for making sure the syntax is consistent. Any good examples
470 to follow there (Apache?)? */
472 /* Strip the trailing newline. There will be one unless we
473 read a partial line without a newline, and then got end of
476 len = strlen (line) - 1;
477 if (line[len] == '\n')
480 /* Skip blank lines. */
484 TRACE (TRACE_DATA, "parse_info() examining line: `%s'", line);
486 /* Check for a root specification. */
487 if (line[0] == '[' && line[len] == ']')
492 tmproot = parse_cvsroot (line);
494 /* Ignoring method. */
496 #if defined CLIENT_SUPPORT || defined SERVER_SUPPORT
497 || (tmproot->method != local_method
498 && (!tmproot->hostname || !isThisHost (tmproot->hostname)))
499 #endif /* CLIENT_SUPPORT || SERVER_SUPPORT */
500 || !isSamePath (tmproot->directory, cvsroot))
502 if (processed) processing = false;
506 TRACE (TRACE_FLOW, "Matched root section`%s'", line);
514 /* There is data on this line. */
516 /* Even if the data is bad or ignored, consider data processed for
522 /* ...but it is for a different root. */
525 /* The first '=' separates keyword from value. */
526 p = strchr (line, '=');
529 if (!parse_error (infopath, ln))
531 "%s [%d]: syntax error: missing `=' between keyword and value",
538 if (strcmp (line, "RCSBIN") == 0)
540 /* This option used to specify the directory for RCS
541 executables. But since we don't run them any more,
542 this is a noop. Silently ignore it so that a
543 repository can work with either new or old CVS. */
546 else if (strcmp (line, "SystemAuth") == 0)
547 #ifdef AUTH_SERVER_SUPPORT
548 readBool (infopath, "SystemAuth", p, &retval->system_auth);
551 /* Still parse the syntax but ignore the option. That way the same
552 * config file can be used for local and server.
555 readBool (infopath, "SystemAuth", p, &dummy);
558 else if (strcmp (line, "LocalKeyword") == 0 ||
559 strcmp (line, "tag") == 0)
560 RCS_setlocalid (infopath, ln, &retval->keywords, p);
561 else if (strcmp (line, "KeywordExpand") == 0 ||
562 strcmp (line, "tagexpand") == 0)
563 RCS_setincexc (&retval->keywords, p);
564 else if (strcmp (line, "PreservePermissions") == 0)
566 #ifdef PRESERVE_PERMISSIONS_SUPPORT
567 readBool (infopath, "PreservePermissions", p,
568 &retval->preserve_perms);
570 if (!parse_error (infopath, ln))
572 %s [%u]: warning: this CVS does not support PreservePermissions",
576 else if (strcmp (line, "TopLevelAdmin") == 0)
577 readBool (infopath, "TopLevelAdmin", p, &retval->top_level_admin);
578 else if (strcmp (line, "LockDir") == 0)
580 if (retval->lock_dir)
581 free (retval->lock_dir);
582 retval->lock_dir = expand_path (p, cvsroot, false, infopath, ln);
583 /* Could try some validity checking, like whether we can
584 opendir it or something, but I don't see any particular
585 reason to do that now rather than waiting until lock.c. */
587 else if (strcmp (line, "HistoryLogPath") == 0)
589 if (retval->HistoryLogPath) free (retval->HistoryLogPath);
591 /* Expand ~ & $VARs. */
592 retval->HistoryLogPath = expand_path (p, cvsroot, false,
595 if (retval->HistoryLogPath && !ISABSOLUTE (retval->HistoryLogPath))
597 error (0, 0, "%s [%u]: HistoryLogPath must be absolute.",
599 free (retval->HistoryLogPath);
600 retval->HistoryLogPath = NULL;
603 else if (strcmp (line, "HistorySearchPath") == 0)
605 if (retval->HistorySearchPath) free (retval->HistorySearchPath);
606 retval->HistorySearchPath = expand_path (p, cvsroot, false,
609 if (retval->HistorySearchPath
610 && !ISABSOLUTE (retval->HistorySearchPath))
612 error (0, 0, "%s [%u]: HistorySearchPath must be absolute.",
614 free (retval->HistorySearchPath);
615 retval->HistorySearchPath = NULL;
618 else if (strcmp (line, "LogHistory") == 0)
620 if (strcmp (p, "all") != 0)
622 static bool gotone = false;
625 %s [%u]: warning: duplicate LogHistory entry found.",
629 free (retval->logHistory);
630 retval->logHistory = xstrdup (p);
633 else if (strcmp (line, "RereadLogAfterVerify") == 0)
635 if (!strcasecmp (p, "never"))
636 retval->RereadLogAfterVerify = LOGMSG_REREAD_NEVER;
637 else if (!strcasecmp (p, "always"))
638 retval->RereadLogAfterVerify = LOGMSG_REREAD_ALWAYS;
639 else if (!strcasecmp (p, "stat"))
640 retval->RereadLogAfterVerify = LOGMSG_REREAD_STAT;
644 if (readBool (infopath, "RereadLogAfterVerify", p, &tmp))
647 retval->RereadLogAfterVerify = LOGMSG_REREAD_ALWAYS;
649 retval->RereadLogAfterVerify = LOGMSG_REREAD_NEVER;
653 else if (strcmp (line, "TmpDir") == 0)
655 if (retval->TmpDir) free (retval->TmpDir);
656 retval->TmpDir = expand_path (p, cvsroot, false, infopath, ln);
657 /* Could try some validity checking, like whether we can
658 * opendir it or something, but I don't see any particular
659 * reason to do that now rather than when the first function
660 * tries to create a temp file.
663 else if (strcmp (line, "UserAdminOptions") == 0)
664 retval->UserAdminOptions = xstrdup (p);
665 else if (strcmp (line, "UseNewInfoFmtStrings") == 0)
666 #ifdef SUPPORT_OLD_INFO_FMT_STRINGS
667 readBool (infopath, "UseNewInfoFmtStrings", p,
668 &retval->UseNewInfoFmtStrings);
669 #else /* !SUPPORT_OLD_INFO_FMT_STRINGS */
672 if (readBool (infopath, "UseNewInfoFmtStrings", p, &dummy)
675 "%s [%u]: Old style info format strings not supported by this executable.",
678 #endif /* SUPPORT_OLD_INFO_FMT_STRINGS */
679 else if (strcmp (line, "ImportNewFilesToVendorBranchOnly") == 0)
680 readBool (infopath, "ImportNewFilesToVendorBranchOnly", p,
681 &retval->ImportNewFilesToVendorBranchOnly);
682 else if (strcmp (line, "PrimaryServer") == 0)
683 retval->PrimaryServer = parse_cvsroot (p);
685 else if (!strcmp (line, "MaxProxyBufferSize"))
686 readSizeT (infopath, "MaxProxyBufferSize", p,
687 &retval->MaxProxyBufferSize);
688 #endif /* PROXY_SUPPORT */
689 else if (!strcmp (line, "MaxCommentLeaderLength"))
690 readSizeT (infopath, "MaxCommentLeaderLength", p,
691 &retval->MaxCommentLeaderLength);
692 else if (!strcmp (line, "UseArchiveCommentLeader"))
693 readBool (infopath, "UseArchiveCommentLeader", p,
694 &retval->UseArchiveCommentLeader);
695 #ifdef SERVER_SUPPORT
696 else if (!strcmp (line, "MinCompressionLevel"))
697 readSizeT (infopath, "MinCompressionLevel", p,
698 &retval->MinCompressionLevel);
699 else if (!strcmp (line, "MaxCompressionLevel"))
700 readSizeT (infopath, "MaxCompressionLevel", p,
701 &retval->MaxCompressionLevel);
702 #endif /* SERVER_SUPPORT */
704 /* We may be dealing with a keyword which was added in a
705 subsequent version of CVS. In that case it is a good idea
706 to complain, as (1) the keyword might enable a behavior like
707 alternate locking behavior, in which it is dangerous and hard
708 to detect if some CVS's have it one way and others have it
709 the other way, (2) in general, having us not do what the user
710 had in mind when they put in the keyword violates the
711 principle of least surprise. Note that one corollary is
712 adding new keywords to your CVSROOT/config file is not
713 particularly recommended unless you are planning on using
715 if (!parse_error (infopath, ln))
716 error (0, 0, "%s [%u]: unrecognized keyword `%s'",
719 if (ferror (fp_info))
720 error (0, errno, "cannot read %s", infopath);
721 if (fclose (fp_info) < 0)
722 error (0, errno, "cannot close %s", infopath);
723 if (freeinfopath) free (freeinfopath);
726 if (path == NULL && !rescan++) {
727 infopath = freeinfopath =
728 Xasprintf ("%s/%s/%s", cvsroot, CVSROOTADM, CVSROOTADM_OPTIONS);