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 everything /*{{{*/
426 // ---------------------------------------------------------------------
427 void Configuration::Clear()
429 const Configuration::Item
*Top
= Tree(0);
432 Clear(Top
->FullTag());
437 // Configuration::Clear - Clear an entire tree /*{{{*/
438 // ---------------------------------------------------------------------
440 void Configuration::Clear(string
const &Name
)
442 Item
*Top
= Lookup(Name
.c_str(),false);
458 while (Top
!= 0 && Top
->Next
== 0)
475 // Configuration::Exists - Returns true if the Name exists /*{{{*/
476 // ---------------------------------------------------------------------
478 bool Configuration::Exists(const char *Name
) const
480 const Item
*Itm
= Lookup(Name
);
486 // Configuration::ExistsAny - Returns true if the Name, possibly /*{{{*/
487 // ---------------------------------------------------------------------
488 /* qualified by /[fdbi] exists */
489 bool Configuration::ExistsAny(const char *Name
) const
493 if (key
.size() > 2 && key
.end()[-2] == '/')
495 if (key
.find_first_of("fdbi",key
.size()-1) < key
.size())
497 key
.resize(key
.size() - 2);
498 if (Exists(key
.c_str()))
503 _error
->Warning(_("Unrecognized type abbreviation: '%c'"), key
.end()[-3]);
509 // Configuration::Dump - Dump the config /*{{{*/
510 // ---------------------------------------------------------------------
511 /* Dump the entire configuration space */
512 void Configuration::Dump(ostream
& str
)
514 Dump(str
, NULL
, "%f \"%v\";\n", true);
516 void Configuration::Dump(ostream
& str
, char const * const root
,
517 char const * const formatstr
, bool const emptyValue
)
519 const Configuration::Item
* Top
= Tree(root
);
522 const Configuration::Item
* const Root
= (root
== NULL
) ? NULL
: Top
;
523 std::vector
<std::string
> const format
= VectorizeString(formatstr
, '%');
525 /* Write out all of the configuration directives by walking the
526 configuration tree */
528 if (emptyValue
== true || Top
->Value
.empty() == emptyValue
)
530 std::vector
<std::string
>::const_iterator f
= format
.begin();
532 for (++f
; f
!= format
.end(); ++f
)
534 if (f
->empty() == true)
540 char const type
= (*f
)[0];
542 str
<< Top
->FullTag();
543 else if (type
== 't')
545 else if (type
== 'v')
547 else if (type
== 'F')
548 str
<< QuoteString(Top
->FullTag(), "=\"\n");
549 else if (type
== 'T')
550 str
<< QuoteString(Top
->Tag
, "=\"\n");
551 else if (type
== 'V')
552 str
<< QuoteString(Top
->Value
, "=\"\n");
553 else if (type
== 'n')
555 else if (type
== 'N')
559 str
<< f
->c_str() + 1;
569 while (Top
!= 0 && Top
->Next
== 0)
576 const Configuration::Item
* I
= Top
;
591 // Configuration::Item::FullTag - Return the fully scoped tag /*{{{*/
592 // ---------------------------------------------------------------------
593 /* Stop sets an optional max recursion depth if this item is being viewed as
594 part of a sub tree. */
595 string
Configuration::Item::FullTag(const Item
*Stop
) const
597 if (Parent
== 0 || Parent
->Parent
== 0 || Parent
== Stop
)
599 return Parent
->FullTag(Stop
) + "::" + Tag
;
603 // ReadConfigFile - Read a configuration file /*{{{*/
604 // ---------------------------------------------------------------------
605 /* The configuration format is very much like the named.conf format
606 used in bind8, in fact this routine can parse most named.conf files.
607 Sectional config files are like bind's named.conf where there are
608 sections like 'zone "foo.org" { .. };' This causes each section to be
609 added in with a tag like "zone::foo.org" instead of being split
610 tag/value. AsSectional enables Sectional parsing.*/
611 bool ReadConfigFile(Configuration
&Conf
,const string
&FName
,bool const &AsSectional
,
612 unsigned const &Depth
)
614 // Open the stream for reading
615 ifstream
F(FName
.c_str(),ios::in
);
617 return _error
->Errno("ifstream::ifstream",_("Opening configuration file %s"),FName
.c_str());
621 unsigned int StackPos
= 0;
627 bool InComment
= false;
628 while (F
.eof() == false)
630 // The raw input line.
632 // The input line with comments stripped.
633 std::string Fragment
;
635 // Grab the next line of F and place it in Input.
638 char *Buffer
= new char[1024];
641 F
.getline(Buffer
,sizeof(Buffer
) / 2);
646 while (F
.fail() && !F
.eof());
648 // Expand tabs in the input line and remove leading and trailing
651 const int BufferSize
= Input
.size() * 8 + 1;
652 char *Buffer
= new char[BufferSize
];
655 memcpy(Buffer
, Input
.c_str(), Input
.size() + 1);
657 _strtabexpand(Buffer
, BufferSize
);
670 // Now strip comments; if the whole line is contained in a
671 // comment, skip this line.
673 // The first meaningful character in the current fragment; will
674 // be adjusted below as we remove bytes from the front.
675 std::string::const_iterator Start
= Input
.begin();
676 // The last meaningful character in the current fragment.
677 std::string::const_iterator End
= Input
.end();
679 // Multi line comment
680 if (InComment
== true)
682 for (std::string::const_iterator I
= Start
;
685 if (*I
== '*' && I
+ 1 != End
&& I
[1] == '/')
692 if (InComment
== true)
696 // Discard single line comments
697 bool InQuote
= false;
698 for (std::string::const_iterator I
= Start
;
706 if ((*I
== '/' && I
+ 1 != End
&& I
[1] == '/') ||
707 (*I
== '#' && strcmp(string(I
,I
+6).c_str(),"#clear") != 0 &&
708 strcmp(string(I
,I
+8).c_str(),"#include") != 0))
715 // Look for multi line comments and build up the
717 Fragment
.reserve(End
- Start
);
719 for (std::string::const_iterator I
= Start
;
725 Fragment
.push_back(*I
);
726 else if (*I
== '/' && I
+ 1 != End
&& I
[1] == '*')
729 for (std::string::const_iterator J
= I
;
732 if (*J
== '*' && J
+ 1 != End
&& J
[1] == '/')
734 // Pretend we just finished walking over the
735 // comment, and don't add anything to the output
743 if (InComment
== true)
747 Fragment
.push_back(*I
);
751 if (Fragment
.empty())
754 // The line has actual content; interpret what it means.
756 Start
= Fragment
.begin();
757 End
= Fragment
.end();
758 for (std::string::const_iterator I
= Start
;
764 if (InQuote
== false && (*I
== '{' || *I
== ';' || *I
== '}'))
766 // Put the last fragment into the buffer
767 std::string::const_iterator NonWhitespaceStart
= Start
;
768 std::string::const_iterator NonWhitespaceStop
= I
;
769 for (; NonWhitespaceStart
!= I
&& isspace(*NonWhitespaceStart
) != 0; ++NonWhitespaceStart
)
771 for (; NonWhitespaceStop
!= NonWhitespaceStart
&& isspace(NonWhitespaceStop
[-1]) != 0; --NonWhitespaceStop
)
773 if (LineBuffer
.empty() == false && NonWhitespaceStop
- NonWhitespaceStart
!= 0)
775 LineBuffer
+= string(NonWhitespaceStart
, NonWhitespaceStop
);
777 // Drop this from the input string, saving the character
778 // that terminated the construct we just closed. (i.e., a
779 // brace or a semicolon)
784 if (TermChar
== '{' && LineBuffer
.empty() == true)
785 return _error
->Error(_("Syntax error %s:%u: Block starts with no name."),FName
.c_str(),CurLine
);
787 // No string on this line
788 if (LineBuffer
.empty() == true)
793 ParentTag
= string();
795 ParentTag
= Stack
[--StackPos
];
802 const char *Pos
= LineBuffer
.c_str();
803 if (ParseQuoteWord(Pos
,Tag
) == false)
804 return _error
->Error(_("Syntax error %s:%u: Malformed tag"),FName
.c_str(),CurLine
);
806 // Parse off the word
809 if (ParseCWord(Pos
,Word
) == false &&
810 ParseQuoteWord(Pos
,Word
) == false)
820 if (strlen(Pos
) != 0)
821 return _error
->Error(_("Syntax error %s:%u: Extra junk after value"),FName
.c_str(),CurLine
);
827 Stack
[StackPos
++] = ParentTag
;
829 /* Make sectional tags incorperate the section into the
831 if (AsSectional
== true && Word
.empty() == false)
838 if (ParentTag
.empty() == true)
841 ParentTag
+= string("::") + Tag
;
845 // Generate the item name
847 if (ParentTag
.empty() == true)
851 if (TermChar
!= '{' || Tag
.empty() == false)
852 Item
= ParentTag
+ "::" + Tag
;
858 if (Tag
.length() >= 1 && Tag
[0] == '#')
860 if (ParentTag
.empty() == false)
861 return _error
->Error(_("Syntax error %s:%u: Directives can only be done at the top level"),FName
.c_str(),CurLine
);
862 Tag
.erase(Tag
.begin());
865 else if (Tag
== "include")
868 return _error
->Error(_("Syntax error %s:%u: Too many nested includes"),FName
.c_str(),CurLine
);
869 if (Word
.length() > 2 && Word
.end()[-1] == '/')
871 if (ReadConfigDir(Conf
,Word
,AsSectional
,Depth
+1) == false)
872 return _error
->Error(_("Syntax error %s:%u: Included from here"),FName
.c_str(),CurLine
);
876 if (ReadConfigFile(Conf
,Word
,AsSectional
,Depth
+1) == false)
877 return _error
->Error(_("Syntax error %s:%u: Included from here"),FName
.c_str(),CurLine
);
881 return _error
->Error(_("Syntax error %s:%u: Unsupported directive '%s'"),FName
.c_str(),CurLine
,Tag
.c_str());
883 else if (Tag
.empty() == true && NoWord
== false && Word
== "#clear")
884 return _error
->Error(_("Syntax error %s:%u: clear directive requires an option tree as argument"),FName
.c_str(),CurLine
);
887 // Set the item in the configuration class
895 // Move up a tag, but only if there is no bit to parse
901 ParentTag
= Stack
[--StackPos
];
907 // Store the remaining text, if any, in the current line buffer.
909 // NB: could change this to use string-based operations; I'm
910 // using strstrip now to ensure backwards compatibility.
911 // -- dburrows 2008-04-01
913 char *Buffer
= new char[End
- Start
+ 1];
916 std::copy(Start
, End
, Buffer
);
917 Buffer
[End
- Start
] = '\0';
919 const char *Stripd
= _strstrip(Buffer
);
920 if (*Stripd
!= 0 && LineBuffer
.empty() == false)
922 LineBuffer
+= Stripd
;
933 if (LineBuffer
.empty() == false)
934 return _error
->Error(_("Syntax error %s:%u: Extra junk at end of file"),FName
.c_str(),CurLine
);
938 // ReadConfigDir - Read a directory of config files /*{{{*/
939 // ---------------------------------------------------------------------
941 bool ReadConfigDir(Configuration
&Conf
,const string
&Dir
,
942 bool const &AsSectional
, unsigned const &Depth
)
944 vector
<string
> const List
= GetListOfFilesInDir(Dir
, "conf", true, true);
947 for (vector
<string
>::const_iterator I
= List
.begin(); I
!= List
.end(); ++I
)
948 if (ReadConfigFile(Conf
,*I
,AsSectional
,Depth
) == false)
953 // MatchAgainstConfig Constructor /*{{{*/
954 Configuration::MatchAgainstConfig::MatchAgainstConfig(char const * Config
)
956 std::vector
<std::string
> const strings
= _config
->FindVector(Config
);
957 for (std::vector
<std::string
>::const_iterator s
= strings
.begin();
958 s
!= strings
.end(); ++s
)
960 regex_t
*p
= new regex_t
;
961 if (regcomp(p
, s
->c_str(), REG_EXTENDED
| REG_ICASE
| REG_NOSUB
) == 0)
962 patterns
.push_back(p
);
967 _error
->Warning("Invalid regular expression '%s' in configuration "
968 "option '%s' will be ignored.",
973 if (strings
.size() == 0)
974 patterns
.push_back(NULL
);
977 // MatchAgainstConfig Destructor /*{{{*/
978 Configuration::MatchAgainstConfig::~MatchAgainstConfig()
982 void Configuration::MatchAgainstConfig::clearPatterns()
984 for(std::vector
<regex_t
*>::const_iterator p
= patterns
.begin();
985 p
!= patterns
.end(); ++p
)
987 if (*p
== NULL
) continue;
994 // MatchAgainstConfig::Match - returns true if a pattern matches /*{{{*/
995 bool Configuration::MatchAgainstConfig::Match(char const * str
) const
997 for(std::vector
<regex_t
*>::const_iterator p
= patterns
.begin();
998 p
!= patterns
.end(); ++p
)
999 if (*p
!= NULL
&& regexec(*p
, str
, 0, 0, 0) == 0)