class.ilLicense.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilLicense {

        protected $obj_id = 0;
        protected $licenses = 0;
        protected $remarks = '';
        protected $accesses = 0;


        public function __construct($a_obj_id) {
                $this->obj_id = (int)$a_obj_id;
                $this->read();
        }


        public function getObjId() {
                return $this->obj_id;
        }


        public function setObjId($obj_id) {
                $this->obj_id = $obj_id;
        }


        public function setLicenses($a_licenses = 0) {
                $this->licenses = (int)$a_licenses;
        }


        public function getLicenses() {
                return $this->licenses;
        }


        public function setRemarks($a_remarks = '') {
                $this->remarks = $a_remarks;
        }


        public function getRemarks() {
                return $this->remarks;
        }


        public function getAccesses() {
                return $this->accesses;
        }


        public function getRemainingLicenses() {
                return max(0, $this->licenses - $this->accesses);
        }


        public function getPotentialAccesses() {
                global $ilDB;

                // get the operation id for read access
                $ops_ids = ilRbacReview::_getOperationIdsByName(array( 'read' ));

                // first get all roles with read access
                $role_ids = array();
                $query = 'SELECT DISTINCT pa.rol_id' . ' FROM rbac_pa pa' . ' INNER JOIN object_reference ob ON ob.ref_id = pa.ref_id' . ' WHERE '
                         . $ilDB->like('pa.ops_id', 'text', '%%i:' . $ops_ids[0] . ';%%') . ' AND ob.obj_id = ' . $ilDB->quote($this->getObjId(), 'integer');

                $result = $ilDB->query($query);
                while ($row = $ilDB->fetchObject($result)) {
                        $role_ids[] = $row->rol_id;
                }

                if (!count($role_ids)) {
                        return 0;
                }

                // then count all users of these roles without read events
                $query = 'SELECT COUNT(DISTINCT(usr_id)) accesses ' . ' FROM rbac_ua' . ' WHERE ' . $ilDB->in('rol_id', $role_ids, false, 'integer')
                         . ' AND usr_id NOT IN' . ' (SELECT usr_id FROM read_event' . '  WHERE obj_id = ' . $ilDB->quote($this->getObjId(), 'integer') . ')';

                $result = $ilDB->query($query);
                $row = $ilDB->fetchObject($result);

                return $row->accesses;
        }


        // Data maintenance

        public function read() {
                global $ilDB;

                $query = 'SELECT * FROM license_data WHERE obj_id = %s';
                $result = $ilDB->queryF($query, array( 'integer' ), array( $this->getObjId() ));

                if ($row = $ilDB->fetchObject($result)) {
                        $this->licenses = $row->licenses;
                        $this->accesses = $row->used;
                        $this->remarks = $row->remarks;
                } else {
                        $this->licenses = 0;
                        $this->accesses = 0;
                        $this->remarks = '';
                }
        }


        public function update() {
                global $ilDB;

                $query = 'SELECT * FROM license_data WHERE obj_id = %s';
                $result = $ilDB->queryF($query, array( 'integer' ), array( $this->obj_id ));

                if ($row = $ilDB->fetchObject($result)) {
                        $ilDB->update('license_data', array(
                                'licenses' => array( 'integer', $this->licenses ),
                                'used'     => array( 'integer', $this->accesses ),
                                'remarks'  => array( 'clob', $this->remarks ),
                        ), array(
                                'obj_id' => array( 'integer', $this->obj_id ),
                        ));
                } else {
                        $ilDB->insert('license_data', array(
                                'obj_id'   => array( 'integer', $this->obj_id ),
                                'licenses' => array( 'integer', $this->licenses ),
                                'used'     => array( 'integer', $this->accesses ),
                                'remarks'  => array( 'clob', $this->remarks ),
                        ));
                }
        }


        public function delete() {
                global $ilDB;

                $query = 'DELETE FROM license_data WHERE obj_id = %s';
                $ilDB->manipulateF($query, array( 'integer' ), array( $this->obj_id ));
        }


        // Tracking

        public static function _checkAccess($a_usr_id, $a_obj_id) {
                // Implementation moved
                require_once("Services/License/classes/class.ilLicenseAccess.php");

                return ilLicenseAccess::_checkAccess($a_usr_id, $a_obj_id);
        }


        public static function _noteAccess($a_obj_id, $a_type, $a_ref_id) {
                global $ilDB, $ilUser;

                // don't note the access if licensing is globally disabled
                require_once("Services/License/classes/class.ilLicenseAccess.php");
                if (!ilLicenseAccess::_isEnabled()) {
                        return;
                }

                // check if user has already accessed
                $query = 'SELECT read_count FROM read_event ' . 'WHERE usr_id = %s AND obj_id = %s';
                $result = $ilDB->queryF($query, array( 'integer', 'integer' ), array( $ilUser->getId(), $a_obj_id ));

                if ($row = $ilDB->fetchObject($result)) {
                        // already accessed -> nothing to do
                        return;
                } else {
                        // note access
                        require_once('Services/Tracking/classes/class.ilChangeEvent.php');
                        ilChangeEvent::_recordReadEvent($a_type, $a_ref_id, $a_obj_id, $ilUser->getId());

                        if (self::_isLicensed($a_obj_id)) {
                                // increase used licenses
                                $query = "UPDATE license_data SET used = used + 1 " . "WHERE obj_id = %s";
                                $ilDB->manipulateF($query, array( 'integer' ), array( $a_obj_id ));
                        }
                }
        }


        // Static Queries

        public static function _getLicensedObjects() {
                global $ilDB;
                $objects = array();

                $query = 'SELECT od.obj_id, od.type, od.title, od.description, re.ref_id ' . 'FROM license_data ld '
                         . 'INNER JOIN object_data od ON od.obj_id = ld.obj_id ' . 'INNER JOIN object_reference re ON re.obj_id = od.obj_id '
                         . 'WHERE ld.licenses > 0 ' . 'ORDER BY od.title, od.obj_id';

                $result = $ilDB->query($query);
                $obj_id = 0;
                while ($row = $ilDB->fetchAssoc($result)) {
                        if ($row['obj_id'] != $obj_id) {
                                $objects[] = $row;
                                $obj_id = $row['obj_id'];
                        }
                }

                return $objects;
        }


        public static function _getLicensedChildObjects($a_ref_id) {
                global $tree;
                $objects = array();

                $childs = $tree->getChilds($a_ref_id, 'title');
                foreach ($childs as $data) {
                        if (in_array($data['type'], array( 'sahs', 'htlm' )) and self::_isLicensed($data['obj_id'])) {
                                $objects[] = $data;
                        }
                }

                return $objects;
        }


        public static function _isLicensed($a_obj_id) {
                global $ilDB;

                $query = "SELECT licenses FROM license_data " . "WHERE obj_id = %s " . "AND licenses > 0";
                $result = $ilDB->queryF($query, array( 'integer' ), array( $a_obj_id ));
                if ($row = $ilDB->fetchObject($result)) {
                        return true;
                }
        }
}