zhamao-robot/zhamao-framework
1
0
Fork 0
mirror of https://github.com/zhamao-robot/zhamao-framework.git synced 2026-07-23 08:35:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor all base things

Browse Source
This commit is contained in:
crazywhalecc
2022-08-13 17:00:29 +08:00
committed by Jerry Ma
parent 1c801bb205
commit b2c95d96b1
54 changed files with 3009 additions and 383 deletions
Download Patch File Download Diff File Expand all files Collapse all files

170
src/ZM/Utils/HttpUtil.php Normal file
View File

@@ -0,0 +1,170 @@
<?php
declare(strict_types=1);
namespace ZM\Utils;
use OneBot\Http\HttpFactory;
use OneBot\Http\ServerRequest;
use OneBot\Http\Stream;
use Psr\Http\Message\ResponseInterface;
use Symfony\Component\Routing\Exception\MethodNotAllowedException;
use Symfony\Component\Routing\Exception\ResourceNotFoundException;
use Symfony\Component\Routing\Matcher\UrlMatcher;
use Symfony\Component\Routing\RequestContext;
use Symfony\Component\Routing\RouteCollection;
use ZM\Config\ZMConfig;
use ZM\Exception\ConfigException;
use ZM\Store\FileSystem;
/**
* Http 工具类
*/
class HttpUtil
{
/**
* @var RouteCollection
*/
private static $routes;
/**
* 解析 Uri，用于匹配路由用的
* 返回值为状态
* 第二个参数为路由节点
* 第三个参数为动态路由节点中匹配到的参数列表
*
* @param mixed $node
* @param mixed $params
*/
public static function parseUri(ServerRequest $request, &$node, &$params): int
{
// 建立上下文，设置当前请求的方法
$context = new RequestContext();
$context->setMethod($request->getMethod());
try {
// 使用UrlMatcher进行匹配Url
$matcher = new UrlMatcher(static::getRouteCollection(), $context);
$matched = $matcher->match($request->getUri()->getPath());
} catch (ResourceNotFoundException $e) {
// 路由找不到会抛出异常，我们不需要这个异常，转换为状态码
return ZM_ERR_ROUTE_NOT_FOUND;
} catch (MethodNotAllowedException $e) {
// 路由匹配到了，但该路由不能使用该方法，所以返回状态码（路由不允许）
return ZM_ERR_ROUTE_METHOD_NOT_ALLOWED;
}
// 匹配到的时候，matched不为空
if (!empty($matched)) {
$node = [
'route' => static::getRouteCollection()->get($matched['_route'])->getPath(),
'class' => $matched['_class'],
'method' => $matched['_method'],
'request_method' => $request->getMethod(),
];
unset($matched['_class'], $matched['_method']);
$params = $matched;
// 返回成功的状态码
return ZM_ERR_NONE;
}
// 返回没有匹配到的状态码
return ZM_ERR_ROUTE_NOT_FOUND;
}
/**
* 解析返回静态文件
*
* @params string $uri 路由地址
* @params string $settings 动态传入的配置模式
* @throws ConfigException
*/
public static function handleStaticPage(string $uri, array $settings = []): ResponseInterface
{
// 确定根目录
$base_dir = $settings['document_root'] ?? ZMConfig::get('global.file_server.document_root');
// 将相对路径转换为绝对路径
if (FileSystem::isRelativePath($base_dir)) {
$base_dir = SOURCE_ROOT_DIR . '/' . $base_dir;
}
// 支持默认缺省搜索的文件名（如index.html）
$base_index = $settings['document_index'] ?? ZMConfig::get('global.file_server.document_index');
if (is_string($base_index)) {
$base_index = [$base_index];
}
$path = realpath($base_dir . urldecode($uri));
if ($path !== false) {
// 安全问题，防止目录穿越，只能囚禁到规定的 Web 根目录下获取文件
$work = realpath($base_dir) . '/';
if (strpos($path, $work) !== 0) {
logger()->info('[403] ' . $uri);
return static::handleHttpCodePage(403);
}
// 如果路径是文件夹的话，如果结尾没有 /，则自动302补充，和传统的Nginx效果相同
if (is_dir($path)) {
if (mb_substr($uri, -1, 1) != '/') {
logger()->info('[302] ' . $uri);
return HttpFactory::getInstance()->createResponse(302, null, ['Location' => $uri . '/']);
}
// 如果结尾有 /，那么就根据默认搜索的文件名进行搜索文件是否存在，存在则直接返回对应文件
foreach ($base_index as $vp) {
if (is_file($path . '/' . $vp)) {
logger()->info('[200] ' . $uri);
$exp = strtolower(pathinfo($path . $vp)['extension'] ?? 'unknown');
return HttpFactory::getInstance()->createResponse()
->withAddedHeader('Content-Type', ZMConfig::get('file_header')[$exp] ?? 'application/octet-stream')
->withBody(HttpFactory::getInstance()->createStream(file_get_contents($path . '/' . $vp)));
}
}
// 如果文件存在，则直接返回文件内容
} elseif (is_file($path)) {
logger()->info('[200] ' . $uri);
$exp = strtolower(pathinfo($path)['extension'] ?? 'unknown');
return HttpFactory::getInstance()->createResponse()
->withAddedHeader('Content-Type', ZMConfig::get('file_header')[$exp] ?? 'application/octet-stream')
->withBody(HttpFactory::getInstance()->createStream(file_get_contents($path)));
}
}
// 否则最终肯定只能返回 404 了
logger()->info('[404] ' . $uri);
return static::handleHttpCodePage(404);
}
/**
* 自动寻找默认的 HTTP Code 页面
*
* @throws ConfigException
*/
public static function handleHttpCodePage(int $code): ResponseInterface
{
// 获取有没有规定 code page
$code_page = ZMConfig::get('global.file_server.document_code_page')[$code] ?? null;
if ($code_page !== null && !file_exists((ZMConfig::get('global.file_server.document_root') ?? '/not/exist/') . '/' . $code_page)) {
$code_page = null;
}
if ($code_page === null) {
return HttpFactory::getInstance()->createResponse($code);
}
return HttpFactory::getInstance()->createResponse($code, null, [], file_get_contents(ZMConfig::get('global.file_server.document_root') . '/' . $code_page));
}
/**
* 快速创建一个 JSON 格式的 HTTP 响应
*
* @param array $data 数据
* @param int $http_code HTTP 状态码
* @param int $json_flag JSON 编码时传入的flag
*/
public static function createJsonResponse(array $data, int $http_code = 200, int $json_flag = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE): ResponseInterface
{
return HttpFactory::getInstance()->createResponse($http_code)
->withAddedHeader('Content-Type', 'application/json')
->withBody(Stream::create(json_encode($data, $json_flag)));
}
public static function getRouteCollection(): RouteCollection
{
if (self::$routes === null) {
self::$routes = new RouteCollection();
}
return self::$routes;
}
}

123
src/ZM/Utils/ReflectionUtil.php Normal file
View File

@@ -0,0 +1,123 @@
<?php
declare(strict_types=1);
namespace ZM\Utils;
use Closure;
use ReflectionException;
use ReflectionFunction;
use ReflectionFunctionAbstract;
use ReflectionMethod;
use ReflectionNamedType;
use ReflectionParameter;
class ReflectionUtil
{
/**
* 获取参数的类名（如有）
*
* @param ReflectionParameter $parameter 参数
* @return null|string 类名，如果参数不是类，返回 null
*/
public static function getParameterClassName(ReflectionParameter $parameter): ?string
{
// 获取参数类型
$type = $parameter->getType();
// 没有声明类型或为基本类型
if (!$type instanceof ReflectionNamedType || $type->isBuiltin()) {
return null;
}
// 获取类名
$class_name = $type->getName();
// 如果存在父类
if (!is_null($class = $parameter->getDeclaringClass())) {
if ($class_name === 'self') {
return $class->getName();
}
if ($class_name === 'parent' && $parent = $class->getParentClass()) {
return $parent->getName();
}
}
return $class_name;
}
/**
* 将传入变量转换为字符串
*
* @param mixed $var
*/
public static function variableToString($var): string
{
switch (true) {
case is_callable($var):
if (is_array($var)) {
if (is_object($var[0])) {
return get_class($var[0]) . '@' . $var[1];
}
return $var[0] . '::' . $var[1];
}
return 'closure';
case is_string($var):
return $var;
case is_array($var):
return 'array' . json_encode($var);
case is_object($var):
return get_class($var);
case is_resource($var):
return 'resource(' . get_resource_type($var) . ')';
case is_null($var):
return 'null';
case is_bool($var):
return $var ? 'true' : 'false';
case is_float($var):
case is_int($var):
return (string) $var;
default:
return 'unknown';
}
}
/**
* 判断传入的回调是否为任意类的非静态方法
*
* @param callable|string $callback 回调
* @throws ReflectionException
*/
public static function isNonStaticMethod($callback): bool
{
if (is_array($callback) && is_string($callback[0])) {
$reflection = new ReflectionMethod($callback[0], $callback[1]);
return !$reflection->isStatic();
}
return false;
}
/**
* 获取传入的回调的反射实例
*
* 如果传入的是类方法，则会返回 {@link ReflectionMethod} 实例
* 否则将返回 {@link ReflectionFunction} 实例
*
* 可传入实现了 __invoke 的类
*
* @param callable|string $callback 回调
* @throws ReflectionException
*/
public static function getCallReflector($callback): ReflectionFunctionAbstract
{
if (is_string($callback) && str_contains($callback, '::')) {
$callback = explode('::', $callback);
} elseif (is_object($callback) && !$callback instanceof Closure) {
$callback = [$callback, '__invoke'];
}
return is_array($callback)
? new ReflectionMethod($callback[0], $callback[1])
: new ReflectionFunction($callback);
}
}

7
src/ZM/Utils/ZMUtil.php
View File

@@ -6,4 +6,11 @@ namespace ZM\Utils;
class ZMUtil
{
/**
* 获取 composer.json 并转为数组进行读取使用
*/
public static function getComposerMetadata(): ?array
{
return json_decode(file_get_contents(SOURCE_ROOT_DIR . '/composer.json'), true);
}
}