Utils/Logger/FileTarget.cc

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief FileTarget non-inline non-template implementation */
  25
  26 #include "FileTarget.hh"
  27 //#include "FileTarget.ih"
  28
  29 // Custom includes
  30 #include "../Console/Console.hh"
  31 #include "../Exception.hh"
  32 #include <boost/filesystem/path.hpp>
  33
  34 //#include "FileTarget.mpp"
  35 #define prefix_
  36 ///////////////////////////////cc.p////////////////////////////////////////
  37
  38 namespace {
  39
  40     std::string getNodename(std::string const & filename, std::string const & nodename)
  41     {
  42         if (! nodename.empty())
  43             return nodename;
  44         return boost::filesystem::path(filename).leaf();
  45     }
  46
  47 }
  48
  49 prefix_ senf::log::FileTarget::FileTarget(std::string const & filename,
  50                                           std::string const & nodename)
  51     : ofstream_t (filename.c_str(), std::ofstream::app),
  52       IOStreamTarget (getNodename(filename, nodename), ofstream_t::member),
  53       file_ (filename)
  54 {
  55     if (! ofstream_t::member)
  56         SENF_THROW_SYSTEM_EXCEPTION("logfile open") << ": " << filename;
  57     consoleDir().add( "reopen", senf::membind(
  58                           static_cast<void (FileTarget::*)()>(&FileTarget::reopen),
  59                           this))
  60         .doc("Reopen logfile");
  61     consoleDir().add("reopen", senf::membind(
  62                          static_cast<void (FileTarget::*)(std::string const &)>(&FileTarget::reopen),
  63                          this))
  64         .arg("filename","new filename")
  65         .overloadDoc("Reopen logfile under new name");
  66     consoleDir().add("file", boost::cref(file_))
  67         .doc("Show filename log messages are sent to");
  68 }
  69
  70 prefix_ void senf::log::FileTarget::reopen()
  71 {
  72     ofstream_t::member.close();
  73     ofstream_t::member.open(file_.c_str(), std::ofstream::app);
  74 }
  75
  76 prefix_ void senf::log::FileTarget::reopen(std::string const & file)
  77 {
  78     file_ = file;
  79     reopen();
  80     // Rename console directory
  81     console::DirectoryNode::ptr parent (consoleDir().node().parent());
  82     if (parent)
  83         parent->add(file, consoleDir().node().unlink());
  84 }
  85
  86 prefix_ std::string const & senf::log::FileTarget::filename()
  87     const
  88 {
  89     return file_;
  90 }
  91
  92 prefix_ senf::log::FileTarget::RegisterConsole::RegisterConsole()
  93 {
  94     namespace kw = senf::console::kw;
  95
  96     detail::TargetRegistry::instance().consoleDir().add("file-target",&RegisterConsole::create)
  97         .arg("filename", "name of logfile")
  98         .arg("nodename", "name of node in console. Defaults to the files basename",
  99              kw::default_value = "")
 100         .doc("Create new file target. Examples:\n"
 101              "\n"
 102              "Create new file target '/var/log/example.log\n"
 103              "    $ file-target \"/var/log/example.log\"\n"
 104              "    <Directory '/sys/log/example.log'>\n"
 105              "\n"
 106              "In a configuration file, create new file target '/var/log/example.log' and set\n"
 107              "some parameters (If written on one line, this works at the console too:\n"
 108              "    /sys/log/file-target \"/var/log/example.log\" mainlog {\n"
 109              "        route (IMPORTANT);             # route all important messages\n"
 110              "        timeFormat \"\";               # use non-formatted time format\n"
 111              "        showArea false;                # don't show log area\n"
 112              "    }\n");
 113 }
 114
 115 prefix_ boost::shared_ptr<senf::console::DirectoryNode>
 116 senf::log::FileTarget::RegisterConsole::create(std::string const & filename,
 117                                                std::string const & nodename)
 118 {
 119     std::auto_ptr<Target> tp (new FileTarget(filename, nodename));
 120     Target & target (*tp.get());
 121     detail::TargetRegistry::instance().dynamicTarget(tp);
 122     return target.consoleDir().node().thisptr();
 123 }
 124
 125 ///////////////////////////////cc.e////////////////////////////////////////
 126 #undef prefix_
 127 //#include "FileTarget.mpp"
 128
 129 \f
 130 // Local Variables:
 131 // mode: c++
 132 // fill-column: 100
 133 // comment-column: 40
 134 // c-file-style: "senf"
 135 // indent-tabs-mode: nil
 136 // ispell-local-dictionary: "american"
 137 // compile-command: "scons -u test"
 138 // End: