Changeset 174 for trunk/lib/ACL.inc.php

Timestamp:

Jun 18, 2006 8:50:35 AM (18 years ago)

Author:

scdev

Message:

Q - added move method to ACL class, added polish.

File:

• trunk/lib/ACL.inc.php (modified) (13 diffs)

trunk/lib/ACL.inc.php

@@ -6 +6 @@
 * Uses Modified Preorder Tree Traversal to maintain a tree-structure.
 * See: http://www.sitepoint.com/print/hierarchical-data-database
-* Includes a command-line tool for managing rights.
+* Includes a command-line tool for managing rights (codebase/bin/acl.cli.php).
 * 
 * Code by Strangecode :: www.strangecode.com :: This document contains copyrighted information.
@@ -29 +29 @@
 
     /**
-     * Prefs constructor.
+     * Constructor.
      */
     function ACL()
@@ -102 +102 @@
 
     /**
-     * Setup the database table for this class.
+     * Setup the database tables for this class.
      *
      * @access  public
@@ -192 +192 @@
 
     /*
-    * 
+    * Add a node to one of the aro/aco/axo tables.
     *
     * @access   public
-    * @param    
-    * @return   
+    * @param    string $name A unique identifier for the new node.
+    * @param    string $parent The name of the parent under-which to attach the new node.
+    * @param    string $type The tree to add to, one of: aro, aco, axo.
+    * @return   bool | int False on error, or the last_insert_id primary key of the new node.
     * @author   Quinn Comendant <quinn@strangecode.com>
     * @version  1.0
@@ -244 +246 @@
         // Select the rgt of $parent.
         $qid = $db->query("SELECT rgt FROM $tbl WHERE name = '" . $db->escapeString($parent) . "'");
-        if (!list($rgt) = mysql_fetch_row($qid)) {
+        if (!list($parent_rgt) = mysql_fetch_row($qid)) {
             $app->logMsg(sprintf('Cannot add %s node to nonexistant parent: %s', $type, $parent), LOG_WARNING, __FILE__, __LINE__);
             return false;
         }
+
         // Update transversal numbers for all nodes to the rgt of $parent.
-        $db->query("UPDATE $tbl SET lft = lft + 2 WHERE lft >= $rgt");
-        $db->query("UPDATE $tbl SET rgt = rgt + 2 WHERE rgt >= $rgt");
+        $db->query("UPDATE $tbl SET lft = lft + 2 WHERE lft >= $parent_rgt");
+        $db->query("UPDATE $tbl SET rgt = rgt + 2 WHERE rgt >= $parent_rgt");
         
         // Insert new node just below parent. Lft is parent's old rgt.
         $db->query("
             INSERT INTO $tbl (name, lft, rgt, added_datetime) 
-            VALUES ('" . $db->escapeString($name) . "', $rgt, $rgt + 1, NOW())
+            VALUES ('" . $db->escapeString($name) . "', $parent_rgt, $parent_rgt + 1, NOW())
         ");
 
@@ -263 +266 @@
 
     // Alias functions for the different object types.
-    function addARO($name, $parent=null)
+    function addRequestObject($name, $parent=null)
     {
         return $this->add($name, $parent, 'aro');
     }
-    function addACO($name, $parent=null)
+    function addControlObject($name, $parent=null)
     {
         return $this->add($name, $parent, 'aco');
     }
-    function addAXO($name, $parent=null)
+    function addXtraObject($name, $parent=null)
     {
         return $this->add($name, $parent, 'axo');
@@ -277 +280 @@
 
     /*
-    * 
+    * Remove a node from one of the aro/aco/axo tables.
     *
     * @access   public
-    * @param    
-    * @return   
+    * @param    string $name The identifier for the node to remove.
+    * @param    string $type The tree to modify, one of: aro, aco, axo.
+    * @return   bool | int False on error, or true on success.
     * @author   Quinn Comendant <quinn@strangecode.com>
     * @version  1.0
@@ -296 +300 @@
         case 'aro' :
             $tbl = 'aro_tbl';
+            $primary_key = 'aro_id';
             break;
         case 'aco' :
             $tbl = 'aco_tbl';
+            $primary_key = 'aco_id';
             break;
         case 'axo' :
             $tbl = 'axo_tbl';
+            $primary_key = 'axo_id';
             break;
         default :
@@ -315 +322 @@
         }
         
-        // Select the lft of $name
+        // Select the lft and rgt of $name to use for selecting children and reordering transversals.
         $qid = $db->query("SELECT lft, rgt FROM $tbl WHERE name = '" . $db->escapeString($name) . "'");
         if (!list($lft, $rgt) = mysql_fetch_row($qid)) {
@@ -322 +329 @@
         }
         
-        // Remove node and all children of node.
-        $db->query("DELETE FROM $tbl WHERE lft BETWEEN $lft AND $rgt");
+        // Remove node and all children of node, as well as acl_tbl links.
+        $db->query("
+            DELETE $tbl, acl_tbl 
+            FROM $tbl
+            LEFT JOIN acl_tbl ON ($tbl.$primary_key = acl_tbl.$primary_key)
+            WHERE $tbl.lft BETWEEN $lft AND $rgt
+        ");
         $num_deleted_nodes = mysql_affected_rows($db->getDBH());
 
@@ -335 +347 @@
     
     // Alias functions for the different object types.
-    function removeUser($name, $parent=null)
-    {
-        return $this->remove($name, $parent, 'aro');
-    }
-    function removeAction($name, $parent=null)
-    {
-        return $this->remove($name, $parent, 'aco');
-    }
-    function removeObject($name, $parent=null)
-    {
-        return $this->remove($name, $parent, 'axo');
+    function removeRequestObject($name)
+    {
+        return $this->remove($name, 'aro');
+    }
+    function removeControlObject($name)
+    {
+        return $this->remove($name, 'aco');
+    }
+    function removeXtraObject($name)
+    {
+        return $this->remove($name, 'axo');
+    }
+
+    /*
+    * Move a node to a new parent in one of the aro/aco/axo tables.
+    *
+    * @access   public
+    * @param    string $name The identifier for the node to remove.
+    * @param    string $new_parent The name of the parent under-which to attach the new node.
+    * @param    string $type The tree to modify, one of: aro, aco, axo.
+    * @return   bool | int False on error, or the last_insert_id primary key of the new node.
+    * @author   Quinn Comendant <quinn@strangecode.com>
+    * @version  1.0
+    * @since    14 Jun 2006 22:39:29
+    */
+    function move($name, $new_parent, $type)
+    {
+        $app =& App::getInstance();
+        $db =& DB::getInstance();
+        
+        $this->initDB();
+
+        switch ($type) {
+        case 'aro' :
+            $tbl = 'aro_tbl';
+            $primary_key = 'aro_id';
+            break;
+        case 'aco' :
+            $tbl = 'aco_tbl';
+            $primary_key = 'aco_id';
+            break;
+        case 'axo' :
+            $tbl = 'axo_tbl';
+            $primary_key = 'axo_id';
+            break;
+        default :
+            $app->logMsg(sprintf('Invalid access object type: %s', $type), LOG_ERR, __FILE__, __LINE__);
+            return false;
+            break;
+        }
+        
+        // If $parent is null, use root object.
+        if (is_null($parent)) {
+            $parent = 'root';
+        }
+        
+        // Ensure node and parent name aren't empty.
+        if ('' == trim($name) || '' == trim($parent)) {
+            $app->logMsg(sprintf('Cannot add node, parent (%s) or name (%s) missing.', $name, $parent), LOG_WARNING, __FILE__, __LINE__);
+            return false;
+        }
+        
+        // Select the lft and rgt of $name to use for selecting children and reordering transversals.
+        $qid = $db->query("SELECT lft, rgt FROM $tbl WHERE name = '" . $db->escapeString($name) . "'");
+        if (!list($lft, $rgt) = mysql_fetch_row($qid)) {
+            $app->logMsg(sprintf('Cannot delete nonexistant %s name: %s', $type, $name), LOG_NOTICE, __FILE__, __LINE__);
+            return false;
+        }
+        
+        // Total number of transversal values (that is, the count of self plus all children times two).
+        $total_transversal_value = ($rgt - $lft + 1);
+
+        // Select the rgt of the new parent.
+        $qid = $db->query("SELECT rgt FROM $tbl WHERE name = '" . $db->escapeString($new_parent) . "'");
+        if (!list($new_parent_rgt) = mysql_fetch_row($qid)) {
+            $app->logMsg(sprintf('Cannot move %s node to nonexistant parent: %s', $type, $new_parent), LOG_WARNING, __FILE__, __LINE__);
+            return false;
+        }
+        
+        // Ensure the new parent is not a child of the node being moved.
+        if ($new_parent_rgt <= $rgt && $new_parent_rgt >= $lft) {
+            $app->logMsg(sprintf('Cannot move %s node %s to parent %s because it is a child of itself.', $type, $name, $new_parent), LOG_WARNING, __FILE__, __LINE__);
+            return false;
+        }
+        
+        // Collect unique ids of all nodes being moved. The transversal numbers will become duplicated so these will be needed to identify these.
+        $qid = $db->query("
+            SELECT $primary_key
+            FROM $tbl
+            WHERE lft BETWEEN $lft AND $rgt
+            AND rgt BETWEEN $lft AND $rgt
+        ");
+        $ids = array();
+        while (list($id) = mysql_fetch_row($qid)) {
+            $ids[] = $id;
+        }
+
+        // Update transversal numbers for all nodes to the rgt of the node being moved, taking in to account the absence of it's children.
+        // This will temporarily "remove" the node from the tree, and its transversal values will be duplicated.
+        $db->query("UPDATE $tbl SET lft = lft - $total_transversal_value WHERE lft > $rgt");
+        $db->query("UPDATE $tbl SET rgt = rgt - $total_transversal_value WHERE rgt > $rgt");
+        // Apply transformation to new parent rgt also.
+        $new_parent_rgt = $new_parent_rgt > $rgt ? $new_parent_rgt - $total_transversal_value : $new_parent_rgt;
+        
+        // Update transversal values of moved node and children.
+        $db->query("
+            UPDATE $tbl SET 
+                lft = lft - ($lft - $new_parent_rgt),
+                rgt = rgt - ($lft - $new_parent_rgt)
+            WHERE $primary_key IN ('" . join("','", $ids) . "')
+        ");
+
+        // Update transversal values of all nodes to the rgt of moved node.
+        $db->query("UPDATE $tbl SET lft = lft + $total_transversal_value WHERE lft >= $new_parent_rgt AND $primary_key NOT IN ('" . join("','", $ids) . "')");
+        $db->query("UPDATE $tbl SET rgt = rgt + $total_transversal_value WHERE rgt >= $new_parent_rgt AND $primary_key NOT IN ('" . join("','", $ids) . "')");
+
+        die;
+        $app->logMsg(sprintf('Moved %s node %s to new parent %s.', $type, $name, $new_parent), LOG_DEBUG, __FILE__, __LINE__);
+        return true;
+    }
+    
+    // Alias functions for the different object types.
+    function moveRequestObject($name, $new_parent=null)
+    {
+        return $this->move($name, $new_parent, 'aro');
+    }
+    function moveControlObject($name, $new_parent=null)
+    {
+        return $this->move($name, $new_parent, 'aco');
+    }
+    function moveXtraObject($name, $new_parent=null)
+    {
+        return $this->move($name, $new_parent, 'axo');
     }
     
     /*
-    * 
+    * Add an entry to the acl_tbl to allow (or deny) a truple with the specified
+    * ARO -> ACO -> AXO entry.
     *
     * @access   public
-    * @param    
-    * @return   
+    * @param    string $aro Identifier of an existing ARO object.
+    * @param    string $aco Identifier of an existing ACO object (or null to use root).
+    * @param    string $axo Identifier of an existing AXO object (or null to use root).
+    * @return   bool False on error, true on success.
     * @author   Quinn Comendant <quinn@strangecode.com>
     * @version  1.0
@@ -397 +534 @@
 
     /*
-    * 
+    * Add an entry to the acl_tbl to deny a truple with the specified
+    * ARO -> ACO -> AXO entry. This calls the ACL::grant function to create the entry
+    * but uses 'deny' as the fourth argument.
     *
     * @access   public
-    * @param    
-    * @return   
+    * @param    string $aro Identifier of an existing ARO object.
+    * @param    string $aco Identifier of an existing ACO object (or null to use root).
+    * @param    string $axo Identifier of an existing AXO object (or null to use root).
+    * @return   bool False on error, true on success.
     * @author   Quinn Comendant <quinn@strangecode.com>
     * @version  1.0
@@ -412 +553 @@
     
     /*
-    * 
+    * Calculates the most specific cascading privilege found for a requested
+    * ARO -> ACO -> AXO entry. Returns FALSE if the entry is denied. By default, 
+    * all entries are denied, unless some point in the hierarchy is set ao "allow."
     *
     * @access   public
-    * @param    
-    * @return   
+    * @param    string $aro Identifier of an existing ARO object.
+    * @param    string $aco Identifier of an existing ACO object (or null to use root).
+    * @param    string $axo Identifier of an existing AXO object (or null to use root).
+    * @return   bool False if denied, true on allowed.
     * @author   Quinn Comendant <quinn@strangecode.com>
     * @version  1.0