travelmate: major frontend update

* all options are full configurable via frontend
* show current runtime information
* show current travelmate logfile information
* automatic wwan network interface setup (advanced section)
* direct access to all relevant configuration files (advanced section)

Signed-off-by: Dirk Brenken <dev@brenken.org>

applications/luci-app-travelmate/Makefile

@@ -1,11 +1,11 @@
-#
-# This is free software, licensed under the Apache License, Version 2.0 .
+# Copyright 2017 Dirk Brenken (dev@brenken.org)
+# This is free software, licensed under the Apache License, Version 2.0
 #
 
 include $(TOPDIR)/rules.mk
 
 LUCI_TITLE:=LuCI support for Travelmate
-LUCI_DEPENDS:=+travelmate
+LUCI_DEPENDS:=+travelmate +luci-lib-jsonc
 LUCI_PKGARCH:=all
 
 include ../../luci.mk

applications/luci-app-travelmate/luasrc/controller/travelmate.lua

@@ -1,11 +1,29 @@
--- Licensed to the public under the Apache License 2.0.
+-- Copyright 2017 Dirk Brenken (dev@brenken.org)
+-- This is free software, licensed under the Apache License, Version 2.0
 
 module("luci.controller.travelmate", package.seeall)
 
+local fs = require("nixio.fs")
+local util = require("luci.util")
+local template = require("luci.template")
+local i18n = require("luci.i18n")
+
 function index()
 	if not nixio.fs.access("/etc/config/travelmate") then
 		return
 	end
-
-	entry({"admin", "services", "travelmate"}, cbi("travelmate"), _("Travelmate"), 60)
+	entry({"admin", "services", "travelmate"}, firstchild(), _("Travelmate"), 30).dependent = false
+	entry({"admin", "services", "travelmate", "tab_from_cbi"}, cbi("travelmate/overview_tab"), _("Overview"), 10).leaf = true
+	entry({"admin", "services", "travelmate", "logfile"}, call("logread"), _("View Logfile"), 20).leaf = true
+	entry({"admin", "services", "travelmate", "advanced"}, firstchild(), _("Advanced"), 100)
+	entry({"admin", "services", "travelmate", "advanced", "setup"}, cbi("travelmate/setup_tab"), _("Setup WWAN Interface"), 110).leaf = true
+	entry({"admin", "services", "travelmate", "advanced", "configuration"}, cbi("travelmate/configuration_tab"), _("Edit Travelmate Configuration"), 120).leaf = true
+	entry({"admin", "services", "travelmate", "advanced", "cfg_wireless"}, cbi("travelmate/cfg_wireless_tab"), _("Edit Wireless Configuration"), 130).leaf = true
+	entry({"admin", "services", "travelmate", "advanced", "cfg_network"}, cbi("travelmate/cfg_network_tab"), _("Edit Network Configuration"), 140).leaf = true
+	entry({"admin", "services", "travelmate", "advanced", "cfg_firewall"}, cbi("travelmate/cfg_firewall_tab"), _("Edit Firewall Configuration"), 150).leaf = true
+end
+
+function logread()
+	local logfile = util.trim(util.exec("logread -e 'travelmate'"))
+	template.render("travelmate/logread", {title = i18n.translate("Travelmate Logfile"), content = logfile})
 end

applications/luci-app-travelmate/luasrc/model/cbi/travelmate.lua

@@ -1,53 +0,0 @@
--- Licensed to the public under the Apache License 2.0.
-
-m = Map("travelmate", translate("Travelmate"),
-	translate("Configuration of the Travelmate package to enable travel router functionality. ") .. [[</p>]] ..
-	translate("Brief advice: Create a wwan interface, configure it to use dhcp and " ..
-		"add it to the wan zone in firewall. Create the wifi interfaces to be used ('client' mode, " ..
-		"assigned to wwan network, left as disabled). Travelmate will try " ..
-		"to connect to the known wifi client interfaces in the defined order. ") ..
-	[[<a href="https://github.com/openwrt/packages/tree/master/net/travelmate/files/README.md" target="_blank">]] 
-	.. translate("Link to detailed advice")
-	.. [[</a>]] )
-
--- General options
-
-s = m:section(NamedSection, "global", "travelmate", translate("Global options"))
-
-o = s:option(Flag, "trm_enabled", translate("Enable Travelmate"))
-o.rmempty = false
-o.default = 0
-
-o = s:option(Value, "trm_maxwait", translate("Max. timeout in seconds for wlan interface reload"),
-	translate("Default 20, range 10-60"))
-o.rmempty = false
-o.default = 20
-o.datatype = "range(10,60)"
-
-o = s:option(Value, "trm_maxretry", translate("Max. number of connection retries to an uplink"),
-	translate("Default 3, range 1-10"))
-o.rmempty = false
-o.default = 3
-o.datatype = "range(1,10)"
-
--- Extra options
-
-e = m:section(NamedSection, "global", "travelmate", translate("Extra options"))
-
-a = e:option(Flag, "trm_debug", translate("Debug logging"))
-a.rmempty = true
-a.default = a.disabled
-
-a = e:option(Value, "trm_iface", translate("Restrict reload trigger to certain interface(s)"),
-	translate("Space separated list of wwan interfaces that trigger reload action. To disable reload trigger set it to 'false'. Default: empty"))
-a.rmempty = true
-a.default = ""
-a.datatype = "uciname"
-
-a = e:option(Flag, "trm_iw", translate("Use iw for scanning"),
-	translate("Disable this if you want to use iwinfo instead of iw"))
-a.rmempty = true
-a.default = a.enabled
-
-return m
-

applications/luci-app-travelmate/luasrc/model/cbi/travelmate/cfg_firewall_tab.lua

@@ -0,0 +1,36 @@
+-- Copyright 2017 Dirk Brenken (dev@brenken.org)
+-- This is free software, licensed under the Apache License, Version 2.0
+
+local fs = require("nixio.fs")
+local util = require("luci.util")
+local trminput = "/etc/config/firewall"
+
+if not nixio.fs.access(trminput) then
+	m = SimpleForm("error", nil, translate("Input file not found, please check your configuration."))
+	return m
+end
+
+m = SimpleForm("input", nil)
+m:append(Template("travelmate/config_css"))
+m.reset = false
+
+s = m:section(SimpleSection, nil,
+	translate("This form allows you to modify the content of the main firewall configuration file (/etc/config/firewall)."))
+
+f = s:option(TextValue, "data")
+f.rows = 20
+f.rmempty = true
+
+function f.cfgvalue()
+	return nixio.fs.readfile(trminput) or ""
+end
+
+function f.write(self, section, data)
+	return nixio.fs.writefile(trminput, "\n" .. util.trim(data:gsub("\r\n", "\n")) .. "\n")
+end
+
+function s.handle(self, state, data)
+	return true
+end
+
+return m

applications/luci-app-travelmate/luasrc/model/cbi/travelmate/cfg_network_tab.lua

@@ -0,0 +1,36 @@
+-- Copyright 2017 Dirk Brenken (dev@brenken.org)
+-- This is free software, licensed under the Apache License, Version 2.0
+
+local fs = require("nixio.fs")
+local util = require("luci.util")
+local trminput = "/etc/config/network"
+
+if not nixio.fs.access(trminput) then
+	m = SimpleForm("error", nil, translate("Input file not found, please check your configuration."))
+	return m
+end
+
+m = SimpleForm("input", nil)
+m:append(Template("travelmate/config_css"))
+m.reset = false
+
+s = m:section(SimpleSection, nil,
+	translate("This form allows you to modify the content of the main network configuration file (/etc/config/network)."))
+
+f = s:option(TextValue, "data")
+f.rows = 20
+f.rmempty = true
+
+function f.cfgvalue()
+	return nixio.fs.readfile(trminput) or ""
+end
+
+function f.write(self, section, data)
+	return nixio.fs.writefile(trminput, "\n" .. util.trim(data:gsub("\r\n", "\n")) .. "\n")
+end
+
+function s.handle(self, state, data)
+	return true
+end
+
+return m

applications/luci-app-travelmate/luasrc/model/cbi/travelmate/cfg_wireless_tab.lua

@@ -0,0 +1,36 @@
+-- Copyright 2017 Dirk Brenken (dev@brenken.org)
+-- This is free software, licensed under the Apache License, Version 2.0
+
+local fs = require("nixio.fs")
+local util = require("luci.util")
+local trminput = "/etc/config/wireless"
+
+if not nixio.fs.access(trminput) then
+	m = SimpleForm("error", nil, translate("Input file not found, please check your configuration."))
+	return m
+end
+
+m = SimpleForm("input", nil)
+m:append(Template("travelmate/config_css"))
+m.reset = false
+
+s = m:section(SimpleSection, nil,
+	translate("This form allows you to modify the content of the main wireless configuration file (/etc/config/wireless)."))
+
+f = s:option(TextValue, "data")
+f.rows = 20
+f.rmempty = true
+
+function f.cfgvalue()
+	return nixio.fs.readfile(trminput) or ""
+end
+
+function f.write(self, section, data)
+	return nixio.fs.writefile(trminput, "\n" .. util.trim(data:gsub("\r\n", "\n")) .. "\n")
+end
+
+function s.handle(self, state, data)
+	return true
+end
+
+return m

applications/luci-app-travelmate/luasrc/model/cbi/travelmate/configuration_tab.lua

@@ -0,0 +1,36 @@
+-- Copyright 2017 Dirk Brenken (dev@brenken.org)
+-- This is free software, licensed under the Apache License, Version 2.0
+
+local fs = require("nixio.fs")
+local util = require("luci.util")
+local trminput = "/etc/config/travelmate"
+
+if not nixio.fs.access(trminput) then
+	m = SimpleForm("error", nil, translate("Input file not found, please check your configuration."))
+	return m
+end
+
+m = SimpleForm("input", nil)
+m:append(Template("travelmate/config_css"))
+m.reset = false
+
+s = m:section(SimpleSection, nil,
+	translate("This form allows you to modify the content of the main travelmate configuration file (/etc/config/travelmate)."))
+
+f = s:option(TextValue, "data")
+f.rows = 20
+f.rmempty = true
+
+function f.cfgvalue()
+	return nixio.fs.readfile(trminput) or ""
+end
+
+function f.write(self, section, data)
+	return nixio.fs.writefile(trminput, "\n" .. util.trim(data:gsub("\r\n", "\n")) .. "\n")
+end
+
+function s.handle(self, state, data)
+	return true
+end
+
+return m

applications/luci-app-travelmate/luasrc/model/cbi/travelmate/overview_tab.lua

@@ -0,0 +1,129 @@
+-- Copyright 2017 Dirk Brenken (dev@brenken.org)
+-- This is free software, licensed under the Apache License, Version 2.0
+
+local fs = require("nixio.fs")
+local uci = require("uci")
+local sys = require("luci.sys")
+local json = require("luci.jsonc")
+local trminput = uci.get("travelmate", "global", "trm_rtfile") or "/tmp/trm_runtime.json"
+local parse = json.parse(fs.readfile(trminput) or "")
+
+m = Map("travelmate", translate("Travelmate"),
+	translate("Configuration of the travelmate package to to enable travel router functionality. ")
+	.. translate("For further information ")
+	.. [[<a href="https://github.com/openwrt/packages/blob/master/net/travelmate/files/README.md" target="_blank">]]
+	.. translate("see online documentation")
+	.. [[</a>]]
+	.. translate("."))
+
+-- Main travelmate options
+
+s = m:section(NamedSection, "global", "travelmate")
+
+o1 = s:option(Flag, "trm_enabled", translate("Enable travelmate"))
+o1.default = o1.disabled
+o1.rmempty = false
+
+o2 = s:option(Flag, "trm_automatic", translate("Enable 'automatic' mode"),
+	translate("Keep travelmate in an active state."))
+o2.default = o2.enabled
+o2.rmempty = false
+
+o3 = s:option(Value, "trm_iface", translate("Restrict interface trigger to certain interface(s)"),
+	translate("Space separated list of interfaces that trigger travelmate processing. "..
+	"To disable event driven (re-)starts remove all entries."))
+o3.rmempty = true
+
+o4 = s:option(Value, "trm_triggerdelay", translate("Trigger delay"),
+	translate("Additional trigger delay in seconds before travelmate processing begins."))
+o4.default = 2
+o4.datatype = "range(1,90)"
+o4.rmempty = false
+
+o5 = s:option(Flag, "trm_debug", translate("Enable verbose debug logging"))
+o5.default = o5.disabled
+o5.rmempty = false
+
+-- Runtime information
+
+ds = s:option(DummyValue, "_dummy", translate("Runtime information"))
+ds.template = "cbi/nullsection"
+
+dv1 = s:option(DummyValue, "status", translate("Online Status"))
+dv1.template = "travelmate/runtime"
+if parse == nil then
+	dv1.value = translate("n/a")
+elseif parse.data.station_connection == "true" then
+	dv1.value = translate("connected")
+else
+	dv1.value = translate("not connected")
+end
+
+dv2 = s:option(DummyValue, "travelmate_version", translate("Travelmate version"))
+dv2.template = "travelmate/runtime"
+if parse ~= nil then
+	dv2.value = parse.data.travelmate_version or translate("n/a")
+else
+	dv2.value = translate("n/a")
+end
+
+dv3 = s:option(DummyValue, "station_ssid", translate("Station SSID"))
+dv3.template = "travelmate/runtime"
+if parse ~= nil then
+	dv3.value = parse.data.station_ssid or translate("n/a")
+else
+	dv3.value = translate("n/a")
+end
+
+dv4 = s:option(DummyValue, "station_interface", translate("Station Interface"))
+dv4.template = "travelmate/runtime"
+if parse ~= nil then
+	dv4.value = parse.data.station_interface or translate("n/a")
+else
+	dv4.value = translate("n/a")
+end
+
+dv5 = s:option(DummyValue, "station_radio", translate("Station Radio"))
+dv5.template = "travelmate/runtime"
+if parse ~= nil then
+	dv5.value = parse.data.station_radio or translate("n/a")
+else
+	dv5.value = translate("n/a")
+end
+
+dv6 = s:option(DummyValue, "last_rundate", translate("Last rundate"))
+dv6.template = "travelmate/runtime"
+if parse ~= nil then
+	dv6.value = parse.data.last_rundate or translate("n/a")
+else
+	dv6.value = translate("n/a")
+end
+
+-- Extra options
+
+e = m:section(NamedSection, "global", "travelmate", translate("Extra options"),
+translate("Options for further tweaking in case the defaults are not suitable for you."))
+
+e1 = e:option(Value, "trm_radio", translate("Radio selection"),
+	translate("Restrict travelmate to a dedicated radio, e.g. 'radio0'"))
+e1.rmempty = true
+
+e2 = e:option(Value, "trm_maxretry", translate("Connection Limit"),
+	translate("How many times should travelmate try to connect to an Uplink"))
+e2.default = 3
+e2.datatype = "range(1,10)"
+e2.rmempty = false
+
+e3 = e:option(Value, "trm_maxwait", translate("Interface Timeout"),
+	translate("How long should travelmate wait for a successful wlan interface reload"))
+e3.default = 30
+e3.datatype = "range(5,60)"
+e3.rmempty = false
+
+e4 = e:option(Value, "trm_timeout", translate("Overall Timeout"),
+	translate("Timeout in seconds between retries in 'automatic' mode"))
+e4.default = 60
+e4.datatype = "range(5,300)"
+e4.rmempty = false
+
+return m

applications/luci-app-travelmate/luasrc/model/cbi/travelmate/setup_tab.lua

@@ -0,0 +1,55 @@
+-- Copyright 2017 Dirk Brenken (dev@brenken.org)
+-- This is free software, licensed under the Apache License, Version 2.0
+
+local nw  = require("luci.model.network").init()
+local fw  = require("luci.model.firewall").init()
+local util = require("luci.util")
+local uci = require("luci.model.uci").cursor()
+
+m = SimpleForm("network", translate("Interface Setup"),
+	translate("Automatically create a new wireless wan interface, configure it to use dhcp and " ..
+	"add it to the wan zone of the firewall. This step has only to be done once."))
+m.reset = false
+
+iface = m:field(Value, "netname", translate("Name of the new wireless wan interface"),
+	translate("The allowed characters are: <code>A-Z</code>, <code>a-z</code>, " ..
+		"<code>0-9</code> and <code>_</code> (3-15 characters)."))
+iface.default = "wwan"
+iface.datatype = "and(uciname,minlength(3),maxlength(15))"
+
+function iface.validate(self, value, section)
+	local value = iface:formvalue(section)
+	local name = uci.get("network", value)
+	if name then
+		iface:add_error(section, translate("The given network interface name already exist"))
+	else
+		iface.datatype = false
+		iface.default = iface.disabled
+		f = m:field(DummyValue, "textfield", "&nbsp;", translate("Direct Link: "
+			.. [[<a href="]] .. luci.dispatcher.build_url("admin/network/wireless") .. [[">]]
+			.. "Wireless Setup" .. [[</a>]]))
+		f.default = translate("Network Interface '" .. value .. "' created successfully." ..
+					" Feel free to scan & add new stations via standard wireless setup.")
+		f.disabled = true
+	end
+	return value
+end
+
+function iface.write(self, section, value)
+	local name = iface:formvalue(section)
+	if name then
+		local net = nw:add_network(name, { proto = "dhcp" })
+		if net then
+			nw:save("network")
+			nw:commit("network")
+			local zone = fw:get_zone_by_network("wan")
+			if zone then
+				zone:add_network(name)
+				fw:save("firewall")
+				fw:commit("firewall")
+			end
+		end
+	end
+end
+
+return m

applications/luci-app-travelmate/luasrc/view/travelmate/config_css.htm

@@ -0,0 +1,10 @@
+<style type="text/css">
+	textarea
+	{
+		border: 1px solid #cccccc;
+		padding: 5px;
+		font-size: 12px;
+		font-family: monospace;
+		resize: none;
+	}
+</style>

applications/luci-app-travelmate/luasrc/view/travelmate/logread.htm

@@ -0,0 +1,15 @@
+<%#
+Copyright 2017 Dirk Brenken (dev@brenken.org)
+This is free software, licensed under the Apache License, Version 2.0
+-%>
+
+<%+header%>
+
+<div class="cbi-map">
+	<fieldset class="cbi-section">
+		<div class="cbi-section-descr"><%:This form shows the syslog output, pre-filtered for travelmate related messages only.%></div>
+		<textarea id="logread_id" style="width: 100%; height: 450px; border: 1px solid #cccccc; padding: 5px; font-size: 12px; font-family: monospace; resize: none;" readonly="readonly" wrap="off" rows="<%=content:cmatch("\n")+2%>"><%=content:pcdata()%></textarea>
+	</fieldset>
+</div>
+
+<%+footer%>

applications/luci-app-travelmate/luasrc/view/travelmate/runtime.htm

@@ -0,0 +1,10 @@
+<%#
+Copyright 2017 Dirk Brenken (dev@brenken.org)
+This is free software, licensed under the Apache License, Version 2.0
+-%>
+
+<%+cbi/valueheader%>
+
+<input name="runtime" id="runtime" type="text" class="cbi-input-text" style="border: none; box-shadow: none; background-color: #ffffff; color: #0069d6;" value="<%=self:cfgvalue(section)%>" disabled="disabled" />
+
+<%+cbi/valuefooter%>