Merge pull request #278 from nmav/ocserv
[project/luci.git] / applications / luci-olsr / luasrc / model / cbi / olsr / olsrd.lua
1 --[[
2 LuCI - Lua Configuration Interface
3
4 Copyright 2008 Steven Barth <steven@midlink.org>
5 Copyright 2010 Jo-Philipp Wich <xm@subsignal.org>
6
7 Licensed under the Apache License, Version 2.0 (the "License");
8 you may not use this file except in compliance with the License.
9 You may obtain a copy of the License at
10
11         http://www.apache.org/licenses/LICENSE-2.0
12
13 $Id$
14 ]]--
15
16 require("luci.tools.webadmin")
17 local fs  = require "nixio.fs"
18 local util = require "luci.util"
19 local ip = require "luci.ip"
20
21 local has_ipip  = fs.glob("/etc/modules.d/[0-9]*-ipip")()
22
23 m = Map("olsrd", translate("OLSR Daemon"),
24         translate("The OLSR daemon is an implementation of the Optimized Link State Routing protocol. "..
25         "As such it allows mesh routing for any network equipment. "..
26         "It runs on any wifi card that supports ad-hoc mode and of course on any ethernet device. "..
27         "Visit <a href='http://www.olsr.org'>olsrd.org</a> for help and documentation."))
28
29 function m.on_parse()
30         local has_defaults = false
31
32         m.uci:foreach("olsrd", "InterfaceDefaults",
33                 function(s)
34                         has_defaults = true
35                         return false
36                 end)
37
38         if not has_defaults then
39                 m.uci:section("olsrd", "InterfaceDefaults")
40         end
41 end
42
43 function write_float(self, section, value)
44     local n = tonumber(value)
45     if n ~= nil then
46         return Value.write(self, section, "%.1f" % n) 
47     end
48 end
49
50 s = m:section(TypedSection, "olsrd", translate("General settings"))
51 s.anonymous = true
52
53 s:tab("general",  translate("General Settings"))
54 s:tab("lquality", translate("Link Quality Settings"))
55 s:tab("smartgw", translate("SmartGW"), not has_ipip and translate("Warning: kmod-ipip is not installed. Without kmod-ipip SmartGateway will not work, please install it."))
56 s:tab("advanced", translate("Advanced Settings"))
57
58 ipv = s:taboption("general", ListValue, "IpVersion", translate("Internet protocol"),
59         translate("IP-version to use. If 6and4 is selected then one olsrd instance is started for each protocol."))
60 ipv:value("4", "IPv4")
61 ipv:value("6and4", "6and4")
62
63
64 poll = s:taboption("advanced", Value, "Pollrate", translate("Pollrate"),
65         translate("Polling rate for OLSR sockets in seconds. Default is 0.05."))
66 poll.optional = true
67 poll.datatype = "ufloat"
68 poll.placeholder = "0.05"
69
70 nicc = s:taboption("advanced", Value, "NicChgsPollInt", translate("Nic changes poll interval"),
71         translate("Interval to poll network interfaces for configuration changes (in seconds). Default is \"2.5\"."))
72 nicc.optional = true
73 nicc.datatype = "ufloat"
74 nicc.placeholder = "2.5"
75
76 tos = s:taboption("advanced", Value, "TosValue", translate("TOS value"),
77         translate("Type of service value for the IP header of control traffic. Default is \"16\"."))
78 tos.optional = true
79 tos.datatype = "uinteger"
80 tos.placeholder = "16"
81
82 fib = s:taboption("general", ListValue, "FIBMetric", translate("FIB metric"),
83         translate ("FIBMetric controls the metric value of the host-routes OLSRd sets. "..
84         "\"flat\" means that the metric value is always 2. This is the preferred value "..
85         "because it helps the linux kernel routing to clean up older routes. "..
86         "\"correct\" uses the hopcount as the metric value. "..
87         "\"approx\" use the hopcount as the metric value too, but does only update the hopcount if the nexthop changes too. "..
88         "Default is \"flat\"."))
89 fib:value("flat")
90 fib:value("correct")
91 fib:value("approx")
92
93 lql = s:taboption("lquality", ListValue, "LinkQualityLevel", translate("LQ level"),
94         translate("Link quality level switch between hopcount and cost-based (mostly ETX) routing.<br />"..
95         "<b>0</b> = do not use link quality<br />"..
96         "<b>2</b> = use link quality for MPR selection and routing<br />"..
97         "Default is \"2\""))
98 lql:value("2")
99 lql:value("0")
100
101 lqage = s:taboption("lquality", Value, "LinkQualityAging", translate("LQ aging"),
102         translate("Link quality aging factor (only for lq level 2). Tuning parameter for etx_float and etx_fpm, smaller values "..
103         "mean slower changes of ETX value. (allowed values are between 0.01 and 1.0)"))
104 lqage.optional = true
105 lqage:depends("LinkQualityLevel", "2")
106
107 lqa = s:taboption("lquality", ListValue, "LinkQualityAlgorithm", translate("LQ algorithm"),
108         translate("Link quality algorithm (only for lq level 2).<br />"..
109         "<b>etx_float</b>: floating point ETX with exponential aging<br />"..
110         "<b>etx_fpm</b>  : same as etx_float, but with integer arithmetic<br />"..
111         "<b>etx_ff</b>   : ETX freifunk, an etx variant which use all OLSR traffic (instead of only hellos) for ETX calculation<br />"..
112         "<b>etx_ffeth</b>: incompatible variant of etx_ff that allows ethernet links with ETX 0.1.<br />"..
113         "Defaults to \"etx_ff\""))
114 lqa.optional = true
115 lqa:value("etx_ff")
116 lqa:value("etx_fpm")
117 lqa:value("etx_float")
118 lqa:value("etx_ffeth")
119 lqa:depends("LinkQualityLevel", "2")
120 lqa.optional = true
121
122 lqfish = s:taboption("lquality", Flag, "LinkQualityFishEye", translate("LQ fisheye"),
123         translate("Fisheye mechanism for TCs (checked means on). Default is \"on\""))
124 lqfish.default = "1"
125 lqfish.optional = true
126
127 hyst = s:taboption("lquality", Flag, "UseHysteresis", translate("Use hysteresis"),
128         translate("Hysteresis for link sensing (only for hopcount metric). Hysteresis adds more robustness to the link sensing "..
129         "but delays neighbor registration. Defaults is \"yes\""))
130 hyst.default = "yes"
131 hyst.enabled = "yes"
132 hyst.disabled = "no"
133 hyst:depends("LinkQualityLevel", "0")
134 hyst.optional = true
135 hyst.rmempty = true
136
137 port = s:taboption("general", Value, "OlsrPort", translate("Port"),
138         translate("The port OLSR uses. This should usually stay at the IANA assigned port 698. It can have a value between 1 and 65535."))
139 port.optional = true
140 port.default = "698"
141 port.rmempty = true
142
143 mainip = s:taboption("general", Value, "MainIp", translate("Main IP"),
144         translate("Sets the main IP (originator ip) of the router. This IP will NEVER change during the uptime of olsrd. "..
145         "Default is 0.0.0.0, which triggers usage of the IP of the first interface."))
146 mainip.optional = true
147 mainip.rmempty = true
148 mainip.datatype = "ipaddr"
149 mainip.placeholder = "0.0.0.0"
150
151 sgw = s:taboption("smartgw", Flag, "SmartGateway", translate("Enable"), translate("Enable SmartGateway. If it is disabled, then " ..
152         "all other SmartGateway parameters are ignored. Default is \"no\"."))
153 sgw.default="no"
154 sgw.enabled="yes"
155 sgw.disabled="no"
156 sgw.rmempty = true
157
158 sgwnat = s:taboption("smartgw", Flag, "SmartGatewayAllowNAT", translate("Allow gateways with NAT"), translate("Allow the selection of an outgoing ipv4 gateway with NAT"))
159 sgwnat:depends("SmartGateway", "yes")
160 sgwnat.default="yes"
161 sgwnat.enabled="yes"
162 sgwnat.disabled="no"
163 sgwnat.optional = true
164 sgwnat.rmempty = true
165
166 sgwuplink = s:taboption("smartgw", ListValue, "SmartGatewayUplink", translate("Announce uplink"), translate("Which kind of uplink is exported to the other mesh nodes. " ..
167         "An uplink is detected by looking for a local HNA of 0.0.0.0/0, ::ffff:0:0/96 or 2000::/3. Default setting is \"both\"."))
168 sgwuplink:value("none")
169 sgwuplink:value("ipv4")
170 sgwuplink:value("ipv6")
171 sgwuplink:value("both")
172 sgwuplink:depends("SmartGateway", "yes")
173 sgwuplink.default="both"
174 sgwuplink.optional = true
175 sgwuplink.rmempty = true
176
177 sgwulnat = s:taboption("smartgw", Flag, "SmartGatewayUplinkNAT", translate("Uplink uses NAT"), translate("If this Node uses NAT for connections to the internet. " ..
178         "Default is \"yes\"."))
179 sgwulnat:depends("SmartGatewayUplink", "ipv4")
180 sgwulnat:depends("SmartGatewayUplink", "both")
181 sgwulnat.default="yes"
182 sgwulnat.enabled="yes"
183 sgwulnat.disabled="no"
184 sgwnat.optional = true
185 sgwnat.rmempty = true
186
187 sgwspeed = s:taboption("smartgw", Value, "SmartGatewaySpeed", translate("Speed of the uplink"), translate("Specifies the speed of "..
188         "the uplink in kilobits/s. First parameter is upstream, second parameter is downstream. Default is \"128 1024\"."))
189 sgwspeed:depends("SmartGatewayUplink", "ipv4")
190 sgwspeed:depends("SmartGatewayUplink", "ipv6")
191 sgwspeed:depends("SmartGatewayUplink", "both")
192 sgwspeed.optional = true
193 sgwspeed.rmempty = true
194
195 sgwprefix = s:taboption("smartgw", Value, "SmartGatewayPrefix", translate("IPv6-Prefix of the uplink"), translate("This can be used " ..
196         "to signal the external IPv6 prefix of the uplink to the clients. This might allow a client to change it's local IPv6 address to " ..
197         "use the IPv6 gateway without any kind of address translation. The maximum prefix length is 64 bits. " ..
198         "Default is \"::/0\" (no prefix)."))
199 sgwprefix:depends("SmartGatewayUplink", "ipv6")
200 sgwprefix:depends("SmartGatewayUplink", "both")
201 sgwprefix.optional = true
202 sgwprefix.rmempty = true
203
204 willingness = s:taboption("advanced", ListValue, "Willingness", translate("Willingness"),
205                 translate("The fixed willingness to use. If not set willingness will be calculated dynamically based on battery/power status. Default is \"3\"."))
206 for i=0,7 do
207         willingness:value(i)
208 end
209 willingness.optional = true
210 willingness.default = "3"
211
212 natthr = s:taboption("advanced", Value, "NatThreshold", translate("NAT threshold"),
213         translate("If the route to the current gateway is to be changed, the ETX value of this gateway is "..
214         "multiplied with this value before it is compared to the new one. "..
215         "The parameter can be a value between 0.1 and 1.0, but should be close to 1.0 if changed.<br />"..
216         "<b>WARNING:</b> This parameter should not be used together with the etx_ffeth metric!<br />"..
217         "Defaults to \"1.0\"."))
218 for i=1,0.1,-0.1 do
219         natthr:value(i)
220 end
221 natthr:depends("LinkQualityAlgorithm", "etx_ff")
222 natthr:depends("LinkQualityAlgorithm", "etx_float")
223 natthr:depends("LinkQualityAlgorithm", "etx_fpm")
224 natthr.default = "1.0"
225 natthr.optional = true
226 natthr.write = write_float
227
228
229 i = m:section(TypedSection, "InterfaceDefaults", translate("Interfaces Defaults"))
230 i.anonymous = true
231 i.addremove = false
232
233 i:tab("general", translate("General Settings"))
234 i:tab("addrs",   translate("IP Addresses"))
235 i:tab("timing",  translate("Timing and Validity"))
236
237 mode = i:taboption("general", ListValue, "Mode", translate("Mode"),
238         translate("Interface Mode is used to prevent unnecessary packet forwarding on switched ethernet interfaces. "..
239         "valid Modes are \"mesh\" and \"ether\". Default is \"mesh\"."))
240 mode:value("mesh")
241 mode:value("ether")
242 mode.optional = true
243 mode.rmempty = true
244
245
246 weight = i:taboption("general", Value, "Weight", translate("Weight"),
247         translate("When multiple links exist between hosts the weight of interface is used to determine the link to use. "..
248         "Normally the weight is automatically calculated by olsrd based on the characteristics of the interface, "..
249         "but here you can specify a fixed value. Olsrd will choose links with the lowest value.<br />"..
250         "<b>Note:</b> Interface weight is used only when LinkQualityLevel is set to 0. "..
251         "For any other value of LinkQualityLevel, the interface ETX value is used instead."))
252 weight.optional = true
253 weight.datatype = "uinteger"
254 weight.placeholder = "0"
255
256 lqmult = i:taboption("general", DynamicList, "LinkQualityMult", translate("LinkQuality Multiplicator"),
257         translate("Multiply routes with the factor given here. Allowed values are between 0.01 and 1.0. "..
258         "It is only used when LQ-Level is greater than 0. Examples:<br />"..
259         "reduce LQ to 192.168.0.1 by half: 192.168.0.1 0.5<br />"..
260         "reduce LQ to all nodes on this interface by 20%: default 0.8"))
261 lqmult.optional = true
262 lqmult.rmempty = true
263 lqmult.cast = "table"
264 lqmult.placeholder = "default 1.0"
265
266 function lqmult.validate(self, value)
267         for _, v in pairs(value) do
268                 if v ~= "" then
269                         local val = util.split(v, " ")
270                         local host = val[1]
271                         local mult = val[2]
272                         if not host or not mult then
273                                 return nil, translate("LQMult requires two values (IP address or 'default' and multiplicator) seperated by space.")
274                         end
275                         if not (host == "default" or ip.IPv4(host) or ip.IPv6(host)) then
276                                 return nil, translate("Can only be a valid IPv4 or IPv6 address or 'default'")
277                         end
278                         if not tonumber(mult) or tonumber(mult) > 1 or tonumber(mult) < 0.01 then
279                                 return nil, translate("Invalid Value for LQMult-Value. Must be between 0.01 and 1.0.")
280                         end
281                         if not mult:match("[0-1]%.[0-9]+") then
282                                 return nil, translate("Invalid Value for LQMult-Value. You must use a decimal number between 0.01 and 1.0 here.")
283                         end
284                 end
285         end
286         return value
287 end
288
289 ip4b = i:taboption("addrs", Value, "Ip4Broadcast", translate("IPv4 broadcast"),
290         translate("IPv4 broadcast address for outgoing OLSR packets. One useful example would be 255.255.255.255. "..
291         "Default is \"0.0.0.0\", which triggers the usage of the interface broadcast IP."))
292 ip4b.optional = true
293 ip4b.datatype = "ip4addr"
294 ip4b.placeholder = "0.0.0.0"
295
296 ip6m = i:taboption("addrs", Value, "IPv6Multicast", translate("IPv6 multicast"),
297         translate("IPv6 multicast address. Default is \"FF02::6D\", the manet-router linklocal multicast."))
298 ip6m.optional = true
299 ip6m.datatype = "ip6addr"
300 ip6m.placeholder = "FF02::6D"
301
302 ip4s = i:taboption("addrs", Value, "IPv4Src", translate("IPv4 source"),
303         translate("IPv4 src address for outgoing OLSR packages. Default is \"0.0.0.0\", which triggers usage of the interface IP."))
304 ip4s.optional = true
305 ip4s.datatype = "ip4addr"
306 ip4s.placeholder = "0.0.0.0"
307
308 ip6s = i:taboption("addrs", Value, "IPv6Src", translate("IPv6 source"),
309         translate("IPv6 src prefix. OLSRd will choose one of the interface IPs which matches the prefix of this parameter. "..
310         "Default is \"0::/0\", which triggers the usage of a not-linklocal interface IP."))
311 ip6s.optional = true
312 ip6s.datatype = "ip6addr"
313 ip6s.placeholder = "0::/0"
314
315
316 hi = i:taboption("timing", Value, "HelloInterval", translate("Hello interval"))
317 hi.optional = true
318 hi.datatype = "ufloat"
319 hi.placeholder = "5.0"
320 hi.write = write_float
321
322 hv = i:taboption("timing", Value, "HelloValidityTime", translate("Hello validity time"))
323 hv.optional = true
324 hv.datatype = "ufloat"
325 hv.placeholder = "40.0"
326 hv.write = write_float
327
328 ti = i:taboption("timing", Value, "TcInterval", translate("TC interval"))
329 ti.optional = true
330 ti.datatype = "ufloat"
331 ti.placeholder = "2.0"
332 ti.write = write_float
333
334 tv = i:taboption("timing", Value, "TcValidityTime", translate("TC validity time"))
335 tv.optional = true
336 tv.datatype = "ufloat"
337 tv.placeholder = "256.0"
338 tv.write = write_float
339
340 mi = i:taboption("timing", Value, "MidInterval", translate("MID interval"))
341 mi.optional = true
342 mi.datatype = "ufloat"
343 mi.placeholder = "18.0"
344 mi.write = write_float
345
346 mv = i:taboption("timing", Value, "MidValidityTime", translate("MID validity time"))
347 mv.optional = true
348 mv.datatype = "ufloat"
349 mv.placeholder = "324.0"
350 mv.write = write_float
351
352 ai = i:taboption("timing", Value, "HnaInterval", translate("HNA interval"))
353 ai.optional = true
354 ai.datatype = "ufloat"
355 ai.placeholder = "18.0"
356 ai.write = write_float
357
358 av = i:taboption("timing", Value, "HnaValidityTime", translate("HNA validity time"))
359 av.optional = true
360 av.datatype = "ufloat"
361 av.placeholder = "108.0"
362 av.write = write_float
363
364
365 ifs = m:section(TypedSection, "Interface", translate("Interfaces"))
366 ifs.addremove = true
367 ifs.anonymous = true
368 ifs.extedit   = luci.dispatcher.build_url("admin/services/olsrd/iface/%s")
369 ifs.template  = "cbi/tblsection"
370
371 function ifs.create(...)
372         local sid = TypedSection.create(...)
373         luci.http.redirect(ifs.extedit % sid)
374 end
375
376 ign = ifs:option(Flag, "ignore", translate("Enable"))
377 ign.enabled  = "0"
378 ign.disabled = "1"
379 ign.rmempty = false
380 function ign.cfgvalue(self, section)
381         return Flag.cfgvalue(self, section) or "0"
382 end
383
384 network = ifs:option(DummyValue, "interface", translate("Network"))
385 network.template = "cbi/network_netinfo"
386
387 mode = ifs:option(DummyValue, "Mode", translate("Mode"))
388 function mode.cfgvalue(...)
389         return Value.cfgvalue(...) or m.uci:get_first("olsrd", "InterfaceDefaults", "Mode", "mesh")
390 end
391
392 hello = ifs:option(DummyValue, "_hello", translate("Hello"))
393 function hello.cfgvalue(self, section)
394         local i = tonumber(m.uci:get("olsrd", section, "HelloInterval"))     or tonumber(m.uci:get_first("olsrd", "InterfaceDefaults", "HelloInterval", 5))
395         local v = tonumber(m.uci:get("olsrd", section, "HelloValidityTime")) or tonumber(m.uci:get_first("olsrd", "InterfaceDefaults", "HelloValidityTime", 40))
396         return "%.01fs / %.01fs" %{ i, v }
397 end
398
399 tc = ifs:option(DummyValue, "_tc", translate("TC"))
400 function tc.cfgvalue(self, section)
401         local i = tonumber(m.uci:get("olsrd", section, "TcInterval"))     or tonumber(m.uci:get_first("olsrd", "InterfaceDefaults", "TcInterval", 2))
402         local v = tonumber(m.uci:get("olsrd", section, "TcValidityTime")) or tonumber(m.uci:get_first("olsrd", "InterfaceDefaults", "TcValidityTime", 256))
403         return "%.01fs / %.01fs" %{ i, v }
404 end
405
406 mid = ifs:option(DummyValue, "_mid", translate("MID"))
407 function mid.cfgvalue(self, section)
408         local i = tonumber(m.uci:get("olsrd", section, "MidInterval"))     or tonumber(m.uci:get_first("olsrd", "InterfaceDefaults", "MidInterval", 18))
409         local v = tonumber(m.uci:get("olsrd", section, "MidValidityTime")) or tonumber(m.uci:get_first("olsrd", "InterfaceDefaults", "MidValidityTime", 324))
410         return "%.01fs / %.01fs" %{ i, v }
411 end
412
413 hna = ifs:option(DummyValue, "_hna", translate("HNA"))
414 function hna.cfgvalue(self, section)
415         local i = tonumber(m.uci:get("olsrd", section, "HnaInterval"))     or tonumber(m.uci:get_first("olsrd", "InterfaceDefaults", "HnaInterval", 18))
416         local v = tonumber(m.uci:get("olsrd", section, "HnaValidityTime")) or tonumber(m.uci:get_first("olsrd", "InterfaceDefaults", "HnaValidityTime", 108))
417         return "%.01fs / %.01fs" %{ i, v }
418 end
419
420 return m