kknongchang_2506/app/Module/ThirdParty/Services/BaseWebhook.php

<?php

namespace App\Module\ThirdParty\Services;

use App\Module\ThirdParty\Models\ThirdPartyService as ServiceModel;
use App\Module\ThirdParty\Models\ThirdPartyCredential;
use App\Module\ThirdParty\Models\ThirdPartyLog;
use App\Module\ThirdParty\Enums\LOG_LEVEL;
use Illuminate\Http\Request;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Facades\Log;

/**
 * 第三方Webhook基类
 * 
 * 处理Webhook分发机制，包含配置读取、配额管理、日志记录等通用功能
 * 基类提供handler接口用于实现Webhook的具体逻辑
 */
abstract class BaseWebhook
{
    /**
     * 服务代码
     */
    protected string $serviceCode;
    
    /**
     * 服务配置
     */
    protected ?ServiceModel $service = null;
    
    /**
     * 认证凭证
     */
    protected ?ThirdPartyCredential $credential = null;
    
    /**
     * 请求对象
     */
    protected Request $request;
    
    /**
     * 请求ID
     */
    protected string $requestId;
    
    /**
     * 开始时间
     */
    protected float $startTime;
    
    /**
     * 构造函数
     * 
     * @param string $serviceCode 服务代码
     * @param Request $request 请求对象
     */
    public function __construct(string $serviceCode, Request $request)
    {
        $this->serviceCode = $serviceCode;
        $this->request = $request;
        $this->requestId = uniqid('webhook_', true);
        $this->startTime = microtime(true);
        
        // 初始化服务配置
        $this->initializeService();
    }
    
    /**
     * 初始化服务配置
     * 
     * @throws \Exception
     */
    protected function initializeService(): void
    {
        $this->service = ServiceModel::where('code', $this->serviceCode)->first();
        
        if (!$this->service) {
            throw new \Exception("服务 {$this->serviceCode} 不存在");
        }
        
        // 获取认证凭证
        $this->credential = $this->service->getActiveCredential();
        if (!$this->credential) {
            throw new \Exception("服务 {$this->serviceCode} 没有可用的认证凭证");
        }
    }
    
    /**
     * 处理Webhook请求
     * 
     * @param string $action 操作类型
     * @return JsonResponse
     */
    public function handle(string $action): JsonResponse
    {
        try {
            // 验证签名
            if (!$this->validateSignature()) {
                throw new \Exception('Webhook签名验证失败');
            }
            
            // 验证请求格式
            $this->validateRequest();
            
            // 执行具体的处理逻辑
            $result = $this->handler($action, $this->request);
            
            // 记录成功日志
            $this->logWebhook($action, $this->request->all(), $result, true);
            
            return response()->json([
                'success' => true,
                'data' => $result,
                'request_id' => $this->requestId,
            ]);
            
        } catch (\Exception $e) {
            // 记录失败日志
            $this->logWebhook($action, $this->request->all(), ['error' => $e->getMessage()], false);
            
            Log::error("Webhook处理失败: {$this->serviceCode}/{$action}", [
                'error' => $e->getMessage(),
                'request_id' => $this->requestId,
                'request_data' => $this->request->all(),
            ]);
            
            return response()->json([
                'success' => false,
                'error' => $e->getMessage(),
                'request_id' => $this->requestId,
            ], 400);
        }
    }
    
    /**
     * 具体的Webhook处理逻辑（由子类实现）
     * 
     * @param string $action 操作类型
     * @param Request $request 请求对象
     * @return array
     */
    abstract protected function handler(string $action, Request $request): array;
    
    /**
     * 验证Webhook签名
     * 
     * @return bool
     */
    protected function validateSignature(): bool
    {
        $webhookSecret = $this->service->webhook_secret;
        
        if (!$webhookSecret) {
            // 如果没有配置密钥，则跳过签名验证
            return true;
        }
        
        $signature = $this->request->header('X-Signature');
        if (!$signature) {
            return false;
        }
        
        $payload = $this->request->getContent();
        $expectedSignature = hash_hmac('sha256', $payload, $webhookSecret);
        
        return hash_equals($expectedSignature, $signature);
    }
    
    /**
     * 验证请求格式（由子类重写）
     * 
     * @throws \Exception
     */
    protected function validateRequest(): void
    {
        // 默认不做验证，子类可以重写此方法
    }
    
    /**
     * 记录Webhook日志
     * 
     * @param string $action 操作类型
     * @param array $requestData 请求数据
     * @param array $result 处理结果
     * @param bool $success 是否成功
     */
    protected function logWebhook(string $action, array $requestData, array $result, bool $success): void
    {
        $responseTime = (int)((microtime(true) - $this->startTime) * 1000);
        
        ThirdPartyLog::create([
            'service_id' => $this->service->id,
            'credential_id' => $this->credential->id,
            'request_id' => $this->requestId,
            'method' => 'WEBHOOK',
            'url' => $this->request->fullUrl(),
            'request_headers' => json_encode($this->request->headers->all()),
            'request_body' => json_encode($requestData),
            'response_status' => $success ? 200 : 400,
            'response_headers' => json_encode([]),
            'response_body' => json_encode($result),
            'response_time' => $responseTime,
            'success' => $success,
            'error_message' => $success ? null : ($result['error'] ?? '未知错误'),
            'level' => $success ? LOG_LEVEL::INFO->value : LOG_LEVEL::ERROR->value,
            'ip_address' => $this->request->ip(),
            'user_agent' => $this->request->userAgent(),
            'called_at' => now(),
        ]);
    }
    
    /**
     * 获取服务配置
     * 
     * @param string|null $key 配置键名，为空则返回全部配置
     * @return mixed
     */
    protected function getConfig(?string $key = null)
    {
        $config = $this->service->config ?? [];
        
        if ($key === null) {
            return $config;
        }
        
        return $config[$key] ?? null;
    }
    
    /**
     * 获取服务信息
     * 
     * @return ServiceModel
     */
    protected function getService(): ServiceModel
    {
        return $this->service;
    }
    
    /**
     * 获取认证凭证
     * 
     * @return ThirdPartyCredential
     */
    protected function getCredential(): ThirdPartyCredential
    {
        return $this->credential;
    }
    
    /**
     * 获取请求ID
     * 
     * @return string
     */
    protected function getRequestId(): string
    {
        return $this->requestId;
    }
    
    /**
     * 获取请求对象
     * 
     * @return Request
     */
    protected function getRequest(): Request
    {
        return $this->request;
    }
}