G++3 fixes from Randolph
[ntk/apt.git] / apt-pkg / contrib / configuration.cc
index 27299ec..2fa570c 100644 (file)
@@ -1,6 +1,6 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
-// $Id: configuration.cc,v 1.9 1998/10/30 07:53:42 jgg Exp $
+// $Id: configuration.cc,v 1.22 2001/05/14 05:47:30 jgg Exp $
 /* ######################################################################
 
    Configuration Class
 #endif
 #include <apt-pkg/configuration.h>
 #include <apt-pkg/error.h>
-#include <strutl.h>
+#include <apt-pkg/strutl.h>
+#include <apt-pkg/fileutl.h>
+#include <apti18n.h>
 
+#include <vector>
+#include <algorithm>
+#include <fstream>
+#include <iostream>
+    
 #include <stdio.h>
-#include <fstream.h>
+#include <dirent.h>
+#include <sys/stat.h>
+#include <unistd.h>
+
+using namespace std;
                                                                        /*}}}*/
 
 Configuration *_config = new Configuration;
@@ -28,9 +39,45 @@ Configuration *_config = new Configuration;
 // Configuration::Configuration - Constructor                          /*{{{*/
 // ---------------------------------------------------------------------
 /* */
-Configuration::Configuration()
+Configuration::Configuration() : ToFree(true)
 {
    Root = new Item;
+}
+Configuration::Configuration(const Item *Root) : Root((Item *)Root), ToFree(false)
+{
+};
+
+                                                                       /*}}}*/
+// Configuration::~Configuration - Destructor                          /*{{{*/
+// ---------------------------------------------------------------------
+/* */
+Configuration::~Configuration()
+{
+   if (ToFree == false)
+      return;
+   
+   Item *Top = Root;
+   for (; Top != 0;)
+   {
+      if (Top->Child != 0)
+      {
+        Top = Top->Child;
+        continue;
+      }
+            
+      while (Top != 0 && Top->Next == 0)
+      {
+        Item *Parent = Top->Parent;
+        delete Top;
+        Top = Parent;
+      }      
+      if (Top != 0)
+      {
+        Item *Next = Top->Next;
+        delete Top;
+        Top = Next;
+      }
+   }
 }
                                                                        /*}}}*/
 // Configuration::Lookup - Lookup a single item                                /*{{{*/
@@ -43,10 +90,17 @@ Configuration::Item *Configuration::Lookup(Item *Head,const char *S,
    int Res = 1;
    Item *I = Head->Child;
    Item **Last = &Head->Child;
-   for (; I != 0; Last = &I->Next, I = I->Next)
-      if ((Res = stringcasecmp(I->Tag.begin(),I->Tag.end(),S,S + Len)) == 0)
-        break;
    
+   // Empty strings match nothing. They are used for lists.
+   if (Len != 0)
+   {
+      for (; I != 0; Last = &I->Next, I = I->Next)
+        if ((Res = stringcasecmp(I->Tag,S,S + Len)) == 0)
+           break;
+   }
+   else
+      for (; I != 0; Last = &I->Next, I = I->Next);
+      
    if (Res == 0)
       return I;
    if (Create == false)
@@ -73,7 +127,7 @@ Configuration::Item *Configuration::Lookup(const char *Name,bool Create)
    const char *End = Start + strlen(Name);
    const char *TagEnd = Name;
    Item *Itm = Root;
-   for (; End - TagEnd > 2; TagEnd++)
+   for (; End - TagEnd >= 2; TagEnd++)
    {
       if (TagEnd[0] == ':' && TagEnd[1] == ':')
       {
@@ -84,6 +138,13 @@ Configuration::Item *Configuration::Lookup(const char *Name,bool Create)
       }
    }   
 
+   // This must be a trailing ::, we create unique items in a list
+   if (End - Start == 0)
+   {
+      if (Create == false)
+        return 0;
+   }
+   
    Itm = Lookup(Itm,Start,End - Start,Create);
    return Itm;
 }
@@ -91,9 +152,9 @@ Configuration::Item *Configuration::Lookup(const char *Name,bool Create)
 // Configuration::Find - Find a value                                  /*{{{*/
 // ---------------------------------------------------------------------
 /* */
-string Configuration::Find(const char *Name,const char *Default)
+string Configuration::Find(const char *Name,const char *Default) const
 {
-   Item *Itm = Lookup(Name,false);
+   const Item *Itm = Lookup(Name);
    if (Itm == 0 || Itm->Value.empty() == true)
    {
       if (Default == 0)
@@ -110,9 +171,9 @@ string Configuration::Find(const char *Name,const char *Default)
 /* Directories are stored as the base dir in the Parent node and the
    sub directory in sub nodes with the final node being the end filename
  */
-string Configuration::FindFile(const char *Name,const char *Default)
+string Configuration::FindFile(const char *Name,const char *Default) const
 {
-   Item *Itm = Lookup(Name,false);
+   const Item *Itm = Lookup(Name);
    if (Itm == 0 || Itm->Value.empty() == true)
    {
       if (Default == 0)
@@ -121,26 +182,35 @@ string Configuration::FindFile(const char *Name,const char *Default)
         return Default;
    }
    
-   // Absolute path
-   if (Itm->Value[0] == '/' || Itm->Parent == 0)
-      return Itm->Value;
-   
-   // ./ is also considered absolute as is anything with ~ in it
-   if (Itm->Value[0] != 0 && 
-       ((Itm->Value[0] == '.' && Itm->Value[1] == '/') ||
-       (Itm->Value[0] == '~' && Itm->Value[1] == '/')))
-      return Itm->Value;
-   
-   if (Itm->Parent->Value.end()[-1] == '/')
-      return Itm->Parent->Value + Itm->Value;
-   else
-      return Itm->Parent->Value + '/' + Itm->Value;
+   string val = Itm->Value;
+   while (Itm->Parent != 0 && Itm->Parent->Value.empty() == false)
+   {    
+      // Absolute
+      if (val.length() >= 1 && val[0] == '/')
+         break;
+
+      // ~/foo or ./foo 
+      if (val.length() >= 2 && (val[0] == '~' || val[0] == '.') && val[1] == '/')
+        break;
+        
+      // ../foo 
+      if (val.length() >= 3 && val[0] == '.' && val[1] == '.' && val[2] == '/')
+        break;
+      
+      if (Itm->Parent->Value.end()[-1] != '/')
+        val.insert(0, "/");
+
+      val.insert(0, Itm->Parent->Value);
+      Itm = Itm->Parent;
+   }
+
+   return val;
 }
                                                                        /*}}}*/
 // Configuration::FindDir - Find a directory name                      /*{{{*/
 // ---------------------------------------------------------------------
 /* This is like findfile execept the result is terminated in a / */
-string Configuration::FindDir(const char *Name,const char *Default)
+string Configuration::FindDir(const char *Name,const char *Default) const
 {
    string Res = FindFile(Name,Default);
    if (Res.end()[-1] != '/')
@@ -151,9 +221,9 @@ string Configuration::FindDir(const char *Name,const char *Default)
 // Configuration::FindI - Find an integer value                                /*{{{*/
 // ---------------------------------------------------------------------
 /* */
-int Configuration::FindI(const char *Name,int Default)
+int Configuration::FindI(const char *Name,int Default) const
 {
-   Item *Itm = Lookup(Name,false);
+   const Item *Itm = Lookup(Name);
    if (Itm == 0 || Itm->Value.empty() == true)
       return Default;
    
@@ -168,15 +238,68 @@ int Configuration::FindI(const char *Name,int Default)
 // Configuration::FindB - Find a boolean type                          /*{{{*/
 // ---------------------------------------------------------------------
 /* */
-bool Configuration::FindB(const char *Name,bool Default)
+bool Configuration::FindB(const char *Name,bool Default) const
 {
-   Item *Itm = Lookup(Name,false);
+   const Item *Itm = Lookup(Name);
    if (Itm == 0 || Itm->Value.empty() == true)
       return Default;
    
    return StringToBool(Itm->Value,Default);
 }
                                                                        /*}}}*/
+// Configuration::FindAny - Find an arbitrary type                     /*{{{*/
+// ---------------------------------------------------------------------
+/* a key suffix of /f, /d, /b or /i calls Find{File,Dir,B,I} */
+string Configuration::FindAny(const char *Name,const char *Default) const
+{
+   string key = Name;
+   char type = 0;
+
+   if (key.size() > 2 && key.end()[-2] == '/')
+   {
+      type = key.end()[-1];
+      key.resize(key.size() - 2);
+   }
+
+   switch (type)
+   {
+      // file
+      case 'f': 
+      return FindFile(key.c_str(), Default);
+      
+      // directory
+      case 'd': 
+      return FindDir(key.c_str(), Default);
+      
+      // bool
+      case 'b': 
+      return FindB(key, Default) ? "true" : "false";
+      
+      // int
+      case 'i': 
+      {
+        char buf[16];
+        snprintf(buf, sizeof(buf)-1, "%d", FindI(key, atoi(Default)));
+        return buf;
+      }
+   }
+
+   // fallback
+   return Find(Name, Default);
+}
+                                                                       /*}}}*/
+// Configuration::CndSet - Conditinal Set a value                      /*{{{*/
+// ---------------------------------------------------------------------
+/* This will not overwrite */
+void Configuration::CndSet(const char *Name,string Value)
+{
+   Item *Itm = Lookup(Name,true);
+   if (Itm == 0)
+      return;
+   if (Itm->Value.empty() == true)
+      Itm->Value = Value;
+}
+                                                                       /*}}}*/
 // Configuration::Set - Set a value                                    /*{{{*/
 // ---------------------------------------------------------------------
 /* */
@@ -201,17 +324,73 @@ void Configuration::Set(const char *Name,int Value)
    Itm->Value = S;
 }
                                                                        /*}}}*/
+// Configuration::Clear - Clear an entire tree                         /*{{{*/
+// ---------------------------------------------------------------------
+/* */
+void Configuration::Clear(string Name)
+{
+   Item *Top = Lookup(Name.c_str(),false);
+   if (Top == 0)
+      return;
+   
+   Top->Value = string();
+   Item *Stop = Top;
+   Top = Top->Child;
+   Stop->Child = 0;
+   for (; Top != 0;)
+   {
+      if (Top->Child != 0)
+      {
+        Top = Top->Child;
+        continue;
+      }
+
+      while (Top != 0 && Top->Next == 0)
+      {
+        Item *Tmp = Top;
+        Top = Top->Parent;
+        delete Tmp;
+        
+        if (Top == Stop)
+           return;
+      }
+      
+      Item *Tmp = Top;
+      if (Top != 0)
+        Top = Top->Next;
+      delete Tmp;
+   }
+}
+                                                                       /*}}}*/
 // Configuration::Exists - Returns true if the Name exists             /*{{{*/
 // ---------------------------------------------------------------------
 /* */
-bool Configuration::Exists(const char *Name)
+bool Configuration::Exists(const char *Name) const
 {
-   Item *Itm = Lookup(Name,false);
+   const Item *Itm = Lookup(Name);
    if (Itm == 0)
       return false;
    return true;
 }
                                                                        /*}}}*/
+// Configuration::ExistsAny - Returns true if the Name, possibly       /*{{{*/
+// ---------------------------------------------------------------------
+/* qualified by /[fdbi] exists */
+bool Configuration::ExistsAny(const char *Name) const
+{
+   string key = Name;
+
+   if (key.size() > 2 && key.end()[-2] == '/' &&
+       key.find_first_of("fdbi",key.size()-1) < key.size())
+   {
+      key.resize(key.size() - 2);
+      if (Exists(key.c_str()))
+        return true;
+   }
+
+   return Exists(Name);
+}
+                                                                       /*}}}*/
 // Configuration::Dump - Dump the config                               /*{{{*/
 // ---------------------------------------------------------------------
 /* Dump the entire configuration space */
@@ -219,7 +398,7 @@ void Configuration::Dump()
 {
    /* Write out all of the configuration directives by walking the 
       configuration tree */
-   const Configuration::Item *Top = _config->Tree(0);
+   const Configuration::Item *Top = Tree(0);
    for (; Top != 0;)
    {
       clog << Top->FullTag() << " \"" << Top->Value << "\";" << endl;
@@ -234,34 +413,42 @@ void Configuration::Dump()
         Top = Top->Parent;
       if (Top != 0)
         Top = Top->Next;
-   }   
+   }
 }
                                                                        /*}}}*/
 
 // Configuration::Item::FullTag - Return the fully scoped tag          /*{{{*/
 // ---------------------------------------------------------------------
-/* */
-string Configuration::Item::FullTag() const
+/* Stop sets an optional max recursion depth if this item is being viewed as
+   part of a sub tree. */
+string Configuration::Item::FullTag(const Item *Stop) const
 {
-   if (Parent == 0 || Parent->Parent == 0)
+   if (Parent == 0 || Parent->Parent == 0 || Parent == Stop)
       return Tag;
-   return Parent->FullTag() + "::" + Tag;
+   return Parent->FullTag(Stop) + "::" + Tag;
 }
                                                                        /*}}}*/
 
 // ReadConfigFile - Read a configuration file                          /*{{{*/
 // ---------------------------------------------------------------------
 /* The configuration format is very much like the named.conf format
-   used in bind8, in fact this routine can parse most named.conf files. */
-bool ReadConfigFile(Configuration &Conf,string FName)
-{
+   used in bind8, in fact this routine can parse most named.conf files. 
+   Sectional config files are like bind's named.conf where there are 
+   sections like 'zone "foo.org" { .. };' This causes each section to be
+   added in with a tag like "zone::foo.org" instead of being split 
+   tag/value. AsSectional enables Sectional parsing.*/
+bool ReadConfigFile(Configuration &Conf,string FName,bool AsSectional,
+                   unsigned Depth)
+{   
    // Open the stream for reading
-   ifstream F(FName.c_str(),ios::in | ios::nocreate);
+   ifstream F(FName.c_str(),ios::in); 
    if (!F != 0)
-      return _error->Errno("ifstream::ifstream","Opening configuration file %s",FName.c_str());
+      return _error->Errno("ifstream::ifstream",_("Opening configuration file %s"),FName.c_str());
    
    char Buffer[300];
    string LineBuffer;
+   string Stack[100];
+   unsigned int StackPos = 0;
    
    // Parser state
    string ParentTag;
@@ -292,18 +479,30 @@ bool ReadConfigFile(Configuration &Conf,string FName)
       }
       
       // Discard single line comments
+      bool InQuote = false;
       for (char *I = Buffer; *I != 0; I++)
       {
+        if (*I == '"')
+           InQuote = !InQuote;
+        if (InQuote == true)
+           continue;
+        
         if (*I == '/' && I[1] == '/')
          {
            *I = 0;
            break;
         }
       }
-      
+
       // Look for multi line comments
+      InQuote = false;
       for (char *I = Buffer; *I != 0; I++)
       {
+        if (*I == '"')
+           InQuote = !InQuote;
+        if (InQuote == true)
+           continue;
+        
         if (*I == '/' && I[1] == '*')
          {
            InComment = true;
@@ -330,11 +529,15 @@ bool ReadConfigFile(Configuration &Conf,string FName)
         continue;
       
       // We now have a valid line fragment
+      InQuote = false;
       for (char *I = Buffer; *I != 0;)
       {
-        if (*I == '{' || *I == ';' || *I == '}')
+        if (*I == '"')
+           InQuote = !InQuote;
+        
+        if (InQuote == false && (*I == '{' || *I == ';' || *I == '}'))
         {
-           // Put the last fragement into the buffer
+           // Put the last fragment into the buffer
            char *Start = Buffer;
            char *Stop = I;
            for (; Start != I && isspace(*Start) != 0; Start++);
@@ -347,75 +550,126 @@ bool ReadConfigFile(Configuration &Conf,string FName)
            char TermChar = *I;
            memmove(Buffer,I + 1,strlen(I + 1) + 1);
            I = Buffer;
-
-           // Move up a tag
-           if (TermChar == '}')
-           {
-              string::size_type Pos = ParentTag.rfind("::");
-              if (Pos == string::npos)
-                 ParentTag = string();
-              else
-                 ParentTag = string(ParentTag,0,Pos);
-           }
            
            // Syntax Error
            if (TermChar == '{' && LineBuffer.empty() == true)
-              return _error->Error("Syntax error %s:%u: Block starts with no name.",FName.c_str(),CurLine);
+              return _error->Error(_("Syntax error %s:%u: Block starts with no name."),FName.c_str(),CurLine);
            
+           // No string on this line
            if (LineBuffer.empty() == true)
+           {
+              if (TermChar == '}')
+              {
+                 if (StackPos == 0)
+                    ParentTag = string();
+                 else
+                    ParentTag = Stack[--StackPos];
+              }
               continue;
-
+           }
+           
            // Parse off the tag
-           string::size_type Pos = LineBuffer.find(' ');
-           if (Pos == string::npos)
+           string Tag;
+           const char *Pos = LineBuffer.c_str();
+           if (ParseQuoteWord(Pos,Tag) == false)
+              return _error->Error(_("Syntax error %s:%u: Malformed Tag"),FName.c_str(),CurLine);
+
+           // Parse off the word
+           string Word;
+           bool NoWord = false;
+           if (ParseCWord(Pos,Word) == false &&
+               ParseQuoteWord(Pos,Word) == false)
            {
-              if (TermChar == '{')
-                 Pos = LineBuffer.length();
+              if (TermChar != '{')
+              {
+                 Word = Tag;
+                 Tag = "";
+              }
               else
-                 return _error->Error("Syntax error %s:%u: Tag with no value",FName.c_str(),CurLine);
+                 NoWord = true;
            }
-           
-           string Tag = string(LineBuffer,0,Pos);
+           if (strlen(Pos) != 0)
+              return _error->Error(_("Syntax error %s:%u: Extra junk after value"),FName.c_str(),CurLine);
 
            // Go down a level
            if (TermChar == '{')
            {
+              if (StackPos <= 100)
+                 Stack[StackPos++] = ParentTag;
+              
+              /* Make sectional tags incorperate the section into the
+                 tag string */
+              if (AsSectional == true && Word.empty() == false)
+              {
+                 Tag += "::" ;
+                 Tag += Word;
+                 Word = "";
+              }
+              
               if (ParentTag.empty() == true)
                  ParentTag = Tag;
               else
                  ParentTag += string("::") + Tag;
               Tag = string();
            }
-
-           // We dont have a value to set
-           if (Pos == LineBuffer.length())
-           {
-              LineBuffer = string();
-              continue;
-           }
            
-           // Parse off the word
-           string Word;
-           if (ParseCWord(LineBuffer.c_str()+Pos,Word) == false)
-              return _error->Error("Syntax error %s:%u: Malformed value",FName.c_str(),CurLine);
-              
            // Generate the item name
            string Item;
            if (ParentTag.empty() == true)
               Item = Tag;
            else
            {
-              if (Tag.empty() == true)
+              if (TermChar != '{' || Tag.empty() == false)
+                 Item = ParentTag + "::" + Tag;
+              else
                  Item = ParentTag;
+           }
+           
+           // Specials
+           if (Tag.length() >= 1 && Tag[0] == '#')
+           {
+              if (ParentTag.empty() == false)
+                 return _error->Error(_("Syntax error %s:%u: Directives can only be done at the top level"),FName.c_str(),CurLine);
+              Tag.erase(Tag.begin());
+              if (Tag == "clear")
+                 Conf.Clear(Word);
+              else if (Tag == "include")
+              {
+                 if (Depth > 10)
+                    return _error->Error(_("Syntax error %s:%u: Too many nested includes"),FName.c_str(),CurLine);
+                 if (Word.length() > 2 && Word.end()[-1] == '/')
+                 {
+                    if (ReadConfigDir(Conf,Word,AsSectional,Depth+1) == false)
+                       return _error->Error(_("Syntax error %s:%u: Included from here"),FName.c_str(),CurLine);
+                 }
+                 else
+                 {
+                    if (ReadConfigFile(Conf,Word,AsSectional,Depth+1) == false)
+                       return _error->Error(_("Syntax error %s:%u: Included from here"),FName.c_str(),CurLine);
+                 }               
+              }
               else
-                 Item = ParentTag + "::" + Tag;
+                 return _error->Error(_("Syntax error %s:%u: Unsupported directive '%s'"),FName.c_str(),CurLine,Tag.c_str());
+           }
+           else
+           {
+              // Set the item in the configuration class
+              if (NoWord == false)
+                 Conf.Set(Item,Word);
            }
            
-           // Set the item in the configuration class
-           Conf.Set(Item,Word);
-                           
            // Empty the buffer
            LineBuffer = string();
+           
+           // Move up a tag, but only if there is no bit to parse
+           if (TermChar == '}')
+           {
+              if (StackPos == 0)
+                 ParentTag = string();
+              else
+                 ParentTag = Stack[--StackPos];
+           }
+           
         }
         else
            I++;
@@ -427,7 +681,53 @@ bool ReadConfigFile(Configuration &Conf,string FName)
         LineBuffer += " ";
       LineBuffer += Stripd;
    }
+
+   if (LineBuffer.empty() == false)
+      return _error->Error(_("Syntax error %s:%u: Extra junk at end of file"),FName.c_str(),CurLine);
+   return true;
+}
+                                                                       /*}}}*/
+// ReadConfigDir - Read a directory of config files                    /*{{{*/
+// ---------------------------------------------------------------------
+/* */
+bool ReadConfigDir(Configuration &Conf,string Dir,bool AsSectional,
+                   unsigned Depth)
+{   
+   DIR *D = opendir(Dir.c_str());
+   if (D == 0)
+      return _error->Errno("opendir",_("Unable to read %s"),Dir.c_str());
+
+   vector<string> List;
+   
+   for (struct dirent *Ent = readdir(D); Ent != 0; Ent = readdir(D))
+   {
+      if (Ent->d_name[0] == '.')
+        continue;
+      
+      // Skip bad file names ala run-parts
+      const char *C = Ent->d_name;
+      for (; *C != 0; C++)
+        if (isalpha(*C) == 0 && isdigit(*C) == 0 && *C != '_' && *C != '-')
+           break;
+      if (*C != 0)
+        continue;
+      
+      // Make sure it is a file and not something else
+      string File = flCombine(Dir,Ent->d_name);
+      struct stat St;
+      if (stat(File.c_str(),&St) != 0 || S_ISREG(St.st_mode) == 0)
+        continue;
+      
+      List.push_back(File);      
+   }   
+   closedir(D);
    
+   sort(List.begin(),List.end());
+
+   // Read the files
+   for (vector<string>::const_iterator I = List.begin(); I != List.end(); I++)
+      if (ReadConfigFile(Conf,*I,AsSectional,Depth) == false)
+        return false;
    return true;
 }
                                                                        /*}}}*/