cpee-logging-xes-yaml 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a089999eb754b1261a11e99783f151d3efb591fbe2a9ce0bca20681a80973da
-  data.tar.gz: 12813da31c00bd2b78c279ff8d69c48d280219452b672f0c7c3b4871097e964b
+  metadata.gz: a19c5d03e19a331837aaeb9b5b9a4559cd35e4b6901e0cf20c7b27e54e92baac
+  data.tar.gz: 4ad00098ce2fbf696ac3da8cbce702b1921bded896f1ff2ef9ef6c7dd592d044
 SHA512:
-  metadata.gz: 288fbd3c749913373ee0535e5b029a0bb9df11c076c88ae3f37db6b9f5493d4b0b1fd336d2bbbf6eb35f38bb14c961fdd45249ddb4bc81bb1269cb67bad98801
-  data.tar.gz: 5ff48fd29f8051c298f1b13bbd831a2fbcbb022ff3c56f25dc64a5e65f2d13fd01204e9c8572b17917692b02d8ee4579e6e2fc818bd432c1f2150d282653ada0
+  metadata.gz: 68222f1697c3f53be1623846d9a4269021bca8f1515576a02d69bcc49011869a69d0a9af8721c6f7170b0f5b8feab4448fd03738abbbde122a38b9373169331b
+  data.tar.gz: e0141bb3bfc89156df662003ec327225fc8d9e8f8e73c2d983c3403990626bd1364178ce9cf876a535264491dc105480f9bcb2ba39ec5c8a56cad011df65184d

data/cpee-logging-xes-yaml.gemspec

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

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

@@ -1,16 +1,16 @@
 # 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 General Public License as published by the Free
+# 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 General Public License for
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
 # more details.
 #
-# You should have received a copy of the GNU General Public License along with
+# 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/>.
 
@@ -23,8 +23,6 @@ require 'time'
 
 require_relative 'tools'
 
-matze = 'localhostr:9318'
-
 module CPEE
   module Logging
 
@@ -32,25 +30,112 @@ module CPEE
 
     class Handler < Riddl::Implementation
       def response
-        topic         = @p[1].value
-        event_name    = @p[2].value
-        log_dir       = @a[0]
-        template      = @a[1]
-        notification  = @p[3].value.read
+        opts       = @a[0]
+        type       = @p[0].value
+        topic      = @p[1].value
+        event_name = @p[2].value
+        payload    = @p[3].value.read
+        EM.defer do
+          CPEE::Logging::forward opts, topic, event_name, payload
+        end if type == 'event'
         EM.defer do
-          CPEE::Logging::doc topic, event_name, log_dir, template, notification
+          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.join(__dir__,'logs')
-      opts[:template] ||= File.join(__dir__,'template.xes_yaml')
+      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[:log_dir], opts[:template] if post 'event'
+          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

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

@@ -1,3 +1,21 @@
+<!--
+  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/>.
+-->
+
 <declaration xmlns="http://riddl.org/ns/declaration/1.0" xmlns:xi="http://www.w3.org/2001/XInclude">
   <interface name="events">
     <xi:include href="http://www.riddl.org/ns/common-patterns/notifications-consumer/2.0/consumer.xml"/>
@@ -6,7 +24,6 @@
     <xi:include href="http://www.riddl.org/ns/common-patterns/notifications-producer/2.0/producer.xml"/>
   </interface>
 
-
   <facade>
     <tile>
       <layer name="events">

data/lib/cpee-logging-xes-yaml/template.xes_yaml

@@ -1,7 +1,7 @@
 ---
 log:
   namespaces:
-    stream: https://cpee.org/sensorstream/
+    stream: https://cpee.org/datastream/
     ssn: http://www.w3.org/ns/ssn/
     sosa: http://www.w3.org/ns/sosa/
   xes:
@@ -13,7 +13,7 @@ log:
     id: http://www.xes-standard.org/identity.xesext
     lifecycle: http://www.xes-standard.org/lifecycle.xesext
     cpee: http://cpee.org/cpee.xesext
-    stream: https://cpee.org/sensorstream/sensorstream.xesext
+    stream: https://cpee.org/datastream/datastream.xesext
   global:
     trace:
       concept:name: __INVALID__

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

@@ -1,4 +1,21 @@
+# 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 'weel'
+require 'digest/sha1'
 
 class StreamPoint
   attr_accessor :value, :timestamp, :source, :meta
@@ -47,7 +64,7 @@ class Stream
     @values.each do |e|
       if e.is_a? Stream
         e.source = @source if e.source.nil? && !@source.nil?
-        tp << { 'stream:sensorstream' => e.to_list }
+        tp << { 'stream:datastream' => e.to_list }
       elsif e.is_a? StreamPoint
         e.source = @source if e.source.nil? && !@source.nil?
         tp << { 'stream:point' => e.to_h }
@@ -60,6 +77,22 @@ end
 module CPEE
   module Logging
 
+    def self::notify(opts,topic,event_name,payload)
+      opts[:subscriptions].each do |e,urls|
+        if e == topic + '/' + event_name
+          urls.each do |url|
+            client = Riddl::Client.new(url)
+            client.post [
+              Riddl::Parameter::Simple::new('type','event'),
+              Riddl::Parameter::Simple::new('topic',topic),
+              Riddl::Parameter::Simple::new('event',event_name),
+              Riddl::Parameter::Complex::new('notification','application/json',payload)
+            ]
+          end
+        end
+      end
+    end
+
     def self::val_merge(target,val,tid,tso)
       if val.is_a? Stream
         val.source = tso if val.source.nil?
@@ -89,6 +122,40 @@ module CPEE
         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').each do |c|
+          tid = c.attributes['id'] || 'start'
+          fname = where + '_' + tid + '.anno'
+          nset = if tid == 'start'
+            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.exists?(fname) || (File.exists?(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|
@@ -133,18 +200,32 @@ module CPEE
       end
       f = File.open(where,'r+')
       f.flock(File::LOCK_EX)
-      json = JSON::load(f).merge(values)
+      json = JSON::load(f) || {}
+      json.merge!(values)
       f.rewind
       f.truncate(0)
       f.write(JSON.generate(json))
       f.close
     end
 
-    def self::doc(topic,event_name,log_dir,template,payload)
+    def self::forward(opts,topic,event_name,payload)
+      if topic == 'state' && event_name == 'change'
+        self::notify(opts,topic,event_name,payload)
+      elsif topic == 'state' && event_name == 'change'
+        self::notify(opts,topic,event_name,payload)
+      elsif topic == 'gateway' && event_name == 'join'
+        self::notify(opts,topic,event_name,payload)
+      end
+    end
+
+    def self::doc(opts,topic,event_name,payload)
       notification = JSON.parse(payload)
       instance = notification['instance-uuid']
       return unless instance
 
+      log_dir = opts[:log_dir]
+      template = opts[:template]
+
       instancenr = notification['instance']
       content = notification['content']
       activity = content['activity']
@@ -153,6 +234,17 @@ module CPEE
 
       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 = Marshal.load(Marshal.dump(notification))
+          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'
+          self::notify(opts,'annotation','change',so.to_json)
+        end
       end
 
       if topic == 'dataelements' && event_name == 'change'
@@ -204,9 +296,9 @@ module CPEE
             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)')
-              event['stream:sensorstream'] ||= []
+              event['stream:datastream'] ||= []
               val = CPEE::Logging::extract_sensor(rs,p.find('string(d:extractor_code)'),pid,nil) rescue nil
-              CPEE::Logging::val_merge(event['stream:sensorstream'],val,pid,p.find('string(d:source)'))
+              CPEE::Logging::val_merge(event['stream:datastream'],val,pid,p.find('string(d:source)'))
             end
           end
         end
@@ -225,13 +317,13 @@ module CPEE
               rc = CPEE::Logging::extract_result(receiving)
               doc.find('//d:probe[d:extractor_type="extrinsic"]').each do |p|
                 pid = p.find('string(d:id)')
-                te['stream:sensorstream'] ||= []
+                te['stream:datastream'] ||= []
                 val = CPEE::Logging::extract_sensor(rs,p.find('string(d:extractor_code)'),pid,rc) rescue nil
-                CPEE::Logging::val_merge(te['stream:sensorstream'],val,pid,p.find('string(d:source)'))
+                CPEE::Logging::val_merge(te['stream:datastream'],val,pid,p.find('string(d:source)'))
               end
             end
           end
-          if te['stream:sensorstream']
+          if te['stream:datastream']
             te["cpee:lifecycle:transition"] = "sensor/stream"
             File.open(File.join(log_dir,instance+'.xes.yaml'),'a') do |f|
               f << {'event' => te}.to_yaml

data/lib/cpee-logging-xes-yaml/topics.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/>.
+-->
+
+<topics xmlns='http://riddl.org/ns/common-patterns/notifications-producer/2.0'>
+  <topic id='annotation'>
+    <event>change</event>
+  </topic>
+  <topic id='stream'>
+    <event>extraction</event>
+  </topic>
+  <topic id='gateway'>
+    <event>decide</event>
+    <event>join</event>
+  </topic>
+  <topic id='state'>
+    <event>change</event>
+  </topic>
+  <topic id='task'>
+    <event>instantiation</event>
+  </topic>
+</topics>

data/server/log

@@ -1,4 +1,21 @@
 #!/usr/bin/ruby
+#
+# 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 'cpee-logging-xes-yaml/logging'
 
@@ -13,6 +30,7 @@ Riddl::Server.new(CPEE::Logging::SERVER, options) do
   cross_site_xhr true
 
   @riddl_opts[:log_dir] ||= File.join(__dir__,'logs')
+  @riddl_opts[:subscriptions_dir] ||= File.join(__dir__,'subscriptions')
 
   use CPEE::Logging::implementation(@riddl_opts)
 end.loop!

data/tools/cpee-logging-xes-yaml

@@ -1,4 +1,21 @@
 #!/usr/bin/ruby
+#
+# 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/>.
+
 curpath = __dir__
 require 'rubygems'
 require 'optparse'
@@ -28,22 +45,22 @@ end
 
 def follow(fname,io,copy,deep=0)
   if copy
-    File.write(File.basename(fname,'.xes.yaml') + '.xes.yaml',io.read)
+    File.write(File.basename(fname,'.xes.yaml') + '.xes.shift.yaml',io.read)
     io.rewind
   end
   YAML.load_stream(io) do |e|
     if name = e.dig('log','trace','cpee:name')
-      puts " " * deep + name + " (#{File.basename(fname,'.xes.yaml')}) - #{e.dig('log','trace','concept:name')}"
+      puts " " * deep + name + " (#{File.basename(fname,'.xes.shift.yaml')}) - #{e.dig('log','trace','concept:name')}"
     end
     if e.dig('event','cpee:lifecycle:transition') == 'task/instantiation'
-      base = e.dig('event','data','data_receiver')
+      base = e.dig('event','raw')
       val = base.dig('CPEE-INSTANCE') rescue nil
       if val.nil?
         val = File.basename(base)
       end
       uuid = base.dig('CPEE-INSTANCE-UUID') rescue nil
       if uuid
-        react File.dirname(fname) + "/#{uuid}.xes.yaml",copy,deep + 2
+        react File.dirname(fname) + "/#{uuid}.xes.shift.yaml",copy,deep + 2
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpee-logging-xes-yaml
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Juergen eTM Mangler
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: tools
 cert_chain: []
-date: 2022-11-10 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riddl
@@ -76,6 +76,7 @@ files:
 - lib/cpee-logging-xes-yaml/logging.xml
 - lib/cpee-logging-xes-yaml/template.xes_yaml
 - lib/cpee-logging-xes-yaml/tools.rb
+- lib/cpee-logging-xes-yaml/topics.xml
 - server/log
 - tools/cpee-logging-xes-yaml
 homepage: http://cpee.org/