cpee 1.5.26 → 2.0.3

data/server/resources/backend/README.md

@@ -0,0 +1,17 @@
+* run is copied into every instance.
+* opts.yaml is written on each start.
+* instance.rb is written on each start.
+
+## What can you do to make it more robust?
+
+Replace run with a program that actually compiles and runs instance.rb.  Of
+courses the transformation_* xslts would have to be adapted to create suitable
+code. The compiled executable would just need to behave the same as the instance.rb,
+dispersing all the same events through redis.
+
+More suitable languages would be crystal and javascript, c++. Less suitable,
+but doable, would be python, C. I.e., all languages that do not support multi-line
+lambdas would produce much less readable code, thus the "Description" tab in
+the cockpit would be garbage.
+
+Definitely do tell me if you are interessted in doing something like this ;-)

data/server/resources/backend/instance.rb

@@ -0,0 +1,23 @@
+class Instance < WEEL
+  handlerwrapper DefaultHandlerWrapper
+
+  endpoint :timeout => "http://gruppe.wst.univie.ac.at/~mangler/services/timeout.php"
+  data :x => ''
+  # search Position.new(:a1,:after,nil)
+
+  control flow do
+    call :a1, :timeout, parameters: { :label => "Step 1", :method => :post, :arguments => [⭐(:name => :timeout, :value => ->{ "2" })] }, finalize: <<-END
+      p 'xxx1'
+			data.x += \"a1,\"
+		END
+		call :a2, :timeout, parameters: { :label => "Step 2", :method => :post, :arguments => [⭐(:name => :timeout, :value => ->{ "4" })] }, finalize: <<-END
+      p 'xxx2'
+			data.x += \"a2,\"
+		END
+		call :a3, :timeout, parameters: { :label => "Step 3", :method => :post, :arguments => [⭐(:name => :timeout, :value => ->{ "4" })] }, finalize: <<-END
+      p 'xxx3'
+			data.x += \"a3,\"
+		END
+  end
+end
+

data/server/resources/backend/instance.template

@@ -0,0 +1,19 @@
+class Instance < WEEL
+  handlerwrapper <%= handlerwrapper %>
+
+<% for key, value in endpoints -%>
+  endpoint :<%= key %> => <%=  CPEE::ValueHelper::parse(value).inspect %>
+<% end  -%>
+
+<% for key, value in dataelements -%>
+  data :<%= key %> => <%=  CPEE::ValueHelper::parse(value).inspect %>
+<% end -%>
+
+<% unless positions.nil? || positions.empty? -%>
+  search <% positions.each_with_index { |de,i| %><%= (i > 0 ? ', ' : '') %>Position.new(:<%= de[0] %>, :<%=de[1] %>, <%= de[2].nil? || de[2].strip.empty? ? 'nil' : '"' + de[2] + '"' %>)<% } %>
+<% end -%>
+
+  control flow do
+    <%= dsl.strip.gsub(/\n/,"\n    ") %>
+  end
+end

data/server/resources/backend/opts.yaml

@@ -0,0 +1,6 @@
+:host: localhost
+:url: http://localhost:8298/
+:redis_path: /tmp/redis.sock
+:redis_db: 3
+:handlerwrappers: ../../handlerwrappers/
+

data/server/resources/backend/run

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby
+require 'yaml'
+opts = YAML::load_file(File.join(__dir__,'opts.yaml'))
+opts[:pidf] = __FILE__ + '.pid'
+opts[:pid] = Process.pid
+if File.exist? '../../../lib/cpee/controller'
+  require_relative '../../../lib/cpee/controller'
+else
+  require 'cpee/controller'
+end
+
+Dir[File.join(opts[:global_handlerwrappers],'*.rb')].each do |h|
+  require h
+end unless opts[:global_handlerwrappers].nil? || opts[:global_handlerwrappers].strip == ''
+Dir[File.join(opts[:handlerwrappers],'*.rb')].each do |h|
+  require h
+end unless opts[:handlerwrappers].nil? || opts[:handlerwrappers].strip == ''
+
+require_relative 'instance'
+controller = CPEE::Controller.new(File.basename(__dir__).to_i, __dir__, opts)
+controller.instance = Instance.new controller
+
+File.write(opts[:pidf],opts[:pid])
+
+%w{TERM HUP INT}.each do |sig|
+  Signal.trap(sig) do
+    puts "Caught #{sig}!"
+    controller.stop
+  end
+end
+
+controller.start
+File.unlink(opts[:pidf])

data/server/resources/notifications/logging/subscription.xml

@@ -0,0 +1,19 @@
+<subscription xmlns="http://riddl.org/ns/common-patterns/notifications-producer/2.0" url="http://localhost:9299/">
+  <topic id="activity">
+    <event>calling</event>
+    <event>receiving</event>
+    <event>done</event>
+  </topic>
+  <topic id="dataelements">
+    <event>change</event>
+  </topic>
+  <topic id="endpoints">
+    <event>change</event>
+  </topic>
+  <topic id="attributes">
+    <event>change</event>
+  </topic>
+  <topic id="task">
+    <event>instantiation</event>
+  </topic>
+</subscription>

data/server/resources/properties.empty

@@ -0,0 +1,38 @@
+<?xml version="1.0"?>
+<!--
+  This file is part of CPEE.
+
+  CPEE 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 3 of the License, or (at your option) any later
+  version.
+
+  CPEE 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.
+
+  You should have received a copy of the GNU General Public License along with
+  CPEE (file COPYING in the main directory). If not, see
+  <http://www.gnu.org/licenses/>.
+-->
+
+<properties xmlns="http://cpee.org/ns/properties/2.0">
+  <state changed="1970-01-01T00:00:00+00:00">ready</state>
+  <status>
+    <id>0</id>
+    <message>undefined</message>
+  </status>
+  <handlerwrapper>DefaultHandlerWrapper</handlerwrapper>
+  <positions/>
+  <dataelements/>
+  <endpoints/>
+  <attributes/>
+  <dsl/>
+  <dslx/>
+  <description/>
+  <transformation>
+    <description type='copy'/>
+    <dataelements type='none'/>
+    <endpoints type='none'/>
+  </transformation>
+</properties>

data/server/resources/properties.init

@@ -16,27 +16,27 @@
   <http://www.gnu.org/licenses/>.
 -->
 
-<properties xmlns="http://riddl.org/ns/common-patterns/properties/1.0">
-  <attributes>
-    <info/>
-    <modeltype>CPEE</modeltype>
-    <theme>preset</theme>
-  </attributes>
-  <state>ready</state>
+<properties xmlns="http://cpee.org/ns/properties/2.0">
+  <state changed="1970-01-01T00:00:00+00:00">ready</state>
+  <status>
+    <id>0</id>
+    <message>undefined</message>
+  </status>
   <handlerwrapper>DefaultHandlerWrapper</handlerwrapper>
   <positions/>
   <dataelements/>
   <endpoints>
     <timeout>http://gruppe.wst.univie.ac.at/~mangler/services/timeout.php</timeout>
   </endpoints>
+  <attributes>
+    <info/>
+    <modeltype>CPEE</modeltype>
+    <theme>preset</theme>
+  </attributes>
   <dsl/>
   <dslx>
     <description xmlns="http://cpee.org/ns/description/1.0"/>
   </dslx>
-  <status>
-    <id>0</id>
-    <message>undefined</message>
-  </status>
   <description>
     <description xmlns="http://cpee.org/ns/description/1.0"/>
   </description>

data/server/resources/states.dot

@@ -0,0 +1,19 @@
+digraph States {
+  ready -> running;
+  ready -> simulating;
+  ready -> replaying;
+  ready -> abandoned;
+  running -> stopping;
+  stopped -> running;
+  stopped -> simulating;
+  stopped -> replaying;
+  stopped -> abandoned;
+
+  running -> finishing;
+  simulating -> ready;
+  simulating -> stopped;
+  replaying -> stopping;
+  replaying -> finishing;
+  finishing -> finished;
+  stopping -> stopped;
+}

data/server/resources/states.xml

@@ -0,0 +1,49 @@
+<states>
+  <!-- final states are "abandoned" and "finished" (no further observable or setable states) -->
+  <!-- children of setable and observable are source states, their respective children are possible target states  -->
+
+  <setable>
+    <!-- the following states change through external input -->
+    <ready><!-- in this state you can set the following four states -->
+      <ready/>
+      <running/>
+      <simulating/>
+      <replaying/>
+      <abandoned/>
+    </ready>
+    <running><!-- in this state you can set the following state -->
+      <stopping/>
+    </running>
+    <stopped><!-- in this state you can set the following four states -->
+      <running/>
+      <simulating/>
+      <replaying/>
+      <abandoned/>
+      <stopped/>
+    </stopped>
+  </setable>
+
+  <observable>
+    <!-- the following states change through internal mechanisms -->
+    <running>
+      <stopping/>
+      <finishing/>
+    </running>
+    <simulating>
+      <ready/>
+      <stopped/>
+    </simulating>
+    <replaying>
+      <stopping/>
+      <finishing/>
+    </replaying>
+    <finishing>
+      <finished/>
+    </finishing>
+    <stopping>
+      <stopped/>
+    </stopping>
+    <abandoned/>
+    <finished/>
+  </observable>
+</states>

data/server/resources/transformation_dslx.xsl

@@ -507,11 +507,11 @@
         <xsl:text>nil</xsl:text>
       </xsl:when>
       <xsl:when test="child::node()[not(self::text())]">
-        <!-- FUUUU, there is probably much more TODO -->
+        <!-- FUUUU, there is probably much more TODO. Updated Matthias und Juergen, we tested for ing-opcua/execute -->
         <xsl:choose>
-          <xsl:when test="child::*/child::* and count(child::*[not(name()=name(../child::*[1]))])=0">
+          <xsl:when test="child::* and name(child::*)=concat(name(.),'_item')  and count(child::*[not(name()=name(../child::*[1]))])=0">
             <xsl:text>"[ </xsl:text>
-            <xsl:apply-templates select="*" mode="JSON"/>
+            <xsl:apply-templates select="*" mode="JSONArrayItem"/>
             <xsl:text>]"</xsl:text>
           </xsl:when>
           <xsl:otherwise>
@@ -655,6 +655,15 @@
       <xsl:otherwise><xsl:text> </xsl:text></xsl:otherwise>
     </xsl:choose>
   </xsl:template>
+  <xsl:template match="*" mode="JSONArrayItem">
+    <xsl:call-template name="JSONProperties">
+      <xsl:with-param name="parent" select="'Yes'"></xsl:with-param>
+    </xsl:call-template>
+    <xsl:choose>
+      <xsl:when test="following-sibling::*">, </xsl:when>
+      <xsl:otherwise><xsl:text> </xsl:text></xsl:otherwise>
+    </xsl:choose>
+  </xsl:template>
 
   <!-- JSON Object Properties -->
   <xsl:template name="JSONProperties">

data/server/routing/end.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby
+#
+# This file is part of CPEE.
+#
+# CPEE 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 3 of the License, or (at your option) any later version.
+#
+# CPEE 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.
+#
+# You should have received a copy of the GNU General Public License along with
+# CPEE (file COPYING in the main directory).  If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'json'
+require 'redis'
+require 'daemonite'
+
+Daemonite.new do |opts|
+  redis = Redis.new(path: "/tmp/redis.sock", db: 3)
+  pubsubredis = Redis.new(path: "/tmp/redis.sock", db: 3)
+
+  run do
+    pubsubredis.psubscribe('callback-end:*') do |on|
+      on.pmessage do |pat, what, message|
+        _, key = what.split(':')
+        index = message.index(' ')
+        instance = message[0...index]
+        redis.multi do |multi|
+          multi.srem("instance:#{instance}/callbacks",key)
+          multi.del("instance:#{instance}/callback/#{key}/uuid")
+          multi.del("instance:#{instance}/callback/#{key}/label")
+          multi.del("instance:#{instance}/callback/#{key}/position")
+          multi.del("instance:#{instance}/callback/#{key}/type")
+        end
+      rescue => e
+        puts e.message
+        puts e.backtrace
+      end
+    end
+  end
+end.go!

data/server/routing/forward-events.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby
+#
+# This file is part of CPEE.
+#
+# CPEE 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 3 of the License, or (at your option) any later version.
+#
+# CPEE 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.
+#
+# You should have received a copy of the GNU General Public License along with
+# CPEE (file COPYING in the main directory).  If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'redis'
+require 'daemonite'
+require 'riddl/client'
+
+Daemonite.new do |opts|
+  redis = Redis.new(path: "/tmp/redis.sock", db: 3)
+  pubsubredis = Redis.new(path: "/tmp/redis.sock", db: 3)
+
+  run do
+    pubsubredis.psubscribe('event:*') do |on|
+      on.pmessage do |pat, what, message|
+        index = message.index(' ')
+        mess = message[index+1..-1]
+        instance = message[0...index]
+        type = pat[0..-3]
+        event = what[(type.length+1)..-1]
+        topic = ::File::dirname(event)
+        name = ::File::basename(event)
+        long = File.join(topic,type,name)
+        redis.smembers("instance:#{instance}/handlers").each do |key|
+          if redis.smembers("instance:#{instance}/handlers/#{key}").include? long
+            url = redis.get("instance:#{instance}/handlers/#{key}/url")
+            if url.nil? || url == ""
+              redis.publish("forward:#{instance}/#{key}",mess)
+            else
+              client = Riddl::Client.new(url,'http://riddl.org/ns/common-patterns/notifications-consumer/2.0/consumer.xml')
+              client.post [
+                Riddl::Parameter::Simple::new('type',type),
+                Riddl::Parameter::Simple::new('topic',topic),
+                Riddl::Parameter::Simple::new('event',name),
+                Riddl::Parameter::Complex::new('notification','application/json',mess)
+              ]
+            end
+          end
+        end
+      rescue => e
+        puts e.message
+        puts e.backtrace
+        p '-----------------'
+      end
+    end
+  end
+end.go!

data/server/routing/forward-votes.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/ruby
+#
+# This file is part of CPEE.
+#
+# CPEE 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 3 of the License, or (at your option) any later version.
+#
+# CPEE 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.
+#
+# You should have received a copy of the GNU General Public License along with
+# CPEE (file COPYING in the main directory).  If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'redis'
+require 'daemonite'
+require 'riddl/client'
+require 'json'
+require_relative '../../lib/cpee/message'
+
+def persist_handler(instance,key,mess,redis) #{{{
+  redis.multi do |multi|
+    multi.sadd("instance:#{instance}/callbacks",key)
+    multi.set("instance:#{instance}/callback/#{key}/uuid",mess.dig('content','activity_uuid'))
+    multi.set("instance:#{instance}/callback/#{key}/label",mess.dig('content','label'))
+    multi.set("instance:#{instance}/callback/#{key}/position",mess.dig('content','activity'))
+    multi.set("instance:#{instance}/callback/#{key}/type",'vote')
+  end
+end #}}}
+
+def send_response(instance,key,url,value,redis) #{{{
+  CPEE::Message::send(
+    :'vote-response',
+    key,
+    url,
+    instance,
+    {},
+    {},
+    value,
+    redis
+  )
+end #}}}
+
+Daemonite.new do |opts|
+  redis = Redis.new(path: "/tmp/redis.sock", db: 3)
+  pubsubredis = Redis.new(path: "/tmp/redis.sock", db: 3)
+
+  run do
+    pubsubredis.psubscribe('vote:*') do |on|
+      on.pmessage do |pat, what, message|
+        index = message.index(' ')
+        mess = message[index+1..-1]
+
+        instance = message[0...index]
+        type = pat[0..-3]
+        event = what[(type.length+1)..-1]
+        topic = ::File::dirname(event)
+        name = ::File::basename(event)
+        long = File.join(topic,type,name)
+
+        redis.smembers("instance:#{instance}/handlers").each do |subscription_key|
+          if redis.smembers("instance:#{instance}/handlers/#{subscription_key}").include? long
+            m = JSON.parse(mess)
+            callback_key = m.dig('content','key')
+            url = redis.get("instance:#{instance}/handlers/#{subscription_key}/url")
+
+            if url.nil? || url == ""
+              persist_handler instance, callback_key, m, redis
+              redis.publish("forward:#{instance}/#{subscription_key}",mess)
+            else
+              client = Riddl::Client.new(url,'http://riddl.org/ns/common-patterns/notifications-consumer/2.0/consumer.xml')
+              callback = m['instance-url'] + '/callbacks/' + subscription_key
+              status, result, headers = (client.post [
+                Riddl::Header.new("CPEE-BASE",m['cpee']),
+                Riddl::Header.new("CPEE-INSTANCE",m['instance']),
+                Riddl::Header.new("CPEE-INSTANCE-URL",m['instance-url']),
+                Riddl::Header.new("CPEE-INSTANCE-UUID",m['instance-uuid']),
+                Riddl::Header.new("CPEE-CALLBACK",callback),
+                Riddl::Header.new("CPEE-CALLBACK-ID",subscription_key),
+                Riddl::Parameter::Simple::new('type',type),
+                Riddl::Parameter::Simple::new('topic',topic),
+                Riddl::Parameter::Simple::new('vote',name),
+                Riddl::Parameter::Simple::new('callback',callback),
+                Riddl::Parameter::Complex::new('notification','application/json',mess)
+              ] rescue [ 0, [], []])
+              if status >= 200 && status < 300
+                val = result[0].value.read
+                if (headers["CPEE_CALLBACK"] && headers["CPEE_CALLBACK"] == 'true') || val == 'callback'
+                  persist_handler instance, callback_key, m, redis
+                else # they may send true or false
+                  send_response instance, callback_key, m['cpee'], val, redis
+                end
+              else
+                send_response instance, callback_key, m['cpee'], true, redis
+              end
+            end
+          end
+        end
+      rescue => e
+        puts e.message
+        puts e.backtrace
+        p '-----------------'
+      end
+    end
+  end
+end.go!