class.ilAddressbook.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2001 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. |
        +-----------------------------------------------------------------------------+
*/


class ilAddressbook
{
        var $ilias;

        var $lng;

        var $user_id;

        var $table_addr;

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

                $this->ilias = &$ilias;
                $this->lng = &$lng;
                $this->user_id = $a_user_id;

                $this->table_addr = 'addressbook';
        }
        
        function searchUsers($a_query_str)
        { 
                global $ilDB;

                if($a_query_str)
                {
                        // #14768
                        $a_query_str = str_replace('%', '\%', $a_query_str);
                        $a_query_str = str_replace('_', '\_', $a_query_str);
                
                        $query = "SELECT * FROM ".$this->table_addr." 
                                WHERE ( " .$ilDB->like('login', 'text', '%'.$a_query_str.'%'). " 
                                OR " .$ilDB->like('firstname', 'text', '%'.$a_query_str.'%'). "
                                OR " .$ilDB->like('lastname', 'text', '%'.$a_query_str.'%'). "
                                OR " .$ilDB->like('email', 'text', '%'.$a_query_str.'%'). ") 
                                AND user_id = ".$ilDB->quote($this->user_id, 'integer'). " " ;
                                
                        
                        $res = $ilDB->query($query);
                }
                else
                {
                        $res = $ilDB->queryf("
                                SELECT * FROM ".$this->table_addr." WHERE user_id = %s",
                                array('integer'),
                                array($this->user_id)
                        );
                }
        
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $entries[] = array(
                                "login"      => ($row->login),
                                "firstname"  => ($row->firstname),
                                "lastname"   => ($row->lastname),
                                "email"      => ($row->email));
                }
                return $entries ? $entries : array();
        }
        public function addEntry($a_login,$a_firstname,$a_lastname,$a_email, $a_auto_update = 0)
        {
                global $ilDB;
                
                $nextId = $ilDB->nextId($this->table_addr);   //addr_id,
                $ilDB->manipulateF("
                        INSERT INTO ".$this->table_addr."
                        (       
                                addr_id,
                                user_id,
                                login,
                                firstname,
                                lastname,
                                email,
                                auto_update
                        )
                        VALUES (%s, %s, %s, %s, %s, %s, %s)",
                        array('integer', 'integer', 'text', 'text', 'text', 'text', 'integer'),
                        array($nextId, $this->user_id, $a_login, $a_firstname, $a_lastname, $a_email, $a_auto_update));
                
                return true;
        }

        public function updateEntry($a_addr_id,$a_login,$a_firstname,$a_lastname,$a_email, $a_auto_update = 0)
        {
                global $ilDB;
                $statement = $ilDB->manipulateF( 
                        "UPDATE ".$this->table_addr ."
                        SET login = %s,
                                firstname = %s,
                                lastname = %s,
                                email = %s,
                                auto_update = %s
                        WHERE user_id = %s
                        AND addr_id = %s",
                        array('text', 'text', 'text', 'text', 'integer', 'integer', 'integer'),
                        array($a_login, $a_firstname, $a_lastname, $a_email, $a_auto_update, $this->user_id, $a_addr_id));
                
                return true;
        }

        public function getEntries()
        {
                global $ilDB;
                
                $data_types = array();
                $data = array();
                $query = ("SELECT * FROM ".$this->table_addr." WHERE user_id = ".$ilDB->quote($this->user_id, 'integer')). " ";

                if (trim($this->getSearchQuery()) != '')
                {
                        $sub_query .= " AND ( %s 
                                OR %s 
                                OR %s 
                                OR %s) ";

                        $query .= sprintf($sub_query,   $ilDB->like('login','text','%'.trim($this->getSearchQuery()).'%'), 
                                                                                        $ilDB->like('firstname','text','%'.trim($this->getSearchQuery()).'%'), 
                                                                                        $ilDB->like('lastname','text','%'.trim($this->getSearchQuery()).'%'),  
                                                                                        $ilDB->like('email','text','%'.trim($this->getSearchQuery()).'%')
                        );
                        
                
                }
                
                $query .= " ORDER BY login, lastname";
                
                $res = $ilDB->query($query, $data_types, $data);
                
                while($row = $ilDB->fetchObject($res))
                {
                        $entries[] = array(
                                "addr_id"    => $row->addr_id,
                                "login"      => ($row->login),
                                "firstname"  => ($row->firstname),
                                "lastname"   => ($row->lastname),
                                "email"      => ($row->email),
                                "auto_update"=> $row->auto_update
                        );
                }
                return $entries ? $entries : array();
        }
        public function getEntry($a_addr_id)
        {
                global $ilDB;
                
                $res = $ilDB->queryf("
                        SELECT * FROM ".$this->table_addr."
                        WHERE user_id = %s
                        AND addr_id = %s",
                        array('integer', 'integer'),
                        array($this->user_id, $a_addr_id));
                
                $row = $ilDB->fetchObject($res);

                return array(
                        "addr_id"    => $row->addr_id,
                        "login"      => ($row->login),
                        "firstname"  => ($row->firstname),
                        "lastname"   => ($row->lastname),
                        "email"      => ($row->email),
                        "auto_update"=> $row->auto_update
                );
        }

        function entryToString($a_addr_id)
        {
                $entry = $this->getEntry($a_addr_id);
                if (!$entry)
                        return "???";
                else
                {
                        $out = "";
                        if ($entry['firstname'] && $entry['lastname'])
                                $out .= $entry['lastname'] . ', ' . $entry['firstname'] . ' ';
                        else if ($entry['firstname'])
                                $out .= $entry['firstname'] . ' ';
                        else if ($entry['lastname'])
                                $out .= $entry['lastname'] . ' ';
                        
                        if ($entry['login'])
                                $out .= '(' . $entry['login'] . ') ';
                        
                        if ($entry['email'])
                                $out .= '[' . $entry['email'] . ']';
                        return $out;
                }
        }
        
        function deleteEntries($a_entries)
        {
                if(is_array($a_entries))
                {
                        foreach($a_entries as $entry)
                        {
                                $this->deleteEntry($entry);
                        }
                }
                return true;
        }
        function deleteEntry($a_addr_id)
        { 
                global $ilDB;
                
                $statement = $ilDB->manipulateF('
                        DELETE FROM addressbook_mlist_ass
                        WHERE addr_id = %s',
                        array('integer'), array($a_addr_id));
                
                $statement = $ilDB->manipulateF("
                        DELETE FROM ".$this->table_addr."
                        WHERE user_id = %s
                        AND addr_id = %s",
                        array('integer', 'integer'),
                        array($this->user_id, $a_addr_id));

                return true;
        }

        function checkEntry($a_login)
        {
                global $ilDB;
                
                if ($a_login != '')
                {
                        $result = $ilDB->queryf("SELECT addr_id FROM ".$this->table_addr." WHERE user_id = %s AND login = %s",
                                        array('integer', 'text'), array($this->user_id, $a_login));
        
                        while($record = $ilDB->fetchAssoc($result))
                        {
                                return $record['addr_id'];
                        }
                }
                
                return 0;
        }

        /* Check whether an entry with a given login name already exists */
        function checkEntryByLogin($a_login)
        {
                global $ilDB;
                
                if ($a_login != "")
                {
                        $result = $ilDB->queryf("SELECT addr_id FROM ".$this->table_addr." WHERE user_id = %s AND login = %s",
                                        array('integer', 'text'), array($this->user_id, $a_login));
                        
                        while($record = $ilDB->fetchAssoc($result))
                        {
                                return $record['addr_id'];
                        }
                }
                
                return 0;
        }
        
        public function setSearchQuery($search_query = '')
        {
                $this->search_query = $search_query;
        }
        public function getSearchQuery()
        {
                return $this->search_query;
        }

        public static function onUserDeletion(ilObjUser $usr)
        {
                global $ilDB;

                $ilDB->manipulateF(
                        'UPDATE addressbook SET login = NULL, auto_update = %s WHERE login = %s AND email IS NOT NULL',
                        array('integer', 'text'),
                        array(0, $usr->getLogin())
                );

                $ilDB->manipulateF(
                        'DELETE FROM addressbook_mlist_ass WHERE addr_id IN(
                                SELECT addr_id FROM addressbook WHERE login = %s AND email IS NULL
                        )',
                        array('text'),
                        array($usr->getLogin())
                );

                $ilDB->manipulateF(
                        'DELETE FROM addressbook WHERE login = %s AND email IS NULL',
                        array('text'),
                        array($usr->getLogin())
                );
        }

        public static function onLoginNameChange($from, $to)
        {
                global $ilDB;

                $ilDB->manipulateF(
                        'UPDATE addressbook SET login = %s WHERE login = %s',
                        array('text', 'text'),
                        array($to, $from)
                );
        }
}
?>