From 9446e96be3e8bf52594b91f20ad20584e55dfc5c Mon Sep 17 00:00:00 2001
From: filesite <release@filesite.io>
Date: Thu, 10 Mar 2022 21:34:31 +0800
Subject: [PATCH] class define update

---
 Class_DirScanner.md | 60 +++++++++++++++++++++++++++++++++++++++++++++
 Class_Dirscanner.md |  8 +++---
 2 files changed, 65 insertions(+), 3 deletions(-)
 create mode 100644 Class_DirScanner.md

diff --git a/Class_DirScanner.md b/Class_DirScanner.md
new file mode 100644
index 0000000..c8de8de
--- /dev/null
+++ b/Class_DirScanner.md
@@ -0,0 +1,60 @@
+# 类 DirScanner 定义
+
+## 私有属性
+
+* nginxSecureOn: Nginx防盗链开启状态
+* nginxSecret: Nginx防盗链密钥
+* userIp: 用户IP地址
+* nginxSecureTimeout: Nginx防盗链有效期，单位：秒
+* nginxSecureLinkMd5Pattern: Nginx防盗链MD5加密方式
+* allowReadContentFileExtensions: 允许读取文件内容的文件类型
+* fields: 私有属性字段名和说明
+* scanResults: 目录扫描结果
+
+
+## 受保护属性
+
+* supportFileExtensions: 支持的文件类型
+* maxReadFilesize: 默认每种文件读取内容最大大小
+* securedFileExtensions: 开启Nginx防盗链的文件类型
+
+
+## 公开属性
+
+* scanTimeCost: 上一次目录扫描耗时，单位：微秒
+
+
+## 私有方法
+
+* parseDescriptionFiles: 解析描述文件内容
+* parseShortCuts: 解析快捷方式文件内容
+* getId: 根据文件路径生成唯一编号
+
+
+## 受保护的方法
+
+* getSecureLink: 根据文件生成防盗链网址
+* getFilePath: 根据文件生成相对路径
+
+
+## 公开方法
+
+* setNginxSecure: 设置Nginx防盗链开启或关闭，以及密钥、用户IP、加密方式、超时时长
+* setNginxSecret: 设置Nginx防盗链密钥
+* setUserIp: 设置当前用户IP，用来生成加密网址
+* setNginxSecureLinkMd5Pattern: 设置Nginx防盗链MD5加密方式
+* setNginxSecureTimeout: 设置Nginx防盗链超时时长，单位：秒
+* scan: 扫描目录获取目录和文件列表，支持指定目录扫描深度（目录级数）
+
+
+## 参考说明
+
+Nginx防盗链MD5加密方式参考下面网址中的示例，
+将Nginx的变量替换$符号为英文大括号；
+
+示例：
+```
+{secure_link_expires}{uri}{remote_addr} {secret}
+```
+
+* http://nginx.org/en/docs/http/ngx_http_secure_link_module.html#secure_link_md5
diff --git a/Class_Dirscanner.md b/Class_Dirscanner.md
index 2386b6b..c8de8de 100644
--- a/Class_Dirscanner.md
+++ b/Class_Dirscanner.md
@@ -1,9 +1,10 @@
-# 类 Dirscanner 定义
+# 类 DirScanner 定义
 
 ## 私有属性
 
 * nginxSecureOn: Nginx防盗链开启状态
 * nginxSecret: Nginx防盗链密钥
+* userIp: 用户IP地址
 * nginxSecureTimeout: Nginx防盗链有效期，单位：秒
 * nginxSecureLinkMd5Pattern: Nginx防盗链MD5加密方式
 * allowReadContentFileExtensions: 允许读取文件内容的文件类型
@@ -38,10 +39,11 @@
 
 ## 公开方法
 
-* setNginxSecure: 设置Nginx防盗链开启或关闭，以及密钥、加密方式、超时时长
-* setNginxSecureTimeout: 设置Nginx防盗链超时时长，单位：秒
+* setNginxSecure: 设置Nginx防盗链开启或关闭，以及密钥、用户IP、加密方式、超时时长
 * setNginxSecret: 设置Nginx防盗链密钥
+* setUserIp: 设置当前用户IP，用来生成加密网址
 * setNginxSecureLinkMd5Pattern: 设置Nginx防盗链MD5加密方式
+* setNginxSecureTimeout: 设置Nginx防盗链超时时长，单位：秒
 * scan: 扫描目录获取目录和文件列表，支持指定目录扫描深度（目录级数）