cpee 1.5.27 → 2.0.5

data/lib/cpee/{callback.rb → message.rb}

@@ -14,27 +14,29 @@
 
 module CPEE
 
-  class Callback
-    def initialize(info,handler,method,event,key,protocol,*data)
-      @info = info
-      @event = event
-      @key = key
-      @data = data
-      @handler = handler
-      @protocol = protocol
-      @method = method.class == Symbol ? method : :callback
-    end
-
-    attr_reader :info, :protocol, :method
+  module Message
 
-    def delete_if!(event,key)
-      @handler.send @method, :DELETE, nil, *@data if @key == key && @event == event
-      nil
+    def self::send(type, event, cpee, instance, instance_uuid, instance_name, content={}, backend)
+      topic = ::File::dirname(event)
+      name = ::File::basename(event)
+      backend.publish(type.to_s + ':' + event,
+        instance.to_s + ' ' +
+        JSON::generate(
+          { 'cpee' => cpee,
+            'instance-url' => File.join(cpee,instance.to_s),
+            'instance-uuid' => instance_uuid,
+            'instance-name' => instance_name,
+            'instance' => instance,
+            'topic' => topic,
+            'type' => type,
+            'name' => name,
+            'timestamp' =>  Time.now.xmlschema(3),
+            'content' => content
+          }
+        )
+      )
     end
 
-    def callback(result=nil,options=nil)
-      @handler.send @method, result, options, *@data
-    end
   end
 
 end

data/lib/cpee/persistence.rb

@@ -0,0 +1,135 @@
+# 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
+
+  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_path => 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
+      dataelements = Persistence::extract_list(id,opts,'dataelements').to_h
+      endpoints = Persistence::extract_list(id,opts,'endpoints').to_h
+      CPEE::Message::send(
+        :event,
+        File.join(item,'change'),
+        opts[:url],
+        id,
+        Persistence::extract_item(id,opts,'attributes/uuid'),
+        Persistence::extract_item(id,opts,'attributes/info'),
+        {
+          :changed => values.keys,
+          :deleted => deleted,
+          :values => values,
+          :attributes => ah.translate(attributes,dataelements,endpoints),
+        },
+        opts[:redis]
+      )
+    end #}}}
+    def self::extract_set(id,opts,item) #{{{
+      opts[:redis].smembers("instance:#{id}/#{item}").map do |e|
+        [e,opts[:redis].get("instance:#{id}/#{item}/#{e}")]
+      end
+    end #}}}
+    def self::extract_list(id,opts,item) #{{{
+      opts[:redis].zrange("instance:#{id}/#{item}",0,-1).map do |e|
+        [e,opts[:redis].get("instance:#{id}/#{item}/#{e}")]
+      end
+    end #}}}
+
+    def self::set_item(id,opts,item,value) #{{{
+      CPEE::Message::send(
+        :event,
+        File.join(item,'change'),
+        opts[:url],
+        id,
+        Persistence::extract_item(id,opts,'attributes/uuid'),
+        Persistence::extract_item(id,opts,'attributes/info'),
+        value,
+        opts[:redis]
+      )
+    end #}}}
+    def self::extract_item(id,opts,item) #{{{
+      opts[:redis].get("instance:#{id}/#{item}")
+    end #}}}
+
+    def self::set_handler(id,opts,key,url,values,update=false) #{{{
+      exis = opts[:redis].smembers("instance:#{id}/handlers/#{key}")
+
+      if update == false && exis.length > 0
+        return 405
+      end
+
+      ah = AttributesHelper.new
+      attributes = Persistence::extract_list(id,opts,'attributes').to_h
+      dataelements = Persistence::extract_list(id,opts,'dataelements').to_h
+      endpoints = Persistence::extract_list(id,opts,'endpoints').to_h
+
+      deleted = exis - values
+
+      CPEE::Message::send(
+        :event,
+        'handler/change',
+        opts[:url],
+        id,
+        Persistence::extract_item(id,opts,'attributes/uuid'),
+        Persistence::extract_item(id,opts,'attributes/info'),
+        {
+          :key => key,
+          :url => url,
+          :changed => values,
+          :deleted => deleted,
+          :attributes => ah.translate(attributes,dataelements,endpoints),
+        },
+        opts[:redis]
+      )
+
+      200
+    end #}}}
+    def self::extract_handler(id,opts,key) #{{{
+      opts[:redis].smembers("instance:#{id}/handlers/#{key}")
+    end #}}}
+    def self::extract_handlers(id,opts) #{{{
+      opts[:redis].smembers("instance:#{id}/handlers").map do |e|
+        [e, opts[:redis].get("instance:#{id}/handlers/#{e}/url")]
+      end
+    end #}}}
+  end
+
+end

data/lib/cpee/statemachine.rb

@@ -0,0 +1,20 @@
+module CPEE
+
+  class StateMachine
+    def initialize(file,readonly,&state)
+      @states = XML::Smart.open_unprotected(file)
+      @state = state
+      @readonly = readonly
+    end
+
+    def setable?(id,nval)
+      cval = @state.call(id)
+      @states.find("/states/setable/#{cval}[#{nval}]").length > 0
+    end
+
+    def readonly?(id)
+      @readonly.include? @state.call(id)
+    end
+  end
+
+end

data/lib/cpee/transform.rb

@@ -0,0 +1,95 @@
+def transform(descxml,tdesc,tdesctype,tdata,tdatatype,tendp,tendptype,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?
+    trans = XML::Smart::open_unprotected(opts[:transformation_dslx])
+    dslx = addit.to_s
+    dsl = addit.transform_with(trans).to_s
+  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

data/lib/engine.xml

@@ -30,42 +30,12 @@
   <message name="instance-new">
     <parameter name="info" type="string"/>
   </message>
-  <message name="instance-new-xml">
-    <parameter name="xml" mimetype="application/xml"/>
-  </message>
 
   <message name="instance-info">
     <parameter name="info" mimetype="text/xml" handler="http://riddl.org/ns/handlers/relaxng">
       <xi:include href="engine/instance-info.rng"/>
     </parameter>
   </message>
-  <message name="callbacks">
-    <parameter name="info" mimetype="text/xml" handler="http://riddl.org/ns/handlers/relaxng">
-      <xi:include href="engine/callbacks.rng"/>
-    </parameter>
-  </message>
-  <message name="xsl">
-    <parameter name="xsl" mimetype="application/xml"/>
-  </message>
-
-  <message name="cmdin">
-    <parameter name="cmd" type="string"/>
-  </message>
-  <message name="cmdout">
-    <parameter name="res" mimetype="text/plain"/>
-  </message>
-  <message name="cmdui">
-    <parameter name="res" mimetype="text/html"/>
-  </message>
-
-  <message name="message">
-    <parameter name="type" type="integer"/>
-    <parameter name="message" type="string"/>
-    <optional>
-      <parameter name="details" mimetype="text/xml"/>
-      <parameter name="details" mimetype="text/yaml"/>
-    </optional>
-  </message>
 
   <resource>
     <doc:documentation>b</doc:documentation>
@@ -73,37 +43,9 @@
       <doc:documentation>a</doc:documentation>
     </get>
     <post in="instance-new" out="instance-id"/>
-    <post in="instance-new-xml" out="instance-id"/>
-    <resource>
+    <resource relative="\d+">
       <get in="*" out="instance-info"/>
       <delete in="*"/>
-      <resource relative="console">
-        <get out="cmdui"/>
-        <get in="cmdin" out="cmdout"/>
-      </resource>
-      <resource relative="callbacks">
-        <doc:documentation>xb</doc:documentation>
-        <get in="*" out="callbacks"/>
-        <resource>
-          <put in="*"/>
-        </resource>
-      </resource>
-      <resource relative="notifications">
-        <doc:documentation>xr</doc:documentation>
-        <resource relative="subscriptions">
-          <resource>
-            <resource relative="debug">
-              <put in="message"/>
-            </resource>
-            <resource relative="error">
-              <put in="message"/>
-            </resource>
-            <resource relative="info">
-              <put in="message"/>
-            </resource>
-          </resource>
-        </resource>
-      </resource>
     </resource>
   </resource>
 </description>

data/lib/properties.xml

@@ -0,0 +1,236 @@
+<!--
+  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/>.
+-->
+
+<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="properties"> <!--{{{-->
+    <parameter name="properties" mimetype="*/xml" handler="http://riddl.org/ns/handlers/relaxng">
+      <xi:include href="properties/properties.rng"/>
+    </parameter>
+  </message> <!--}}}-->
+  <message name="set-some-properties"> <!--{{{-->
+    <parameter name="properties" mimetype="*/xml" handler="http://riddl.org/ns/handlers/relaxng">
+      <xi:include href="properties/set-some-properties.rng"/>
+    </parameter>
+  </message> <!--}}}-->
+
+  <message name="machine"> <!--{{{-->
+    <parameter name="machine" type="string"/>
+  </message> <!--}}}-->
+  <message name="diagram"> <!--{{{-->
+    <parameter name="diagram" mimetype="*/xml"/>
+  </message> <!--}}}-->
+  <message name="state"> <!--{{{-->
+    <parameter name="value" type="string">
+      <choice>
+        <value>ready</value>
+        <value>running</value>
+        <value>simulating</value>
+        <value>replaying</value>
+        <value>stopping</value>
+        <value>stopped</value>
+        <value>abandoned</value>
+        <value>finished</value>
+      </choice>
+    </parameter>
+  </message> <!--}}}-->
+
+  <message name="changed"> <!--{{{-->
+    <parameter name="state" type="dateTime"/>
+  </message> <!--}}}-->
+
+  <message name="status"> <!--{{{-->
+    <parameter name="status" mimetype="*/xml" handler="http://riddl.org/ns/handlers/relaxng">
+      <xi:include href="properties/t_status.rng"/>
+    </parameter>
+  </message> <!--}}}-->
+  <message name="integer"> <!--{{{-->
+    <parameter name="value" type="integer"/>
+  </message> <!--}}}-->
+  <message name="string"> <!--{{{-->
+    <parameter name="value" type="string"/>
+  </message> <!--}}}-->
+
+  <message name="handlerwrapper"> <!--{{{-->
+    <parameter name="value" type="string">
+      <param name="pattern">[A-Z][a-zA-Z]*</param>
+    </parameter>
+  </message> <!--}}}-->
+
+  <message name="id"> <!--{{{-->
+    <parameter name="value" type="string"/>
+  </message> <!--}}}-->
+
+  <message name="position"> <!--{{{-->
+    <parameter name="position" mimetype="*/xml" handler="http://riddl.org/ns/handlers/relaxng">
+      <xi:include href="properties/t_position.rng"/>
+    </parameter>
+  </message> <!--}}}-->
+  <message name="positions"> <!--{{{-->
+    <parameter name="positions" mimetype="*/xml" handler="http://riddl.org/ns/handlers/relaxng">
+      <xi:include href="properties/t_positions.rng"/>
+    </parameter>
+  </message> <!--}}}-->
+  <message name="detail"> <!--{{{-->
+    <parameter name="detail" type="string">
+      <choice>
+        <value>at</value>
+        <value>after</value>
+        <value>before</value>
+      </choice>
+    </parameter>
+  </message> <!--}}}-->
+
+  <message name="dataelement"> <!--{{{-->
+    <parameter name="dataelement" mimetype="*/xml" handler="http://riddl.org/ns/handlers/relaxng">
+      <xi:include href="properties/t_simple.rng"/>
+    </parameter>
+  </message> <!--}}}-->
+  <message name="dataelements"> <!--{{{-->
+    <parameter name="dataelements" mimetype="*/xml" handler="http://riddl.org/ns/handlers/relaxng">
+      <xi:include href="properties/t_dataelements.rng"/>
+    </parameter>
+  </message> <!--}}}-->
+
+  <message name="endpoint"> <!--{{{-->
+    <parameter name="endpoint" mimetype="*/xml" handler="http://riddl.org/ns/handlers/relaxng">
+      <xi:include href="properties/t_simple.rng"/>
+    </parameter>
+  </message> <!--}}}-->
+  <message name="endpoints"> <!--{{{-->
+    <parameter name="endpoints" mimetype="*/xml" handler="http://riddl.org/ns/handlers/relaxng">
+      <xi:include href="properties/t_endpoints.rng"/>
+    </parameter>
+  </message> <!--}}}-->
+
+  <message name="attribute"> <!--{{{-->
+    <parameter name="attribute" mimetype="*/xml" handler="http://riddl.org/ns/handlers/relaxng">
+      <xi:include href="properties/t_simple.rng"/>
+    </parameter>
+  </message> <!--}}}-->
+  <message name="attributes"> <!--{{{-->
+    <parameter name="attributes" mimetype="*/xml" handler="http://riddl.org/ns/handlers/relaxng">
+      <xi:include href="properties/t_attributes.rng"/>
+    </parameter>
+  </message> <!--}}}-->
+
+  <message name="dsl"> <!--{{{-->
+    <parameter name="dsl" mimetype="text/plain"/>
+  </message> <!--}}}-->
+  <message name="dslx"> <!--{{{-->
+    <parameter name="dslx" mimetype="*/xml"/>
+  </message> <!--}}}-->
+  <message name="description"> <!--{{{-->
+    <parameter name="description" mimetype="*/xml"/>
+  </message> <!--}}}-->
+
+  <message name="transformation"> <!--{{{-->
+    <parameter name="transformation" mimetype="*/xml" handler="http://riddl.org/ns/handlers/relaxng">
+      <xi:include href="properties/t_transformation.rng"/>
+    </parameter>
+  </message> <!--}}}-->
+
+  <resource>
+    <get out="properties"/>
+    <put in="set-some-properties"/>
+    <patch in="set-some-properties"/>
+
+    <resource relative="state"> <!--{{{-->
+      <get in="machine" out="diagram"/>
+      <get out="state"/>
+      <put in="state"/>
+      <resource relative="@changed">
+        <get out="changed"/>
+      </resource>
+    </resource> <!--}}}-->
+    <resource relative="status"> <!--{{{-->
+      <get out="status"/>
+      <put in="status"/>
+      <resource relative="id">
+        <get out="integer"/>
+      </resource>
+      <resource relative="message">
+        <get out="string"/>
+      </resource>
+    </resource> <!--}}}-->
+    <resource relative="handlerwrapper"> <!--{{{-->
+      <put in="handlerwrapper"/>
+      <get out="handlerwrapper"/>
+    </resource> <!--}}}-->
+    <resource relative="positions"> <!--{{{-->
+      <get out="positions"/>
+      <post in="position" out="id"/>
+      <patch in="positions"/>
+      <put in="positions"/>
+      <resource>
+        <get out="detail"/>
+        <put in="detail"/>
+        <delete/>
+        <resource relative="@passthrough">
+          <get out="string"/>
+        </resource>
+      </resource>
+    </resource> <!--}}}-->
+    <resource relative="dataelements"> <!--{{{-->
+      <get out="dataelements"/>
+      <post in="dataelement" out="id"/>
+      <patch in="dataelements"/>
+      <put in="dataelements"/>
+      <resource>
+        <get out="string"/>
+        <put in="string"/>
+        <delete/>
+      </resource>
+    </resource> <!--}}}-->
+    <resource relative="endpoints"> <!--{{{-->
+      <get out="endpoints"/>
+      <post in="endpoint" out="id"/>
+      <patch in="endpoints"/>
+      <put in="endpoints"/>
+      <resource>
+        <get out="string"/>
+        <put in="string"/>
+        <delete/>
+      </resource>
+    </resource> <!--}}}-->
+    <resource relative="attributes"> <!--{{{-->
+      <get out="attributes"/>
+      <post in="attribute" out="id"/>
+      <patch in="attributes"/>
+      <put in="attributes"/>
+      <resource>
+        <get out="string"/>
+        <put in="string"/>
+        <delete/>
+      </resource>
+    </resource> <!--}}}-->
+
+    <resource relative="dsl"> <!--{{{-->
+      <get out="dsl"/>
+    </resource> <!--}}}-->
+    <resource relative="dslx"> <!--{{{-->
+      <get out="dslx"/>
+    </resource> <!--}}}-->
+    <resource relative="description"> <!--{{{-->
+      <get out="description"/>
+      <put in="description"/>
+    </resource> <!--}}}-->
+
+    <resource relative="transformation"> <!--{{{-->
+      <get out="transformation"/>
+      <put in="transformation"/>
+    </resource> <!--}}}-->
+  </resource>
+</description>