class.ilMailOptions.php

Go to the documentation of this file.

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

class ilMailOptions
{
    const INCOMING_LOCAL = 0;
    const INCOMING_EMAIL = 1;
    const INCOMING_BOTH = 2;

    const FIRST_EMAIL = 3;
    const SECOND_EMAIL = 4;
    const BOTH_EMAIL = 5;

    const DEFAULT_LINE_BREAK = 60;

    protected $ilias;
    protected $db;
    protected $user_id;
    protected $settings;
    protected $table_mail_options = 'mail_options';
    protected $linebreak = self::DEFAULT_LINE_BREAK;
    protected $signature;
    protected $cronjob_notification = 0;
    protected $incoming_type = self::INCOMING_LOCAL;
    protected $mail_address_option = self::FIRST_EMAIL;
    private $mailTransportSettings;

    public function __construct($a_user_id, ilMailTransportSettings $mailTransportSettings = null)
    {
        global $DIC;

        $this->user_id = $a_user_id;

        $this->db = $DIC->database();
        $this->settings = $DIC->settings();

        if ($mailTransportSettings === null) {
            $mailTransportSettings = new ilMailTransportSettings($this);
        }
        $this->mailTransportSettings = $mailTransportSettings;

        $this->read();
    }

    public function createMailOptionsEntry()
    {
        $this->incoming_type = self::INCOMING_LOCAL;
        if (strlen($this->settings->get('mail_incoming_mail', '')) > 0) {
            $this->incoming_type =  (int) $this->settings->get('mail_incoming_mail');
        }

        $this->mail_address_option = self::FIRST_EMAIL;
        if (strlen($this->settings->get('mail_address_option', '')) > 0) {
            $this->mail_address_option = (int) $this->settings->get('mail_address_option');
        }

        $this->linebreak = self::DEFAULT_LINE_BREAK;
        $this->cronjob_notification = 0;
        $this->signature = null;

        $this->db->replace(
            $this->table_mail_options,
            [
                'user_id' => ['integer', $this->user_id],
            ],
            [
                'linebreak' => ['integer', $this->linebreak],
                'signature' => ['text', $this->signature],
                'incoming_type' => ['integer', $this->incoming_type],
                'mail_address_option' => ['integer', $this->mail_address_option],
                'cronjob_notification' => ['integer', $this->cronjob_notification]
            ]
        );
    }

    protected function read()
    {
        $res = $this->db->queryF(
            'SELECT mail_options.cronjob_notification,
                                        mail_options.signature,
                                        mail_options.linebreak,
                                        mail_options.incoming_type,
                                        mail_options.mail_address_option,
                                        usr_data.email,
                                        usr_data.second_email
                         FROM mail_options 
                         LEFT JOIN usr_data ON mail_options.user_id = usr_data.usr_id
                         WHERE mail_options.user_id = %s',
            array('integer'),
            array($this->user_id)
        );
        $row = $this->db->fetchObject($res);

        if ($row !== null) {
            $this->cronjob_notification = (int) $row->cronjob_notification;
            $this->signature = $row->signature;
            $this->linebreak = (int) $row->linebreak;
            $this->incoming_type = (int) $row->incoming_type;
            $this->mail_address_option = (int) $row->mail_address_option;

            if (
                filter_var(
                    $this->incoming_type,
                    FILTER_VALIDATE_INT,
                    ['options' => ['min_range' => self::INCOMING_LOCAL, 'max_range' => self::INCOMING_BOTH]]
                ) === false
            ) {
                $this->incoming_type = self::INCOMING_LOCAL;
            }

            if (
                filter_var(
                    $this->mail_address_option,
                    FILTER_VALIDATE_INT,
                    ['options' => ['min_range' => self::FIRST_EMAIL, 'max_range' => self::BOTH_EMAIL]]
                ) === false
            ) {
                $this->mail_address_option = self::FIRST_EMAIL;
            }

            $firstMailAddress = (string) $row->email;
            $secondMailAddress = (string) $row->second_email;

            $this->mailTransportSettings->adjust($firstMailAddress, $secondMailAddress);
        }
    }

    public function updateOptions()
    {
        $data = [
            'signature' => ['text', $this->getSignature()],
            'linebreak' => ['integer', (int) $this->getLinebreak()],
            'incoming_type' => ['integer', $this->getIncomingType()],
            'mail_address_option' => ['integer', $this->getMailAddressOption()]
        ];

        if ($this->settings->get('mail_notification')) {
            $data['cronjob_notification'] = ['integer', (int) $this->getCronjobNotification()];
        } else {
            $data['cronjob_notification'] = ['integer', (int) self::lookupNotificationSetting($this->user_id)];
        }

        return $this->db->replace(
            $this->table_mail_options,
            [
                'user_id' => ['integer', $this->user_id]
            ],
            $data
        );
    }

    public function getLinebreak()
    {
        return $this->linebreak;
    }

    public function getSignature()
    {
        return $this->signature;
    }

    public function getIncomingType()
    {
        return $this->incoming_type;
    }

    public function setLinebreak($linebreak)
    {
        $this->linebreak = $linebreak;
    }

    public function setSignature($signature)
    {
        $this->signature = $signature;
    }

    public function setIncomingType($incoming_type)
    {
        $this->incoming_type = $incoming_type;
    }

    public function setCronjobNotification($cronjob_notification)
    {
        $this->cronjob_notification = $cronjob_notification;
    }

    public function getCronjobNotification()
    {
        return $this->cronjob_notification;
    }
    
    public function getMailAddressOption()
    {
        return $this->mail_address_option;
    }
    
    public function setMailAddressOption($mail_address_option)
    {
        $this->mail_address_option = $mail_address_option;
    }

    protected static function lookupNotificationSetting($usr_id)
    {
        global $DIC;

        $query = "SELECT cronjob_notification FROM mail_options WHERE user_id = " . $DIC->database()->quote($usr_id, 'integer');
        $row = $DIC->database()->fetchAssoc($DIC->database()->query($query));
        return (int) $row['cronjob_notification'];
    }
    
    protected static function lookupExternalEmails(ilObjUser $user, ilMailOptions $mail_options)
    {
        $emailAddresses = array();

        switch ($mail_options->getMailAddressOption()) {
            case self::SECOND_EMAIL:
                if (strlen($user->getSecondEmail())) {
                    $emailAddresses[] = $user->getSecondEmail();
                } elseif (strlen($user->getEmail())) {
                    // fallback, use first email address
                    $emailAddresses[] = $user->getEmail();
                }
                break;
            
            case self::BOTH_EMAIL:
                if (strlen($user->getEmail())) {
                    $emailAddresses[] = $user->getEmail();
                }
                if (strlen($user->getSecondEmail())) {
                    $emailAddresses[] = $user->getSecondEmail();
                }
                break;
            
            case self::FIRST_EMAIL:
            default:
                if (strlen($user->getEmail())) {
                    $emailAddresses[] = $user->getEmail();
                } elseif (strlen($user->getSecondEmail())) {
                    // fallback, use first email address
                    $emailAddresses[] = $user->getSecondEmail();
                }
                break;
        }
        
        return $emailAddresses;
    }
    
    public static function getExternalEmailsByUser(ilObjUser $user, ilMailOptions $mail_options = null)
    {
        if (!($mail_options instanceof ilMailOptions)) {
            $mail_options = new self($user->getId());
        }

        return self::lookupExternalEmails($user, $mail_options);
    }
    
    public static function getExternalEmailsByUserId($user_id, ilMailOptions $mail_options = null)
    {
        return self::getExternalEmailsByUser(new ilObjUser($user_id), $mail_options);
    }
}