]>
git.saurik.com Git - apt.git/blob - apt-pkg/contrib/configuration.cc
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)
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());
502 unsigned int StackPos
= 0;
508 bool InComment
= false;
509 while (F
.eof() == false)
511 F
.getline(Buffer
,sizeof(Buffer
));
513 // This should be made to work instead, but this is better than looping
514 if (F
.fail() && !F
.eof())
515 return _error
->Error(_("Line %d too long (max %lu)"), CurLine
, sizeof(Buffer
));
517 _strtabexpand(Buffer
,sizeof(Buffer
));
520 // Multi line comment
521 if (InComment
== true)
523 for (const char *I
= Buffer
; *I
!= 0; I
++)
525 if (*I
== '*' && I
[1] == '/')
527 memmove(Buffer
,I
+2,strlen(I
+2) + 1);
532 if (InComment
== true)
536 // Discard single line comments
537 bool InQuote
= false;
538 for (char *I
= Buffer
; *I
!= 0; I
++)
545 if (*I
== '/' && I
[1] == '/')
552 // Look for multi line comments
554 for (char *I
= Buffer
; *I
!= 0; I
++)
561 if (*I
== '/' && I
[1] == '*')
564 for (char *J
= Buffer
; *J
!= 0; J
++)
566 if (*J
== '*' && J
[1] == '/')
568 memmove(I
,J
+2,strlen(J
+2) + 1);
574 if (InComment
== true)
586 // We now have a valid line fragment
588 for (char *I
= Buffer
; *I
!= 0;)
593 if (InQuote
== false && (*I
== '{' || *I
== ';' || *I
== '}'))
595 // Put the last fragment into the buffer
596 char *Start
= Buffer
;
598 for (; Start
!= I
&& isspace(*Start
) != 0; Start
++);
599 for (; Stop
!= Start
&& isspace(Stop
[-1]) != 0; Stop
--);
600 if (LineBuffer
.empty() == false && Stop
- Start
!= 0)
602 LineBuffer
+= string(Start
,Stop
- Start
);
604 // Remove the fragment
606 memmove(Buffer
,I
+ 1,strlen(I
+ 1) + 1);
610 if (TermChar
== '{' && LineBuffer
.empty() == true)
611 return _error
->Error(_("Syntax error %s:%u: Block starts with no name."),FName
.c_str(),CurLine
);
613 // No string on this line
614 if (LineBuffer
.empty() == true)
619 ParentTag
= string();
621 ParentTag
= Stack
[--StackPos
];
628 const char *Pos
= LineBuffer
.c_str();
629 if (ParseQuoteWord(Pos
,Tag
) == false)
630 return _error
->Error(_("Syntax error %s:%u: Malformed tag"),FName
.c_str(),CurLine
);
632 // Parse off the word
635 if (ParseCWord(Pos
,Word
) == false &&
636 ParseQuoteWord(Pos
,Word
) == false)
646 if (strlen(Pos
) != 0)
647 return _error
->Error(_("Syntax error %s:%u: Extra junk after value"),FName
.c_str(),CurLine
);
653 Stack
[StackPos
++] = ParentTag
;
655 /* Make sectional tags incorperate the section into the
657 if (AsSectional
== true && Word
.empty() == false)
664 if (ParentTag
.empty() == true)
667 ParentTag
+= string("::") + Tag
;
671 // Generate the item name
673 if (ParentTag
.empty() == true)
677 if (TermChar
!= '{' || Tag
.empty() == false)
678 Item
= ParentTag
+ "::" + Tag
;
684 if (Tag
.length() >= 1 && Tag
[0] == '#')
686 if (ParentTag
.empty() == false)
687 return _error
->Error(_("Syntax error %s:%u: Directives can only be done at the top level"),FName
.c_str(),CurLine
);
688 Tag
.erase(Tag
.begin());
691 else if (Tag
== "include")
694 return _error
->Error(_("Syntax error %s:%u: Too many nested includes"),FName
.c_str(),CurLine
);
695 if (Word
.length() > 2 && Word
.end()[-1] == '/')
697 if (ReadConfigDir(Conf
,Word
,AsSectional
,Depth
+1) == false)
698 return _error
->Error(_("Syntax error %s:%u: Included from here"),FName
.c_str(),CurLine
);
702 if (ReadConfigFile(Conf
,Word
,AsSectional
,Depth
+1) == false)
703 return _error
->Error(_("Syntax error %s:%u: Included from here"),FName
.c_str(),CurLine
);
707 return _error
->Error(_("Syntax error %s:%u: Unsupported directive '%s'"),FName
.c_str(),CurLine
,Tag
.c_str());
711 // Set the item in the configuration class
719 // Move up a tag, but only if there is no bit to parse
725 ParentTag
= Stack
[--StackPos
];
733 // Store the fragment
734 const char *Stripd
= _strstrip(Buffer
);
735 if (*Stripd
!= 0 && LineBuffer
.empty() == false)
737 LineBuffer
+= Stripd
;
740 if (LineBuffer
.empty() == false)
741 return _error
->Error(_("Syntax error %s:%u: Extra junk at end of file"),FName
.c_str(),CurLine
);
745 // ReadConfigDir - Read a directory of config files /*{{{*/
746 // ---------------------------------------------------------------------
748 bool ReadConfigDir(Configuration
&Conf
,const string
&Dir
,bool AsSectional
,
751 DIR *D
= opendir(Dir
.c_str());
753 return _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
757 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
759 if (Ent
->d_name
[0] == '.')
762 // Skip bad file names ala run-parts
763 const char *C
= Ent
->d_name
;
765 if (isalpha(*C
) == 0 && isdigit(*C
) == 0 && *C
!= '_' && *C
!= '-')
770 // Make sure it is a file and not something else
771 string File
= flCombine(Dir
,Ent
->d_name
);
773 if (stat(File
.c_str(),&St
) != 0 || S_ISREG(St
.st_mode
) == 0)
776 List
.push_back(File
);
780 sort(List
.begin(),List
.end());
783 for (vector
<string
>::const_iterator I
= List
.begin(); I
!= List
.end(); I
++)
784 if (ReadConfigFile(Conf
,*I
,AsSectional
,Depth
) == false)