Class: OmfRc::ResourceProxy::AbstractResource

746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 746

def check_guard(message)
  guard = message.guard

  if guard.nil? || guard.empty?
    return true
  else
    guard.keys.all? do |key|
      value = self.__send__("request_#{key}")
      if value.kind_of? Symbol
        value.to_s == guard[key].to_s
      else
        value == guard[key]
      end
    end
  end
end

400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 400

def configure_membership(*args)
  case args[0]
  when Symbol, String, Array
    new_membership = [args[0]].flatten.compact
  when Hash
    leave_membership = [args[0][:leave]].flatten.compact
    only_membership = [args[0][:only]].flatten.compact
  end

  new_membership && new_membership.each do |new_m|
    unless @membership.include?(new_m)
      OmfCommon.comm.subscribe(new_m, routing_key: "o.op") do |t|
        if t.error?
          warn "Group #{new_m} disappeared"
          self.synchronize do
            @membership.delete(m)
          end
        else
          self.synchronize do
            @membership << new_m
            @membership_topics[new_m] = t
            self.inform(:status, { membership: @membership }, t)
          end

          t.on_message(@uid) do |imsg|
            process_omf_message(imsg, t)
          end
        end
      end
    end
  end

  leave_membership && leave_membership.each do |leave_m|
    if (leave_m_topic = @membership_topics[leave_m])
      self.synchronize do
        leave_m_topic.unsubscribe(leave_m)
        @membership.delete(leave_m)
        @membership_topics.delete_if { |k, v| k == leave_m }
      end
    end
  end

  unless only_membership.nil? || only_membership.empty?
    configure_membership({ leave: @membership })
    configure_membership(only_membership)
  end

  @membership
end

455
456
457

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 455

def configure_res_index(index)
  @res_index = index
end

234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 234

def create(type, opts = {}, creation_opts = {}, &creation_callback)
  unless request_supported_children_type.include?(type.to_sym)
    raise StandardError, "Resource #{type} is not designed to be created by #{self.type}"
  end

  opts[:parent_certificate] = @certificate if @certificate
  opts[:parent] = self

  call_hook(:before_create, self, type, opts)

  new_resource = OmfRc::ResourceFactory.create(type.to_sym, opts, creation_opts, &creation_callback)

  log_metadata(self.uid, new_resource.uid, :create)

  call_hook(:after_create, self, new_resource)

  self.synchronize do
    children << new_resource
  end
  new_resource
end

201
202
203
204

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 201

def defaults(key = nil)
  d = @@defaults[@type] || {}
  key ? d[key] : d
end

226
227
228

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 226

def disconnect
  OmfCommon.comm.disconnect
end

490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 490

def execute_omf_operation(message, obj, topic)
  begin
    response_h = handle_message(message, obj)
  rescue  => ex
    err_resp = message.create_inform_reply_message(nil, {}, src: resource_address)
    err_resp[:reason] = ex.to_s
    error "Encountered exception, returning ERROR message"
    debug ex.message
    debug ex.backtrace.join("\n")
    return inform(:error, err_resp, topic)
  end

  case message.operation
  #when :create
  #  inform(:creation_ok, response_h, topic)
  when :request, :configure
    inform(:status, response_h, topic)
  when :release
    OmfCommon.eventloop.after(RELEASE_WAIT) do
      inform(:released, response_h, topic) if response_h[:res_id]
    end
  end
end

221
222
223

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 221

def get_binding
  binding
end

583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 583

def handle_configure_message(message, obj, response)
  conf_properties = message.properties
  conf_result = Hashie::Mash.new

  call_hook(:pre_configure, obj, conf_properties, conf_result)

  if obj.respond_to?(:configure_all)
    obj.configure_all(conf_properties, conf_result)
  else
    conf_properties.each do |key, value|
      method_name = "configure_#{key}"
      conf_result[key] = obj.__send__(method_name, value)
    end
  end

  call_hook(:post_configure, obj, conf_properties, conf_result)

  conf_result.each do |key, value|
    if namespaced_property?(key)
      response[key, namespace] = value
    else
      response[key] = value
    end
  end
end

550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 550

def handle_create_message(message, obj, response)
  new_name = message[:name] || message[:hrn]
  msg_props = message.properties.merge({ hrn: new_name })

  obj.create(message[:type], msg_props, &lambda do |new_obj|
    begin
      response[:res_id] = new_obj.resource_address
      response[:uid] = new_obj.uid

      # Getting property status, for preparing inform msg
      add_prop_status_to_response(new_obj, msg_props.keys, response)

      if (cred = new_obj.certificate)
        response[:cert] = cred.to_pem_compact
      end
      # self here is the parent
      self.inform(:creation_ok, response)
    rescue  => ex
      err_resp = message.create_inform_reply_message(nil, {}, src: resource_address)
      err_resp[:reason] = ex.to_s
      error "Encountered exception, returning ERROR message"
      debug ex.message
      debug ex.backtrace.join("\n")
      return self.inform(:error, err_resp)
    end
  end)
end

518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 518

def handle_message(message, obj)
  # We really don't care about inform messages which created from here
  return nil if message.operation == :inform

  unless [:create, :request, :configure, :release].include?(message.operation)
    raise StandardError, <<-ERROR
      Invalid message received (Unknown OMF operation #{message.operation}): #{message}.
      Please check protocol schema of version #{OmfCommon::PROTOCOL_VERSION}.
    ERROR
  end

  response = message.create_inform_reply_message(nil, {}, src: resource_address)
  response.replyto = replyto_address(obj, message.replyto)

  case message.operation
  when :create
    handle_create_message(message, obj, response)
  when :request
    handle_request_message(message, obj, response)
  when :configure
    handle_configure_message(message, obj, response)
  when :release
    handle_release_message(message, obj, response)
  end
  response
end

640
641
642
643
644
645
646
647
648
649

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 640

def handle_release_message(message, obj, response)
  res_id = message.res_id
  released_obj = obj.release(res_id)
  # TODO: Under what circumstances would 'realease_obj' be NIL
  #
  # When release message send to a group, for bulk releasing,
  # the proxy might not be aware of a res_id it received
  response[:res_id] = released_obj.resource_address if released_obj
  response
end

614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 614

def handle_request_message(message, obj, response)
  request_props = if message.has_properties?
                    message.properties.keys.map(&:to_sym) & obj.request_available_properties.request
                  else
                    # Return ALL props when nothing specified
                    obj.request_available_properties.request
                  end

  request_props.each do |p_name|
    method_name = "request_#{p_name.to_s}"
    value = obj.__send__(method_name)
    if value
      if namespaced_property?(p_name)
        response[p_name, namespace] = value
      else
        response[p_name] = value
      end
    end
  end
end

657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 657

def inform(itype, inform_data, topic = nil)
  inform_data = inform_data.dup # better make a copy
  unless address = resource_address
    OmfCommon.eventloop.after(1) do
      # try again in a bit and see if address has been set by then
      inform(itype, inform_data, topic = nil)
    end
    warn "INFORM message delayed as resource's address is not known yet"
    return
  end

  if inform_data.is_a? Hash
    inform_data = Hashie::Mash.new(inform_data) if inform_data.class == Hash
    #idata = inform_data.dup
    idata = {
      src: address,
      type: self.type  # NOTE: Should we add the object's type as well???
    }
    message = OmfCommon::Message.create_inform_message(itype.to_s.upcase, inform_data, idata)
  else
    message = inform_data
  end

  message.itype = itype
  unless itype == :released
    message[:hrn] ||= self.hrn if self.hrn
  end

  # Just send to all topics, including group membership
  (membership_topics.map { |mt| mt[1] } + @topics).each do |t|
    t.publish(message, { routing_key: "o.info" })
    OmfRc::ResourceProxy::MPPublished.inject(Time.now.to_f,
      self.uid, t.id, message.mid) if OmfCommon::Measure.enabled?
  end
end

702
703
704
705

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 702

def inform_creation_failed(reason)
  error reason
  inform :creation_failed, { reason: reason }
end

697
698
699
700

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 697

def inform_error(reason)
  error reason
  inform :error, { reason: reason }
end

693
694
695

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 693

def inform_status(props)
  inform :status, props
end

707
708
709
710

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 707

def inform_warn(reason)
  warn reason
  inform :warn, { reason: reason }
end

767
768
769
770
771
772
773
774
775
776
777
778
779

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 767

def init_configure(res_ctx, props)
  props.each do |key, value|
    if res_ctx.respond_to? "configure_#{key}"
      res_ctx.__send__("configure_#{key}", value)
    elsif res_ctx.respond_to? "initialise_#{key}"
      # For read only props, they won't have "configure" method defined,
      # we can still set them directly during this creation.
      res_ctx.__send__("initialise_#{key}", value)
    end
  end

  call_hook(:after_initial_configured, res_ctx)
end

804
805
806

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 804

def log_metadata(key, value, domain)
  OmfRc::MetaData.inject(domain.to_s, key.to_s, value.to_s)
end

800
801
802

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 800

def namespaced_property?(name)
  respond_to?(:namespace) && name =~ /^(.+)__(.+)$/
end

725
726
727
728
729
730
731
732

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 725

def objects_by_topic(name)
  if name == uid || membership.any? { |m| m.include?(name) }
    objs = [self]
  else
    objs = children.find_all { |v| v.uid == name || v.membership.any? { |m| m.include?(name) } }
  end
  objs
end

465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 465

def process_omf_message(message, topic)
  unless message.is_a? OmfCommon::Message
    raise ArgumentError, "Expected OmfCommon::Message, but got '#{message.class}'"
  end

  unless message.valid?
    raise StandardError, "Invalid message received: #{pubsub_item_payload}. Please check protocol schema of version #{OmfCommon::PROTOCOL_VERSION}."
  end

  return unless check_guard(message)
  # We really don't care about inform messages which created from here
  return nil if message.operation == :inform

  objects_by_topic(topic.id.to_s).each do |obj|
    OmfRc::ResourceProxy::MPReceived.inject(Time.now.to_f, self.uid,
      topic.id.to_s, message.mid) if OmfCommon::Measure.enabled?
    execute_omf_operation(message, obj, topic)
  end
end

259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 259

def release(res_id)
  if (child = children.find { |v| v.uid.to_s == res_id.to_s })
    if child.release_self()
      self.synchronize do
        children.delete(child)
      end
      child
    else
      child = nil
    end
    debug "#{child.uid} released"
  else
    debug "#{res_id} does not belong to #{self.uid}(#{self.hrn}) - #{children.map(&:uid).inspect}"
  end
  child
end

279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 279

def release_self
  # Release children resource recursively
  children.each do |c|
    if c.release_self
      self.synchronize do
        children.delete(c)
      end
    end
  end

  return false unless children.empty?

  info "Releasing hrn: #{hrn}, uid: #{uid}"

  call_hook(:before_release, self)

  props = {
    res_id: resource_address
  }
  props[:hrn] = hrn if hrn
  inform :released, props

  # clean up topics
  @topics.each do |t|
    t.unsubscribe(@uid)
  end

  @membership_topics.each_value do |t|
    if t.respond_to? :delete_on_message_cbk_by_id
      t.delete_on_message_cbk_by_id(@uid)
    end
    t.unsubscribe(@uid)
  end

  true
end

738
739
740

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 738

def replyto_address(obj, replyto = nil)
  replyto || obj.uid
end

333
334
335
336
337
338
339

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 333

def request_available_properties(*args)
  Hashie::Mash.new(request: [], configure: []).tap do |mash|
    methods.each do |m|
      mash[$1] << $2.to_sym if m =~ /^(request|configure)_(.+)/ && $2 != "available_properties"
    end
  end
end

373
374
375
376

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 373

def request_child_resources(*args)
  #children.map { |c| Hashie::Mash.new({ uid: c.uid, name: c.hrn }) }
  children.map { |c| c.to_hash }
end

352
353
354

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 352

def request_hrn(*args)
  hrn
end

361
362
363

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 361

def request_membership(*args)
  @membership
end

366
367
368

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 366

def request_res_index(*args)
  @res_index
end

321
322
323
324
325

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 321

def request_supported_children_type(*args)
  OmfRc::ResourceFactory.proxy_list.reject { |v| v == @type.to_s }.find_all do |k, v|
    (v.create_by && v.create_by.include?(@type.to_sym)) || v.create_by.nil?
  end.map(&:first).map(&:to_sym)
end

347
348
349

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 347

def request_type(*args)
  type
end

342
343
344

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 342

def request_uid(*args)
  uid
end

216
217
218

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 216

def resource_address
  resource_topic.address
end

207
208
209
210
211
212

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 207

def resource_topic
  if @topics.empty?
    raise TopicNotSubscribedError, "Resource '#{@uid}' has not subscribed to any topics"
  end
  @topics[0]
end

715
716
717

# File 'omf_rc/lib/omf_rc/resource_proxy/abstract_resource.rb', line 715

def to_hash
  { uid: @uid, address: resource_address() }
end