diff --git a/API.md b/API.md index ea74bb2..0ce0b3a 100644 --- a/API.md +++ b/API.md @@ -145,7 +145,7 @@ "msg": "操作成功", "code": 0, "data": { - "header": null, # 头部文件名称 + "readme": null, # 文档文件名称 "viewConfig": { "siteName": "站点名称", # 站点名称 "infoEnable": false, # 是否开启右侧信息框 diff --git a/README.md b/README.md index 0fa8b61..f998592 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ * 内存缓存 (免安装) * 内存数据库 (免安装) * 个性化配置 -* 自定义目录的 header 说明文件 +* 自定义目录的 readme 说明文件 * 自定义 JS, CSS * 文件夹密码 * 支持在线浏览文本文件, 视频, 图片, 音乐. (支持 FLV 和 HLS) @@ -119,9 +119,9 @@ https://login.chinacloudapi.cn/common/oauth2/v2.0/authorize?client_id=4a72d927-1 默认 H2 数据库文件地址: `~/.zfile/db/`, `~` 表示用户目录, windows 为 `C:/Users/用户名/`, linux 为 `/home/用户名/`, root 用户为 `/root/` -### 头尾文件和加密文件 +### 文档文件和加密文件 -- 目录头部显示文件名为 `header.md` +- 目录文档显示文件名为 `readme.md` - 目录需要密码访问, 添加文件 `password.txt` (无法拦截此文件被下载, 但可以改名文件) ## 开发计划 @@ -139,6 +139,7 @@ https://login.chinacloudapi.cn/common/oauth2/v2.0/authorize?client_id=4a72d927-1 - [ ] 布局优化 - 自定义操作按钮 (现为右键实现) - [ ] 后台优化 - 设置按照其功能进行分离 - [ ] 架构调整 - 支持多存储策略 +- [ ] 体验优化 - 一键安装脚本 ## 支持作者 diff --git a/src/main/java/im/zhaojun/common/controller/FileController.java b/src/main/java/im/zhaojun/common/controller/FileController.java index c924148..8029f34 100644 --- a/src/main/java/im/zhaojun/common/controller/FileController.java +++ b/src/main/java/im/zhaojun/common/controller/FileController.java @@ -74,7 +74,7 @@ public class FileController { /** - * 获取系统配置信息和当前页的标题, 文件头, 文件尾信息 + * 获取系统配置信息和当前页的标题, 页面文档信息 * @param path 路径 */ @CheckStorageStrategyInit @@ -107,7 +107,7 @@ public class FileController { /** - * 过滤文件列表, 不显示密码, 头部和尾部文件. + * 过滤文件列表, 不显示密码, 文档文件. */ private void filterFileList(List fileItemList) { if (fileItemList == null) { @@ -115,7 +115,7 @@ public class FileController { } fileItemList.removeIf(fileItem -> ZFileConstant.PASSWORD_FILE_NAME.equals(fileItem.getName()) - || ZFileConstant.HEADER_FILE_NAME.equals(fileItem.getName())); + || ZFileConstant.README_FILE_NAME.equals(fileItem.getName())); } diff --git a/src/main/java/im/zhaojun/common/model/constant/ZFileConstant.java b/src/main/java/im/zhaojun/common/model/constant/ZFileConstant.java index 13fc0c0..34ce43c 100644 --- a/src/main/java/im/zhaojun/common/model/constant/ZFileConstant.java +++ b/src/main/java/im/zhaojun/common/model/constant/ZFileConstant.java @@ -15,9 +15,9 @@ public class ZFileConstant { public static final String AUDIO_TMP_PATH = "/.zfile/tmp/audio/"; /** - * 页面头部文件 + * 页面文档文件 */ - public static String HEADER_FILE_NAME = "header.md"; + public static String README_FILE_NAME = "readme.md"; /** * 密码文件 @@ -25,8 +25,8 @@ public class ZFileConstant { public static String PASSWORD_FILE_NAME = "password.txt"; @Autowired(required = false) - public void setHeaderFileName(@Value("${zfile.constant.header}") String headerFileName) { - ZFileConstant.HEADER_FILE_NAME = headerFileName; + public void setHeaderFileName(@Value("${zfile.constant.readme}") String headerFileName) { + ZFileConstant.README_FILE_NAME = headerFileName; } @Autowired(required = false) diff --git a/src/main/java/im/zhaojun/common/model/dto/SiteConfigDTO.java b/src/main/java/im/zhaojun/common/model/dto/SiteConfigDTO.java index 20e96c6..33b8822 100644 --- a/src/main/java/im/zhaojun/common/model/dto/SiteConfigDTO.java +++ b/src/main/java/im/zhaojun/common/model/dto/SiteConfigDTO.java @@ -15,7 +15,7 @@ public class SiteConfigDTO implements Serializable { private static final long serialVersionUID = 8811196207046121740L; - private String header; + private String readme; @JsonProperty("viewConfig") private SystemConfigDTO systemConfigDTO; diff --git a/src/main/java/im/zhaojun/common/model/dto/SystemConfigDTO.java b/src/main/java/im/zhaojun/common/model/dto/SystemConfigDTO.java index 0fe9f3e..230a968 100644 --- a/src/main/java/im/zhaojun/common/model/dto/SystemConfigDTO.java +++ b/src/main/java/im/zhaojun/common/model/dto/SystemConfigDTO.java @@ -44,4 +44,15 @@ public class SystemConfigDTO { private String customCss; + private String tableSize; + + private Boolean showOperator; + + private Boolean showDocument; + + private String announcement; + + private Boolean showAnnouncement; + + private String layout; } \ No newline at end of file diff --git a/src/main/java/im/zhaojun/common/service/SystemService.java b/src/main/java/im/zhaojun/common/service/SystemService.java index 286fb7a..a5cc377 100644 --- a/src/main/java/im/zhaojun/common/service/SystemService.java +++ b/src/main/java/im/zhaojun/common/service/SystemService.java @@ -20,7 +20,7 @@ public class SystemService { private SystemConfigService systemConfigService; /** - * 构建指定路径下标题, 页头, 页尾 + * 构建指定路径下标题, 页面文档信息 * @param path 路径 */ public synchronized SiteConfigDTO getConfig(String path) throws Exception { @@ -30,8 +30,8 @@ public class SystemService { List fileItemList = new ArrayList<>(fileService.fileList(path)); for (FileItemDTO fileItemDTO : fileItemList) { - if (ZFileConstant.HEADER_FILE_NAME.equalsIgnoreCase(fileItemDTO.getName())) { - siteConfigDTO.setHeader(HttpUtil.getTextContent(fileItemDTO.getUrl())); + if (ZFileConstant.README_FILE_NAME.equalsIgnoreCase(fileItemDTO.getName())) { + siteConfigDTO.setReadme(HttpUtil.getTextContent(fileItemDTO.getUrl())); } } return siteConfigDTO; diff --git a/src/main/java/im/zhaojun/common/util/NaturalOrderComparator.java b/src/main/java/im/zhaojun/common/util/NaturalOrderComparator.java index 2de33da..ae6bfbb 100644 --- a/src/main/java/im/zhaojun/common/util/NaturalOrderComparator.java +++ b/src/main/java/im/zhaojun/common/util/NaturalOrderComparator.java @@ -23,7 +23,7 @@ package im.zhaojun.common.util; 3. This notice may not be removed or altered from any source distribution. */ -import java.util.*; +import java.util.Comparator; public class NaturalOrderComparator implements Comparator { diff --git a/src/main/java/im/zhaojun/local/controller/LocalController.java b/src/main/java/im/zhaojun/local/controller/LocalController.java index a0a1741..622f3c7 100644 --- a/src/main/java/im/zhaojun/local/controller/LocalController.java +++ b/src/main/java/im/zhaojun/local/controller/LocalController.java @@ -1,7 +1,6 @@ package im.zhaojun.local.controller; import cn.hutool.core.util.URLUtil; -import im.zhaojun.common.exception.NotExistFileException; import im.zhaojun.common.util.StringUtils; import im.zhaojun.local.service.LocalServiceImpl; import org.springframework.core.io.FileSystemResource; diff --git a/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/src/main/resources/META-INF/additional-spring-configuration-metadata.json index e496c2f..c307a1a 100644 --- a/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -6,10 +6,10 @@ "description": "目录缓存过期时间 和 下载地址过期时间. 单位为秒." }, { - "name": "zfile.constant.header", + "name": "zfile.constant.readme", "type": "java.lang.String", - "defaultValue": "header.md", - "description": "头部文件 文件名." + "defaultValue": "readme.md", + "description": "文档文件 文件名." }, { "name": "zfile.constant.password", diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml index a3ee08d..023d5ae 100644 --- a/src/main/resources/application.yml +++ b/src/main/resources/application.yml @@ -50,7 +50,7 @@ zfile: cache: timeout: 300 constant: - header: header.md + readme: readme.md password: password.txt onedirve: clientId: 09939809-c617-43c8-a220-a93c1513c5d4 diff --git a/src/main/resources/db/data.sql b/src/main/resources/db/data.sql index a4b8b88..7f43f5b 100644 --- a/src/main/resources/db/data.sql +++ b/src/main/resources/db/data.sql @@ -10,6 +10,12 @@ INSERT INTO SYSTEM_CONFIG (`ID`, `k`, `REMARK`) VALUES (9, 'enableCache', '是 INSERT INTO SYSTEM_CONFIG (`ID`, `k`, `REMARK`) VALUES (10, 'searchContainEncryptedFile', '搜索包含加密文件'); INSERT INTO SYSTEM_CONFIG (`ID`, `k`, `REMARK`) VALUES (11, 'customCss', '自定义 CSS'); INSERT INTO SYSTEM_CONFIG (`ID`, `k`, `REMARK`) VALUES (12, 'customJs', '自定义 JS (可用于统计代码)'); +INSERT INTO SYSTEM_CONFIG (`ID`, `k`, `REMARK`) VALUES (13, 'tableSize', '表格大小'); +INSERT INTO SYSTEM_CONFIG (`ID`, `k`, `REMARK`) VALUES (14, 'showOperator', '是否显示操作按钮'); +INSERT INTO SYSTEM_CONFIG (`ID`, `k`, `REMARK`) VALUES (15, 'showDocument', '是否显示文档'); +INSERT INTO SYSTEM_CONFIG (`ID`, `k`, `REMARK`) VALUES (16, 'announcement', '网站公告'); +INSERT INTO SYSTEM_CONFIG (`ID`, `k`, `REMARK`) VALUES (17, 'showAnnouncement', '是否显示网站公告'); +INSERT INTO SYSTEM_CONFIG (`ID`, `k`, `REMARK`) VALUES (18, 'layout', '页面布局'); INSERT INTO STORAGE_CONFIG (`ID`, `k`, `TITLE`, `TYPE`) VALUES (1, 'bucket-name', '云存储服务名称', 'upyun'); INSERT INTO STORAGE_CONFIG (`ID`, `k`, `TITLE`, `TYPE`) VALUES (2, 'username', '操作员名称', 'upyun');