cpee 2.0.25 → 2.1.0

data/lib/cpee/implementation_notifications.rb

@@ -1,3 +1,17 @@
+# 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'
 
 module CPEE
@@ -169,8 +183,12 @@ module CPEE
       conn.psubscribe('forward:*','event:state/change') do |on|
         on.pmessage do |pat, what, message|
           if pat == 'forward:*'
-            _, id, key = what.match(/forward(-end)?:([^\/]+)\/(.+)/).captures
-            opts.dig(:sse_connections,id.to_i,key)&.send message
+            id, key = what.match(/forward:([^\/]+)\/(.+)/).captures
+            if sse = opts.dig(:sse_connections,id.to_i,key)
+              sse.send message
+            else
+              DeleteSubscription::set(id,opts,key)
+            end
           elsif pat == 'event:state/change'
             mess = JSON.parse(message[message.index(' ')+1..-1])
             state = mess.dig('content','state')

data/lib/cpee/implementation_properties.rb

@@ -1,6 +1,19 @@
+# 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_relative 'attributes_helper'
 require_relative 'value_helper'
-require_relative 'transform'
 require 'json'
 require 'erb'
 require 'yaml'
@@ -31,9 +44,9 @@ module CPEE
             run CPEE::Properties::GetStatusMessage, id, opts if get
           end
         end
-        on resource 'handlerwrapper' do
-          run CPEE::Properties::GetHandlerWrapper, id, opts if get
-          run CPEE::Properties::PutHandlerWrapper, id, opts if put 'handlerwrapper'
+        on resource 'executionhandler' do
+          run CPEE::Properties::GetExecutionHandler, id, opts if get
+          run CPEE::Properties::PutExecutionHandler, id, opts if put 'executionhandler'
         end
         on resource 'positions' do
           run CPEE::Properties::GetPositions, id, opts if get
@@ -128,8 +141,8 @@ module CPEE
           if (node = doc.find('/p:properties/p:status')).any?
             CPEE::Properties::PutStatus::set id, opts, node.first.dump
           end
-          if (node = doc.find('/p:properties/p:handlerwrapper')).any?
-            CPEE::Properties::PutHandlerWrapper::set id, opts, node.first.text
+          if (node = doc.find('/p:properties/p:executionhandler')).any?
+            CPEE::Properties::PutExecutionHandler::set id, opts, node.first.text
           end
 
           %w{dataelements endpoints attributes}.each do |item|
@@ -169,8 +182,8 @@ module CPEE
           if (node = doc.find('/p:properties/p:status')).any?
             CPEE::Properties::PutStatus::set id, opts, node.first.dump
           end
-          if (node = doc.find('/p:properties/p:handlerwrapper')).any?
-            CPEE::Properties::PutHandlerWrapper::set id, opts, node.first.text
+          if (node = doc.find('/p:properties/p:executionhandler')).any?
+            CPEE::Properties::PutExecutionHandler::set id, opts, node.first.text
           end
 
           %w{dataelements endpoints attributes}.each do |item|
@@ -211,19 +224,14 @@ module CPEE
       end
 
       def self::run(id,opts,state)
-        exe = File.join(opts[:instances],id.to_s,File.basename(opts[:backend_run]))
         case state
           when 'running'
-            CPEE::Persistence::write_instance id, opts
-            pid = Kernel.spawn(exe , :pgroup => true, :in => '/dev/null', :out => exe + '.out', :err => exe + '.err')
-            Process.detach pid
-            File.write(exe + '.pid',pid)
+            seh = Object.const_get('CPEE::ExecutionHandler::' + CPEE::Persistence::extract_item(id,opts,'executionhandler').capitalize)
+            seh::prepare(id,opts)
+            seh::run(id,opts)
           when 'stopping'
-            pid = File.read(exe + '.pid') rescue nil
-            if pid && (Process.kill(0, pid.to_i) rescue false)
-              Process.kill('HUP', pid.to_i) rescue nil
-            else
-              File.unlink(exe + '.pid') rescue nil
+            seh = Object.const_get('CPEE::ExecutionHandler::' + CPEE::Persistence::extract_item(id,opts,'executionhandler').capitalize)
+            if seh::stop(id,opts) # process is not running anyway, so change redis
               PutState::set id, opts, 'stopped'
             end
           else
@@ -302,16 +310,16 @@ module CPEE
         Riddl::Parameter::Simple.new('value',CPEE::Persistence::extract_item(id,opts,'status/message'))
       end
     end #}}}
-    class GetHandlerWrapper < Riddl::Implementation #{{{
+    class GetExecutionHandler < Riddl::Implementation #{{{
       def response
         id = @a[0]
         opts = @a[1]
-        Riddl::Parameter::Simple.new('value',CPEE::Persistence::extract_item(id,opts,'handlerwrapper'))
+        Riddl::Parameter::Simple.new('value',CPEE::Persistence::extract_item(id,opts,'executionhandler'))
       end
     end #}}}
-    class PutHandlerWrapper < Riddl::Implementation #{{{
+    class PutExecutionHandler < Riddl::Implementation #{{{
       def self::set(id,opts,hw)
-        CPEE::Persistence::set_item(id,opts,'handlerwrapper',:handlerwrapper => hw)
+        CPEE::Persistence::set_item(id,opts,'executionhandler',:executionhandler => hw)
       end
       def response
         id = @a[0]
@@ -319,7 +327,7 @@ module CPEE
         if opts[:statemachine].readonly? id
           @status = 423
         else
-          PutHandlerWrapper::set(id,opts,@p[0].value)
+          PutExecutionHandler::set(id,opts,@p[0].value)
         end
         nil
       end
@@ -633,8 +641,103 @@ module CPEE
     end #}}}
 
     class PutDescription < Riddl::Implementation #{{{
+      def self::transform(descxml,tdesc,tdesctype,tdata,tdatatype,tendp,tendptype,hw,opts) #{{{
+        desc = XML::Smart::string(descxml)
+        desc.register_namespace  'p', 'http://cpee.org/ns/description/1.0'
+
+        dslx = nil
+        dsl = nil
+        de = {}
+        ep = {}
+
+        if desc.root.children.empty?
+          tdesctype = tdatatype = tendptype = 'clean'
+        end
+
+        ### description transformation, including dslx to dsl
+        addit = if tdesctype == 'copy' || tdesc.empty?
+          desc
+        elsif tdesctype == 'rest' && !tdesc.empty?
+          srv = Riddl::Client.interface(tdesc,opts[:transformation_service])
+          status, res = srv.post [
+            Riddl::Parameter::Complex.new("description","text/xml",descxml),
+            Riddl::Parameter::Simple.new("type","description")
+          ]
+          if status >= 200 && status < 300
+            XML::Smart::string(res[0].value.read).root
+          else
+            raise 'Could not extract dslx'
+          end
+        elsif tdesctype == 'xslt' && !tdesc.empty?
+          trans = XML::Smart::open_unprotected(tdesc)
+          desc.transform_with(trans).root
+        elsif tdesctype == 'clean'
+          XML::Smart::open_unprotected(opts[:empty_dslx]).root
+        else
+          nil
+        end
+        unless addit.nil?
+          dslx = addit.to_s
+          dsl = Object.const_get('CPEE::ExecutionHandler::' + hw.capitalize)::dslx_to_dsl(addit)
+        end
+
+        ### dataelements extraction
+        addit = if tdatatype == 'rest' && !tdata.empty?
+          srv = Riddl::Client.interface(tdata,@opts[:transformation_service])
+          status, res = srv.post [
+            Riddl::Parameter::Complex.new("description","text/xml",descxml),
+            Riddl::Parameter::Simple.new("type","dataelements")
+          ]
+          if status >= 200 && status < 300
+            res
+          else
+            raise 'Could not extract dataelements'
+          end
+        elsif tdatatype == 'xslt' && !tdata.empty?
+          trans = XML::Smart::open_unprotected(tdata)
+          desc.transform_with(trans)
+        elsif tdatatype == 'clean'
+          []
+        else
+          nil
+        end
+        unless addit.nil?
+          addit.each_slice(2).each do |k,v|
+            de[k.value.to_sym] = v.value
+          end
+        end
+
+        ### endpoints extraction
+        addit = if tendptype == 'rest' && !tdata.empty?
+          srv = Riddl::Client.interface(tendp,@opts[:transformation_service])
+          status, res = srv.post [
+            Riddl::Parameter::Complex.new("description","text/xml",descxml),
+            Riddl::Parameter::Simple.new("type","endpoints")
+          ]
+          if status >= 200 && status < 300
+            res
+          else
+            raise 'Could not extract endpoints'
+          end
+        elsif tendptype == 'xslt' && !tdata.empty?
+          trans = XML::Smart::open_unprotected(tendp.text)
+          desc.transform_with(trans)
+        elsif tendptype == 'clean'
+          []
+        else
+          nil
+        end
+        unless addit.nil?
+          addit.each_slice(2).each do |k,v|
+            ep[k.value.to_sym] = v.value
+          end
+        end
+
+        [dslx, dsl, de, ep]
+      end #}}}
+
       def self::set(id,opts,xml)
-        dslx, dsl, de, ep = transform(
+        dslx, dsl, de, ep = PutDescription::transform(
           xml,
           CPEE::Persistence::extract_item(id,opts,'transformation/description'),
           CPEE::Persistence::extract_item(id,opts,'transformation/description/@type'),
@@ -642,6 +745,7 @@ module CPEE
           CPEE::Persistence::extract_item(id,opts,'transformation/dataelements/@type'),
           CPEE::Persistence::extract_item(id,opts,'transformation/endpoints'),
           CPEE::Persistence::extract_item(id,opts,'transformation/endpoints/@type'),
+          CPEE::Persistence::extract_item(id,opts,'executionhandler'),
           opts
         )
         CPEE::Persistence::set_item(id,opts,'description',

data/lib/cpee/persistence.rb

@@ -15,33 +15,6 @@
 module CPEE
 
   module Persistence
-    def self::write_instance(id,opts) #{{{
-      Dir.mkdir(File.join(opts[:instances],id.to_s)) rescue nil
-      FileUtils.copy(opts[:backend_run],File.join(opts[:instances],id.to_s))
-      dsl = CPEE::Persistence::extract_item(id,opts,'dsl')
-      hw = CPEE::Persistence::extract_item(id,opts,'handlerwrapper')
-      endpoints = CPEE::Persistence::extract_list(id,opts,'endpoints')
-      dataelements = CPEE::Persistence::extract_list(id,opts,'dataelements')
-      positions = CPEE::Persistence::extract_set(id,opts,'positions')
-      positions.map! do |k, v|
-        [ k, v, CPEE::Persistence::extract_item(id,opts,File.join('positions',k,'@passthrough')) ]
-      end
-      File.open(File.join(opts[:instances],id.to_s,opts[:backend_opts]),'w') do |f|
-        YAML::dump({
-          :host => opts[:host],
-          :url => opts[:url],
-          :redis_url => opts[:redis_url],
-          :redis_path => File.join(opts[:basepath],opts[:redis_path]),
-          :redis_db => opts[:redis_db],
-          :global_handlerwrappers => opts[:global_handlerwrappers],
-          :handlerwrappers => opts[:handlerwrappers]
-        },f)
-      end
-      template = ERB.new(File.read(opts[:backend_template]), trim_mode: '-')
-      res = template.result_with_hash(dsl: dsl, handlerwrapper: hw, dataelements: dataelements, endpoints: endpoints, positions: positions)
-      File.write(File.join(opts[:instances],id.to_s,opts[:backend_instance]),res)
-    end #}}}
-
     def self::set_list(id,opts,item,values,deleted=[]) #{{{
       ah = AttributesHelper.new
       attributes = Persistence::extract_list(id,opts,'attributes').to_h

data/lib/cpee/statemachine.rb

@@ -1,3 +1,17 @@
+# 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/>.
+
 module CPEE
 
   class StateMachine

data/lib/cpee/value_helper.rb

@@ -1,3 +1,17 @@
+# 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 'time'
 

data/lib/properties.xml

@@ -63,7 +63,7 @@
     <parameter name="value" type="string"/>
   </message> <!--}}}-->
 
-  <message name="handlerwrapper"> <!--{{{-->
+  <message name="executionhandler"> <!--{{{-->
     <parameter name="value" type="string">
       <param name="pattern">[A-Z][a-zA-Z]*</param>
     </parameter>
@@ -165,9 +165,9 @@
         <get out="string"/>
       </resource>
     </resource> <!--}}}-->
-    <resource relative="handlerwrapper"> <!--{{{-->
-      <put in="handlerwrapper"/>
-      <get out="handlerwrapper"/>
+    <resource relative="executionhandler"> <!--{{{-->
+      <put in="executionhandler"/>
+      <get out="executionhandler"/>
     </resource> <!--}}}-->
     <resource relative="positions"> <!--{{{-->
       <get out="positions"/>

data/lib/properties/{handlerwrapper.rng → executionhandler.rng}

@@ -1,6 +1,6 @@
 <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
-  <define name="handlerwrapper">
-    <element name="handlerwrapper" ns="http://cpee.org/ns/properties/2.0">
+  <define name="executionhandler">
+    <element name="executionhandler" ns="http://cpee.org/ns/properties/2.0">
       <data type="string">
         <param name="pattern">[A-Z][a-zA-Z]*</param>
       </data>

data/lib/properties/properties.rng

@@ -1,7 +1,7 @@
 <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <include href="state.rng"/>
   <include href="status.rng"/>
-  <include href="handlerwrapper.rng"/>
+  <include href="executionhandler.rng"/>
   <include href="positions.rng"/>
   <include href="dataelements.rng"/>
   <include href="endpoints.rng"/>
@@ -15,7 +15,7 @@
     <element name="properties" ns="http://cpee.org/ns/properties/2.0">
       <ref name="state"/>
       <ref name="status"/>
-      <ref name="handlerwrapper"/>
+      <ref name="executionhandler"/>
       <ref name="positions"/>
       <ref name="dataelements"/>
       <ref name="endpoints"/>

data/lib/properties/set-properties.rng

@@ -1,7 +1,7 @@
 <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <include href="state.rng"/>
   <include href="status.rng"/>
-  <include href="handlerwrapper.rng"/>
+  <include href="executionhandler.rng"/>
   <include href="positions.rng"/>
   <include href="dataelements.rng"/>
   <include href="endpoints.rng"/>
@@ -13,7 +13,7 @@
     <element name="properties" ns="http://cpee.org/ns/properties/2.0">
       <ref name="set-state"/>
       <ref name="status"/>
-      <ref name="handlerwrapper"/>
+      <ref name="executionhandler"/>
       <ref name="positions"/>
       <ref name="dataelements"/>
       <ref name="endpoints"/>

data/lib/properties/set-some-properties.rng

@@ -1,7 +1,7 @@
 <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <include href="state.rng"/>
   <include href="status.rng"/>
-  <include href="handlerwrapper.rng"/>
+  <include href="executionhandler.rng"/>
   <include href="positions.rng"/>
   <include href="dataelements.rng"/>
   <include href="endpoints.rng"/>
@@ -19,7 +19,7 @@
           <ref name="status"/>
         </optional>
         <optional>
-          <ref name="handlerwrapper"/>
+          <ref name="executionhandler"/>
         </optional>
         <optional>
           <ref name="positions"/>

data/server/{resources → executionhandlers/ruby}/backend/instance.template

@@ -1,5 +1,5 @@
 class Instance < WEEL
-  handlerwrapper <%= handlerwrapper %>
+  connectionwrapper ConnectionWrapper
 
 <% for key, value in endpoints -%>
   endpoint :<%= key %> => <%=  CPEE::ValueHelper::parse(value).inspect %>
@@ -13,7 +13,5 @@ class Instance < WEEL
   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
+  <%= dsl.strip.gsub(/\n/,"\n  ") %>
 end

data/server/{resources → executionhandlers/ruby}/backend/opts.yaml

@@ -2,5 +2,5 @@
 :url: http://localhost:8298/
 :redis_path: /tmp/redis.sock
 :redis_db: 3
-:handlerwrappers: ../../handlerwrappers/
-
+:executionhandlers: ../../executionhandlers/
+:executionhandler: ruby

data/server/executionhandlers/ruby/backend/run

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby
+require 'yaml'
+opts = YAML::load_file(File.join(__dir__,'opts.yaml'))
+opts[:pidf] = __FILE__ + '.pid'
+opts[:pid] = Process.pid
+
+global_controller = File.join(opts[:global_executionhandlers],opts[:executionhandler],'controller.rb')
+controller        = File.join(opts[:executionhandlers],       opts[:executionhandler],'controller.rb')
+if File.exists? global_controller
+  require global_controller
+elsif File.exists? controller
+  require controller
+end
+
+global_connectionhandler = File.join(opts[:global_executionhandlers],opts[:executionhandler],'connection.rb')
+connectionhandler        = File.join(opts[:executionhandlers],       opts[:executionhandler],'connection.rb')
+if File.exists? global_connectionhandler
+  require global_connectionhandler
+elsif File.exists? connectionhandler
+  require connectionhandler
+end
+
+require_relative 'instance'
+controller = 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])