This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  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 136 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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 
<?php
defined('C5_EXECUTE') or die("Access Denied.");

class Concrete5_Model_PermissionAccess extends Object {
    
    protected $paID;
    protected $paIDList = array();
    
    public function setPermissionKey($permissionKey) {
        $this->pk = $permissionKey;
    }
    
    public function getPermissionObject() {
        return $this->pk->getPermissionObject();
    }

    public function getPermissionObjectToCheck() {
        return $this->pk->getPermissionObjectToCheck();
    }
        
    public function getPermissionAccessID() {return $this->paID;}
    public function isPermissionAccessInUse() {return $this->paIsInUse;}
    
    protected function deliverAccessListItems($q, $accessType, $filterEntities) {
        $db = Loader::db();
        $class = str_replace('PermissionKey', 'PermissionAccessListItem', get_class($this->pk));
        if (!class_exists($class)) {
            $class = 'PermissionAccessListItem';
        }
        $filterString = $this->buildAssignmentFilterString($accessType, $filterEntities);
        $q = $q . ' ' . $filterString;
        $list = array();
        $r = $db->Execute($q);
        while ($row = $r->FetchRow()) {
            $obj = new $class();
            $obj->setPropertiesFromArray($row);
            if ($row['pdID']) {
                $obj->loadPermissionDurationObject($row['pdID']);
            }
            if ($row['peID']) {
                $obj->loadAccessEntityObject($row['peID']);
            }
            $list[] = $obj;
        }
        return $list;
    }
    
    public function validateAndFilterAccessEntities($accessEntities) {
        $entities = array();
        foreach($accessEntities as $ae) {
            if ($ae->validate($this)) {
                $entities[] = $ae;
            }
        }
        return $entities;
    }
    
    public function validateAccessEntities($accessEntities) {
        $valid = false;
        $accessEntities = $this->validateAndFilterAccessEntities($accessEntities);
        $list = $this->getAccessListItems(PermissionKey::ACCESS_TYPE_ALL, $accessEntities);
        $list = PermissionDuration::filterByActive($list);
        foreach($list as $l) {
            if ($l->getAccessType() == PermissionKey::ACCESS_TYPE_INCLUDE) {
                $valid = true;
            }
            if ($l->getAccessType() == PermissionKey::ACCESS_TYPE_EXCLUDE) {
                $valid = false;
            }
        }
        return $valid;
    }
    
    public function validate() {
        $u = new User();
        if ($u->isSuperUser()) {
            return true;
        }
        $accessEntities = $u->getUserAccessEntityObjects();
        return $this->validateAccessEntities($accessEntities);
    }
    
    public static function createByMerge($permissions) {
        $class = get_class($permissions[0]);
        $p = new $class();
        foreach($permissions as $px) {
            $p->paIDList[] = $px->getPermissionAccessID();
        }
        $p->pk = $permissions[0]->pk;
        $p->paID = -1;
        return $p;
    }
    
    public function getAccessListItems($accessType = PermissionKey::ACCESS_TYPE_INCLUDE, $filterEntities = array()) {
        if (count($this->paIDList) > 0) {
            $q = 'select paID, peID, pdID, accessType from PermissionAccessList where paID in (' . implode(',', $this->paIDList) . ')';
            return $this->deliverAccessListItems($q, $accessType, $filterEntities);
        } else {
            $filter = $accessType . ':';
            foreach($filterEntities as $pae) {
                $filter .= $pae->getAccessEntityID() . ':';
            }
            $filter = trim($filter, ':');
            $items = CacheLocal::getEntry('permission_access_list_items', $this->getPermissionAccessID() . $filter . strtolower(get_class($this->pk)));
            if (is_array($items)) {
                return $items;
            }               
            $q = 'select paID, peID, pdID, accessType from PermissionAccessList where paID = ' . $this->getPermissionAccessID();
            $items = $this->deliverAccessListItems($q, $accessType, $filterEntities);
            CacheLocal::set('permission_access_list_items', $this->getPermissionAccessID() . $filter . strtolower(get_class($this->pk)), $items);
            return $items;
        }
    }

    protected function buildAssignmentFilterString($accessType, $filterEntities) { 
        $peIDs = '';
        $filters = array();
        if (count($filterEntities) > 0) {
            foreach($filterEntities as $ent) {
                $filters[] = $ent->getAccessEntityID();
            }
            $peIDs .= 'and peID in (' . implode($filters, ',') . ')';
        }
        if ($accessType == 0) {
            $accessType = '';
        } else { 
            $accessType = ' and accessType = ' . $accessType;
        }
        return $peIDs . ' ' . $accessType . ' order by accessType desc'; // we order desc so that excludes come last (-1)
    }
    
    public function clearWorkflows() {
        $db = Loader::db();
        $db->Execute('delete from PermissionAccessWorkflows where paID = ?', array($this->getPermissionAccessID()));
    }

    public function attachWorkflow(Workflow $wf) {
        $db = Loader::db();
        $db->Replace('PermissionAccessWorkflows', array('paID' => $this->getPermissionAccessID(), 'wfID' => $wf->getWorkflowID()), array('paID', 'wfID'), true);
    }   

    public function getWorkflows() {
        $db = Loader::db();
        $r = $db->Execute('select wfID from PermissionAccessWorkflows where paID = ?', array($this->getPermissionAccessID()));
        $workflows = array();
        while ($row = $r->FetchRow()) {
            $wf = Workflow::getByID($row['wfID']);
            if (is_object($wf)) {
                $workflows[] = $wf;
            }
        }
        return $workflows;
    }

    public function duplicate($newPA = false) {
        $db = Loader::db();
        if (!$newPA) {
            $newPA = self::create($this->pk);
        }
        $listItems = $this->getAccessListItems(PermissionKey::ACCESS_TYPE_ALL);
        foreach($listItems as $li) {
            $newPA->addListItem($li->getAccessEntityObject(), $li->getPermissionDurationObject(), $li->getAccessType());
        }
        $workflows = $this->getWorkflows();
        foreach($workflows as $wf) {
            $newPA->attachWorkflow($wf);
        }
        $newPA->setPermissionKey($this->pk);
        return $newPA;
    }

    public function markAsInUse() {
        $db = Loader::db();
        $db->Execute('update PermissionAccess set paIsInUse = 1 where paID = ?', array($this->paID));
    }


    public function addListItem(PermissionAccessEntity $pae, $durationObject = false, $accessType = PermissionKey::ACCESS_TYPE_INCLUDE) {
        $db = Loader::db();
        $pdID = 0;
        if ($durationObject instanceof PermissionDuration) {
            $pdID = $durationObject->getPermissionDurationID();
        }
        
        $db->Replace('PermissionAccessList', array(
            'paID' => $this->getPermissionAccessID(),
            'peID' => $pae->getAccessEntityID(),
            'pdID' => $pdID,
            'accessType' => $accessType
        ), array('paID','peID'), false);
    }

    public function removeListItem(PermissionAccessEntity $pe) {
        $db = Loader::db();
        $db->Execute('delete from PermissionAccessList where peID = ? and paID = ?', array($pe->getAccessEntityID(), $this->getPermissionAccessID()));  
    }
    
    public function save() {}

    public static function create(PermissionKey $pk) {
        $db = Loader::db();
        $db->Execute('insert into PermissionAccess (paIsInUse) values (0)');
        return PermissionAccess::getByID($db->Insert_ID(), $pk);
    }
    
    public static function getByID($paID, PermissionKey $pk, $checkPA = true) {
        $db = Loader::db();
        $pa = PermissionCache::getPermissionAccessObject($paID, $pk);
        if (is_object($pa)) {
            return $pa;
        }
        $class = str_replace('PermissionKey', 'PermissionAccess', get_class($pk));
        if ($checkPA) {
            $row = $db->GetRow('select paID, paIsInUse from PermissionAccess where paID = ?', array($paID));
            if ($row['paID']) {
                $obj = new $class();
                $obj->setPropertiesFromArray($row);
            }
        } else { // we got here from an assignment object so we already know its in use.
            $obj = new $class();
            $obj->paID = $paID;
            $obj->paIsInUse = true;
        }
        if (is_object($obj)) {
            $obj->setPermissionKey($pk);
        }
        PermissionCache::addPermissionAccessObject($paID, $pk, $obj);
        return $obj;
    }
    
}