classes/class.ilMailbox.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
        |                                                                             |
        | 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.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/


require_once("./classes/class.ilMail.php");

class ilMailbox
{
        var $ilias;

        var $lng;

        var $mtree;

        var $user_id;

        var $actions;

        var $default_folder;

        var $table_mail_obj_data;

        var $table_tree;

        function ilMailbox($a_user_id = 0)
        {
                global $ilias,$lng;


                $this->ilias = &$ilias;
                $this->lng = &$lng;
                $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(
                                "move"        => $this->lng->txt("mail_move_to"),
                                "mark_read"   => $this->lng->txt("mail_mark_read"),
                                "mark_unread" => $this->lng->txt("mail_mark_unread"),
                                "delete"      => $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");

        }
        function getInboxFolder()
        {
                $query = "SELECT * FROM $this->table_mail_obj_data ".
                                 "WHERE user_id = '".$this->user_id."' ".
                                 "AND type = 'inbox'";
                $row = $this->ilias->db->getRow($query,DB_FETCHMODE_OBJECT);

                return $row->obj_id;
        }

        function getDraftsFolder()
        {
                $query = "SELECT * FROM $this->table_mail_obj_data ".
                                 "WHERE user_id = '".$this->user_id."' ".
                                 "AND type = 'drafts'";
                $row = $this->ilias->db->getRow($query,DB_FETCHMODE_OBJECT);

                return $row->obj_id;
        }

        function getTrashFolder()
        {
                $query = "SELECT * FROM $this->table_mail_obj_data ".
                                 "WHERE user_id = '".$this->user_id."' ".
                                 "AND type = 'trash'";
                $row = $this->ilias->db->getRow($query,DB_FETCHMODE_OBJECT);

                return $row->obj_id;
        }

        function getSentFolder()
        {
                $query = "SELECT * FROM $this->table_mail_obj_data ".
                                 "WHERE user_id = '".$this->user_id."' ".
                                 "AND type = 'sent'";
                $row = $this->ilias->db->getRow($query,DB_FETCHMODE_OBJECT);

                return $row->obj_id;
        }

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

        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 array_merge($this->actions,array("add" => $this->lng->txt("mail_add_subfolder")));
                        }
                }

                return $this->actions;
        }

        function hasNewMail($a_user_id)
        {
                global $ilias;

                if (!$a_user_id)
                {
                        return 0;
                }

                // CHECK FOR SYSTEM MAIL
                $query = "SELECT mail_id FROM mail WHERE folder_id = 0 AND user_id = '".$a_user_id."' ".
                        "AND m_status = 'unread'";

                $row = $ilias->db->getRow($query,DB_FETCHMODE_OBJECT);
                
                if($row->mail_id)
                {
                        return $row->mail_id;
                }

                $query = "SELECT m.mail_id FROM mail AS m,mail_obj_data AS mo ".
                                 "WHERE m.user_id = mo.user_id ".
                                 "AND m.folder_id = mo.obj_id ".
                                 "AND mo.type = 'inbox' ".
                                 "AND m.user_id = '".$a_user_id."' ".
                                 "AND m.m_status = 'unread'";
                $row = $ilias->db->getRow($query,DB_FETCHMODE_OBJECT);

                return $row ? $row->mail_id : 0;
        }

        function _countNewMails($a_user_id)
        {
                global $ilias;

                if (!$a_user_id)
                {
                        return 0;
                }

                // CHECK FOR SYSTEM MAIL
                $query = "SELECT count(*) as cnt FROM mail WHERE folder_id = 0 AND user_id = '".$a_user_id."' ".
                        "AND m_status = 'unread'";

                $row = $ilias->db->getRow($query,DB_FETCHMODE_OBJECT);

                $query = "SELECT count(*) as cnt FROM mail AS m,mail_obj_data AS mo ".
                                 "WHERE m.user_id = mo.user_id ".
                                 "AND m.folder_id = mo.obj_id ".
                                 "AND mo.type = 'inbox' ".
                                 "AND m.user_id = '".$a_user_id."' ".
                                 "AND m.m_status = 'unread'";
                $row2 = $ilias->db->getRow($query,DB_FETCHMODE_OBJECT);
                
                return $row->cnt + $row2->cnt;
        }

        function createDefaultFolder()
        {
                $root_id = $this->getLastInsertId();
                ++$root_id;

                $query = "INSERT INTO $this->table_mail_obj_data ".
                                 "SET obj_id = '".$root_id."',".
                                 "user_id = '$this->user_id',".
                                 "title = 'a_root',".
                                 "type = 'root'";
                $res = $this->ilias->db->query($query);
                $this->mtree->addTree($this->user_id,$root_id);
                
                foreach ($this->default_folder as $key => $folder)
                {
                        $last_id = $this->getLastInsertId();
                        ++$last_id;

                        $query = "INSERT INTO $this->table_mail_obj_data ".
                                         "SET obj_id = '".$last_id."',".
                                         "user_id = '$this->user_id',".
                                         "title = '$key',".
                                         "type = '$folder'";
                        $res = $this->ilias->db->query($query);
                        $this->mtree->insertNode($last_id,$root_id);
                }
        }
        function addFolder($a_parent_id,$a_folder_name)
        {
                if ($this->folderNameExists($a_folder_name))
                {
                        return 0;
                }
                // ENTRY IN mail_obj_data
                $query = "INSERT INTO $this->table_mail_obj_data ".
                                 "SET user_id = '$this->user_id',".
                                 "title = '".addslashes($a_folder_name)."',".
                                 "type = 'user_folder'";
                $res = $this->ilias->db->query($query);

                // ENTRY IN mail_tree
                $new_id = $this->getLastInsertId();
                $this->mtree->insertNode($new_id,$a_parent_id);

                return $new_id;
        }

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

                $query = "UPDATE $this->table_mail_obj_data ".
                                 "SET title = '".addslashes($a_new_folder_name)."' ".
                                 "WHERE obj_id = '".$a_obj_id."'";
                $res = $this->ilias->db->query($query);
                
                return true;
        }

        function folderNameExists($a_folder_name)
        {
                $query = "SELECT obj_id FROM $this->table_mail_obj_data ".
                                 "WHERE user_id = '".$this->user_id."' ".
                                 "AND title = '".addslashes($a_folder_name)."'";
                $row = $this->ilias->db->getRow($query,DB_FETCHMODE_OBJECT);

                return $row->obj_id ? true : false;
        }

        function deleteFolder($a_folder_id)
        {
                include_once("classes/class.ilMail.php");
                $umail = new ilMail($this->user_id);

                // SAVE SUBTREE DATA
                $subtree = $this->mtree->getSubtree($this->mtree->getNodeData($a_folder_id));

                // DELETE ENTRY IN TREE
                $this->mtree->deleteTree($this->mtree->getNodeData($a_folder_id));

                // DELETE ENTRY IN mobj_data
                foreach($subtree as $node)
                {
                        // DELETE mail(s) of folder(s)
                        $mails = $umail->getMailsOfFolder($node["obj_id"]);

                        foreach ($mails as $mail)
                        {
                                $mail_ids[] = $mail["mail_id"];
                        }

                        if (is_array($mail_ids))
                        {
                                $umail->deleteMails($mail_ids);
                        }

                        // DELETE mobj_data entries
                        $query = "DELETE FROM $this->table_mail_obj_data ".
                                         "WHERE obj_id = '".$node["obj_id"]."'";
                        $res = $this->ilias->db->query($query);
                }

                return true;
        }

        // TODO: can be substituted by ilUtil::getLastInsertId
        function getLastInsertId()
        {
                $query = "SELECT MAX(obj_id) FROM $this->table_mail_obj_data ";
                $res = $this->ilias->db->query($query);

                while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        return $row["MAX(obj_id)"] ? $row["MAX(obj_id)"] : 0;
                }
        }
        
        function getFolderData($a_obj_id)
        {
                $query = "SELECT * FROM $this->table_mail_obj_data ".
                                 "WHERE user_id = '".$this->user_id."' ".
                                 "AND obj_id = '".$a_obj_id."'";

                $row = $this->ilias->db->getRow($query,DB_FETCHMODE_OBJECT);

                return array(
                                        "title"    => stripslashes($row->title),
                                        "type"     => $row->type
                                        );
        }
        function getParentFolderId($a_obj_id)
        {
                $query = "SELECT * FROM $this->table_tree ".
                                 "WHERE child = '".$a_obj_id."'";
                $row = $this->ilias->db->getRow($query,DB_FETCHMODE_OBJECT);
        
                return $row->parent;
        }
        function getSubFolders($a_folder = 0,$a_folder_parent = 0)
        {
                if (!$a_folder)
                {
                        $a_folder = $this->getRootFolderId();
                }
                
                foreach ($this->default_folder as $key => $value)
                {
                        $query = "SELECT obj_id,type FROM $this->table_mail_obj_data ".
                                "WHERE user_id = $this->user_id ".
                                "AND title = '".$key."'";
                        $row = $this->ilias->db->getRow($query,DB_FETCHMODE_OBJECT);
                        
                        $user_folder[] = array(
                                "title"    => $key,
                                "type"     => $row->type,
                                "obj_id"   => $row->obj_id);
                } 

                $query = "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 > '2' ".
                        "AND $this->table_tree.tree = '".$this->user_id."' ".
                        "ORDER BY $this->table_mail_obj_data.title";

                $res = $this->ilias->db->query($query);

                while ($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $user_folder[] = array(
                                "title"      => stripslashes($row->title),
                                "type"    => $row->type,
                                "obj_id"  => $row->child);
                }

                return $user_folder;
        }

        function setUserId($a_user_id)
        {
                $this->user_id = $a_user_id;
        }
        
        function delete()
        {
                $q = "DELETE FROM mail_obj_data WHERE user_id='".$this->user_id."'";
                $this->ilias->db->query($q);

                $q = "DELETE FROM mail_options WHERE user_id='".$this->user_id."'";
                $this->ilias->db->query($q);

                $q = "DELETE FROM mail_saved WHERE user_id='".$this->user_id."'";
                $this->ilias->db->query($q);

                $q = "DELETE FROM mail_tree WHERE tree='".$this->user_id."'";
                $this->ilias->db->query($q);
                
                return true;
        }

        function updateMailsOfDeletedUser()
        {
                $tmp_user =& ilObjectFactory::getInstanceByObjId($this->user_id,false);

                $query = "UPDATE mail SET sender_id = '0',import_name = '".$tmp_user->getLogin()."' ".
                        "WHERE sender_id = '".$this->user_id."'";

                $this->ilias->db->query($query);

                return true;
        }
                
}
?>