class.ilSoapMailXmlParser.php

Go to the documentation of this file.

<?php
/******************************************************************************
 * This file is part of ILIAS, a powerful learning management system.
 * ILIAS is licensed with the GPL-3.0, you should have received a copy
 * of said license along with the source code.
 * If this is not the case or you just want to try ILIAS, you'll find
 * us at:
 * https://www.ilias.de
 * https://github.com/ILIAS-eLearning
 *****************************************************************************/

class ilSoapMailXmlParser extends ilSaxParser
{
    protected array $mails = [];
    protected array $mail = [];
    protected array $attachment = [];
    protected array $lines = [];
    protected string $cdata = '';

    public function __construct(string $a_xml)
    {
        parent::__construct('', true);
        $this->setThrowException(true);
        $this->setXMLContent($a_xml);
    }

    public function getMails() : array
    {
        return $this->mails;
    }

    public function start() : bool
    {
        $this->startParsing();
        return true;
    }

    public function setHandlers($a_xml_parser) : void
    {
        xml_set_object($a_xml_parser, $this);
        xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
        xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
    }

    public function handlerBeginTag($a_xml_parser, string $a_name, array $a_attribs) : void
    {
        switch ($a_name) {
            case 'Mail':
                $this->mail = array();
                $this->mail['usePlaceholders'] = (bool) $a_attribs['usePlaceholders'];
                $this->mail['type'] = $a_attribs['type'] === 'System' ? 'system' : 'normal';
                break;

            case 'To':
                $this->mail['to'] = $this->parseName($a_attribs);
                break;

            case 'Cc':
                $this->mail['cc'] = $this->parseName($a_attribs);
                break;

            case 'Bcc':
                $this->mail['bcc'] = $this->parseName($a_attribs);
                break;

            case 'Subject':
                break;

            case 'Message':
                $this->lines = array();
                break;

            case 'Attachment':
                $this->attachment = array();
                $this->attachment['name'] = $a_attribs['name'];
                break;

        }
    }

    public function handlerEndTag($a_xml_parser, string $a_name) : void
    {
        switch ($a_name) {
            case 'Mail':
                $this->mails[] = $this->mail;
                break;

            case 'Subject':
                $this->mail['subject'] = $this->cdata;
                break;

            case 'Message':
                $this->mail['body'] = $this->lines;
                break;

            case 'P':
                $this->lines[] = trim($this->cdata);
                break;

            case 'Attachment':
                $this->attachment['content'] = base64_decode(trim($this->cdata));
                $this->mail['attachments'][] = $this->attachment;
                break;
        }

        $this->cdata = '';
    }

    public function handlerCharacterData($a_xml_parser, string $a_data) : void
    {
        if ($a_data !== "\n") {
            // Replace multiple tabs with one space
            $a_data = preg_replace("/\t+/", " ", $a_data);
            $this->cdata .= $a_data;
        }
    }

    protected function parseName(array $a_attribs) : string
    {
        if ($a_attribs['obj_id']) {
            $il_id = explode('_', $a_attribs['obj_id']);
            if (!$user = ilObjectFactory::getInstanceByObjId($il_id[3], false)) {
                throw new InvalidArgumentException("Invalid user id given: obj_id => " . $a_attribs['obj_id']);
            }
            return $user->getLogin();
        }
        return (string) ($a_attribs['name'] ?? '');
    }
}