jundayw/laravel-sensitive

Laravel Sensitive Words Filter Package.

v2.1.0 2024-09-14 08:17 UTC

Requires

• php: >=8.0
• illuminate/cache: >=9.0
• illuminate/collections: >=9.0

MIT

• jundayw

• filter
• laravel
• sensitive
• stop word

README

安装

推荐使用 PHP 包管理工具 Composer 软件包管理器安装：

composer require jundayw/laravel-sensitive

接下来，你需要使用 vendor:publish Artisan 命令发布的配置和迁移文件。

配置文件将会保存在 config 文件夹中：

php artisan vendor:publish --provider="Jundayw\LaravelSensitive\SensitiveServiceProvider"

或单独发布配置文件

php artisan vendor:publish --tag=sensitive-config

或单独发布迁移文件

php artisan vendor:publish --tag=sensitive-migrations

最后，您应该运行数据库迁移。

php artisan migrate --path=database/migrations/2022_08_31_182223_create_sensitive_table.php

数据填充：

php artisan db:seed --class=SensitiveSeeder

自定义迁移

如果你不想使用默认迁移，你应该在 sensitive.php 配置文件中将 migration 设置为 false。

您可以通过执行以下命令导出默认迁移：

php artisan vendor:publish --tag=sensitive-migrations

扩展云端过滤器

本扩展包默认支持 Eloquent 驱动的 \Jundayw\LaravelSensitive\LocalInterceptor::class 本地过滤器，

可自定义扩展 百度云、腾讯云、阿里云 的文本审核功能。

<?php

namespace App\Cloud;

use Illuminate\Support\Collection;
use Jundayw\LaravelSensitive\Contracts\InterceptorInterface;

class CloudInterceptor implements InterceptorInterface
{
    public function handle(string $content, string $field): Collection
    {
        return collect([
            // [
            //     'stop_type'   => 'REPLACE',
            //     'stop_words'  => '小额贷款',
            //     'replacement' => 'xxx',
            // ],
        ]);
    }

}

编码实现后需要变更配置文件 interceptor.php 中过滤驱动 driver 为 \App\Cloud\CloudInterceptor::class。

Getting Started

适合通过、拒绝场景

仅支持SensitiveInterface::STATUS_PASS | SensitiveInterface::STATUS_BLOCK

Sensitive::username(string $content);

适合通过、审核、拒绝场景

仅支持SensitiveInterface::STATUS_PASS | SensitiveInterface::STATUS_REVIEW | SensitiveInterface::STATUS_BLOCK

Sensitive::nickname(string $content);

适合通过、审核、替换场景

仅支持SensitiveInterface::STATUS_PASS | SensitiveInterface::STATUS_REVIEW | SensitiveInterface::STATUS_REPLACE

Sensitive::message(string $content);

适合通过、审核、拒绝、替换场景

支持SensitiveInterface::STATUS_ALL

Sensitive::content(string $content);

自定义

支持SensitiveInterface::STATUS_PASS | SensitiveInterface::STATUS_REPLACE | SensitiveInterface::STATUS_REVIEW | SensitiveInterface::STATUS_BLOCK

Sensitive::filter(string $content, string $field = 'username|nickname|message|content', int $scope = SensitiveInterface::STATUS_ALL);

Quick Examples

自定义处理敏感词

<?php

use Jundayw\LaravelSensitive\Sensitive;

public function handle(SensitiveInterface $sensitive): void
{
    $content  = '本校小额贷款，安全、快捷、方便、无抵押，随机随贷，当天放款，上门服务。';
    $instance = $sensitive->content($content);

    if ($instance->isBlock()) {
        // 含有黑名单词语
    }

    if ($instance->isReview()) {
        // 含有待审核词语
    }

    if ($instance->isReplace()) {
        // 含有敏感词词语已被替换
        $content = $instance->getContent();
    }

    var_dump($content);
}

不允许含有任何敏感词

<?php

use Jundayw\LaravelSensitive\Facades\Sensitive;

try {
    $content  = '本校小额贷款，安全、快捷、方便、无抵押，随机随贷，当天放款，上门服务。';
    $instance = Sensitive::listen(SensitiveInterface::STATUS_REVIEW | SensitiveInterface::STATUS_BLOCK, function () {
        throw new Exception('含有敏感词');
    })->content($content);
    var_dump($instance->getContent());
} catch (Exception $exception) {
    // $exception->getMessage();
}

将含有任何敏感词做替换处理，并通过事件做异步处理

<?php

use Jundayw\LaravelSensitive\Contracts\SensitiveInterface;
use Jundayw\LaravelSensitive\Events\SensitiveReviewEvent;
use Jundayw\LaravelSensitive\Facades\Sensitive;

$content  = '本校小额贷款，安全、快捷、方便、无抵押，随机随贷，当天放款，上门服务。';
$instance = Sensitive::listen(
    SensitiveInterface::STATUS_REVIEW | SensitiveInterface::STATUS_BLOCK,
    function (string $content, string $field, int $scope, Collection $collect, SensitiveInterface $sensitive) {
        return $sensitive->replacement($content, $collect);
    })->content($content);
// 获取替换后短语
$content = $instance->getContent();
// 正常进行业务处理
$user = User::create([
    'nickname' => $content,
]);
// 通过事件对业务做异步处理
$instance->event(SensitiveInterface::STATUS_REVIEW | SensitiveInterface::STATUS_BLOCK, SensitiveReviewEvent::class);
$instance->dispatch($user, $instance->getContent(), $instance->getRaw());

完整使用案例

<?php

use Jundayw\LaravelSensitive\Contracts\SensitiveInterface;
use Jundayw\LaravelSensitive\Events\SensitiveBlockEvent;
use Jundayw\LaravelSensitive\Events\SensitivePassEvent;
use Jundayw\LaravelSensitive\Events\SensitiveReplaceEvent;
use Jundayw\LaravelSensitive\Events\SensitiveReviewEvent;
use Jundayw\LaravelSensitive\Facades\Sensitive;

$content  = '本校小额贷款，安全、快捷、方便、无抵押，随机随贷，当天放款，上门服务。';

// listen 用于设置各状态的监听及回调处理函数
$instance = Sensitive::listen(SensitiveInterface::STATUS_BLOCK, function (string $content) {
    return $content;// @todo block
})->listen(SensitiveInterface::STATUS_REVIEW, function (string $content) {
    return $content;// @todo review
})->listen(SensitiveInterface::STATUS_REPLACE, function (string $content) {
    return $content;// @todo replace
})->listen(SensitiveInterface::STATUS_PASS, function (string $content) {
    return $content;// @todo pass
})->listen(SensitiveInterface::STATUS_ALL, function (string $content) {
    return $content;// @todo any
})->content($content);

var_dump($instance->isBlock());
var_dump($instance->isReview());
var_dump($instance->isReplace());
var_dump($instance->isPass());
var_dump($instance->getScope());
var_dump($instance->getRaw());
var_dump($instance->getContent());
var_dump($instance->getValues(SensitiveInterface::STATUS_BLOCK | SensitiveInterface::STATUS_REPLACE));
var_dump($instance->getStopWords(SensitiveInterface::STATUS_ALL));

// event 用于配置异步回调事件，方便对违规敏感词进一步做处理，如：修改状态为待审核、禁言、封号等后续操作
$instance
    //->event(SensitiveInterface::STATUS_ALL, SensitivePassEvent::class)
    ->event(SensitiveInterface::STATUS_BLOCK, SensitiveBlockEvent::class)
    ->event(SensitiveInterface::STATUS_REVIEW, SensitiveReviewEvent::class)
    ->event(SensitiveInterface::STATUS_REPLACE, SensitiveReplaceEvent::class)
    ->event(SensitiveInterface::STATUS_PASS, SensitivePassEvent::class)
    ->dispatch(...);

设置事件后，请正常使用 Laravel 事件和监听器 进行事件注册和调度。

License

Guzzle is made available under the MIT License (MIT). Please see License File for more information.