cpee-logging-xes-yaml 1.4.1 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '093abf131db31464c118276deec2c33110a1eada1249b40451fca9eaeee3c38d'
-  data.tar.gz: 8ba44738e83d6d5487f33026012d9ee813bd4dada97d0e4d4ffeefa0b04494b5
+  metadata.gz: b2f390c43e6c32b2abead85f3ead4fa971dda1cb24226c784a7048024c364d53
+  data.tar.gz: 4a5b8ffceb7522522568a8499d35118942dfb74a4521df7e45ebec646667cd20
 SHA512:
-  metadata.gz: 2b20ebd080a36d9e71ea5e1bf1556d26c2e709fe28e9dd783058111dc4472bd52ecac7562d4e97a1c756a7768e29aec4f7aed4ec9cfeaf1df9e53a40d47e25a8
-  data.tar.gz: 958888e149af9efc14c16429830a3c54db0e97ac681826f08072a0e902ec036ae9369df8ae5b33599a8968f75fa70f774520e53f2e4429b8aca0923e90f65911
+  metadata.gz: 9b472f1e1258dd2c6d88156a088c1e97e79b208bea4b59df1933b5f818443094c19b16c2f6c6f9d4510d785bfb7c9c8bcb1288adcf8f148e3c8ce6d2e10efc06
+  data.tar.gz: b5d446c669f4e2e95323dd3c319d97926dca9690746b852855b5ce90b12c91711a6a63e4f4c4c62a9a6db655a68fde18d9e2c28571b57e17de1796b5078df250

data/cpee-logging-xes-yaml.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name             = "cpee-logging-xes-yaml"
-  s.version          = "1.4.1"
+  s.version          = "1.5.1"
   s.platform         = Gem::Platform::RUBY
   s.license          = "LGPL-3.0-or-later"
   s.summary          = "Logging for the cloud process execution engine (cpee.org)"

data/lib/cpee-logging-xes-yaml/access.xml

@@ -0,0 +1,36 @@
+<!--
+  This file is part of CPEE-LOGGING-XES-YAML.
+
+  CPEE-LOGGING-XES-YAML is free software: you can redistribute it and/or modify
+  it under the terms of the GNU Lesser General Public License as published by the Free
+  Software Foundation, either version 3 of the License, or (at your option) any
+  later version.
+
+  CPEE-LOGGING-XES-YAML 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 Lesser General Public License for
+  more details.
+
+  You should have received a copy of the GNU Lesser General Public License along with
+  CPEE-LOGGING-XES-YAML (file LICENSE in the main directory).  If not, see
+  <http://www.gnu.org/licenses/>.
+-->
+
+<description datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes" xmlns="http://riddl.org/ns/description/1.0" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:doc="http://cpee.org/ns/documentation">
+
+  <message name="yaml">
+    <parameter name="log" mimetype="text/yaml"/>
+  </message>
+  <message name="xml">
+    <parameter name="log" mimetype="application/xml"/>
+  </message>
+
+  <resource>
+    <resource relative="[a-f0-9-]+.xes.yaml">
+      <get out="yaml"/>
+    </resource>
+    <resource relative="[a-f0-9-]+.xes.xml">
+      <get out="xml"/>
+    </resource>
+  </resource>
+</description>

data/lib/cpee-logging-xes-yaml/implementation.rb

@@ -0,0 +1,365 @@
+# This file is part of CPEE-LOGGING-XES-YAML.
+#
+# CPEE-LOGGING-XES-YAML is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# CPEE-LOGGING-XES-YAML 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 Lesser General Public License for
+# more details.
+#
+# You should have received a copy of the GNU Lesser General Public License along with
+# CPEE-LOGGING-XES-YAML (file LICENSE in the main directory).  If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'redis'
+require 'json'
+require 'yaml'
+require 'riddl/server'
+require 'time'
+
+require_relative 'tools'
+
+module CPEE
+  module Logging
+
+    SERVER = File.expand_path(File.join(__dir__,'implementation.xml'))
+
+    TEMPLATE_XES_XML_START = <<-END
+<log xmlns="http://www.xes-standard.org/" xes.version="2.0" xes.features="nested-attributes">
+  <string key="creator" value="cpee.org"/>
+  <extension name="Time" prefix="time" uri="http://www.xes-standard.org/time.xesext"/>
+  <extension name="Concept" prefix="concept" uri="http://www.xes-standard.org/concept.xesext"/>
+  <extension name="ID" prefix="id" uri="http://www.xes-standard.org/identity.xesext"/>
+  <extension name="Lifecycle" prefix="lifecycle" uri="http://www.xes-standard.org/lifecycle.xesext"/>
+  <extension name="CPEE" prefix="cpee" uri="http://cpee.org/cpee.xesext"/>
+  <extension name="stream" prefix="stream" uri="https://cpee.org/datastream/datastream.xesext"/>
+  <global scope="trace">
+    <string key="concept:name" value="__NOTSPECIFIED__"/>
+    <string key="cpee:name" value="__NOTSPECIFIED__"/>
+  </global>
+  <global scope="event">
+    <string key="concept:name" value="__NOTSPECIFIED__"/>
+    <string key="concept:instance" value="-1"/>
+    <string key="concept:endpoint" value="__NOTSPECIFIED__"/>
+    <string key="id:id" value="__NOTSPECIFIED__"/>
+    <string key="lifecycle:transition" value="complete" />
+    <string key="cpee:lifecycle:transition" value="activity/calling"/>
+    <date key="time:timestamp" value="__NOTSPECIFIED__"/>
+  </global>
+    END
+    TEMPLATE_XES_XML_TRC = <<-END
+<trace xmlns="http://www.xes-standard.org/"/>
+    END
+    TEMPLATE_XES_XML_EVT = <<-END
+<event xmlns="http://www.xes-standard.org/"/>
+    END
+    TEMPLATE_XES_XML_MID = <<-END
+  <trace>
+    END
+    TEMPLATE_XES_XML_END = <<-END
+  </trace>
+</log>
+    END
+
+    class HeaderAndFile #{{{
+      def initialize(header, io)
+        @header = header
+        @io = io
+        @position = 0
+      end
+
+      def read(length = nil, outbuf = nil)
+        if @position < @header.bytesize
+          data = read_header(length)
+
+          if length && data.bytesize < length
+            remaining_length = length - data.bytesize
+            file_data = @io.read
+            data << file_data if file_data
+          end
+        else
+          data = @io.read(length)
+        end
+
+        return data.nil? || data.empty? && length ? nil : append_to_outbuf(data, outbuf)
+      end
+
+      def rewind
+        @io&.rewind
+        @position = 0 # returning position is the way rewind does it
+      end
+
+      def close
+        @io&.close
+        @io = nil
+      end
+
+      def read_header(length)
+        chunk = if length
+          @header.byteslice(@position, length)
+        else
+          @header.byteslice(@position..-1)
+        end
+        @position += chunk.bytesize
+        chunk
+      end
+      private :read_header
+
+      def append_to_outbuf(data, outbuf)
+        outbuf ? outbuf.replace(data || '') : data
+      end
+      private :append_to_outbuf
+    end #}}}
+
+    class DownloadYAML < Riddl::Implementation
+      def response
+        opts = @a[0]
+        fname = File.join(opts[:log_dir],@r[-1])
+        if File.exist?(fname)
+          io = File.open fname
+          header = File.read(fname.sub(/yaml$/,'header')) if File.exist?(fname.sub(/yaml$/,'header'))
+          Riddl::Parameter::Complex::new('log','text/yaml',HeaderAndFile.new(header || '',File.open(fname)))
+        else
+          @status = 404
+        end
+      end
+    end
+
+    class DownloadXML < Riddl::Implementation
+      def self::rec_type(it) #{{{
+        if it.is_a?(String) && it =~ /^[\dT:+.-]+$/ && (Time.parse(it) rescue nil)
+          'x:date'
+        elsif it.is_a? Float
+          'x:float'
+        elsif it.is_a? Integer
+          'x:int'
+        elsif it.is_a? String
+          'x:string'
+        end
+      end #}}}
+
+      def self::format_secs(s) #{{{
+        return 'long' if s.infinite?
+        s = s.to_i
+        m = s / 60
+        m < 0 ? "#{s}s" : "#{'%02d' % m}m #{'%02d' % (s%60)}s"
+      end #}}}
+
+      def self::rec_a_insert(event,node,level=0) #{{{
+        event.each do |i|
+          tnode = node
+          case i
+            when Hash
+              tnode = node.add('x:list', 'key' => 'element')
+              self::rec_insert(i,tnode,level+1)
+            when Array
+              tnode = node.add('x:list', 'key' => 'element')
+              self::rec_insert(i,tnode,level+1)
+            when String
+              node.add(rec_type(i), 'key' => 'element', 'value' => (i.empty? ? "__UNSPECIFIED__" : i))
+            when Integer, Float
+              node.add(rec_type(i), 'key' => 'element', 'value' => i)
+          end
+        end
+      end #}}}
+
+      def self::rec_insert(event,node,level=0) #{{{
+        event.each do |k,v|
+          case v
+            when String
+              node.add(rec_type(v), 'key' => k, 'value' => (v.empty? ? "__UNSPECIFIED__" : v))
+            when Integer
+              node.add(rec_type(v), 'key' => k, 'value' => v)
+            when Float
+              node.add(rec_type(v), 'key' => k, 'value' => v)
+            when Array
+              tnode = node.add('x:list', 'key' => k)
+              self::rec_a_insert(v,tnode,level+1)
+            when Hash
+              tnode = node.add('x:list', 'key' => k)
+              self::rec_insert(v,tnode)
+          end
+        end
+      end #}}}
+
+      def response
+        opts = @a[0]
+        fname = File.join(opts[:log_dir],@r[-1]).sub(/xml$/,'yaml')
+        if File.exist?(fname)
+          body = StringIO.new
+
+          body.write(TEMPLATE_XES_XML_START)
+
+          io = File.open(fname)
+          YAML.load_stream(io) do |e|
+            if trace = e.dig('log','trace')
+              xml = XML::Smart.string(TEMPLATE_XES_XML_TRC)
+              xml.register_namespace 'x', 'http://www.xes-standard.org/'
+              trace.each do |t,tv|
+                xml.find('//x:trace').each do |ele|
+                  ele.add('x:string', 'key' => t, 'value' => tv)
+                end
+              end
+              body.write('  ' + xml.root.dump.gsub(/\n/,"\n  ") + "\n")
+              body.write(TEMPLATE_XES_XML_MID)
+            end
+            if e.dig('event')
+              xml = XML::Smart.string(TEMPLATE_XES_XML_EVT)
+              xml.register_namespace 'x', 'http://www.xes-standard.org/'
+              DownloadXML::rec_insert(e.dig('event'),xml.root)
+              body.write('    ' + xml.root.dump.gsub(/\n/,"\n    ") + "\n")
+            end
+          end
+          body.write(TEMPLATE_XES_XML_END)
+          body.rewind
+
+          Riddl::Parameter::Complex::new('log','application/xml',body)
+        else
+          @status = 404
+        end
+      end
+    end
+
+    class Handler < Riddl::Implementation
+      def response
+        opts       = @a[0]
+        type       = @p[0].value
+        topic      = @p[1].value
+        event_name = @p[2].value
+        payload    = @p[3].value.read
+
+        ### we write headers into its own file. If race condition at first, no problemo
+        unless File.exist? File.join(opts[:log_dir],@h['CPEE_INSTANCE_UUID'] + '.xes.header')
+          notification = JSON.parse(payload)
+          log = YAML::load(File.read(opts[:template]))
+          log['log']['trace']['concept:name']                    ||= notification['instance']
+          log['log']['trace']['cpee:name']                       ||= notification['instance-name'] if notification['instance-name']
+          log['log']['trace']['cpee:instance']                   ||= notification['instance-uuid']
+          log['log']['trace']['cpee:parent_instance']            ||= notification.dig('content','attributes','parent_instance').to_i       if notification.dig('content','attributes','parent_instance')
+          log['log']['trace']['cpee:parent_instance_uuid']       ||= notification.dig('content','attributes','parent_instance_uuid')       if notification.dig('content','attributes','parent_instance_uuid')
+          log['log']['trace']['cpee:parent_instance_model']      ||= notification.dig('content','attributes','parent_instance_model')      if notification.dig('content','attributes','parent_instance_model')
+          log['log']['trace']['cpee:parent_instance_task_id']    ||= notification.dig('content','attributes','parent_instance_task_id')    if notification.dig('content','attributes','parent_instance_task_id')
+          log['log']['trace']['cpee:parent_instance_task_label'] ||= notification.dig('content','attributes','parent_instance_task_label') if notification.dig('content','attributes','parent_instance_task_label')
+          File.open(File.join(opts[:log_dir],@h['CPEE_INSTANCE_UUID']+'.xes.header'),'w'){|f| f.puts log.to_yaml}
+        end
+
+        EM.defer do
+          CPEE::Logging::forward opts, topic, event_name, payload
+        end if type == 'event'
+        EM.defer do
+          CPEE::Logging::doc opts, topic, event_name, payload
+        end
+        nil
+      end
+    end
+
+    class Overview < Riddl::Implementation #{{{
+      def response
+        Riddl::Parameter::Complex.new('overview','text/xml') do
+          <<-END
+            <overview xmlns='http://riddl.org/ns/common-patterns/notifications-producer/2.0'>
+              <topics/>
+              <subscriptions/>
+            </overview>
+          END
+        end
+      end
+    end #}}}
+
+    class Topics < Riddl::Implementation #{{{
+      def response
+        opts = @a[0]
+        Riddl::Parameter::Complex.new('overview','text/xml') do
+          File.read(opts[:topics])
+        end
+      end
+    end #}}}
+
+    class Subscriptions < Riddl::Implementation #{{{
+      def response
+        opts = @a[0]
+        Riddl::Parameter::Complex.new('subscriptions','text/xml') do
+          ret = XML::Smart::string <<-END
+            <subscriptions xmlns='http://riddl.org/ns/common-patterns/notifications-producer/2.0'/>
+          END
+          Dir.glob(File.join(opts[:notifications_dir],'*','subscription.xml')).each do |f|
+            ret.root.add('subscription').tap do |n|
+              n.attributes['id'] = File.basename(File.dirname(f))
+              XML::Smart.open_unprotected(f) do |doc|
+                n.attributes['url'] =  doc.root.attributes['url']
+              end
+            end
+          end
+          ret.to_s
+        end
+      end
+    end #}}}
+
+    class Subscription < Riddl::Implementation #{{{
+      def response
+        opts = @a[0]
+        id = @r[-1]
+        doc = XML::Smart::open_unprotected(File.join(opts[:notifications_dir],id,'subscription.xml'))
+        doc.root.attributes['id'] = id
+        Riddl::Parameter::Complex.new('subscriptions','text/xml',doc.to_s)
+      end
+    end #}}}
+
+    def self::implementation(opts)
+      opts[:log_dir]           ||= File.expand_path(File.join(__dir__,'logs'))
+      opts[:notifications_dir] ||= File.expand_path(File.join(__dir__,'notifications'))
+      opts[:template]          ||= File.expand_path(File.join(__dir__,'template.xes_yaml'))
+      opts[:topics]            ||= File.expand_path(File.join(__dir__,'topics.xml'))
+      opts[:subscriptions]     =  {}
+
+      opts[:sse_keepalive_frequency]    ||= 10
+
+      Dir.glob(File.join(opts[:notifications_dir],'*','subscription.xml')).each do |f|
+        XML::Smart::open_unprotected(f) do |doc|
+          doc.register_namespace :p, 'http://riddl.org/ns/common-patterns/notifications-producer/2.0'
+          doc.find('/p:subscription/p:topic').each do |t|
+            t.find('p:event').each do |e|
+              opts[:subscriptions][t.attributes['id']+'/'+e.text] ||= []
+              opts[:subscriptions][t.attributes['id']+'/'+e.text] << doc.root.attributes['url']
+            end
+          end
+        end
+      end
+
+      Proc.new do
+        interface 'access' do
+          on resource '[a-f0-9-]+.xes.yaml' do
+            run DownloadYAML, opts if get
+          end
+          on resource '[a-f0-9-]+.xes.xml' do
+            run DownloadXML, opts if get
+          end
+        end
+        interface 'events' do
+          run Handler, opts if post 'event'
+        end
+        interface 'notifications' do
+          on resource 'notifications' do
+            run Overview if get
+            on resource 'topics' do
+              run Topics, opts if get
+            end
+            on resource 'subscriptions' do
+              run Subscriptions, opts if get
+              run CreateSubscription, opts if post 'create_subscription'
+              on resource do
+                run Subscription, opts if get
+                run UpdateSubscription, opts if put 'change_subscription'
+                run DeleteSubscription, opts if delete
+              end
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/cpee-logging-xes-yaml/{logging.xml → implementation.xml}

@@ -23,9 +23,15 @@
   <interface name="notifications">
     <xi:include href="http://www.riddl.org/ns/common-patterns/notifications-producer/2.0/producer.xml"/>
   </interface>
+  <interface name="access">
+    <xi:include href="access.xml"/>
+  </interface>
 
   <facade>
     <tile>
+      <layer name="access">
+        <apply-to>/logs</apply-to>
+      </layer>
       <layer name="events">
         <apply-to>/</apply-to>
       </layer>

data/lib/cpee-logging-xes-yaml/tools.rb

@@ -114,53 +114,6 @@ module CPEE
       end
     end
 
-    def self::extract_probes(where,xml)
-      XML::Smart::string(xml) do |doc|
-        doc.register_namespace 'd', 'http://cpee.org/ns/description/1.0'
-        doc.find('//d:call | //d:manipulate').each do |c|
-          File.unlink(where + '_' + c.attributes['id'] + '.probe') rescue nil
-          c.find('d:annotations/d:_context_data_analysis/d:probes[d:probe]').each do |p|
-            File.write(where + '_' + c.attributes['id'] + '.probe', p.dump)
-          end
-        end
-      end
-    end
-
-    def self::extract_annotations(where,xml)
-      ret = {}
-      XML::Smart::string(xml) do |doc|
-        doc.register_namespace 'd', 'http://cpee.org/ns/description/1.0'
-        doc.find('/d:description | //d:call | //d:manipulate').each do |c|
-          tid = c.attributes['id'] || 'complex'
-          fname = where + '_' + tid + '.anno'
-          nset = if tid == 'complex'
-            c.find('d:*[starts-with(name(),"_")]')
-          else
-            c.find('d:annotations')
-          end
-          nset.each do |p|
-            anno = p.dump
-            ret[tid] ||= []
-            ret[tid] << anno
-          end
-          if ret[tid]
-            if ret[tid].length > 1
-              ret[tid] = "<annotations xmlns=\"http://cpee.org/ns/description/1.0\">\n" +
-                ret[tid].join("\n") + "\n" +
-                '</annotations>'
-            else
-              ret[tid] = ret[tid][0]
-            end
-            hash = Digest::SHA1.hexdigest(ret[tid])
-            if !File.exist?(fname) || File.read(fname) !=  hash
-              File.write(fname,hash)
-            end
-          end
-        end
-      end
-      ret
-    end
-
     def self::extract_result(result)
       ret = result.map do |res|
         if res['mimetype'].nil?
@@ -198,30 +151,6 @@ module CPEE
       e.backtrace[0].gsub(/(\w+):(\d+):in.*/,'Probe ' + pid + ' Line \2: ') + e.message
     end
 
-    def self::persist_values(where,values)
-      unless File.exist?(where)
-        File.write(where,'{}')
-      end
-      f = File.open(where,'r+')
-      f.flock(File::LOCK_EX)
-      json = JSON::load(f) || {}
-      json.merge!(values)
-      f.rewind
-      f.truncate(0)
-      f.write(JSON.generate(json))
-      f.flock(File::LOCK_UN)
-      f.close
-    end
-    def self::load_values(where)
-      ret = nil
-      File.open(where,'r') do |f|
-        f.flock(File::LOCK_SH)
-        ret = JSON::load(f)
-        f.flock(File::LOCK_UN)
-      end
-      ret
-    end
-
     def self::forward(opts,topic,event_name,payload)
       if topic == 'state' && event_name == 'change'
         self::notify(opts,topic,event_name,payload)
@@ -246,29 +175,6 @@ module CPEE
       parameters = content['parameters']
       receiving = content['received']
 
-      if content['dslx']
-        CPEE::Logging::extract_probes(File.join(log_dir,instance),content['dslx'])
-        CPEE::Logging::extract_annotations(File.join(log_dir,instance),content['dslx']).each do |k,v|
-          so = JSON.parse(notification.to_json)
-          so['content'].delete('dslx')
-          so['content'].delete('dsl')
-          so['content'].delete('description')
-          so['content']['annotation'] = v
-          so['content']['activity'] = k
-          so['topic'] = 'annotation'
-          so['name'] = 'change'
-          EM.defer do
-            self::notify(opts,'annotation','change',so.to_json)
-          end
-        end
-      end
-
-      if topic == 'dataelements' && event_name == 'change'
-        if content['changed']&.any?
-          CPEE::Logging::persist_values(File.join(log_dir,instance + '.data.json'),content['values'])
-        end
-      end
-
       event = {}
       event['concept:instance'] = instancenr
       event['concept:name'] = content['label'] if content['label']
@@ -298,90 +204,79 @@ module CPEE
       unless parameters['arguments']&.nil?
         event['data'] = parameters['arguments']
       end if parameters
-      if content['changed']&.any?
+      if (event_name == 'modify' || event_name == 'change') && content['values']&.any?
         event['data'] = content['values'].map do |k,v|
           { 'name' => k, 'value' => v }
         end
+      end
 
-        fname = File.join(log_dir,instance + '_' + event['id:id'] + '.probe')
-        dname = File.join(log_dir,instance + '.data.json')
+      if topic == 'task' && event_name == 'probe'
+        rs = WEEL::ReadStructure.new(content['data'],{},{},{})
+        rc = CPEE::Logging::extract_result(receiving) if receiving && !receiving.empty?
+        te = event.dup
 
-        # Handle intrinsic data probes
-        if File.exist?(fname)
-          rs = WEEL::ReadStructure.new(File.exist?(dname) ? CPEE::Logging::load_values(dname) : {},{},{},{})
-          XML::Smart::open_unprotected(fname) do |doc|
-            doc.register_namespace 'd', 'http://cpee.org/ns/description/1.0'
-            doc.find('//d:probe[d:extractor_type="intrinsic"]').each do |p|
-              pid    = p.find('string(d:id)')
-              source = p.find('string(d:source)')
-              val = CPEE::Logging::extract_val(rs,p.find('string(d:extractor_code)'),pid,nil) rescue nil
-              # Do not add datastream entries if the dataprobes return nil
-              if val != nil
-                event['stream:datastream'] ||= []
-                CPEE::Logging::merge_val(event['stream:datastream'],val,pid,source)
-              end
+        content['probes'].each do |p|
+
+          if p.dig('probe','extractor_type') == 'intrinsic'
+            pid    = p.dig('probe','id')
+            source = p.dig('probe','source')
+            val = CPEE::Logging::extract_val(rs,p.dig('probe','extractor_code'),pid,nil) rescue nil
+            # Do not add datastream entries if the dataprobes return nil
+            if val != nil
+              event['stream:datastream'] ||= []
+              CPEE::Logging::merge_val(event['stream:datastream'],val,pid,source)
             end
-          end
-          if event['stream:datastream'] && event['stream:datastream'].any?
-            EM.defer do
-              self::notify(
-                opts,
-                'stream',
-                'extraction',
-                notification.merge(
-                  'topic'=>'stream',
-                  'name'=>'extraction',
-                  'datastream'=>event['stream:datastream']
-                ).to_json
-              )
+            if event['stream:datastream'] && event['stream:datastream'].any?
+              EM.defer do
+                self::notify(
+                  opts,
+                  'stream',
+                  'extraction',
+                  notification.merge(
+                    'topic'=>'stream',
+                    'name'=>'extraction',
+                    'datastream'=>event['stream:datastream']
+                  ).to_json
+                )
+              end
             end
           end
-        end
-      end
-      # Handle extrinsic data probes
-      if topic == 'activity' && event_name == 'receiving' && receiving && !receiving.empty?
-        fname = File.join(log_dir,instance + '_' + event['id:id'] + '.probe')
-        dname = File.join(log_dir,instance + '.data.json')
 
-        if File.exist?(fname)
-          te = event.dup
-
-          rs = WEEL::ReadStructure.new(File.exist?(dname) ? CPEE::Logging::load_values(dname) : {},{},{},{})
-          XML::Smart::open_unprotected(fname) do |doc|
-            doc.register_namespace 'd', 'http://cpee.org/ns/description/1.0'
-            if doc.find('//d:probe/d:extractor_type[.="extrinsic"]').any?
-              rc = CPEE::Logging::extract_result(receiving)
-              doc.find('//d:probe[d:extractor_type="extrinsic"]').each do |p|
-                pid = p.find('string(d:id)')
+          if receiving && !receiving.empty?
+            if p.dig('probe','extractor_type') == 'extrinsic'
+              pid    = p.dig('probe','id')
+              source = p.dig('probe','source')
+              val = CPEE::Logging::extract_val(rs,p.dig('probe','extractor_code'),pid,rc) rescue nil
+              # Do not add datastream entries if the dataprobes return nil
+              if val != nil
                 te['stream:datastream'] ||= []
-                val = CPEE::Logging::extract_val(rs,p.find('string(d:extractor_code)'),pid,rc) rescue nil
-                if not val.nil?
-                  # Do not add datastream entries if the dataprobes return nil
-                  CPEE::Logging::merge_val(te['stream:datastream'],val,pid,p.find('string(d:source)'))
+                CPEE::Logging::merge_val(te['stream:datastream'],val,pid,source)
+              end
+              if te['stream:datastream'] && te['stream:datastream'].any?
+                te['cpee:lifecycle:transition'] = 'stream/data'
+                File.open(File.join(log_dir,instance+'.xes.yaml'),'a') do |f|
+                  f << {'event' => te}.to_yaml
+                end
+                EM.defer do
+                  self::notify(
+                    opts,
+                    'stream',
+                    'extraction',
+                    notification.merge(
+                      'topic'=>'stream',
+                      'name'=>'extraction',
+                      'datastream'=>te['stream:datastream']
+                    ).to_json
+                  )
                 end
               end
             end
           end
-          if te['stream:datastream'] && te['stream:datastream'].any?
-            te['cpee:lifecycle:transition'] = 'stream/data'
-            File.open(File.join(log_dir,instance+'.xes.yaml'),'a') do |f|
-              f << {'event' => te}.to_yaml
-            end
-            EM.defer do
-              self::notify(
-                opts,
-                'stream',
-                'extraction',
-                notification.merge(
-                  'topic'=>'stream',
-                  'name'=>'extraction',
-                  'datastream'=>te['stream:datastream']
-                ).to_json
-              )
-            end
-          end
+
         end
+
       end
+
       if receiving && !receiving.empty?
         event['data'] = receiving
       end

data/server/log

@@ -17,7 +17,7 @@
 # <http://www.gnu.org/licenses/>.
 
 require 'rubygems'
-require 'cpee-logging-xes-yaml/logging'
+require 'cpee-logging-xes-yaml/implementation'
 
 options = {
   :host => 'localhost',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpee-logging-xes-yaml
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.1
 platform: ruby
 authors:
 - Juergen eTM Mangler
@@ -105,8 +105,9 @@ files:
 - README.md
 - Rakefile
 - cpee-logging-xes-yaml.gemspec
-- lib/cpee-logging-xes-yaml/logging.rb
-- lib/cpee-logging-xes-yaml/logging.xml
+- lib/cpee-logging-xes-yaml/access.xml
+- lib/cpee-logging-xes-yaml/implementation.rb
+- lib/cpee-logging-xes-yaml/implementation.xml
 - lib/cpee-logging-xes-yaml/template.xes_yaml
 - lib/cpee-logging-xes-yaml/tools.rb
 - lib/cpee-logging-xes-yaml/topics.xml

data/lib/cpee-logging-xes-yaml/logging.rb

@@ -1,160 +0,0 @@
-# This file is part of CPEE-LOGGING-XES-YAML.
-#
-# CPEE-LOGGING-XES-YAML is free software: you can redistribute it and/or modify it
-# under the terms of the GNU Lesser General Public License as published by the Free
-# Software Foundation, either version 3 of the License, or (at your option) any
-# later version.
-#
-# CPEE-LOGGING-XES-YAML 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 Lesser General Public License for
-# more details.
-#
-# You should have received a copy of the GNU Lesser General Public License along with
-# CPEE-LOGGING-XES-YAML (file LICENSE in the main directory).  If not, see
-# <http://www.gnu.org/licenses/>.
-
-require 'rubygems'
-require 'redis'
-require 'json'
-require 'yaml'
-require 'riddl/server'
-require 'time'
-
-require_relative 'tools'
-
-module CPEE
-  module Logging
-
-    SERVER = File.expand_path(File.join(__dir__,'logging.xml'))
-
-    class Handler < Riddl::Implementation
-      def response
-        opts       = @a[0]
-        type       = @p[0].value
-        topic      = @p[1].value
-        event_name = @p[2].value
-        payload    = @p[3].value.read
-
-        ### we do not write headers for now. Or else we can only do per instance sharding.
-        # unless File.exist? File.join(opts[:log_dir],@h['CPEE_INSTANCE_UUID'] + '.xes.yaml')
-        #   notification = JSON.parse(payload)
-        #   log = YAML::load(File.read(opts[:template]))
-        #   log['log']['trace']['concept:name']                    ||= notification['instance']
-        #   log['log']['trace']['cpee:name']                       ||= notification['instance-name'] if notification['instance-name']
-        #   log['log']['trace']['cpee:instance']                   ||= notification['instance-uuid']
-        #   log['log']['trace']['cpee:parent_instance']            ||= notification.dig('content','attributes','parent_instance').to_i       if notification.dig('content','attributes','parent_instance')
-        #   log['log']['trace']['cpee:parent_instance_uuid']       ||= notification.dig('content','attributes','parent_instance_uuid')       if notification.dig('content','attributes','parent_instance_uuid')
-        #   log['log']['trace']['cpee:parent_instance_model']      ||= notification.dig('content','attributes','parent_instance_model')      if notification.dig('content','attributes','parent_instance_model')
-        #   log['log']['trace']['cpee:parent_instance_task_id']    ||= notification.dig('content','attributes','parent_instance_task_id')    if notification.dig('content','attributes','parent_instance_task_id')
-        #   log['log']['trace']['cpee:parent_instance_task_label'] ||= notification.dig('content','attributes','parent_instance_task_label') if notification.dig('content','attributes','parent_instance_task_label')
-        #   File.open(File.join(opts[:log_dir],@h['CPEE_INSTANCE_UUID']+'.xes.yaml'),'w'){|f| f.puts log.to_yaml}
-        # end
-
-        EM.defer do
-          CPEE::Logging::forward opts, topic, event_name, payload
-        end if type == 'event'
-        EM.defer do
-          CPEE::Logging::doc opts, topic, event_name, payload
-        end
-        nil
-      end
-    end
-
-    class Overview < Riddl::Implementation #{{{
-      def response
-        Riddl::Parameter::Complex.new('overview','text/xml') do
-          <<-END
-            <overview xmlns='http://riddl.org/ns/common-patterns/notifications-producer/2.0'>
-              <topics/>
-              <subscriptions/>
-            </overview>
-          END
-        end
-      end
-    end #}}}
-
-    class Topics < Riddl::Implementation #{{{
-      def response
-        opts = @a[0]
-        Riddl::Parameter::Complex.new("overview","text/xml") do
-          File.read(opts[:topics])
-        end
-      end
-    end #}}}
-
-    class Subscriptions < Riddl::Implementation #{{{
-      def response
-        opts = @a[0]
-        Riddl::Parameter::Complex.new("subscriptions","text/xml") do
-          ret = XML::Smart::string <<-END
-            <subscriptions xmlns='http://riddl.org/ns/common-patterns/notifications-producer/2.0'/>
-          END
-          Dir.glob(File.join(opts[:notifications_dir],'*','subscription.xml')).each do |f|
-            ret.root.add('subscription').tap do |n|
-              n.attributes['id'] = File.basename(File.dirname(f))
-              XML::Smart.open_unprotected(f) do |doc|
-                n.attributes['url'] =  doc.root.attributes['url']
-              end
-            end
-          end
-          ret.to_s
-        end
-      end
-    end #}}}
-
-    class Subscription < Riddl::Implementation #{{{
-      def response
-        opts = @a[0]
-        id = @r[-1]
-        doc = XML::Smart::open_unprotected(File.join(opts[:notifications_dir],id,'subscription.xml'))
-        doc.root.attributes['id'] = id
-        Riddl::Parameter::Complex.new("subscriptions","text/xml",doc.to_s)
-      end
-    end #}}}
-
-    def self::implementation(opts)
-      opts[:log_dir]           ||= File.expand_path(File.join(__dir__,'logs'))
-      opts[:notifications_dir] ||= File.expand_path(File.join(__dir__,'notifications'))
-      opts[:template]          ||= File.expand_path(File.join(__dir__,'template.xes_yaml'))
-      opts[:topics]            ||= File.expand_path(File.join(__dir__,'topics.xml'))
-      opts[:subscriptions]     =  {}
-
-      Dir.glob(File.join(opts[:notifications_dir],'*','subscription.xml')).each do |f|
-        XML::Smart::open_unprotected(f) do |doc|
-          doc.register_namespace :p, 'http://riddl.org/ns/common-patterns/notifications-producer/2.0'
-          doc.find('/p:subscription/p:topic').each do |t|
-            t.find('p:event').each do |e|
-              opts[:subscriptions][t.attributes['id']+'/'+e.text] ||= []
-              opts[:subscriptions][t.attributes['id']+'/'+e.text] << doc.root.attributes['url']
-            end
-          end
-        end
-      end
-
-      Proc.new do
-        interface 'events' do
-          run Handler, opts if post 'event'
-        end
-        interface 'notifications' do
-          on resource "notifications" do
-            run Overview if get
-            on resource "topics" do
-              run Topics, opts if get
-            end
-            on resource "subscriptions" do
-              run Subscriptions, opts if get
-              run CreateSubscription, opts if post 'create_subscription'
-              on resource do
-                run Subscription, opts if get
-                run UpdateSubscription, opts if put 'change_subscription'
-                run DeleteSubscription, opts if delete
-              end
-            end
-          end
-        end
-      end
-    end
-
-  end
-end