Implemented new log category 'user-access'.
authorAdam Dickmeiss <adam@indexdata.dk>
Tue, 22 May 2007 19:45:57 +0000 (19:45 +0000)
committerAdam Dickmeiss <adam@indexdata.dk>
Tue, 22 May 2007 19:45:57 +0000 (19:45 +0000)
NEWS
doc/log.xml
etc/config0.xml
src/filter_log.cpp

diff --git a/NEWS b/NEWS
index 1d1a743..b415d07 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,6 +1,8 @@
 --- 1.0.9 ..
 
-Extended the access log a bit. Updated documentation accordingly.
+Extension for log module. The log category 'access' logs more details.
+New category 'user-access' added which is simlar to 'access' but adds
+the Z39.50 user as for all entries in a session.
 
 Switched to GPL v2.
 
index 618b3ce..e72e4e0 100644 (file)
@@ -4,7 +4,7 @@
  <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
-<!-- $Id: log.xml,v 1.11 2007-05-22 13:03:32 adam Exp $ -->
+<!-- $Id: log.xml,v 1.12 2007-05-22 19:45:57 adam Exp $ -->
 <refentry id="ref-log">
  <refmeta>
   <refentrytitle>log</refentrytitle>
          </para>
         </listitem>
        </varlistentry>
+       <varlistentry><term>user-access</term>
+        <listitem>
+         <para>
+          One line log messages similar to <literal>access</literal> but
+          with the authenticated user on each log line.
+         </para>
+        </listitem>
+       </varlistentry>
        <varlistentry><term>request-apdu</term>
         <listitem>
          <para>
      <listitem><para>
        IP address of origin (peer)
       </para>
+      <para>
+       If category <literal>user-acesss</literal> is used the
+       user is written on position 3 and the IP is written on position 4.
+      </para>
      </listitem>
     </varlistentry>
 
index 40791ca..a184c77 100644 (file)
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<!-- $Id: config0.xml,v 1.4 2006-11-29 13:00:54 marc Exp $ -->
+<!-- $Id: config0.xml,v 1.5 2007-05-22 19:45:58 adam Exp $ -->
 <metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0">
   <start route="start"/>
   <filters>
@@ -10,7 +10,8 @@
   <routes>  
     <route id="start">
       <filter refid="frontend"/>
-      <filter type="log"/>
+      <filter type="log"><category user-access="true"/></filter>
+      <filter type="backend_test"/>
       <filter type="bounce"/>
     </route>
   </routes>
index bc22583..46e993f 100644 (file)
@@ -1,4 +1,4 @@
-/* $Id: filter_log.cpp,v 1.30 2007-05-22 13:03:32 adam Exp $
+/* $Id: filter_log.cpp,v 1.31 2007-05-22 19:45:58 adam Exp $
    Copyright (c) 2005-2007, Index Data.
 
 This file is part of Metaproxy.
@@ -43,7 +43,6 @@ namespace yf = metaproxy_1::filter;
 
 namespace metaproxy_1 {
     namespace filter {
-
         class Log::Impl {
         public:
             class LFile;
@@ -52,7 +51,7 @@ namespace metaproxy_1 {
             //Impl();
             Impl(const std::string &x = "-");
            ~Impl();
-            void process(metaproxy_1::Package & package) const;
+            void process(metaproxy_1::Package & package);
             void configure(const xmlNode * ptr);
         private:
             void openfile(const std::string &fname);
@@ -64,6 +63,7 @@ namespace metaproxy_1 {
         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;
@@ -74,6 +74,9 @@ namespace metaproxy_1 {
             // for performance avoid opening files which other log filter 
             // instances already have opened
             static std::list<LFilePtr> filter_log_files;
+
+            boost::mutex m_session_mutex;
+            std::map<mp::Session, std::string> m_sessions;
        };
 
         class Log::Impl::LFile {
@@ -134,6 +137,7 @@ std::list<yf::Log::Impl::LFilePtr> yf::Log::Impl::filter_log_files;
 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),
@@ -167,10 +171,10 @@ void yf::Log::Impl::configure(const xmlNode *ptr)
             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);
+                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"))
@@ -214,24 +218,51 @@ void yf::Log::Impl::configure(const xmlNode *ptr)
     }
 }
 
-void yf::Log::Impl::process(mp::Package &package) const
+void yf::Log::Impl::process(mp::Package &package)
 {
-    Z_GDU *gdu;
+    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 
+    // scope for session lock
+    {
+        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)
         {
-            gdu = package.request().get();
             if (gdu)          
             {
                 m_file->out
@@ -246,6 +277,22 @@ void yf::Log::Impl::process(mp::Package &package) const
             }
         }
 
+        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;
@@ -257,7 +304,6 @@ void yf::Log::Impl::process(mp::Package &package) const
 
         if (m_init_options)
         {
-            gdu = package.request().get();
             if (gdu && gdu->which == Z_GDU_Z3950 &&
                 gdu->u.z3950->which == Z_APDU_initRequest)
             {
@@ -271,7 +317,6 @@ void yf::Log::Impl::process(mp::Package &package) const
         
         if (m_req_apdu)
         {
-            gdu = package.request().get();
             if (gdu)
             {
                 mp::odr odr(ODR_PRINT);
@@ -285,6 +330,8 @@ void yf::Log::Impl::process(mp::Package &package) const
     // 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();
@@ -297,7 +344,6 @@ void yf::Log::Impl::process(mp::Package &package) const
 
         if (m_access)
         {
-            gdu = package.response().get();
             if (gdu)
             {
                 m_file->out
@@ -311,6 +357,21 @@ void yf::Log::Impl::process(mp::Package &package) const
                     << "\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)
         {
@@ -324,7 +385,6 @@ void yf::Log::Impl::process(mp::Package &package) const
 
         if (m_init_options)
         {
-            gdu = package.response().get();
             if (gdu && gdu->which == Z_GDU_Z3950 &&
                 gdu->u.z3950->which == Z_APDU_initResponse)
             {
@@ -338,7 +398,6 @@ void yf::Log::Impl::process(mp::Package &package) const
         
         if (m_res_apdu)
         {
-            gdu = package.response().get();
             if (gdu)
             {
                 mp::odr odr(ODR_PRINT);
@@ -346,7 +405,6 @@ void yf::Log::Impl::process(mp::Package &package) const
                 z_GDU(odr, &gdu, 0, 0);
             }
         }
-        
         m_file->out.flush();
     }
 }