原理

  • osroom系统提供部分功能的hook, 供插件开发使用.

目录结构

  2. - plugin_test # 为你的插件名称, 可自定义
  3. | - main.py # 调用主程序
  4. | - config.py # 插件配置
  5. | - conf.yaml # 插件安装配置，比如名称之类的
  6. | - README.md # 说明

conf.yaml

conf.yaml示范

  2. # 插件名称必须和主目录名称一致
  3. alias_name: plugin_test
  4. author: Allen Woo
  5. author_uri: www.xxx.com/plugin
  6. plugin_uri: www.xxx.com/plugin
  7. introduce: 这里是简单介绍.
  8. version: v0.1
  9. license: BSD-3
  10. hook_name: file_storage
  11. startup_file_name: main.py
  12. execution_func_name: main

config.py

config.py示范

mian.py

  2. # -*-coding:utf-8-*-
  4. # 导入插件里的其他程序方法
  5. from apps.core.plug_in.config_process import import_plugin_config, get_plugin_config
  6. from apps.plugins.plugin_test.upfile_cloud import fun_test
  7. from apps.plugins.plugin_test.config import CONFIG, PLUGIN_NAME
  9. '''
  10. osroom提供了插件设置导入函数
  11. import_plugin_config(<plugin name>, <config:dict>)
  12. 可以用于把插件的一些设置导入到osroom系统保存, 方便调用.
  13. 比如密码之类数据.
  14. 之后可以调用get_plugin_config(<plugin name>, <str>)获取导入的dict数据中
  15. '''
  17. # 导入插件的设置
  18. import_plugin_config(PLUGIN_NAME, CONFIG)
  20. # 调用插件插件的设置
  21. get_plugin_config(PLUGIN_NAME, "TEST1")
  23. def main(**kwargs):
  25.     '''
  26.     主函数
  27.     :param kwargs:
  28.     :return:
  29.     '''
  31.     # 这里可以调用其他程序方法来完成工作...
  32.     ...
  34.     # 最后返回结果
  35.     return data

实例参考

hook

目前osroom提供以下hook

file_storage文件存储

主要用于接入第三方图床/文集储存, 如aliyun oss, 七牛云存储. 解决集群部署图片等文件保存问题.

  3. 1.上传
  4. 插件接受参数:
  5.     action："upload"
  6.     localfile_path：<str> 服务器本地文件路径
  7.     filename： <str>,要保存的文件名
  8.     prefix：<str>,要保存的文件名前缀
  10. 返回结果格式:
  12. 如{"type":"aliyun_oss", "bucket_name":"demo_osr"}
  15. 2. 复制文件
  16. 插件接受参数:
  17.     action："copy_file"
  18.     file_url_obj:<dict> 在使用插件上传时, 插件返回的结果dict
  19.     new_filename:<str>, 新文件名
  21. 返回结果格式:
  22. 复制的副本文件的{type:"<你的储存平台名>", ...其他需要保存的信息}
  25. 3.删除文件
  26. 插件接收参数:
  27.     action："delete"
  28.     file_url_obj:<dict>  在使用插件上传或复制时, 插件返回的结果dict
  30. 返回的结果格式：
  31.    bool值, 删除成功：True， 删除失败False
  34. 4.重命名
  35. 插件接收参数:
  36.     action："rename"
  37.     file_url_obj:<dict> 在使用插件上传或复制时, 插件返回的结果dict
  38.     new_filename:<str>, 新名称
  40. 返回的结果格式：
  41.     bool值, 删除成功：True， 删除失败False
  43. 5. 获取文件url
  44. 插件接收参数:
  45.     action："get_file_url"
  46.     file_url_obj:<dict> 在使用插件上传或复制时, 插件返回的结果dict
  48. 返回的结果格式：
  49.     成功：return url
  50.     失败：return None

短信发送send_msg

发送短信

邮件send_email

  2. hookname：send_email
  5. 1.邮件发送
  6. 插件接受参数:
  7.     msg:<dict> , 字典类型, 里面包含如下数据:
  8.             {
  9.                 "subject": <subject>,
  10.                 "recipients": <list:[email, email]>
  11.             }
  12.     send_independently:<bool> 如果为Ture,给每个收件人独立发送, 不一次性发送给多个，导致收件人邮件中可以看到此邮件发送给了多少人,
  13.     html：<str> html格式邮件
  14.     text：<str> text格式邮件
  15.     attach : <str> 附件文件路径
  17. 需要返回的结果格式：
  18.     bool值, 成功：True， 失败False

内容安全检测

用于检测内容安全, 比如鉴定文本, 图片等文件敏感信息.

  2. 1. 文本安全鉴定
  3. hookname: content_inspection_text
  4. 插件接受参数:
  6. 需要返回的结果格式:
  7.     dict: {"lable":"<鉴定结果的类型>", "score":<int or float>}
  8.     score范围是1到100分，违规越可疑，分值越高. 如果无法判断是否正常或违规,那就返回
  11. 2. 图片安全鉴定
  12. hookname: content_inspection_image
  14. 插件接受参数:
  15.     url:<str>, 可获取的图片url
  17. 需要返回的结果格式:
  18.     dict: {"lable":"<鉴定结果的类型>", "score":<int or float>}
  19.     score范围是1到100分，违规越可疑，分值越高. 如果无法判断是否正常或违规,那就返回
  20.     {"suggestion”:"review",  "lable":"<鉴定结果的类型>"， score":0}
  22. 2. 视频安全鉴定
  23. hookname: content_inspection_video
  25. 插件接受参数:
  26.     url:<str>, 可获取的视频url
  28. 需要返回的结果格式:
  29.     dict: {"lable":"<鉴定结果的类型>", "score":<int or float>}
  30.     score范围是1到100分，违规越可疑，分值越高. 如果无法判断是否正常或违规,那就返回
  31.     {"suggestion”:"review",  "lable":"<鉴定结果的类型>"， score":0}
  33. 2. 音频安全鉴定
  34. hookname: content_inspection_audio
  36. 插件接受参数:
  37.     url:<str>, 可获取的音频url
  39. 需要返回的结果格式:
  40.     dict: {"lable":"<鉴定结果的类型>", "score":<int or float>}
  41.     score范围是1到100分，违规越可疑，分值越高. 如果无法判断是否正常或违规,那就返回
  42.     {"suggestion”:"review",  "lable":"<鉴定结果的类型>"， score":0}

ip geo

根据IP获取geo(地理位置), osroom中用于鉴定用户登录地区, 识别用户登录是否异常等功能中

第三方登录

  1. hookname: wechat_login
  2. hookname: qq_login
  3. hookname: github_login
  4. hookname: sina_weibo_login
  5. hookname: alipay_login
  6. hookname: facebook_login
  7. hookname: twitter_login
  9. 插件接受参数:
  10.     request_argget_all：<obj>, 一个获取第三方平台登录验证后,回调osroom系统url时传过来的数据.
  12. 登录回调地址：
  13.     http://youdomain/open-api/sign-in/third-party/<platform>/callback
  14.     比如:微信登录可以这样回调:/open-api/sign-in/third-party/wechat/callback
  16. 第三方平台回调地址后, 系统会根据地址执行相关的登录插件
  17.     如:/open-api/sign-in/third-party/wechat/callback 则执行wechat登录插件
  19. request_argget_all使用:
  20.     在插件中可以使用osroom传入的request_argget_all对象获取登录回调地址参数
  21.      使用方式: request_argget.all("unionid"), 获取用户唯一标识
  23. 插件需要返回结果格式:
  24. {
  25.     "unionid":<用户唯一标示>  # 必须返回
  26.     "nickname": <用户昵称>,
  27.     "gender" :<性别>,        # 只能是 "secret", "m", "f"中的一个，分别代表保密, 男, 女
  28.     "email" :<email>,
  29.     "avatar_url":<头像地址>,
  30.     "province" :<地址区>,
  31.     "city": <地址城市>,
  32.     "country":<地址国家>
  33. }