ClusterLabs/hawk

View on GitHub
hawk/app/models/record.rb

Summary

Maintainability
C
1 day
Test Coverage
# Copyright (c) 2009-2015 Tim Serong <tserong@suse.com>
# See COPYING for license.

class Record < Tableless
  attribute :id, String

  attr_accessor :xml

  validates :id,
    presence: { message: _("ID is required") },
    format: { with: /\A[a-zA-Z0-9_.-]+\z/, message: _("Invalid ID") }

  class << self
    # Check whether anything with the given ID exists, or for a specific element
    # with that ID if type is specified.
    #
    # FIXME: This is an outdated note, but how may it apply now? Will running
    # as a less privileged user mean that current_cib might not contain everything?
    #
    # Note that we run as hacluster, because we need to verify existence regardless
    # of whether the current user can actually see the object in quesion.
    def exists?(id, type = '*')
      !current_cib.match("//configuration//#{type}[@id='#{id}']").empty?
    end

    def find(id, attr = 'id')
      elems = current_cib.match "//configuration//*[self::node or self::primitive or self::template or self::clone or self::group or self::master or self::rsc_order or self::rsc_colocation or self::rsc_location or self::rsc_ticket or self::acl_role or self::acl_target or self::acl_user or self::tag or self::alert or self::bundle][@#{attr}='#{id}']"
      fail(Cib::RecordNotFound, _('Object not found: %s=%s') % [attr, id]) unless elems && elems[0]

      elem = elems[0]
      obj = class_from_element_name(elem.name).instantiate(elem)
      obj.id = elem.attributes['id']
      obj.xml = elem
      obj
    rescue SecurityError => e
      raise Cib::PermissionDenied, e.message
    rescue Cib::RecordNotFound => e
      raise Cib::RecordNotFound, e.message
    rescue RuntimeError => e
      raise Cib::CibError, e.message
    end

    # Return all objects of a given type.
    #
    # If get_children is true, the result is a flattened
    # list of objects of the given type and its children
    # (which may be of a different type)
    def all(get_children = false)
      elems = current_cib.match "//#{cib_type_fetch}"
      return [] if elems.empty?

      elems = elems[0].elements.to_a if class_from_element_name(elems[0].name).nil?

      [].tap do |result|
        elems.each do |elem|
          cls = class_from_element_name(elem.name)
          next unless cls
          obj = cls.instantiate(elem)
          obj.id = elem.attributes['id']
          obj.xml = elem
          result << obj
          result.concat Record.children_of(obj) if get_children
        end
      end
    rescue SecurityError => e
      raise Cib::PermissionDenied, e.message
    rescue Cib::RecordNotFound => e
      []
    rescue RuntimeError => e
      raise Cib::CibError, e.message
    end

    def children_of(rsc)
      [].tap do |result|
        if rsc.respond_to? :children
          rsc.children.each do |child|
            cr = Record.find(child)
            result.push cr
            result.concat Record.children_of(cr)
          end
        end
        if rsc.respond_to? :child
          cr = Record.find(rsc.child)
          result.push cr
          result.concat Record.children_of(cr)
        end
      end
    end

    def ordered
      all.sort do |a, b|
        a.id.natcmp(b.id, true)
      end
    end

    def help_text
      {}
    end

    def mapping
      {}
    end

    def cib_type
      nil
    end

    def cib_type_fetch
      cib_type
    end

    def cib_type_write
      cib_type
    end

    protected

    def class_from_element_name(name)
      @map ||= {
        node: Node,
        primitive: Primitive,
        template: Template,
        clone: Clone,
        group: Group,
        master: Master,
        rsc_order: Order,
        rsc_colocation: Colocation,
        rsc_location: Location,
        rsc_ticket: Ticket,
        acl_role: Role,
        acl_target: User,
        acl_user: User,
        tag: Tag,
        alert: Alert,
        bundle: Bundle
      }

      @map[name.to_sym]
    end
  end

  def merge_ocf_check_level(op, v)
    unless v
      # No OCF_CHECK_LEVEL set, remove it from the XML if present
      cl = op.elements['instance_attributes/nvpair[@name="OCF_CHECK_LEVEL"]']
      cl.remove if cl

      return
    end

    unless op.elements['instance_attributes']
      op.add_element(
        'instance_attributes',
        'id' => "#{op.attributes['id']}-instance_attributes")
    end

    nvp = op.elements['instance_attributes/nvpair[@name="OCF_CHECK_LEVEL"]']

    if nvp
      nvp.attributes['value'] = v
    else
      op.elements['instance_attributes'].add_element(
        'nvpair',
        'id' => "#{op.attributes['id']}-instance_attributes-OCF_CHECK_LEVEL",
        'name' => 'OCF_CHECK_LEVEL',
        'value' => v)
    end
  end

  def merge_operations(attrs)
    if attrs.empty?
      # No operations to set, get rid of the list (if it exists)
      xml.elements['operations'].remove if xml.elements['operations']
    else
      # Get rid of any operations that are no longer set
      if xml.elements['operations']
        xml.elements['operations'].elements.each do |el|
          if el.attributes['name'] == 'monitor'
            op_id = "#{el.attributes['name']}_#{el.attributes['interval']}"
            el.remove unless attrs[op_id]
          else
            el.remove unless attrs[el.attributes['name']]
          end
        end
      else
        xml.add_element 'operations'
      end

      # Write new operations or update existing ones
      attrs.each do |_op_id, attrlist|
        op_name = attrlist['name']
        attrlist['interval'] = '0' unless attrlist.keys.include?('interval')
        op = xml.elements["operations/op[@name=\"#{op_name}\" and @interval=\"#{attrlist["interval"]}\"]"]

        unless op
          op = xml.elements['operations'].add_element(
            "op",
            "id" => "#{xml.attributes["id"]}-#{op_name}-#{attrlist["interval"]}",
            "name" => op_name)
        end

        merge_ocf_check_level(op, attrlist.delete("OCF_CHECK_LEVEL"))
        op.attributes.each do |n, _v|
          op.attributes.delete(n) unless n == 'id' || n == 'name' || attrlist.keys.include?(n)
        end
        attrlist.each do |n, v|
          op.attributes[n] = v
        end
      end
    end
  end

  def merge_nvpairs(list, attrs)
    if attrs.empty?
      # No attributes to set, get rid of the list (if it exists)
      xml.elements[list].remove if xml.elements[list]
    else
      # Get rid of any attributes that are no longer set
      if xml.elements[list]
        xml.elements[list].elements.each do |el|
          el.remove unless attrs.keys.include? el.attributes['name']
        end
      else
        xml.add_element(
          list,
          "id" => "#{xml.attributes["id"]}-#{list}")
      end

      # Write new attributes or update existing ones
      attrs.each do |n, v|
        nvp = xml.elements["#{list}/nvpair[@name=\"#{n}\"]"]

        if nvp
          nvp.attributes["value"] = v
        else
          xml.elements[list].add_element(
            "nvpair",
            "id" => "#{xml.elements[list].attributes['id']}-#{n}",
            "name" => n,
            "value" => v)
        end
      end
    end
  end

  def crm_quote(str)
    if str.index("'")
      "\"#{str}\""
    else
      "'#{str}'"
    end
  end

  def unquotable?(str)
    str.to_s.index("'") && str.to_s.index('"')
  end

  def help_text
    self.class.help_text
  end

  def mapping
    self.class.mapping
  end

  protected

  def create
    if self.class.exists? id
      errors.add :base, _('The ID "%{id}" is already in use') % { id: id }
      return false
    end

    cli = shell_syntax

    Rails.logger.debug "crmsh syntax: #{cli}"

    _, err, rc = Invoker.instance.crm_configure cli

    return true if rc == 0
    errors.add :base, _('Unable to create: %{msg}') % { msg: err }
    false
  end

  def update
    unless self.class.exists? id, self.class.cib_type_write
      errors.add :base, _('The ID "%{id}" does not exist') % { id: id }
      return false
    end

    cli = shell_syntax

    Rails.logger.debug "crmsh syntax: #{cli}"

    out, err, rc = Invoker.instance.crm_configure_load_update cli
    return true if rc == 0
    errmsg = _('Error updating %{id} (rc=%{rc})') % { id: id, rc: rc }
    errmsg = err.to_s unless err.blank?
    errmsg = out.to_s unless out.blank?
    errors.add :base, errmsg
    false
  end
end