luci/applications/luci-app-pbr/htdocs/luci-static/resources/view/pbr/overview.js

// Copyright 2022 Stan Grishin <stangri@melmac.ca>
// This code wouldn't have been possible without help from [@vsviridov](https://github.com/vsviridov)

"use strict";
"require form";
"require rpc";
"require view";
"require pbr.status as pbr";

var pkg = pbr.pkg;

return view.extend({
	load: function () {
		return Promise.all([
			L.resolveDefault(pbr.getInterfaces(pkg.Name), {}),
			L.resolveDefault(pbr.getPlatformSupport(pkg.Name), {}),
			L.resolveDefault(L.uci.load(pkg.Name), {}),
		]);
	},

	render: function (data) {
		var status, m, s, o;
		var reply = {
			interfaces: (data[0] &&
				data[0][pkg.Name] &&
				data[0][pkg.Name].interfaces) || ["wan"],
			platform: (data[1] && data[1][pkg.Name]) || {
				ipset_installed: null,
				nft_installed: null,
				adguardhome_installed: null,
				dnsmasq_installed: null,
				unbound_installed: null,
				adguardhome_ipset_support: null,
				dnsmasq_ipset_support: null,
				dnsmasq_nftset_support: null,
			},
		};

		status = new pbr.status();
		m = new form.Map(pkg.Name, _("Policy Based Routing - Configuration"));

		s = m.section(form.NamedSection, "config", pkg.Name);
		s.tab("tab_basic", _("Basic Configuration"));
		s.tab(
			"tab_advanced",
			_("Advanced Configuration"),
			_(
				"%sWARNING:%s Please make sure to check the %sREADME%s before changing anything in this section! " +
					"Change any of the settings below with extreme caution!%s"
			).format(
				"<br/>&#160;&#160;&#160;&#160;<b>",
				"</b>",
				'<a href="' +
					pkg.URL +
					'#ServiceConfigurationSettings" target="_blank">',
				"</a>",
				"<br/><br/>"
			)
		);

		s.tab("tab_webui", _("Web UI Configuration"));

		o = s.taboption(
			"tab_basic",
			form.ListValue,
			"verbosity",
			_("Output verbosity"),
			_("Controls both system log and console output verbosity.")
		);
		o.value("0", _("Suppress/No output"));
		o.value("1", _("Condensed output"));
		o.value("2", _("Verbose output"));
		o.default = "2";

		o = s.taboption(
			"tab_basic",
			form.ListValue,
			"strict_enforcement",
			_("Strict enforcement"),
			_("See the %sREADME%s for details.").format(
				'<a href="' + pkg.URL + '#StrictEnforcement" target="_blank">',
				"</a>"
			)
		);
		o.value("0", _("Do not enforce policies when their gateway is down"));
		o.value("1", _("Strictly enforce policies when their gateway is down"));
		o.default = "1";

		var text = "";
		if (reply.platform.dnsmasq_nftset_support === null) {
			text +=
				_("The %s support is unknown.").format("<i>dnsmasq.nftset</i>") +
				"<br />";
		} else if (!reply.platform.dnsmasq_nftset_support) {
			text +=
				_("The %s is not supported on this system.").format(
					"<i>dnsmasq.nftset</i>"
				) + "<br />";
		}
		text += _(
			"Please check the %sREADME%s before changing this option."
		).format(
			'<a href="' + pkg.URL + '#UseResolversSetSupport" target="_blank">',
			"</a>"
		);

		o = s.taboption(
			"tab_basic",
			form.ListValue,
			"resolver_set",
			_("Use resolver set support for domains"),
			text
		);
		o.value("none", _("Disabled"));
		if (reply.platform.adguardhome_ipset_support) {
			o.value("adguardhome.ipset", _("AdGuardHome ipset"));
			o.default = "adguardhome.ipset";
		}
		if (reply.platform.dnsmasq_ipset_support) {
			o.value("dnsmasq.ipset", _("Dnsmasq ipset"));
			o.default = "dnsmasq.ipset";
		}
		if (reply.platform.dnsmasq_nftset_support) {
			o.value("dnsmasq.nftset", _("Dnsmasq nft set"));
			o.default = "dnsmasq.nftset";
		}

		o = s.taboption(
			"tab_basic",
			form.ListValue,
			"ipv6_enabled",
			_("IPv6 Support")
		);
		o.value("0", _("Disabled"));
		o.value("1", _("Enabled"));

		o = s.taboption(
			"tab_advanced",
			form.DynamicList,
			"supported_interface",
			_("Supported Interfaces"),
			_(
				"Allows to specify the list of interface names (in lower case) to be explicitly supported by the service. " +
					"Can be useful if your OpenVPN tunnels have dev option other than tun* or tap* or specific use cases " +
					"of WireGuard servers. See the %sREADME%s for details."
			).format(
				'<a href="' + pkg.URL + '#WireGuardServerUseCases" target="_blank">',
				"</a>"
			)
		);
		o.optional = false;

		o = s.taboption(
			"tab_advanced",
			form.DynamicList,
			"ignored_interface",
			_("Ignored Interfaces"),
			_(
				"Allows to specify the list of interface names (lower case) to be ignored by the service. " +
					"Can be useful for an OpenVPN server running on OpenWrt device. WireGuard servers, which " +
					"have a listen_port defined, are handled automatically, do not add those here." +
					"See the %sREADME%s for details."
			).format(
				'<a href="' + pkg.URL + '#WireGuardServerUseCases" target="_blank">',
				"</a>"
			)
		);
		o.optional = false;

		o = s.taboption(
			"tab_advanced",
			form.ListValue,
			"rule_create_option",
			_("Rule Create option"),
			_("Select Add for -A/add and Insert for -I/Insert.")
		);
		o.value("add", _("Add"));
		o.value("insert", _("Insert"));
		o.default = "add";

		o = s.taboption(
			"tab_advanced",
			form.ListValue,
			"icmp_interface",
			_("Default ICMP Interface"),
			_("Force the ICMP protocol interface.")
		);
		o.value("", _("No Change"));
		reply.interfaces.forEach((element) => {
			if (element.toLowerCase() !== "ignore") {
				o.value(element);
			}
		});
		o.rmempty = true;

		o = s.taboption(
			"tab_advanced",
			form.Value,
			"uplink_mark",
			_("Uplink Interface Table FW Mark"),
			_(
				"Starting (Uplink Interface) FW Mark for marks used by the service. High starting mark is " +
					"used to avoid conflict with SQM/QoS. Change with caution together with"
			) +
				" " +
				_("Service FW Mask") +
				"."
		);
		o.rmempty = true;
		o.placeholder = "010000";
		o.datatype = "hexstring";

		o = s.taboption(
			"tab_advanced",
			form.Value,
			"fw_mask",
			_("Service FW Mask"),
			_(
				"FW Mask used by the service. High mask is used to avoid conflict with SQM/QoS. " +
					"Change with caution together with"
			) +
				" " +
				_("WAN Table FW Mark") +
				"."
		);
		o.rmempty = true;
		o.placeholder = "ff0000";
		o.datatype = "hexstring";

		o = s.taboption(
			"tab_webui",
			form.ListValue,
			"webui_show_ignore_target",
			_("Add Ignore Target"),
			_(
				"Adds 'ignore' to the list of interfaces for policies. See the %sREADME%s for details."
			).format(
				'<a href="' + pkg.URL + '#IgnoreTarget" target="_blank">',
				"</a>"
			)
		);
		o.value("0", _("Disabled"));
		o.value("1", _("Enabled"));
		o.default = "0";
		o.optional = false;

		o = s.taboption(
			"tab_webui",
			form.DynamicList,
			"webui_supported_protocol",
			_("Supported Protocols"),
			_("Display these protocols in protocol column in Web UI.")
		);
		o.optional = false;

		s = m.section(
			form.GridSection,
			"policy",
			_("Policies"),
			_(
				"Name, interface and at least one other field are required. Multiple local and remote " +
					"addresses/devices/domains and ports can be space separated. Placeholders below represent just " +
					"the format/syntax and will not be used if fields are left blank. For more information on options, check the %sREADME%s."
			).format(
				'<a href="' + pkg.URL + '#PolicyOptions" target="_blank">',
				"</a>"
			)
		);
		s.rowcolors = true;
		s.sortable = true;
		s.anonymous = true;
		s.addremove = true;

		o = s.option(form.Flag, "enabled", _("Enabled"));
		o.default = "1";
		o.editable = true;

		o = s.option(form.Value, "name", _("Name"));

		o = s.option(form.Value, "src_addr", _("Local addresses / devices"));
		o.datatype =
			"list(neg(or(cidr,host,ipmask,ipaddr,macaddr,network,string)))";
		o.rmempty = true;
		o.default = "";

		o = s.option(form.Value, "src_port", _("Local ports"));
		o.datatype = "list(neg(or(portrange,port)))";
		o.placeholder = "0-65535";
		o.rmempty = true;
		o.default = "";

		o = s.option(form.Value, "dest_addr", _("Remote addresses / domains"));
		o.datatype =
			"list(neg(or(cidr,host,ipmask,ipaddr,macaddr,network,string)))";
		o.rmempty = true;
		o.default = "";

		o = s.option(form.Value, "dest_port", _("Remote ports"));
		o.datatype = "list(neg(or(portrange,port)))";
		o.placeholder = "0-65535";
		o.rmempty = true;
		o.default = "";

		o = s.option(form.ListValue, "proto", _("Protocol"));
		var proto = L.toArray(
			L.uci.get(pkg.Name, "config", "webui_supported_protocol")
		);
		if (!proto.length) {
			proto = ["all", "tcp", "udp", "tcp udp", "icmp"];
		}
		proto.forEach((element) => {
			if (element === "all") {
				o.value("", _("all"));
				o.default = "";
			} else {
				o.value(element.toLowerCase());
			}
		});
		o.rmempty = true;

		o = s.option(form.ListValue, "chain", _("Chain"));
		o.value("", "prerouting");
		o.value("forward", "forward");
		o.value("input", "input");
		o.value("output", "output");
		o.value("postrouting", "postrouting");
		o.default = "";
		o.rmempty = true;

		o = s.option(form.ListValue, "interface", _("Interface"));
		reply.interfaces.forEach((element) => {
			o.value(element);
		});
		o.datatype = "network";
		o.rmempty = false;

		s = m.section(
			form.GridSection,
			"dns_policy",
			_("DNS Policies"),
			_(
				"Name, local address and remote DNS fields are required. Multiple local " +
					"addresses/devices can be space separated. For more information on options, check the %sREADME%s."
			).format(
				'<a href="' + pkg.URL + '#DNSPolicyOptions" target="_blank">',
				"</a>"
			)
		);
		s.rowcolors = true;
		s.sortable = true;
		s.anonymous = true;
		s.addremove = true;

		o = s.option(form.Flag, "enabled", _("Enabled"));
		o.default = "1";
		o.editable = true;

		o = s.option(form.Value, "name", _("Name"));
		o.optional = false;

		o = s.option(form.Value, "src_addr", _("Local addresses / devices"));
		o.optional = false;
		o.datatype =
			"list(neg(or(cidr,host,ipmask,ipaddr,macaddr,network,string)))";
		o.rmempty = true;
		o.default = "";

		o = s.option(form.Value, "dest_dns", _("Remote DNS"));
		o.optional = false;
		o.rmempty = false;
		o.datatype = "list(or(cidr,host,network,ipaddr))";
		reply.interfaces.forEach((element) => {
			element === "ignore" || o.value(element);
		});

		o = s.option(form.Value, "dest_dns_port", _("Remote DNS Port"));
		o.optional = true;
		o.rmempty = true;
		o.datatype = "port";
		o.default = "53";

		s = m.section(
			form.NamedSection,
			"config",
			pkg.Name,
			_("DSCP Tagging"),
			_(
				"Set DSCP tags (in range between 1 and 63) for specific interfaces. See the %sREADME%s for details."
			).format(
				'<a href="' + pkg.URL + "#DSCPTag-BasedPolicies" + '" target="_blank">',
				"</a>"
			)
		);
		reply.interfaces.forEach((element) => {
			if (element.toLowerCase() !== "ignore") {
				o = s.option(
					form.Value,
					element + "_dscp",
					element.toUpperCase() + " " + _("DSCP Tag")
				);
				o.datatype = "and(uinteger, min(1), max(63))";
			}
		});

		s = m.section(
			form.GridSection,
			"include",
			_("Custom User File Includes"),
			_(
				"Run the following user files after setting up but before restarting DNSMASQ. " +
					"See the %sREADME%s for details."
			).format(
				'<a href="' + pkg.URL + '#CustomUserFiles" target="_blank">',
				"</a>"
			)
		);
		s.sortable = true;
		s.anonymous = true;
		s.addremove = true;

		o = s.option(form.Flag, "enabled", _("Enabled"));
		o.optional = false;
		o.editable = true;
		o.rmempty = false;

		o = s.option(form.Value, "path", _("Path"));
		o.optional = false;
		o.editable = true;
		o.rmempty = false;

		return Promise.all([status.render(), m.render()]);
	},
});