Merge pull request #278 from nmav/ocserv
[project/luci.git] / applications / luci-ddns / luasrc / model / cbi / ddns / detail.lua
1 --[[
2 LuCI - Lua Configuration Interface
3
4 A lot of code taken from original ddns.lua cbi-model made by
5 Copyright 2008 Steven Barth <steven@midlink.org>
6 Copyright 2008 Jo-Philipp Wich <xm@leipzig.freifunk.net>
7 Copyright 2013 Manuel Munz <freifunk at somakoma dot de>
8
9 modified to use as detail page together with new overview page and
10 extensions for IPv6, HTTPS settings, syslog and log settings,
11 optional Proxy-Support, optional DNS-Server, optional use of TCP requests to DNS server,
12 optional force of IP protocol version usage
13 Copyright 2014 Christian Schoenebeck <christian dot schoenebeck at gmail dot com>
14
15 Licensed under the Apache License, Version 2.0 (the "License");
16 you may not use this file except in compliance with the License.
17 You may obtain a copy of the License at
18
19 http://www.apache.org/licenses/LICENSE-2.0
20
21 $Id$
22 ]]--
23
24 local NX = require "nixio"
25 local FS = require "nixio.fs"
26 local SYS = require "luci.sys"
27 local UTIL = require "luci.util"
28 local DISP = require "luci.dispatcher"
29 local WADM = require "luci.tools.webadmin"
30 local DTYP = require "luci.cbi.datatypes"
31 local DDNS = require "luci.tools.ddns" -- ddns multiused functions
32
33 -- takeover arguments -- #######################################################
34 section = arg[1]
35
36 -- check supported options -- ##################################################
37 -- saved to local vars here because doing multiple os calls slow down the system
38 has_ipv6 = DDNS.check_ipv6() -- IPv6 support
39 has_ssl = DDNS.check_ssl() -- HTTPS support
40 has_proxy = DDNS.check_proxy() -- Proxy support
41 has_dnstcp = DDNS.check_bind_host() -- DNS TCP support
42 has_force = has_ssl and has_dnstcp -- Force IP Protocoll
43
44 -- html constants -- ###########################################################
45 font_red = "<font color='red'>"
46 font_off = "</font>"
47 bold_on = "<strong>"
48 bold_off = "</strong>"
49
50 -- error text constants -- #####################################################
51 err_ipv6_plain = translate("IPv6 not supported") .. " - " ..
52 translate("please select 'IPv4' address version")
53 err_ipv6_basic = bold_on ..
54 font_red ..
55 translate("IPv6 not supported") ..
56 font_off ..
57 "<br />" .. translate("please select 'IPv4' address version") ..
58 bold_off
59 err_ipv6_other = bold_on ..
60 font_red ..
61 translate("IPv6 not supported") ..
62 font_off ..
63 "<br />" .. translate("please select 'IPv4' address version in") .. " " ..
64 [[<a href="]] ..
65 DISP.build_url("admin", "services", "ddns", "detail", section) ..
66 "?tab.dns." .. section .. "=basic" ..
67 [[">]] ..
68 translate("Basic Settings") ..
69 [[</a>]] ..
70 bold_off
71
72 function err_tab_basic(self)
73 return translate("Basic Settings") .. " - " .. self.title .. ": "
74 end
75 function err_tab_adv(self)
76 return translate("Advanced Settings") .. " - " .. self.title .. ": "
77 end
78 function err_tab_timer(self)
79 return translate("Timer Settings") .. " - " .. self.title .. ": "
80 end
81
82 -- function to verify settings around ip_source
83 -- will use dynamic_dns_lucihelper to check if
84 -- local IP can be read
85 local function _verify_ip_source()
86 -- section is globally defined here be calling agrument (see above)
87 local _network = "-"
88 local _url = "-"
89 local _interface = "-"
90 local _script = "-"
91 local _proxy = ""
92
93 local _ipv6 = usev6:formvalue(section)
94 local _source = (_ipv6 == "1")
95 and src6:formvalue(section)
96 or src4:formvalue(section)
97 if _source == "network" then
98 _network = (_ipv6 == "1")
99 and ipn6:formvalue(section)
100 or ipn4:formvalue(section)
101 elseif _source == "web" then
102 _url = (_ipv6 == "1")
103 and iurl6:formvalue(section)
104 or iurl4:formvalue(section)
105 -- proxy only needed for checking url
106 _proxy = (pxy) and pxy:formvalue(section) or ""
107 elseif _source == "interface" then
108 _interface = ipi:formvalue(section)
109 elseif _source == "script" then
110 _script = ips:formvalue(section)
111 end
112
113 local command = [[/usr/lib/ddns/dynamic_dns_lucihelper.sh get_local_ip ]] ..
114 _ipv6 .. [[ ]] .. _source .. [[ ]] .. _network .. [[ ]] ..
115 _url .. [[ ]] .. _interface .. [[ ']] .. _script.. [[' ]] .. _proxy
116 local ret = SYS.call(command)
117
118 if ret == 0 then
119 return true -- valid
120 else
121 return nil -- invalid
122 end
123 end
124
125 -- cbi-map definition -- #######################################################
126 m = Map("ddns")
127
128 -- first need to close <a> from cbi map template our <a> closed by template
129 m.title = [[</a><a href="]] .. DISP.build_url("admin", "services", "ddns") .. [[">]] ..
130 translate("Dynamic DNS")
131
132 m.description = translate("Dynamic DNS allows that your router can be reached with " ..
133 "a fixed hostname while having a dynamically changing " ..
134 "IP address.")
135
136 m.redirect = DISP.build_url("admin", "services", "ddns")
137
138 m.on_after_commit = function(self)
139 if self.changed then -- changes ?
140 local pid = DDNS.get_pid(section)
141 if pid > 0 then -- running ?
142 local tmp = NX.kill(pid, 1) -- send SIGHUP
143 end
144 end
145 end
146
147 -- read application settings -- ################################################
148 -- date format; if not set use ISO format
149 date_format = m.uci:get(m.config, "global", "date_format") or "%F %R"
150 -- log directory
151 log_dir = m.uci:get(m.config, "global", "log_dir") or "/var/log/ddns"
152
153 -- cbi-section definition -- ###################################################
154 ns = m:section( NamedSection, section, "service",
155 translate("Details for") .. ([[: <strong>%s</strong>]] % section),
156 translate("Configure here the details for selected Dynamic DNS service") )
157 ns.instance = section -- arg [1]
158 ns:tab("basic", translate("Basic Settings"), nil )
159 ns:tab("advanced", translate("Advanced Settings"), nil )
160 ns:tab("timer", translate("Timer Settings"), nil )
161 ns:tab("logview", translate("Log File Viewer"), nil )
162
163 -- TAB: Basic #####################################################################################
164 -- enabled -- #################################################################
165 en = ns:taboption("basic", Flag, "enabled",
166 translate("Enabled"),
167 translate("If this service section is disabled it could not be started." .. "<br />" ..
168 "Neither from LuCI interface nor from console") )
169 en.orientation = "horizontal"
170 function en.parse(self, section)
171 DDNS.flag_parse(self, section)
172 end
173
174 -- use_ipv6 (NEW) -- ##########################################################
175 usev6 = ns:taboption("basic", ListValue, "use_ipv6",
176 translate("IP address version"),
177 translate("Defines which IP address 'IPv4/IPv6' is send to the DDNS provider") )
178 usev6.widget = "radio"
179 usev6.default = "0"
180 usev6:value("0", translate("IPv4-Address") )
181 function usev6.cfgvalue(self, section)
182 local value = AbstractValue.cfgvalue(self, section)
183 if has_ipv6 or (value == "1" and not has_ipv6) then
184 self:value("1", translate("IPv6-Address") )
185 end
186 if value == "1" and not has_ipv6 then
187 self.description = err_ipv6_basic
188 end
189 return value
190 end
191 function usev6.validate(self, value)
192 if (value == "1" and has_ipv6) or value == "0" then
193 return value
194 end
195 return nil, err_tab_basic(self) .. err_ipv6_plain
196 end
197 function usev6.write(self, section, value)
198 if value == "0" then -- force rmempty
199 return self.map:del(section, self.option)
200 else
201 return self.map:set(section, self.option, value)
202 end
203 end
204
205 -- IPv4 - service_name -- ######################################################
206 svc4 = ns:taboption("basic", ListValue, "ipv4_service_name",
207 translate("DDNS Service provider") .. " [IPv4]" )
208 svc4.default = "-"
209 svc4:depends("use_ipv6", "0") -- only show on IPv4
210
211 local services4 = { }
212 local fd4 = io.open("/usr/lib/ddns/services", "r")
213
214 if fd4 then
215 local ln
216 repeat
217 ln = fd4:read("*l")
218 local s = ln and ln:match('^%s*"([^"]+)"')
219 if s then services4[#services4+1] = s end
220 until not ln
221 fd4:close()
222 end
223
224 for _, v in UTIL.vspairs(services4) do svc4:value(v) end
225 svc4:value("-", translate("-- custom --") )
226
227 function svc4.cfgvalue(self, section)
228 local v = DDNS.read_value(self, section, "service_name")
229 if not v or #v == 0 then
230 return "-"
231 else
232 return v
233 end
234 end
235 function svc4.validate(self, value)
236 if usev6:formvalue(section) == "0" then -- do only on IPv4
237 return value
238 else
239 return "" -- supress validate error
240 end
241 end
242 function svc4.write(self, section, value)
243 if usev6:formvalue(section) == "0" then -- do only IPv4 here
244 self.map:del(section, self.option) -- to be shure
245 if value ~= "-" then -- and write "service_name
246 self.map:del(section, "update_url") -- delete update_url
247 return self.map:set(section, "service_name", value)
248 else
249 return self.map:del(section, "service_name")
250 end
251 end
252 end
253
254 -- IPv6 - service_name -- ######################################################
255 svc6 = ns:taboption("basic", ListValue, "ipv6_service_name",
256 translate("DDNS Service provider") .. " [IPv6]" )
257 svc6.default = "-"
258 svc6:depends("use_ipv6", "1") -- only show on IPv6
259 if not has_ipv6 then
260 svc6.description = err_ipv6_basic
261 end
262
263 local services6 = { }
264 local fd6 = io.open("/usr/lib/ddns/services_ipv6", "r")
265
266 if fd6 then
267 local ln
268 repeat
269 ln = fd6:read("*l")
270 local s = ln and ln:match('^%s*"([^"]+)"')
271 if s then services6[#services6+1] = s end
272 until not ln
273 fd6:close()
274 end
275
276 for _, v in UTIL.vspairs(services6) do svc6:value(v) end
277 svc6:value("-", translate("-- custom --") )
278
279 function svc6.cfgvalue(self, section)
280 local v = DDNS.read_value(self, section, "service_name")
281 if not v or #v == 0 then
282 return "-"
283 else
284 return v
285 end
286 end
287 function svc6.validate(self, value)
288 if usev6:formvalue(section) == "1" then -- do only on IPv6
289 if has_ipv6 then return value end
290 return nil, err_tab_basic(self) .. err_ipv6_plain
291 else
292 return "" -- supress validate error
293 end
294 end
295 function svc6.write(self, section, value)
296 if usev6:formvalue(section) == "1" then -- do only when IPv6
297 self.map:del(section, self.option) -- delete "ipv6_service_name" helper
298 if value ~= "-" then -- and write "service_name
299 self.map:del(section, "update_url") -- delete update_url
300 return self.map:set(section, "service_name", value)
301 else
302 return self.map:del(section, "service_name")
303 end
304 end
305 end
306
307 -- IPv4/IPv6 - update_url -- ###################################################
308 uurl = ns:taboption("basic", Value, "update_url",
309 translate("Custom update-URL"),
310 translate("Update URL to be used for updating your DDNS Provider." .. "<br />" ..
311 "Follow instructions you will find on their WEB page.") )
312 uurl:depends("ipv4_service_name", "-")
313 uurl:depends("ipv6_service_name", "-")
314 function uurl.validate(self, value)
315 local script = ush:formvalue(section)
316
317 if (usev6:formvalue(section) == "0" and svc4:formvalue(section) ~= "-") or
318 (usev6:formvalue(section) == "1" and svc6:formvalue(section) ~= "-") then
319 return "" -- suppress validate error
320 elseif not value then
321 if not script or not (#script > 0) then
322 return nil, err_tab_basic(self) .. translate("missing / required")
323 else
324 return "" -- suppress validate error / update_script is given
325 end
326 elseif (#script > 0) then
327 return nil, err_tab_basic(self) .. translate("either url or script could be set")
328 end
329
330 local url = DDNS.parse_url(value)
331 if not url.scheme == "http" then
332 return nil, err_tab_basic(self) .. translate("must start with 'http://'")
333 elseif not url.query then
334 return nil, err_tab_basic(self) .. "<QUERY> " .. translate("missing / required")
335 elseif not url.host then
336 return nil, err_tab_basic(self) .. "<HOST> " .. translate("missing / required")
337 elseif SYS.call([[nslookup ]] .. url.host .. [[ >/dev/null 2>&1]]) ~= 0 then
338 return nil, err_tab_basic(self) .. translate("can not resolve host: ") .. url.host
339 end
340
341 return value
342 end
343
344 -- IPv4/IPv6 - update_script -- ################################################
345 ush = ns:taboption("basic", Value, "update_script",
346 translate("Custom update-script"),
347 translate("Custom update script to be used for updating your DDNS Provider.") )
348 ush:depends("ipv4_service_name", "-")
349 ush:depends("ipv6_service_name", "-")
350 function ush.validate(self, value)
351 local url = uurl:formvalue(section)
352
353 if (usev6:formvalue(section) == "0" and svc4:formvalue(section) ~= "-") or
354 (usev6:formvalue(section) == "1" and svc6:formvalue(section) ~= "-") then
355 return "" -- suppress validate error
356 elseif not value then
357 if not url or not (#url > 0) then
358 return nil, err_tab_basic(self) .. translate("missing / required")
359 else
360 return "" -- suppress validate error / update_url is given
361 end
362 elseif (#url > 0) then
363 return nil, err_tab_basic(self) .. translate("either url or script could be set")
364 elseif not FS.access(value) then
365 return nil, err_tab_basic(self) .. translate("File not found")
366 end
367 return value
368 end
369
370 -- IPv4/IPv6 - domain -- #######################################################
371 dom = ns:taboption("basic", Value, "domain",
372 translate("Hostname/Domain"),
373 translate("Replaces [DOMAIN] in Update-URL") )
374 dom.rmempty = false
375 dom.placeholder = "mypersonaldomain.dyndns.org"
376 function dom.validate(self, value)
377 if not value
378 or not (#value > 0)
379 or not DTYP.hostname(value) then
380 return nil, err_tab_basic(self) .. translate("invalid - Sample") .. ": 'mypersonaldomain.dyndns.org'"
381 else
382 return value
383 end
384 end
385
386 -- IPv4/IPv6 - username -- #####################################################
387 user = ns:taboption("basic", Value, "username",
388 translate("Username"),
389 translate("Replaces [USERNAME] in Update-URL") )
390 user.rmempty = false
391 function user.validate(self, value)
392 if not value then
393 return nil, err_tab_basic(self) .. translate("missing / required")
394 end
395 return value
396 end
397
398 -- IPv4/IPv6 - password -- #####################################################
399 pw = ns:taboption("basic", Value, "password",
400 translate("Password"),
401 translate("Replaces [PASSWORD] in Update-URL") )
402 pw.rmempty = false
403 pw.password = true
404 function pw.validate(self, value)
405 if not value then
406 return nil, err_tab_basic(self) .. translate("missing / required")
407 end
408 return value
409 end
410
411 -- IPv4/IPv6 - use_https (NEW) -- ##############################################
412 if has_ssl or ( ( m:get(section, "use_https") or "0" ) == "1" ) then
413 https = ns:taboption("basic", Flag, "use_https",
414 translate("Use HTTP Secure") )
415 https.orientation = "horizontal"
416 https.rmempty = false -- force validate function
417 function https.cfgvalue(self, section)
418 local value = AbstractValue.cfgvalue(self, section)
419 if not has_ssl and value == "1" then
420 self.description = bold_on .. font_red ..
421 translate("HTTPS not supported") .. font_off .. "<br />" ..
422 translate("please disable") .. " !" .. bold_off
423 else
424 self.description = translate("Enable secure communication with DDNS provider")
425 end
426 return value
427 end
428 function https.parse(self, section)
429 DDNS.flag_parse(self, section)
430 end
431 function https.validate(self, value)
432 if (value == "1" and has_ssl ) or value == "0" then return value end
433 return nil, err_tab_basic(self) .. translate("HTTPS not supported") .. " !"
434 end
435 function https.write(self, section, value)
436 if value == "1" then
437 return self.map:set(section, self.option, value)
438 else
439 self.map:del(section, "cacert")
440 return self.map:del(section, self.option)
441 end
442 end
443 end
444
445 -- IPv4/IPv6 - cacert (NEW) -- #################################################
446 if has_ssl then
447 cert = ns:taboption("basic", Value, "cacert",
448 translate("Path to CA-Certificate"),
449 translate("directory or path/file") .. "<br />" ..
450 translate("or") .. bold_on .. " IGNORE " .. bold_off ..
451 translate("to run HTTPS without verification of server certificates (insecure)") )
452 cert:depends("use_https", "1")
453 cert.rmempty = false -- force validate function
454 cert.default = "/etc/ssl/certs"
455 function cert.validate(self, value)
456 if https:formvalue(section) == "0" then
457 return "" -- supress validate error if NOT https
458 end
459 if value then -- otherwise errors in datatype check
460 if DTYP.directory(value)
461 or DTYP.file(value)
462 or value == "IGNORE" then
463 return value
464 end
465 end
466 return nil, err_tab_basic(self) ..
467 translate("file or directory not found or not 'IGNORE'") .. " !"
468 end
469 end
470
471 -- TAB: Advanced ##################################################################################
472 -- IPv4 - ip_source -- #########################################################
473 src4 = ns:taboption("advanced", ListValue, "ipv4_source",
474 translate("IP address source") .. " [IPv4]",
475 translate("Defines the source to read systems IPv4-Address from, that will be send to the DDNS provider") )
476 src4:depends("use_ipv6", "0") -- IPv4 selected
477 src4.default = "network"
478 src4:value("network", translate("Network"))
479 src4:value("web", translate("URL"))
480 src4:value("interface", translate("Interface"))
481 src4:value("script", translate("Script"))
482 function src4.cfgvalue(self, section)
483 return DDNS.read_value(self, section, "ip_source")
484 end
485 function src4.validate(self, value)
486 if usev6:formvalue(section) == "1" then
487 return "" -- ignore on IPv6 selected
488 elseif not _verify_ip_source() then
489 return nil, err_tab_adv(self) ..
490 translate("can not detect local IP. Please select a different Source combination")
491 else
492 return value
493 end
494 end
495 function src4.write(self, section, value)
496 if usev6:formvalue(section) == "1" then
497 return true -- ignore on IPv6 selected
498 elseif value == "network" then
499 self.map:del(section, "ip_url") -- delete not need parameters
500 self.map:del(section, "ip_interface")
501 self.map:del(section, "ip_script")
502 elseif value == "web" then
503 self.map:del(section, "ip_network") -- delete not need parameters
504 self.map:del(section, "ip_interface")
505 self.map:del(section, "ip_script")
506 elseif value == "interface" then
507 self.map:del(section, "ip_network") -- delete not need parameters
508 self.map:del(section, "ip_url")
509 self.map:del(section, "ip_script")
510 elseif value == "script" then
511 self.map:del(section, "ip_network")
512 self.map:del(section, "ip_url") -- delete not need parameters
513 self.map:del(section, "ip_interface")
514 end
515 self.map:del(section, self.option) -- delete "ipv4_source" helper
516 return self.map:set(section, "ip_source", value) -- and write "ip_source
517 end
518
519 -- IPv6 - ip_source -- #########################################################
520 src6 = ns:taboption("advanced", ListValue, "ipv6_source",
521 translate("IP address source") .. " [IPv6]",
522 translate("Defines the source to read systems IPv6-Address from, that will be send to the DDNS provider") )
523 src6:depends("use_ipv6", 1) -- IPv6 selected
524 src6.default = "network"
525 src6:value("network", translate("Network"))
526 src6:value("web", translate("URL"))
527 src6:value("interface", translate("Interface"))
528 src6:value("script", translate("Script"))
529 if not has_ipv6 then
530 src6.description = err_ipv6_other
531 end
532 function src6.cfgvalue(self, section)
533 return DDNS.read_value(self, section, "ip_source")
534 end
535 function src6.validate(self, value)
536 if usev6:formvalue(section) == "0" then
537 return "" -- ignore on IPv4 selected
538 elseif not has_ipv6 then
539 return nil, err_tab_adv(self) .. err_ipv6_plain
540 elseif not _verify_ip_source() then
541 return nil, err_tab_adv(self) ..
542 translate("can not detect local IP. Please select a different Source combination")
543 else
544 return value
545 end
546 end
547 function src6.write(self, section, value)
548 if usev6:formvalue(section) == "0" then
549 return true -- ignore on IPv4 selected
550 elseif value == "network" then
551 self.map:del(section, "ip_url") -- delete not need parameters
552 self.map:del(section, "ip_interface")
553 self.map:del(section, "ip_script")
554 elseif value == "web" then
555 self.map:del(section, "ip_network") -- delete not need parameters
556 self.map:del(section, "ip_interface")
557 self.map:del(section, "ip_script")
558 elseif value == "interface" then
559 self.map:del(section, "ip_network") -- delete not need parameters
560 self.map:del(section, "ip_url")
561 self.map:del(section, "ip_script")
562 elseif value == "script" then
563 self.map:del(section, "ip_network")
564 self.map:del(section, "ip_url") -- delete not need parameters
565 self.map:del(section, "ip_interface")
566 end
567 self.map:del(section, self.option) -- delete "ipv4_source" helper
568 return self.map:set(section, "ip_source", value) -- and write "ip_source
569 end
570
571 -- IPv4 - ip_network (default "wan") -- ########################################
572 ipn4 = ns:taboption("advanced", ListValue, "ipv4_network",
573 translate("Network") .. " [IPv4]",
574 translate("Defines the network to read systems IPv4-Address from") )
575 ipn4:depends("ipv4_source", "network")
576 ipn4.default = "wan"
577 WADM.cbi_add_networks(ipn4)
578 function ipn4.cfgvalue(self, section)
579 return DDNS.read_value(self, section, "ip_network")
580 end
581 function ipn4.validate(self, value)
582 if usev6:formvalue(section) == "1"
583 or src4:formvalue(section) ~= "network" then
584 -- ignore if IPv6 selected OR
585 -- ignore everything except "network"
586 return ""
587 else
588 return value
589 end
590 end
591 function ipn4.write(self, section, value)
592 if usev6:formvalue(section) == "1"
593 or src4:formvalue(section) ~= "network" then
594 -- ignore if IPv6 selected OR
595 -- ignore everything except "network"
596 return true
597 else
598 -- set also as "interface" for monitoring events changes/hot-plug
599 self.map:set(section, "interface", value)
600 self.map:del(section, self.option) -- delete "ipv4_network" helper
601 return self.map:set(section, "ip_network", value) -- and write "ip_network"
602 end
603 end
604
605 -- IPv6 - ip_network (default "wan6") -- #######################################
606 ipn6 = ns:taboption("advanced", ListValue, "ipv6_network",
607 translate("Network") .. " [IPv6]" )
608 ipn6:depends("ipv6_source", "network")
609 ipn6.default = "wan6"
610 WADM.cbi_add_networks(ipn6)
611 if has_ipv6 then
612 ipn6.description = translate("Defines the network to read systems IPv6-Address from")
613 else
614 ipn6.description = err_ipv6_other
615 end
616 function ipn6.cfgvalue(self, section)
617 return DDNS.read_value(self, section, "ip_network")
618 end
619 function ipn6.validate(self, value)
620 if usev6:formvalue(section) == "0"
621 or src6:formvalue(section) ~= "network" then
622 -- ignore if IPv4 selected OR
623 -- ignore everything except "network"
624 return ""
625 elseif has_ipv6 then
626 return value
627 else
628 return nil, err_tab_adv(self) .. err_ipv6_plain
629 end
630 end
631 function ipn6.write(self, section, value)
632 if usev6:formvalue(section) == "0"
633 or src6:formvalue(section) ~= "network" then
634 -- ignore if IPv4 selected OR
635 -- ignore everything except "network"
636 return true
637 else
638 -- set also as "interface" for monitoring events changes/hotplug
639 self.map:set(section, "interface", value)
640 self.map:del(section, self.option) -- delete "ipv6_network" helper
641 return self.map:set(section, "ip_network", value) -- and write "ip_network"
642 end
643 end
644
645 -- IPv4 - ip_url (default "checkip.dyndns.com") -- #############################
646 iurl4 = ns:taboption("advanced", Value, "ipv4_url",
647 translate("URL to detect") .. " [IPv4]",
648 translate("Defines the Web page to read systems IPv4-Address from") )
649 iurl4:depends("ipv4_source", "web")
650 iurl4.default = "http://checkip.dyndns.com"
651 function iurl4.cfgvalue(self, section)
652 return DDNS.read_value(self, section, "ip_url")
653 end
654 function iurl4.validate(self, value)
655 if usev6:formvalue(section) == "1"
656 or src4:formvalue(section) ~= "web" then
657 -- ignore if IPv6 selected OR
658 -- ignore everything except "web"
659 return ""
660 elseif not value or #value == 0 then
661 return nil, err_tab_adv(self) .. translate("missing / required")
662 end
663
664 local url = DDNS.parse_url(value)
665 if not (url.scheme == "http" or url.scheme == "https") then
666 return nil, err_tab_adv(self) .. translate("must start with 'http://'")
667 elseif not url.host then
668 return nil, err_tab_adv(self) .. "<HOST> " .. translate("missing / required")
669 elseif SYS.call([[nslookup ]] .. url.host .. [[>/dev/null 2>&1]]) ~= 0 then
670 return nil, err_tab_adv(self) .. translate("can not resolve host: ") .. url.host
671 else
672 return value
673 end
674 end
675 function iurl4.write(self, section, value)
676 if usev6:formvalue(section) == "1"
677 or src4:formvalue(section) ~= "web" then
678 -- ignore if IPv6 selected OR
679 -- ignore everything except "web"
680 return true
681 else
682 self.map:del(section, self.option) -- delete "ipv4_url" helper
683 return self.map:set(section, "ip_url", value) -- and write "ip_url"
684 end
685 end
686
687 -- IPv6 - ip_url (default "checkipv6.dyndns.com") -- ###########################
688 iurl6 = ns:taboption("advanced", Value, "ipv6_url",
689 translate("URL to detect") .. " [IPv6]" )
690 iurl6:depends("ipv6_source", "web")
691 iurl6.default = "http://checkipv6.dyndns.com"
692 if has_ipv6 then
693 iurl6.description = translate("Defines the Web page to read systems IPv6-Address from")
694 else
695 iurl6.description = err_ipv6_other
696 end
697 function iurl6.cfgvalue(self, section)
698 return DDNS.read_value(self, section, "ip_url")
699 end
700 function iurl6.validate(self, value)
701 if usev6:formvalue(section) == "0"
702 or src6:formvalue(section) ~= "web" then
703 -- ignore if IPv4 selected OR
704 -- ignore everything except "web"
705 return ""
706 elseif not has_ipv6 then
707 return nil, err_tab_adv(self) .. err_ipv6_plain
708 elseif not value or #value == 0 then
709 return nil, err_tab_adv(self) .. translate("missing / required")
710 end
711
712 local url = DDNS.parse_url(value)
713 if not (url.scheme == "http" or url.scheme == "https") then
714 return nil, err_tab_adv(self) .. translate("must start with 'http://'")
715 elseif not url.host then
716 return nil, err_tab_adv(self) .. "<HOST> " .. translate("missing / required")
717 elseif SYS.call([[nslookup ]] .. url.host .. [[>/dev/null 2>&1]]) ~= 0 then
718 return nil, err_tab_adv(self) .. translate("can not resolve host: ") .. url.host
719 else
720 return value
721 end
722 end
723 function iurl6.write(self, section, value)
724 if usev6:formvalue(section) == "0"
725 or src6:formvalue(section) ~= "web" then
726 -- ignore if IPv4 selected OR
727 -- ignore everything except "web"
728 return true
729 else
730 self.map:del(section, self.option) -- delete "ipv6_url" helper
731 return self.map:set(section, "ip_url", value) -- and write "ip_url"
732 end
733 end
734
735 -- IPv4 + IPv6 - ip_interface -- ###############################################
736 ipi = ns:taboption("advanced", ListValue, "ip_interface",
737 translate("Interface"),
738 translate("Defines the interface to read systems IP-Address from") )
739 ipi:depends("ipv4_source", "interface") -- IPv4
740 ipi:depends("ipv6_source", "interface") -- or IPv6
741 for _, v in pairs(SYS.net.devices()) do
742 -- show only interface set to a network
743 -- and ignore loopback
744 net = WADM.iface_get_network(v)
745 if net and net ~= "loopback" then
746 ipi:value(v)
747 end
748 end
749 function ipi.validate(self, value)
750 if (usev6:formvalue(section) == "0" and src4:formvalue(section) ~= "interface")
751 or (usev6:formvalue(section) == "1" and src6:formvalue(section) ~= "interface") then
752 return ""
753 else
754 return value
755 end
756 end
757 function ipi.write(self, section, value)
758 if (usev6:formvalue(section) == "0" and src4:formvalue(section) ~= "interface")
759 or (usev6:formvalue(section) == "1" and src6:formvalue(section) ~= "interface") then
760 return true
761 else
762 -- get network from device to
763 -- set also as "interface" for monitoring events changes/hotplug
764 local net = WADM.iface_get_network(value)
765 self.map:set(section, "interface", net)
766 return self.map:set(section, self.option, value)
767 end
768 end
769
770 -- IPv4 + IPv6 - ip_script (NEW) -- ############################################
771 ips = ns:taboption("advanced", Value, "ip_script",
772 translate("Script"),
773 translate("User defined script to read systems IP-Address") )
774 ips:depends("ipv4_source", "script") -- IPv4
775 ips:depends("ipv6_source", "script") -- or IPv6
776 ips.rmempty = false
777 ips.placeholder = "/path/to/script.sh"
778 function ips.validate(self, value)
779 local split
780 if value then split = UTIL.split(value, " ") end
781
782 if (usev6:formvalue(section) == "0" and src4:formvalue(section) ~= "script")
783 or (usev6:formvalue(section) == "1" and src6:formvalue(section) ~= "script") then
784 return ""
785 elseif not value or not (#value > 0) or not FS.access(split[1], "x") then
786 return nil, err_tab_adv(self) ..
787 translate("not found or not executable - Sample: '/path/to/script.sh'")
788 else
789 return value
790 end
791 end
792 function ips.write(self, section, value)
793 if (usev6:formvalue(section) == "0" and src4:formvalue(section) ~= "script")
794 or (usev6:formvalue(section) == "1" and src6:formvalue(section) ~= "script") then
795 return true
796 else
797 return self.map:set(section, self.option, value)
798 end
799 end
800
801 -- IPv4 - interface - default "wan" -- #########################################
802 -- event network to monitor changes/hotplug/dynamic_dns_updater.sh
803 -- only needs to be set if "ip_source"="web" or "script"
804 -- if "ip_source"="network" or "interface" we use their network
805 eif4 = ns:taboption("advanced", ListValue, "ipv4_interface",
806 translate("Event Network") .. " [IPv4]",
807 translate("Network on which the ddns-updater scripts will be started") )
808 eif4:depends("ipv4_source", "web")
809 eif4:depends("ipv4_source", "script")
810 eif4.default = "wan"
811 WADM.cbi_add_networks(eif4)
812 function eif4.cfgvalue(self, section)
813 return DDNS.read_value(self, section, "interface")
814 end
815 function eif4.validate(self, value)
816 if usev6:formvalue(section) == "1"
817 or src4:formvalue(section) == "network"
818 or src4:formvalue(section) == "interface" then
819 return "" -- ignore IPv6, network, interface
820 else
821 return value
822 end
823 end
824 function eif4.write(self, section, value)
825 if usev6:formvalue(section) == "1"
826 or src4:formvalue(section) == "network"
827 or src4:formvalue(section) == "interface" then
828 return true -- ignore IPv6, network, interface
829 else
830 self.map:del(section, self.option) -- delete "ipv4_interface" helper
831 return self.map:set(section, "interface", value) -- and write "interface"
832 end
833 end
834
835 -- IPv6 - interface (NEW) - default "wan6" -- ##################################
836 -- event network to monitor changes/hotplug (NEW)
837 -- only needs to be set if "ip_source"="web" or "script"
838 -- if "ip_source"="network" or "interface" we use their network
839 eif6 = ns:taboption("advanced", ListValue, "ipv6_interface",
840 translate("Event Network") .. " [IPv6]" )
841 eif6:depends("ipv6_source", "web")
842 eif6:depends("ipv6_source", "script")
843 eif6.default = "wan6"
844 WADM.cbi_add_networks(eif6)
845 if not has_ipv6 then
846 eif6.description = err_ipv6_other
847 else
848 eif6.description = translate("Network on which the ddns-updater scripts will be started")
849 end
850 function eif6.cfgvalue(self, section)
851 return DDNS.read_value(self, section, "interface")
852 end
853 function eif6.validate(self, value)
854 if usev6:formvalue(section) == "0"
855 or src4:formvalue(section) == "network"
856 or src4:formvalue(section) == "interface" then
857 return "" -- ignore IPv4, network, interface
858 elseif not has_ipv6 then
859 return nil, err_tab_adv(self) .. err_ipv6_plain
860 else
861 return value
862 end
863 end
864 function eif6.write(self, section, value)
865 if usev6:formvalue(section) == "0"
866 or src4:formvalue(section) == "network"
867 or src4:formvalue(section) == "interface" then
868 return true -- ignore IPv4, network, interface
869 else
870 self.map:del(section, self.option) -- delete "ipv6_interface" helper
871 return self.map:set(section, "interface", value) -- and write "interface"
872 end
873 end
874
875 -- IPv4 + IPv6 - force_ipversion (NEW) -- ######################################
876 -- optional to force wget/curl and host to use only selected IP version
877 -- command parameter "-4" or "-6"
878 if has_force or ( ( m:get(section, "force_ipversion") or "0" ) ~= "0" ) then
879 fipv = ns:taboption("advanced", Flag, "force_ipversion",
880 translate("Force IP Version") )
881 fipv.orientation = "horizontal"
882 function fipv.cfgvalue(self, section)
883 local value = AbstractValue.cfgvalue(self, section)
884 if not has_force and value ~= "0" then
885 self.description = bold_on .. font_red ..
886 translate("Force IP Version not supported") .. font_off .. "<br />" ..
887 translate("please disable") .. " !" .. bold_off
888 else
889 self.description = translate("OPTIONAL: Force the usage of pure IPv4/IPv6 only communication.")
890 end
891 return value
892 end
893 function fipv.validate(self, value)
894 if (value == "1" and has_force) or value == "0" then return value end
895 return nil, err_tab_adv(self) .. translate("Force IP Version not supported")
896 end
897 function fipv.parse(self, section)
898 DDNS.flag_parse(self, section)
899 end
900 function fipv.write(self, section, value)
901 if value == "1" then
902 return self.map:set(section, self.option, value)
903 else
904 return self.map:del(section, self.option)
905 end
906 end
907 end
908
909 -- IPv4 + IPv6 - dns_server (NEW) -- ###########################################
910 -- optional DNS Server to use resolving my IP if "ip_source"="web"
911 dns = ns:taboption("advanced", Value, "dns_server",
912 translate("DNS-Server"),
913 translate("OPTIONAL: Use non-default DNS-Server to detect 'Registered IP'.") .. "<br />" ..
914 translate("Format: IP or FQDN"))
915 dns.placeholder = "mydns.lan"
916 function dns.validate(self, value)
917 -- if .datatype is set, then it is checked before calling this function
918 if not value then
919 return "" -- ignore on empty
920 elseif not DTYP.host(value) then
921 return nil, err_tab_adv(self) .. translate("use hostname, FQDN, IPv4- or IPv6-Address")
922 else
923 local ipv6 = usev6:formvalue(section)
924 local force = (fipv) and fipv:formvalue(section) or "0"
925 local command = [[/usr/lib/ddns/dynamic_dns_lucihelper.sh verify_dns ]] ..
926 value .. [[ ]] .. ipv6 .. [[ ]] .. force
927 local ret = SYS.call(command)
928 if ret == 0 then return value -- everything OK
929 elseif ret == 2 then return nil, err_tab_adv(self) .. translate("nslookup can not resolve host")
930 elseif ret == 3 then return nil, err_tab_adv(self) .. translate("nc (netcat) can not connect")
931 elseif ret == 4 then return nil, err_tab_adv(self) .. translate("Forced IP Version don't matched")
932 else return nil, err_tab_adv(self) .. translate("unspecific error")
933 end
934 end
935 end
936
937 -- IPv4 + IPv6 - force_dnstcp (NEW) -- #########################################
938 if has_dnstcp or ( ( m:get(section, "force_dnstcp") or "0" ) ~= "0" ) then
939 tcp = ns:taboption("advanced", Flag, "force_dnstcp",
940 translate("Force TCP on DNS") )
941 tcp.orientation = "horizontal"
942 function tcp.cfgvalue(self, section)
943 local value = AbstractValue.cfgvalue(self, section)
944 if not has_dnstcp and value ~= "0" then
945 self.description = bold_on .. font_red ..
946 translate("DNS requests via TCP not supported") .. font_off .. "<br />" ..
947 translate("please disable") .. " !" .. bold_off
948 else
949 self.description = translate("OPTIONAL: Force the use of TCP instead of default UDP on DNS requests.")
950 end
951 return value
952 end
953 function tcp.validate(self, value)
954 if (value == "1" and has_dnstcp ) or value == "0" then
955 return value
956 end
957 return nil, err_tab_adv(self) .. translate("DNS requests via TCP not supported")
958 end
959 function tcp.parse(self, section)
960 DDNS.flag_parse(self, section)
961 end
962 end
963
964 -- IPv4 + IPv6 - proxy (NEW) -- ################################################
965 -- optional Proxy to use for http/https requests [user:password@]proxyhost[:port]
966 if has_proxy or ( ( m:get(section, "proxy") or "" ) ~= "" ) then
967 pxy = ns:taboption("advanced", Value, "proxy",
968 translate("PROXY-Server") )
969 pxy.placeholder="user:password@myproxy.lan:8080"
970 function pxy.cfgvalue(self, section)
971 local value = AbstractValue.cfgvalue(self, section)
972 if not has_proxy and value ~= "" then
973 self.description = bold_on .. font_red ..
974 translate("PROXY-Server not supported") .. font_off .. "<br />" ..
975 translate("please remove entry") .. "!" .. bold_off
976 else
977 self.description = translate("OPTIONAL: Proxy-Server for detection and updates.") .. "<br />" ..
978 translate("Format") .. ": " .. bold_on .. "[user:password@]proxyhost:port" .. bold_off .. "<br />" ..
979 translate("IPv6 address must be given in square brackets") .. ": " ..
980 bold_on .. " [2001:db8::1]:8080" .. bold_off
981 end
982 return value
983 end
984 function pxy.validate(self, value)
985 -- if .datatype is set, then it is checked before calling this function
986 if not value then
987 return "" -- ignore on empty
988 elseif has_proxy then
989 local ipv6 = usev6:formvalue(section) or "0"
990 local force = (fipv) and fipv:formvalue(section) or "0"
991 local command = [[/usr/lib/ddns/dynamic_dns_lucihelper.sh verify_proxy ]] ..
992 value .. [[ ]] .. ipv6 .. [[ ]] .. force
993 local ret = SYS.call(command)
994 if ret == 0 then return value
995 elseif ret == 2 then return nil, err_tab_adv(self) .. translate("nslookup can not resolve host")
996 elseif ret == 3 then return nil, err_tab_adv(self) .. translate("nc (netcat) can not connect")
997 elseif ret == 4 then return nil, err_tab_adv(self) .. translate("Forced IP Version don't matched")
998 elseif ret == 5 then return nil, err_tab_adv(self) .. translate("proxy port missing")
999 else return nil, err_tab_adv(self) .. translate("unspecific error")
1000 end
1001 else
1002 return nil, err_tab_adv(self) .. translate("PROXY-Server not supported")
1003 end
1004 end
1005 end
1006
1007 -- use_syslog -- ###############################################################
1008 slog = ns:taboption("advanced", ListValue, "use_syslog",
1009 translate("Log to syslog"),
1010 translate("Writes log messages to syslog. Critical Errors will always be written to syslog.") )
1011 slog.default = "2"
1012 slog:value("0", translate("No logging"))
1013 slog:value("1", translate("Info"))
1014 slog:value("2", translate("Notice"))
1015 slog:value("3", translate("Warning"))
1016 slog:value("4", translate("Error"))
1017
1018 -- use_logfile (NEW) -- ########################################################
1019 logf = ns:taboption("advanced", Flag, "use_logfile",
1020 translate("Log to file"),
1021 translate("Writes detailed messages to log file. File will be truncated automatically.") .. "<br />" ..
1022 translate("File") .. [[: "]] .. log_dir .. [[/]] .. section .. [[.log"]] )
1023 logf.orientation = "horizontal"
1024 logf.rmempty = false -- we want to save in /etc/config/ddns file on "0" because
1025 logf.default = "1" -- if not defined write to log by default
1026 function logf.parse(self, section)
1027 DDNS.flag_parse(self, section)
1028 end
1029
1030 -- TAB: Timer #####################################################################################
1031 -- check_interval -- ###########################################################
1032 ci = ns:taboption("timer", Value, "check_interval",
1033 translate("Check Interval") )
1034 ci.template = "ddns/detail_value"
1035 ci.default = 10
1036 ci.rmempty = false -- validate ourselves for translatable error messages
1037 function ci.validate(self, value)
1038 if not DTYP.uinteger(value)
1039 or tonumber(value) < 1 then
1040 return nil, err_tab_timer(self) .. translate("minimum value 5 minutes == 300 seconds")
1041 end
1042
1043 local secs = DDNS.calc_seconds(value, cu:formvalue(section))
1044 if secs >= 300 then
1045 return value
1046 else
1047 return nil, err_tab_timer(self) .. translate("minimum value 5 minutes == 300 seconds")
1048 end
1049 end
1050 function ci.write(self, section, value)
1051 -- simulate rmempty=true remove default
1052 local secs = DDNS.calc_seconds(value, cu:formvalue(section))
1053 if secs ~= 600 then --default 10 minutes
1054 return self.map:set(section, self.option, value)
1055 else
1056 self.map:del(section, "check_unit")
1057 return self.map:del(section, self.option)
1058 end
1059 end
1060
1061 -- check_unit -- ###############################################################
1062 cu = ns:taboption("timer", ListValue, "check_unit", "not displayed, but needed otherwise error",
1063 translate("Interval to check for changed IP" .. "<br />" ..
1064 "Values below 5 minutes == 300 seconds are not supported") )
1065 cu.template = "ddns/detail_lvalue"
1066 cu.default = "minutes"
1067 cu.rmempty = false -- want to control write process
1068 cu:value("seconds", translate("seconds"))
1069 cu:value("minutes", translate("minutes"))
1070 cu:value("hours", translate("hours"))
1071 --cu:value("days", translate("days"))
1072 function cu.write(self, section, value)
1073 -- simulate rmempty=true remove default
1074 local secs = DDNS.calc_seconds(ci:formvalue(section), value)
1075 if secs ~= 600 then --default 10 minutes
1076 return self.map:set(section, self.option, value)
1077 else
1078 return true
1079 end
1080 end
1081
1082 -- force_interval (modified) -- ################################################
1083 fi = ns:taboption("timer", Value, "force_interval",
1084 translate("Force Interval") )
1085 fi.template = "ddns/detail_value"
1086 fi.default = 72 -- see dynamic_dns_updater.sh script
1087 fi.rmempty = false -- validate ourselves for translatable error messages
1088 function fi.validate(self, value)
1089 if not DTYP.uinteger(value)
1090 or tonumber(value) < 0 then
1091 return nil, err_tab_timer(self) .. translate("minimum value '0'")
1092 end
1093
1094 local force_s = DDNS.calc_seconds(value, fu:formvalue(section))
1095 if force_s == 0 then
1096 return value
1097 end
1098
1099 local ci_value = ci:formvalue(section)
1100 if not DTYP.uinteger(ci_value) then
1101 return "" -- ignore because error in check_interval above
1102 end
1103
1104 local check_s = DDNS.calc_seconds(ci_value, cu:formvalue(section))
1105 if force_s >= check_s then
1106 return value
1107 end
1108
1109 return nil, err_tab_timer(self) .. translate("must be greater or equal 'Check Interval'")
1110 end
1111 function fi.write(self, section, value)
1112 -- simulate rmempty=true remove default
1113 local secs = DDNS.calc_seconds(value, fu:formvalue(section))
1114 if secs ~= 259200 then --default 72 hours == 3 days
1115 return self.map:set(section, self.option, value)
1116 else
1117 self.map:del(section, "force_unit")
1118 return self.map:del(section, self.option)
1119 end
1120 end
1121
1122 -- force_unit -- ###############################################################
1123 fu = ns:taboption("timer", ListValue, "force_unit", "not displayed, but needed otherwise error",
1124 translate("Interval to force updates send to DDNS Provider" .. "<br />" ..
1125 "Setting this parameter to 0 will force the script to only run once" .. "<br />" ..
1126 "Values lower 'Check Interval' except '0' are not supported") )
1127 fu.template = "ddns/detail_lvalue"
1128 fu.default = "hours"
1129 fu.rmempty = false -- want to control write process
1130 --fu:value("seconds", translate("seconds"))
1131 fu:value("minutes", translate("minutes"))
1132 fu:value("hours", translate("hours"))
1133 fu:value("days", translate("days"))
1134 function fu.write(self, section, value)
1135 -- simulate rmempty=true remove default
1136 local secs = DDNS.calc_seconds(fi:formvalue(section), value)
1137 if secs ~= 259200 and secs ~= 0 then --default 72 hours == 3 days
1138 return self.map:set(section, self.option, value)
1139 else
1140 return true
1141 end
1142 end
1143
1144 -- retry_count (NEW) -- ########################################################
1145 rc = ns:taboption("timer", Value, "retry_count",
1146 translate("Error Retry Counter"),
1147 translate("On Error the script will stop execution after given number of retrys") )
1148 rc.default = 5
1149 rc.rmempty = false -- validate ourselves for translatable error messages
1150 function rc.validate(self, value)
1151 if not DTYP.uinteger(value) then
1152 return nil, err_tab_timer(self) .. translate("minimum value '0'")
1153 else
1154 return value
1155 end
1156 end
1157 function rc.write(self, section, value)
1158 -- simulate rmempty=true remove default
1159 if tonumber(value) ~= self.default then
1160 return self.map:set(section, self.option, value)
1161 else
1162 return self.map:del(section, self.option)
1163 end
1164 end
1165
1166 -- retry_interval -- ###########################################################
1167 ri = ns:taboption("timer", Value, "retry_interval",
1168 translate("Error Retry Interval") )
1169 ri.template = "ddns/detail_value"
1170 ri.default = 60
1171 ri.rmempty = false -- validate ourselves for translatable error messages
1172 function ri.validate(self, value)
1173 if not DTYP.uinteger(value)
1174 or tonumber(value) < 1 then
1175 return nil, err_tab_timer(self) .. translate("minimum value '1'")
1176 else
1177 return value
1178 end
1179 end
1180 function ri.write(self, section, value)
1181 -- simulate rmempty=true remove default
1182 local secs = DDNS.calc_seconds(value, ru:formvalue(section))
1183 if secs ~= 60 then --default 60seconds
1184 return self.map:set(section, self.option, value)
1185 else
1186 self.map:del(section, "retry_unit")
1187 return self.map:del(section, self.option)
1188 end
1189 end
1190
1191 -- retry_unit -- ###############################################################
1192 ru = ns:taboption("timer", ListValue, "retry_unit", "not displayed, but needed otherwise error",
1193 translate("On Error the script will retry the failed action after given time") )
1194 ru.template = "ddns/detail_lvalue"
1195 ru.default = "seconds"
1196 ru.rmempty = false -- want to control write process
1197 ru:value("seconds", translate("seconds"))
1198 ru:value("minutes", translate("minutes"))
1199 --ru:value("hours", translate("hours"))
1200 --ru:value("days", translate("days"))
1201 function ru.write(self, section, value)
1202 -- simulate rmempty=true remove default
1203 local secs = DDNS.calc_seconds(ri:formvalue(section), value)
1204 if secs ~= 60 then --default 60seconds
1205 return self.map:set(section, self.option, value)
1206 else
1207 return true -- will be deleted by retry_interval
1208 end
1209 end
1210
1211 -- TAB: LogView (NEW) #############################################################################
1212 lv = ns:taboption("logview", DummyValue, "_logview")
1213 lv.template = "ddns/detail_logview"
1214 lv.inputtitle = translate("Read / Reread log file")
1215 lv.rows = 50
1216 function lv.cfgvalue(self, section)
1217 local lfile=log_dir .. "/" .. section .. ".log"
1218 if FS.access(lfile) then
1219 return lfile .. "\n" .. translate("Please press [Read] button")
1220 end
1221 return lfile .. "\n" .. translate("File not found or empty")
1222 end
1223
1224 return m