File: serve/vendor/topthink/framework/src/think/log/driver/Socket.php
Package: Application
Class hierarchy: \think\log\driver\Socket
Implements: \think\contract\LogHandlerInterface
Uses

Properties

$app

$app

$config

$config

$css

$css

$allowForceClientIds

$allowForceClientIds

$clientArg

$clientArg

Methods

__construct()

__construct(\think\App  $app, array  $config = []) : mixed

架构函数

Parameters

\think\App	$app
array	$config	缓存参数

Returns

mixed —

save()

save(array  $log = []) : bool

调试输出接口

Parameters

array

$log

日志信息

Returns

bool —

sendToClient()

sendToClient( $tabid,  $clientId,  $logs,  $forceClientId) : mixed

发送给指定客户端

Parameters

	$tabid
	$clientId
	$logs
	$forceClientId

Returns

mixed —

Inherited from: \think\log\driver\Socket
Uses

Tags

author	Zjmainstay

check()

check() : bool

检测客户授权

Returns

bool —

getClientArg()

getClientArg(string  $name) : string

获取客户参数

Parameters

string

$name

Returns

string —

send()

send(string  $host, int  $port, string  $message = '', string  $address = '/') : bool

Parameters

string	$host	$host of socket server
int	$port	$port of socket server
string	$message	发送的消息
string	$address	地址

Returns

bool —

<?php
// +----------------------------------------------------------------------
// | ThinkPHP [ WE CAN DO IT JUST THINK IT ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006-2021 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: luofei614 <weibo.com/luofei614>
// +----------------------------------------------------------------------
declare (strict_types = 1);

namespace think\log\driver;

use Psr\Container\NotFoundExceptionInterface;
use think\App;
use think\contract\LogHandlerInterface;

/**
 * github: https://github.com/luofei614/SocketLog
 * @author luofei614<weibo.com/luofei614>
 */
class Socket implements LogHandlerInterface
{
    protected $app;

    protected $config = [
        // socket服务器地址
        'host'                => 'localhost',
        // socket服务器端口
        'port'                => 1116,
        // 是否显示加载的文件列表
        'show_included_files' => false,
        // 日志强制记录到配置的client_id
        'force_client_ids'    => [],
        // 限制允许读取日志的client_id
        'allow_client_ids'    => [],
        // 调试开关
        'debug'               => false,
        // 输出到浏览器时默认展开的日志级别
        'expand_level'        => ['debug'],
        // 日志头渲染回调
        'format_head'         => null,
        // curl opt
        'curl_opt'            => [
            CURLOPT_CONNECTTIMEOUT => 1,
            CURLOPT_TIMEOUT        => 10,
        ],
    ];

    protected $css = [
        'sql'      => 'color:#009bb4;',
        'sql_warn' => 'color:#009bb4;font-size:14px;',
        'error'    => 'color:#f4006b;font-size:14px;',
        'page'     => 'color:#40e2ff;background:#171717;',
        'big'      => 'font-size:20px;color:red;',
    ];

    protected $allowForceClientIds = []; //配置强制推送且被授权的client_id

    protected $clientArg = [];

    /**
     * 架构函数
     * @access public
     * @param App   $app
     * @param array $config 缓存参数
     */
    public function __construct(App $app, array $config = [])
    {
        $this->app = $app;

        if (!empty($config)) {
            $this->config = array_merge($this->config, $config);
        }

        if (!isset($config['debug'])) {
            $this->config['debug'] = $app->isDebug();
        }
    }

    /**
     * 调试输出接口
     * @access public
     * @param array $log 日志信息
     * @return bool
     */
    public function save(array $log = []): bool
    {
        if (!$this->check()) {
            return false;
        }

        $trace = [];

        if ($this->config['debug']) {
            if ($this->app->exists('request')) {
                $currentUri = $this->app->request->url(true);
            } else {
                $currentUri = 'cmd:' . implode(' ', $_SERVER['argv'] ?? []);
            }

            if (!empty($this->config['format_head'])) {
                try {
                    $currentUri = $this->app->invoke($this->config['format_head'], [$currentUri]);
                } catch (NotFoundExceptionInterface $notFoundException) {
                    // Ignore exception
                }
            }

            // 基本信息
            $trace[] = [
                'type' => 'group',
                'msg'  => $currentUri,
                'css'  => $this->css['page'],
            ];
        }

        $expandLevel = array_flip($this->config['expand_level']);

        foreach ($log as $type => $val) {
            $trace[] = [
                'type' => isset($expandLevel[$type]) ? 'group' : 'groupCollapsed',
                'msg'  => '[ ' . $type . ' ]',
                'css'  => $this->css[$type] ?? '',
            ];

            foreach ($val as $msg) {
                if (!is_string($msg)) {
                    $msg = var_export($msg, true);
                }
                $trace[] = [
                    'type' => 'log',
                    'msg'  => $msg,
                    'css'  => '',
                ];
            }

            $trace[] = [
                'type' => 'groupEnd',
                'msg'  => '',
                'css'  => '',
            ];
        }

        if ($this->config['show_included_files']) {
            $trace[] = [
                'type' => 'groupCollapsed',
                'msg'  => '[ file ]',
                'css'  => '',
            ];

            $trace[] = [
                'type' => 'log',
                'msg'  => implode("\n", get_included_files()),
                'css'  => '',
            ];

            $trace[] = [
                'type' => 'groupEnd',
                'msg'  => '',
                'css'  => '',
            ];
        }

        $trace[] = [
            'type' => 'groupEnd',
            'msg'  => '',
            'css'  => '',
        ];

        $tabid = $this->getClientArg('tabid');

        if (!$clientId = $this->getClientArg('client_id')) {
            $clientId = '';
        }

        if (!empty($this->allowForceClientIds)) {
            //强制推送到多个client_id
            foreach ($this->allowForceClientIds as $forceClientId) {
                $clientId = $forceClientId;
                $this->sendToClient($tabid, $clientId, $trace, $forceClientId);
            }
        } else {
            $this->sendToClient($tabid, $clientId, $trace, '');
        }

        return true;
    }

    /**
     * 发送给指定客户端
     * @access protected
     * @author Zjmainstay
     * @param  $tabid
     * @param  $clientId
     * @param  $logs
     * @param  $forceClientId
     */
    protected function sendToClient($tabid, $clientId, $logs, $forceClientId)
    {
        $logs = [
            'tabid'           => $tabid,
            'client_id'       => $clientId,
            'logs'            => $logs,
            'force_client_id' => $forceClientId,
        ];

        $msg     = json_encode($logs, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_PARTIAL_OUTPUT_ON_ERROR);
        $address = '/' . $clientId; //将client_id作为地址， server端通过地址判断将日志发布给谁

        $this->send($this->config['host'], $this->config['port'], $msg, $address);
    }

    /**
     * 检测客户授权
     * @access protected
     * @return bool
     */
    protected function check()
    {
        $tabid = $this->getClientArg('tabid');

        //是否记录日志的检查
        if (!$tabid && !$this->config['force_client_ids']) {
            return false;
        }

        //用户认证
        $allowClientIds = $this->config['allow_client_ids'];

        if (!empty($allowClientIds)) {
            //通过数组交集得出授权强制推送的client_id
            $this->allowForceClientIds = array_intersect($allowClientIds, $this->config['force_client_ids']);
            if (!$tabid && count($this->allowForceClientIds)) {
                return true;
            }

            $clientId = $this->getClientArg('client_id');
            if (!in_array($clientId, $allowClientIds)) {
                return false;
            }
        } else {
            $this->allowForceClientIds = $this->config['force_client_ids'];
        }

        return true;
    }

    /**
     * 获取客户参数
     * @access protected
     * @param string $name
     * @return string
     */
    protected function getClientArg(string $name)
    {
        if (!$this->app->exists('request')) {
            return '';
        }

        if (empty($this->clientArg)) {
            if (empty($socketLog = $this->app->request->header('socketlog'))) {
                if (empty($socketLog = $this->app->request->header('User-Agent'))) {
                    return '';
                }
            }

            if (!preg_match('/SocketLog\((.*?)\)/', $socketLog, $match)) {
                $this->clientArg = ['tabid' => null, 'client_id' => null];
                return '';
            }
            parse_str($match[1] ?? '', $this->clientArg);
        }

        if (isset($this->clientArg[$name])) {
            return $this->clientArg[$name];
        }

        return '';
    }

    /**
     * @access protected
     * @param string $host    - $host of socket server
     * @param int    $port    - $port of socket server
     * @param string $message - 发送的消息
     * @param string $address - 地址
     * @return bool
     */
    protected function send($host, $port, $message = '', $address = '/')
    {
        $url = 'http://' . $host . ':' . $port . $address;
        $ch  = curl_init();

        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $message);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $this->config['curl_opt'][CURLOPT_CONNECTTIMEOUT] ?? 1);
        curl_setopt($ch, CURLOPT_TIMEOUT, $this->config['curl_opt'][CURLOPT_TIMEOUT] ?? 10);

        $headers = [
            "Content-Type: application/json;charset=UTF-8",
        ];

        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); //设置header

        return curl_exec($ch);
    }
}