bird-openwrt: update to version 0.3
[feed/routing.git] / bird-openwrt / bird6-openwrt / src / model / gen_proto.lua
index 5299a5b..d823907 100644 (file)
@@ -1,6 +1,5 @@
 --[[ 
-Copyright (C) 2014 - Eloi Carbó Solé (GSoC2014) 
-BGP/Bird integration with OpenWRT and QMP
+Copyright (C) 2014-2017 - Eloi Carbo
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -18,20 +17,24 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require("luci.sys")
 local http = require "luci.http"
-local uci = require "luci.model.uci"
-local uciout = uci.cursor()
+local uci = luci.model.uci.cursor()
+
+-- Repeated Strings
+local common_string = "Valid options are:<br />" .. "1. all (All the routes)<br />" .. "2. none (No routes)<br />" .. "3. filter <b>Your_Filter_Name</b>      (Call a specific filter from any of the available in the filters files)"
+local imp_string = "Set if the protocol must import routes.<br />" .. common_string
+local exp_string = "Set if the protocol must export routes.<br />" .. common_string
 
 m=Map("bird6", "Bird6 general protocol's configuration.")
 
 -- Optional parameters lists
 local protoptions = {
        {["name"]="table", ["help"]="Auxiliar table for routing", ["depends"]={"static","kernel"}},
-       {["name"]="import", ["help"]="Set if the protocol must import routes", ["depends"]={"kernel"}},
-       {["name"]="export", ["help"]="Set if the protocol must export routes", ["depends"]={"kernel"}},
+       {["name"]="import", ["help"]=imp_string, ["depends"]={"kernel"}},
+       {["name"]="export", ["help"]=exp_string, ["depends"]={"kernel"}},
        {["name"]="scan_time", ["help"]="Time between scans", ["depends"]={"kernel","device"}},
        {["name"]="kernel_table", ["help"]="Set which table must be used as auxiliar kernel table", ["depends"]={"kernel"}},
        {["name"]="learn", ["help"]="Learn routes", ["depends"]={"kernel"}},
-       {["name"]="persist", ["help"]="Store routes. After a restart, routes will be still configured", ["depends"]={"kernel"}}
+       {["name"]="persist", ["help"]="Store routes. After a restart, routes willstill be configured", ["depends"]={"kernel"}}
 }
 
 local routeroptions = {
@@ -64,11 +67,12 @@ for _,o in ipairs(protoptions) do
                                        value = sect_kernel_protos:option(Flag, o.name, translate(o.name), translate(o.help))
                                elseif o.name == "table" then 
                                        value = sect_kernel_protos:option(ListValue, o.name, translate(o.name), translate(o.help))
-                                       uciout:foreach("bird6", "table",
+                                       uci:foreach("bird6", "table",
                                                function (s)
                                                        value:value(s.name)
                                                end)
                                        value:value("")
+                    value.default = ""
                                else
                                        value = sect_kernel_protos:option(Value, o.name, translate(o.name), translate(o.help))
                                end
@@ -126,11 +130,12 @@ for _,o in ipairs(protoptions) do
                        if d == "static" then
                                if o.name == "table" then
                                        value = sect_static_protos:option(ListValue, o.name, translate(o.name), translate(o.help))
-                                       uciout:foreach("bird6", "table",
+                                       uci:foreach("bird6", "table",
                                                function (s)
                                                        value:value(s.name)
                                                end)
                                        value:value("")
+                    value.default = ""
                                else
                                        value = sect_static_protos:option(Value, o.name, translate(o.name), translate(o.help))
                                end
@@ -141,11 +146,69 @@ for _,o in ipairs(protoptions) do
        end
 end
 
+
 --
--- ROUTES FOR STATIC PROTOCOL
+-- PIPE PROTOCOL
 --
+sect_pipe_protos = m:section(TypedSection, "pipe", "Pipe options",     "Configuration of the Pipe protocols.")
+sect_pipe_protos.addremove = true
+sect_pipe_protos.anonymous = false
+
+-- Default Pipe parameters
+disabled = sect_pipe_protos:option(Flag, "disabled", "Disabled", "If this  option is true, the protocol will not be configured. This protocol will connect the configured 'Table' to the 'Peer Table'.")
+disabled.default=0
+
+table = sect_pipe_protos:option(ListValue, "table", "Table", "Select the Primary Table to connect.")
+table.optional = false
+uci:foreach("bird6", "table",
+  function (s)
+    table:value(s.name)
+  end)
+table:value("")
+table.default = ""
+
+peer_table = sect_pipe_protos:option(ListValue, "peer_table", "Peer Table", "Select the Secondary Table to connect.")
+table.optional = false
+uci:foreach("bird6", "table",
+  function (s)
+    peer_table:value(s.name)
+  end)
+peer_table:value("")
+peer_table.default = ""
+
+mode = sect_pipe_protos:option(ListValue, "mode", "Mode", "Select <b>transparent</b> to retransmit all routes and their attributes<br />Select <b>opaque</b> to retransmit optimal routes (similar to what other protocols do)")
+mode.optional = false
+mode:value("transparent")
+mode:value("opaque")
+mode.default = "transparent"
+
+import = sect_pipe_protos:option(Value, "import", "Import",imp_string)
+import.optional=true
+
+export = sect_pipe_protos:option(Value, "export", "Export", exp_string)
+export.optional=true
 
 
+--
+-- DIRECT PROTOCOL
+--
+sect_direct_protos = m:section(TypedSection, "direct", "Direct options", "Configuration of the Direct protocols.")
+sect_direct_protos.addremove = true
+sect_direct_protos.anonymous = false
+
+-- Default Direct parameters
+disabled = sect_direct_protos:option(Flag, "disabled", "Disabled", "If this option is true, the protocol will not be configured. This protocol will connect the configured 'Table' to the 'Peer Table'.")
+disabled.optional = false
+disabled.default = 0
+
+interface = sect_direct_protos:option(Value, "interface", "Interfaces", "By default Direct will generate device routes for all the interfaces. To restrict this behaviour, select a number of patterns to match your desired interfaces:" .. "<br />" .. "1. All the strings <b>MUST</b> be quoted: \"pattern\"" .. "<br />" .. "2. Use * (star) to match patterns: \"eth*\" (<b>include</b> all eth... interfaces)" .. "<br />" .. "3. You can add \"-\" (minus) to exclude patterns: \"-em*\" (<b>exclude</b> all em... interfaces)." .. "<br />" .. "4. Separate several patterns using , (coma): \"-em*\", \"eth*\" (<b>exclude</b> em... and <b>include</b> all eth... interfaces).")
+interface.optional = false
+interface.default = "\"*\""
+
+
+--
+-- ROUTES FOR STATIC PROTOCOL
+--
 sect_routes = m:section(TypedSection, "route", "Routes configuration", "Configuration of the routes used in static protocols.")
 sect_routes.addremove = true
 sect_routes.anonymous = true
@@ -153,7 +216,7 @@ sect_routes.anonymous = true
 instance = sect_routes:option(ListValue, "instance", "Route instance", "")
 i = 0
 
-uciout:foreach("bird6", "static",
+uci:foreach("bird6", "static",
        function (s)
                instance:value(s[".name"])
        end)
@@ -184,9 +247,11 @@ attribute:depends("type", "special")
 iface  = sect_routes:option(ListValue, "iface", "Interface", "")
 iface:depends("type", "iface")
 
-uciout:foreach("wireless", "wifi-iface",
+uci:foreach("network", "interface",
        function(section)
-               iface:value(section[".name"])
+        if section[".name"] ~= "loopback" then
+            iface:value(section[".name"])
+        end
        end)
 
 ip =  sect_routes:option(Value, "ip", "IP address", "")
@@ -194,7 +259,7 @@ ip:depends("type", "ip")
 ip.datatype = [[ or"ip4addr", "ip6addr" ]]
 
 function m.on_commit(self,map)
-        luci.sys.call('/etc/init.d/bird6 stop; /etc/init.d/bird6 start')
+        luci.sys.exec('/etc/init.d/bird6 restart')
 end
 
 return m