switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Utils / Logger / Target.cc
index 9c7968c..fc983ec 100644 (file)
@@ -2,23 +2,28 @@
 //
 // Copyright (C) 2007
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
-// Competence Center NETwork research (NET), St. Augustin, GERMANY
-//     Stefan Bund <g0dil@berlios.de>
 //
-// This program is free software; you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation; either version 2 of the License, or
-// (at your option) any later version.
+// The contents of this file are subject to the Fraunhofer FOKUS Public License
+// Version 1.0 (the "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at 
+// http://senf.berlios.de/license.html
 //
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
+// The Fraunhofer FOKUS Public License Version 1.0 is based on, 
+// but modifies the Mozilla Public License Version 1.1.
+// See the full license text for the amendments.
 //
-// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the
-// Free Software Foundation, Inc.,
-// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+// Software distributed under the License is distributed on an "AS IS" basis, 
+// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
+// for the specific language governing rights and limitations under the License.
+//
+// The Original Code is Fraunhofer FOKUS code.
+//
+// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
+// (registered association), Hansastraße 27 c, 80686 Munich, Germany.
+// All Rights Reserved.
+//
+// Contributor(s):
+//   Stefan Bund <g0dil@berlios.de>
 
 /** \file
     \brief Target non-inline non-template implementation */
 #include <boost/format.hpp>
 #include "ConsoleTarget.hh"
 #include <senf/Utils/Console/Console.hh>
-#include <senf/Utils/Console/Sysdir.hh>
-#include <senf/Utils/membind.hh>
 
 //#include "Target.mpp"
 #define prefix_
-///////////////////////////////cc.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::log::Target
 
 namespace senf {
@@ -55,8 +58,8 @@ namespace detail {
 
 prefix_ senf::log::Target::Target(std::string const & name)
 {
-    namespace kw = senf::console::kw;
-    namespace fty = senf::console::factory;
+    namespace kw = console::kw;
+    namespace fty = console::factory;
 
     detail::TargetRegistry::instance().registerTarget(this, name);
     consoleDir_()
@@ -70,12 +73,14 @@ prefix_ senf::log::Target::Target(std::string const & name)
                   "    LEVEL   match messages with level above this. Log levels in increasing order\n"
                   "            are:\n"
                   "                verbose, notice, message, important, critical, fatal\n"
+                  "            If the log level is listed as 'default', the streams default limit\n"
+                  "            applies.\n"
                   "    ACTION  action to take: accept or reject") );
     consoleDir_()
         .add("route", fty::Command(&Target::consoleRoute, this)
              .arg("index", "index at which to insert new rule")
              .arg("parameters", "log parameters. The log parameters select the log stream, log area\n"
-                  "              and log level. You may specify any combination of these parameterse\n"
+                  "              and log level. You may specify any combination of these parameters\n"
                   "              in any order. Use the '/sys/log/stream' and '/sys/log/areas' commands\n"
                   "              to list all valid streams and areas. Valid log levels are:\n"
                   "                  VERBOSE NOTICE MESSAGE IMPORTANT CRITICAL FATAL")
@@ -88,9 +93,10 @@ prefix_ senf::log::Target::Target(std::string const & name)
                   "Examples:\n"
                   "\n"
                   "    route ()\n"
-                  "        route all messages to this target.\n"
+                  "        route all messages with level above each streams default log limit to this\n"
+                  "        target.\n"
                   "\n"
-                  "    route 1 (my::Class)\n"
+                  "    route 1 (my::Class VERBOSE)\n"
                   "        route all messages which are in the my::Class area. Insert this route after\n"
                   "        the first route,\n"
                   "\n"
@@ -114,7 +120,7 @@ prefix_ senf::log::Target::Target(std::string const & name)
     consoleDir_()
         .add("unroute", fty::Command(&Target::consoleUnroute, this)
              .arg("parameters", "log parameters. The log parameters select the log stream, log area\n"
-                  "              and log level. You may specify any combination of these parameterse\n"
+                  "              and log level. You may specify any combination of these parameters\n"
                   "              in any order. Use the '/sys/log/stream' and '/sys/log/areas' commands\n"
                   "              to list all valid streams and areas. Valid log levels are:\n"
                   "                  VERBOSE NOTICE MESSAGE IMPORTANT CRITICAL FATAL")
@@ -214,7 +220,7 @@ prefix_ void senf::log::Target::flush()
             updateRoutingCache(i->stream_, i->area_);
 }
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // protected members
 
 prefix_ senf::console::ScopedDirectory<> & senf::log::Target::consoleDir()
@@ -222,7 +228,7 @@ prefix_ senf::console::ScopedDirectory<> & senf::log::Target::consoleDir()
     return consoleDir_();
 }
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // private members
 
 prefix_ void senf::log::Target::route(detail::StreamBase const * stream,
@@ -285,7 +291,7 @@ prefix_ void senf::log::Target::updateRoutingCache(detail::StreamBase const * st
     unsigned limit (DISABLED::value);
     RIB::iterator i (rib_.begin());
     RIB::iterator const i_end (rib_.end());
-    for(; i != i_end; ++i)
+    for (; i != i_end; ++i)
         if ( (! i->stream_ || i->stream_ == stream) &&
              (! i->area_ || i->area_ == area) &&
              i->action_ == ACCEPT ) {
@@ -325,12 +331,16 @@ namespace {
             return l.substr(l.size()-29);
         return l;
     }
+
+    char const * levelNames[] = {
+        "NONE", "VERBOSE", "NOTICE", "MESSAGE", "IMPORTANT", "CRITICAL", "FATAL", "DISABLED" };
+
+    char const * levelNamesList[] = {
+        "default", "verbose", "notice", "message", "important", "critical", "fatal", "disabled" };
 }
 
 prefix_ void senf::log::Target::consoleList(std::ostream & os)
 {
-    static char const * levels[] = {
-        "verbose", "verbose", "notice", "message", "important", "critical", "fatal", "disabled" };
 
     boost::format fmt ("%2d %-29s %-29s %-9s %-6s\n");
     os << fmt % "#" % "STREAM" % "AREA" % "LEVEL" % "ACTION";
@@ -340,7 +350,7 @@ prefix_ void senf::log::Target::consoleList(std::ostream & os)
             % n
             % formatLabel(i->stream())
             % formatLabel(i->area())
-            % levels[i->level()]
+            % levelNamesList[i->level()]
             % (i->action() == ACCEPT ? "accept" : "reject");
 }
 
@@ -354,12 +364,12 @@ prefix_ void senf::log::Target::consoleUnroute(detail::LogParameters const & pm,
     unroute(pm.stream, pm.area, pm.level, action);
 }
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::log::detail::TargetRegistry
 
 prefix_ void senf::log::detail::TargetRegistry::dynamicTarget(std::auto_ptr<Target> target)
 {
-    namespace fty = senf::console::factory;
+    namespace fty = console::factory;
 
     target->consoleDir()
         .add("remove", fty::Command<void ()>(
@@ -397,8 +407,8 @@ prefix_ void senf::log::detail::TargetRegistry::consoleRemoveTarget(Target * tar
 prefix_ senf::log::detail::TargetRegistry::TargetRegistry()
     : fallbackRouting_(true)
 {
-    namespace kw = senf::console::kw;
-    namespace fty = senf::console::factory;
+    namespace kw = console::kw;
+    namespace fty = console::factory;
 
     console::sysdir().add("log", consoleDir_());
     consoleDir_()
@@ -406,11 +416,11 @@ prefix_ senf::log::detail::TargetRegistry::TargetRegistry()
              .doc("List all areas") );
     consoleDir_()
         .add("streams", fty::Command(&TargetRegistry::consoleStreams, this)
-             .doc("List all streams") );
+             .doc("List all streams with the streams default runtime log level limit.") );
     consoleDir_()
         .add("message", fty::Command(&TargetRegistry::consoleWrite, this)
              .arg("parameters", "log parameters. The log parameters select the log stream, log area\n"
-                  "              and log level. You may specify any combination of these parameterse\n"
+                  "              and log level. You may specify any combination of these parameters\n"
                   "              in any order. Use the '/sys/log/stream' and '/sys/log/areas' commands\n"
                   "              to list all valid streams and areas. Valid log levels are:\n"
                   "                  VERBOSE NOTICE MESSAGE IMPORTANT CRITICAL FATAL",
@@ -455,8 +465,10 @@ prefix_ void senf::log::detail::TargetRegistry::consoleStreams(std::ostream & os
 {
     StreamRegistry::iterator i (StreamRegistry::instance().begin());
     StreamRegistry::iterator const i_end (StreamRegistry::instance().end());
-    for (; i != i_end; ++i)
-        os << *i << "\n";
+    for (; i != i_end; ++i) {
+        os << *i << " "
+           << levelNames[StreamRegistry::instance().lookup(*i)->defaultRuntimeLimit()] << "\n";
+    }
 }
 
 prefix_ void senf::log::detail::TargetRegistry::consoleWrite(LogParameters pm,
@@ -472,7 +484,7 @@ senf::log::detail::TargetRegistry::consoleSelf(std::ostream & os)
     return senf::console::Client::get(os).consoleDir().node().thisptr();
 }
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::log::detail::LogParameters
 
 prefix_ void senf::log::detail::LogParameters::clear()
@@ -492,8 +504,7 @@ prefix_ void senf::log::detail::LogParameters::setDefaults()
         level = MESSAGE::value;
 }
 
-prefix_ senf::log::detail::LogParameters::LogParameters
-senf::log::detail::LogParameters::defaultParameters()
+prefix_ senf::log::detail::LogParameters senf::log::detail::LogParameters::defaultParameters()
 {
     LogParameters pm;
     pm.clear();
@@ -501,7 +512,7 @@ senf::log::detail::LogParameters::defaultParameters()
     return pm;
 }
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // namespace members
 
 prefix_ std::ostream & senf::log::operator<<(std::ostream & os, senf::log::Target::action_t const & action)
@@ -514,9 +525,6 @@ prefix_ std::ostream & senf::log::operator<<(std::ostream & os, senf::log::Targe
 
 namespace {
 
-    char const * levelNames[] = {
-        "NONE", "VERBOSE", "NOTICE", "MESSAGE", "IMPORTANT", "CRITICAL", "FATAL", "DISABLED" };
-
     void parseParamToken(std::string const & value, senf::log::detail::LogParameters & out)
     {
         senf::log::detail::StreamBase const * s (
@@ -575,7 +583,7 @@ senf_console_parse_argument(console::ParseCommandInfo::TokensRange const & token
         parseParamToken(i->value(), out);
 }
 
-//////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // I need to put this here, otherwise the file target will not be registered
 // if it is not used ... :-(
 
@@ -583,7 +591,7 @@ senf::log::FileTarget::RegisterConsole senf::log::FileTarget::RegisterConsole::i
 senf::log::SyslogTarget::RegisterConsole senf::log::SyslogTarget::RegisterConsole::instance;
 senf::log::SyslogUDPTarget::RegisterConsole senf::log::SyslogUDPTarget::RegisterConsole::instance;
 
-///////////////////////////////cc.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #undef prefix_
 //#include "Target.mpp"