1 // -*- mode: cpp; mode: fold -*-
3 // $Id: configuration.cc,v 1.28 2004/04/30 04:00:15 mdz Exp $
4 /* ######################################################################
8 This class provides a configuration file and command line parser
9 for a tree-oriented configuration environment. All runtime configuration
12 This source is placed in the Public Domain, do with it what you will
13 It was originally written by Jason Gunthorpe <jgg@debian.org>.
15 ##################################################################### */
17 // Include files /*{{{*/
20 #include <apt-pkg/configuration.h>
21 #include <apt-pkg/error.h>
22 #include <apt-pkg/strutl.h>
23 #include <apt-pkg/fileutl.h>
34 Configuration
*_config
= new Configuration
;
36 // Configuration::Configuration - Constructor /*{{{*/
37 // ---------------------------------------------------------------------
39 Configuration::Configuration() : ToFree(true)
43 Configuration::Configuration(const Item
*Root
) : Root((Item
*)Root
), ToFree(false)
48 // Configuration::~Configuration - Destructor /*{{{*/
49 // ---------------------------------------------------------------------
51 Configuration::~Configuration()
65 while (Top
!= 0 && Top
->Next
== 0)
67 Item
*Parent
= Top
->Parent
;
73 Item
*Next
= Top
->Next
;
80 // Configuration::Lookup - Lookup a single item /*{{{*/
81 // ---------------------------------------------------------------------
82 /* This will lookup a single item by name below another item. It is a
83 helper function for the main lookup function */
84 Configuration::Item
*Configuration::Lookup(Item
*Head
,const char *S
,
85 unsigned long const &Len
,bool const &Create
)
88 Item
*I
= Head
->Child
;
89 Item
**Last
= &Head
->Child
;
91 // Empty strings match nothing. They are used for lists.
94 for (; I
!= 0; Last
= &I
->Next
, I
= I
->Next
)
95 if ((Res
= stringcasecmp(I
->Tag
,S
,S
+ Len
)) == 0)
99 for (; I
!= 0; Last
= &I
->Next
, I
= I
->Next
);
107 I
->Tag
.assign(S
,Len
);
114 // Configuration::Lookup - Lookup a fully scoped item /*{{{*/
115 // ---------------------------------------------------------------------
116 /* This performs a fully scoped lookup of a given name, possibly creating
118 Configuration::Item
*Configuration::Lookup(const char *Name
,bool const &Create
)
123 const char *Start
= Name
;
124 const char *End
= Start
+ strlen(Name
);
125 const char *TagEnd
= Name
;
127 for (; End
- TagEnd
>= 2; TagEnd
++)
129 if (TagEnd
[0] == ':' && TagEnd
[1] == ':')
131 Itm
= Lookup(Itm
,Start
,TagEnd
- Start
,Create
);
134 TagEnd
= Start
= TagEnd
+ 2;
138 // This must be a trailing ::, we create unique items in a list
139 if (End
- Start
== 0)
145 Itm
= Lookup(Itm
,Start
,End
- Start
,Create
);
149 // Configuration::Find - Find a value /*{{{*/
150 // ---------------------------------------------------------------------
152 string
Configuration::Find(const char *Name
,const char *Default
) const
154 const Item
*Itm
= Lookup(Name
);
155 if (Itm
== 0 || Itm
->Value
.empty() == true)
166 // Configuration::FindFile - Find a Filename /*{{{*/
167 // ---------------------------------------------------------------------
168 /* Directories are stored as the base dir in the Parent node and the
169 sub directory in sub nodes with the final node being the end filename
171 string
Configuration::FindFile(const char *Name
,const char *Default
) const
173 const Item
*RootItem
= Lookup("RootDir");
174 std::string result
= (RootItem
== 0) ? "" : RootItem
->Value
;
175 if(result
.empty() == false && result
[result
.size() - 1] != '/')
176 result
.push_back('/');
178 const Item
*Itm
= Lookup(Name
);
179 if (Itm
== 0 || Itm
->Value
.empty() == true)
182 result
.append(Default
);
186 string val
= Itm
->Value
;
187 while (Itm
->Parent
!= 0)
189 if (Itm
->Parent
->Value
.empty() == true)
196 if (val
.length() >= 1 && val
[0] == '/')
198 if (val
.compare(0, 9, "/dev/null") == 0)
204 if (val
.length() >= 2 && (val
[0] == '~' || val
[0] == '.') && val
[1] == '/')
208 if (val
.length() >= 3 && val
[0] == '.' && val
[1] == '.' && val
[2] == '/')
211 if (Itm
->Parent
->Value
.end()[-1] != '/')
214 val
.insert(0, Itm
->Parent
->Value
);
220 // do some normalisation by removing // and /./ from the path
221 size_t found
= string::npos
;
222 while ((found
= result
.find("/./")) != string::npos
)
223 result
.replace(found
, 3, "/");
224 while ((found
= result
.find("//")) != string::npos
)
225 result
.replace(found
, 2, "/");
230 // Configuration::FindDir - Find a directory name /*{{{*/
231 // ---------------------------------------------------------------------
232 /* This is like findfile execept the result is terminated in a / */
233 string
Configuration::FindDir(const char *Name
,const char *Default
) const
235 string Res
= FindFile(Name
,Default
);
236 if (Res
.end()[-1] != '/')
238 size_t const found
= Res
.rfind("/dev/null");
239 if (found
!= string::npos
&& found
== Res
.size() - 9)
240 return Res
; // /dev/null returning
246 // Configuration::FindVector - Find a vector of values /*{{{*/
247 // ---------------------------------------------------------------------
248 /* Returns a vector of config values under the given item */
249 vector
<string
> Configuration::FindVector(const char *Name
) const
252 const Item
*Top
= Lookup(Name
);
256 Item
*I
= Top
->Child
;
259 Vec
.push_back(I
->Value
);
265 // Configuration::FindI - Find an integer value /*{{{*/
266 // ---------------------------------------------------------------------
268 int Configuration::FindI(const char *Name
,int const &Default
) const
270 const Item
*Itm
= Lookup(Name
);
271 if (Itm
== 0 || Itm
->Value
.empty() == true)
275 int Res
= strtol(Itm
->Value
.c_str(),&End
,0);
276 if (End
== Itm
->Value
.c_str())
282 // Configuration::FindB - Find a boolean type /*{{{*/
283 // ---------------------------------------------------------------------
285 bool Configuration::FindB(const char *Name
,bool const &Default
) const
287 const Item
*Itm
= Lookup(Name
);
288 if (Itm
== 0 || Itm
->Value
.empty() == true)
291 return StringToBool(Itm
->Value
,Default
);
294 // Configuration::FindAny - Find an arbitrary type /*{{{*/
295 // ---------------------------------------------------------------------
296 /* a key suffix of /f, /d, /b or /i calls Find{File,Dir,B,I} */
297 string
Configuration::FindAny(const char *Name
,const char *Default
) const
302 if (key
.size() > 2 && key
.end()[-2] == '/')
304 type
= key
.end()[-1];
305 key
.resize(key
.size() - 2);
312 return FindFile(key
.c_str(), Default
);
316 return FindDir(key
.c_str(), Default
);
320 return FindB(key
, Default
) ? "true" : "false";
326 snprintf(buf
, sizeof(buf
)-1, "%d", FindI(key
, Default
? atoi(Default
) : 0 ));
332 return Find(Name
, Default
);
335 // Configuration::CndSet - Conditinal Set a value /*{{{*/
336 // ---------------------------------------------------------------------
337 /* This will not overwrite */
338 void Configuration::CndSet(const char *Name
,const string
&Value
)
340 Item
*Itm
= Lookup(Name
,true);
343 if (Itm
->Value
.empty() == true)
347 // Configuration::Set - Set an integer value /*{{{*/
348 // ---------------------------------------------------------------------
350 void Configuration::CndSet(const char *Name
,int const Value
)
352 Item
*Itm
= Lookup(Name
,true);
353 if (Itm
== 0 || Itm
->Value
.empty() == false)
356 snprintf(S
,sizeof(S
),"%i",Value
);
360 // Configuration::Set - Set a value /*{{{*/
361 // ---------------------------------------------------------------------
363 void Configuration::Set(const char *Name
,const string
&Value
)
365 Item
*Itm
= Lookup(Name
,true);
371 // Configuration::Set - Set an integer value /*{{{*/
372 // ---------------------------------------------------------------------
374 void Configuration::Set(const char *Name
,int const &Value
)
376 Item
*Itm
= Lookup(Name
,true);
380 snprintf(S
,sizeof(S
),"%i",Value
);
384 // Configuration::Clear - Clear an single value from a list /*{{{*/
385 // ---------------------------------------------------------------------
387 void Configuration::Clear(string
const &Name
, int const &Value
)
390 snprintf(S
,sizeof(S
),"%i",Value
);
394 // Configuration::Clear - Clear an single value from a list /*{{{*/
395 // ---------------------------------------------------------------------
397 void Configuration::Clear(string
const &Name
, string
const &Value
)
399 Item
*Top
= Lookup(Name
.c_str(),false);
400 if (Top
== 0 || Top
->Child
== 0)
403 Item
*Tmp
, *Prev
, *I
;
404 Prev
= I
= Top
->Child
;
408 if(I
->Value
== Value
)
411 // was first element, point parent to new first element
412 if(Top
->Child
== Tmp
)
413 Top
->Child
= I
->Next
;
425 // Configuration::Clear - Clear an entire tree /*{{{*/
426 // ---------------------------------------------------------------------
428 void Configuration::Clear(string
const &Name
)
430 Item
*Top
= Lookup(Name
.c_str(),false);
446 while (Top
!= 0 && Top
->Next
== 0)
463 // Configuration::Exists - Returns true if the Name exists /*{{{*/
464 // ---------------------------------------------------------------------
466 bool Configuration::Exists(const char *Name
) const
468 const Item
*Itm
= Lookup(Name
);
474 // Configuration::ExistsAny - Returns true if the Name, possibly /*{{{*/
475 // ---------------------------------------------------------------------
476 /* qualified by /[fdbi] exists */
477 bool Configuration::ExistsAny(const char *Name
) const
481 if (key
.size() > 2 && key
.end()[-2] == '/')
483 if (key
.find_first_of("fdbi",key
.size()-1) < key
.size())
485 key
.resize(key
.size() - 2);
486 if (Exists(key
.c_str()))
491 _error
->Warning(_("Unrecognized type abbreviation: '%c'"), key
.end()[-3]);
497 // Configuration::Dump - Dump the config /*{{{*/
498 // ---------------------------------------------------------------------
499 /* Dump the entire configuration space */
500 void Configuration::Dump(ostream
& str
)
502 Dump(str
, NULL
, "%f \"%v\";\n", true);
504 void Configuration::Dump(ostream
& str
, char const * const root
,
505 char const * const formatstr
, bool const emptyValue
)
507 const Configuration::Item
* Top
= Tree(root
);
510 const Configuration::Item
* const Root
= (root
== NULL
) ? NULL
: Top
;
511 std::vector
<std::string
> const format
= VectorizeString(formatstr
, '%');
513 /* Write out all of the configuration directives by walking the
514 configuration tree */
516 if (emptyValue
== true || Top
->Value
.empty() == emptyValue
)
518 std::vector
<std::string
>::const_iterator f
= format
.begin();
520 for (++f
; f
!= format
.end(); ++f
)
522 if (f
->empty() == true)
528 char const type
= (*f
)[0];
530 str
<< Top
->FullTag();
531 else if (type
== 't')
533 else if (type
== 'v')
535 else if (type
== 'F')
536 str
<< QuoteString(Top
->FullTag(), "=\"\n");
537 else if (type
== 'T')
538 str
<< QuoteString(Top
->Tag
, "=\"\n");
539 else if (type
== 'V')
540 str
<< QuoteString(Top
->Value
, "=\"\n");
541 else if (type
== 'n')
543 else if (type
== 'N')
547 str
<< f
->c_str() + 1;
557 while (Top
!= 0 && Top
->Next
== 0)
564 const Configuration::Item
* I
= Top
;
579 // Configuration::Item::FullTag - Return the fully scoped tag /*{{{*/
580 // ---------------------------------------------------------------------
581 /* Stop sets an optional max recursion depth if this item is being viewed as
582 part of a sub tree. */
583 string
Configuration::Item::FullTag(const Item
*Stop
) const
585 if (Parent
== 0 || Parent
->Parent
== 0 || Parent
== Stop
)
587 return Parent
->FullTag(Stop
) + "::" + Tag
;
591 // ReadConfigFile - Read a configuration file /*{{{*/
592 // ---------------------------------------------------------------------
593 /* The configuration format is very much like the named.conf format
594 used in bind8, in fact this routine can parse most named.conf files.
595 Sectional config files are like bind's named.conf where there are
596 sections like 'zone "foo.org" { .. };' This causes each section to be
597 added in with a tag like "zone::foo.org" instead of being split
598 tag/value. AsSectional enables Sectional parsing.*/
599 bool ReadConfigFile(Configuration
&Conf
,const string
&FName
,bool const &AsSectional
,
600 unsigned const &Depth
)
602 // Open the stream for reading
603 ifstream
F(FName
.c_str(),ios::in
);
605 return _error
->Errno("ifstream::ifstream",_("Opening configuration file %s"),FName
.c_str());
609 unsigned int StackPos
= 0;
615 bool InComment
= false;
616 while (F
.eof() == false)
618 // The raw input line.
620 // The input line with comments stripped.
621 std::string Fragment
;
623 // Grab the next line of F and place it in Input.
626 char *Buffer
= new char[1024];
629 F
.getline(Buffer
,sizeof(Buffer
) / 2);
634 while (F
.fail() && !F
.eof());
636 // Expand tabs in the input line and remove leading and trailing
639 const int BufferSize
= Input
.size() * 8 + 1;
640 char *Buffer
= new char[BufferSize
];
643 memcpy(Buffer
, Input
.c_str(), Input
.size() + 1);
645 _strtabexpand(Buffer
, BufferSize
);
658 // Now strip comments; if the whole line is contained in a
659 // comment, skip this line.
661 // The first meaningful character in the current fragment; will
662 // be adjusted below as we remove bytes from the front.
663 std::string::const_iterator Start
= Input
.begin();
664 // The last meaningful character in the current fragment.
665 std::string::const_iterator End
= Input
.end();
667 // Multi line comment
668 if (InComment
== true)
670 for (std::string::const_iterator I
= Start
;
673 if (*I
== '*' && I
+ 1 != End
&& I
[1] == '/')
680 if (InComment
== true)
684 // Discard single line comments
685 bool InQuote
= false;
686 for (std::string::const_iterator I
= Start
;
694 if ((*I
== '/' && I
+ 1 != End
&& I
[1] == '/') ||
695 (*I
== '#' && strcmp(string(I
,I
+6).c_str(),"#clear") != 0 &&
696 strcmp(string(I
,I
+8).c_str(),"#include") != 0))
703 // Look for multi line comments and build up the
705 Fragment
.reserve(End
- Start
);
707 for (std::string::const_iterator I
= Start
;
713 Fragment
.push_back(*I
);
714 else if (*I
== '/' && I
+ 1 != End
&& I
[1] == '*')
717 for (std::string::const_iterator J
= I
;
720 if (*J
== '*' && J
+ 1 != End
&& J
[1] == '/')
722 // Pretend we just finished walking over the
723 // comment, and don't add anything to the output
731 if (InComment
== true)
735 Fragment
.push_back(*I
);
739 if (Fragment
.empty())
742 // The line has actual content; interpret what it means.
744 Start
= Fragment
.begin();
745 End
= Fragment
.end();
746 for (std::string::const_iterator I
= Start
;
752 if (InQuote
== false && (*I
== '{' || *I
== ';' || *I
== '}'))
754 // Put the last fragment into the buffer
755 std::string::const_iterator NonWhitespaceStart
= Start
;
756 std::string::const_iterator NonWhitespaceStop
= I
;
757 for (; NonWhitespaceStart
!= I
&& isspace(*NonWhitespaceStart
) != 0; ++NonWhitespaceStart
)
759 for (; NonWhitespaceStop
!= NonWhitespaceStart
&& isspace(NonWhitespaceStop
[-1]) != 0; --NonWhitespaceStop
)
761 if (LineBuffer
.empty() == false && NonWhitespaceStop
- NonWhitespaceStart
!= 0)
763 LineBuffer
+= string(NonWhitespaceStart
, NonWhitespaceStop
);
765 // Drop this from the input string, saving the character
766 // that terminated the construct we just closed. (i.e., a
767 // brace or a semicolon)
772 if (TermChar
== '{' && LineBuffer
.empty() == true)
773 return _error
->Error(_("Syntax error %s:%u: Block starts with no name."),FName
.c_str(),CurLine
);
775 // No string on this line
776 if (LineBuffer
.empty() == true)
781 ParentTag
= string();
783 ParentTag
= Stack
[--StackPos
];
790 const char *Pos
= LineBuffer
.c_str();
791 if (ParseQuoteWord(Pos
,Tag
) == false)
792 return _error
->Error(_("Syntax error %s:%u: Malformed tag"),FName
.c_str(),CurLine
);
794 // Parse off the word
797 if (ParseCWord(Pos
,Word
) == false &&
798 ParseQuoteWord(Pos
,Word
) == false)
808 if (strlen(Pos
) != 0)
809 return _error
->Error(_("Syntax error %s:%u: Extra junk after value"),FName
.c_str(),CurLine
);
815 Stack
[StackPos
++] = ParentTag
;
817 /* Make sectional tags incorperate the section into the
819 if (AsSectional
== true && Word
.empty() == false)
826 if (ParentTag
.empty() == true)
829 ParentTag
+= string("::") + Tag
;
833 // Generate the item name
835 if (ParentTag
.empty() == true)
839 if (TermChar
!= '{' || Tag
.empty() == false)
840 Item
= ParentTag
+ "::" + Tag
;
846 if (Tag
.length() >= 1 && Tag
[0] == '#')
848 if (ParentTag
.empty() == false)
849 return _error
->Error(_("Syntax error %s:%u: Directives can only be done at the top level"),FName
.c_str(),CurLine
);
850 Tag
.erase(Tag
.begin());
853 else if (Tag
== "include")
856 return _error
->Error(_("Syntax error %s:%u: Too many nested includes"),FName
.c_str(),CurLine
);
857 if (Word
.length() > 2 && Word
.end()[-1] == '/')
859 if (ReadConfigDir(Conf
,Word
,AsSectional
,Depth
+1) == false)
860 return _error
->Error(_("Syntax error %s:%u: Included from here"),FName
.c_str(),CurLine
);
864 if (ReadConfigFile(Conf
,Word
,AsSectional
,Depth
+1) == false)
865 return _error
->Error(_("Syntax error %s:%u: Included from here"),FName
.c_str(),CurLine
);
869 return _error
->Error(_("Syntax error %s:%u: Unsupported directive '%s'"),FName
.c_str(),CurLine
,Tag
.c_str());
871 else if (Tag
.empty() == true && NoWord
== false && Word
== "#clear")
872 return _error
->Error(_("Syntax error %s:%u: clear directive requires an option tree as argument"),FName
.c_str(),CurLine
);
875 // Set the item in the configuration class
883 // Move up a tag, but only if there is no bit to parse
889 ParentTag
= Stack
[--StackPos
];
895 // Store the remaining text, if any, in the current line buffer.
897 // NB: could change this to use string-based operations; I'm
898 // using strstrip now to ensure backwards compatibility.
899 // -- dburrows 2008-04-01
901 char *Buffer
= new char[End
- Start
+ 1];
904 std::copy(Start
, End
, Buffer
);
905 Buffer
[End
- Start
] = '\0';
907 const char *Stripd
= _strstrip(Buffer
);
908 if (*Stripd
!= 0 && LineBuffer
.empty() == false)
910 LineBuffer
+= Stripd
;
921 if (LineBuffer
.empty() == false)
922 return _error
->Error(_("Syntax error %s:%u: Extra junk at end of file"),FName
.c_str(),CurLine
);
926 // ReadConfigDir - Read a directory of config files /*{{{*/
927 // ---------------------------------------------------------------------
929 bool ReadConfigDir(Configuration
&Conf
,const string
&Dir
,
930 bool const &AsSectional
, unsigned const &Depth
)
932 vector
<string
> const List
= GetListOfFilesInDir(Dir
, "conf", true, true);
935 for (vector
<string
>::const_iterator I
= List
.begin(); I
!= List
.end(); ++I
)
936 if (ReadConfigFile(Conf
,*I
,AsSectional
,Depth
) == false)
941 // MatchAgainstConfig Constructor /*{{{*/
942 Configuration::MatchAgainstConfig::MatchAgainstConfig(char const * Config
)
944 std::vector
<std::string
> const strings
= _config
->FindVector(Config
);
945 for (std::vector
<std::string
>::const_iterator s
= strings
.begin();
946 s
!= strings
.end(); ++s
)
948 regex_t
*p
= new regex_t
;
949 if (regcomp(p
, s
->c_str(), REG_EXTENDED
| REG_ICASE
| REG_NOSUB
) == 0)
950 patterns
.push_back(p
);
955 _error
->Warning("Invalid regular expression '%s' in configuration "
956 "option '%s' will be ignored.",
961 if (strings
.size() == 0)
962 patterns
.push_back(NULL
);
965 // MatchAgainstConfig Destructor /*{{{*/
966 Configuration::MatchAgainstConfig::~MatchAgainstConfig()
970 void Configuration::MatchAgainstConfig::clearPatterns()
972 for(std::vector
<regex_t
*>::const_iterator p
= patterns
.begin();
973 p
!= patterns
.end(); ++p
)
975 if (*p
== NULL
) continue;
982 // MatchAgainstConfig::Match - returns true if a pattern matches /*{{{*/
983 bool Configuration::MatchAgainstConfig::Match(char const * str
) const
985 for(std::vector
<regex_t
*>::const_iterator p
= patterns
.begin();
986 p
!= patterns
.end(); ++p
)
987 if (*p
!= NULL
&& regexec(*p
, str
, 0, 0, 0) == 0)