summaryrefslogtreecommitdiffhomepage
path: root/applications/luci-app-travelmate/luasrc/model/cbi/travelmate/overview_tab.lua
blob: e2f4e3f0021de43b5562d95a1d5fb5b5740e8935 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
-- Copyright 2017-2018 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("luci.model.uci").cursor()
local json     = require("luci.jsonc")
local util     = require("luci.util")
local nw       = require("luci.model.network").init()
local fw       = require("luci.model.firewall").init()
local dump     = util.ubus("network.interface", "dump", {})
local trmiface = uci:get("travelmate", "global", "trm_iface") or "trm_wwan"
local trminput = uci:get("travelmate", "global", "trm_rtfile") or "/tmp/trm_runtime.json"
local uplink   = uci:get("network", trmiface) or ""
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. ")
	.. translatef("For further information "
	.. "<a href=\"%s\" target=\"_blank\">"
	.. "see online documentation</a>", "https://github.com/openwrt/packages/blob/master/net/travelmate/files/README.md"))

-- We might modify these configs too:
m:chain("network")
m:chain("firewall")

function m.on_after_commit(self)
	uci:apply(true)
	luci.http.redirect(luci.dispatcher.build_url("admin", "services", "travelmate"))
end

-- Interface Wizard

if uplink == "" then
	ds = m:section(NamedSection, "global", "travelmate", translate("Interface Wizard"))

	o = ds:option(Value, "", translate("Uplink interface"))
	o.datatype = "and(uciname,rangelength(3,15))"
	o.default = trmiface
	o.rmempty = false

	btn = ds:option(Button, "trm_iface", translate("Create Uplink Interface"),
		translate("Create a new wireless wan uplink interface, configure it to use dhcp and ")
		.. translate("add it to the wan zone of the firewall. This step has only to be done once."))
	btn.inputtitle = translate("Add Interface")
	btn.inputstyle = "apply"
	btn.disabled = false

	function btn.write(self, section)
		-- Do uci changes. Note that we must not commit here as the rollback handler
		-- needs to see "unsaved changes" in order to roll them back.
		local iface = o:formvalue(section)
		if iface then
			uci:set("travelmate", section, "trm_iface", iface)
			local net = nw:add_network(iface, { proto = "dhcp" })
			if net then
				local zone = fw:get_zone_by_network("wan")
				if zone then
					zone:add_network(iface)
				end
			end
		end

		-- Since we're prematurely terminating the cbi logic flow here and since we trigger
		-- our modifications in a button write callback and not via cbi.apply, we do need to
		-- tell cbi to trigger apply/rollback.
		m.flow.autoapply = true
	end
	return m
end

-- 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_captive", translate("Captive Portal Detection"),
	translate("Check the internet availability, log captive portal redirections and keep the uplink connection 'alive'."))
o2.default = o2.enabled
o2.rmempty = false

o3 = s:option(ListValue, "trm_iface", translate("Uplink / Trigger interface"),
	translate("Name of the used uplink interface."))
if dump then
	local i, v
	for i, v in ipairs(dump.interface) do
		if v.interface ~= "loopback" and v.interface ~= "lan" then
			o3:value(v.interface)
		end
	end
end
o3.default = trmiface
o3.rmempty = false

if fs.access("/usr/bin/qrencode") then
	btn = s:option(Button, "btn", translate("View AP QR-Codes"),
		translate("Connect your Android or iOS devices to your router's WiFi using the shown QR code."))
	btn.inputtitle = translate("QR-Codes")
	btn.inputstyle = "apply"
	btn.disabled = false

	function btn.write()
		luci.http.redirect(luci.dispatcher.build_url("admin", "services", "travelmate", "apqr"))
	end
end

-- Runtime information

ds = m:section(NamedSection, "global", "travelmate", translate("Runtime Information"))

dv1 = ds:option(DummyValue, "status", translate("Travelmate Status (Quality)"))
dv1.template = "travelmate/runtime"
if parse ~= nil then
	dv1.value = parse.data.travelmate_status or translate("n/a")
else
	dv1.value = translate("n/a")
end

dv2 = ds: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 = ds:option(DummyValue, "station_id", translate("Station ID (SSID/BSSID)"))
dv3.template = "travelmate/runtime"
if parse ~= nil then
	dv3.value = parse.data.station_id or translate("n/a")
else
	dv3.value = translate("n/a")
end

dv4 = ds: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 = ds: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 = ds: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(Flag, "trm_debug", translate("Enable verbose debug logging"))
e1.default = e1.disabled
e1.rmempty = false

e2 = e:option(Value, "trm_radio", translate("Radio selection"),
	translate("Restrict travelmate to a dedicated radio, e.g. 'radio0'."))
e2.datatype = "and(uciname,rangelength(6,6))"
e2.rmempty = true

e3 = e:option(Value, "trm_triggerdelay", translate("Trigger Delay"),
	translate("Additional trigger delay in seconds before travelmate processing begins."))
e3.datatype = "range(1,60)"
e3.default = 2
e3.rmempty = false

e4 = e:option(Value, "trm_maxretry", translate("Connection Limit"),
	translate("Retry limit to connect to an uplink."))
e4.default = 3
e4.datatype = "range(1,10)"
e4.rmempty = false

e5 = e:option(Value, "trm_minquality", translate("Signal Quality Threshold"),
	translate("Minimum signal quality threshold as percent for conditional uplink (dis-) connections."))
e5.default = 35
e5.datatype = "range(20,80)"
e5.rmempty = false

e6 = e:option(Value, "trm_maxwait", translate("Interface Timeout"),
	translate("How long should travelmate wait for a successful wlan uplink connection."))
e6.default = 30
e6.datatype = "range(20,40)"
e6.rmempty = false

e7 = e:option(Value, "trm_timeout", translate("Overall Timeout"),
	translate("Overall retry timeout in seconds."))
e7.default = 60
e7.datatype = "range(30,300)"
e7.rmempty = false

return m