legado/app/src/main/assets/help/jsHelp.md

js变量和函数

书源规则中使用js可访问以下变量

java 变量-当前类
baseUrl 变量-当前url,String
result 变量-上一步的结果
book 变量-书籍类
chapter 变量-当前目录类
source 变量-基础书源类
cookie 变量-cookie操作类
cache 变量-缓存操作类
title 变量-当前标题,String
src 内容,源码
nextChapterUrl 变量 下一章节url

当前类对象的可使用的部分方法

AnalyzeUrl 部分函数

js中通过java.调用,只在登录检查JS规则中有效

initUrl() //重新解析url,可以用于登录检测js登录后重新解析url重新访问
getHeaderMap().putAll(source.getHeaderMap(true)) //重新设置登录头
getStrResponse( jsStr: String? = null, sourceRegex: String? = null) //返回访问结果,文本类型,书源内部重新登录后可调用此方法重新返回结果
getResponse(): Response //返回访问结果,网络朗读引擎采用的是这个,调用登录后在调用这方法可以重新访问,参考阿里云登录检测

AnalyzeRule 部分函数

• 获取文本/文本列表

  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)

• 重新搜索书籍/重新获取目录url

可以在刷新目录之前使用,有些书源书籍地址和目录url会变

java.reGetBook()
java.refreshTocUrl()

• 变量存取

  java.get(key)
  java.put(key, value)
  

js扩展类 部分函数

• 网络请求

  java.ajax(urlStr): String
  java.ajaxAll(urlList: Array<String>): Array<StrResponse?>
  //返回Response 方法body() code() message() header() raw() toString() 
  java.connect(urlStr): StrResponse
  
  java.post(url: String, body: String, headerMap: Map<String, String>): Connection.Response
  
  java.get(url: String, headerMap: Map<String, String>): Connection.Response
  
  java.head(url: String, headerMap: Map<String, String>): Connection.Response
  
  * 使用webView访问网络
  * @param html 直接用webView载入的html, 如果html为空直接访问url
  * @param url html内如果有相对路径的资源不传入url访问不了
  * @param js 用来取返回值的js语句, 没有就返回整个源代码
  * @return 返回js获取的内容
  java.webView(html: String?, url: String?, js: String?): String
  
  * 使用内置浏览器打开链接，可用于获取验证码 手动验证网站防爬
  * @param url 要打开的链接
  * @param title 浏览器的标题
  java.startBrowser(url: String, title: String)
  
  * 使用内置浏览器打开链接，并等待网页结果 .body()获取网页内容
  java.startBrowserAwait(url: String, title: String): StrResponse
  

• 调试

  java.log(msg)
  java.logType(var)
  

• 获取用户输入的验证码

  java.getVerificationCode(imageUrl)
  

• 弹窗提示

  java.longToast(msg: Any?)
  java.toast(msg: Any?)
  

• 从网络(由java.cacheFile实现)、本地读取JavaScript文件，导入上下文请手动eval(String(...))

  java.importScript(url)
  //相对路径支持android/data/{package}/cache
  java.importScript(relativePath)
  java.importScript(absolutePath)
  

• 缓存网络文件

  获取
  java.cacheFile(url)
  java.cacheFile(url,saveTime)
  执行内容
  eval(String(java.cacheFile(url)))
  删除缓存文件
  cache.delete(java.md5Encode16(url))
  

• 获取网络压缩文件里面指定路径的数据 *可替换Zip Rar 7Z Archive

  java.get*StringContent(url: String, path: String): String
  
  java.get*StringContent(url: String, path: String, charsetName: String): String
  
  java.get*ByteArrayContent(url: String, path: String): ByteArray?
  
  

• base64

  flags参数可省略，默认Base64.NO_WRAP，查看flags参数说明

  java.base64Decode(str: String)
  java.base64Decode(str: String, charset: String)
  java.base64DecodeToByteArray(str: String, flags: Int)
  java.base64Encode(str: String, flags: Int)
  

• ByteArray

  Str转Bytes
  java.strToBytes(str: String)
  java.strToBytes(str: String, charset: String)
  Bytes转Str
  java.bytesToStr(bytes: ByteArray)
  java.bytesToStr(bytes: ByteArray, charset: String)
  

• Hex

  HexString 解码为字节数组
  java.hexDecodeToByteArray(hex: String)
  hexString 解码为utf8String
  java.hexDecodeToString(hex: String)
  utf8 编码为hexString
  java.hexEncodeToString(utf8: String)
  

• 标识id

  java.randomUUID()
  java.androidId()
  

• 文件

  所有对于文件的读写删操作都是相对路径,只能操作阅读缓存/android/data/{package}/cache/内的文件

  //文件下载,content为十六进制字符串,url用于生成文件名，返回文件路径
  downloadFile(content: String, url: String): String
  downloadFile(url: String): String
  //文件解压,zipPath为压缩文件路径，返回解压路径
  unArchiveFile(zipPath: String): String
  unzipFile(zipPath: String): String
  unrarFile(zipPath: String): String
  un7zFile(zipPath: String): String
  //文件夹内所有文件读取
  getTxtInFolder(unzipPath: String): String
  //读取文本文件
  readTxtFile(path: String): String
  //删除文件
  deleteFile(path: String) 
  

  ---

  提供在JavaScript环境中快捷调用crypto算法的函数，由hutool-crypto实现

其他没有添加的算法可在JavaScript中使用JavaImporter调用Java，例子可参考朗读引擎-阿里云语音

如果输入的参数不是Utf8String 可先调用java.hexDecodeToByteArray java.strToBytes(str: String)转成ByteArray

• 对称加密 输入参数key iv 支持ByteArray|Utf8String

  // 创建Cipher
  java.createSymmetricCrypto(transformation, key, iv)
  

  解密加密参数 data支持ByteArray|Base64String|HexString|InputStream

  //解密为ByteArray String
  cipher.decrypt(data)
  cipher.decryptStr(data)
  //加密为ByteArray Base64字符 HEX字符
  cipher.encrypt(data)
  cipher.encryptBase64(data)
  cipher.encryptHex(data)
  

• 非对称加密 输入参数 key支持ByteArray|Utf8String

  //创建cipher
  java.createAsymmetricCrypto(transformation)
  //设置密钥
  .setPublicKey(key)
  .setPrivateKey(key)
  
  

解密加密参数 data支持ByteArray|Base64String|HexString|InputStream
usePublicKey: true 使用公钥 false 使用私钥

//解密为ByteArray String
cipher.decrypt(data, usePublicKey)
cipher.decryptStr(data, usePublicKey)
//加密为ByteArray Base64字符 HEX字符
cipher.encrypt(data, usePublicKey)
cipher.encryptBase64(data, usePublicKey)
cipher.encryptHex(data, usePublicKey)

• 签名 输入参数 key 支持ByteArray|Utf8String

  //创建Sign
  java.createSign(algorithm)
  //设置密钥
  .setPublicKey(key)
  .setPrivateKey(key)
  

  签名参数 data支持ByteArray|inputStream|String

  //签名输出 ByteArray HexString
  sign.sign(data)
  sign.signHex(data)
  

• 摘要

  java.digestHex(data: String, algorithm: String,): String?
  
  java.digestBase64Str(data: String, algorithm: String,): String?
  

• md5

  java.md5Encode(str)
  java.md5Encode16(str)
  

• HMac

  java.HMacHex(data: String, algorithm: String, key: String): String
  
  java.HMacBase64(data: String, algorithm: String, key: String): String
  

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 // 自定义书籍变量信息(用于书源规则检索书籍信息)

方法

//可在正文js中关闭净化 对于漫画源有用
book.setUseReplaceRule(boolean)

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().get(key: String)
  source.putLoginHeader(header: String)
  source.removeLoginHeader()
  

• 用户登录信息操作

  使用登录UI规则，并成功登录，阅读自动加密保存登录UI规则中除type为button的信息

  source.getLoginInfo()
  source.getLoginInfoMap().get(key: String)
  source.removeLoginInfo()
  

  cookie对象的部分可用函数

  获取全部cookie
  cookie.getCookie(url)
  获取cookie某一键值
  cookie.getKey(url,key)
  删除cookie
  cookie.removeCookie(url)
  

cache对象的部分可用函数

saveTime单位:秒，可省略
保存至数据库和缓存文件(50M)，保存的内容较大时请使用getFile putFile

保存
cache.put(key, value , saveTime)
读取数据库
cache.get(key)
删除
cache.delete(key)
缓存文件内容
cache.putFile(key, value, saveTime)
读取文件内容
cache.getFile(key)