code
stringlengths 11
173k
| docstring
stringlengths 2
593k
| func_name
stringlengths 2
189
| language
stringclasses 1
value | repo
stringclasses 844
values | path
stringlengths 11
294
| url
stringlengths 60
339
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
private String normalized(IRequestInfo requestInfo) {
String type = requestInfo.getMethod();
String url = String.valueOf(requestInfo.getUrl()).split("\\?")[0]; // 获取?之前的url
return Utils.MD5(url + "+" + type);
} |
归一化请求包
格式: ${url} + GET/POST
@param requestInfo
@return MD5
| Scanner::normalized | java | metaStor/SpringScan | src/main/java/burp/scan/Scanner.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/scan/Scanner.java | MIT |
private boolean isChecked(String url_md5) {
return this.allScan.contains(url_md5);
} |
是否已扫描过
@param url_md5
@return
| Scanner::isChecked | java | metaStor/SpringScan | src/main/java/burp/scan/Scanner.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/scan/Scanner.java | MIT |
public void close() {
if (this.backend != null) {
this.backend.close();
}
} |
关闭持续监听的Dnslog
| Scanner::close | java | metaStor/SpringScan | src/main/java/burp/scan/Scanner.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/scan/Scanner.java | MIT |
public static String MD5(String src) {
byte[] digest = null;
try {
MessageDigest md5 = MessageDigest.getInstance("MD5");
digest = md5.digest(src.getBytes());
} catch (NoSuchAlgorithmException e) {
throw new RuntimeException("MD5 Algorithm not found!");
}
return new BigInteger(1, digest).toString(16);
} |
MD5加密, 用于只扫描一次同类uri
@param src
@return hexadecimal string
| Utils::MD5 | java | metaStor/SpringScan | src/main/java/burp/util/Utils.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/util/Utils.java | MIT |
public static String getUriExt(String url) {
String pureUrl = url.substring(0, url.contains("?") ? url.indexOf("?") : url.length());
return (pureUrl.lastIndexOf(".") > -1 ? pureUrl.substring(pureUrl.lastIndexOf(".") + 1) : "").toLowerCase();
} |
获取url的文件后缀
@param url
@return ext
| Utils::getUriExt | java | metaStor/SpringScan | src/main/java/burp/util/Utils.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/util/Utils.java | MIT |
public static String getUri(String url) {
url = url.replace("https://", "").replace("http://", ""); // 截去http://或https://
String pureUrl = url.substring(0, url.contains("#") ? url.indexOf("#") : url.length()); // 排除锚点
pureUrl = pureUrl.substring(0, pureUrl.contains("?") ? pureUrl.indexOf("?") : pureUrl.length()); // 排除参数
pureUrl = pureUrl.substring(pureUrl.contains("/") ? pureUrl.indexOf("/") : pureUrl.length(), pureUrl.contains("/") ? pureUrl.lastIndexOf("/") : pureUrl.length()); // 取最后一个/之前的uri
return pureUrl + "/";
} |
取url的uri路径
@param url http://xxx:8080/api/auth-manager-microservice/v1/login/anon/apps?_t=1649647394555kna8
@return uri /api/auth-manager-microservice/v1/login/anon/
| Utils::getUri | java | metaStor/SpringScan | src/main/java/burp/util/Utils.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/util/Utils.java | MIT |
public static boolean isErrorStatusCode(int status_code) {
return Arrays.stream(new Integer[]{ 400, 500, 502, 503 }).anyMatch(e -> e == status_code);
} |
判断状态码是否是异常
异常响应码: 400, 500, 502, 503
@param status_code
@return
| Utils::isErrorStatusCode | java | metaStor/SpringScan | src/main/java/burp/util/Utils.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/util/Utils.java | MIT |
public static boolean isStaticFile(String url) {
for (String ext : STATIC_FILE_EXT) {
if (ext.equalsIgnoreCase(Utils.getUriExt(url))) return true;
}
return false;
} |
判断uri是否静态文件,
使用传统的循环判断，时间复杂度为O(1)
@param url
@return true/false
| Utils::isStaticFile | java | metaStor/SpringScan | src/main/java/burp/util/Utils.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/util/Utils.java | MIT |
public static IPoc[] getPocs(Integer[] rangePocs) {
List<IPoc> pocs = new ArrayList<IPoc>();
try {
for (Integer no : rangePocs) {
Class<?> poc = Class.forName("burp.payload.pocs.POC" + String.valueOf(no));
pocs.add((IPoc) poc.newInstance());
}
} catch (Exception e) {
e.printStackTrace();
}
return pocs.toArray(new IPoc[0]);
} |
获取pocs包中的所有poc类
@param rangePocs
@return Map
| Utils::getPocs | java | metaStor/SpringScan | src/main/java/burp/util/Utils.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/util/Utils.java | MIT |
public static String randomStr(int n) {
StringBuilder s = new StringBuilder();
char[] stringArray = {'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i',
'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u',
'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6',
'7', '8', '9'};
for (int i = 0; i < n; i++) {
char num = stringArray[random.nextInt(stringArray.length)];
s.append(num);
}
return s.toString();
} |
随机取 n 个字符
@param n
@return String
| Utils::randomStr | java | metaStor/SpringScan | src/main/java/burp/util/Utils.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/util/Utils.java | MIT |
public static int getRandom(int min, int max){
return random.nextInt(max) % (max - min + 1) + min;
} |
随机获取 [min, max] 范围内的随机整数
eg: [1, 3] => 1, 2, 3
ps: min为0的时候会计算会少1，如：[0, 3] => 0, 1, 2
@return random int
| Utils::getRandom | java | metaStor/SpringScan | src/main/java/burp/util/Utils.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/util/Utils.java | MIT |
public static long getRandomLong() {
return Math.abs(random.nextLong());
} |
随机获取long数值
@return
| Utils::getRandomLong | java | metaStor/SpringScan | src/main/java/burp/util/Utils.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/util/Utils.java | MIT |
public static String bytes2Hex(byte[] src){
if (src == null || src.length <= 0) {
return null;
}
StringBuilder stringBuilder = new StringBuilder("");
for (int i = 0; i < src.length; i++) {
// 之所以用byte和0xff相与，是因为int是32位，与0xff相与后就舍弃前面的24位，只保留后8位
String str = Integer.toHexString(src[i] & 0xff);
if (str.length() < 2) { // 不足两位要补0
stringBuilder.append(0);
}
stringBuilder.append(str);
}
return stringBuilder.toString();
} |
byte[] => string
@param src
@return
| Utils::bytes2Hex | java | metaStor/SpringScan | src/main/java/burp/util/Utils.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/util/Utils.java | MIT |
public static String urlEncode(String src) {
try {
return URLEncoder.encode(src, "UTF-8");
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
return null;
}
} |
URL编码
@param src
@return
| Utils::urlEncode | java | metaStor/SpringScan | src/main/java/burp/util/Utils.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/util/Utils.java | MIT |
public static String urlDecode(String src) {
try {
return URLEncoder.encode(src, "UTF-8");
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
return null;
}
} |
URL解码
@param src
@return
| Utils::urlDecode | java | metaStor/SpringScan | src/main/java/burp/util/Utils.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/util/Utils.java | MIT |
public boolean isEnable() {
return this.enableCheckBox.isSelected();
} |
插件是否开启状态
@return true/false
| Backends::isEnable | java | metaStor/SpringScan | src/main/java/burp/ui/tabs/SettingUi.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/ui/tabs/SettingUi.java | MIT |
public boolean isErrorCheck() {
return this.errorCheckBox.isSelected();
} |
是否开启报错检测
@return true/false
| Backends::isErrorCheck | java | metaStor/SpringScan | src/main/java/burp/ui/tabs/SettingUi.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/ui/tabs/SettingUi.java | MIT |
public boolean isReverseCheck() {
return this.reverseCheckBox.isSelected();
} |
是否开启回连检测
@return true/false
| Backends::isReverseCheck | java | metaStor/SpringScan | src/main/java/burp/ui/tabs/SettingUi.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/ui/tabs/SettingUi.java | MIT |
public Backends getBackendPlatform() {
return Backends.valueOf(this.backendSelector.getSelectedItem().toString());
} |
返回选择到回连平台
@return Dnslog/BurpCollaboratorClient/Ceye
| Backends::getBackendPlatform | java | metaStor/SpringScan | src/main/java/burp/ui/tabs/SettingUi.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/ui/tabs/SettingUi.java | MIT |
public String getApiField() {
return this.apiInput.getText().trim().toLowerCase();
} |
获取 Ceye Api 地址
@return xxxxxx.ceye.io
| Backends::getApiField | java | metaStor/SpringScan | src/main/java/burp/ui/tabs/SettingUi.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/ui/tabs/SettingUi.java | MIT |
public String getTokenField() {
return this.tokenInput.getText().trim().toLowerCase();
} |
获取 Ceye Token
@return xxxxxxxxxxxxxxxxx
| Backends::getTokenField | java | metaStor/SpringScan | src/main/java/burp/ui/tabs/SettingUi.java | https://github.com/metaStor/SpringScan/blob/master/src/main/java/burp/ui/tabs/SettingUi.java | MIT |
public boolean checkFileIsInaccessible(Integer storageId, String path) {
List<FilterConfig> filterConfigList = filterConfigService.findByStorageIdAndInaccessible(storageId);
return testPattern(storageId, filterConfigList, path);
} |
判断访问的路径是否是不允许访问的
@param storageId
存储源 ID
@param path
请求路径
| FilterConfigService::checkFileIsInaccessible | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/filter/service/FilterConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/filter/service/FilterConfigService.java | MIT |
public boolean checkFileIsHidden(Integer storageId, String fileName) {
List<FilterConfig> filterConfigList = filterConfigService.findByStorageId(storageId);
return testPattern(storageId, filterConfigList, fileName);
} |
指定存储源下的文件名称, 根据过滤表达式判断是否会显示, 如果符合任意一条表达式, 表示隐藏则返回 true, 反之表示不隐藏则返回 false.
@param storageId
存储源 ID
@param fileName
文件名
@return 是否是隐藏文件夹
| FilterConfigService::checkFileIsHidden | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/filter/service/FilterConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/filter/service/FilterConfigService.java | MIT |
public boolean checkFileIsDisableDownload(Integer storageId, String fileName) {
List<FilterConfig> filterConfigList = filterConfigService.findByStorageIdAndDisableDownload(storageId);
String filePath = FileUtil.getParent(fileName, 1);
if (StrUtil.isEmpty(filePath)) {
return testPattern(storageId, filterConfigList, fileName);
} else {
return testPattern(storageId, filterConfigList, fileName) || testPattern(storageId, filterConfigList, filePath);
}
} |
指定存储源下的文件名称, 根据过滤表达式判断文件名和所在路径是否禁止下载, 如果符合任意一条表达式, 则返回 true, 反之则返回 false.
@param storageId
存储源 ID
@param fileName
文件名
@return 是否显示
| FilterConfigService::checkFileIsDisableDownload | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/filter/service/FilterConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/filter/service/FilterConfigService.java | MIT |
private boolean testPattern(Integer storageId, List<FilterConfig> patternList, String test) {
// 如果规则列表为空, 则表示不需要过滤, 直接返回 false
if (CollUtil.isEmpty(patternList)) {
if (log.isDebugEnabled()) {
log.debug("过滤规则列表为空, 存储源 ID: {}, 测试字符串: {}", storageId, test);
}
return false;
}
// 校验表达式
for (FilterConfig filterConfig : patternList) {
String expression = filterConfig.getExpression();
if (StrUtil.isEmpty(expression)) {
if (log.isDebugEnabled()) {
log.debug("存储源 {} 过滤文件测试表达式: {}, 测试字符串: {}, 表达式为空，跳过该规则校验", storageId, expression, test);
}
continue;
}
try {
boolean match = PatternMatcherUtils.testCompatibilityGlobPattern(expression, test);
if (log.isDebugEnabled()) {
log.debug("存储源 {} 过滤文件测试表达式: {}, 测试字符串: {}, 匹配结果: {}", storageId, expression, test, match);
}
if (match) {
return true;
}
} catch (Exception e) {
log.error("存储源 {} 过滤文件测试表达式: {}, 测试字符串: {}, 匹配异常，跳过该规则.", storageId, expression, test, e);
}
}
return false;
} |
根据规则表达式和测试字符串进行匹配，如测试字符串和其中一个规则匹配上，则返回 true，反之返回 false。
@param patternList
规则列表
@param test
测试字符串
@return 是否显示
| FilterConfigService::testPattern | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/filter/service/FilterConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/filter/service/FilterConfigService.java | MIT |
public synchronized String getRsaHexKeyOrGenerate() {
SystemConfigDTO systemConfigDTO = systemConfigService.getSystemConfig();
String rsaHexKey = systemConfigDTO.getRsaHexKey();
if (StrUtil.isEmpty(rsaHexKey)) {
byte[] key = SecureUtil.generateKey(SymmetricAlgorithm.AES.getValue()).getEncoded();
rsaHexKey = HexUtil.encodeHexStr(key);
SystemConfig loginVerifyModeConfig = systemConfigMapper.findByName(SystemConfigConstant.RSA_HEX_KEY);
loginVerifyModeConfig.setValue(rsaHexKey);
systemConfigMapper.updateById(loginVerifyModeConfig);
systemConfigDTO.setRsaHexKey(rsaHexKey);
Cache cache = cacheManager.getCache(CACHE_NAME);
Optional.ofNullable(cache).ifPresent(cache1 -> cache1.put("dto", systemConfigDTO));
}
return rsaHexKey;
} |
获取 RSA Hex 格式密钥
@return RSA Hex 格式密钥
| CacheEvict::getRsaHexKeyOrGenerate | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/config/service/SystemConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/config/service/SystemConfigService.java | MIT |
public Boolean getSystemIsInstalled() {
return systemConfigService.getSystemConfig().getInstalled();
} |
获取系统是否已初始化
@return 管理员名称
| CacheEvict::getSystemIsInstalled | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/config/service/SystemConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/config/service/SystemConfigService.java | MIT |
public String getDomain() {
SystemConfigDTO systemConfigDTO = systemConfigService.getSystemConfig();
return systemConfigDTO.getDomain();
} |
获取后端站点域名
@return 后端站点域名
| CacheEvict::getDomain | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/config/service/SystemConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/config/service/SystemConfigService.java | MIT |
public String getFrontDomain() {
SystemConfigDTO systemConfigDTO = systemConfigService.getSystemConfig();
return systemConfigDTO.getFrontDomain();
} |
获取前端站点域名
@return 前端站点域名
| CacheEvict::getFrontDomain | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/config/service/SystemConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/config/service/SystemConfigService.java | MIT |
public String getRealFrontDomain() {
SystemConfigDTO systemConfigDTO = systemConfigService.getSystemConfig();
return StrUtil.firstNonNull(systemConfigDTO.getFrontDomain(), systemConfigDTO.getDomain());
} |
获取实际的前端站点域名
@return 实际的前端站点域名
| CacheEvict::getRealFrontDomain | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/config/service/SystemConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/config/service/SystemConfigService.java | MIT |
public String getForbiddenUrl() {
return getRealFrontDomain() + "/403";
} |
获取前端地址下的 403 页面地址.
@return 前端地址下的 403 页面地址.
| CacheEvict::getForbiddenUrl | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/config/service/SystemConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/config/service/SystemConfigService.java | MIT |
public VerifyResultDTO verifyPassword(Integer storageId, String path, String inputPassword) {
List<PasswordConfig> passwordConfigList = passwordConfigService.findByStorageId(storageId);
// 如果规则列表为空, 则表示不需要过滤, 直接返回 false
if (CollUtil.isEmpty(passwordConfigList)) {
if (log.isDebugEnabled()) {
log.debug("密码规则列表为空, 请求路径: {}, 存储源 ID: {}, 输入密码: {}", path, storageId, inputPassword);
}
return VerifyResultDTO.success();
}
// 校验密码
for (PasswordConfig passwordConfig : passwordConfigList) {
String expression = passwordConfig.getExpression();
String expectPassword = passwordConfig.getPassword();
// 规则为空跳过
if (StrUtil.isEmpty(expression)) {
if (log.isDebugEnabled()) {
log.debug("密码规则测试表达式: {}, 请求路径: {}, 表达式为空，跳过该规则比对", expression, path);
}
continue;
}
try {
// 判断当前请求路径是否和规则路径表达式匹配
boolean match = PatternMatcherUtils.testCompatibilityGlobPattern(expression, path);
if (log.isDebugEnabled()) {
log.debug("密码规则测试表达式: {}, 请求路径: {}, 匹配结果: {}, 预期密码: {}, 输入密码; {}", expression, path, match, expectPassword, inputPassword);
}
// 如果匹配且输入了密码则校验
if (match) {
if (StrUtil.isEmpty(inputPassword)) {
if (log.isDebugEnabled()) {
log.debug("密码规则匹配, 但未输入密码；" +
"表达式: {}, 请求路径: {}, 存储源 ID: {}, 预期密码：{}, 输入密码: {}",
expression, path, storageId, expectPassword, inputPassword);
}
return VerifyResultDTO.fail("此文件夹需要密码.", AjaxJson.REQUIRED_PASSWORD);
}
if (matchPassword(expectPassword, inputPassword)) {
if (log.isDebugEnabled()) {
log.debug("密码规则匹配, 密码校验通过；" +
"表达式: {}, 请求路径: {}, 存储源 ID: {}, 预期密码：{}, 输入密码: {}",
expression, path, storageId, expectPassword, inputPassword);
}
return VerifyResultDTO.success(expression);
}
if (log.isDebugEnabled()) {
log.debug("密码规则匹配, 但输入密码与预期密码不同；" +
"表达式: {}, 请求路径: {}, 存储源 ID: {}, 预期密码：{}, 输入密码: {}",
expression, path, storageId, expectPassword, inputPassword);
}
return VerifyResultDTO.fail("此文件夹密码错误.", AjaxJson.INVALID_PASSWORD);
}
} catch (Exception e) {
log.error("密码规则匹配出现异常，表达式: {}, 请求路径: {}, 存储源 ID: {}, 预期密码：{}, 输入密码: {}, 解析错误, 跳过此规则.",
expression, path, storageId, expectPassword, inputPassword, e);
}
}
if (log.isDebugEnabled()) {
log.debug("校验文件夹密码 path: {}, 没有匹配的表达式, 不进行密码校验.", path);
}
return VerifyResultDTO.success();
} |
校验密码
@param storageId
存储源 ID
@param path
请求路径
@param inputPassword
用户输入的密码
@return 是否校验通过
| public::verifyPassword | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/password/service/PasswordConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/password/service/PasswordConfigService.java | MIT |
private boolean matchPassword(String expectedPasswordContent, String password) {
if (Objects.equals(expectedPasswordContent, password)) {
return true;
}
// 如果预期密码或输入密码为空, 则不匹配
if (ObjectUtil.hasNull(expectedPasswordContent, password)) {
return false;
}
expectedPasswordContent = StringUtils.removeAllLineBreaksAndTrim(expectedPasswordContent);
password = StringUtils.removeAllLineBreaksAndTrim(password);
return Objects.equals(expectedPasswordContent, password);
} |
校验两个密码是否相同, 忽略空白字符
@param expectedPasswordContent
预期密码
@param password
实际输入密码
@return 是否匹配
| public::matchPassword | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/password/service/PasswordConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/password/service/PasswordConfigService.java | MIT |
private String getHostByType(String type) {
// 判断是标准版还是世纪互联版
if (Objects.equals(type, "Standard")) {
return "graph.microsoft.com";
} else if (Objects.equals(type, "China")) {
return "microsoftgraph.chinacloudapi.cn";
} else {
throw new RuntimeException("不支持的类型");
}
} |
根据类型获取 API 地址
@param type
网站类型：
Standard：标准版
China：世纪互联版
@return API 地址
| sites::getHostByType | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/controller/helper/SharePointHelperController.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/controller/helper/SharePointHelperController.java | MIT |
private String getSearchSiteUrlByType(String type) {
String hostByType = getHostByType(type);
return StrUtil.format("https://{}/v1.0/sites", hostByType);
} |
获取搜索网站请求 URL
@param type
网站类型：
Standard：标准版
China：世纪互联版
@return 搜索网站请求 URL
| sites::getSearchSiteUrlByType | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/controller/helper/SharePointHelperController.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/controller/helper/SharePointHelperController.java | MIT |
private String getSiteListsUrlByType(String type, String siteId) {
String hostByType = getHostByType(type);
return StrUtil.format("https://{}/v1.0/sites/{}/lists",hostByType, siteId);
} |
获取搜索网站请求 URL
@param type
网站类型：
Standard：标准版
China：世纪互联版
@return 搜索网站请求 URL
| sites::getSiteListsUrlByType | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/controller/helper/SharePointHelperController.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/controller/helper/SharePointHelperController.java | MIT |
public FileContext execute(FileContext content) throws Exception {
super.execute(content);
return content;
} |
执行文件处理责任链
@param content
文件上下文
@return 是否执行成功
| FileChain::execute | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/chain/FileChain.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/chain/FileChain.java | MIT |
int order() default 99;
/**
* 参数键, 如果为空, 则使用字段名称.
*/
String key() default "";
/**
* 参数名称, 用于网页上显示名称.
*/
String name();
/**
* 字段类型, 默认为 input, 可选值为: input, select, switch.
*/
StorageParamTypeEnum type() default StorageParamTypeEnum.INPUT;
/**
* 当 {@link #type} 为 select 时, 选项的值.
*/
StorageParamSelectOption[] options() default {}; |
字段显示排序值, 值越小, 越靠前. 默认为 99
| order | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/annotation/StorageParamItem.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/annotation/StorageParamItem.java | MIT |
public AbstractBaseFileService<IStorageParam> getByStorageId(Integer storageId) {
AbstractBaseFileService<IStorageParam> abstractBaseFileService = DRIVES_SERVICE_MAP.get(storageId);
if (abstractBaseFileService == null) {
throw new InvalidStorageSourceException(storageId);
}
return abstractBaseFileService;
} |
根据存储源 id 获取对应的 Service.
@param storageId
存储源 ID
@return 存储源对应的 Service
| StorageSourceContext::getByStorageId | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/context/StorageSourceContext.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/context/StorageSourceContext.java | MIT |
public AbstractBaseFileService<?> getByStorageKey(String key) {
Integer storageId = storageSourceService.findIdByKey(key);
if (storageId == null) {
return null;
}
return getByStorageId(storageId);
} |
根据存储源 key 获取对应的 Service.
@param key
存储源 key
@return 存储源对应的 Service
| StorageSourceContext::getByStorageKey | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/context/StorageSourceContext.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/context/StorageSourceContext.java | MIT |
public static List<StorageSourceParamDef> getStorageSourceParamListByType(StorageTypeEnum type) {
return storageTypeEnumFileServiceMap.values().stream()
// 根据存储源类型找到第一个匹配的 Service
.filter(fileService -> fileService.getStorageTypeEnum() == type)
.findFirst()
// 获取该 Service 的参数列表
.map(StorageSourceSupport::getStorageSourceParamList)
// 如果没有找到, 则返回空列表
.orElse(Collections.emptyList());
} |
根据存储类型获取对应的存储源的参数列表.
@param type
存储类型: {@link StorageTypeEnum}
@return 指定类型存储源的参数列表. {@link StorageSourceSupport#getStorageSourceParamList(AbstractBaseFileService)} )}}
| StorageSourceContext::getStorageSourceParamListByType | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/context/StorageSourceContext.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/context/StorageSourceContext.java | MIT |
public void init(StorageSource storageSource) {
Integer storageId = storageSource.getId();
String storageName = storageSource.getName();
AbstractBaseFileService<IStorageParam> baseFileService = getInitStorageBeanByStorageId(storageId);
if (baseFileService == null) {
throw new InvalidStorageSourceException(storageId);
}
// 填充初始化参数
IStorageParam initParam = getInitParam(storageId, baseFileService);
// 进行初始化并测试连接
baseFileService.init(storageName, storageId, initParam);
baseFileService.testConnection();
DRIVES_SERVICE_MAP.put(storageId, baseFileService);
} |
初始化指定存储源的 Service, 添加到上下文环境中.
@param storageSource
存储源对象
| StorageSourceContext::init | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/context/StorageSourceContext.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/context/StorageSourceContext.java | MIT |
private AbstractBaseFileService<IStorageParam> getInitStorageBeanByStorageId(Integer storageId) {
StorageTypeEnum storageTypeEnum = storageSourceService.findStorageTypeById(storageId);
for (AbstractBaseFileService<?> value : storageTypeEnumFileServiceMap.values()) {
if (Objects.equals(value.getStorageTypeEnum(), storageTypeEnum)) {
return SpringUtil.getBean(value.getClass());
}
}
return null;
} |
获取指定存储源初始状态的 Service.
@param storageId
存储源 ID
@return 存储源对应未初始化的 Service
| StorageSourceContext::getInitStorageBeanByStorageId | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/context/StorageSourceContext.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/context/StorageSourceContext.java | MIT |
private Integer getStorageId(JoinPoint point) {
AbstractBaseFileService<?> targetService = (AbstractBaseFileService<?>) point.getTarget();
return targetService.getStorageId();
} |
获取存储源 id
@param point
切入点
@return 存储源 id
| FileOperatorExceptionWrapperAspect::getStorageId | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/aspect/FileOperatorExceptionWrapperAspect.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/aspect/FileOperatorExceptionWrapperAspect.java | MIT |
private Object getArg(JoinPoint point, int index) {
Object[] args = point.getArgs();
return ArrayUtil.get(args, index);
} |
获取切入点方法第 n 个参数
@param point
切入点
@param index
参数索引
@return 参数值
| FileOperatorExceptionWrapperAspect::getArg | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/aspect/FileOperatorExceptionWrapperAspect.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/aspect/FileOperatorExceptionWrapperAspect.java | MIT |
private Object check(ProceedingJoinPoint point, FileOperatorTypeEnum fileOperatorType) throws Throwable {
// 获取对应的存储源 service
AbstractBaseFileService<?> targetService = (AbstractBaseFileService<?>) point.getTarget();
Integer storageId = targetService.storageId;
// 判断是否允许文件操作. 如果不允许, 则抛出异常
StorageSource storageSource = storageSourceService.findById(storageId);
boolean allowOperator = storageSource.getAllowOperator();
if (BooleanUtil.isFalse(allowOperator)) {
throw new StorageSourceException(CodeMsg.STORAGE_SOURCE_ILLEGAL_OPERATION, storageId, "非法进行无权限的操作:" + fileOperatorType.getName());
}
return point.proceed();
} |
校验是否有此文件操作的权限
@param point
连接点
@param fileOperatorType
文件操作类型
@return 方法运行结果
| FileOperatorCheckAspect::check | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/aspect/FileOperatorCheckAspect.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/aspect/FileOperatorCheckAspect.java | MIT |
public StorageSourceConfig findByStorageIdAndName(Integer storageId, String name) {
return storageSourceConfigService
.selectStorageConfigByStorageId(storageId)
.stream()
.filter(storageSourceConfig -> StrUtil.equals(name, storageSourceConfig.getName()))
.findFirst()
.orElse(null);
} |
获取指定存储源的指定参数名称
@param storageId
存储源 id
@param name
参数名
@return 参数信息
| StorageSourceConfigService::findByStorageIdAndName | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceConfigService.java | MIT |
public List<StorageSourceConfig> toStorageSourceConfigList(Integer storageId, StorageTypeEnum storageType, StorageSourceAllParamDTO storageSourceAllParam) {
// 返回结果
List<StorageSourceConfig> result = new ArrayList<>();
// 获取该存储源类型需要的参数列表
List<StorageSourceParamDef> storageSourceParamList = StorageSourceContext.getStorageSourceParamListByType(storageType);
// 遍历参数列表, 将参数转换成存储源参数对象
for (StorageSourceParamDef storageSourceParam : storageSourceParamList) {
// 根据字段名称获取字段值
Object fieldValue = ReflectUtil.getFieldValue(storageSourceAllParam, storageSourceParam.getKey());
String fieldStrValue = Convert.toStr(fieldValue);
// 校验是否必填, 如果不符合则抛出异常
boolean paramRequired = storageSourceParam.isRequired();
if (paramRequired && StrUtil.isEmpty(fieldStrValue)) {
String errMsg = StrUtil.format("参数「{}」不能为空", storageSourceParam.getName());
throw new InitializeStorageSourceException(CodeMsg.STORAGE_SOURCE_INIT_STORAGE_CONFIG_FAIL,
storageId, errMsg).setResponseExceptionMessage(true);
}
// 校验如果有默认值，则填充默认值
String paramDefaultValue = storageSourceParam.getDefaultValue();
if (StrUtil.isNotEmpty(paramDefaultValue) && StrUtil.isEmpty(fieldStrValue)) {
fieldStrValue = paramDefaultValue;
}
// 添加到结果列表
StorageSourceConfig storageSourceConfig = new StorageSourceConfig();
storageSourceConfig.setTitle(storageSourceParam.getName());
storageSourceConfig.setName(storageSourceParam.getKey());
storageSourceConfig.setValue(fieldStrValue);
storageSourceConfig.setType(storageType);
storageSourceConfig.setStorageId(storageId);
result.add(storageSourceConfig);
}
return result;
} |
将存储源所有参数转换成指定存储类型的参数对象列表
@param storageId
存储源 ID
@param storageType
存储源类型
@param storageSourceAllParam
存储源所有参数
| CacheEvict::toStorageSourceConfigList | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceConfigService.java | MIT |
public List<StorageSource> findAllOrderByOrderNum() {
return storageSourceMapper.findAllOrderByOrderNum();
} |
获取所有存储源列表
@return 存储源列表
| StorageSourceService::findAllOrderByOrderNum | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java | MIT |
public List<StorageSource> findAllEnableOrderByOrderNum() {
return storageSourceMapper.findListByEnableOrderByOrderNum();
} |
获取所有已启用的存储源列表，按照存储源的排序号排序
@return 已启用的存储源列表
| StorageSourceService::findAllEnableOrderByOrderNum | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java | MIT |
public Integer findIdByKey(String storageKey) {
return Optional.ofNullable(storageSourceService.findByStorageKey(storageKey)).map(StorageSource::getId).orElse(null);
} |
根据存储源 key 获取存储源 id
@param storageKey
存储源 key
@return 存储源信息
| StorageSourceService::findIdByKey | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java | MIT |
public String findStorageKeyById(Integer id){
return Optional.ofNullable(storageSourceService.findById(id)).map(StorageSource::getKey).orElse(null);
} |
根据存储源 id 获取存储源 key
@param id
存储源 id
@return 存储源 key
| StorageSourceService::findStorageKeyById | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java | MIT |
public StorageTypeEnum findStorageTypeById(Integer id) {
return Optional.ofNullable(storageSourceService.findById(id)).map(StorageSource::getType).orElse(null);
} |
根据 id 获取指定存储源的类型.
@param id
存储源 ID
@return 存储源对应的类型.
| StorageSourceService::findStorageTypeById | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java | MIT |
public boolean existByStorageKey(String storageKey) {
return storageSourceService.findByStorageKey(storageKey) != null;
} |
判断存储源 key 是否已存在 (不读取缓存)
@param storageKey
存储源 key
@return 是否已存在
| StorageSourceService::existByStorageKey | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java | MIT |
private static void checkPathSecurity(String... paths) {
for (String path : paths) {
// 路径中不能包含 .. 不然可能会获取到上层文件夹的内容
if (StrUtil.startWith(path, "/..") || StrUtil.containsAny(path, "../", "..\\")) {
throw new IllegalArgumentException("文件路径存在安全隐患: " + path);
}
}
} |
检查路径合法性：
- 只有以 . 开头的允许通过，其他的如 ./ ../ 的都是非法获取上层文件夹内容的路径.
@param paths
文件路径
@throws IllegalArgumentException 文件路径包含非法字符时会抛出此异常
| LocalServiceImpl::checkPathSecurity | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/impl/LocalServiceImpl.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/impl/LocalServiceImpl.java | MIT |
private static void checkNameSecurity(String... names) {
for (String name : names) {
// 路径中不能包含 .. 不然可能会获取到上层文件夹的内容
if (StrUtil.containsAny(name, "\\", "/")) {
throw new IllegalArgumentException("文件名存在安全隐患: " + name);
}
}
} |
检查路径合法性：
- 不为空，且不包含 \ / 字符
@param names
文件路径
@throws IllegalArgumentException 文件名包含非法字符时会抛出此异常
| LocalServiceImpl::checkNameSecurity | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/impl/LocalServiceImpl.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/impl/LocalServiceImpl.java | MIT |
private String getIdByPath(String path) {
String fullPath = StringUtils.concat(param.getBasePath(), path);
if (StrUtil.isEmpty(fullPath) || StrUtil.equals(fullPath, StringUtils.DELIMITER_STR)) {
return StrUtil.isEmpty(param.getDriveId()) ? "root" : param.getDriveId();
}
List<String> pathList = StrUtil.splitTrim(fullPath, "/");
String driveId = "";
for (String subPath : pathList) {
String folderIdParam = new GoogleDriveAPIParam().getDriveIdByPathParam(subPath, driveId);
HttpRequest httpRequest = HttpUtil.createGet(DRIVE_FILE_URL);
httpRequest.header("Authorization", "Bearer " + param.getAccessToken());
httpRequest.body(folderIdParam);
HttpResponse httpResponse = httpRequest.execute();
checkHttpResponseIsError(httpResponse);
String body = httpResponse.body();
JSONObject jsonRoot = JSON.parseObject(body);
JSONArray files = jsonRoot.getJSONArray("files");
if (files.size() == 0) {
throw ExceptionUtil.wrapRuntime(new FileNotFoundException());
}
JSONObject jsonLastItem = files.getJSONObject(files.size() - 1);
if (jsonLastItem.containsKey("shortcutDetails")) {
driveId = jsonLastItem.getJSONObject("shortcutDetails").getString("targetId");
} else {
driveId = jsonLastItem.getString("id");
}
}
return driveId;
} |
根据路径获取文件/文件夹 id
@param path
路径
@return 文件/文件夹 id
| GoogleDriveServiceImpl::getIdByPath | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | MIT |
public OAuth2TokenDTO getRefreshToken() {
StorageSourceConfig refreshStorageSourceConfig =
storageSourceConfigService.findByStorageIdAndName(storageId, StorageConfigConstant.REFRESH_TOKEN_KEY);
String paramStr = "client_id=" + param.getClientId() +
"&client_secret=" + param.getClientSecret() +
"&refresh_token=" + refreshStorageSourceConfig.getValue() +
"&grant_type=refresh_token" +
"&access_type=offline";
log.info("存储源 {}({}) 尝试刷新令牌", storageId, this.getStorageTypeEnum().getDescription());
if (log.isDebugEnabled()) {
log.debug("存储源 {}({}) 尝试刷新令牌, 参数信息为: {}", storageId, this.getStorageTypeEnum().getDescription(), param);
}
HttpRequest post = HttpUtil.createPost(REFRESH_TOKEN_URL);
post.body(paramStr);
HttpResponse response = post.execute();
String responseBody = response.body();
log.info("存储源 {}({}) 刷新令牌完成, 响应信息为: httpStatus: {}", storageId, this.getStorageTypeEnum().getDescription(), response.getStatus());
if (log.isDebugEnabled()) {
log.debug("存储源 {}({}) 刷新令牌完成, 响应信息为: {}", storageId, this.getStorageTypeEnum().getDescription(), responseBody);
}
JSONObject jsonBody = JSONObject.parseObject(responseBody);
if (response.getStatus() != HttpStatus.OK.value()) {
return OAuth2TokenDTO.fail(param.getClientId(), param.getClientSecret(), param.getRedirectUri(), responseBody);
}
String accessToken = jsonBody.getString("access_token");
return OAuth2TokenDTO.success(param.getClientId(), param.getClientSecret(), param.getRedirectUri(), accessToken, null, responseBody);
} |
根据 RefreshToken 刷新 AccessToken, 返回刷新后的 Token.
@return 刷新后的 Token
| GoogleDriveServiceImpl::getRefreshToken | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | MIT |
public List<FileItemResult> jsonArrayToFileList(JSONArray jsonArray, String folderPath) {
ArrayList<FileItemResult> fileList = new ArrayList<>();
for (int i = 0; i < jsonArray.size(); i++) {
fileList.add(jsonObjectToFileItem(jsonArray.getJSONObject(i), folderPath));
}
return fileList;
} |
转换 api 返回的 json array 为 zfile 文件对象列表
@param jsonArray
api 返回文件 json array
@param folderPath
所属文件夹路径
@return zfile 文件对象列表
| GoogleDriveServiceImpl::jsonArrayToFileList | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | MIT |
public FileItemResult jsonObjectToFileItem(JSONObject jsonObject, String folderPath) {
FileItemResult fileItemResult = new FileItemResult();
fileItemResult.setName(jsonObject.getString("name"));
fileItemResult.setPath(folderPath);
fileItemResult.setSize(jsonObject.getLong("size"));
String mimeType = jsonObject.getString("mimeType");
if (ObjectUtil.equals(SHORTCUT_MIME_TYPE, mimeType)) {
JSONObject shortcutDetails = jsonObject.getJSONObject("shortcutDetails");
mimeType = shortcutDetails.getString("targetMimeType");
}
if (StrUtil.equals(mimeType, FOLDER_MIME_TYPE)) {
fileItemResult.setType(FileTypeEnum.FOLDER);
} else {
fileItemResult.setType(FileTypeEnum.FILE);
fileItemResult.setUrl(getDownloadUrl(StringUtils.concat(folderPath, fileItemResult.getName())));
}
fileItemResult.setTime(jsonObject.getDate("modifiedTime"));
if (fileItemResult.getSize() == null) {
fileItemResult.setSize(-1L);
}
return fileItemResult;
} |
转换 api 返回的 json object 为 zfile 文件对象
@param jsonObject
api 返回文件 json object
@param folderPath
所属文件夹路径
@return zfile 文件对象
| GoogleDriveServiceImpl::jsonObjectToFileItem | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | MIT |
public String getDriveIdByPathParam(String folderPath, String parentId) {
GoogleDriveAPIParam googleDriveApiParam = getBasicParam();
String parentIdParam = "";
if (StrUtil.isNotEmpty(parentId)) {
parentIdParam = "'" + parentId + "' in parents and ";
}
googleDriveApiParam.setFields("files(id,shortcutDetails)");
googleDriveApiParam.setQ(parentIdParam + " name = '" + folderPath + "' and trashed = false");
return googleDriveApiParam.toString();
} |
根据路径获取 id 的 api 请求参数
@param folderPath
文件夹路径
| GoogleDriveAPIParam::getDriveIdByPathParam | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | MIT |
public String getFileListParam(String folderId, String pageToken) {
GoogleDriveAPIParam googleDriveAPIParam = getBasicParam();
googleDriveAPIParam.setFields("files(id,name,mimeType,shortcutDetails,size,modifiedTime),nextPageToken");
googleDriveAPIParam.setQ("'" + folderId + "' in parents and trashed = false");
googleDriveAPIParam.setPageToken(pageToken);
googleDriveAPIParam.setPageSize(DEFAULT_PAGE_SIZE);
return googleDriveAPIParam.toString();
} |
根据路径获取 id 的 api 请求参数
@param folderId
google drive 文件夹 id
@param pageToken
分页 token
| GoogleDriveAPIParam::getFileListParam | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | MIT |
public String getSearchParam(String folderId, String pageToken, String keyword) {
GoogleDriveAPIParam googleDriveAPIParam = getBasicParam();
String parentIdParam = "";
if (StrUtil.isNotEmpty(folderId)) {
parentIdParam = "'" + folderId + "' in parents and ";
}
googleDriveAPIParam.setFields("files(id,name,mimeType,shortcutDetails,size,modifiedTime),nextPageToken");
googleDriveAPIParam.setQ(parentIdParam + " name contains '" + keyword + "' and trashed = false");
googleDriveAPIParam.setPageToken(pageToken);
googleDriveAPIParam.setPageSize(DEFAULT_PAGE_SIZE);
return googleDriveAPIParam.toString();
} |
根据关键字和路径搜索文件 api 请求参数
@param folderId
搜索的父文件夹 id
@param pageToken
分页 token
@param keyword
搜索关键字
| GoogleDriveAPIParam::getSearchParam | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | MIT |
public GoogleDriveAPIParam getBasicParam() {
GoogleDriveAPIParam googleDriveAPIParam = new GoogleDriveAPIParam();
String driveId = param.getDriveId();
// 判断是否是团队盘，如果是，则需要添加团队盘的参数
boolean isTeamDrive = StrUtil.isNotEmpty(driveId);
googleDriveAPIParam.setCorpora("user");
googleDriveAPIParam.setIncludeItemsFromAllDrives(true);
googleDriveAPIParam.setSupportsAllDrives(true);
if (isTeamDrive) {
googleDriveAPIParam.setDriveId(driveId);
googleDriveAPIParam.setCorpora("drive");
}
return googleDriveAPIParam;
} |
判断是否是团队盘，填充基础参数
| GoogleDriveAPIParam::getBasicParam | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | MIT |
private void checkHttpResponseIsError(HttpResponse httpResponse) {
if (HttpStatus.valueOf(httpResponse.getStatus()).isError()) {
int statusCode = httpResponse.getStatus();
String responseBody = httpResponse.body();
String msg = StrUtil.format("statusCode: {}, responseBody: {}", statusCode, responseBody);
throw new HttpResponseStatusErrorException(msg);
}
} |
检查 http 响应是否为 5xx, 如果是，则抛出异常
@param httpResponse
http 响应
| GoogleDriveAPIParam::checkHttpResponseIsError | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | MIT |
private void checkHttpResponseIsError(CloseableHttpResponse closeableHttpResponse) throws IOException {
int statusCode = closeableHttpResponse.getStatusLine().getStatusCode();
if (HttpStatus.valueOf(statusCode).isError()) {
HttpEntity responseEntity = closeableHttpResponse.getEntity();
String responseBody = EntityUtils.toString(responseEntity, StandardCharsets.UTF_8);
String msg = StrUtil.format("statusCode: {}, responseBody: {}", statusCode, responseBody);
throw new HttpResponseStatusErrorException(msg);
}
} |
检查 http 响应是否为 5xx, 如果是，则抛出异常 (http client)
@param closeableHttpResponse
http 响应
| GoogleDriveAPIParam::checkHttpResponseIsError | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/impl/GoogleDriveServiceImpl.java | MIT |
private String getPolicy(UploadSignParam uploadSignParam) {
String bucketName = param.getBucketName();
HashMap<String, Object> params = new HashMap<>();
params.put(Params.BUCKET, bucketName);
params.put(Params.SAVE_KEY, StringUtils.concat(uploadSignParam.getPath(), uploadSignParam.getName()));
params.put(Params.EXPIRATION, System.currentTimeMillis() / 1000 + UPLOAD_SESSION_EXPIRATION);
params.put("content-length", uploadSignParam.getSize());
params.put(Params.CONTENT_LENGTH_RANGE, "0," + uploadSignParam.getSize());
return UpYunUtils.getPolicy(params);
} |
获取上传 policy
@param uploadSignParam
上传签名参数
@return 上传 policy
| UpYunServiceImpl::getPolicy | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/impl/UpYunServiceImpl.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/impl/UpYunServiceImpl.java | MIT |
public void testConnection() {
try {
fileList("/");
isInitialized = true;
} catch (Exception e) {
throw new InitializeStorageSourceException(CodeMsg.STORAGE_SOURCE_INIT_FAIL, storageId, "初始化异常, 错误信息为: " + e.getMessage(), e).setResponseExceptionMessage(true);
}
} |
测试是否连接成功, 会尝试取调用获取根路径的文件, 如果没有抛出异常, 则认为连接成功.
| AbstractBaseFileService::testConnection | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/base/AbstractBaseFileService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/base/AbstractBaseFileService.java | MIT |
public OAuth2TokenDTO getAndRefreshToken() {
StorageSourceConfig refreshStorageSourceConfig =
storageSourceConfigService.findByStorageIdAndName(storageId, StorageConfigConstant.REFRESH_TOKEN_KEY);
String param = "client_id=" + getClientId() +
"&redirect_uri=" + getRedirectUri() +
"&client_secret=" + getClientSecret() +
"&refresh_token=" + refreshStorageSourceConfig.getValue() +
"&grant_type=refresh_token";
if (log.isDebugEnabled()) {
log.debug("{} 尝试刷新令牌, 请求参数: [{}]", getStorageSimpleInfo(), param);
}
String authenticateUrl = AUTHENTICATE_URL.replace("{authenticateEndPoint}", getAuthenticateEndPoint());
HttpResponse response = HttpUtil.createPost(authenticateUrl)
.body(param, ContentType.FORM_URLENCODED.getValue())
.execute();
String responseBody = response.body();
int responseStatus = response.getStatus();
log.info("{} 刷新令牌完成. [httpStatus: {}]", getStorageSimpleInfo(), responseStatus);
if (responseStatus != HttpStatus.OK.value()) {
return OAuth2TokenDTO.fail(getClientId(), getClientSecret(), getRedirectUri(), responseBody);
}
JSONObject jsonBody = JSONObject.parseObject(responseBody);
String accessToken = jsonBody.getString(ACCESS_TOKEN_FIELD_NAME);
String refreshToken = jsonBody.getString(REFRESH_TOKEN_FIELD_NAME);
return OAuth2TokenDTO.success(getClientId(), getClientSecret(), getRedirectUri(), accessToken, refreshToken, responseBody);
} |
根据 RefreshToken 刷新 AccessToken, 返回刷新后的 Token.
@return 刷新后的 Token
| AbstractMicrosoftDriveService::getAndRefreshToken | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/base/AbstractMicrosoftDriveService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/base/AbstractMicrosoftDriveService.java | MIT |
public OAuth2TokenDTO getTokenByCode(String code, String clientId, String clientSecret, String redirectUri) {
String param = "client_id=" + clientId +
"&redirect_uri=" + redirectUri +
"&client_secret=" + clientSecret +
"&code=" + code +
"&scope=" + getScope() +
"&grant_type=authorization_code";
if (log.isDebugEnabled()) {
log.debug("根据授权回调 code 获取存储源类型为 [{}] 的令牌, 请求参数: [{}]", this.getStorageTypeEnum().getDescription(), param);
}
String fullAuthenticateUrl = AUTHENTICATE_URL.replace("{authenticateEndPoint}", getAuthenticateEndPoint());
HttpResponse response = HttpUtil.createPost(fullAuthenticateUrl)
.body(param, "application/x-www-form-urlencoded")
.execute();
String responseBody = response.body();
int responseStatus = response.getStatus();
log.info("根据授权回调 code 获取存储源类型为 [{}] 的令牌完成. [httpStatus: {}]", this.getStorageTypeEnum().getDescription(), responseStatus);
if (responseStatus != HttpStatus.OK.value()) {
return OAuth2TokenDTO.fail(clientId, clientSecret, redirectUri, responseBody);
}
JSONObject jsonBody = JSONObject.parseObject(responseBody);
String accessToken = jsonBody.getString(ACCESS_TOKEN_FIELD_NAME);
String refreshToken = jsonBody.getString(REFRESH_TOKEN_FIELD_NAME);
return OAuth2TokenDTO.success(clientId, clientSecret, redirectUri, accessToken, refreshToken, responseBody);
} |
OAuth2 协议中, 根据 code 换取 access_token 和 refresh_token.
@param code
代码
@return 获取的 Token 信息.
| AbstractMicrosoftDriveService::getTokenByCode | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/base/AbstractMicrosoftDriveService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/base/AbstractMicrosoftDriveService.java | MIT |
public List<FileItemResult> s3FileList(String path) {
String bucketName = param.getBucketName();
path = StringUtils.trimStartSlashes(path);
String fullPath = StringUtils.trimStartSlashes(StringUtils.concat(param.getBasePath(), path, ZFileConstant.PATH_SEPARATOR));
List<FileItemResult> fileItemList = new ArrayList<>();
ListObjectsRequest listObjectsRequest = new ListObjectsRequest()
.withBucketName(bucketName)
.withPrefix(fullPath)
.withMaxKeys(1000)
.withDelimiter("/");
ObjectListing objectListing = s3Client.listObjects(listObjectsRequest);
boolean isFirstWhile = true;
do {
if (!isFirstWhile) {
objectListing = s3Client.listNextBatchOfObjects(objectListing);
}
for (S3ObjectSummary s : objectListing.getObjectSummaries()) {
FileItemResult fileItemResult = new FileItemResult();
if (s.getKey().equals(fullPath)) {
continue;
}
fileItemResult.setName(s.getKey().substring(fullPath.length()));
fileItemResult.setSize(s.getSize());
fileItemResult.setTime(s.getLastModified());
fileItemResult.setType(FileTypeEnum.FILE);
fileItemResult.setPath(path);
String fullPathAndName = StringUtils.concat(path, fileItemResult.getName());
fileItemResult.setUrl(getDownloadUrl(fullPathAndName));
fileItemList.add(fileItemResult);
}
for (String commonPrefix : objectListing.getCommonPrefixes()) {
FileItemResult fileItemResult = new FileItemResult();
fileItemResult.setName(commonPrefix.substring(fullPath.length(), commonPrefix.length() - 1));
String name = fileItemResult.getName();
if (StrUtil.isEmpty(name) || StrUtil.equals(name, StringUtils.DELIMITER_STR)) {
continue;
}
fileItemResult.setType(FileTypeEnum.FOLDER);
fileItemResult.setPath(path);
fileItemList.add(fileItemResult);
}
isFirstWhile = false;
} while (objectListing.isTruncated());
return fileItemList;
} |
获取 S3 指定目录下的对象列表
@param path 路径
@return 指定目录下的对象列表
| AbstractS3BaseFileService::s3FileList | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/storage/service/base/AbstractS3BaseFileService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/storage/service/base/AbstractS3BaseFileService.java | MIT |
public boolean containsPathMatcher(Collection<String> patternList, String value) {
if (CollUtil.isEmpty(patternList)) {
return false;
}
for (String pattern : patternList) {
if (pathMatcher.match(pattern, value)) {
return true;
}
}
return false;
} |
校验 value 是否在 Ant 表达式列表中.
@param patternList
Ant 表达式列表
@param value
要校验的值
@return 如果集合为空 (null 或者空), 返回 false, 否则在表达式列表中找到匹配的返回 true, 找不到返回 false.
| RefererCheckAspect::containsPathMatcher | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/link/aspect/RefererCheckAspect.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/link/aspect/RefererCheckAspect.java | MIT |
private void handlerDownload(String storageKey, String filePath, String shortKey, String downloadType) throws IOException {
HttpServletRequest request = RequestHolder.getRequest();
HttpServletResponse response = RequestHolder.getResponse();
// 获取存储源 Service
AbstractBaseFileService<?> fileService;
try {
fileService = storageSourceContext.getByStorageKey(storageKey);
} catch (InvalidStorageSourceException e) {
throw new RuntimeException("无效的或初始化失败的存储源 [" + storageKey + "] 文件 [" + filePath + "] 下载链接异常, 无法下载.", e);
}
StorageSource storageSource = storageSourceService.findByStorageKey(storageKey);
Boolean enable = storageSource.getEnable();
if (!enable) {
throw new RuntimeException("未启用的存储源 [" + storageKey + "] 文件 [" + filePath + "] 下载链接异常, 无法下载.");
}
// 检查是否访问了禁止下载的目录
if (filterConfigService.checkFileIsDisableDownload(storageSource.getId(), filePath)) {
// 获取 Forbidden 页面地址
String forbiddenUrl = systemConfigService.getForbiddenUrl();
RequestHolder.getResponse().sendRedirect(forbiddenUrl);
return;
}
// 获取文件下载链接
String downloadUrl;
try {
downloadUrl = fileService.getDownloadUrl(filePath);
} catch (StorageSourceFileOperatorException e) {
throw new RuntimeException("获取存储源 [" + storageKey + "] 文件 [" + filePath + "] 下载链接异常, 无法下载.", e);
}
// 判断下载链接是否为空
if (StrUtil.isEmpty(downloadUrl)) {
throw new RuntimeException("获取存储源 [" + storageKey + "] 文件 [" + filePath + "] 下载链接为空, 无法下载.");
}
// 记录下载日志.
SystemConfigDTO systemConfig = systemConfigService.getSystemConfig();
Boolean recordDownloadLog = systemConfig.getRecordDownloadLog();
if (BooleanUtil.isTrue(recordDownloadLog)) {
DownloadLog downloadLog = new DownloadLog(downloadType, filePath, storageKey, shortKey);
downloadLogService.save(downloadLog);
}
// 判断下载链接是否为 m3u8 格式, 如果是则返回 m3u8 内容.
if (StrUtil.equalsIgnoreCase(FileUtil.extName(filePath), "m3u8")) {
String textContent = HttpUtil.getTextContent(downloadUrl);
response.setContentType("application/vnd.apple.mpegurl;charset=utf-8");
OutputStream outputStream = response.getOutputStream();
byte[] textContentBytes = EncodingUtils.getBytes(textContent, CharsetUtil.CHARSET_UTF_8.displayName());
IoUtil.write(outputStream, true, textContentBytes);
return;
}
// 禁止直链被浏览器 302 缓存.
response.setHeader(HttpHeaders.CACHE_CONTROL, "no-cache, no-store, must-revalidate, private");
response.setHeader(HttpHeaders.PRAGMA, "no-cache");
response.setHeader(HttpHeaders.EXPIRES, "0");
// 重定向到下载链接.
String parameterType = request.getParameter("type");
if (StrUtil.equals(parameterType, "preview")) {
downloadUrl = UrlUtils.concatQueryParam(downloadUrl, "type", "preview");
}
response.sendRedirect(downloadUrl);
} |
处理指定存储源的下载请求
@param storageKey
存储源 key
@param filePath
文件路径
@param shortKey
短链接 key
@param downloadType
下载类型, 直链下载(directLink)或短链下载(shortLink)
@throws IOException 可能抛出的 IO 异常
| LinkDownloadService::handlerDownload | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/link/service/LinkDownloadService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/link/service/LinkDownloadService.java | MIT |
public ShortLink generatorShortLink(Integer storageId, String fullPath, Long expireTime) {
boolean validate = checkExpireDateIsValidate(expireTime);
if (!validate) {
throw new IllegalArgumentException("过期时间不合法");
}
ShortLink shortLink;
String randomKey;
int generateCount = 0;
do {
// 获取短链
randomKey = RandomUtil.randomString(6);
shortLink = shortLinkService.findByKey(randomKey);
generateCount++;
} while (shortLink != null);
shortLink = new ShortLink();
shortLink.setStorageId(storageId);
shortLink.setUrl(fullPath);
shortLink.setCreateDate(new Date());
shortLink.setShortKey(randomKey);
if (expireTime == -1) {
shortLink.setExpireDate(DateUtil.parseDate("9999-12-31"));
} else {
shortLink.setExpireDate(new Date(System.currentTimeMillis() + expireTime * 1000L));
}
if (log.isDebugEnabled()) {
log.debug("生成直/短链: 存储源 ID: {}, 文件路径: {}, 短链 key {}, 随机生成直链冲突次数: {}",
shortLink.getStorageId(), shortLink.getUrl(), shortLink.getShortKey(), generateCount);
}
shortLinkMapper.insert(shortLink);
return shortLink;
} |
为存储源指定路径生成短链接, 保证生成的短连接 key 是不同的
@param storageId
存储源 id
@param fullPath
存储源路径
@return 生成后的短链接信息
| ShortLinkService::generatorShortLink | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/link/service/ShortLinkService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/link/service/ShortLinkService.java | MIT |
public ReadmeConfig findReadmeByPath(Integer storageId, String path) {
List<ReadmeConfig> readmeConfigList = readmeConfigService.findByStorageId(storageId);
return getReadmeByTestPattern(storageId, readmeConfigList, path);
} |
根据存储源指定路径下的 readme 配置
@param storageId
存储源ID
@param path
文件夹路径
@return 存储源 readme 配置列表
| public::findReadmeByPath | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/readme/service/ReadmeConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/readme/service/ReadmeConfigService.java | MIT |
public ReadmeConfig getByStorageAndPath(Integer storageId, String path, Boolean compatibilityReadme) {
ReadmeConfig readmeByPath = new ReadmeConfig();
readmeByPath.setStorageId(storageId);
readmeByPath.setDisplayMode(ReadmeDisplayModeEnum.BOTTOM);
if (BooleanUtil.isTrue(compatibilityReadme)) {
try {
log.info("存储源 {} 兼容获取目录 {} 下的 readme.md", storageId, path);
AbstractBaseFileService<IStorageParam> abstractBaseFileService = storageSourceContext.getByStorageId(storageId);
String pathAndName = StringUtils.concat(path, "readme.md");
FileItemResult fileItem = abstractBaseFileService.getFileItem(pathAndName);
if (fileItem != null) {
String url = fileItem.getUrl();
String readmeText = HttpUtil.getTextContent(url);
readmeByPath.setReadmeText(readmeText);
}
} catch (Exception e) {
log.error("存储源 {} 兼容获取目录 {} 下的 readme.md 文件失败", storageId, path, e);
}
} else {
// 获取指定目录 readme 文件
ReadmeConfig dbReadmeConfig = readmeConfigService.findReadmeByPath(storageId, path);
if (dbReadmeConfig != null) {
readmeByPath = dbReadmeConfig;
}
log.info("存储源 {} 规则模式获取目录 {} 下文档信息", storageId, path);
}
return readmeByPath;
} |
根据存储源指定路径下的 readme 配置，如果指定为兼容模式，则会读取指定目录下的 readme.md 文件.
@param storageId
存储源 ID
@param path
存储源路径
@param compatibilityReadme
是否兼容为读取 readme.md 文件
@return 目录下存储源 readme 配置
| public::getByStorageAndPath | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/readme/service/ReadmeConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/readme/service/ReadmeConfigService.java | MIT |
private ReadmeConfig getReadmeByTestPattern(Integer storageId, List<ReadmeConfig> patternList, String test) {
// 如果目录文档规则为空, 则可直接返回空.
if (CollUtil.isEmpty(patternList)) {
if (log.isDebugEnabled()) {
log.debug("目录文档规则列表为空, 存储源 ID: {}, 测试字符串: {}", storageId, test);
}
return null;
}
for (ReadmeConfig filterConfig : patternList) {
String expression = filterConfig.getExpression();
if (StrUtil.isEmpty(expression)) {
if (log.isDebugEnabled()) {
log.debug("存储源 {} 目录文档规则表达式为空: {}, 测试字符串: {}, 表达式为空，跳过该规则比对", storageId, expression, test);
}
continue;
}
try {
boolean match = PatternMatcherUtils.testCompatibilityGlobPattern(expression, test);
if (log.isDebugEnabled()) {
log.debug("存储源 {} 目录文档规则表达式: {}, 测试字符串: {}, 匹配结果: {}", storageId, expression, test, match);
}
if (match) {
return filterConfig;
}
} catch (Exception e) {
log.error("存储源 {} 目录文档规则表达式: {}, 测试字符串: {}, 匹配异常，跳过该规则.", storageId, expression, test, e);
}
}
return null;
} |
根据规则表达式和测试字符串进行匹配，如测试字符串和其中一个规则匹配上，则返回 true，反之返回 false。
@param patternList
规则列表
@param test
测试字符串
@return 是否显示
| public::getReadmeByTestPattern | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/readme/service/ReadmeConfigService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/readme/service/ReadmeConfigService.java | MIT |
public LoginVerifyImgResult generatorCaptcha() {
CircleCaptcha captcha = CaptchaUtil.createCircleCaptcha(200, 45, 4, 7);
String code = captcha.getCode();
String imageBase64 = captcha.getImageBase64Data();
String uuid = UUID.fastUUID().toString();
verifyCodeCache.put(uuid, code);
LoginVerifyImgResult loginVerifyImgResult = new LoginVerifyImgResult();
loginVerifyImgResult.setImgBase64(imageBase64);
loginVerifyImgResult.setUuid(uuid);
return loginVerifyImgResult;
} |
生成验证码，并写入缓存中.
@return 验证码生成结果
| ImgVerifyCodeService::generatorCaptcha | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/login/service/ImgVerifyCodeService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/login/service/ImgVerifyCodeService.java | MIT |
public boolean verifyCaptcha(String uuid, String code) {
String expectedCode = verifyCodeCache.get(uuid);
return Objects.equals(expectedCode, code);
} |
对验证码进行验证.
@param uuid
验证码 uuid
@param code
验证码
@return 是否验证成功
| ImgVerifyCodeService::verifyCaptcha | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/login/service/ImgVerifyCodeService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/login/service/ImgVerifyCodeService.java | MIT |
public void checkCaptcha(String uuid, String code) {
boolean flag = verifyCaptcha(uuid, code);
if (!flag) {
throw new LoginVerifyException("验证码错误或已失效.");
}
} |
对验证码进行验证, 如验证失败则抛出异常
@param uuid
验证码 uuid
@param code
验证码
| ImgVerifyCodeService::checkCaptcha | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/login/service/ImgVerifyCodeService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/login/service/ImgVerifyCodeService.java | MIT |
public LoginTwoFactorAuthenticatorResult setupDevice() throws QrGenerationException {
// 生成 2FA 密钥
String secret = secretGenerator.generate();
QrData data = qrDataFactory.newBuilder().secret(secret).issuer("ZFile").build();
// 将生成的 2FA 密钥转换为 Base64 图像字符串
String qrCodeImage = getDataUriForImage(
qrGenerator.generate(data),
qrGenerator.getImageMimeType());
return new LoginTwoFactorAuthenticatorResult(qrCodeImage, secret);
} |
生成 2FA 双因素认证二维码和密钥
@return 2FA 双因素认证二维码和密钥
@throws QrGenerationException 二维码生成异常
| TwoFactorAuthenticatorVerifyService::setupDevice | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/login/service/TwoFactorAuthenticatorVerifyService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/login/service/TwoFactorAuthenticatorVerifyService.java | MIT |
public void deviceVerify(VerifyLoginTwoFactorAuthenticatorRequest verifyLoginTwoFactorAuthenticatorRequest) {
String secret = verifyLoginTwoFactorAuthenticatorRequest.getSecret();
String code = verifyLoginTwoFactorAuthenticatorRequest.getCode();
if (verifier.isValidCode(secret, code)) {
SystemConfigDTO systemConfig = systemConfigService.getSystemConfig();
systemConfig.setLoginVerifyMode(LoginVerifyModeEnum.TWO_FACTOR_AUTHENTICATION_MODE);
systemConfig.setLoginVerifySecret(secret);
systemConfigService.updateSystemConfig(systemConfig);
} else {
throw new LoginVerifyException("验证码不正确");
}
} |
验证 2FA 双因素认证是否正确，正确则进行绑定.
@param verifyLoginTwoFactorAuthenticatorRequest
2FA 双因素认证请求参数
| TwoFactorAuthenticatorVerifyService::deviceVerify | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/login/service/TwoFactorAuthenticatorVerifyService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/login/service/TwoFactorAuthenticatorVerifyService.java | MIT |
public void checkCode(String loginVerifySecret, String verifyCode) {
if (!verifier.isValidCode(loginVerifySecret, verifyCode)) {
throw new LoginVerifyException("验证码错误或已失效");
}
} |
验证 2FA 双因素认证.
@param loginVerifySecret
2FA 双因素认证密钥
@param verifyCode
2FA 双因素认证验证码
| TwoFactorAuthenticatorVerifyService::checkCode | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/module/login/service/TwoFactorAuthenticatorVerifyService.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/module/login/service/TwoFactorAuthenticatorVerifyService.java | MIT |
private List<RequestParameter> generateRequestParameters(){
RequestParameterBuilder token = new RequestParameterBuilder();
List<RequestParameter> parameters = new ArrayList<>();
token.name("zfile-token").description("token").in(In.HEADER.toValue()).required(true).build();
parameters.add(token.build());
return parameters;
} |
获取通用的全局参数
@return 全局参数列表
| Knife4jConfiguration::generateRequestParameters | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/config/Knife4jConfiguration.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/config/Knife4jConfiguration.java | MIT |
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("ZFILE 文档")
.description("# 这是 ZFILE Restful 接口文档展示页面")
.termsOfServiceUrl("https://www.zfile.vip")
.contact(new Contact("zhaojun", "https://zfile.vip", "[email protected]"))
.version("1.0")
.build();
} |
api 基本信息描述
@return ApiInfo
| Knife4jConfiguration::apiInfo | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/config/Knife4jConfiguration.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/config/Knife4jConfiguration.java | MIT |
public String getResultMessage() {
return responseExceptionMessage ? super.getMessage() : super.getCodeMsg().getMsg();
} |
根据 responseExceptionMessage 判断使用异常消息进行接口返回，如果是则取异常的 message, 否则取 CodeMsg 中的 message
@return 异常消息
| StorageSourceException::getResultMessage | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/exception/StorageSourceException.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/exception/StorageSourceException.java | MIT |
public StorageSourceException setResponseExceptionMessage(boolean responseExceptionMessage) {
this.responseExceptionMessage = responseExceptionMessage;
return this;
} |
设置值是否使用异常消息进行接口返回
@param responseExceptionMessage
是否使用异常消息进行接口返回
@return 当前对象
| StorageSourceException::setResponseExceptionMessage | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/exception/StorageSourceException.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/exception/StorageSourceException.java | MIT |
public static String getTextContent(String url) {
long maxFileSize = 1024 * ZFileConstant.TEXT_MAX_FILE_SIZE_KB;
if (getRemoteFileSize(url) > maxFileSize) {
throw new PreviewException("预览文件超出大小, 最大支持 " + FileUtil.readableFileSize(maxFileSize));
}
String result;
try {
result = cn.hutool.http.HttpUtil.get(url);
} catch (Exception e) {
throw new TextParseException(StrUtil.format("获取文件内容失败, URL: {}", url), e);
}
return result == null ? "" : result;
} |
获取 URL 对应的文件内容
@param url
文件 URL
@return 文件内容
| HttpUtil::getTextContent | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/util/HttpUtil.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/util/HttpUtil.java | MIT |
public static Long getRemoteFileSize(String url) {
long size = 0;
URL urlObject;
try {
urlObject = new URL(url);
URLConnection conn = urlObject.openConnection();
size = conn.getContentLength();
} catch (IOException e) {
e.printStackTrace();
}
return size;
} |
获取远程文件大小
@param url
文件 URL
@return 文件大小
| HttpUtil::getRemoteFileSize | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/util/HttpUtil.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/util/HttpUtil.java | MIT |
public static String resolvePlaceholdersBySpringProperties(String formatStr) {
String placeholderName = getFirstPlaceholderName(formatStr);
if (StrUtil.isEmpty(placeholderName)) {
return formatStr;
}
String propertyValue = SpringUtil.getProperty(placeholderName);
Map<String, String> map = new HashMap<>();
map.put(placeholderName, propertyValue);
return resolvePlaceholders(formatStr, map);
} |
解析占位符, 将指定的占位符替换为指定的值. 变量值从 Spring 环境中获取, 如没取到, 则默认为空.
必须在 Spring 环境下使用, 否则会抛出异常.
@param formatStr
模板字符串
@return 替换后的字符串
| PlaceholderUtils::resolvePlaceholdersBySpringProperties | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/util/PlaceholderUtils.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/util/PlaceholderUtils.java | MIT |
public static String resolvePlaceholders(String formatStr, Map<String, String> parameter) {
if (parameter == null || parameter.isEmpty()) {
return formatStr;
}
StringBuffer buf = new StringBuffer(formatStr);
int startIndex = buf.indexOf(PLACEHOLDER_PREFIX);
while (startIndex != -1) {
int endIndex = buf.indexOf(PLACEHOLDER_SUFFIX, startIndex + PLACEHOLDER_PREFIX.length());
if (endIndex != -1) {
String placeholder = buf.substring(startIndex + PLACEHOLDER_PREFIX.length(), endIndex);
int nextIndex = endIndex + PLACEHOLDER_SUFFIX.length();
try {
String propVal = parameter.get(placeholder);
if (propVal != null) {
buf.replace(startIndex, endIndex + PLACEHOLDER_SUFFIX.length(), propVal);
nextIndex = startIndex + propVal.length();
} else {
log.warn("Could not resolve placeholder '{}' in [{}] ", placeholder, formatStr);
}
} catch (Exception ex) {
log.error("Could not resolve placeholder '{}' in [{}]: ", placeholder, formatStr, ex);
}
startIndex = buf.indexOf(PLACEHOLDER_PREFIX, nextIndex);
} else {
startIndex = -1;
}
}
return buf.toString();
} |
解析占位符, 将指定的占位符替换为指定的值.
@param formatStr
模板字符串
@param parameter
参数列表
@return 替换后的字符串
| PlaceholderUtils::resolvePlaceholders | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/util/PlaceholderUtils.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/util/PlaceholderUtils.java | MIT |
public static String getFirstPlaceholderName(String formatStr) {
List<String> list = getPlaceholderNames(formatStr);
if (CollUtil.isNotEmpty(list)) {
return list.get(0);
}
return null;
} |
获取模板字符串第一个占位符的名称, 如 "我的名字是: ${name}, 我的年龄是: ${age}", 返回 "name".
@param formatStr
模板字符串
@return 占位符名称
| PlaceholderUtils::getFirstPlaceholderName | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/util/PlaceholderUtils.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/util/PlaceholderUtils.java | MIT |
public static List<String> getPlaceholderNames(String formatStr) {
if (StrUtil.isEmpty(formatStr)) {
return Collections.emptyList();
}
List<String> placeholderNameList = new ArrayList<>();
StringBuffer buf = new StringBuffer(formatStr);
int startIndex = buf.indexOf(PLACEHOLDER_PREFIX);
while (startIndex != -1) {
int endIndex = buf.indexOf(PLACEHOLDER_SUFFIX, startIndex + PLACEHOLDER_PREFIX.length());
if (endIndex != -1) {
String placeholder = buf.substring(startIndex + PLACEHOLDER_PREFIX.length(), endIndex);
int nextIndex = endIndex + PLACEHOLDER_SUFFIX.length();
startIndex = buf.indexOf(PLACEHOLDER_PREFIX, nextIndex);
placeholderNameList.add(placeholder);
} else {
startIndex = -1;
}
}
return placeholderNameList;
} |
获取模板字符串第一个占位符的名称, 如 "我的名字是: ${name}, 我的年龄是: ${age}", 返回 ["name", "age].
@param formatStr
模板字符串
@return 占位符名称
| PlaceholderUtils::getPlaceholderNames | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/util/PlaceholderUtils.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/util/PlaceholderUtils.java | MIT |
public int getCode() {
return this.code;
} |
返回code
| AjaxJson::getCode | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/util/AjaxJson.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/util/AjaxJson.java | MIT |
public AjaxJson<T> setMsg(String msg) {
this.msg = msg;
return this;
} |
给 msg 赋值，连缀风格
| AjaxJson::setMsg | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/util/AjaxJson.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/util/AjaxJson.java | MIT |
public AjaxJson<T> setData(T data) {
this.data = data;
return this;
} |
给data赋值，连缀风格
| AjaxJson::setData | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/util/AjaxJson.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/util/AjaxJson.java | MIT |
public static Class<?> getClassFirstGenericsParam(Class<?> clazz) {
Type genericSuperclass = clazz.getGenericSuperclass();
Type actualTypeArgument = ((ParameterizedType) genericSuperclass).getActualTypeArguments()[0];
return (Class<?>) actualTypeArgument;
} |
获取指定类的泛型类型, 只获取第一个泛型类型
@param clazz
泛型类
@return 泛型类型
| ClassUtils::getClassFirstGenericsParam | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/util/ClassUtils.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/util/ClassUtils.java | MIT |
public static ResponseEntity<Resource> exportSingleThread(File file, String fileName) {
if (!file.exists()) {
ByteArrayResource byteArrayResource = new ByteArrayResource("文件不存在或异常，请联系管理员.".getBytes(StandardCharsets.UTF_8));
return ResponseEntity.status(HttpStatus.NOT_FOUND)
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
.body(byteArrayResource);
}
MediaType mediaType = MediaType.APPLICATION_OCTET_STREAM;
HttpHeaders headers = new HttpHeaders();
if (StrUtil.isEmpty(fileName)) {
fileName = file.getName();
}
headers.setContentDispositionFormData("attachment", StringUtils.encodeAllIgnoreSlashes(fileName));
return ResponseEntity
.ok()
.headers(headers)
.contentLength(file.length())
.contentType(mediaType)
.body(new InputStreamResource(FileUtil.getInputStream(file)));
} |
文件下载，单线程，不支持断点续传
@param file
文件对象
@param fileName
要保存为的文件名
@return 文件下载对象
| FileResponseUtil::exportSingleThread | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/util/FileResponseUtil.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/util/FileResponseUtil.java | MIT |
public static String concatQueryParam(String url, String name, String value) {
if (StrUtil.contains(url, "?")) {
return url + "&" + name + "=" + value;
} else {
return url + "?" + name + "=" + value;
}
} |
给 url 拼接参数
@param url
原始 URL
@param name
参数名称
@param value
参数值
@return 拼接后的 URL
| UrlUtils::concatQueryParam | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/util/UrlUtils.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/util/UrlUtils.java | MIT |
public static String bytesToSize(long bytes) {
if (bytes == 0) {
return "0";
}
double k = 1024;
String[] sizes = new String[]{"B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"};
double i = Math.floor(Math.log(bytes) / Math.log(k));
return NumberUtil.round(bytes / Math.pow(k, i), 3) + " " + sizes[(int) i];
} |
将文件大小转换为可读单位
@param bytes
字节数
@return 文件大小可读单位
| SizeToStrUtils::bytesToSize | java | zfile-dev/zfile | src/main/java/im/zhaojun/zfile/core/util/SizeToStrUtils.java | https://github.com/zfile-dev/zfile/blob/master/src/main/java/im/zhaojun/zfile/core/util/SizeToStrUtils.java | MIT |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.