The configure method takes test_only flag so we can avoid
[metaproxy-moved-to-github.git] / src / filter_log.cpp
index 232fd7a..74e86db 100644 (file)
-/* $Id: filter_log.cpp,v 1.5 2005-10-19 22:45:59 marc Exp $
-   Copyright (c) 2005, Index Data.
+/* $Id: filter_log.cpp,v 1.33 2008-02-20 15:07:52 adam Exp $
+   Copyright (c) 2005-2007, Index Data.
 
-%LICENSE%
- */
+This file is part of Metaproxy.
 
+Metaproxy 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, or (at your option) any later
+version.
 
-#include "config.hpp"
+Metaproxy 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.
 
-#include "filter.hpp"
-#include "router.hpp"
-#include "package.hpp"
+You should have received a copy of the GNU General Public License
+along with Metaproxy; see the file LICENSE.  If not, write to the
+Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
+02111-1307, USA.
+ */
 
 #include "filter_log.hpp"
+#include "config.hpp"
+#include "package.hpp"
+
+#include <string>
+#include <sstream>
+#include <boost/thread/mutex.hpp>
+#include <boost/date_time/posix_time/posix_time.hpp>
 
+#include "gduutil.hpp"
+#include "util.hpp"
+#include "xmlutil.hpp"
+
+#include <fstream>
 #include <yaz/zgdu.h>
-#include <yaz/log.h>
+#include <yaz/wrbuf.h>
+#include <yaz/querytowrbuf.h>
 
-#include <boost/date_time/posix_time/posix_time.hpp>
-#include <iostream>
 
+namespace mp = metaproxy_1;
+namespace yf = metaproxy_1::filter;
 
-yp2::filter::Log::Log() {}
+namespace metaproxy_1 {
+    namespace filter {
+        class Log::Impl {
+        public:
+            class LFile;
+            typedef boost::shared_ptr<Log::Impl::LFile> LFilePtr;
+        public:
+            //Impl();
+            Impl(const std::string &x = "-");
+           ~Impl();
+            void process(metaproxy_1::Package & package);
+            void configure(const xmlNode * ptr);
+        private:
+            void openfile(const std::string &fname);
+            // needs to be static to be called by C pointer-to-function-syntax
+            static void stream_write(ODR o, void *handle, int type, 
+                              const char *buf, int len);
+            // needs to be static to be called by C pointer-to-function-syntax
+            static void option_write(const char *name, void *handle);
+        private:
+            std::string m_msg_config;
+            bool m_access;
+            bool m_user_access;
+            bool m_req_apdu;
+            bool m_res_apdu;
+            bool m_req_session;
+            bool m_res_session;
+            bool m_init_options;
+            LFilePtr m_file;
+            // Only used during configure stage (no threading), 
+            // for performance avoid opening files which other log filter 
+            // instances already have opened
+            static std::list<LFilePtr> filter_log_files;
 
-void yp2::filter::Log::process(Package &package) const {
+            boost::mutex m_session_mutex;
+            std::map<mp::Session, std::string> m_sessions;
+       };
+
+        class Log::Impl::LFile {
+        public:
+            boost::mutex m_mutex;
+            std::string m_fname;
+            std::ofstream fout;
+            std::ostream &out;
+            LFile(std::string fname);
+            LFile(std::string fname, std::ostream &use_this);
+        };
+        
+    }
+}
+
+// define Pimpl wrapper forwarding to Impl
+yf::Log::Log() : m_p(new Impl)
+{
+}
+
+yf::Log::Log(const std::string &x) : m_p(new Impl(x))
+{
+}
+
+yf::Log::~Log()
+{  // must have a destructor because of boost::scoped_ptr
+}
 
-    Z_GDU *gdu;
+void yf::Log::configure(const xmlNode *xmlnode, bool test_only)
+{
+    m_p->configure(xmlnode);
+}
+
+void yf::Log::process(mp::Package &package) const
+{
+    m_p->process(package);
+}
+
+
+// define Implementation stuff
+
+// static initialization
+std::list<yf::Log::Impl::LFilePtr> yf::Log::Impl::filter_log_files;
+
+
+// yf::Log::Impl::Impl()
+// {
+//     m_access = true;
+//     m_req_apdu = false;
+//     m_res_apdu = false;
+//     m_req_session = false;
+//     m_res_session = false;
+//     m_init_options = false;
+//     openfile("");
+// }
+
+yf::Log::Impl::Impl(const std::string &x)
+    : m_msg_config(x),
+      m_access(true),
+      m_user_access(false),
+      m_req_apdu(false),
+      m_res_apdu(false),
+      m_req_session(false),
+      m_res_session(false),
+      m_init_options(false)
+{
+    openfile("");
+}
+
+
+yf::Log::Impl::~Impl() 
+{
+}
+
+
+void yf::Log::Impl::configure(const xmlNode *ptr)
+{
+    for (ptr = ptr->children; ptr; ptr = ptr->next)
+    {
+        if (ptr->type != XML_ELEMENT_NODE)
+            continue;
+        if (!strcmp((const char *) ptr->name, "message"))
+            m_msg_config = mp::xml::get_text(ptr);
+        else if (!strcmp((const char *) ptr->name, "filename"))
+        {
+            std::string fname = mp::xml::get_text(ptr);
+            openfile(fname);
+        }
+        else if (!strcmp((const char *) ptr->name, "category"))
+        {
+            const struct _xmlAttr *attr;
+            for (attr = ptr->properties; attr; attr = attr->next)
+            {
+                if (!strcmp((const char *) attr->name,  "access"))
+                    m_access = mp::xml::get_bool(attr->children, true);
+                else if (!strcmp((const char *) attr->name, "user-access"))
+                    m_user_access = mp::xml::get_bool(attr->children, true);
+                else if (!strcmp((const char *) attr->name, "request-apdu"))
+                    m_req_apdu = mp::xml::get_bool(attr->children, true);
+                else if (!strcmp((const char *) attr->name, "response-apdu"))
+                    m_res_apdu = mp::xml::get_bool(attr->children, true);
+                else if (!strcmp((const char *) attr->name, "apdu"))
+                {
+                    m_req_apdu = mp::xml::get_bool(attr->children, true);
+                    m_res_apdu = m_req_apdu;
+                }
+                else if (!strcmp((const char *) attr->name,
+                                 "request-session"))
+                    m_req_session = 
+                        mp::xml::get_bool(attr->children, true);
+                else if (!strcmp((const char *) attr->name, 
+                                 "response-session"))
+                    m_res_session = 
+                        mp::xml::get_bool(attr->children, true);
+                else if (!strcmp((const char *) attr->name,
+                                 "session"))
+                {
+                    m_req_session = 
+                        mp::xml::get_bool(attr->children, true);
+                    m_res_session = m_req_session;
+                }
+                else if (!strcmp((const char *) attr->name, 
+                                 "init-options"))
+                    m_init_options = 
+                        mp::xml::get_bool(attr->children, true);
+                else
+                    throw mp::filter::FilterException(
+                        "Bad attribute " + std::string((const char *)
+                                                       attr->name));
+            }
+        }
+        else
+        {
+            throw mp::filter::FilterException("Bad element " 
+                                               + std::string((const char *)
+                                                             ptr->name));
+        }
+    }
+}
+
+void yf::Log::Impl::process(mp::Package &package)
+{
+    Z_GDU *gdu = package.request().get();
+    std::string user("-");
 
     // getting timestamp for receiving of package
     boost::posix_time::ptime receive_time
         = boost::posix_time::microsec_clock::local_time();
 
-    // scope for locking Ostream 
-    { 
-        boost::mutex::scoped_lock scoped_lock(m_log_mutex);
-        std::cout << receive_time << " ";
-        std::cout << "request id=" << package.session().id();
-        std::cout << " close=" 
-                  << (package.session().is_closed() ? "yes" : "no")
-                  << "\n";
-    }
-    
-    gdu = package.request().get();
-    if (gdu)
+    // scope for session lock
     {
-       ODR odr = odr_createmem(ODR_PRINT);
-       z_GDU(odr, &gdu, 0, 0);
-       odr_destroy(odr);
+        boost::mutex::scoped_lock scoped_lock(m_session_mutex);
+        
+        if (gdu && gdu->which == Z_GDU_Z3950)
+        {
+            Z_APDU *apdu_req = gdu->u.z3950;
+            if (apdu_req->which == Z_APDU_initRequest)
+            {
+                Z_InitRequest *req = apdu_req->u.initRequest;
+                Z_IdAuthentication *a = req->idAuthentication;
+                if (a)
+                {
+                    if (a->which == Z_IdAuthentication_idPass)
+                        user = a->u.idPass->userId;
+                    else if (a->which == Z_IdAuthentication_open)
+                        user = a->u.open;
+                
+                    m_sessions[package.session()] = user;
+                }
+            }
+        }
+        std::map<mp::Session,std::string>::iterator it = 
+            m_sessions.find(package.session());
+        if (it != m_sessions.end())
+            user = it->second;
+        
+        if (package.session().is_closed())
+            m_sessions.erase(package.session());
     }
+    // scope for locking Ostream
+    { 
+        boost::mutex::scoped_lock scoped_lock(m_file->m_mutex);
+        if (m_access)
+        {
+            if (gdu)          
+            {
+                m_file->out
+                    //<< receive_time << " "
+                    //<< to_iso_string(receive_time) << " "
+                    << to_iso_extended_string(receive_time) << " "
+                    << m_msg_config << " "
+                    << package << " "
+                    << "000000.000000" << " " 
+                    << *gdu
+                    << "\n";
+            }
+        }
+
+        if (m_user_access)
+        {
+            if (gdu)          
+            {
+                m_file->out
+                    //<< receive_time << " "
+                    //<< to_iso_string(receive_time) << " "
+                    << to_iso_extended_string(receive_time) << " "
+                    << m_msg_config << " " << user << " "
+                    << package << " "
+                    << "000000.000000" << " " 
+                    << *gdu
+                    << "\n";
+            }
+        }
 
+        if (m_req_session)
+        {
+            m_file->out << receive_time << " " << m_msg_config;
+            m_file->out << " request id=" << package.session().id();
+            m_file->out << " close=" 
+                             << (package.session().is_closed() ? "yes" : "no")
+                             << "\n";
+        }
+
+        if (m_init_options)
+        {
+            if (gdu && gdu->which == Z_GDU_Z3950 &&
+                gdu->u.z3950->which == Z_APDU_initRequest)
+            {
+                m_file->out << receive_time << " " << m_msg_config;
+                m_file->out << " init options:";
+                yaz_init_opt_decode(gdu->u.z3950->u.initRequest->options,
+                                    option_write, m_file.get());
+                m_file->out << "\n";
+            }
+        }
+        
+        if (m_req_apdu)
+        {
+            if (gdu)
+            {
+                mp::odr odr(ODR_PRINT);
+                odr_set_stream(odr, m_file.get(), stream_write, 0);
+                z_GDU(odr, &gdu, 0, 0);
+            }
+        }
+        m_file->out.flush();
+    }
+    
     // unlocked during move
     package.move();
 
+    gdu = package.response().get();
+
     // getting timestamp for sending of package
     boost::posix_time::ptime send_time
         = boost::posix_time::microsec_clock::local_time();
@@ -59,29 +340,135 @@ void yp2::filter::Log::process(Package &package) const {
 
     // scope for locking Ostream 
     { 
-        boost::mutex::scoped_lock scoped_lock(m_log_mutex);
-        std::cout << send_time << " ";
-        std::cout << "response id=" << package.session().id();
-        std::cout << " close=" 
-                  << (package.session().is_closed() ? "yes " : "no ")
-                  << "duration=" << duration      
-                  << "\n";
-            //<< "duration=" << duration.total_seconds() 
-            //    << "." << duration.fractional_seconds()
-            //      << "\n";
+        boost::mutex::scoped_lock scoped_lock(m_file->m_mutex);
+
+        if (m_access)
+        {
+            if (gdu)
+            {
+                m_file->out
+                    //<< send_time << " "
+                    //<< to_iso_string(send_time) << " "
+                    << to_iso_extended_string(send_time) << " "
+                    << m_msg_config << " "
+                    << package << " "
+                    << to_iso_string(duration) << " "
+                    << *gdu
+                    << "\n";
+            }   
+        }
+        if (m_user_access)
+        {
+            if (gdu)
+            {
+                m_file->out
+                    //<< send_time << " "
+                    //<< to_iso_string(send_time) << " "
+                    << to_iso_extended_string(send_time) << " "
+                    << m_msg_config << " " << user << " "
+                    << package << " "
+                    << to_iso_string(duration) << " "
+                    << *gdu
+                    << "\n";
+            }   
+        }
+
+        if (m_res_session)
+        {
+            m_file->out << send_time << " " << m_msg_config;
+            m_file->out << " response id=" << package.session().id();
+            m_file->out << " close=" 
+                             << (package.session().is_closed() ? "yes " : "no ")
+                             << "duration=" << duration      
+                             << "\n";
+        }
+
+        if (m_init_options)
+        {
+            if (gdu && gdu->which == Z_GDU_Z3950 &&
+                gdu->u.z3950->which == Z_APDU_initResponse)
+            {
+                m_file->out << receive_time << " " << m_msg_config;
+                m_file->out << " init options:";
+                yaz_init_opt_decode(gdu->u.z3950->u.initResponse->options,
+                                    option_write, m_file.get());
+                m_file->out << "\n";
+            }
+        }
+        
+        if (m_res_apdu)
+        {
+            if (gdu)
+            {
+                mp::odr odr(ODR_PRINT);
+                odr_set_stream(odr, m_file.get(), stream_write, 0);
+                z_GDU(odr, &gdu, 0, 0);
+            }
+        }
+        m_file->out.flush();
     }
-    
-    gdu = package.response().get();
-    if (gdu)
+}
+
+
+void yf::Log::Impl::openfile(const std::string &fname)
+{
+    std::list<LFilePtr>::const_iterator it
+        = filter_log_files.begin();
+    for (; it != filter_log_files.end(); it++)
     {
-       ODR odr = odr_createmem(ODR_PRINT);
-       z_GDU(odr, &gdu, 0, 0);
-       odr_destroy(odr);
+        if ((*it)->m_fname == fname)
+        {
+            m_file = *it;
+            return;
+        }
     }
+    // open stdout for empty file
+    LFilePtr newfile(fname.length() == 0 
+                     ? new LFile(fname, std::cout) 
+                     : new LFile(fname));
+    filter_log_files.push_back(newfile);
+    m_file = newfile;
+}
+
+
+void yf::Log::Impl::stream_write(ODR o, void *handle, int type, const char *buf, int len)
+{
+    yf::Log::Impl::LFile *lfile = (yf::Log::Impl::LFile*) handle;
+    lfile->out.write(buf, len);
+}
+
+void yf::Log::Impl::option_write(const char *name, void *handle)
+{
+    yf::Log::Impl::LFile *lfile = (yf::Log::Impl::LFile*) handle;
+    lfile->out << " " << name;
+}
+
+
+yf::Log::Impl::LFile::LFile(std::string fname) : 
+    m_fname(fname), fout(fname.c_str(),std::ios_base::app), out(fout)
+{
+}
+
+yf::Log::Impl::LFile::LFile(std::string fname, std::ostream &use_this) : 
+    m_fname(fname), out(use_this)
+{
 }
 
-// defining and initializing static members
-boost::mutex yp2::filter::Log::m_log_mutex;
+
+
+
+static mp::filter::Base* filter_creator()
+{
+    return new mp::filter::Log;
+}
+
+extern "C" {
+    struct metaproxy_1_filter_struct metaproxy_1_filter_log = {
+        0,
+        "log",
+        filter_creator
+    };
+}
 
 /*
  * Local variables: