sergeymakinen\log\SlackTarget

Complexity

Total Complexity

15

Size/Duplication

Total Lines	202
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	5	1
A	export()	0	13	2
A	encodeMessage()	0	4	1
A	encode()	0	4	1
A	getPayload()	0	13	1
B	formatMessageAttachment()	0	33	3
A	insertField()	0	21	4
A	insertIntoPayload()	0	7	2

<?php
/**
 * Slack log target for Yii 2
 *
 * @see       https://github.com/sergeymakinen/yii2-slack-log
 * @copyright Copyright (c) 2016-2017 Sergey Makinen (https://makinen.ru)
 * @license   https://github.com/sergeymakinen/yii2-slack-log/blob/master/LICENSE MIT License
 */

namespace sergeymakinen\log;

use yii\base\InvalidValueException;
use yii\di\Instance;
use yii\helpers\Json;
use yii\httpclient\Client;
use yii\log\Logger;
use yii\log\Target;

class SlackTarget extends Target
{
    /**
     * @var Client|array|string Yii HTTP client configuration.
     * This can be a component ID, a configuration array or a Client instance.
     * @since 1.2
     */
    public $httpClient = [
        'class' => 'yii\httpclient\Client',
    ];

    /**
     * @var string incoming webhook URL.
     */
    public $webhookUrl;

    /**
     * @var string displayed username.
     */
    public $username;

    /**
     * @var string icon URL.
     */
    public $iconUrl;

    /**
     * @var string icon emoji.
     */
    public $iconEmoji;

    /**
     * @var string channel or direct message name.
     */
    public $channel;

    /**
     * @var string[] colors per a logger level.
     */
    public $colors = [
        Logger::LEVEL_ERROR => 'danger',
        Logger::LEVEL_WARNING => 'warning',
    ];

    /**
     * @inheritDoc
     */
    public $exportInterval = 50;

    /**
     * @inheritDoc
     */
    public function init()
    {
        parent::init();
        $this->httpClient = Instance::ensure($this->httpClient, Client::className());
    }

    /**
     * @inheritDoc
     */
    public function export()
    {
        $response = $this->httpClient->post(
            $this->webhookUrl,
            Json::encode($this->getPayload()),
            ['Content-Type: application/json; charset=UTF-8']
        )->send();
        if (!$response->getIsOk()) {
            throw new InvalidValueException(
                'Unable to send logs to Slack: ' . $response->getContent(), (int) $response->getStatusCode()
            );
        }
    }

    /**
     * Encodes special chars in a message as HTML entities.
     * @param string $message
     * @return string
     * @deprecated 1.3
     * @see encode()
     */
    protected function encodeMessage($message)
    {
        return $this->encode($message);
    }

    /**
     * Encodes special chars in a string as HTML entities.
     * @param string $string
     * @return string
     * @since 1.3
     */
    protected function encode($string)
    {
        return htmlspecialchars($string, ENT_NOQUOTES, 'UTF-8');
    }

    /**
     * Returns a Slack API payload.
     * @return array
     * @since 1.2
     */
    protected function getPayload()
    {
        $payload = [
            'parse' => 'none',
            'attachments' => array_map([$this, 'formatMessageAttachment'], $this->messages),
        ];
        $this
            ->insertIntoPayload($payload, 'username', $this->username)
            ->insertIntoPayload($payload, 'icon_url', $this->iconUrl)
            ->insertIntoPayload($payload, 'icon_emoji', $this->iconEmoji)
            ->insertIntoPayload($payload, 'channel', $this->channel);
        return $payload;
    }

    /**
     * Returns a properly formatted message attachment for Slack API.
     * @param array $message
     * @return array
     */
    protected function formatMessageAttachment($message)
    {
        $message = new Message($message, $this);
        $attachment = [
            'fallback' => $this->encode($this->formatMessage($message->message)),
            'title' => ucwords($message->getLevel()),
            'fields' => [],
            'text' => "```\n" . $this->encode($message->getText()) . "\n```",
            'footer' => static::className(),
            'ts' => (int) round($message->getTimestamp()),
            'mrkdwn_in' => [
                'fields',
                'text',
            ],
        ];
        if ($message->getIsConsoleRequest()) {
            $attachment['author_name'] = $message->getCommandLine();
        } else {
            $attachment['author_name'] = $attachment['author_link'] = $message->getUrl();
        }
        if (isset($this->colors[$message->message[1]])) {
            $attachment['color'] = $this->colors[$message->message[1]];
        }
        $this
            ->insertField($attachment, 'Level', $message->getLevel(), true, false)
            ->insertField($attachment, 'Category', $message->getCategory(), true)
            ->insertField($attachment, 'Prefix', $message->getPrefix(), true)
            ->insertField($attachment, 'User IP', $message->getUserIp(), true, false)
            ->insertField($attachment, 'User ID', $message->getUserId(), true, false)
            ->insertField($attachment, 'Session ID', $message->getSessionId(), true)
            ->insertField($attachment, 'Stack Trace', $message->getStackTrace(), false);
        return $attachment;
    }

    /**
     * Inserts the new attachment field if the value is not empty.
     * @param array $attachment
     * @param string $title
     * @param string|null $value
     * @param bool $short
     * @param bool $encodeValue
     * @return $this
     */
    private function insertField(array &$attachment, $title, $value, $short, $encodeValue = true)
    {
        if ((string) $value === '') {
            return $this;
        }

        if ($encodeValue) {
            $value = $this->encode($value);
            if ($short) {
                $value = '`' . $value . '`';
            } else {
                $value = "```\n" . $value . "\n```";
            }
        }
        $attachment['fields'][] = [
            'title' => $title,
            'value' => $value,
            'short' => $short,
        ];
        return $this;
    }

    /**
     * Copies the value to the payload if the value is set.
     * @param array $payload
     * @param string $name
     * @param string $value
     * @return $this
     */
    private function insertIntoPayload(array &$payload, $name, $value)
    {
        if ((string) $value !== '') {
            $payload[$name] = $value;
        }
        return $this;
    }
}