File phpboost/event/ContributionService.class.php

  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: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 

<?php
/**
 * This service allows developers to manage their contributions.
 * @package     PHPBoost
 * @subpackage  Event
 * @copyright   &copy; 2005-2019 PHPBoost
 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
 * @author      Benoit SAUTEL <ben.popeye@phpboost.com>
 * @version     PHPBoost 5.2 - last update: 2016 10 30
 * @since       PHPBoost 2.0 - 2008 07 21
 * @contributor Arnaud GENET <elenwii@phpboost.com>
 * @contributor Julien BRISWALTER <j1.seth@phpboost.com>
*/

class ContributionService
{
    const CONTRIBUTION_TYPE = 0;

    private static $db_querier;

    public static function __static()
    {
        self::$db_querier = PersistenceContext::get_querier();
    }

    /**
     * Finds a contribution with its identifier.
     * @param int $id_contrib Id of the contribution.
     * @return Contribution The contribution you wanted. If it doesn't exist, it will return null.
     */
    public static function find_by_id($id_contrib)
    {
        $result = self::$db_querier->select("SELECT id, entitled, fixing_url, module, current_status, creation_date, fixing_date, auth, poster_id, fixer_id, id_in_module, identifier, type, poster_member.display_name poster_login, poster_member.level poster_level, poster_member.groups poster_groups, fixer_member.display_name fixer_login, fixer_member.level fixer_level, fixer_member.groups fixer_groups, description
        FROM " . DB_TABLE_EVENTS  . " c
        LEFT JOIN " . DB_TABLE_MEMBER . " poster_member ON poster_member.user_id = c.poster_id
        LEFT JOIN " . DB_TABLE_MEMBER . " fixer_member ON fixer_member.user_id = c.poster_id
        WHERE id = :id AND contribution_type = :contribution_type
        ORDER BY creation_date DESC", array(
            'id' => $id_contrib,
            'contribution_type' => self::CONTRIBUTION_TYPE
        ));

        $properties = $result->fetch();

        $result->dispose();

        if ((int)$properties['id'] > 0)
        {
            $contribution = new Contribution();
            $contribution->build($properties['id'], $properties['entitled'], $properties['description'], $properties['fixing_url'], $properties['module'], $properties['current_status'], new Date($properties['creation_date'], Timezone::SERVER_TIMEZONE), new Date($properties['fixing_date'], Timezone::SERVER_TIMEZONE), TextHelper::unserialize($properties['auth']), $properties['poster_id'], $properties['fixer_id'], $properties['id_in_module'], $properties['identifier'], $properties['type'], $properties['poster_login'], $properties['fixer_login'], $properties['poster_level'], $properties['fixer_level'], $properties['poster_groups'], $properties['fixer_groups']);
            return $contribution;
        }
        else
        {
            return null;
        }
    }

    /**
     * Gets all the contributions of the table. You can sort the list.
     * @param string $criteria Criteria according to which they are ordered.
     * It can be id, entitled, fixing_url, auth, current_status, module, creation_date, fixing_date, poster_id, fixer_id,
     * poster_member.login poster_login, fixer_member.login fixer_login, identifier, id_in_module, type, description.
     * @param string $order desc or asc.
     * @return Contribution[] The list of the contributions.
     */
    public static function get_all_contributions($criteria = 'creation_date', $order = 'desc')
    {
        $array_result = array();

        //On liste les contributions
        $result = self::$db_querier->select("SELECT id, entitled, fixing_url, auth, current_status, module, creation_date, fixing_date, poster_id, fixer_id, poster_member.display_name poster_login, poster_member.level poster_level, poster_member.groups poster_groups, fixer_member.display_name fixer_login, fixer_member.level fixer_level, fixer_member.groups fixer_groups, identifier, id_in_module, type, description
        FROM " . DB_TABLE_EVENTS  . " c
        LEFT JOIN " . DB_TABLE_MEMBER . " poster_member ON poster_member.user_id = c.poster_id
        LEFT JOIN " . DB_TABLE_MEMBER . " fixer_member ON fixer_member.user_id = c.fixer_id
        WHERE contribution_type = :contribution_type
        ORDER BY " . $criteria . " " . TextHelper::strtoupper($order) . ", creation_date DESC", array(
            'contribution_type' => self::CONTRIBUTION_TYPE
        ));
        while ($row = $result->fetch())
        {
            $contri = new Contribution();

            $contri->build($row['id'], $row['entitled'], $row['description'], $row['fixing_url'], $row['module'], $row['current_status'], new Date($row['creation_date'], Timezone::SERVER_TIMEZONE), new Date($row['fixing_date'], Timezone::SERVER_TIMEZONE), TextHelper::unserialize($row['auth']), $row['poster_id'], $row['fixer_id'], $row['id_in_module'], $row['identifier'], $row['type'], $row['poster_login'], $row['fixer_login'], $row['poster_level'], $row['fixer_level'], $row['poster_groups'], $row['fixer_groups']);
            $array_result[] = $contri;
        }
        $result->dispose();

        return $array_result;
    }

    /**
     * Builds a list of the contributions matching the required criteria(s). All the parameters represent the criterias you can use.
     * If you don't want to use a criteria, let the null value. The returned contribution match all the criterias (it's a AND condition).
     * @param string $module The module identifier.
     * @param int $id_in_module The id in module field.
     * @param string $type The contribution type.
     * @param string $identifier The contribution identifier.
     * @param int $poster_id The poster.
     * @param int $fixer_id The fixer.
     * @return Contribution[] The list of the contributions matching all the criterias.
     */
    public static function find_by_criteria($module, $id_in_module = null, $type = null, $identifier = null, $poster_id = null, $fixer_id = null)
    {
        $criterias = array();

        //The module parameter must be specified and of string type, otherwise we can't continue
        if (empty($module) || !is_string($module))
        {
            return array();
        }

        $criterias[] = "module = '" . TextHelper::strprotect($module) . "'";

        if ($id_in_module != null)
        {
            $criterias[] = "id_in_module = '" . intval($id_in_module) . "'";
        }

        if ($type != null)
        {
            $criterias[] = "type = '" . TextHelper::strprotect($type) . "'";
        }

        if ($identifier != null)
        {
            $criterias[] = "identifier = '" . TextHelper::strprotect($identifier). "'";
        }

        if ($poster_id != null)
        {
            $criterias[] = "poster_id = '" . intval($poster_id) . "'";
        }

        if ($fixer_id != null)
        {
            $criterias[] = "fixer_id = '" . intval($fixer_id) . "'";
        }

        $array_result = array();

        $result = self::$db_querier->select("SELECT id, entitled, fixing_url, auth, current_status, module, creation_date, fixing_date, poster_id, fixer_id, poster_member.display_name poster_login, fixer_member.display_name fixer_login, identifier, id_in_module, type, description
        FROM " . DB_TABLE_EVENTS  . " c
        LEFT JOIN " . DB_TABLE_MEMBER . " poster_member ON poster_member.user_id = c.poster_id
        LEFT JOIN " . DB_TABLE_MEMBER . " fixer_member ON fixer_member.user_id = c.fixer_id
        WHERE contribution_type = '" . self::CONTRIBUTION_TYPE . "' AND " . implode(" AND ", $criterias));

        while ($row = $result->fetch())
        {
            $contri = new Contribution();
            $contri->build($row['id'], $row['entitled'], $row['description'], $row['fixing_url'], $row['module'], $row['current_status'], new Date($row['creation_date'], Timezone::SERVER_TIMEZONE), new Date($row['fixing_date']), TextHelper::unserialize($row['auth']), $row['poster_id'], $row['fixer_id'], $row['id_in_module'], $row['identifier'], $row['type'], $row['poster_login'], $row['fixer_login']);
            $array_result[] = $contri;
        }
        $result->dispose();

        return $array_result;
    }

    /**
     * Create or update a contribution in the database.
     * @param Contribution $contribution The contribution to synchronize with the data base.
     */
    public static function save_contribution($contribution)
    {
        // If it exists already in the data base
        if ($contribution->get_id() > 0)
        {
            //We write it for PHP 4 which doesn't understand (object->get_object()->method())
            $creation_date = $contribution->get_creation_date();
            $fixing_date = $contribution->get_fixing_date();

            self::$db_querier->update(DB_TABLE_EVENTS, array('entitled' => $contribution->get_entitled(), 'description' => $contribution->get_description(), 'fixing_url' => $contribution->get_fixing_url(), 'module' => $contribution->get_module(), 'current_status' => $contribution->get_status(), 'creation_date' => $creation_date->get_timestamp(), 'fixing_date' => $fixing_date->get_timestamp(), 'auth' => TextHelper::serialize($contribution->get_auth()), 'poster_id' => $contribution->get_poster_id(), 'fixer_id' => $contribution->get_fixer_id(), 'id_in_module' => $contribution->get_id_in_module(), 'identifier' => $contribution->get_identifier(), 'type' => $contribution->get_type()), 'WHERE id = :id', array('id' => $contribution->get_id()));
        }
        else //We create it
        {
            $creation_date = $contribution->get_creation_date();
            $result = self::$db_querier->insert(DB_TABLE_EVENTS, array('entitled' => $contribution->get_entitled(), 'description' => $contribution->get_description(), 'fixing_url' => $contribution->get_fixing_url(), 'module' => $contribution->get_module(), 'current_status' => $contribution->get_status(), 'creation_date' => $creation_date->get_timestamp(), 'fixing_date' => 0, 'auth' => TextHelper::serialize($contribution->get_auth()), 'poster_id' => $contribution->get_poster_id(), 'fixer_id' => $contribution->get_fixer_id(), 'id_in_module' => $contribution->get_id_in_module(), 'identifier' => $contribution->get_identifier(), 'type' => $contribution->get_type(), 'contribution_type' => self::CONTRIBUTION_TYPE));
            $contribution->set_id($result->get_last_inserted_id());
        }

        //Regeneration of the member cache file
        if ($contribution->get_must_regenerate_cache())
        {
            UnreadContributionsCache::invalidate();
            $contribution->set_must_regenerate_cache(false);
        }
    }

    /**
     * Deletes a contribution in the database.
     * @param Contribution $contribution The contribution to delete in the data base.
     */
    public static function delete_contribution($contribution)
    {
        //If it exists in database
        if ($contribution->get_id() > 0)
        {
            self::$db_querier->delete(DB_TABLE_EVENTS, 'WHERE id = :id', array('id' => $contribution->get_id()));
            //We reset the id
            $contribution->set_id(0);

            //Regeneration of the member cache file
            UnreadContributionsCache::invalidate();
        }
    }

    /**
     * Delete all contributions of a module
     * @param string $module_id the module identifier
     */
    public static function delete_contribution_module($module_id)
    {
        self::$db_querier->delete(DB_TABLE_EVENTS, 'WHERE module = :module_id', array('module_id' => $module_id));
    }

    /**
     * Generates the contribution cache file.
     */
    public static function generate_cache()
    {
        UnreadContributionsCache::invalidate();
    }

    /**
     * Computes the number of contributions available for each profile.
     * It will count the contributions for the administrator, the moderators, the members, for each group and for each member who can have some special authorizations.
     * @return int[] A map containing the values for each profile:
     * <ul>
     *  <li>r2 => for the administrator</li>
     *  <li>r1 => for the moderators</li>
     *  <li>r0 => for the members</li>
     *  <li>gi => for the group whose id is i</li>
     *  <li>mi => for the member whose id is i</li>
     * </ul>
     */
    public static function compute_number_contrib_for_each_profile()
    {
        $array_result = array('r2' => 0, 'r1' => 0, 'r0' => 0);

        $result = self::$db_querier->select("SELECT auth FROM " . DB_TABLE_EVENTS  . "
        WHERE current_status = :current_status AND contribution_type = :contribution_type", array(
            'current_status' => Event::EVENT_STATUS_UNREAD,
            'contribution_type' => self::CONTRIBUTION_TYPE
        ));
        while ($row = $result->fetch())
        {
            if (!($this_auth = TextHelper::unserialize($row['auth'])))
            {
                $this_auth = array();
            }

            //We can count only for ranks. For groups and users we can't generalize because there can be intersection problems. Yet, we know the maximum number of contributions they can see, and we can be sure if they have at least 1.

            //Administrators can see everything
            $array_result['r2']++;

            //For moderators ?
            if (Authorizations::check_auth(RANK_TYPE, User::MODERATOR_LEVEL, $this_auth, Contribution::CONTRIBUTION_AUTH_BIT))
            {
                $array_result['r1']++;
            }

            //For members ?
            if (Authorizations::check_auth(RANK_TYPE, User::MEMBER_LEVEL, $this_auth, Contribution::CONTRIBUTION_AUTH_BIT))
            {
                $array_result['r0']++;
            }

            foreach ($this_auth as $profile => $auth_profile)
            {
                //Groups
                if (is_numeric($profile))
                {
                    //If this member has not already an entry and he can see that contribution
                    if (empty($array_result[$profile]) && Authorizations::check_auth(GROUP_TYPE, (int)$profile, $this_auth, Contribution::CONTRIBUTION_AUTH_BIT))
                    {
                        $array_result['g' . $profile] = 1;
                    }
                }
                //Members
                elseif (TextHelper::substr($profile, 0, 1) == 'm')
                {
                    //If this member has not already an entry and he can see that contribution
                    if (empty($array_result[$profile]) && Authorizations::check_auth(USER_TYPE, (int)TextHelper::substr($profile, 1), $this_auth, Contribution::CONTRIBUTION_AUTH_BIT))
                    {
                        $array_result[$profile] = 1;
                    }
                }
            }
        }
        $result->dispose();

        return $array_result;
    }
}
?>