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>
24 #include <apt-pkg/macros.h>
42 Configuration
*_config
= new Configuration
;
44 // Configuration::Configuration - Constructor /*{{{*/
45 // ---------------------------------------------------------------------
47 Configuration::Configuration() : ToFree(true)
51 Configuration::Configuration(const Item
*Root
) : Root((Item
*)Root
), ToFree(false)
55 // Configuration::~Configuration - Destructor /*{{{*/
56 // ---------------------------------------------------------------------
58 Configuration::~Configuration()
72 while (Top
!= 0 && Top
->Next
== 0)
74 Item
*Parent
= Top
->Parent
;
80 Item
*Next
= Top
->Next
;
87 // Configuration::Lookup - Lookup a single item /*{{{*/
88 // ---------------------------------------------------------------------
89 /* This will lookup a single item by name below another item. It is a
90 helper function for the main lookup function */
91 Configuration::Item
*Configuration::Lookup(Item
*Head
,const char *S
,
92 unsigned long const &Len
,bool const &Create
)
95 Item
*I
= Head
->Child
;
96 Item
**Last
= &Head
->Child
;
98 // Empty strings match nothing. They are used for lists.
101 for (; I
!= 0; Last
= &I
->Next
, I
= I
->Next
)
102 if ((Res
= stringcasecmp(I
->Tag
,S
,S
+ Len
)) == 0)
106 for (; I
!= 0; Last
= &I
->Next
, I
= I
->Next
);
114 I
->Tag
.assign(S
,Len
);
121 // Configuration::Lookup - Lookup a fully scoped item /*{{{*/
122 // ---------------------------------------------------------------------
123 /* This performs a fully scoped lookup of a given name, possibly creating
125 Configuration::Item
*Configuration::Lookup(const char *Name
,bool const &Create
)
130 const char *Start
= Name
;
131 const char *End
= Start
+ strlen(Name
);
132 const char *TagEnd
= Name
;
134 for (; End
- TagEnd
>= 2; TagEnd
++)
136 if (TagEnd
[0] == ':' && TagEnd
[1] == ':')
138 Itm
= Lookup(Itm
,Start
,TagEnd
- Start
,Create
);
141 TagEnd
= Start
= TagEnd
+ 2;
145 // This must be a trailing ::, we create unique items in a list
146 if (End
- Start
== 0)
152 Itm
= Lookup(Itm
,Start
,End
- Start
,Create
);
156 // Configuration::Find - Find a value /*{{{*/
157 // ---------------------------------------------------------------------
159 string
Configuration::Find(const char *Name
,const char *Default
) const
161 const Item
*Itm
= Lookup(Name
);
162 if (Itm
== 0 || Itm
->Value
.empty() == true)
173 // Configuration::FindFile - Find a Filename /*{{{*/
174 // ---------------------------------------------------------------------
175 /* Directories are stored as the base dir in the Parent node and the
176 sub directory in sub nodes with the final node being the end filename
178 string
Configuration::FindFile(const char *Name
,const char *Default
) const
180 const Item
*RootItem
= Lookup("RootDir");
181 std::string result
= (RootItem
== 0) ? "" : RootItem
->Value
;
182 if(result
.empty() == false && result
[result
.size() - 1] != '/')
183 result
.push_back('/');
185 const Item
*Itm
= Lookup(Name
);
186 if (Itm
== 0 || Itm
->Value
.empty() == true)
189 result
.append(Default
);
193 string val
= Itm
->Value
;
194 while (Itm
->Parent
!= 0)
196 if (Itm
->Parent
->Value
.empty() == true)
203 if (val
.length() >= 1 && val
[0] == '/')
205 if (val
.compare(0, 9, "/dev/null") == 0)
211 if (val
.length() >= 2 && (val
[0] == '~' || val
[0] == '.') && val
[1] == '/')
215 if (val
.length() >= 3 && val
[0] == '.' && val
[1] == '.' && val
[2] == '/')
218 if (Itm
->Parent
->Value
.end()[-1] != '/')
221 val
.insert(0, Itm
->Parent
->Value
);
227 // do some normalisation by removing // and /./ from the path
228 size_t found
= string::npos
;
229 while ((found
= result
.find("/./")) != string::npos
)
230 result
.replace(found
, 3, "/");
231 while ((found
= result
.find("//")) != string::npos
)
232 result
.replace(found
, 2, "/");
237 // Configuration::FindDir - Find a directory name /*{{{*/
238 // ---------------------------------------------------------------------
239 /* This is like findfile execept the result is terminated in a / */
240 string
Configuration::FindDir(const char *Name
,const char *Default
) const
242 string Res
= FindFile(Name
,Default
);
243 if (Res
.end()[-1] != '/')
245 size_t const found
= Res
.rfind("/dev/null");
246 if (found
!= string::npos
&& found
== Res
.size() - 9)
247 return Res
; // /dev/null returning
253 // Configuration::FindVector - Find a vector of values /*{{{*/
254 // ---------------------------------------------------------------------
255 /* Returns a vector of config values under the given item */
256 #if (APT_PKG_MAJOR >= 4 && APT_PKG_MINOR < 13)
257 vector
<string
> Configuration::FindVector(const char *Name
) const {
258 return FindVector(Name
, "");
261 vector
<string
> Configuration::FindVector(const char *Name
, std::string
const &Default
) const
264 const Item
*Top
= Lookup(Name
);
266 return VectorizeString(Default
, ',');
268 if (Top
->Value
.empty() == false)
269 return VectorizeString(Top
->Value
, ',');
271 Item
*I
= Top
->Child
;
274 Vec
.push_back(I
->Value
);
277 if (Vec
.empty() == true)
278 return VectorizeString(Default
, ',');
283 // Configuration::FindI - Find an integer value /*{{{*/
284 // ---------------------------------------------------------------------
286 int Configuration::FindI(const char *Name
,int const &Default
) const
288 const Item
*Itm
= Lookup(Name
);
289 if (Itm
== 0 || Itm
->Value
.empty() == true)
293 int Res
= strtol(Itm
->Value
.c_str(),&End
,0);
294 if (End
== Itm
->Value
.c_str())
300 // Configuration::FindB - Find a boolean type /*{{{*/
301 // ---------------------------------------------------------------------
303 bool Configuration::FindB(const char *Name
,bool const &Default
) const
305 const Item
*Itm
= Lookup(Name
);
306 if (Itm
== 0 || Itm
->Value
.empty() == true)
309 return StringToBool(Itm
->Value
,Default
);
312 // Configuration::FindAny - Find an arbitrary type /*{{{*/
313 // ---------------------------------------------------------------------
314 /* a key suffix of /f, /d, /b or /i calls Find{File,Dir,B,I} */
315 string
Configuration::FindAny(const char *Name
,const char *Default
) const
320 if (key
.size() > 2 && key
.end()[-2] == '/')
322 type
= key
.end()[-1];
323 key
.resize(key
.size() - 2);
330 return FindFile(key
.c_str(), Default
);
334 return FindDir(key
.c_str(), Default
);
338 return FindB(key
, Default
) ? "true" : "false";
344 snprintf(buf
, sizeof(buf
)-1, "%d", FindI(key
, Default
? atoi(Default
) : 0 ));
350 return Find(Name
, Default
);
353 // Configuration::CndSet - Conditinal Set a value /*{{{*/
354 // ---------------------------------------------------------------------
355 /* This will not overwrite */
356 void Configuration::CndSet(const char *Name
,const string
&Value
)
358 Item
*Itm
= Lookup(Name
,true);
361 if (Itm
->Value
.empty() == true)
365 // Configuration::Set - Set an integer value /*{{{*/
366 // ---------------------------------------------------------------------
368 void Configuration::CndSet(const char *Name
,int const Value
)
370 Item
*Itm
= Lookup(Name
,true);
371 if (Itm
== 0 || Itm
->Value
.empty() == false)
374 snprintf(S
,sizeof(S
),"%i",Value
);
378 // Configuration::Set - Set a value /*{{{*/
379 // ---------------------------------------------------------------------
381 void Configuration::Set(const char *Name
,const string
&Value
)
383 Item
*Itm
= Lookup(Name
,true);
389 // Configuration::Set - Set an integer value /*{{{*/
390 // ---------------------------------------------------------------------
392 void Configuration::Set(const char *Name
,int const &Value
)
394 Item
*Itm
= Lookup(Name
,true);
398 snprintf(S
,sizeof(S
),"%i",Value
);
402 // Configuration::Clear - Clear an single value from a list /*{{{*/
403 // ---------------------------------------------------------------------
405 void Configuration::Clear(string
const &Name
, int const &Value
)
408 snprintf(S
,sizeof(S
),"%i",Value
);
412 // Configuration::Clear - Clear an single value from a list /*{{{*/
413 // ---------------------------------------------------------------------
415 void Configuration::Clear(string
const &Name
, string
const &Value
)
417 Item
*Top
= Lookup(Name
.c_str(),false);
418 if (Top
== 0 || Top
->Child
== 0)
421 Item
*Tmp
, *Prev
, *I
;
422 Prev
= I
= Top
->Child
;
426 if(I
->Value
== Value
)
429 // was first element, point parent to new first element
430 if(Top
->Child
== Tmp
)
431 Top
->Child
= I
->Next
;
443 // Configuration::Clear - Clear everything /*{{{*/
444 // ---------------------------------------------------------------------
445 void Configuration::Clear()
447 const Configuration::Item
*Top
= Tree(0);
450 Clear(Top
->FullTag());
455 // Configuration::Clear - Clear an entire tree /*{{{*/
456 // ---------------------------------------------------------------------
458 void Configuration::Clear(string
const &Name
)
460 Item
*Top
= Lookup(Name
.c_str(),false);
476 while (Top
!= 0 && Top
->Next
== 0)
493 // Configuration::Exists - Returns true if the Name exists /*{{{*/
494 // ---------------------------------------------------------------------
496 bool Configuration::Exists(const char *Name
) const
498 const Item
*Itm
= Lookup(Name
);
504 // Configuration::ExistsAny - Returns true if the Name, possibly /*{{{*/
505 // ---------------------------------------------------------------------
506 /* qualified by /[fdbi] exists */
507 bool Configuration::ExistsAny(const char *Name
) const
511 if (key
.size() > 2 && key
.end()[-2] == '/')
513 if (key
.find_first_of("fdbi",key
.size()-1) < key
.size())
515 key
.resize(key
.size() - 2);
516 if (Exists(key
.c_str()))
521 _error
->Warning(_("Unrecognized type abbreviation: '%c'"), key
.end()[-3]);
527 // Configuration::Dump - Dump the config /*{{{*/
528 // ---------------------------------------------------------------------
529 /* Dump the entire configuration space */
530 void Configuration::Dump(ostream
& str
)
532 Dump(str
, NULL
, "%f \"%v\";\n", true);
534 void Configuration::Dump(ostream
& str
, char const * const root
,
535 char const * const formatstr
, bool const emptyValue
)
537 const Configuration::Item
* Top
= Tree(root
);
540 const Configuration::Item
* const Root
= (root
== NULL
) ? NULL
: Top
;
541 std::vector
<std::string
> const format
= VectorizeString(formatstr
, '%');
543 /* Write out all of the configuration directives by walking the
544 configuration tree */
546 if (emptyValue
== true || Top
->Value
.empty() == emptyValue
)
548 std::vector
<std::string
>::const_iterator f
= format
.begin();
550 for (++f
; f
!= format
.end(); ++f
)
552 if (f
->empty() == true)
558 char const type
= (*f
)[0];
560 str
<< Top
->FullTag();
561 else if (type
== 't')
563 else if (type
== 'v')
565 else if (type
== 'F')
566 str
<< QuoteString(Top
->FullTag(), "=\"\n");
567 else if (type
== 'T')
568 str
<< QuoteString(Top
->Tag
, "=\"\n");
569 else if (type
== 'V')
570 str
<< QuoteString(Top
->Value
, "=\"\n");
571 else if (type
== 'n')
573 else if (type
== 'N')
577 str
<< f
->c_str() + 1;
587 while (Top
!= 0 && Top
->Next
== 0)
594 const Configuration::Item
* I
= Top
;
609 // Configuration::Item::FullTag - Return the fully scoped tag /*{{{*/
610 // ---------------------------------------------------------------------
611 /* Stop sets an optional max recursion depth if this item is being viewed as
612 part of a sub tree. */
613 string
Configuration::Item::FullTag(const Item
*Stop
) const
615 if (Parent
== 0 || Parent
->Parent
== 0 || Parent
== Stop
)
617 return Parent
->FullTag(Stop
) + "::" + Tag
;
621 // ReadConfigFile - Read a configuration file /*{{{*/
622 // ---------------------------------------------------------------------
623 /* The configuration format is very much like the named.conf format
624 used in bind8, in fact this routine can parse most named.conf files.
625 Sectional config files are like bind's named.conf where there are
626 sections like 'zone "foo.org" { .. };' This causes each section to be
627 added in with a tag like "zone::foo.org" instead of being split
628 tag/value. AsSectional enables Sectional parsing.*/
629 bool ReadConfigFile(Configuration
&Conf
,const string
&FName
,bool const &AsSectional
,
630 unsigned const &Depth
)
632 // Open the stream for reading
633 ifstream
F(FName
.c_str(),ios::in
);
635 return _error
->Errno("ifstream::ifstream",_("Opening configuration file %s"),FName
.c_str());
639 unsigned int StackPos
= 0;
645 bool InComment
= false;
646 while (F
.eof() == false)
648 // The raw input line.
650 // The input line with comments stripped.
651 std::string Fragment
;
653 // Grab the next line of F and place it in Input.
656 char *Buffer
= new char[1024];
659 F
.getline(Buffer
,sizeof(Buffer
) / 2);
664 while (F
.fail() && !F
.eof());
666 // Expand tabs in the input line and remove leading and trailing
669 const int BufferSize
= Input
.size() * 8 + 1;
670 char *Buffer
= new char[BufferSize
];
673 memcpy(Buffer
, Input
.c_str(), Input
.size() + 1);
675 _strtabexpand(Buffer
, BufferSize
);
688 // Now strip comments; if the whole line is contained in a
689 // comment, skip this line.
691 // The first meaningful character in the current fragment; will
692 // be adjusted below as we remove bytes from the front.
693 std::string::const_iterator Start
= Input
.begin();
694 // The last meaningful character in the current fragment.
695 std::string::const_iterator End
= Input
.end();
697 // Multi line comment
698 if (InComment
== true)
700 for (std::string::const_iterator I
= Start
;
703 if (*I
== '*' && I
+ 1 != End
&& I
[1] == '/')
710 if (InComment
== true)
714 // Discard single line comments
715 bool InQuote
= false;
716 for (std::string::const_iterator I
= Start
;
724 if ((*I
== '/' && I
+ 1 != End
&& I
[1] == '/') ||
725 (*I
== '#' && strcmp(string(I
,I
+6).c_str(),"#clear") != 0 &&
726 strcmp(string(I
,I
+8).c_str(),"#include") != 0))
733 // Look for multi line comments and build up the
735 Fragment
.reserve(End
- Start
);
737 for (std::string::const_iterator I
= Start
;
743 Fragment
.push_back(*I
);
744 else if (*I
== '/' && I
+ 1 != End
&& I
[1] == '*')
747 for (std::string::const_iterator J
= I
;
750 if (*J
== '*' && J
+ 1 != End
&& J
[1] == '/')
752 // Pretend we just finished walking over the
753 // comment, and don't add anything to the output
761 if (InComment
== true)
765 Fragment
.push_back(*I
);
769 if (Fragment
.empty())
772 // The line has actual content; interpret what it means.
774 Start
= Fragment
.begin();
775 End
= Fragment
.end();
776 for (std::string::const_iterator I
= Start
;
782 if (InQuote
== false && (*I
== '{' || *I
== ';' || *I
== '}'))
784 // Put the last fragment into the buffer
785 std::string::const_iterator NonWhitespaceStart
= Start
;
786 std::string::const_iterator NonWhitespaceStop
= I
;
787 for (; NonWhitespaceStart
!= I
&& isspace(*NonWhitespaceStart
) != 0; ++NonWhitespaceStart
)
789 for (; NonWhitespaceStop
!= NonWhitespaceStart
&& isspace(NonWhitespaceStop
[-1]) != 0; --NonWhitespaceStop
)
791 if (LineBuffer
.empty() == false && NonWhitespaceStop
- NonWhitespaceStart
!= 0)
793 LineBuffer
+= string(NonWhitespaceStart
, NonWhitespaceStop
);
795 // Drop this from the input string, saving the character
796 // that terminated the construct we just closed. (i.e., a
797 // brace or a semicolon)
802 if (TermChar
== '{' && LineBuffer
.empty() == true)
803 return _error
->Error(_("Syntax error %s:%u: Block starts with no name."),FName
.c_str(),CurLine
);
805 // No string on this line
806 if (LineBuffer
.empty() == true)
811 ParentTag
= string();
813 ParentTag
= Stack
[--StackPos
];
820 const char *Pos
= LineBuffer
.c_str();
821 if (ParseQuoteWord(Pos
,Tag
) == false)
822 return _error
->Error(_("Syntax error %s:%u: Malformed tag"),FName
.c_str(),CurLine
);
824 // Parse off the word
827 if (ParseCWord(Pos
,Word
) == false &&
828 ParseQuoteWord(Pos
,Word
) == false)
838 if (strlen(Pos
) != 0)
839 return _error
->Error(_("Syntax error %s:%u: Extra junk after value"),FName
.c_str(),CurLine
);
844 if (StackPos
< sizeof(Stack
)/sizeof(std::string
))
845 Stack
[StackPos
++] = ParentTag
;
847 /* Make sectional tags incorperate the section into the
849 if (AsSectional
== true && Word
.empty() == false)
856 if (ParentTag
.empty() == true)
859 ParentTag
+= string("::") + Tag
;
863 // Generate the item name
865 if (ParentTag
.empty() == true)
869 if (TermChar
!= '{' || Tag
.empty() == false)
870 Item
= ParentTag
+ "::" + Tag
;
876 if (Tag
.length() >= 1 && Tag
[0] == '#')
878 if (ParentTag
.empty() == false)
879 return _error
->Error(_("Syntax error %s:%u: Directives can only be done at the top level"),FName
.c_str(),CurLine
);
880 Tag
.erase(Tag
.begin());
883 else if (Tag
== "include")
886 return _error
->Error(_("Syntax error %s:%u: Too many nested includes"),FName
.c_str(),CurLine
);
887 if (Word
.length() > 2 && Word
.end()[-1] == '/')
889 if (ReadConfigDir(Conf
,Word
,AsSectional
,Depth
+1) == false)
890 return _error
->Error(_("Syntax error %s:%u: Included from here"),FName
.c_str(),CurLine
);
894 if (ReadConfigFile(Conf
,Word
,AsSectional
,Depth
+1) == false)
895 return _error
->Error(_("Syntax error %s:%u: Included from here"),FName
.c_str(),CurLine
);
899 return _error
->Error(_("Syntax error %s:%u: Unsupported directive '%s'"),FName
.c_str(),CurLine
,Tag
.c_str());
901 else if (Tag
.empty() == true && NoWord
== false && Word
== "#clear")
902 return _error
->Error(_("Syntax error %s:%u: clear directive requires an option tree as argument"),FName
.c_str(),CurLine
);
905 // Set the item in the configuration class
913 // Move up a tag, but only if there is no bit to parse
919 ParentTag
= Stack
[--StackPos
];
925 // Store the remaining text, if any, in the current line buffer.
927 // NB: could change this to use string-based operations; I'm
928 // using strstrip now to ensure backwards compatibility.
929 // -- dburrows 2008-04-01
931 char *Buffer
= new char[End
- Start
+ 1];
934 std::copy(Start
, End
, Buffer
);
935 Buffer
[End
- Start
] = '\0';
937 const char *Stripd
= _strstrip(Buffer
);
938 if (*Stripd
!= 0 && LineBuffer
.empty() == false)
940 LineBuffer
+= Stripd
;
951 if (LineBuffer
.empty() == false)
952 return _error
->Error(_("Syntax error %s:%u: Extra junk at end of file"),FName
.c_str(),CurLine
);
956 // ReadConfigDir - Read a directory of config files /*{{{*/
957 // ---------------------------------------------------------------------
959 bool ReadConfigDir(Configuration
&Conf
,const string
&Dir
,
960 bool const &AsSectional
, unsigned const &Depth
)
962 vector
<string
> const List
= GetListOfFilesInDir(Dir
, "conf", true, true);
965 for (vector
<string
>::const_iterator I
= List
.begin(); I
!= List
.end(); ++I
)
966 if (ReadConfigFile(Conf
,*I
,AsSectional
,Depth
) == false)
971 // MatchAgainstConfig Constructor /*{{{*/
972 Configuration::MatchAgainstConfig::MatchAgainstConfig(char const * Config
)
974 std::vector
<std::string
> const strings
= _config
->FindVector(Config
);
975 for (std::vector
<std::string
>::const_iterator s
= strings
.begin();
976 s
!= strings
.end(); ++s
)
978 regex_t
*p
= new regex_t
;
979 if (regcomp(p
, s
->c_str(), REG_EXTENDED
| REG_ICASE
| REG_NOSUB
) == 0)
980 patterns
.push_back(p
);
985 _error
->Warning("Invalid regular expression '%s' in configuration "
986 "option '%s' will be ignored.",
991 if (strings
.empty() == true)
992 patterns
.push_back(NULL
);
995 // MatchAgainstConfig Destructor /*{{{*/
996 Configuration::MatchAgainstConfig::~MatchAgainstConfig()
1000 void Configuration::MatchAgainstConfig::clearPatterns()
1002 for(std::vector
<regex_t
*>::const_iterator p
= patterns
.begin();
1003 p
!= patterns
.end(); ++p
)
1005 if (*p
== NULL
) continue;
1012 // MatchAgainstConfig::Match - returns true if a pattern matches /*{{{*/
1013 bool Configuration::MatchAgainstConfig::Match(char const * str
) const
1015 for(std::vector
<regex_t
*>::const_iterator p
= patterns
.begin();
1016 p
!= patterns
.end(); ++p
)
1017 if (*p
!= NULL
&& regexec(*p
, str
, 0, 0, 0) == 0)