Ruby-ACL 1.0.0

data/lib/ace.rb

@@ -0,0 +1,91 @@
+class Ace < ACL_Object
+  
+  def initialize(connector, col_path, report = false)
+    super(connector, col_path, report)
+    @doc = "doc(\"#{@col_path}acl.xml\")"
+  end
+  
+  private
+  def generate_expr(id, prin_id, acc_type, priv_id, res_ob_id)
+    expr = <<END
+    <Ace id="#{id}">
+      <Principal idref="#{prin_id}"/>
+      <accessType>#{acc_type}</accessType>
+      <Privilege idref="#{priv_id}"/>
+      <ResourceObject idref="#{res_ob_id}"/>
+    </Ace>
+END
+    return expr
+  end
+  
+  #finds ace's id by principal id, acc_type, privilege id, resource object id
+  def find_ace(prin_id, acc_type, priv_id, res_ob_id)   
+    query = "#{@doc}//#{self.class.name}s/descendant::*
+[Principal/@idref=\"#{prin_id}\" and accessType=\"#{acc_type}\" and 
+Privilege/@idref=\"#{priv_id}\" and ResourceObject/@idref=\"#{res_ob_id}\"]
+/string(@id)"
+    handle = @connector.execute_query(query)
+    hits = @connector.get_hits(handle)
+    case hits
+    when 1
+      ace_id = @connector.retrieve(handle, 0)
+      if(ace_id == "")   #eXist returns empty result => should return no result
+        return nil
+      else
+        return ace_id
+      end
+      
+    when 0
+      return nil
+    else
+      raise RubyACLExceptionRubyACLException.new(self.class.name, __method__,
+        "#{self.class.name} 
+Principal=\"#{prin_id}\" and accessType=\"#{acc_type}\" and 
+Privilege=\"#{priv_id}\" and ResourceObject=\"#{res_ob_id}\" 
+exists more then once. (#{hits}x)", 220), caller
+    end
+  rescue => e
+    raise e
+  end   #def find_ace
+  
+  protected
+  
+  public
+  def create_new(prin_id, acc_type, priv_id, res_ob_id)
+    if(acc_type == "deny" || acc_type == "allow")
+      id = find_ace(prin_id, acc_type, priv_id, res_ob_id)
+      if(id == nil) #this ace doesnt exist
+        id = "a" + Random.rand(1000000000).to_s
+        while(exists?(id))
+          id = "a" + Random.rand(1000000000).to_s
+        end
+        expr = generate_expr(id, prin_id, acc_type, priv_id, res_ob_id)
+        expr_loc = "#{@doc}//#{self.class.name}s/#{self.class.name}[last()]"
+        #puts expr_loc
+        @connector.update_insert(expr, "following", expr_loc)
+        if(exists?(id))
+          #puts "New #{self.class.name} \"#{name}\" created."
+          return id
+        else
+          puts "#{self.class.name} \"#{id}\" was not able to create."
+          raise RubyACLException.new(self.class.name, __method__, 
+            "#{self.class.name} \"#{id}\" was not able to create.", 221), caller
+          return nil
+        end
+      else #already exists
+        return id
+      end
+    else
+      raise RubyACLException.new(self.class.name, __method__, 
+        "Access type \"#{acc_type}\" is not allowed. Only allowed type is \"deny\" or \"allow\".", 222), caller
+      return nil
+    end
+  rescue => e
+    raise e
+  end   #def create_new  
+  
+  def rename()
+    raise RubyACLException.new(self.class.name, __method__, 
+      "Rename method is not supported for ACE.", 223), caller
+  end  
+end   #class Ace

data/lib/ace_rule.rb

@@ -0,0 +1,36 @@
+class AceRule
+  
+  attr_reader :prin
+  attr_reader :priv
+  attr_reader :res_obj
+  attr_reader :acc_type
+  
+  def initialize(ace_id, ace, connector)
+    @ace = ace
+    @connector = connector
+    reload!(ace_id)
+  rescue => e
+    raise e
+  end
+  
+  def reload!(ace_id)
+    query = "#{@ace.doc}//Ace[@id=\"#{ace_id}\"]/Principal/string(@idref)"
+    handle = @connector.execute_query(query)
+    @prin = @connector.retrieve(handle, 0)
+    
+    query = "#{@ace.doc}//Ace[@id=\"#{ace_id}\"]/Privilege/string(@idref)"
+    handle = @connector.execute_query(query)
+    @priv = @connector.retrieve(handle, 0)
+    
+    query = "#{@ace.doc}//Ace[@id=\"#{ace_id}\"]/ResourceObject/string(@idref)"
+    handle = @connector.execute_query(query)
+    @res_obj = @connector.retrieve(handle, 0)
+    
+    query = "#{@ace.doc}//Ace[@id=\"#{ace_id}\"]/accessType/text()"
+    #puts query
+    handle = @connector.execute_query(query)
+    @acc_type = @connector.retrieve(handle, 0)
+  rescue => e
+    raise e
+  end   #def reload!
+end   #class AceRule

data/lib/group.rb

@@ -0,0 +1,32 @@
+class Group < Principal
+  
+  def initialize(connector, col_path, report = false)
+    super(connector, col_path, report)
+  end
+  
+  private
+  
+  public
+  
+  def create_new(name, groups, members)
+    super(name, groups)
+    if(members.length > 0)    #add members into group
+      for member in members
+        add_membership(member, [name])
+      end
+    end
+  rescue => e
+    raise e
+  end
+  
+  def delete(name)
+    super(name)
+    
+    expr = "#{@doc}//node()[@idref=\"#{name}\"]"
+    @connector.update_delete(expr)
+    return name
+  rescue => e
+    raise e
+  end
+  
+end

data/lib/individual.rb

@@ -0,0 +1,14 @@
+class Individual < Principal
+  
+  def initialize(connector, col_path, report = false)
+    super(connector, col_path, report)
+  end
+  
+  public
+  def create_new(name, groups)
+    super(name, groups)
+  rescue => e
+    raise e
+  end
+end
+

data/lib/principal.rb

@@ -0,0 +1,44 @@
+class Principal < ACL_Object
+  def initialize(connector, col_path, report = false)
+    super(connector, col_path, report)
+    @doc = "doc(\"#{@col_path}Principals.xml\")"
+  end
+  
+  def eq (temp_ace, final_ace)
+    if(temp_ace.prin == final_ace.prin)
+      return true
+    else 
+      return false
+    end
+  end
+  
+  def ne (temp_ace, final_ace)
+    return !eq(temp_ace, final_ace)
+  end
+  
+  def delete(name)
+    super(name)
+    
+    expr = "#{@doc}//node()[@idref=\"#{name}\"]/parent::node()"
+    @connector.update_delete(expr)
+    return name
+  rescue => e
+    raise e
+  end
+  
+  def add_membership(name, groups, ob_exists = false)
+    ok = true
+    #Make sure that group is really group and not individual
+    for group in groups
+      if(!exists?(group, "#{@doc}//Group[@id=\"#{group}\"]"))
+        ok = false;
+      end
+    end
+    if(ok)
+      super(name, groups, ob_exists)
+    else
+      raise RubyACLException.new(self.class.name, __method__, 
+        "Failed to add membership. Group \"#{group}\" does not exist.", 113), caller
+    end
+  end
+end

data/lib/privilege.rb

@@ -0,0 +1,13 @@
+class Privilege < ACL_Object
+ 
+  def initialize(connector, col_path, report = false)
+    super(connector, col_path, report)
+    @doc = "doc(\"#{@col_path}Privileges.xml\")"
+  end
+  
+  def ge(temp_ace, final_ace, grid)
+    temp = grid.find_index(temp_ace.priv)
+    final = grid.find_index(final_ace.priv)
+    return super(temp, final)
+  end
+end

data/lib/resource_object.rb

@@ -0,0 +1,208 @@
+class ResourceObject < ACL_Object
+  def initialize(connector, col_path, report = false)
+    super(connector, col_path, report)
+    @doc = "doc(\"#{@col_path}ResourceObjects.xml\")"
+  end
+  
+  private
+  def generate_expr(id, type, address, owner)
+    expr = <<END
+    <#{self.class.name} id="#{id}">
+      <type>#{type}</type>
+      <address>#{address}</address>
+      <owner idref="#{owner}" />
+    </#{self.class.name}>
+END
+    return expr
+  end
+    
+  def parent(adr)
+    if(adr[-1] == "/")    #if last is "/" then delete it
+      adr = adr[0..-2]
+    end
+    pos = adr.rindex("/")
+    adr = adr[0..pos-1]
+    return adr
+  end
+  
+  def get_adr(res_ob_id)
+    query = "#{@doc}//node()[@id=\"#{res_ob_id}\"]/address/text()"
+    #puts query
+    handle = @connector.execute_query(query)
+    hits = @connector.get_hits(handle)
+    if(hits == 1)
+      adr = @connector.retrieve(handle, 0)
+    else
+      raise RubyACLException.new(self.class.name, __method__, 
+        "#{self.class.name}(id=\"#{res_ob_id}\") exists more then once. (#{hits}x)", 31), caller
+    end
+    return adr
+  rescue => e
+    raise e
+  end
+  
+  def get_type(res_ob_id)
+    query = "#{@doc}//node()[@id=\"#{res_ob_id}\"]/type/text()"
+    #puts query
+    handle = @connector.execute_query(query)
+    hits = @connector.get_hits(handle)
+    if(hits == 1)
+      type = @connector.retrieve(handle, 0)
+    else
+      raise RubyACLException.new(self.class.name, __method__, 
+        "#{self.class.name}(id=\"#{res_ob_id}\") exists more then once. (#{hits}x)", 32), caller
+    end
+    return type
+  rescue => e
+    raise e
+  end
+  
+  def change(type, address, what_is_changed, with_what)
+    address.delete!('(")')
+#    puts "type ,#{type},"
+#    puts "adr ,#{address},"
+    res_ob_id = find_res_ob(type, address)
+    if(res_ob_id.nil?)
+      raise RubyACLException.new(self.class.name, __method__, 
+        "Failed to change #{what_is_changed}. Resource objects doesn't exist.", 36), caller
+    end
+    if(what_is_changed == "owner")
+      expr = "#{@doc}//node()[@id=\"#{res_ob_id}\"]/#{what_is_changed}/@idref"
+    else
+      expr = "#{@doc}//node()[@id=\"#{res_ob_id}\"]/#{what_is_changed}/text()"  
+    end
+    expr_single = "\"#{with_what}\""
+    @connector.update_value(expr, expr_single)
+    if(what_is_changed == "type")
+      res_ob_id = find_res_ob(with_what, address)
+    end
+    if (what_is_changed == "address")
+      res_ob_id = find_res_ob(type, with_what)
+    end
+    if(what_is_changed == "owner")
+      expr = "#{@doc}//node()[@id=\"#{res_ob_id}\"]/#{what_is_changed}/string(@idref)"
+    end
+    handle = @connector.execute_query(expr)
+    hits = @connector.get_hits(handle)
+    if(hits == 1)
+      res = @connector.retrieve(handle, 0)
+      if(with_what == res)
+        puts "Change #{what_is_changed} succeeded." if @report
+      else
+        raise RubyACLException.new(self.class.name, __method__, 
+          "Failed to change #{what_is_changed}.", 34), caller
+      end
+    else
+      raise RubyACLException.new(self.class.name, __method__, 
+        "Failed to change #{what_is_changed}.", 34), caller
+    end
+    return type
+  rescue => e
+    raise e
+  end
+  
+  public
+  def create_new(type, address, owner)
+    address.delete!('(")')
+    id = find_res_ob(type, address)
+    if(id == nil) #this resOb doesnt exist
+      id = "r" + Random.rand(1000000000).to_s
+      while(exists?(id))
+        id = "r" + Random.rand(1000000000).to_s
+      end
+      expr = generate_expr(id, type, address, owner)
+      expr_loc = "#{@doc}//#{self.class.name}s/#{self.class.name}[last()]"
+      #puts expr_loc
+      @connector.update_insert(expr, "following", expr_loc)
+      if(exists?(id))
+        puts "New #{self.class.name} \"#{id}\" created." if @report
+        return id
+      else
+        raise RubyACLException.new(self.class.name, __method__, 
+          "#{self.class.name} type=\"#{type}\", address=\"#{address}\" was not able to create.", 33), caller
+      end
+    else #already exists
+      puts "#{self.class.name} \"#{id}\" was already created created." if @report
+      return id
+    end
+  end
+  
+  def find_res_ob(type, address)    #finds resource object's id by type and address
+    address.delete!('(")')
+    query = "#{@doc}//#{self.class.name}s/descendant::*[type=\"#{type}\" and address=\"#{address}\"]/string(@id)"
+    #puts query
+    handle = @connector.execute_query(query)
+    hits = @connector.get_hits(handle)
+    #puts hits
+    case hits
+    when 1
+      res_ob_id = @connector.retrieve(handle, 0)
+      if(res_ob_id == "")   #eXist returns empty result => should return no result
+        return nil
+      else
+        return res_ob_id
+      end
+      
+    when 0
+      return nil
+    else
+      raise RubyACLException.new(self.class.name, __method__, 
+        "#{self.class.name}(type=\"#{type}\", address=\"#{address}\") exists more then once. (#{hits}x)", 30), caller
+    end
+  end  
+  
+  def ge(temp_ace, final_ace, grid)
+    temp = grid.find_index(temp_ace.res_obj)
+    final = grid.find_index(final_ace.res_obj)
+    return super(temp, final)
+  end
+  
+  #finds membership parrent, e.g. dog's parrent is mammal
+  def find_res_ob_parents(res_ob_type, res_ob_adr)   
+    ids = Array.new    
+    while(res_ob_adr.rindex("/") != 0)
+      res_ob_adr = parent(res_ob_adr)
+      #puts res_ob_adr 
+      ids.push(find_res_ob(res_ob_type, res_ob_adr))      
+    end
+    #puts "ids #{ids.to_s}"
+    ids.compact!
+    #puts "ids #{ids.to_s}"
+    return ids
+  rescue => e
+    raise e
+  end
+  
+  #finds resOb, which ends with /*
+  def res_obs_grand2children(res_ob_ids)
+    ids = Array.new    
+    for res_ob_id in res_ob_ids
+      adr = get_adr(res_ob_id)
+      type = get_type(res_ob_id)
+      adr += "/*"  
+      ids.push(find_res_ob(type, adr))      
+    end
+    ids.compact!
+    return ids
+  rescue => e
+    raise e
+  end
+  
+  def rename()
+    raise RubyACLException.new(self.class.name, __method__, 
+      "Rename method is not supported for resource object", 35), caller
+  end
+  
+  def change_type(type, address, new_type)
+    change(type, address, "type", new_type)
+  end
+  
+  def change_address(type, address, new_address)
+    change(type, address, "address", new_address)
+  end
+  
+  def change_owner(type, address, new_owner)
+    change(type, address, "owner", new_owner)
+  end
+  
+end #class ResourceObject

data/lib/rubyacl_exception.rb

@@ -0,0 +1,69 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+class RubyACLException < RuntimeError
+  
+  @description
+  @number
+  
+  def initialize(called_class, called_method, _description = "Epic fail \n", _number = nil)
+    @clas = called_class
+    @method = called_method
+    @description = _description + "\n"
+    @number  = _number
+  end
+  def inspect
+    self.tostring
+  end
+
+  def to_s
+    self.tostring
+  end
+
+  def tostring
+    @number.to_s + ": " + method + "\n" + @description
+  end
+
+  def code
+    @number
+  end
+  
+  def method
+    return "#{@clas}.#{@method}"
+  end
+end
+
+#List of all exception. In brackets is method, that raise mentioned exception.
+
+#0: Name is empty                       (RubyACL.initialize)
+#1: Failed to create ACL in database    (RubyACL.create_acl_in_db)
+#2: Failed to set new name              (RubyACL.setname)
+  
+#110: Name is empty                      (ACL_Object.create_new)
+#111: ... already exist(s)               (ACL_Object.create_new)
+#112: ... was not able to create         (ACL_Object.create_new)
+#113: Failed to add membership. Group ... does not exist.    (ACL_Object.add_membership)
+#114: Failed to add membership. ... does not exist.          (ACL_Object.add_membership)
+#115: Failed to delete membership. Group ... does not exist. (ACL_Object.del_membership)
+#116: Failed to delete membership. ... does not exist.       (ACL_Object.del_membership)
+#117: Failed to delete ... ... does not exist.               (ACL_Object.delete)
+#118: Failed to add membership. Membership is in cycle.      (ACL_Object.add_membership)
+#119: Failed to rename ... ... already exists                (ACL_Object.rename)
+#120: Failed to rename.                                      (ACL_Object.rename)
+#121: 
+  
+#220: #{self.class.name}                                     (Ace.find_ace)
+#Principal=\"#{prin_id}\" and accessType=\"#{acc_type}\" and 
+#Privilege=\"#{priv_id}\" and ResourceObject=\"#{res_ob_id}\" 
+#exists more then once. (#{hits}x)
+#221: #{self.class.name} \"#{id}\" was not able to create.     (Ace.create_new)
+#222: Access type #{acc_type} is not allowed. Only allowed type is \"deny\" and \"allow\".   (Ace.create_new)
+#223: Rename method is not supported for ACE.                (Ace.rename)
+
+#30: "#{self.class.name}(type=\"#{type}\", address=\"#{address}\") exists more then once. (#{hits}x)"   (ResourceObject.find_res_ob)
+#31: "#{self.class.name}(id=\"#{res_ob_id}\") exists more then once. (#{hits}x)"     (ResourceObject.get_adr)
+#32: "#{self.class.name}(id=\"#{res_ob_id}\") exists more then once. (#{hits}x)"     (ResourceObject.get_type)
+#33: #{self.class.name} type=\"#{type}\", address=\"#{address}\" was not able to create.  (ResourceObject.create_new)
+#34: Failed to change owner.                               (ResourceObject.change)
+#35: Rename method is not supported for resource object     (ResourceObject.rename)
+#36: Failed to change #{what_is_changed}. Resource objects doesn't exist.   (ResourceObject.change)