Changeset 620

Timestamp:

05/03/07 14:29:56 (2 years ago)

Author:

sacha

Message:

Added ebXML Message Tracker

Ticket #100

This changeset adds:

o user ebXML Message Tracker code to command center
o Berkeley XML Database support
o installation script to download, compile and install the Berkeley XML Database

Files:

• trunk/bin/make-install-c.sh (modified) (3 diffs)
• trunk/bin/run-command-center.rb (modified) (5 diffs)
• trunk/defaults/hefeweizen-defaults (modified) (1 diff)
• trunk/src/hefeweizen_library_xmldb.rb (added)

trunk/bin/make-install-c.sh

@@ -30 +30 @@
-##############################################################################
-
+##############################################################################
+# This script is used to compile and install any C code for the target system.
+#
+# Currently there are two main users of this:
+#
+# o the XML encryption and XML digital signature taskers
+# o the Berkeley XML Database
+#
+##############################################################################
+
+
-# Installation script
-SRC_DIR=..
@@ -52 +63 @@
-}
-
+DBXML_SOURCE_PATH=/usr/local/src
+DBXML_BIN_PATH=install/bin
+DBXML_URL=http://download-uk.oracle.com/berkeley-db/dbxml-2.3.10.tar.gz
+DBXML_PATH=dbxml-2.3.10
+
+check_installed_dbxml()
+{
+    which dbxml 1>/dev/null
+    if [ $? -eq 0 ]; then
+        echo "dbxml binary is available. good."
+        return 0
+    else
+        echo "The dbxml binary (Berkeley XML Database) is not available."
+        if [ -d $DBXML_SOURCE_PATH/$DBXML_PATH ]; then
+            if [ -e $DBXML_SOURCE_PATH/$DBXML_PATH/$DBXML_TEST_PATH/dbxml ]; then
+                echo "The dbXML binary is installed in $DBXML_SOURCE_PATH/$DBXML_PATH/$DBXML_TEST_PATH/. That is good."
+                return 0
+            else
+                return -1
+            fi
+            return 0
+        else
+            return -1
+        fi
+    fi
+    
+}
+
+blah()
+{
-check_installed_package gcc
-check_installed_package libgmime-2.0-2
@@ -60 +101 @@
-check_installed_package libxmlsec1-dev
-check_installed_package libxmlsec1-openssl
+}
+
+install_berkeley_xml_database()
+{
+    apt-get update
+    apt-get install -y binutils gcc g++ flex make
+
+    current=$(pwd)
+    cd $DBXML_SOURCE_PATH
+    echo "Downloading Berekely XML Database"
+    wget DBXML_URL
+#    cp $current/../xml-db/dbxml-2.3.10.tar.gz .
+    tar xvfz dbxml-2.3.10.tar.gz
+    cd $DBXML_PATH
+    echo "Continue building ? The compilation will take about 20 minutes (Core 2 Duo with 2GB Ram reference machine)."
+    read blah
+    sh buildall.sh
+    cd $current
+}
+
+check_installed_dbxml
+if [ $? -eq 0 ]; then
+    echo "Berkeley XML Database is installed."
+else
+    echo "Berkeley XML Database is not installed."
+    install_berkeley_xml_database
+fi
+
+exit
+
-
-WD=$(pwd)

trunk/bin/run-command-center.rb

@@ -34 +34 @@
-require 'logger'
-require 'fileutils'
+require 'rubygems'
+require 'xmlsimple'
+
-config_file = "../defaults/hefeweizen-defaults"
-
@@ -176 +179 @@
-end
-
+####################################################################################
+####################################################################################
+
+def message_tracker config
+  puts "                       HefeWeizen Message Tracker                   :: #{Time.now}"
+  puts "--------------------------------------------------------------------------------------------"
+  puts "                       PARTY  :: #{config['party_name']}"
+  
+  puts "B - Back to Menu"
+  if FileTest.exists? config['xmldb_location'] then
+    puts "D - Delete XML Database                  U - Update XML Database of ebXML Messages."
+    puts ""
+    puts "# - Number of ebXML messages (unfiltered -> total)"
+    puts "A - All ebXML message ids of this party (filtered)"
+    puts "E - All ebXML messages that failed to be processed"
+    #    puts "L   Last messages L 5M -> last 5 minutes; L5D -> last 5 days"
+    puts "M <id> - Show details of message with id x"
+    puts "C <id> - Show all messages with conversatio id x"
+    puts "F - View Filter                          FF - Edit Filter                R - Run Filter"
+    #    puts "XML - Direct XML database access"
+  else
+    puts ""
+    puts "NO XML Database of ebXML Messages exists."
+    puts ""
+    puts "N - Create XML Database"
+  end
+  puts ""
+  puts "--------------------------------------------------------------------------------------------"
+  if !config['previous'].nil? then
+    puts "previous selection '#{config['previous']}'"
+    if !config['output'].nil? then
+      puts config['output']
+    end
+  end
+  
+end 
+
+def x string, length
+  length = length * -1 if length < 0
+  if string.first.to_s.size > length then
+    return string.first[0..(length-2)] + "."
+  end
+  return string.first
+end
+
+def render_content content, elements
+  out  = ""
+
+  width = OpenStruct.new( { 'show_id' => 7, 'message_id' => 45, 'from' => 15, 
+                            'to' => 15, 'service' => 35, 'action' => 20, 'timestamp' => 20, 'cpaid' => 15,
+                            'conversation_id' => 25
+                          } )
+  
+  all = []
+  elements.each{ | element |
+    if width.send(element) then
+      all << (width.send element)
+    else
+      puts "Element '#{element}' not yet declared with a width."
+      all << 7
+      width.send "#{element}=", 7
+    end
+  }
+
+  total_string_length = all.inject(1){|total, i| total + i}+(all.size-1)
+  out += "-" * total_string_length + "\n"
+  format = ""
+  # + 1 because we add a short key (index) for the enduser
+  ((elements.size)+1).times{ | time |
+    time += 1
+    first = time + (time -1)
+    second = first + 1
+    format += "%#{first}$*#{second}$s "
+  }
+  format += "\n"
+  
+  elements_and_size  = [ 'show', -7]
+  elements.each{ | ele |
+    size = (-(width.send ele)) rescue 7
+    elements_and_size << ele
+    size = size * -1 if size > 0
+    elements_and_size << size
+  }
+  
+  out += "-"*total_string_length + "\n"
+  out += sprintf( format, *elements_and_size )
+  
+  message = XmlSimple.xml_in content
+  if message['messages'] then
+    ids = File.new "/tmp/message_ids", "w"
+    counter = 1
+    
+    # popping show and show size
+    dud = elements_and_size.reverse
+    dud.pop; dud.pop
+    elements_and_size = dud.reverse
+    
+    # pp message['messages']
+
+    message['messages'].each{ | message |
+      
+      content_output = Array.new
+      content_output << "D #{counter}"
+      content_output << -5
+
+      ids << ( (message['message_id'].first.to_s) +"\n")
+      
+      value = size = nil
+      elements_and_size.each_index{ | index |
+        xml_element = elements_and_size[index]
+        if index % 2 == 0 then
+          # even
+          value = (message[xml_element]) 
+        else
+          # odd
+          content_output << (x(value, xml_element))
+          xml_element = xml_element * -1 if xml_element > 0
+          content_output << xml_element
+          value = size = nil
+        end
+      }
+      counter += 1
+      out += sprintf( format , *content_output )
+      
+    }
+    ids.close
+  else
+    out += "No messages found.\n"
+  end
+  return out
+end
+
+def render_filter filter = nil
+  out = ""
+  out += "\n"
+  out += sprintf("%1$*2$s %3$*4$s\n", "Filter name:", -35, filter['name'], -40)
+  out += sprintf("%1$*2$s %3$*4$s\n", "Elements displayed:", -35, filter['elements'].join(", "), -40)
+  out += sprintf("%1$*2$s %3$*4$s\n", "Sorting done by:   ", -35, filter['sort'], -40)
+  out += "Conditions: (they are all AND filters)\n"
+  filter['conditions'].each_pair{ | key, value |
+    out += sprintf("   %1$*2$s %3$*4$s\n", "Filter for key #{key}: ", -35, value.to_s, -20)
+  }
+  return out
+end
+
+def edit_filter_menu filter
+  out = ""
+  out += "Current filter: " + render_filter( filter )
+  out += "\n"
+  out += "Change filter:\n"
+#  out += "L Load a stored filter\n"
+#  out += "S Save this filter\n"
+#  out += "1 Edit elements to display\n"
+  out += "O Edit sorting\n"
+  out += "F Edit 'from' condition\n"
+  out += "T Edit 'to' condition\n"
+  out += "S Edit 'service' condition\n"
+  out += "A Edit 'action' condition\n"
+#  out += "D1 Edit 'starting date' condition\n"
+#  out += "D2 Edit 'ending date' condition\n"
+  out += "C Edit 'CPA Id' condition\n"
+  out += "X Back"
+  out  
+end
+
+def edit_filter filter = nil
+  system "clear"
+  puts edit_filter_menu filter
+  while true do
+    input = gets.chomp
+    case input.upcase
+    when "LOAD"
+      output = "Choice: L\n"
+      output += "Not implemented.\n"
+    when "SAVE"
+      output = "Choice: S\n"
+      output += "Not implemented.\n"
+    when "1" # elements to edit
+    when "O" # sort
+      puts "Enter name of element to sort:"
+      input = gets.chomp
+      puts "Your choice:  #{input}\n"
+      filter['sort'] = input.empty? ? nil : [ input ]
+    when "F" # from 
+      puts "Enter the sendings party's name:"
+      input = gets.chomp
+      puts "Your choice:  #{input}\n"
+      filter['conditions']['from'] = input.empty? ? nil : [ input ]
+    when "T" # to
+      puts "Enter the receiving party's name:"
+      input = gets.chomp
+      puts "Your choice:  #{input}\n"
+      filter['conditions']['to'] = input.empty? ? nil : [ input ]
+    when "S" # service
+      puts "Enter the service of the ebXML message:"
+      puts "Helpful service (ebMS): urn:oasis:names:tc:ebxml-msg:service"
+      input = gets.chomp
+      puts "Your choice:  #{input}\n"
+      filter['conditions']['service'] = input.empty? ? nil : [ input ]
+    when "A" # action
+      puts "Enter the action of the ebXML message:"
+      puts "Helpful actions: #{["MessageError", "Ping", "Pong", "StatusRequest", "StatusResponse", "Acknowledgment"].join(", ")}"
+      input = gets.chomp
+      puts "Your choice:  #{input}\n"
+      filter['conditions']['action'] = input.empty? ? nil : [ input ]
+    when "D1" # starting date
+    when "D2" # ending date
+    when "C" # cpa id
+      puts "Enter the CPA id to search for:"
+      input = gets.chomp
+      puts "Your choice:  #{input}\n"
+      filter['conditions']['cpaid'] = input.empty? ? nil : [ input ]
+    when "X" # go back
+      return filter, "Filter edited."
+    end
+    system "clear"
+    puts edit_filter_menu filter
+    puts output
+  end
+    
+end
+
+def work_message_tracker party_name
+#  require "#{@config['LIB_DIR']}/hefeweizen_library_xmldb"
+  require "../src/hefeweizen_library_xmldb"
+#  require "#{@config['LIB_DIR']}/hefeweizen_library_message_state"
+  require "../src/hefeweizen_library_message_state"
+
+  party_location = "#{@config['MESSAGE_DIR']}/#{party_name}/"
+  db_location = "#{party_location}/#{party_name}_ebMS.xmldb"
+  bin_dir = @config['BDXML_BIN_DIR']
+  party_id = party_name
+  xmldb = HefeWeizen::HefeWeizenLibrary::BerkeleyDBXMLHelper.new @config, party_id, party_location, db_location, bin_dir
+  config = { 
+    'party_name' => party_name, 
+    'previous' => nil, 
+    'output' => nil,
+    'xmldb_location' => db_location
+  }
+
+  system "clear"
+  message_tracker config
+
+  elements = ['message_id', 'timestamp', 'service', 'from', 'to', 'action', 'cpaid']
+  filter = { 
+    'name' => "Default Filter",
+    'elements' => elements,
+    'conditions' => {
+      'from' => ['gnaraloo'],
+      'to' => nil,
+      'service' => nil,
+      'action' => nil,
+      'date_from' => nil,
+      'date_to' => nil,
+      'cpaid' => nil,
+      'conversation_id' => nil
+    },
+    'sort' => 'timestamp'
+  }
+  
+  while true do
+    config = { 
+      'party_name' => party_name, 
+      'output' => nil,
+      'xmldb_location' => db_location,
+      'filter' => nil
+    }
+
+
+    input = gets.chomp
+    case input.upcase
+    when "R"
+      config['output'] = "Run filter.\n"
+      the_condition = Hash.new
+      filter['conditions'].each{ | key, value |
+
+        # puts "#{key}: #{value.class.to_s}"
+        
+        if not(value.nil? or value.empty?) then
+          the_condition[key] = [ '=', value.first ]
+        end
+      }
+
+      sorting = nil
+      if filter['sort'].class == Array then
+        sorting = filter['sort'].first
+      elsif filter['sort'].nil? then
+        sorting = nil
+      else
+        sorting = filter['sort']
+      end
+
+      the_condition = nil if the_condition.size == 0
+      content = xmldb.all_ebXML_message_ids( { :format => "xml", :sort => sorting,
+                                               :elements => filter['elements'], 
+                                               :condition => the_condition, 
+                                             } )
+      config['output'] += render_content content, filter['elements']
+    when "F"
+      config['output'] = "Viewing filter.\n"
+      config['output'] += render_filter filter
+    when "FF"
+      config['output'] = "Edit filter.\n"
+      filter, config['output'] = edit_filter filter
+    when "XML"
+#      command = "cd #{db_location} && #{bin_dir} && cd -"
+#      system command
+    when "B"
+      return
+    when "N"
+      config['output'] = "Creating new xml database for Party '#{party_name}'.\n"
+      config['output'] += xmldb.create_new_ebMS_db
+    when "D"
+      if FileTest.exists? db_location then
+        FileUtils.rm db_location 
+        config['output'] = "Removed XML database for Party '#{party_name}'.\n"
+      else
+        config['output'] = "There is no XML database for Party '#{party_name}'.\n"
+      end
+      config['xmldb'] = FileTest.exists? db_location
+    when "U"
+      config['output'] = "Updating xml database for Party '#{party_name}'.\n"
+      config['output'] += xmldb.update_xml_database
+    when "E"
+      ################################
+      ## Is this working???
+      ################################
+      config['output'] = "All messages that failed to be processed.\n"
+      ebMSStateMgr = HefeWeizen::HefeWeizenLibrary::HefeWeizenMessageStateManager.new @config, "#{party_name}"
+      result = ebMSStateMgr.get_failed_messages_information
+      config['output'] += sprintf("%1$*2$s %3$*4$s\n", "Number of failed user messages: ", -35, result['number_failed_user_messages'].to_s, -20)
+      config['output'] += sprintf("%1$*2$s %3$*4$s\n", "Number of failed signals: ", -35, result['number_failed_signal_messages'].to_s, -20)
+      content = "<messages>"
+      result['signal_failed_ids'].each{| id |
+        content += "<message>"
+        content += "<message_id>#{id}</message_id>"
+        content += "</message>"
+      }
+      content += "</messages>"
+      puts content
+      elements = ['message_id']
+      config['output'] += render_content content, elements
+
+      content = "<messages>"
+      result['user_failed_ids'].each{| id |
+        content += "<messages>"
+        content += "<message_id>#{id}</message_id>"
+        content += "</messages>"
+      }
+      content += "</messages>"
+      puts content
+      elements = ['message_id']
+      config['output'] += render_content content, elements
+    when "A"
+      config['output'] = "All messages found with filter.\n"
+      # last day
+      diff = Time.now.to_f - 24*60*60*1
+      new_time = Time.at diff
+      new_time = new_time.strftime('%Y-%m-%dT%H:%M:%SZ')
+      
+      # + add paginate
+      # :exclude => { 'service' => ['urn:oasis:names:tc:ebxml-msg:service'], 'action' => 'send_a_message_4'}, 
+      # :condition => { 'timestamp' => [ '>=', new_time ] }, 
+      elements = ['message_id', 'timestamp', 'service', 'from', 'to', 'action', 'cpaid']
+      content = xmldb.all_ebXML_message_ids( { :format => "xml", :sort => "timestamp", 
+                                               :elements => elements,
+                                             } )
+      config['output'] += render_content content, elements
+    when "#"
+      config['output'] = "Number of total messages: "
+      config['output'] += xmldb.number_ebXML_messages
+    when "X"
+      exit
+      input = "M ID24db82b8edf911dbb0c500dc10007ca1Coronation"
+    when "Y"
+      input = "I 23971278edf911dba93200dc10007ca1"
+    end
+
+    
+    if input =~ /[Cc] (.*)/ then
+      config['output'] = "All messages with conversation id '#{$1}'\n"
+      elements = ['message_id', 'conversation_id', 'timestamp', 'service', 'from', 'to', 'action', 'cpaid']
+      elements = ['message_id', 'conversation_id', 'service', 'from', 'to', 'action']
+      content = xmldb.all_ebXML_message_ids( { :format => "xml", :sort => "timestamp", 
+                                               :elements => elements, 
+                                               :condition => { 'conversation_id' => [ '=', "#{$1}" ] }, 
+                                             } )
+      config['output'] += render_content content, elements
+    end
+    if input =~ /[Dd] (\d*)/ then
+      config['output'] = "Message detail of message with index '#{$1}'\n"
+      config['output'] += "---------------------------------------------\n"
+      if FileTest.exists? '/tmp/message_ids' then
+        ids = IO.readlines '/tmp/message_ids'
+        puts ids.size.to_s
+        puts $1
+        if $1.to_i > ids.size then
+          config['output'] += "There is no message via shortcut id '#{$1}'.\n"
+        else
+          message_id = ids[$1.to_i-1].strip
+          # puts "#{party_location}/messages/#{message_id}/ebXML_message.ebMS2"
+          begin
+            ebMS = HefeWeizen::HefeWeizenLibrary::EBMessage2.new @config, "#{party_location}/messages/#{message_id}/ebXML_message.ebMS2"
+            config['output'] += ebMS.long_summary
+          rescue Exception => e
+            config['output'] += e.inspect
+            config['output'] += "There is no message with ID '#{message_id}'"
+          end
+        end
+        FileUtils.rm '/tmp/message_ids'
+      else
+        config['output'] += "There is no message index. Please get a list of messages to view the detail of a message or \n"
+        config['output'] += "if you have the message id then use the M option"
+      end
+    end
+    if input =~ /[Mm] (.*)/ then
+      config['output'] = "Message detail of message with id '#{$1}'\n"
+      config['output'] += "---------------------------------------------\n"
+      puts "#{party_location}/messages/#{$1}/ebXML_message.ebMS2"
+      begin
+        ebMS = HefeWeizen::HefeWeizenLibrary::EBMessage2.new @config, "#{party_location}/messages/#{$1}/ebXML_message.ebMS2"
+        config['output'] += ebMS.long_summary
+      rescue Exception => e
+        config['output'] += e.inspect
+        config['output'] += "There is no message with ID '#{$1}'"
+      end
+    end
+ 
+    if input =~ /[Ll] (.*)/ then
+      if $1 =~ /(\d)M/ then
+        # minutes
+      elsif $1 =~ /\dH/ then
+        # hourse
+      end
+    end
+    config['previous'] = input
+    system "clear"
+    message_tracker config
+  end
+
+end
+
+
+####################################################################################
+####################################################################################
+####################################################################################
+
-def directive_dynamic_menu party_name, cpa_id, cpas_command, previous = nil, output = nil, number_directives = 1, payload_size = "small", resend_interval = 0
-  puts "                       HefeWeizen Main Directive Dynamic Menu        :: #{Time.now}"
@@ -185 +635 @@
-  puts "N - number of directives: #{number_directives}   R - Resends (after seconds): #{resend_interval}"
-  puts "K - Show kids          K <Process Id> - Kill process           KA - Kill all kids"
-
+      M Message Tracker
-  puts ""
-  cpas_command.sort.each{ | entry |
@@ -257 +707 @@
-        resend_interval = 0
-      end
+    when "M"
+      work_message_tracker party_name
-    when "L"
-      payload_size = payload_size == "small" ? "large" : "small"
@@ -283 +735 @@
-      children.each{ | pid |
-        Process.kill 9, pid.to_i rescue nil
-
+\n
-      }
-      children = Array.new

trunk/defaults/hefeweizen-defaults

@@ -15 +15 @@
-LIB_DIR=/usr/lib
-BIN_DIR=/usr/sbin
+
+BDXML_BIN_DIR=/usr/local/src/dbxml-2.3.10/install/bin
+
-CONFIG_DIR=/etc/hefeweizen
-LOG_DIR=/home/hefeweizen-env/var/log/hefeweizen