Maintenance: Add dedicated /etc/hosts manager

configure.ac

@@ -2585,6 +2585,7 @@ AC_CONFIG_FILES([
 	src/base/Makefile
 	src/clients/Makefile
 	src/comm/Makefile
+	src/configuration/Makefile
 	src/debug/Makefile
 	src/dns/Makefile
 	src/DiskIO/Makefile

src/ConfigParser.cc

@@ -16,8 +16,11 @@
 #include "fatal.h"
 #include "globals.h"
 #include "neighbors.h"
+#include "parser/Tokenizer.h"
 #include "sbuf/Stream.h"
 
+#include <memory>
+
 bool ConfigParser::RecognizeQuotedValues = true;
 bool ConfigParser::StrictMode = true;
 std::stack<ConfigParser::CfgFile *> ConfigParser::CfgFiles;
@@ -41,14 +44,12 @@ ConfigParser::destruct()
     if (!CfgFiles.empty()) {
         std::ostringstream message;
         CfgFile *f = CfgFiles.top();
-        message << "Bungled " << f->filePath << " line " << f->lineNo <<
-                ": " << f->currentLine << std::endl;
+        message << "Bungled " << f->lineInfo() << std::endl;
         CfgFiles.pop();
         delete f;
         while (!CfgFiles.empty()) {
             f = CfgFiles.top();
-            message << " included from " << f->filePath << " line " <<
-                    f->lineNo << ": " << f->currentLine << std::endl;
+            message << " included from " << f->lineInfo() << std::endl;
             CfgFiles.pop();
             delete f;
         }
@@ -68,7 +69,7 @@ ConfigParser::strtokFile()
         return ConfigParser::NextToken();
 
     static int fromFile = 0;
-    static FILE *wordFile = nullptr;
+    static std::unique_ptr<Configuration::File> wordFile;
 
     char *t;
     static char buf[CONFIG_LINE_LIMIT];
@@ -90,42 +91,25 @@ ConfigParser::strtokFile()
 
                 *t = '\0';
 
-                if ((wordFile = fopen(fn, "r")) == nullptr) {
-                    debugs(3, DBG_CRITICAL, "ERROR: Can not open file " << fn << " for reading");
-                    return nullptr;
-                }
-
-#if _SQUID_WINDOWS_
-                setmode(fileno(wordFile), O_TEXT);
-#endif
-
+                wordFile.reset(new Configuration::File(fn));
+                wordFile->load();
                 fromFile = 1;
             } else {
                 return t;
             }
         }
 
         /* fromFile */
-        if (fgets(buf, sizeof(buf), wordFile) == nullptr) {
+        static SBuf line;
+        line = wordFile->nextLine();
+        if (line.isEmpty()) {
             /* stop reading from file */
-            fclose(wordFile);
             wordFile = nullptr;
             fromFile = 0;
             return nullptr;
         } else {
-            char *t2, *t3;
-            t = buf;
-            /* skip leading and trailing white space */
-            t += strspn(buf, w_space);
-            t2 = t + strcspn(t, w_space);
-            t3 = t2 + strspn(t2, w_space);
-
-            while (*t3 && *t3 != '#') {
-                t2 = t3 + strcspn(t3, w_space);
-                t3 = t2 + strspn(t2, w_space);
-            }
-
-            *t2 = '\0';
+            assert(line.length() < CONFIG_LINE_LIMIT);
+            t = const_cast<char *>(line.c_str());
         }
 
         /* skip comments */
@@ -341,7 +325,7 @@ ConfigParser::NextToken()
             if (!token) {
                 assert(!wordfile->isOpen());
                 CfgFiles.pop();
-                debugs(3, 4, "CfgFiles.pop " << wordfile->filePath);
+                debugs(3, 4, "CfgFiles.pop " << wordfile->lineInfo());
                 delete wordfile;
             }
         }
@@ -361,6 +345,8 @@ ConfigParser::NextToken()
                 return nullptr;
             }
 
+            assert(path); // a QuotedToken cannot be nil
+
             // The next token in current cfg file line must be a ")"
             char *end = NextToken();
             ConfigParser::PreviewMode_ = savePreview;
@@ -376,14 +362,9 @@ ConfigParser::NextToken()
                 return nullptr;
             }
 
-            ConfigParser::CfgFile *wordfile = new ConfigParser::CfgFile();
-            if (!path || !wordfile->startParse(path)) {
-                debugs(3, DBG_CRITICAL, "FATAL: Error opening config file: " << token);
-                delete wordfile;
-                self_destruct();
-                return nullptr;
-            }
-            CfgFiles.push(wordfile);
+            std::unique_ptr<ConfigParser::CfgFile> wordfile(new ConfigParser::CfgFile(path));
+            wordfile->startParse(); // throws on error
+            CfgFiles.push(wordfile.release());
             token = nullptr;
         }
     } while (token == nullptr && !CfgFiles.empty());
@@ -608,54 +589,32 @@ ConfigParser::optionalAclList()
     return acls;
 }
 
-bool
-ConfigParser::CfgFile::startParse(char *path)
-{
-    assert(wordFile == nullptr);
-    debugs(3, 3, "Parsing from " << path);
-    if ((wordFile = fopen(path, "r")) == nullptr) {
-        debugs(3, DBG_CRITICAL, "WARNING: file :" << path << " not found");
-        return false;
-    }
-
-#if _SQUID_WINDOWS_
-    setmode(fileno(wordFile), O_TEXT);
-#endif
-
-    filePath = path;
-    return getFileLine();
-}
-
-bool
-ConfigParser::CfgFile::getFileLine()
+void
+ConfigParser::CfgFile::startParse()
 {
-    // Else get the next line
-    if (fgets(parseBuffer, CONFIG_LINE_LIMIT, wordFile) == nullptr) {
-        /* stop reading from file */
-        fclose(wordFile);
-        wordFile = nullptr;
-        parseBuffer[0] = '\0';
-        return false;
-    }
-    parsePos = parseBuffer;
-    currentLine = parseBuffer;
-    lineNo++;
-    return true;
+    assert(isOpen());
+    confFileData.load();
+    debugs(3, 3, "Parsing from " << confFileData.lineInfo());
 }
 
 char *
 ConfigParser::CfgFile::parse(ConfigParser::TokenType &type)
 {
-    if (!wordFile)
-        return nullptr;
-
     if (!*parseBuffer)
         return nullptr;
 
     char *token;
     while (!(token = nextElement(type))) {
-        if (!getFileLine())
+        auto line = confFileData.nextLine();
+        if (line.isEmpty()) {
+            *parseBuffer = 0;
             return nullptr;
+        }
+
+        assert(line.length() < CONFIG_LINE_LIMIT);
+
+        SBufToCstring(parseBuffer, line);
+        parsePos = parseBuffer;
     }
     return token;
 }
@@ -671,9 +630,3 @@ ConfigParser::CfgFile::nextElement(ConfigParser::TokenType &type)
     return token;
 }
 
-ConfigParser::CfgFile::~CfgFile()
-{
-    if (wordFile)
-        fclose(wordFile);
-}
-

src/ConfigParser.h

@@ -11,6 +11,7 @@
 
 #include "acl/forward.h"
 #include "base/forward.h"
+#include "configuration/File.h"
 #include "sbuf/forward.h"
 #include "SquidString.h"
 
@@ -22,16 +23,6 @@
 class CachePeer;
 class wordlist;
 
-/**
- * Limit to how long any given config line may be.
- * This affects squid.conf and all included files.
- *
- * Behaviour when setting larger than 2KB is unknown.
- * The config parser read mechanism can cope, but the other systems
- * receiving the data from its buffers on such lines may not.
- */
-#define CONFIG_LINE_LIMIT   2048
-
 /**
  * A configuration file Parser. Instances of this class track
  * parsing state and perform tokenisation. Syntax is currently
@@ -161,22 +152,21 @@ class ConfigParser
 
 protected:
     /**
-     * Class used to store required information for the current
-     * configuration file.
+     * Interprets file content as a series of configuration tokens/elements instead of lines.
      */
     class CfgFile
     {
     public:
-        CfgFile(): wordFile(nullptr), parsePos(nullptr), lineNo(0) { parseBuffer[0] = '\0';}
-        ~CfgFile();
+        CfgFile(const char *path) : confFileData(path) { *parseBuffer = 0; }
+
         /// True if the configuration file is open
-        bool isOpen() {return wordFile != nullptr;}
+        bool isOpen() const { return confFileData.isOpen(); }
 
-        /**
-         * Open the file given by 'path' and initializes the CfgFile object
-         * to start parsing
-         */
-        bool startParse(char *path);
+        // filename and line number for debug display
+        SourceLocation lineInfo() const { return confFileData.lineInfo(); }
+
+        /// Initializes the CfgFile object to start parsing
+        void startParse();
 
         /**
          * Do the next parsing step:
@@ -187,19 +177,17 @@ class ConfigParser
         char *parse(TokenType &type);
 
     private:
-        bool getFileLine();   ///< Read the next line from the file
         /**
          * Return the body of the next element. If the wasQuoted is given
          * set to true if the element was quoted.
          */
         char *nextElement(TokenType &type);
-        FILE *wordFile; ///< Pointer to the file.
+
+    private:
+        Configuration::File confFileData; ///< actual file manager holding unparsed file content
+
         char parseBuffer[CONFIG_LINE_LIMIT]; ///< Temporary buffer to store data to parse
-        const char *parsePos; ///< The next element position in parseBuffer string
-    public:
-        std::string filePath; ///< The file path
-        std::string currentLine; ///< The current line to parse
-        int lineNo; ///< Current line number
+        const char *parsePos = nullptr; ///< The next element position in parseBuffer string
     };
 
     /**

src/Makefile.am

@@ -16,7 +16,7 @@ LOADABLE_MODULES_SOURCES = \
 	LoadableModules.cc \
 	LoadableModules.h
 
-SUBDIRS = mem time debug base anyp helper dns html ftp parser comm error eui acl format clients sbuf servers fs repl store DiskIO proxyp
+SUBDIRS = mem time debug base configuration anyp helper dns html ftp parser comm error eui acl format clients sbuf servers fs repl store DiskIO proxyp
 
 if ENABLE_AUTH
 SUBDIRS += auth
@@ -521,6 +521,7 @@ squid_LDADD = \
 	mem/libmem.la \
 	store/libstore.la \
 	time/libtime.la \
+	configuration/libconfiguration.la \
 	$(top_builddir)/lib/libmisccontainers.la \
 	$(top_builddir)/lib/libmiscencoding.la \
 	$(top_builddir)/lib/libmiscutil.la \
@@ -1150,6 +1151,7 @@ tests_testRock_LDADD = \
 	mem/libmem.la \
 	store/libstore.la \
 	$(ADAPTATION_LIBS) \
+	configuration/libconfiguration.la \
 	sbuf/libsbuf.la \
 	time/libtime.la \
 	$(top_builddir)/lib/libmisccontainers.la \
@@ -1327,6 +1329,7 @@ tests_testUfs_LDADD = \
 	mem/libmem.la \
 	store/libstore.la \
 	$(ADAPTATION_LIBS) \
+	configuration/libconfiguration.la \
 	sbuf/libsbuf.la \
 	time/libtime.la \
 	$(top_builddir)/lib/libmisccontainers.la \
@@ -1492,6 +1495,7 @@ tests_testStore_LDADD= \
 	sbuf/libsbuf.la \
 	DiskIO/libdiskio.la \
 	ipc/libipc.la \
+	configuration/libconfiguration.la \
 	$(top_builddir)/lib/libmisccontainers.la \
 	$(top_builddir)/lib/libmiscencoding.la \
 	$(top_builddir)/lib/libmiscutil.la \
@@ -1668,6 +1672,7 @@ tests_testDiskIO_LDADD = \
 	dns/libdns.la \
 	base/libbase.la \
 	mem/libmem.la \
+	configuration/libconfiguration.la \
 	sbuf/libsbuf.la \
 	$(top_builddir)/lib/libmisccontainers.la \
 	$(top_builddir)/lib/libmiscencoding.la \
@@ -1720,6 +1725,7 @@ tests_testACLMaxUserIP_LDADD = \
 	acl/libacls.la \
 	SquidConfig.o \
 	ip/libip.la \
+	configuration/libconfiguration.la \
 	parser/libparser.la \
 	sbuf/libsbuf.la \
 	base/libbase.la \
@@ -1973,6 +1979,7 @@ tests_test_http_range_LDADD = \
 	sbuf/libsbuf.la \
 	debug/libdebug.la \
 	store/libstore.la \
+	configuration/libconfiguration.la \
 	$(SNMP_LIBS) \
 	$(top_builddir)/lib/libmisccontainers.la \
 	$(top_builddir)/lib/libmiscencoding.la \
@@ -2131,6 +2138,7 @@ tests_testHttpReply_LDADD=\
 	ip/libip.la \
 	base/libbase.la \
 	ipc/libipc.la \
+	configuration/libconfiguration.la \
 	sbuf/libsbuf.la \
 	$(top_builddir)/lib/libmisccontainers.la \
 	$(top_builddir)/lib/libmiscencoding.la \
@@ -2363,6 +2371,7 @@ tests_testHttpRequest_LDADD = \
 	$(REPL_OBJS) \
 	$(ADAPTATION_LIBS) \
 	$(ESI_LIBS) \
+	configuration/libconfiguration.la \
 	$(top_builddir)/lib/libmisccontainers.la \
 	$(top_builddir)/lib/libmiscencoding.la \
 	$(top_builddir)/lib/libmiscutil.la \
@@ -2635,7 +2644,6 @@ tests_testCacheManager_LDADD = \
 	helper/libhelper.la \
 	http/libhttp.la \
 	proxyp/libproxyp.la \
-	parser/libparser.la \
 	ident/libident.la \
 	acl/libacls.la \
 	acl/libstate.la \
@@ -2660,6 +2668,8 @@ tests_testCacheManager_LDADD = \
 	$(SNMP_LIBS) \
 	mem/libmem.la \
 	store/libstore.la \
+	configuration/libconfiguration.la \
+	parser/libparser.la \
 	sbuf/libsbuf.la \
 	time/libtime.la \
 	debug/libdebug.la \
@@ -2736,6 +2746,8 @@ nodist_tests_testConfigParser_SOURCES = \
 	tests/stub_libmem.cc \
 	tests/stub_neighbors.cc
 tests_testConfigParser_LDADD = \
+	configuration/libconfiguration.la \
+	parser/libparser.la \
 	base/libbase.la \
 	$(LIBCPPUNIT_LIBS) \
 	$(COMPAT_LIB) \