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 /*{{{*/
18 #include <apt-pkg/configuration.h>
19 #include <apt-pkg/error.h>
20 #include <apt-pkg/strutl.h>
21 #include <apt-pkg/fileutl.h>
37 Configuration
*_config
= new Configuration
;
39 // Configuration::Configuration - Constructor /*{{{*/
40 // ---------------------------------------------------------------------
42 Configuration::Configuration() : ToFree(true)
46 Configuration::Configuration(const Item
*Root
) : Root((Item
*)Root
), ToFree(false)
51 // Configuration::~Configuration - Destructor /*{{{*/
52 // ---------------------------------------------------------------------
54 Configuration::~Configuration()
68 while (Top
!= 0 && Top
->Next
== 0)
70 Item
*Parent
= Top
->Parent
;
76 Item
*Next
= Top
->Next
;
83 // Configuration::Lookup - Lookup a single item /*{{{*/
84 // ---------------------------------------------------------------------
85 /* This will lookup a single item by name below another item. It is a
86 helper function for the main lookup function */
87 Configuration::Item
*Configuration::Lookup(Item
*Head
,const char *S
,
88 unsigned long Len
,bool Create
)
91 Item
*I
= Head
->Child
;
92 Item
**Last
= &Head
->Child
;
94 // Empty strings match nothing. They are used for lists.
97 for (; I
!= 0; Last
= &I
->Next
, I
= I
->Next
)
98 if ((Res
= stringcasecmp(I
->Tag
,S
,S
+ Len
)) == 0)
102 for (; I
!= 0; Last
= &I
->Next
, I
= I
->Next
);
110 I
->Tag
.assign(S
,Len
);
117 // Configuration::Lookup - Lookup a fully scoped item /*{{{*/
118 // ---------------------------------------------------------------------
119 /* This performs a fully scoped lookup of a given name, possibly creating
121 Configuration::Item
*Configuration::Lookup(const char *Name
,bool Create
)
126 const char *Start
= Name
;
127 const char *End
= Start
+ strlen(Name
);
128 const char *TagEnd
= Name
;
130 for (; End
- TagEnd
>= 2; TagEnd
++)
132 if (TagEnd
[0] == ':' && TagEnd
[1] == ':')
134 Itm
= Lookup(Itm
,Start
,TagEnd
- Start
,Create
);
137 TagEnd
= Start
= TagEnd
+ 2;
141 // This must be a trailing ::, we create unique items in a list
142 if (End
- Start
== 0)
148 Itm
= Lookup(Itm
,Start
,End
- Start
,Create
);
152 // Configuration::Find - Find a value /*{{{*/
153 // ---------------------------------------------------------------------
155 string
Configuration::Find(const char *Name
,const char *Default
) const
157 const Item
*Itm
= Lookup(Name
);
158 if (Itm
== 0 || Itm
->Value
.empty() == true)
169 // Configuration::FindFile - Find a Filename /*{{{*/
170 // ---------------------------------------------------------------------
171 /* Directories are stored as the base dir in the Parent node and the
172 sub directory in sub nodes with the final node being the end filename
174 string
Configuration::FindFile(const char *Name
,const char *Default
) const
176 const Item
*RootItem
= Lookup("RootDir");
177 std::string rootDir
= (RootItem
== 0) ? "" : RootItem
->Value
;
178 if(rootDir
.size() > 0 && rootDir
[rootDir
.size() - 1] != '/')
179 rootDir
.push_back('/');
181 const Item
*Itm
= Lookup(Name
);
182 if (Itm
== 0 || Itm
->Value
.empty() == true)
187 return rootDir
+ Default
;
190 string val
= Itm
->Value
;
191 while (Itm
->Parent
!= 0 && Itm
->Parent
->Value
.empty() == false)
194 if (val
.length() >= 1 && val
[0] == '/')
198 if (val
.length() >= 2 && (val
[0] == '~' || val
[0] == '.') && val
[1] == '/')
202 if (val
.length() >= 3 && val
[0] == '.' && val
[1] == '.' && val
[2] == '/')
205 if (Itm
->Parent
->Value
.end()[-1] != '/')
208 val
.insert(0, Itm
->Parent
->Value
);
212 return rootDir
+ val
;
215 // Configuration::FindDir - Find a directory name /*{{{*/
216 // ---------------------------------------------------------------------
217 /* This is like findfile execept the result is terminated in a / */
218 string
Configuration::FindDir(const char *Name
,const char *Default
) const
220 string Res
= FindFile(Name
,Default
);
221 if (Res
.end()[-1] != '/')
226 // Configuration::FindI - Find an integer value /*{{{*/
227 // ---------------------------------------------------------------------
229 int Configuration::FindI(const char *Name
,int Default
) const
231 const Item
*Itm
= Lookup(Name
);
232 if (Itm
== 0 || Itm
->Value
.empty() == true)
236 int Res
= strtol(Itm
->Value
.c_str(),&End
,0);
237 if (End
== Itm
->Value
.c_str())
243 // Configuration::FindB - Find a boolean type /*{{{*/
244 // ---------------------------------------------------------------------
246 bool Configuration::FindB(const char *Name
,bool Default
) const
248 const Item
*Itm
= Lookup(Name
);
249 if (Itm
== 0 || Itm
->Value
.empty() == true)
252 return StringToBool(Itm
->Value
,Default
);
255 // Configuration::FindAny - Find an arbitrary type /*{{{*/
256 // ---------------------------------------------------------------------
257 /* a key suffix of /f, /d, /b or /i calls Find{File,Dir,B,I} */
258 string
Configuration::FindAny(const char *Name
,const char *Default
) const
263 if (key
.size() > 2 && key
.end()[-2] == '/')
265 type
= key
.end()[-1];
266 key
.resize(key
.size() - 2);
273 return FindFile(key
.c_str(), Default
);
277 return FindDir(key
.c_str(), Default
);
281 return FindB(key
, Default
) ? "true" : "false";
287 snprintf(buf
, sizeof(buf
)-1, "%d", FindI(key
, Default
? atoi(Default
) : 0 ));
293 return Find(Name
, Default
);
296 // Configuration::CndSet - Conditinal Set a value /*{{{*/
297 // ---------------------------------------------------------------------
298 /* This will not overwrite */
299 void Configuration::CndSet(const char *Name
,const string
&Value
)
301 Item
*Itm
= Lookup(Name
,true);
304 if (Itm
->Value
.empty() == true)
308 // Configuration::Set - Set a value /*{{{*/
309 // ---------------------------------------------------------------------
311 void Configuration::Set(const char *Name
,const string
&Value
)
313 Item
*Itm
= Lookup(Name
,true);
319 // Configuration::Set - Set an integer value /*{{{*/
320 // ---------------------------------------------------------------------
322 void Configuration::Set(const char *Name
,int Value
)
324 Item
*Itm
= Lookup(Name
,true);
328 snprintf(S
,sizeof(S
),"%i",Value
);
332 // Configuration::Clear - Clear an single value from a list /*{{{*/
333 // ---------------------------------------------------------------------
335 void Configuration::Clear(const string Name
, int Value
)
338 snprintf(S
,sizeof(S
),"%i",Value
);
342 // Configuration::Clear - Clear an single value from a list /*{{{*/
343 // ---------------------------------------------------------------------
345 void Configuration::Clear(const string Name
, string Value
)
347 Item
*Top
= Lookup(Name
.c_str(),false);
348 if (Top
== 0 || Top
->Child
== 0)
351 Item
*Tmp
, *Prev
, *I
;
352 Prev
= I
= Top
->Child
;
356 if(I
->Value
== Value
)
359 // was first element, point parent to new first element
360 if(Top
->Child
== Tmp
)
361 Top
->Child
= I
->Next
;
373 // Configuration::Clear - Clear an entire tree /*{{{*/
374 // ---------------------------------------------------------------------
376 void Configuration::Clear(string Name
)
378 Item
*Top
= Lookup(Name
.c_str(),false);
394 while (Top
!= 0 && Top
->Next
== 0)
411 // Configuration::Exists - Returns true if the Name exists /*{{{*/
412 // ---------------------------------------------------------------------
414 bool Configuration::Exists(const char *Name
) const
416 const Item
*Itm
= Lookup(Name
);
422 // Configuration::ExistsAny - Returns true if the Name, possibly /*{{{*/
423 // ---------------------------------------------------------------------
424 /* qualified by /[fdbi] exists */
425 bool Configuration::ExistsAny(const char *Name
) const
429 if (key
.size() > 2 && key
.end()[-2] == '/')
431 if (key
.find_first_of("fdbi",key
.size()-1) < key
.size())
433 key
.resize(key
.size() - 2);
434 if (Exists(key
.c_str()))
439 _error
->Warning(_("Unrecognized type abbreviation: '%c'"), key
.end()[-3]);
445 // Configuration::Dump - Dump the config /*{{{*/
446 // ---------------------------------------------------------------------
447 /* Dump the entire configuration space */
448 void Configuration::Dump(ostream
& str
)
450 /* Write out all of the configuration directives by walking the
451 configuration tree */
452 const Configuration::Item
*Top
= Tree(0);
455 str
<< Top
->FullTag() << " \"" << Top
->Value
<< "\";" << endl
;
463 while (Top
!= 0 && Top
->Next
== 0)
471 // Configuration::Item::FullTag - Return the fully scoped tag /*{{{*/
472 // ---------------------------------------------------------------------
473 /* Stop sets an optional max recursion depth if this item is being viewed as
474 part of a sub tree. */
475 string
Configuration::Item::FullTag(const Item
*Stop
) const
477 if (Parent
== 0 || Parent
->Parent
== 0 || Parent
== Stop
)
479 return Parent
->FullTag(Stop
) + "::" + Tag
;
483 // ReadConfigFile - Read a configuration file /*{{{*/
484 // ---------------------------------------------------------------------
485 /* The configuration format is very much like the named.conf format
486 used in bind8, in fact this routine can parse most named.conf files.
487 Sectional config files are like bind's named.conf where there are
488 sections like 'zone "foo.org" { .. };' This causes each section to be
489 added in with a tag like "zone::foo.org" instead of being split
490 tag/value. AsSectional enables Sectional parsing.*/
491 bool ReadConfigFile(Configuration
&Conf
,const string
&FName
,bool AsSectional
,
494 // Open the stream for reading
495 ifstream
F(FName
.c_str(),ios::in
);
497 return _error
->Errno("ifstream::ifstream",_("Opening configuration file %s"),FName
.c_str());
501 unsigned int StackPos
= 0;
507 bool InComment
= false;
508 while (F
.eof() == false)
510 // The raw input line.
512 // The input line with comments stripped.
513 std::string Fragment
;
515 // Grab the next line of F and place it in Input.
518 char *Buffer
= new char[1024];
521 F
.getline(Buffer
,sizeof(Buffer
) / 2);
526 while (F
.fail() && !F
.eof());
528 // Expand tabs in the input line and remove leading and trailing
531 const int BufferSize
= Input
.size() * 8 + 1;
532 char *Buffer
= new char[BufferSize
];
535 memcpy(Buffer
, Input
.c_str(), Input
.size() + 1);
537 _strtabexpand(Buffer
, BufferSize
);
550 // Now strip comments; if the whole line is contained in a
551 // comment, skip this line.
553 // The first meaningful character in the current fragment; will
554 // be adjusted below as we remove bytes from the front.
555 std::string::const_iterator Start
= Input
.begin();
556 // The last meaningful character in the current fragment.
557 std::string::const_iterator End
= Input
.end();
559 // Multi line comment
560 if (InComment
== true)
562 for (std::string::const_iterator I
= Start
;
565 if (*I
== '*' && I
+ 1 != End
&& I
[1] == '/')
572 if (InComment
== true)
576 // Discard single line comments
577 bool InQuote
= false;
578 for (std::string::const_iterator I
= Start
;
586 if ((*I
== '/' && I
+ 1 != End
&& I
[1] == '/') || *I
== '#')
593 // Look for multi line comments and build up the
595 Fragment
.reserve(End
- Start
);
597 for (std::string::const_iterator I
= Start
;
603 Fragment
.push_back(*I
);
604 else if (*I
== '/' && I
+ 1 != End
&& I
[1] == '*')
607 for (std::string::const_iterator J
= I
;
610 if (*J
== '*' && J
+ 1 != End
&& J
[1] == '/')
612 // Pretend we just finished walking over the
613 // comment, and don't add anything to the output
621 if (InComment
== true)
625 Fragment
.push_back(*I
);
629 if (Fragment
.empty())
632 // The line has actual content; interpret what it means.
634 Start
= Fragment
.begin();
635 End
= Fragment
.end();
636 for (std::string::const_iterator I
= Start
;
642 if (InQuote
== false && (*I
== '{' || *I
== ';' || *I
== '}'))
644 // Put the last fragment into the buffer
645 std::string::const_iterator NonWhitespaceStart
= Start
;
646 std::string::const_iterator NonWhitespaceStop
= I
;
647 for (; NonWhitespaceStart
!= I
&& isspace(*NonWhitespaceStart
) != 0; NonWhitespaceStart
++)
649 for (; NonWhitespaceStop
!= NonWhitespaceStart
&& isspace(NonWhitespaceStop
[-1]) != 0; NonWhitespaceStop
--)
651 if (LineBuffer
.empty() == false && NonWhitespaceStop
- NonWhitespaceStart
!= 0)
653 LineBuffer
+= string(NonWhitespaceStart
, NonWhitespaceStop
);
655 // Drop this from the input string, saving the character
656 // that terminated the construct we just closed. (i.e., a
657 // brace or a semicolon)
662 if (TermChar
== '{' && LineBuffer
.empty() == true)
663 return _error
->Error(_("Syntax error %s:%u: Block starts with no name."),FName
.c_str(),CurLine
);
665 // No string on this line
666 if (LineBuffer
.empty() == true)
671 ParentTag
= string();
673 ParentTag
= Stack
[--StackPos
];
680 const char *Pos
= LineBuffer
.c_str();
681 if (ParseQuoteWord(Pos
,Tag
) == false)
682 return _error
->Error(_("Syntax error %s:%u: Malformed tag"),FName
.c_str(),CurLine
);
684 // Parse off the word
687 if (ParseCWord(Pos
,Word
) == false &&
688 ParseQuoteWord(Pos
,Word
) == false)
698 if (strlen(Pos
) != 0)
699 return _error
->Error(_("Syntax error %s:%u: Extra junk after value"),FName
.c_str(),CurLine
);
705 Stack
[StackPos
++] = ParentTag
;
707 /* Make sectional tags incorperate the section into the
709 if (AsSectional
== true && Word
.empty() == false)
716 if (ParentTag
.empty() == true)
719 ParentTag
+= string("::") + Tag
;
723 // Generate the item name
725 if (ParentTag
.empty() == true)
729 if (TermChar
!= '{' || Tag
.empty() == false)
730 Item
= ParentTag
+ "::" + Tag
;
736 if (Tag
.length() >= 1 && Tag
[0] == '#')
738 if (ParentTag
.empty() == false)
739 return _error
->Error(_("Syntax error %s:%u: Directives can only be done at the top level"),FName
.c_str(),CurLine
);
740 Tag
.erase(Tag
.begin());
743 else if (Tag
== "include")
746 return _error
->Error(_("Syntax error %s:%u: Too many nested includes"),FName
.c_str(),CurLine
);
747 if (Word
.length() > 2 && Word
.end()[-1] == '/')
749 if (ReadConfigDir(Conf
,Word
,AsSectional
,Depth
+1) == false)
750 return _error
->Error(_("Syntax error %s:%u: Included from here"),FName
.c_str(),CurLine
);
754 if (ReadConfigFile(Conf
,Word
,AsSectional
,Depth
+1) == false)
755 return _error
->Error(_("Syntax error %s:%u: Included from here"),FName
.c_str(),CurLine
);
759 return _error
->Error(_("Syntax error %s:%u: Unsupported directive '%s'"),FName
.c_str(),CurLine
,Tag
.c_str());
763 // Set the item in the configuration class
771 // Move up a tag, but only if there is no bit to parse
777 ParentTag
= Stack
[--StackPos
];
783 // Store the remaining text, if any, in the current line buffer.
785 // NB: could change this to use string-based operations; I'm
786 // using strstrip now to ensure backwards compatibility.
787 // -- dburrows 2008-04-01
789 char *Buffer
= new char[End
- Start
+ 1];
792 std::copy(Start
, End
, Buffer
);
793 Buffer
[End
- Start
] = '\0';
795 const char *Stripd
= _strstrip(Buffer
);
796 if (*Stripd
!= 0 && LineBuffer
.empty() == false)
798 LineBuffer
+= Stripd
;
809 if (LineBuffer
.empty() == false)
810 return _error
->Error(_("Syntax error %s:%u: Extra junk at end of file"),FName
.c_str(),CurLine
);
814 // ReadConfigDir - Read a directory of config files /*{{{*/
815 // ---------------------------------------------------------------------
817 bool ReadConfigDir(Configuration
&Conf
,const string
&Dir
,bool AsSectional
,
820 DIR *D
= opendir(Dir
.c_str());
822 return _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
826 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
828 if (Ent
->d_name
[0] == '.')
831 // Skip bad file names ala run-parts
832 const char *C
= Ent
->d_name
;
834 if (isalpha(*C
) == 0 && isdigit(*C
) == 0 && *C
!= '_' && *C
!= '-')
839 // Make sure it is a file and not something else
840 string File
= flCombine(Dir
,Ent
->d_name
);
842 if (stat(File
.c_str(),&St
) != 0 || S_ISREG(St
.st_mode
) == 0)
845 List
.push_back(File
);
849 sort(List
.begin(),List
.end());
852 for (vector
<string
>::const_iterator I
= List
.begin(); I
!= List
.end(); I
++)
853 if (ReadConfigFile(Conf
,*I
,AsSectional
,Depth
) == false)