diff --git a/app/src/main/assets/help/jsExtensions.md b/app/src/main/assets/help/jsExtensions.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/app/src/main/assets/help/jsHelp.md b/app/src/main/assets/help/jsHelp.md new file mode 100644 index 000000000..6d08173f9 --- /dev/null +++ b/app/src/main/assets/help/jsHelp.md @@ -0,0 +1,220 @@ +# js变量和函数 + +书源规则中使用js可访问以下变量 +> java 变量-当前类 +> baseUrl 变量-当前url,String +> result 变量-上一步的结果 +> book 变量-[书籍类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/Book.kt) +> chapter 变量-[当前目录类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookChapter.kt) +> source 变量-[基础书源类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BaseSource.kt) +> cookie 变量-[cookie操作类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/help/http/CookieStore.kt) +> cache 变量-[缓存操作类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/help/CacheManager.kt) +> title 变量-当前标题,String +> src 内容,源码 +> nextChapterUrl 变量 下一章节url + +## 当前类对象的可使用的部分方法 + +### [AnalyzeUrl](https://github.com/gedoor/legado/app/src/main/java/io/legado/app/model/analyzeRule/AnalyzeUrl.kt) 部分函数 +> js中通过java.调用,只在`登录检查JS`规则中有效 +``` +initUrl() //重新解析url,可以用于登录检测js登录后重新解析url重新访问 +getHeaderMap().putAll(source.getHeaderMap(true)) //重新设置登录头 +getStrResponse( jsStr: String? = null, sourceRegex: String? = null) //返回访问结果,文本类型,书源内部重新登录后可调用此方法重新返回结果 +getResponse(): Response //返回访问结果,网络朗读引擎采用的是这个,调用登录后在调用这方法可以重新访问,参考阿里云登录检测 +``` + +### [AnalyzeRule](https://github.com/gedoor/legado/app/src/main/java/io/legado/app/model/analyzeRule/AnalyzeRule.kt) 部分函数 +* 获取文本/文本列表 +> `mContent` 待解析源代码，默认为当前页面 +> `isUrl` 链接标识，默认为`false` +``` +java.getString(ruleStr: String?, mContent: Any? = null, isUrl: Boolean = false) +java.getStringList(ruleStr: String?, mContent: Any? = null, isUrl: Boolean = false) +``` +* 设置解析内容 +``` +java.setContent(content: Any?, baseUrl: String? = null): +``` +* 获取Element/Element列表 +> 如果要改变解析源代码，请先使用`java.setContent` +``` +java.getElement(ruleStr: String) +java.getElements(ruleStr: String) +``` + +### [js扩展类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/help/JsExtensions.kt) 部分函数 +* 变量存取 +``` +java.get(key) +java.put(key, value) +``` +* 网络请求 +``` +java.ajax(urlStr) +java.ajaxAll(urlList: Array): Array +``` +* 调试 +``` +java.log(msg) +java.logType(var) +``` +* 缓存网络文件 +``` +获取 +java.cacheFile(url) +java.cacheFile(url,saveTime) +执行内容 +eval(String(java.cacheFile(url))) +删除缓存文件 +cache.delete(java.md5Encode16(url)) +``` +* 获取网络zip文件里面的数据 +``` +java.getZipStringContent(url: String, path: String) +``` +* base64 +> flags参数可省略，默认Base64.NO_WRAP，查看[flags参数说明](https://blog.csdn.net/zcmain/article/details/97051870) +``` +java.base64Decode(str: String, flags: Int) +java.base64Encode(str: String, flags: Int) +``` +* 文件 +> 所有对于文件的读写删操作都是相对路径,只能操作阅读缓存/android/data/{package}/cache/内的文件 +``` +java.readTxtFile(path: String): String +java.deleteFile(path: String) +``` +**** +> [常见加密解密算法介绍](https://www.yijiyong.com/algorithm/encryption/01-intro.html) +> [相关概念](https://blog.csdn.net/OrangeJack/article/details/82913804) +* AES +``` +* @param data 传入的原始数据 +* @param key AES加密的key +* @param transformation AES加密的方式 例如AES/ECB/PKCS5Padding +* @param iv ECB模式的偏移向量 +java.aesDecodeToString(str: String, key: String, transformation: String, iv: String) + +java.aesBase64DecodeToString(str: String, key: String, transformation: String, iv: String) + +java.aesEncodeToString(str: String, key: String, transformation: String, iv: String) + +java.aesEncodeToBase64String(str: String, key: String, transformation: String, iv: String) +``` +* 3DES +``` +* @param data 被加密的字符串 +* @param key 密钥 +* @param mode 模式 ECB/CBC/CFB/OFB/CTR +* @param padding 补码方式 NoPadding/PKCS5Padding/ +* @param iv 加盐 +java.tripleDESEncodeBase64Str(data: String,key: String,mode: String,padding: String,iv: String): String? + +java.tripleDESDecodeStr(data: String,key: String,mode: String,padding: String,iv: String): String? +``` +* 摘要 +``` +* @param data 被摘要数据 +* @param algorithm 签名算法 MD5/SHA1/SHA256/SHA512 +java.digestHex(data: String,algorithm: String,): String? + +java.digestBase64Str(data: String,algorithm: String,): String? +``` +* md5 +``` +java.md5Encode(str) +java.md5Encode16(str) +``` + +## book对象的可用属性 +> 使用方法: 在js中或{{}}中使用book.属性的方式即可获取.如在正文内容后加上 ##{{book.name+"正文卷"+title}} 可以净化 书名+正文卷+章节名称（如 我是大明星正文卷第二章我爸是豪门总裁） 这一类的字符. +``` +bookUrl // 详情页Url(本地书源存储完整文件路径) +tocUrl // 目录页Url (toc=table of Contents) +origin // 书源URL(默认BookType.local) +originName //书源名称 or 本地书籍文件名 +name // 书籍名称(书源获取) +author // 作者名称(书源获取) +kind // 分类信息(书源获取) +customTag // 分类信息(用户修改) +coverUrl // 封面Url(书源获取) +customCoverUrl // 封面Url(用户修改) +intro // 简介内容(书源获取) +customIntro // 简介内容(用户修改) +charset // 自定义字符集名称(仅适用于本地书籍) +type // 0:text 1:audio +group // 自定义分组索引号 +latestChapterTitle // 最新章节标题 +latestChapterTime // 最新章节标题更新时间 +lastCheckTime // 最近一次更新书籍信息的时间 +lastCheckCount // 最近一次发现新章节的数量 +totalChapterNum // 书籍目录总数 +durChapterTitle // 当前章节名称 +durChapterIndex // 当前章节索引 +durChapterPos // 当前阅读的进度(首行字符的索引位置) +durChapterTime // 最近一次阅读书籍的时间(打开正文的时间) +canUpdate // 刷新书架时更新书籍信息 +order // 手动排序 +originOrder //书源排序 +variable // 自定义书籍变量信息(用于书源规则检索书籍信息) + ``` + +## chapter对象的部分可用属性 +> 使用方法: 在js中或{{}}中使用chapter.属性的方式即可获取.如在正文内容后加上 ##{{chapter.title+chapter.index}} 可以净化 章节标题+序号(如 第二章 天仙下凡2) 这一类的字符. + ``` + url // 章节地址 + title // 章节标题 + baseUrl //用来拼接相对url + bookUrl // 书籍地址 + index // 章节序号 + resourceUrl // 音频真实URL + tag // + start // 章节起始位置 + end // 章节终止位置 + variable //变量 + ``` + +## source对象的部分可用函数 +* 获取书源url +``` +source.getKey() +``` +* 书源变量存取 +``` +source.setVariable(variable: String?) +source.getVariable() +``` + +* 登录头操作 +``` +source.getLoginHeader() +source.getLoginHeaderMap(): Map? +source.putLoginHeader(header: String) +source.removeLoginHeader() +``` +## cookie对象的部分可用函数 +``` +获取全部cookie +cookie.getCookie(url) +获取cookie某一键值 +cookie.getKey(url,key) +删除cookie +cookie.removeCookie(key) +``` + +## cache对象的部分可用函数 +> saveTime单位:秒，可省略 +> 保存至数据库和缓存文件(50M)，保存的内容较大时请使用`getFile putFile` +``` +保存 +cache.put(key, value , saveTime) +读取数据库 +cache.get(key) +删除 +cache.delete(key) +缓存文件内容 +cache.putFile(key, value, saveTime) +读取文件内容 +cache.getFile(key) +``` \ No newline at end of file diff --git a/app/src/main/assets/help/ruleHelp.md b/app/src/main/assets/help/ruleHelp.md index b2b1bb0b8..3ddc61526 100644 --- a/app/src/main/assets/help/ruleHelp.md +++ b/app/src/main/assets/help/ruleHelp.md @@ -2,8 +2,7 @@ * [书源帮助文档](https://alanskycn.gitee.io/teachme/Rule/source.html) * [订阅源帮助文档](https://alanskycn.gitee.io/teachme/Rule/rss.html) -* [js扩展类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/help/JsExtensions.kt) -* 辅助键盘❓中可插入URL参数模板,打开帮助,选择文件 +* 辅助键盘❓中可插入URL参数模板,打开帮助,js教程,正则教程,选择文件 * 规则标志, {{......}}内使用规则必须有明显的规则标志,没有规则标志当作js执行 ``` @@ 默认规则,直接写时可以省略@@ @@ -29,25 +28,6 @@ ] ``` -* 获取登录后的cookie -``` -获取全部 -cookie.getCookie(url) -获取某一键值 -cookie.getKey(url,key) -``` - -* 缓存网络文件 -``` -获取 -java.cacheFile(url) -java.cacheFile(url,saveTime) -执行内容 -eval(String(java.cacheFile(url))) -删除缓存文件 -cache.delete(java.md5Encode16(url)) -``` - * 请求头,支持http代理,socks4 socks5代理设置 ``` socks5代理 @@ -64,19 +44,6 @@ http代理 } 注意:这些请求头是无意义的,会被忽略掉 ``` - -* js 变量和函数 -``` -java 变量-当前类 -baseUrl 变量-当前url,String -result 变量-上一步的结果 -book 变量-书籍类,方法见 io.legado.app.data.entities.Book -cookie 变量-cookie操作类,方法见 io.legado.app.help.http.CookieStore -cache 变量-缓存操作类,方法见 io.legado.app.help.CacheManager -chapter 变量-当前目录类,方法见 io.legado.app.data.entities.BookChapter -title 变量-当前标题,String -src 内容,源码 -``` * url添加js参数,解析url时执行,可在访问url时处理url,例 ``` @@ -113,7 +80,7 @@ https://www.baidu.com,{"js":"java.url=java.url+'yyyy'"} })() ``` -* 正文图片链接支持修改headers +* 图片链接支持修改headers ``` let options = { "headers": {"User-Agent": "xxxx","Referrer":baseUrl,"Cookie":"aaa=vbbb;"} @@ -121,58 +88,7 @@ let options = { '' ``` - ## 部分js对象属性说明 -上述js变量与函数中，一些js的对象属性用的频率较高，在此列举。方便写源的时候快速翻阅。 - -### book对象的可用属性 -> 使用方法: 在js中或{{}}中使用book.属性的方式即可获取.如在正文内容后加上 ##{{book.name+"正文卷"+title}} 可以净化 书名+正文卷+章节名称（如 我是大明星正文卷第二章我爸是豪门总裁） 这一类的字符. -``` -bookUrl // 详情页Url(本地书源存储完整文件路径) -tocUrl // 目录页Url (toc=table of Contents) -origin // 书源URL(默认BookType.local) -originName //书源名称 or 本地书籍文件名 -name // 书籍名称(书源获取) -author // 作者名称(书源获取) -kind // 分类信息(书源获取) -customTag // 分类信息(用户修改) -coverUrl // 封面Url(书源获取) -customCoverUrl // 封面Url(用户修改) -intro // 简介内容(书源获取) -customIntro // 简介内容(用户修改) -charset // 自定义字符集名称(仅适用于本地书籍) -type // 0:text 1:audio -group // 自定义分组索引号 -latestChapterTitle // 最新章节标题 -latestChapterTime // 最新章节标题更新时间 -lastCheckTime // 最近一次更新书籍信息的时间 -lastCheckCount // 最近一次发现新章节的数量 -totalChapterNum // 书籍目录总数 -durChapterTitle // 当前章节名称 -durChapterIndex // 当前章节索引 -durChapterPos // 当前阅读的进度(首行字符的索引位置) -durChapterTime // 最近一次阅读书籍的时间(打开正文的时间) -canUpdate // 刷新书架时更新书籍信息 -order // 手动排序 -originOrder //书源排序 -variable // 自定义书籍变量信息(用于书源规则检索书籍信息) - ``` - -### chapter对象的可用属性 -> 使用方法: 在js中或{{}}中使用chapter.属性的方式即可获取.如在正文内容后加上 ##{{chapter.title+chapter.index}} 可以净化 章节标题+序号(如 第二章 天仙下凡2) 这一类的字符. - ``` - url // 章节地址 - title // 章节标题 - baseUrl //用来拼接相对url - bookUrl // 书籍地址 - index // 章节序号 - resourceUrl // 音频真实URL - tag // - start // 章节起始位置 - end // 章节终止位置 - variable //变量 - ``` - -### 字体解析使用 +* 字体解析使用 > 使用方法,在正文替换规则中使用,原理根据f1字体的字形数据到f2中查找字形对应的编码 ``` diff --git a/app/src/main/assets/updateLog.md b/app/src/main/assets/updateLog.md index c7d195cc2..ddd0ae7a9 100644 --- a/app/src/main/assets/updateLog.md +++ b/app/src/main/assets/updateLog.md @@ -17,6 +17,7 @@ * 紧急修复登录问题 * 添加isVolume规则，支持二级目录，正文标题显示优化 by Xwite * 书源编辑界面显示payAction规则 +* 书源编辑中的辅助键盘❓中可查看js说明文档 **2022/01/10** diff --git a/app/src/main/java/io/legado/app/ui/book/source/edit/BookSourceEditActivity.kt b/app/src/main/java/io/legado/app/ui/book/source/edit/BookSourceEditActivity.kt index 0a59dc75a..6ac7ddf74 100644 --- a/app/src/main/java/io/legado/app/ui/book/source/edit/BookSourceEditActivity.kt +++ b/app/src/main/java/io/legado/app/ui/book/source/edit/BookSourceEditActivity.kt @@ -77,7 +77,7 @@ class BookSourceEditActivity : override fun onPostCreate(savedInstanceState: Bundle?) { super.onPostCreate(savedInstanceState) if (!LocalConfig.ruleHelpVersionIsLast) { - showRuleHelp() + showHelp("ruleHelp") } } @@ -119,7 +119,7 @@ class BookSourceEditActivity : getString(R.string.share_book_source), ErrorCorrectionLevel.L ) - R.id.menu_help -> showRuleHelp() + R.id.menu_help -> showHelp("ruleHelp") R.id.menu_login -> getSource().let { source -> if (checkSource(source)) { viewModel.save(source) { @@ -420,26 +420,23 @@ class BookSourceEditActivity : } private fun showHelpDialog() { - val items = arrayListOf("插入URL参数", "书源教程", "正则教程", "选择文件") + val items = arrayListOf("插入URL参数", "书源教程", "js教程", "正则教程", "选择文件") selector(getString(R.string.help), items) { _, index -> when (index) { 0 -> insertText(AppConst.urlOption) - 1 -> showRuleHelp() - 2 -> showRegexHelp() - 3 -> selectDoc.launch { + 1 -> showHelp("ruleHelp") + 2 -> showHelp("jsHelp") + 3 -> showHelp("regexHelp") + 4 -> selectDoc.launch { mode = HandleFileContract.FILE } } } } - private fun showRuleHelp() { - val mdText = String(assets.open("help/ruleHelp.md").readBytes()) - showDialogFragment(TextDialog(mdText, TextDialog.Mode.MD)) - } - - private fun showRegexHelp() { - val mdText = String(assets.open("help/regexHelp.md").readBytes()) + private fun showHelp(fileName: String) { + //显示目录help下的帮助文档 + val mdText = String(assets.open("help/${fileName}.md").readBytes()) showDialogFragment(TextDialog(mdText, TextDialog.Mode.MD)) }