Implement include directive for properties files.

Initial patch provided by: Jukka Lantto  <jukka dot lantto at outokumpu dot com>

Author: wilx

AUTHORS

@@ -18,3 +18,4 @@ Jens Rehsack          <[email protected]>
 Siva Chandran P       <[email protected]>
 Chernyshev Vyacheslav <[email protected]>
 Chris Steenwyk        <[email protected]>
+Jukka Lantto          <[email protected]>

include/log4cplus/configurator.h

@@ -46,18 +46,23 @@ namespace log4cplus
     /**
      * Provides configuration from an external file.  See configure() for
      * the expected format.
-     * 
+     *
      * <em>All option values admit variable substitution.</em> For
      * example, if <code>userhome</code> environment property is set to
      * <code>/home/xyz</code> and the File option is set to the string
      * <code>${userhome}/test.log</code>, then File option will be
      * interpreted as the string <code>/home/xyz/test.log</code>.
-     * 
+     *
      * The syntax of variable substitution is similar to that of UNIX
      * shells. The string between an opening <b>&quot;${&quot;</b> and
      * closing <b>&quot;}&quot;</b> is interpreted as a key. Its value is
      * searched in the environment properties.  The corresponding value replaces
      * the ${variableName} sequence.
+     *
+     * Configuration files also recognize <code>include
+     * <i>file.properties</i></code> directive that allow composing
+     * configuration from multiple files. There is no cyclic includes
+     * detection mechanism to stop unbound recursion.
      */
     class LOG4CPLUS_EXPORT PropertyConfigurator
     {

include/log4cplus/helpers/property.h

@@ -39,6 +39,7 @@
 namespace log4cplus {
     namespace helpers {
 
+        //! \sa log4cplus::PropertyConfigurator
         class LOG4CPLUS_EXPORT Properties {
         public:
             enum PFlags
@@ -141,6 +142,7 @@ namespace log4cplus {
 
           // Data
             StringMap data;
+            unsigned flags;
 
         private:
             template <typename StringType>

src/property.cxx

@@ -102,38 +102,13 @@ trim_ws (tstring & str)
 }
 
 
-} // namespace
-
-
-
-///////////////////////////////////////////////////////////////////////////////
-// Properties ctors and dtor
-///////////////////////////////////////////////////////////////////////////////
-
-Properties::Properties() 
-{
-}
-
-
-
-Properties::Properties(tistream& input)
-{
-    init(input);
-}
-
-
-
-Properties::Properties(const tstring& inputFile, unsigned flags)
+void
+imbue_file_from_flags (tistream & file, unsigned flags)
 {
-    if (inputFile.empty ())
-        return;
-
-    tifstream file;
-
-    switch (flags & (fEncodingMask << fEncodingShift))
+    switch (flags & (Properties::fEncodingMask << Properties::fEncodingShift))
     {
 #if defined (LOG4CPLUS_HAVE_CODECVT_UTF8_FACET) && defined (UNICODE)
-    case fUTF8:
+    case Properties::fUTF8:
         file.imbue (
             std::locale (file.getloc (),
                 new std::codecvt_utf8<tchar, 0x10FFFF,
@@ -142,15 +117,15 @@ Properties::Properties(const tstring& inputFile, unsigned flags)
 #endif
 
 #if defined (LOG4CPLUS_HAVE_CODECVT_UTF16_FACET) && defined (UNICODE)
-    case fUTF16:
+    case Properties::fUTF16:
         file.imbue (
             std::locale (file.getloc (),
                 new std::codecvt_utf16<tchar, 0x10FFFF,
                     static_cast<std::codecvt_mode>(std::consume_header | std::little_endian)>));
         break;
 
 #elif defined (UNICODE) && defined (WIN32)
-    case fUTF16:
+    case Properties::fUTF16:
         file.imbue (
             std::locale (file.getloc (),
                 // TODO: This should actually be a custom "null" facet
@@ -161,19 +136,53 @@ Properties::Properties(const tstring& inputFile, unsigned flags)
 #endif
 
 #if defined (LOG4CPLUS_HAVE_CODECVT_UTF32_FACET) && defined (UNICODE)
-    case fUTF32:
+    case Properties::fUTF32:
         file.imbue (
             std::locale (file.getloc (),
                 new std::codecvt_utf32<tchar, 0x10FFFF,
                     static_cast<std::codecvt_mode>(std::consume_header | std::little_endian)>));
         break;
 #endif
 
-    case fUnspecEncoding:;
+    case Properties::fUnspecEncoding:;
     default:
         // Do nothing.
         ;
     }
+}
+
+
+} // namespace
+
+
+
+///////////////////////////////////////////////////////////////////////////////
+// Properties ctors and dtor
+///////////////////////////////////////////////////////////////////////////////
+
+Properties::Properties()
+    : flags (0)
+{
+}
+
+
+
+Properties::Properties(tistream& input)
+    : flags (0)
+{
+    init(input);
+}
+
+
+
+Properties::Properties(const tstring& inputFile, unsigned f)
+    : flags (f)
+{
+    if (inputFile.empty ())
+        return;
+
+    tifstream file;
+    imbue_file_from_flags (file, flags);
 
     file.open(LOG4CPLUS_FSTREAM_PREFERED_FILE_NAME(inputFile).c_str(),
         std::ios::binary);
@@ -216,6 +225,24 @@ Properties::init(tistream& input)
             trim_ws (value);
             setProperty(key, value);
         }
+        else if (buffer.compare (0, 7, LOG4CPLUS_TEXT ("include")) == 0
+            && buffer.size () >= 7 + 1 + 1
+            && is_space (buffer[7]))
+        {
+            tstring included (buffer, 8) ;
+            trim_ws (included);
+
+            tifstream file;
+            imbue_file_from_flags (file, flags);
+
+            file.open (LOG4CPLUS_FSTREAM_PREFERED_FILE_NAME(included).c_str(),
+                std::ios::binary);
+            if (! file.good ())
+                helpers::getLogLog ().error (
+                    LOG4CPLUS_TEXT ("could not open file ") + included);
+
+            init (file);
+        }
     }
 }