nvm.lua 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318
  1. --- 模块功能:参数管理
  2. -- @module nvm
  3. -- @author openLuat
  4. -- @license MIT
  5. -- @copyright openLuat
  6. -- @release 2017.11.9
  7. require "log"
  8. module(..., package.seeall)
  9. --实时参数配置存储在paraname文件中
  10. --默认参数配置存储在configname文件中
  11. --para:实时参数表
  12. --config:默认参数表
  13. paraname, paranamebak = "/nvm_para.lua", "/nvm_para_bak.lua"
  14. para = {}
  15. local libdftconfig, configname, cconfigname, econfigname
  16. local sBurnSave
  17. --[[
  18. 函数名:serialize
  19. 功能 :根据不同的数据类型,按照不同的格式,写格式化后的数据到文件中
  20. 参数 :
  21. pout:文件句柄
  22. o:数据
  23. 返回值:无
  24. ]]
  25. local function serialize(pout, o)
  26. if type(o) == "number" then
  27. --number类型,直接写原始数据
  28. pout:write(o)
  29. elseif type(o) == "string" then
  30. --string类型,原始数据左右各加上双引号写入
  31. pout:write(string.format("%q", o))
  32. elseif type(o) == "boolean" then
  33. --boolean类型,转化为string写入
  34. pout:write(tostring(o))
  35. elseif type(o) == "table" then
  36. --table类型,加换行,大括号,中括号,双引号写入
  37. pout:write("{\n")
  38. for k, v in pairs(o) do
  39. -- if type(k) == "number" then
  40. -- pout:write(" [" .. k .. "] = ")
  41. -- elseif type(k) == "string" then
  42. -- pout:write(" [\"" .. k .."\"] = ")
  43. -- else
  44. -- error("cannot serialize table key " .. type(o))
  45. -- end
  46. pout:write(" [")
  47. serialize(pout, k)
  48. pout:write("] = ")
  49. serialize(pout, v)
  50. pout:write(",\n")
  51. end
  52. pout:write("}\n")
  53. else
  54. error("cannot serialize a " .. type(o))
  55. end
  56. end
  57. --[[
  58. 函数名:upd
  59. 功能 :更新实时参数表
  60. 参数 :
  61. overide:是否用默认参数强制更新实时参数
  62. 返回值:无
  63. ]]
  64. function upd(overide)
  65. for k, v in pairs(libdftconfig) do
  66. if k ~= "_M" and k ~= "_NAME" and k ~= "_PACKAGE" then
  67. if overide or para[k] == nil then
  68. para[k] = v
  69. end
  70. end
  71. end
  72. end
  73. local function safePcall(file)
  74. local oldPath = package.path
  75. package.path = "/?.lua;".."/?.luae;".."/#lua_user#/?.lua;".."/#lua_user#/?.luae;"..package.path
  76. local result, para = pcall(require, file)
  77. package.path = oldPath
  78. return result, para
  79. end
  80. --[[
  81. 函数名:load
  82. 功能 :初始化参数
  83. 参数 :无
  84. 返回值:无
  85. ]]
  86. local function load()
  87. local f, fBak, fExist, fBakExist
  88. f = io.open(paraname, "rb")
  89. fBak = io.open(paranamebak, "rb")
  90. if f then
  91. fExist = f:read("*a") ~= ""
  92. f:close()
  93. end
  94. if fBak then
  95. fBakExist = fBak:read("*a") ~= ""
  96. fBak:close()
  97. end
  98. print("load fExist fBakExist", fExist, fBakExist)
  99. local fResult, fBakResult
  100. if fExist then
  101. if sBurnSave then
  102. fResult, para = safePcall(paraname:match("/#lua_user#/(.+)%.lua"))
  103. else
  104. fResult, para = safePcall(paraname:match("/(.+)%.lua"))
  105. end
  106. end
  107. print("load fResult", fResult)
  108. if fResult then
  109. os.remove(paranamebak)
  110. upd()
  111. return
  112. end
  113. if fBakExist then
  114. if sBurnSave then
  115. fBakResult, para = safePcall(paranamebak:match("/#lua_user#/(.+)%.lua"))
  116. else
  117. fBakResult, para = safePcall(paranamebak:match("/(.+)%.lua"))
  118. end
  119. end
  120. print("load fBakResult", fBakResult)
  121. if fBakResult then
  122. os.remove(paraname)
  123. upd()
  124. return
  125. else
  126. para = {}
  127. restore()
  128. end
  129. end
  130. --[[
  131. 函数名:save
  132. 功能 :保存参数文件
  133. 参数 :
  134. s:是否真正保存,true保存,false或者nil不保存
  135. 返回值:无
  136. ]]
  137. local function save(s)
  138. if not s then return end
  139. local f = {}
  140. f.write = function(self, s)table.insert(self, s) end
  141. f:write("module(...)\n")
  142. for k, v in pairs(para) do
  143. if k ~= "_M" and k ~= "_NAME" and k ~= "_PACKAGE" then
  144. f:write(k .. " = ")
  145. serialize(f, v)
  146. f:write("\n")
  147. end
  148. end
  149. local fparabak = io.open(paranamebak, 'wb')
  150. fparabak:write(table.concat(f))
  151. fparabak:close()
  152. os.remove(paraname)
  153. os.rename(paranamebak, paraname)
  154. end
  155. --- 初始化参数存储管理模块
  156. -- @string defaultCfgFile 默认参数文件名
  157. -- @bool burnSave 本地烧录时是否保留已有参数,true为保留,false或者nil为清除
  158. -- 注意:在同一个项目,不同版本中,此参数必须保持前后版本一致
  159. -- @return nil
  160. -- @usage
  161. -- 初始化参数存储管理模块,默认参数文件名为config.lua,本地烧录时清除已有的参数:
  162. -- nvm.init("config.lua")
  163. -- 初始化参数存储管理模块,默认参数文件名为config.lua,本地烧录时保留已有的参数:
  164. -- nvm.init("config.lua",true)
  165. function init(defaultCfgFile,burnSave)
  166. local f
  167. f, libdftconfig = safePcall(defaultCfgFile:match("(.+)%.lua"))
  168. configname, cconfigname, econfigname = "/lua/" .. defaultCfgFile, "/lua/" .. defaultCfgFile .. "c", "/lua/" .. defaultCfgFile .. "e"
  169. sBurnSave = burnSave
  170. if burnSave then
  171. rtos.make_dir("/#lua_user#")
  172. paraname, paranamebak = "/#lua_user#/nvm_para.lua", "/#lua_user#/nvm_para_bak.lua"
  173. end
  174. --初始化配置文件,从文件中把参数读取到内存中
  175. load()
  176. end
  177. --- 设置某个参数的值
  178. -- @string k 参数名
  179. -- @param v,可以是任意类型,参数的新值
  180. -- @param r,设置原因,如果传入了非nil的有效参数,并且v值和旧值相比发生了改变,
  181. -- 会产生一个PARA_CHANGED_IND内部消息,携带 k,v,r 3个参数
  182. -- @param s,是否立即写入到文件系统中,false不写入,其余的都写入
  183. -- @return bool或者nil,成功返回true,失败返回nil
  184. -- @usage
  185. -- 参数name赋值为Luat,立即写入文件系统:
  186. -- nvm.set("name","Luat")
  187. --
  188. -- 参数age赋值为12,立即写入文件系统:
  189. -- 如果旧值不是12,会产生一个PARA_CHANGED_IND消息,携带 "age",12,"SVR" 3个参数:
  190. -- nvm.set("age",12,"SVR")
  191. --
  192. -- 参数class赋值为Class2,不写入文件系统:
  193. -- nvm.set("class","Class2",nil,false)
  194. --
  195. -- 参数score赋值为{chinese=100,math=99,english=98},立即写入文件系统:
  196. -- nvm.set("score",{chinese=100,math=99,english=98})
  197. --
  198. -- 连续写入4个参数,前3个不保存到文件系统中,写第4个时,一次性全部保存到文件系统中:
  199. -- nvm.set("para1",1,nil,false)
  200. -- nvm.set("para2",2,nil,false)
  201. -- nvm.set("para3",3,nil,false)
  202. -- nvm.set("para4",4)
  203. function set(k, v, r, s)
  204. local bchg = true
  205. if type(v) ~= "table" then
  206. bchg = (para[k] ~= v)
  207. end
  208. log.info("nvm.set", bchg, k, v, r, s)
  209. if bchg then
  210. para[k] = v
  211. save(s or s == nil)
  212. if r then sys.publish("PARA_CHANGED_IND", k, v, r) end
  213. end
  214. return true
  215. end
  216. --- 设置某个table类型参数的某一个索引的值
  217. -- @string k table类型的参数名
  218. -- @param kk table类型参数的某一个索引名
  219. -- @param v,table类型参数的某一个索引的新值
  220. -- @param r,设置原因,如果传入了非nil的有效参数,并且v值和旧值相比发生了改变,会产生一个TPARA_CHANGED_IND消息,携带 k,kk,v,r 4个参数
  221. -- @param s,是否立即写入到文件系统中,false不写入,其余的都写入
  222. -- @return bool或者nil,成功返回true,失败返回nil
  223. -- @usage nvm.sett("score","chinese",100),参数score["chinese"]赋值为100,立即写入文件系统
  224. -- @usage nvm.sett("score","chinese",100,"SVR"),参数score["chinese"]赋值为100,立即写入文件系统,
  225. -- 如果旧值不是100,会产生一个TPARA_CHANGED_IND消息,携带 "score","chinese",100,"SVR" 4个参数
  226. -- @usage nvm.sett("score","chinese",100,nil,false),参数class赋值为Class2,不写入文件系统
  227. function sett(k, kk, v, r, s)
  228. local bchg = true
  229. if type(v) ~= "table" then
  230. bchg = (para[k][kk] ~= v)
  231. end
  232. if bchg then
  233. para[k][kk] = v
  234. save(s or s == nil)
  235. if r then sys.publish("TPARA_CHANGED_IND", k, kk, v, r) end
  236. end
  237. return true
  238. end
  239. --- 所有参数立即写入文件系统
  240. -- @return nil
  241. -- @usage nvm.flush()
  242. function flush()
  243. save(true)
  244. end
  245. --- 读取某个参数的值
  246. -- @string k 参数名
  247. -- @return 参数值
  248. -- @usage
  249. -- 读取参数名为name的参数值:
  250. -- nameValue = nvm.get("name")
  251. function get(k)
  252. return para[k]
  253. end
  254. --- 读取某个table类型参数的键名对应的值
  255. -- @string k table类型的参数名
  256. -- @param kk table类型参数的键名
  257. -- @usage
  258. -- 有一个table参数为score,数据如下:
  259. -- score = {chinese=100, math=100, english=95}
  260. -- 读取score中chinese对应的值:
  261. -- nvm.gett("score","chinese")
  262. function gett(k, kk)
  263. return para[k][kk]
  264. end
  265. --- 参数恢复出厂设置
  266. -- @return nil
  267. -- @usage nvm.restore()
  268. function restore()
  269. os.remove(paraname)
  270. os.remove(paranamebak)
  271. local fpara, fconfig = io.open(paraname, "wb"), io.open(configname, "rb")
  272. if not fconfig then fconfig = io.open(cconfigname, "rb") end
  273. if not fconfig then fconfig = io.open(econfigname, "rb") end
  274. fpara:write(fconfig:read("*a"))
  275. fpara:close()
  276. fconfig:close()
  277. upd(true)
  278. end
  279. --- 请求删除参数文件.
  280. -- 此接口一般用在远程升级时,需要用新的config.lua覆盖原来的参数文件的场景,在此场景下,远程升级包下载成功后,在确定要重启前调用此接口
  281. -- 下次开机执行nvm.init("config.lua")时,会用新的config.lua文件自动覆盖参数文件;以后再开机就不会自动覆盖了
  282. -- 也就是说"nvm.remove()->重启->nvm.init("config.lua")"是一个仅执行一次的完整操作
  283. -- @return nil
  284. -- @usage nvm.remove()
  285. function remove()
  286. os.remove(paraname)
  287. os.remove(paranamebak)
  288. end