Class: DefaultHandlerWrapper

Inherits:
WEEL::HandlerWrapperBase
  • Object
show all
Defined in:
lib/cpee-handlerwrapper-opcua.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arguments, position = nil, continue = nil) ⇒ DefaultHandlerWrapper

}}}



41
42
43
44
45
46
47
48
49
50
# File 'lib/cpee-handlerwrapper-opcua.rb', line 41

def initialize(arguments,position=nil,continue=nil) # {{{
  @controller = arguments[0]
  @handler_continue = continue
  @handler_position = position
  @handler_passthrough = nil
  @handler_returnValue = nil
  @handler_returnOptions = nil
  @handler_activity_uuid = Digest::MD5.hexdigest(Kernel::rand().to_s)
  @label = ''
end

Class Method Details

.inform_handlerwrapper_error(arguments, err) ⇒ Object

}}}



28
29
30
31
# File 'lib/cpee-handlerwrapper-opcua.rb', line 28

def self::inform_handlerwrapper_error(arguments,err) # {{{
  controller = arguments[0]
  controller.notify("handlerwrapper/error", :instance => controller.instance, :instance_uuid => controller.uuid, :message => err.message, :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
end

.inform_position_change(arguments, ipc = {}) ⇒ Object

}}}



32
33
34
35
36
37
38
39
# File 'lib/cpee-handlerwrapper-opcua.rb', line 32

def self::inform_position_change(arguments,ipc={}) # {{{
  controller = arguments[0]
  controller.serialize_positions!
  ipc[:instance] = controller.instance
  ipc[:instance_uuid] = controller.uuid
  ipc[:timestamp] = Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z")
  controller.notify("position/change", ipc)
end

.inform_state_change(arguments, newstate) ⇒ Object

{{{



18
19
20
21
22
23
# File 'lib/cpee-handlerwrapper-opcua.rb', line 18

def self::inform_state_change(arguments,newstate) # {{{
  controller = arguments[0]
controller.serialize_state!
controller.notify("state/change", :instance => controller.instance, :instance_uuid => controller.uuid, :state => newstate, :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
controller.finalize_if_finished
end

.inform_syntax_error(arguments, err, code) ⇒ Object

}}}



24
25
26
27
# File 'lib/cpee-handlerwrapper-opcua.rb', line 24

def self::inform_syntax_error(arguments,err,code)# {{{
  controller = arguments[0]
  controller.notify("description/error", :instance => controller.instance, :instance_uuid => controller.uuid, :message => err.message, :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
end

Instance Method Details

#activity_handle(passthrough, parameters) ⇒ Object

{{{



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/cpee-handlerwrapper-opcua.rb', line 200

def activity_handle(passthrough, parameters) # {{{
  raise "Wrong endpoint" if @handler_endpoint.nil? || @handler_endpoint.empty?
  @label = parameters[:label]
  @sensors = parameters.dig(:stream,:sensors)
  @aggregators = parameters.dig(:stream,:aggregators)
  @costs = parameters.dig(:stream,:costs)
  @controller.notify("activity/calling", :activity_uuid => @handler_activity_uuid, :instance => @controller.instance, :instance_uuid => @controller.uuid, :label => @label, :instance_name => @controller.info, :activity => @handler_position, :passthrough => passthrough, :endpoint => @handler_endpoint, :parameters => parameters, :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated)
  if passthrough.to_s.empty?
    if @handler_endpoint.start_with?('opc.tcp')
      proto_opcua parameters
    else
      proto_curl parameters
    end
  else
    @controller.callbacks[passthrough] = CPEE::Callback.new("callback activity: #{@handler_position}",self,:callback,nil,nil,:http)
    @handler_passthrough = passthrough
  end
end

#activity_manipulate_handle(parameters) ⇒ Object

}}}



218
219
220
# File 'lib/cpee-handlerwrapper-opcua.rb', line 218

def activity_manipulate_handle(parameters) #{{{
  @label = parameters[:label]
end

#activity_no_longer_necessaryObject

}}}



238
239
240
# File 'lib/cpee-handlerwrapper-opcua.rb', line 238

def activity_no_longer_necessary # {{{
  true
end

#activity_passthrough_valueObject

}}}



234
235
236
# File 'lib/cpee-handlerwrapper-opcua.rb', line 234

def activity_passthrough_value # {{{
  @handler_passthrough
end

#activity_result_optionsObject

}}}



225
226
227
# File 'lib/cpee-handlerwrapper-opcua.rb', line 225

def activity_result_options # {{{
  @handler_returnOptions
end

#activity_result_valueObject

}}}



222
223
224
# File 'lib/cpee-handlerwrapper-opcua.rb', line 222

def activity_result_value # {{{
  @handler_returnValue
end

#activity_stopObject

}}}



229
230
231
232
233
# File 'lib/cpee-handlerwrapper-opcua.rb', line 229

def activity_stop # {{{
  unless @handler_passthrough.nil?
    @controller.callbacks.delete(@handler_passthrough)
  end
end

#additionalObject

}}}



70
71
72
# File 'lib/cpee-handlerwrapper-opcua.rb', line 70

def additional
  { :attributes => @controller.attributes_translated } rescue {}
end

#callback(result = nil, options = {}) ⇒ Object



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/cpee-handlerwrapper-opcua.rb', line 330

def callback(result=nil,options={})
  @controller.notify("activity/receiving", :activity_uuid => @handler_activity_uuid, :instance => @controller.instance, :label => @label, :instance_name => @controller.info, :instance_uuid => @controller.uuid, :activity => @handler_position, :endpoint => @handler_endpoint, :received => structurize_result(result), :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated, :sensors => @sensors, :aggregators => @aggregators, :costs => @costs)
  result = simplify_result(result)
  @handler_returnValue = result
  @handler_returnOptions = options
  if options['CPEE_UPDATE']
    if options['CPEE_UPDATE_STATUS']
      @controller.notify("activity/status", :activity_uuid => @handler_activity_uuid, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :endpoint => @handler_endpoint, :status => options['CPEE_UPDATE_STATUS'], :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated)
    end
    @handler_continue.continue WEEL::Signal::Again
  else
    @controller.callbacks.delete(@handler_passthrough)
    @handler_passthrough = nil
    if options['CPEE_SALVAGE']
      @handler_continue.continue WEEL::Signal::Salvage
    else
      @handler_continue.continue
    end
  end
end

#inform_activity_doneObject

}}}



242
243
244
# File 'lib/cpee-handlerwrapper-opcua.rb', line 242

def inform_activity_done # {{{
  @controller.notify("activity/done", :activity_uuid => @handler_activity_uuid, :endpoint => @handler_endpoint, :instance => @controller.instance, :label => @label, :instance_name => @controller.info, :instance_uuid => @controller.uuid, :activity => @handler_position, :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated)
end

#inform_activity_failed(err) ⇒ Object

}}}



248
249
250
251
252
# File 'lib/cpee-handlerwrapper-opcua.rb', line 248

def inform_activity_failed(err) # {{{
  puts err.message
  puts err.backtrace
  @controller.notify("activity/failed", :activity_uuid => @handler_activity_uuid, :endpoint => @handler_endpoint, :label => @label, :instance_name => @controller.info, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :message => err.message, :line => err.backtrace[0].match(/(.*?):(\d+):/)[2], :where => err.backtrace[0].match(/(.*?):(\d+):/)[1], :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated)
end

#inform_activity_manipulateObject

}}}



245
246
247
# File 'lib/cpee-handlerwrapper-opcua.rb', line 245

def inform_activity_manipulate # {{{
  @controller.notify("activity/manipulating", :activity_uuid => @handler_activity_uuid, :endpoint => @handler_endpoint, :instance => @controller.instance, :label => @label, :instance_name => @controller.info, :instance_uuid => @controller.uuid, :activity => @handler_position, :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated)
end

#inform_manipulate_change(status, changed_dataelements, changed_endpoints, dataelements, endpoints) ⇒ Object

}}}



253
254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'lib/cpee-handlerwrapper-opcua.rb', line 253

def inform_manipulate_change(status,changed_dataelements,changed_endpoints,dataelements,endpoints) # {{{
  unless status.nil?
    @controller.serialize_status!
    @controller.notify("status/change", :activity_uuid => @handler_activity_uuid, :endpoint => @handler_endpoint, :label => @label, :instance_name => @controller.info, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :id => status.id, :message => status.message, :attributes => @controller.attributes_translated, :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
  end
  unless changed_dataelements.nil?
    @controller.serialize_dataelements!
    @controller.notify("dataelements/change", :activity_uuid => @handler_activity_uuid, :endpoint => @handler_endpoint, :label => @label, :instance_name => @controller.info, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :changed => changed_dataelements, :values => dataelements, :attributes => @controller.attributes_translated, :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
  end
  unless changed_endpoints.nil?
    @controller.serialize_endpoints!
    @controller.notify("endpoints/change", :activity_uuid => @handler_activity_uuid, :endpoint => @handler_endpoint, :label => @label, :instance_name => @controller.info, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :changed => changed_endpoints, :values => endpoints, :attributes => @controller.attributes_translated, :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
  end
end

#prepare(readonly, endpoints, parameters, replay = false) ⇒ Object

}}}



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/cpee-handlerwrapper-opcua.rb', line 52

def prepare(readonly, endpoints, parameters, replay=false) #{{{
  if replay
    @handler_endpoint = @controller.attributes[:replayer]
  else
    @handler_endpoint = endpoints.is_a?(Array) ? endpoints.map{ |ep| readonly.endpoints[ep] }.compact : readonly.endpoints[endpoints]
  end
  params = parameters.dup
  params[:arguments] = params[:arguments].dup if params[:arguments]
  params[:arguments]&.map! do |ele|
    t = ele.dup
    if t.value.is_a?(Proc)
      t.value = readonly.instance_exec &t.value
    end
    t
  end
  params
end

#proto_curl(parameters) ⇒ Object

{{{



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/cpee-handlerwrapper-opcua.rb', line 74

def proto_curl(parameters) #{{{
  params = []
  callback = Digest::MD5.hexdigest(Kernel::rand().to_s)
  (parameters[:arguments] || []).each do |s|
    if s.respond_to?(:mimetype)
      params <<  Riddl::Parameter::Complex.new(s.name.to_s,v.mimetype,v.value)
    else
      if s.name.to_s =~ /^_Q_/
        params <<  Riddl::Parameter::Simple.new(s.name.to_s.sub(/^_Q_/,''),CPEE::ValueHelper::generate(s.value),:query)
      elsif s.name.to_s =~ /^_B_/
        params <<  Riddl::Parameter::Simple.new(s.name.to_s.sub(/^_B_/,''),CPEE::ValueHelper::generate(s.value),:body)
      elsif s.name.to_s =~ /^_H_/
        params <<  Riddl::Header.new(s.name.to_s.sub(/^_H_/,''),CPEE::ValueHelper::generate(s.value))
      elsif s.name.to_s =~ /^_C_/
        params <<  Riddl::Parameter::Complex.new(s.name.to_s.sub(/^_C_/,''),*CPEE::ValueHelper::generate(s.value).split(';',2))
      else
        params <<  Riddl::Parameter::Simple.new(s.name.to_s,CPEE::ValueHelper::generate(s.value))
      end
    end
  end

  params << Riddl::Header.new("CPEE-BASE",@controller.base_url)
  params << Riddl::Header.new("CPEE-INSTANCE",@controller.instance)
  params << Riddl::Header.new("CPEE-INSTANCE-URL",@controller.instance_url)
  params << Riddl::Header.new("CPEE-INSTANCE-UUID",@controller.uuid)
  params << Riddl::Header.new("CPEE-CALLBACK",@controller.instance_url + '/callbacks/' + callback)
  params << Riddl::Header.new("CPEE-CALLBACK-ID",callback)
  params << Riddl::Header.new("CPEE-ACTIVITY",@handler_position)
  params << Riddl::Header.new("CPEE-LABEL",@label||'')
  params << Riddl::Header.new("CPEE-REPLAY",@controller.attributes['replayer_args'])
  @controller.attributes.each do |key,value|
    params << Riddl::Header.new("CPEE-ATTR-#{key.to_s.gsub(/_/,'-')}",value)
  end

  tendpoint = @handler_endpoint.sub(/^http(s)?-(get|put|post|delete):/,'http\\1:')
  type = $2 || parameters[:method] || 'post'

  client = Riddl::Client.new(tendpoint)

  @controller.callbacks[callback] = CPEE::Callback.new("callback activity: #{@handler_position}",self,:callback,nil,nil,:http)
  @handler_passthrough = callback

  status, result, headers = client.request type => params
  if status < 200 || status >= 300
    headers['CPEE_SALVAGE'] = true
    c = result[0]&.value
    c = c.read if c.respond_to? :read
    callback([ Riddl::Parameter::Complex.new('error','application/json',StringIO.new(JSON::generate({ 'status' => status, 'error' => c }))) ], headers)
  else
    if headers['CPEE_INSTANTIATION']
      @controller.notify("task/instantiation", :activity_uuid => @handler_activity_uuid, :instance => @controller.instance, :label => @label, :instance_name => @controller.info, :instance_uuid => @controller.uuid, :activity => @handler_position, :endpoint => @handler_endpoint, :received => CPEE::ValueHelper.parse(headers['CPEE_INSTANTIATION']), :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated)
    end
    if headers['CPEE_CALLBACK'] && headers['CPEE_CALLBACK'] == 'true' && result.any?
      headers['CPEE_UPDATE'] = true
      callback result, headers
    elsif headers['CPEE_CALLBACK'] && headers['CPEE_CALLBACK'] == 'true' && result.empty?
      # do nothing, later on things will happend
    else
      callback result, headers
    end
  end
end

#proto_opcua(parameters) ⇒ Object

}}}



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
# File 'lib/cpee-handlerwrapper-opcua.rb', line 137

def proto_opcua(parameters)
  if @handler_endpoint =~ /^opc\.tcp-read:\/\/([^\/]+)\/(\d+)\/(.+)/
    nid = $3 == $3.to_i.to_s ? $3.to_i : $3
    ns  = $2
    url = 'opc.tcp://' + $1
    begin
      client = OPCUA::Client.new(url)
      if (node = client.get ns.to_i, nid)
        result = node.value
      else
        raise 'invalid nodeid'
      end
      client.disconnect
      callback [Riddl::Parameter::Simple.new('value',result)], {}
    rescue => e
      callback([ Riddl::Parameter::Complex.new('error','application/json',StringIO.new(JSON::generate({ 'status' => 0, 'error' => e.message }))) ], 'CPEE_SALVAGE' => true)
    end
  elsif @handler_endpoint =~ /^opc\.tcp-write:\/\/([^\/]+)\/(\d+)\/([^\?]+)(\?value=(.*))?/
    nid = $3 == $3.to_i.to_s ? $3.to_i : $3
    ns  = $2
    par = $5
    url = 'opc.tcp://' + $1
    begin
      client = OPCUA::Client.new(url)
      if (node = client.get ns.to_i, nid)
        (parameters[:arguments] || [

#simplify_result(result) ⇒ Object

}}}



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# File 'lib/cpee-handlerwrapper-opcua.rb', line 275

def simplify_result(result)
  if result.length == 1
    if result[0].is_a? Riddl::Parameter::Simple
      result = result[0].value
    elsif result[0].is_a? Riddl::Parameter::Complex
      if result[0].mimetype == 'application/json'
        result = JSON::parse(result[0].value.read) rescue nil
      elsif result[0].mimetype == 'application/xml' || result[0].mimetype == 'text/xml'
        result = XML::Smart::string(result[0].value.read) rescue nil
      elsif result[0].mimetype == 'text/plain'
        result = result[0].value.read
        if result.start_with?("<?xml version=")
          result = XML::Smart::string(result)
        else
          result = result.to_f if result == result.to_f.to_s
          result = result.to_i if result == result.to_i.to_s
        end
      elsif result[0].mimetype == 'text/html'
        result = result[0].value.read
        result = result.to_f if result == result.to_f.to_s
        result = result.to_i if result == result.to_i.to_s
      else
        result = result[0]
      end
    end
  end
  result
end

#simulate(type, nesting, tid, parent, parameters = {}) ⇒ Object

{{{



357
358
359
360
361
362
363
364
365
366
367
368
369
370
# File 'lib/cpee-handlerwrapper-opcua.rb', line 357

def simulate(type,nesting,tid,parent,parameters={}) #{{{
  pp "#{type} - #{nesting} - #{tid} - #{parent} - #{parameters.inspect}"

  @controller.call_vote("simulating/step",
    :endpoint => @handler_endpoint,
    :instance => @controller.instance,
    :instance_uuid => @controller.uuid,
    :activity => tid,
    :type => type,
    :nesting => nesting,
    :parent => parent,
    :parameters => parameters
  )
end

#structurize_result(result) ⇒ Object



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'lib/cpee-handlerwrapper-opcua.rb', line 304

def structurize_result(result)
  result.map do |r|
    if r.is_a? Riddl::Parameter::Simple
      { 'name' => r.name, 'data' => r.value }
    elsif r.is_a? Riddl::Parameter::Complex
      res = if r.mimetype == 'application/json'
        JSON::parse(r.value.read) rescue nil
      elsif r.mimetype == 'text/plain' || r.mimetype == 'text/html'
        ttt = r.value.read
        ttt = ttt.to_f if ttt == ttt.to_f.to_s
        ttt = ttt.to_i if ttt == ttt.to_i.to_s
        ttt
      else
        r.value.read
      end
      tmp = {
        'name' => r.name == '' ? 'result' : r.name,
        'mimetype' => r.mimetype,
        'data' => res
      }
      r.value.rewind
      tmp
    end
  end
end

#test_condition(mr, code) ⇒ Object



351
352
353
354
355
# File 'lib/cpee-handlerwrapper-opcua.rb', line 351

def test_condition(mr,code)
  res = mr.instance_eval(code)
  @controller.notify("condition/eval", :instance => @controller.instance, :instance_uuid => @controller.uuid, :code => code, :condition => (res ? "true" : "false"), :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"), :attributes => @controller.attributes_translated)
  res
end

#vote_sync_afterObject

}}}



268
269
270
# File 'lib/cpee-handlerwrapper-opcua.rb', line 268

def vote_sync_after # {{{
  @controller.call_vote("activity/syncing_after", :activity_uuid => @handler_activity_uuid, :endpoint => @handler_endpoint, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
end

#vote_sync_before(parameters = nil) ⇒ Object

}}}



271
272
273
# File 'lib/cpee-handlerwrapper-opcua.rb', line 271

def vote_sync_before(parameters=nil) # {{{
  @controller.call_vote("activity/syncing_before", :activity_uuid => @handler_activity_uuid, :endpoint => @handler_endpoint, :instance => @controller.instance, :instance_uuid => @controller.uuid, :activity => @handler_position, :parameters => parameters, :timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%:z"))
end