class.ilMailbox.php

Go to the documentation of this file.

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

class ilMailbox
{
    protected $ilias;

    protected $lng;

    protected $db;

    protected $mtree;

    protected $user_id;

    protected $actions = array();

    protected $default_folder = array();

    protected $table_mail_obj_data;

    protected $table_tree;

    public function __construct($a_user_id = 0)
    {
        global $DIC;

        $this->ilias = $DIC['ilias'];
        $this->lng = $DIC->language();
        $this->db = $DIC->database();

        $this->user_id = $a_user_id;

        $this->table_mail_obj_data = 'mail_obj_data';
        $this->table_tree = 'mail_tree';

        if ($a_user_id) {
            $this->mtree = new ilTree($this->user_id);
            $this->mtree->setTableNames($this->table_tree, $this->table_mail_obj_data);
        }

        // i added this, becaus if i create a new user automatically during
        // CAS authentication, we have no $lng variable (alex, 16.6.2006)
        // (alternative: make createDefaultFolder call static in ilObjUser->saveAsNew())
        if (is_object($this->lng)) {
            $this->lng->loadLanguageModule("mail");

            $this->actions = array(
                "moveMails" => $this->lng->txt("mail_move_to"),
                "markMailsRead" => $this->lng->txt("mail_mark_read"),
                "markMailsUnread" => $this->lng->txt("mail_mark_unread"),
                "deleteMails" => $this->lng->txt("delete"));
        }
        
        // array contains basic folders and there lng translation for every new user
        $this->default_folder = array(
            "b_inbox" => "inbox",
            "c_trash" => "trash",
            "d_drafts" => "drafts",
            "e_sent" => "sent",
            "z_local" => "local");
    }

    public function getInboxFolder()
    {
        $res = $this->db->queryF(
            '
                        SELECT obj_id FROM ' . $this->table_mail_obj_data . '
                        WHERE user_id = %s
                        AND m_type = %s',
            array('integer', 'text'),
            array($this->user_id, 'inbox')
        );

        $row = $this->db->fetchAssoc($res);

        return $row['obj_id'];
    }

    public function getDraftsFolder()
    {
        $res = $this->db->queryF(
            '
                        SELECT obj_id FROM ' . $this->table_mail_obj_data . '
                        WHERE user_id = %s
                        AND m_type = %s',
            array('integer', 'text'),
            array($this->user_id, 'drafts')
        );

        $row = $this->db->fetchAssoc($res);

        return $row['obj_id'];
    }

    public function getTrashFolder()
    {
        $res = $this->db->queryf(
            '
                        SELECT obj_id FROM ' . $this->table_mail_obj_data . '
                        WHERE user_id = %s
                        AND m_type = %s',
            array('integer', 'text'),
            array($this->user_id, 'trash')
        );

        $row = $this->db->fetchAssoc($res);

        return $row['obj_id'];
    }

    public function getSentFolder()
    {
        $res = $this->db->queryf(
            '
                        SELECT obj_id FROM ' . $this->table_mail_obj_data . '
                        WHERE user_id = %s
                        AND m_type = %s',
            array('integer', 'text'),
            array($this->user_id, 'sent')
        );

        $row = $this->db->fetchAssoc($res);

        return $row['obj_id'];
    }

    public function getRootFolderId()
    {
        return $this->mtree->getRootID($this->user_id);
    }

    public function getActions($a_mobj_id)
    {
        if ($a_mobj_id) {
            $folder_data = $this->getFolderData($a_mobj_id);

            if ($folder_data["type"] == "user_folder" or $folder_data["type"] == "local") {
                return $this->actions;
            }
        }

        return $this->actions;
    }

    public function createDefaultFolder()
    {
        $root_id = $this->db->nextId($this->table_mail_obj_data);
        $this->db->manipulateF(
            '
                        INSERT INTO ' . $this->table_mail_obj_data . ' 
                        (       obj_id,
                                user_id,
                                title,
                                m_type
                        )
                        VALUES(%s, %s, %s, %s)',
            array('integer','integer', 'text', 'text'),
            array($root_id, $this->user_id, 'a_root', 'root')
        );
        $this->mtree->addTree($this->user_id, $root_id);

        foreach ($this->default_folder as $key => $folder) {
            $last_id = $this->db->nextId($this->table_mail_obj_data);
            $this->db->manipulateF(
                '
                                INSERT INTO ' . $this->table_mail_obj_data . ' 
                                (       obj_id,
                                        user_id,
                                        title,
                                        m_type
                                )
                                VALUES(%s, %s, %s, %s)',
                array('integer','integer', 'text', 'text'),
                array($last_id, $this->user_id, $key, $folder)
            );
            $this->mtree->insertNode($last_id, $root_id);
        }
    }

    public function addFolder($a_parent_id, $a_folder_name)
    {
        if ($this->folderNameExists($a_folder_name)) {
            return 0;
        }

        $next_id = $this->db->nextId($this->table_mail_obj_data);
        $this->db->manipulateF(
            '
                        INSERT INTO ' . $this->table_mail_obj_data . '
                        (       obj_id,
                                user_id,
                                title,
                                m_type 
                         )
                         VALUES(%s,%s,%s,%s)',
            array('integer','integer', 'text', 'text'),
            array($next_id, $this->user_id, $a_folder_name, 'user_folder')
        );
        $this->mtree->insertNode($next_id, $a_parent_id);

        return $next_id;
    }

    public function renameFolder($a_obj_id, $a_new_folder_name)
    {
        if ($this->folderNameExists($a_new_folder_name)) {
            return false;
        }

        $this->db->manipulateF(
            '
                        UPDATE ' . $this->table_mail_obj_data . '
                        SET title = %s
                        WHERE obj_id = %s AND user_id = %s',
            array('text', 'integer', 'integer'),
            array($a_new_folder_name, $a_obj_id, $this->user_id)
        );

        return true;
    }

    protected function folderNameExists($a_folder_name)
    {
        $res = $this->db->queryF(
            '
                        SELECT obj_id FROM ' . $this->table_mail_obj_data . '
                        WHERE user_id = %s
                        AND title = %s',
            array('integer', 'text'),
            array($this->user_id, $a_folder_name)
        );
        $row = $this->db->fetchAssoc($res);

        return is_array($row) && $row['obj_id'] > 0 ? true : false;
    }

    public function deleteFolder($a_folder_id)
    {
        $query = $this->db->queryf(
            '
                        SELECT obj_id, title FROM mail_obj_data
                        WHERE obj_id = %s AND user_id = %s',
            array('integer', 'integer'),
            array($a_folder_id, $this->user_id)
        );
        $row = $this->db->fetchAssoc($query);

        if (!is_array($row) || array_key_exists($row['title'], $this->default_folder)) {
            return false;
        }

        require_once 'Services/Mail/classes/class.ilMail.php';
        $umail = new ilMail($this->user_id);

        $subtree = $this->mtree->getSubtree($this->mtree->getNodeData($a_folder_id));
        $this->mtree->deleteTree($this->mtree->getNodeData($a_folder_id));

        foreach ($subtree as $node) {
            $mails = $umail->getMailsOfFolder($node["obj_id"]);
            $mail_ids = array();
            foreach ($mails as $mail) {
                $mail_ids[] = $mail["mail_id"];
            }

            $umail->deleteMails($mail_ids);

            $this->db->manipulateF(
                '
                                DELETE FROM ' . $this->table_mail_obj_data . ' 
                                WHERE obj_id = %s AND user_id = %s',
                array('integer', 'integer'),
                array($node['obj_id'], $this->user_id)
            );
        }

        return true;
    }

    public function getFolderData($a_obj_id)
    {
        $res = $this->db->queryF(
            '
                        SELECT * FROM ' . $this->table_mail_obj_data . ' 
                        WHERE user_id = %s
                        AND obj_id = %s',
            array('integer', 'integer'),
            array($this->user_id, $a_obj_id)
        );
        $row = $this->db->fetchAssoc($res);

        return array(
            'obj_id' => $row['obj_id'],
            'title' => $row['title'],
            'type' => $row['m_type']
        );
    }

    public function getParentFolderId($a_obj_id)
    {
        $res = $this->db->queryF(
            '
                        SELECT * FROM  ' . $this->table_tree . ' 
                        WHERE child = %s AND tree = %s',
            array('integer', 'integer'),
            array($a_obj_id, $this->user_id)
        );
        $row = $this->db->fetchAssoc($res);

        return is_array($row) ? $row['parent'] : 0;
    }

    public function getSubFolders($a_folder = 0, $a_folder_parent = 0)
    {
        if (!$a_folder) {
            $a_folder = $this->getRootFolderId();
        }

        $user_folder = array();

        foreach ($this->default_folder as $key => $value) {
            $res = $this->db->queryF(
                '
                                SELECT obj_id, m_type
                                FROM ' . $this->table_mail_obj_data . ' 
                                WHERE user_id = %s
                                AND title = %s',
                array('integer', 'text'),
                array($this->user_id, $key)
            );
            $row = $this->db->fetchAssoc($res);

            $user_folder[] = array(
                'title' => $key,
                'type' => $row['m_type'],
                'obj_id' => $row['obj_id']
            );
        }

        $res = $this->db->queryF(
            '
                        SELECT * FROM ' . $this->table_tree . ', ' . $this->table_mail_obj_data . '
                        WHERE ' . $this->table_mail_obj_data . '.obj_id = ' . $this->table_tree . '.child 
                        AND ' . $this->table_tree . '.depth  > %s
                        AND ' . $this->table_tree . '.tree  = %s
                        ORDER BY ' . $this->table_tree . '.lft, ' . $this->table_mail_obj_data . '.title  ',
            array('integer', 'integer'),
            array(2, $this->user_id)
        );
        while ($row = $this->db->fetchAssoc($res)) {
            $user_folder[] = array(
                'title' => $row['title'],
                'type' => $row['m_type'],
                'obj_id' => $row['child']
            );
        }

        return $user_folder;
    }

    public function setUserId($a_user_id)
    {
        $this->user_id = $a_user_id;
    }

    public function getUserId() : int
    {
        return (int) $this->user_id;
    }

    public function delete()
    {
        $this->db->manipulateF(
            '
                        DELETE FROM mail_obj_data WHERE user_id = %s',
            array('integer'),
            array($this->user_id)
        );

        $this->db->manipulateF(
            '
                        DELETE FROM mail_options WHERE user_id = %s',
            array('integer'),
            array($this->user_id)
        );

        $this->db->manipulateF(
            '
                        DELETE FROM mail_saved WHERE user_id = %s',
            array('integer'),
            array($this->user_id)
        );

        $this->db->manipulateF(
            '
                        DELETE FROM mail_tree WHERE tree = %s',
            array('integer'),
            array($this->user_id)
        );

        // Delete the user's files from filesystem: This has to be done before deleting the database entries in table 'mail'
        require_once 'Services/Mail/classes/class.ilFileDataMail.php';
        $fdm = new ilFileDataMail($this->user_id);
        $fdm->onUserDelete();
        
        // Delete mails of deleted user
        $this->db->manipulateF(
            'DELETE FROM mail WHERE user_id = %s',
            array('integer'),
            array($this->user_id)
        );

        return true;
    }

    public function updateMailsOfDeletedUser($nameToShow)
    {
        $this->db->manipulateF(
            '
                        UPDATE mail 
                        SET sender_id = %s, import_name = %s
                        WHERE sender_id = %s',
            array('integer', 'text', 'integer'),
            array(0, $nameToShow, $this->user_id)
        );
    }

    public function isOwnedFolder(int $folderId) : bool
    {
        $folderData = $this->getFolderData($folderId);

        return $folderData['obj_id'] == $folderId;
    }
}