Elep

<?php

/*
 * Copyright (C) 2013 Mailgun
 *
 * This software may be modified and distributed under the terms
 * of the MIT license. See the LICENSE file for details.
 */

namespace Mailgun\Messages;

use Mailgun\Constants\Api;
use Mailgun\Constants\ExceptionMessages;
use Mailgun\Messages\Exceptions\InvalidParameter;
use Mailgun\Messages\Exceptions\TooManyParameters;

/**
 * This class is used for composing a properly formed
 * message object. Dealing with arrays can be cumbersome,
 * this class makes the process easier. See the official
 * documentation (link below) for usage instructions.
 *
 * @deprecated Will be removed in 3.0. Use Mailgun\Message\MessageBuilder
 * @see https://github.com/mailgun/mailgun-php/blob/master/src/Mailgun/Messages/README.md
 */
class MessageBuilder
{
    /**
     * @var array
     */
    protected $message = [];

/**
     * @var array
     */
    protected $variables = [];

/**
     * @var array
     */
    protected $files = [];

/**
     * @var array
     */
    protected $counters = [
        'recipients' => [
            'to' => 0,
            'cc' => 0,
            'bcc' => 0,
        ],
        'attributes' => [
            'attachment' => 0,
            'campaign_id' => 0,
            'custom_option' => 0,
            'tag' => 0,
        ],
    ];

/**
     * @param array  $params
     * @param string $key
     * @param mixed  $default
     *
     * @return mixed
     */
    protected function safeGet($params, $key, $default)
    {
        if (array_key_exists($key, $params)) {
            return $params[$key];
        }

return $default;
    }

/**
     * @param array $params
     *
     * @return mixed|string
     */
    protected function getFullName($params)
    {
        if (array_key_exists('first', $params)) {
            $first = $this->safeGet($params, 'first', '');
            $last = $this->safeGet($params, 'last', '');

return trim("$first $last");
        }

return $this->safeGet($params, 'full_name', '');
    }

/**
     * @param string $address
     * @param array  $variables
     *
     * @return string
     */
    protected function parseAddress($address, $variables)
    {
        if (!is_array($variables)) {
            return $address;
        }
        $fullName = $this->getFullName($variables);
        if (null != $fullName) {
            return sprintf('"%s" <%s>', $fullName, $address);
        }

return $address;
    }

/**
     * @param string $headerName
     * @param string $address
     * @param array  $variables
     */
    protected function addRecipient($headerName, $address, $variables)
    {
        $compiledAddress = $this->parseAddress($address, $variables);

if ('h:reply-to' === $headerName) {
            $this->message[$headerName] = $compiledAddress;
        } elseif (isset($this->message[$headerName])) {
            array_push($this->message[$headerName], $compiledAddress);
        } else {
            $this->message[$headerName] = [$compiledAddress];
        }
        if (array_key_exists($headerName, $this->counters['recipients'])) {
            $this->counters['recipients'][$headerName] += 1;
        }
    }

/**
     * @param string     $address
     * @param array|null $variables
     *
     * @throws TooManyParameters
     *
     * @return mixed
     */
    public function addToRecipient($address, $variables = null)
    {
        if ($this->counters['recipients']['to'] > Api::RECIPIENT_COUNT_LIMIT) {
            throw new TooManyParameters(ExceptionMessages::TOO_MANY_PARAMETERS_RECIPIENT);
        }

$variables = is_array($variables) ? $variables : [];

$this->addRecipient('to', $address, $variables);

return end($this->message['to']);
    }

/**
     * @param string     $address
     * @param array|null $variables
     *
     * @throws TooManyParameters
     *
     * @return mixed
     */
    public function addCcRecipient($address, $variables = null)
    {
        if ($this->counters['recipients']['cc'] > Api::RECIPIENT_COUNT_LIMIT) {
            throw new TooManyParameters(ExceptionMessages::TOO_MANY_PARAMETERS_RECIPIENT);
        }

$variables = is_array($variables) ? $variables : [];

$this->addRecipient('cc', $address, $variables);

return end($this->message['cc']);
    }

/**
     * @param string     $address
     * @param array|null $variables
     *
     * @throws TooManyParameters
     *
     * @return mixed
     */
    public function addBccRecipient($address, $variables = null)
    {
        if ($this->counters['recipients']['bcc'] > Api::RECIPIENT_COUNT_LIMIT) {
            throw new TooManyParameters(ExceptionMessages::TOO_MANY_PARAMETERS_RECIPIENT);
        }

$variables = is_array($variables) ? $variables : [];

$this->addRecipient('bcc', $address, $variables);

return end($this->message['bcc']);
    }

/**
     * @param string     $address
     * @param array|null $variables
     *
     * @return mixed
     */
    public function setFromAddress($address, $variables = null)
    {
        $variables = is_array($variables) ? $variables : [];

$this->addRecipient('from', $address, $variables);

return $this->message['from'];
    }

/**
     * @param string     $address
     * @param array|null $variables
     *
     * @return mixed
     */
    public function setReplyToAddress($address, $variables = null)
    {
        $variables = is_array($variables) ? $variables : [];

$this->addRecipient('h:reply-to', $address, $variables);

return $this->message['h:reply-to'];
    }

/**
     * @param string $subject
     *
     * @return mixed
     */
    public function setSubject($subject = '')
    {
        if (null == $subject || '' == $subject) {
            $subject = ' ';
        }
        $this->message['subject'] = $subject;

return $this->message['subject'];
    }

/**
     * @param string $headerName
     * @param mixed  $headerData
     *
     * @return mixed
     */
    public function addCustomHeader($headerName, $headerData)
    {
        if (!preg_match('/^h:/i', $headerName)) {
            $headerName = 'h:'.$headerName;
        }

if (array_key_exists($headerName, $this->message)) {
            if (is_array($this->message[$headerName])) {
                $this->message[$headerName][] = $headerData;
            } else {
                $this->message[$headerName] = [$this->message[$headerName], $headerData];
            }
        } else {
            $this->message[$headerName] = $headerData;
        }

return $this->message[$headerName];
    }

/**
     * @param string $textBody
     *
     * @return string
     */
    public function setTextBody($textBody)
    {
        if (null == $textBody || '' == $textBody) {
            $textBody = ' ';
        }
        $this->message['text'] = $textBody;

return $this->message['text'];
    }

/**
     * @param string $htmlBody
     *
     * @return string
     */
    public function setHtmlBody($htmlBody)
    {
        if (null == $htmlBody || '' == $htmlBody) {
            $htmlBody = ' ';
        }
        $this->message['html'] = $htmlBody;

return $this->message['html'];
    }

/**
     * @param string      $attachmentPath
     * @param string|null $attachmentName
     *
     * @return bool
     */
    public function addAttachment($attachmentPath, $attachmentName = null)
    {
        if (isset($this->files['attachment'])) {
            $attachment = [
                'filePath' => $attachmentPath,
                'remoteName' => $attachmentName,
            ];
            array_push($this->files['attachment'], $attachment);
        } else {
            $this->files['attachment'] = [
                [
                    'filePath' => $attachmentPath,
                    'remoteName' => $attachmentName,
                ],
            ];
        }

return true;
    }

/**
     * @param string      $inlineImagePath
     * @param string|null $inlineImageName
     *
     * @throws InvalidParameter
     *
     * @return bool
     */
    public function addInlineImage($inlineImagePath, $inlineImageName = null)
    {
        if (0 !== strpos($inlineImagePath, '@')) {
            throw new InvalidParameter(ExceptionMessages::INVALID_PARAMETER_INLINE);
        }

$this->files['inline'][] = [
            'filePath' => $inlineImagePath,
            'remoteName' => $inlineImageName,
        ];

return true;
    }

/**
     * @param bool $testMode
     *
     * @return string
     */
    public function setTestMode($testMode)
    {
        if (filter_var($testMode, FILTER_VALIDATE_BOOLEAN)) {
            $testMode = 'yes';
        } else {
            $testMode = 'no';
        }
        $this->message['o:testmode'] = $testMode;

return $this->message['o:testmode'];
    }

/**
     * @param string|int $campaignId
     *
     * @throws TooManyParameters
     *
     * @return string|int
     */
    public function addCampaignId($campaignId)
    {
        if ($this->counters['attributes']['campaign_id'] < Api::CAMPAIGN_ID_LIMIT) {
            if (isset($this->message['o:campaign'])) {
                array_push($this->message['o:campaign'], (string) $campaignId);
            } else {
                $this->message['o:campaign'] = [(string) $campaignId];
            }
            $this->counters['attributes']['campaign_id'] += 1;

return $this->message['o:campaign'];
        } else {
            throw new TooManyParameters(ExceptionMessages::TOO_MANY_PARAMETERS_CAMPAIGNS);
        }
    }

/**
     * @param string $tag
     *
     * @throws TooManyParameters
     */
    public function addTag($tag)
    {
        if ($this->counters['attributes']['tag'] < Api::TAG_LIMIT) {
            if (isset($this->message['o:tag'])) {
                array_push($this->message['o:tag'], $tag);
            } else {
                $this->message['o:tag'] = [$tag];
            }
            $this->counters['attributes']['tag'] += 1;

return $this->message['o:tag'];
        } else {
            throw new TooManyParameters(ExceptionMessages::TOO_MANY_PARAMETERS_TAGS);
        }
    }

/**
     * @param bool $enabled
     *
     * @return mixed
     */
    public function setDkim($enabled)
    {
        if (filter_var($enabled, FILTER_VALIDATE_BOOLEAN)) {
            $enabled = 'yes';
        } else {
            $enabled = 'no';
        }
        $this->message['o:dkim'] = $enabled;

return $this->message['o:dkim'];
    }

/**
     * @param bool $enabled
     *
     * @return string
     */
    public function setOpenTracking($enabled)
    {
        if (filter_var($enabled, FILTER_VALIDATE_BOOLEAN)) {
            $enabled = 'yes';
        } else {
            $enabled = 'no';
        }
        $this->message['o:tracking-opens'] = $enabled;

return $this->message['o:tracking-opens'];
    }

/**
     * @param bool $enabled
     *
     * @return string
     */
    public function setClickTracking($enabled)
    {
        if (filter_var($enabled, FILTER_VALIDATE_BOOLEAN)) {
            $enabled = 'yes';
        } elseif ('html' == $enabled) {
            $enabled = 'html';
        } else {
            $enabled = 'no';
        }
        $this->message['o:tracking-clicks'] = $enabled;

return $this->message['o:tracking-clicks'];
    }

/**
     * @param string      $timeDate
     * @param string|null $timeZone
     *
     * @return string
     */
    public function setDeliveryTime($timeDate, $timeZone = null)
    {
        if (isset($timeZone)) {
            $timeZoneObj = new \DateTimeZone("$timeZone");
        } else {
            $timeZoneObj = new \DateTimeZone(Api::DEFAULT_TIME_ZONE);
        }

$dateTimeObj = new \DateTime($timeDate, $timeZoneObj);
        $formattedTimeDate = $dateTimeObj->format(\DateTime::RFC2822);
        $this->message['o:deliverytime'] = $formattedTimeDate;

return $this->message['o:deliverytime'];
    }

/**
     * @param string $customName
     * @param mixed  $data
     */
    public function addCustomData($customName, $data)
    {
        $this->message['v:'.$customName] = json_encode($data);
    }

/**
     * @param string $parameterName
     * @param mixed  $data
     *
     * @return mixed
     */
    public function addCustomParameter($parameterName, $data)
    {
        if (isset($this->message[$parameterName])) {
            array_push($this->message[$parameterName], $data);

return $this->message[$parameterName];
        } else {
            $this->message[$parameterName] = [$data];

return $this->message[$parameterName];
        }
    }

/**
     * @param array $message
     */
    public function setMessage($message)
    {
        $this->message = $message;
    }

/**
     * @return array
     */
    public function getMessage()
    {
        return $this->message;
    }

/**
     * @return array
     */
    public function getFiles()
    {
        return $this->files;
    }
}