2022-10-17 21:25:03 +02:00
|
|
|
<?php declare(strict_types=1);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This file is part of the Monolog package.
|
|
|
|
*
|
|
|
|
* (c) Jordi Boggiano <j.boggiano@seld.be>
|
|
|
|
*
|
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace Monolog\Handler;
|
|
|
|
|
|
|
|
use Monolog\Formatter\FormatterInterface;
|
2023-07-02 23:57:24 +02:00
|
|
|
use Monolog\Logger;
|
2022-10-17 21:25:03 +02:00
|
|
|
use Monolog\Utils;
|
|
|
|
use Monolog\Handler\Slack\SlackRecord;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sends notifications through Slack API
|
|
|
|
*
|
|
|
|
* @author Greg Kedzierski <greg@gregkedzierski.com>
|
|
|
|
* @see https://api.slack.com/
|
2023-07-02 23:57:24 +02:00
|
|
|
*
|
|
|
|
* @phpstan-import-type FormattedRecord from AbstractProcessingHandler
|
2022-10-17 21:25:03 +02:00
|
|
|
*/
|
|
|
|
class SlackHandler extends SocketHandler
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* Slack API token
|
2023-07-02 23:57:24 +02:00
|
|
|
* @var string
|
2022-10-17 21:25:03 +02:00
|
|
|
*/
|
2023-07-02 23:57:24 +02:00
|
|
|
private $token;
|
2022-10-17 21:25:03 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Instance of the SlackRecord util class preparing data for Slack API.
|
2023-07-02 23:57:24 +02:00
|
|
|
* @var SlackRecord
|
2022-10-17 21:25:03 +02:00
|
|
|
*/
|
2023-07-02 23:57:24 +02:00
|
|
|
private $slackRecord;
|
2022-10-17 21:25:03 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $token Slack API token
|
|
|
|
* @param string $channel Slack channel (encoded ID or name)
|
|
|
|
* @param string|null $username Name of a bot
|
|
|
|
* @param bool $useAttachment Whether the message should be added to Slack as attachment (plain text otherwise)
|
|
|
|
* @param string|null $iconEmoji The emoji name to use (or null)
|
|
|
|
* @param bool $useShortAttachment Whether the context/extra messages added to Slack as attachments are in a short style
|
|
|
|
* @param bool $includeContextAndExtra Whether the attachment should include context and extra data
|
|
|
|
* @param string[] $excludeFields Dot separated list of fields to exclude from slack message. E.g. ['context.field1', 'extra.field2']
|
|
|
|
* @throws MissingExtensionException If no OpenSSL PHP extension configured
|
|
|
|
*/
|
|
|
|
public function __construct(
|
|
|
|
string $token,
|
|
|
|
string $channel,
|
|
|
|
?string $username = null,
|
|
|
|
bool $useAttachment = true,
|
|
|
|
?string $iconEmoji = null,
|
2023-07-02 23:57:24 +02:00
|
|
|
$level = Logger::CRITICAL,
|
2022-10-17 21:25:03 +02:00
|
|
|
bool $bubble = true,
|
|
|
|
bool $useShortAttachment = false,
|
|
|
|
bool $includeContextAndExtra = false,
|
2023-07-02 23:57:24 +02:00
|
|
|
array $excludeFields = array(),
|
2022-10-17 21:25:03 +02:00
|
|
|
bool $persistent = false,
|
|
|
|
float $timeout = 0.0,
|
|
|
|
float $writingTimeout = 10.0,
|
|
|
|
?float $connectionTimeout = null,
|
|
|
|
?int $chunkSize = null
|
|
|
|
) {
|
|
|
|
if (!extension_loaded('openssl')) {
|
|
|
|
throw new MissingExtensionException('The OpenSSL PHP extension is required to use the SlackHandler');
|
|
|
|
}
|
|
|
|
|
|
|
|
parent::__construct(
|
|
|
|
'ssl://slack.com:443',
|
|
|
|
$level,
|
|
|
|
$bubble,
|
|
|
|
$persistent,
|
|
|
|
$timeout,
|
|
|
|
$writingTimeout,
|
|
|
|
$connectionTimeout,
|
|
|
|
$chunkSize
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->slackRecord = new SlackRecord(
|
|
|
|
$channel,
|
|
|
|
$username,
|
|
|
|
$useAttachment,
|
|
|
|
$iconEmoji,
|
|
|
|
$useShortAttachment,
|
|
|
|
$includeContextAndExtra,
|
|
|
|
$excludeFields
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->token = $token;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getSlackRecord(): SlackRecord
|
|
|
|
{
|
|
|
|
return $this->slackRecord;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getToken(): string
|
|
|
|
{
|
|
|
|
return $this->token;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2023-07-02 23:57:24 +02:00
|
|
|
* {@inheritDoc}
|
2022-10-17 21:25:03 +02:00
|
|
|
*/
|
2023-07-02 23:57:24 +02:00
|
|
|
protected function generateDataStream(array $record): string
|
2022-10-17 21:25:03 +02:00
|
|
|
{
|
|
|
|
$content = $this->buildContent($record);
|
|
|
|
|
|
|
|
return $this->buildHeader($content) . $content;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Builds the body of API call
|
2023-07-02 23:57:24 +02:00
|
|
|
*
|
|
|
|
* @phpstan-param FormattedRecord $record
|
2022-10-17 21:25:03 +02:00
|
|
|
*/
|
2023-07-02 23:57:24 +02:00
|
|
|
private function buildContent(array $record): string
|
2022-10-17 21:25:03 +02:00
|
|
|
{
|
|
|
|
$dataArray = $this->prepareContentData($record);
|
|
|
|
|
|
|
|
return http_build_query($dataArray);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2023-07-02 23:57:24 +02:00
|
|
|
* @phpstan-param FormattedRecord $record
|
2022-10-17 21:25:03 +02:00
|
|
|
* @return string[]
|
|
|
|
*/
|
2023-07-02 23:57:24 +02:00
|
|
|
protected function prepareContentData(array $record): array
|
2022-10-17 21:25:03 +02:00
|
|
|
{
|
|
|
|
$dataArray = $this->slackRecord->getSlackData($record);
|
|
|
|
$dataArray['token'] = $this->token;
|
|
|
|
|
2023-07-02 23:57:24 +02:00
|
|
|
if (!empty($dataArray['attachments'])) {
|
2022-10-17 21:25:03 +02:00
|
|
|
$dataArray['attachments'] = Utils::jsonEncode($dataArray['attachments']);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $dataArray;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Builds the header of the API Call
|
|
|
|
*/
|
|
|
|
private function buildHeader(string $content): string
|
|
|
|
{
|
|
|
|
$header = "POST /api/chat.postMessage HTTP/1.1\r\n";
|
|
|
|
$header .= "Host: slack.com\r\n";
|
|
|
|
$header .= "Content-Type: application/x-www-form-urlencoded\r\n";
|
|
|
|
$header .= "Content-Length: " . strlen($content) . "\r\n";
|
|
|
|
$header .= "\r\n";
|
|
|
|
|
|
|
|
return $header;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2023-07-02 23:57:24 +02:00
|
|
|
* {@inheritDoc}
|
2022-10-17 21:25:03 +02:00
|
|
|
*/
|
2023-07-02 23:57:24 +02:00
|
|
|
protected function write(array $record): void
|
2022-10-17 21:25:03 +02:00
|
|
|
{
|
|
|
|
parent::write($record);
|
|
|
|
$this->finalizeWrite();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Finalizes the request by reading some bytes and then closing the socket
|
|
|
|
*
|
|
|
|
* If we do not read some but close the socket too early, slack sometimes
|
|
|
|
* drops the request entirely.
|
|
|
|
*/
|
|
|
|
protected function finalizeWrite(): void
|
|
|
|
{
|
|
|
|
$res = $this->getResource();
|
|
|
|
if (is_resource($res)) {
|
|
|
|
@fread($res, 2048);
|
|
|
|
}
|
|
|
|
$this->closeSocket();
|
|
|
|
}
|
|
|
|
|
|
|
|
public function setFormatter(FormatterInterface $formatter): HandlerInterface
|
|
|
|
{
|
|
|
|
parent::setFormatter($formatter);
|
|
|
|
$this->slackRecord->setFormatter($formatter);
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getFormatter(): FormatterInterface
|
|
|
|
{
|
|
|
|
$formatter = parent::getFormatter();
|
|
|
|
$this->slackRecord->setFormatter($formatter);
|
|
|
|
|
|
|
|
return $formatter;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Channel used by the bot when posting
|
|
|
|
*/
|
|
|
|
public function setChannel(string $channel): self
|
|
|
|
{
|
|
|
|
$this->slackRecord->setChannel($channel);
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Username used by the bot when posting
|
|
|
|
*/
|
|
|
|
public function setUsername(string $username): self
|
|
|
|
{
|
|
|
|
$this->slackRecord->setUsername($username);
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function useAttachment(bool $useAttachment): self
|
|
|
|
{
|
|
|
|
$this->slackRecord->useAttachment($useAttachment);
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function setIconEmoji(string $iconEmoji): self
|
|
|
|
{
|
|
|
|
$this->slackRecord->setUserIcon($iconEmoji);
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function useShortAttachment(bool $useShortAttachment): self
|
|
|
|
{
|
|
|
|
$this->slackRecord->useShortAttachment($useShortAttachment);
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function includeContextAndExtra(bool $includeContextAndExtra): self
|
|
|
|
{
|
|
|
|
$this->slackRecord->includeContextAndExtra($includeContextAndExtra);
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string[] $excludeFields
|
|
|
|
*/
|
|
|
|
public function excludeFields(array $excludeFields): self
|
|
|
|
{
|
|
|
|
$this->slackRecord->excludeFields($excludeFields);
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
}
|