path: root/lib/classes/UserFilter.php

<?php

/**
 * UserFilter.php
 *
 * Conditions for user selection in Stud.IP. A condition is a collection of
 * condition fields, e.g. degree, course of study or semester. Each
 * condition can have a validity period.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * @author      Thomas Hackl <thomas.hackl@uni-passau.de>
 * @license     http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
 * @category    Stud.IP
 */
class UserFilter
{
    // --- ATTRIBUTES ---

    /**
     * All condition fields that form this condition.
     */
    public $fields = [];

    /**
     * Unique identifier for this condition.
     */
    public $id = '';

    // Data about where this filter belongs.
    public string $range_id = '';
    public string $range_type = '';

    public $show_user_count = false;

    // --- OPERATIONS ---

    /**
     * Standard constructor.
     *
     * @param String conditionId
     * @return UserFilter
     */
    public function __construct($conditionId = '')
    {
        $this->id = $conditionId;
        if ($conditionId) {
            $this->load();
        } else {
            $this->id = $this->generateId();
        }
        return $this;
    }

    /**
     * Add a new condition field.
     *
     * @param UserFilterField fieldId
     * @return UserFilter
     */
    public function addField($field)
    {
        $this->fields[$field->getId()] = $field;
        $field->setConditionId($this->id);
        return $this;
    }

    /**
     * Deletes the condition and all associated fields.
     */
    public function delete()
    {
        // Delete condition data.
        $stmt = DBManager::get()->prepare("DELETE FROM `userfilter`
            WHERE `filter_id`=?");
        $stmt->execute([$this->id]);
        // Delete all defined condition fields.
        foreach ($this->fields as $field) {
            $field->delete();
        }
    }

    /**
     * Generate a new unique ID.
     *
     * @param String tableName
     */
    public function generateId()
    {
        do {
            $newid = md5(uniqid(get_class($this) . microtime(), true));
            $id = DBManager::get()->fetchColumn("SELECT `filter_id`
                FROM `userfilter` WHERE `filter_id`=?", [$newid]);
        } while ($id);
        return $newid;
    }

    /**
     * Get all fields (without checking for validity according
     * to the current time).
     *
     * @return Array
     */
    public function getFields()
    {
        uasort($this->fields, function ($a, $b) {
            return $a::$sortOrder - $b::$sortOrder;
        });
        return $this->fields;
    }

    /**
     * Get ID.
     *
     * @return String
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * Gets all users that fulfill the current condition.
     *
     * @return Array
     */
    public function getUsers()
    {
        $users = null;
        foreach ($this->fields as $field) {
            // Check if restrictions for the field value must be taken into consideration.
            $restrictions = [];
            foreach ($field->relations as $className => $related) {
                if ($other = $this->hasField($className)) {
                    if ($other->getValue()) {
                        $restrictions[$className] = [
                            'table' => $other->userDataDbTable,
                            'field' => $other->userDataDbField,
                            'compare' => $other->getCompareOperator(),
                            'value' => $other->getValue()
                        ];
                    }
                }
            }
            $users = isset($users) ? array_intersect($users, $field->getUsers($restrictions)) : $field->getUsers($restrictions);
        }
        return (array)$users;
    }

    /**
     * Checks whether the current filter object contains a field
     * of the given type.
     *
     * @param String $className the type to check for
     * @return UserFilterField Return the found field or null if not applicable.
     */
    public function hasField($className)
    {
        foreach ($this->fields as $field) {
            if ($field instanceof $className) {
                return $field;
                break;
            }
        }
        return null;
    }

    /**
     * Is the current condition fulfilled (that means, are all
     * required field values matched)?
     *
     * @return boolean
     */
    public function isFulfilled($userId)
    {
        // Check all fields.
        foreach ($this->fields as $field) {
            if (!$field->checkValue($field->getUserValues($userId, $this->fields))) {
                return false;
            }
        }
        return true;
    }

    /**
     * Helper function for loading data from DB.
     */
    public function load()
    {
        // Load basic condition data.
        $stmt = DBManager::get()->prepare(
            "SELECT * FROM `userfilter` WHERE `filter_id`=? LIMIT 1");
        $stmt->execute([$this->id]);
        if ($data = $stmt->fetch(PDO::FETCH_ASSOC)) {
            $this->id = $data['filter_id'];
            $this->range_id = $data['range_id'];
            $this->range_type = $data['range_type'];
            // Load the associated condition fields.
            $stmt = DBManager::get()->prepare(
                "SELECT `field_id`, `type` FROM `userfilter_fields`
                WHERE `filter_id`=?");
            $stmt->execute([$this->id]);
            while ($data = $stmt->fetch(PDO::FETCH_ASSOC)) {
                /*
                 * Create instance of appropriate UserFilterField subclass.
                 * We just "try" here because the class definition could have
                 * been removed since saving data to DB.
                 */
                //try {
                $chunks = explode('_', $data['type']);
                $type = $chunks[0];
                $param = $chunks[1] ?? null;
                if ($param) {
                    $field = new $type($param, $data['field_id']);
                } else {
                    $field = new $type($data['field_id']);
                }

                $this->fields[$field->getId()] = $field;
                //} catch (Exception $e) {}
            }
        }
    }

    /**
     * Removes the field with the given ID from the condition fields.
     *
     * @param String fieldId
     * @return UserFilter
     */
    public function removeField($fieldId)
    {
        unset($this->fields[$fieldId]);
        return $this;
    }

    /**
     * Stores data to DB.
     */
    public function store()
    {
        // Generate new ID if condition entry doesn't exist in DB yet.
        if (!$this->id) {
            $this->id = $this->generateId();
        }

        // Store condition data.
        $stmt = DBManager::get()->prepare("INSERT INTO `userfilter`
            (`filter_id`, `range_id`, `range_type`, `mkdate`, `chdate`)
            VALUES (?, ?, ?, ?, ?)
            ON DUPLICATE KEY UPDATE `chdate` = VALUES(`chdate`), `range_type` = VALUES(`range_type`), `range_id` = VALUES(`range_id`)");
        $stmt->execute([$this->id, $this->range_id, $this->range_type, time(), time()]);
        // Delete removed condition fields from DB.
        DBManager::get()->exec("DELETE FROM `userfilter_fields`
            WHERE `filter_id`='" . $this->id . "' AND `field_id` NOT IN ('" .
            implode("', '", array_keys($this->fields)) . "')");
        // Store all fields.
        foreach ($this->fields as $field) {
            $field->store($this->id);
        }
    }

    public function toString()
    {
        $tpl = $GLOBALS['template_factory']->open('userfilter/display');
        $tpl->set_attribute('filter', $this);
        return $tpl->render();
    }

    public function __toString()
    {
        return $this->toString();
    }

    public function __clone()
    {
        $this->id = md5(uniqid(get_class($this)));
        $cloned_fields = [];
        foreach ($this->fields as $field) {
            $dolly = clone $field;
            $dolly->conditionId = $this->id;
            $cloned_fields[$dolly->id] = $dolly;
        }
        $this->fields = $cloned_fields;
    }

    /**
     * Checks whether the given user can edit this filter.
     * @return bool
     */
    public function canEdit(User $user): bool
    {
        // This is a new object, we can always create that as it has no other connection to the system or database.
        if (!$this->range_type || !$this->range_id) {
            return true;
        }

        // Check for an existing object, using range_type and tange_id.
        $range = new $this->range_type($this->range_id);
        return $range->canEditFilter($user, $this);
    }

    /**
     * Sets the range this UserFilter belongs to.
     * @param string $type
     * @param string|int $id
     * @return void
     */
    public function setRange(string $type, string|int $id): void
    {
        $this->range_type = $type;
        $this->range_id = $id;
    }

} /* end of class UserFilter */

?>