php_sensitive/Sensitive.class.php at master · chinaliwenbo/php_sensitive · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<?php
/**
 * 敏感词过滤
 * php实现基于确定有穷自动机算法的铭感词过滤
 * 可以重写获取敏感词的方法，因为有一些敏感词是去数据库等地方获取的
 *
 * User: Lwb
 * Date: 2017/10/10
 * Time: 19:28
 */
class Sensitive{

    /**
     * @var string 索引缓存文件， 设置为空将不会缓存索引
     */
    public static $CACHE_FILE =  './sensitive/cache_tree.dat';

    /**
     * @var int 索引缓存时间，默认1个小时
     */
    public static $CACHE_TIME = 3600;


    public static $_ACTION_REPLACE = 1;
    public static $_ACTION_ISLEGAL = 2;

    public static $instance = null;

    /**
     * 获取敏感词库，可以自己写，比如去数据库获取敏感词等等
     * 这里默认从本类库自带的文本中读取,是测试用的敏感词
     * @return array 敏感词库数组
     */
    public static function getSensitiveWord(){
        $wordPool = file_get_contents(__DIR__ . '/sensitive/keyWord.txt');
        return explode(',', $wordPool);
    }

    /**
     * 对于敏感词的操作
     * @param $content  需要处理的内容
     * @param int $type 操作类型， 1-查找敏感词，返回数组 array 2-替换敏感词，返回替换后的内容 string  3-返回是否包含敏感词 bool
     * @param string $replaceStr  如果是替换操作，可以把敏感词替换成该字符
     * @param int $matchType 匹配模式， 0-最长匹配 1-最短匹配
     * @throws Exception
     */
    public static function filter($content, $type = 1, $replaceChar = '***', $matchType = 0){
        //初始化
        require_once __DIR__ . "/sensitive/SensitiveHelper.php";
        require_once __DIR__ . "/sensitive/HashMap.php";
        if(!(self::$instance instanceof SensitiveHelper)){
            self::$instance = new SensitiveHelper();
            //设置缓存文件和缓存时长
            self::$instance->setCache(self::$CACHE_FILE, self::$CACHE_TIME);
            //生成关键字查询索引
            self::$instance->setTree();
        }

        //进行操作
        switch ($type){
            case 2: //查找是否包含有，返回bool
                return self::$instance->islegal($content);
            case 1: //替换敏感词，返回替换后的字符串
            default:
                return self::$instance->replace($content, $matchType, $replaceChar);
        }
    }

    /**
     * 获取文本中的敏感词
     */
    public static function getBadWords($content, $matchType = 0){
        //初始化
        require_once __DIR__ . "/sensitive/SensitiveHelper.php";
        require_once __DIR__ . "/sensitive/HashMap.php";
        if(!(self::$instance instanceof SensitiveHelper)){
            self::$instance = new SensitiveHelper();
            //设置缓存文件和缓存时长
            self::$instance->setCache(self::$CACHE_FILE, self::$CACHE_TIME);
            //生成关键字查询索引
            self::$instance->setTree();
        }

        return self::$instance->getBadWord($content, $matchType);
    }
}

/**
 * 基本调用方法示例
    //指定用'*'号替换内容中的敏感词 , 返回替换后的内容.  filter 后会存储敏感词数组，获取方法见最后
    Sensitive::filter("这是一段电狗测资料泄试语句");
 *
    //判断内容中是否包含有敏感词 ，返回bool类型
    Sensitive::filter("这是一段电狗测资料泄试语句", Sensitive::$_ACTION_ISLEGAL);
 *
 *
 *
 * 其他功能
 * 1、设置自带的敏感词来源，请直接重写该类的 getSensitiveWord方法
 *
 * 2、设置敏感词索引缓存位置和缓存时间, 可直接赋值, 如果设置缓存文件为空则不缓存
    Sensitive::$CACHE_TIME = 7200;
    Sensitive::$CACHE_FILE = '/www/xx.dat';
 *
 * 3、替换完字符串后获取检测到的敏感词数组如下,
 *  先替换效率更高， 因为敏感词已经缓存.
 *  Sensitive::filter("这是一段电狗测资料泄试语句"); //替换字符串
 *  Sensitive::getBadWords("这是一段电狗测资料泄试语句"); //获取检测到的敏感字符
 */

//  var_dump(Sensitive::filter("这是一段电狗测资料泄试语句")); //替换字符串
//  var_dump(Sensitive::getBadWords("这是一段电狗测资料泄试语句")); //获取检测到的敏感字符


//   var_dump(Sensitive::filter("这是一段电狗测资料")); //替换字符串
//   var_dump(Sensitive::getBadWords("这是一段电狗测资料")); //获取检测到的敏感字符