Warning Tools

v2.3.1 2021-02-03 10:26 UTC

This package is auto-updated.

Last update: 2024-09-29 05:36:37 UTC


README

本扩展自带了邮件、短信、钉钉机器人、微信企业机器人、webhook等预警发送方式

安装

安装依赖

composer require hanxiaoqingcheng/warning

自动生成文件

php artisan vendor:publish

选择Sy\Warning\WarningServiceProvider 若没有生成配置文件,可以尝试先执行

php artisan cache:clear

执行数据库迁移

本扩展已经设计好预警日志表和预警用户表

php artisan migrate

需要配置数据库表:warning_user_account 和 warning_tpls

warning_user_account表配置示例:

warning_tpls表配置示例:

warning_tpls的type字段为default时,account表里面配置的账号,如果没有配置模板,则会走默认模板。

短信发送

本扩展使用的是聚合数据的短信发送功能,申请账号查看官网聚合数据短信发送

开启用户发送短信、邮件、钉钉机器人、webhook、微信企业机器人

开启任何一个功能,只需在数据库warning_user_account表配置用户即可使用

配置Mail

本扩展依赖laravel框架,并没有引入laravel已经存在的扩展。 配置laravel框架下config目录下的mail.php,不了解的可以自行查看laravel官方文档

调用

示例1

event(new Sy\Warning\Events\MsgPublishEvent( $tplValue));

示例1:无需配置模板表,默认uid=1,$tplValue为自定义的内容

示例2

event(new Sy\Warning\Events\MsgPublishEvent( $tplValue, $custom, $product, $uid, $username, $warningName));

示例2:需要按照一定的规则配置模板表

  • 创建的数据warning_tpls表,字段product => $product,uid => $uid,uname => $uname,warning_name=> $warningName,字段名对应的参数为下面调用示例的入参

  • $tplValue字段规则:warning_tpls表中的warning_tpl字段,所有参数以#xxx#的形式,参数前后用#号。

  • $tplValue示例:#keywords#=聚合数据&#num#=10&#url#=https://scan.juhe.cn

  • 数据库warning_tpl字段模板如果是email,webhook,weixin,dingding,示例:您扫描的关键字「#keywords#」,有#num#个新增未知风险待确认,请您前往 #url# 查看。

  • 如果是phone,按照聚合网站的要求,需要输入的参数tpl_value字段就可,示例:#code#=1234&#uname#=小明

  • $custom=1表示为自定义模板,不需要与模板表匹配,直接发送$tplValue原文