path: root/applications/luci-app-adblock-fast/htdocs/luci-static/resources/view/adblock-fast/overview.js

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

"use strict";
"require form";
"require view";
"require adblock-fast.status as adb";

var pkg = {
	get Name() {
		return "adblock-fast";
	},
	get URL() {
		return "https://docs.openwrt.melmac.net/" + pkg.Name + "/";
	},
	humanFileSize: function (bytes, si = false, dp = 2) {
		return `%${si ? 1000 : 1024}.${dp ?? 0}mB`.format(bytes);
	},
};

return view.extend({
	load: function () {
		return Promise.all([
			L.resolveDefault(adb.getFileUrlFilesizes(pkg.Name), {}),
			L.resolveDefault(adb.getPlatformSupport(pkg.Name), {}),
			L.resolveDefault(L.uci.load(pkg.Name), {}),
			L.resolveDefault(L.uci.load("dhcp"), {}),
			L.resolveDefault(L.uci.load("smartdns"), {}),
		]);
	},

	render: function (data) {
		var reply = {
			sizes: (data[0] && data[0][pkg.Name] && data[0][pkg.Name]["sizes"]) || [],
			platform: (data[1] && data[1][pkg.Name]) || {
				ipset_installed: false,
				nft_installed: false,
				dnsmasq_installed: false,
				dnsmasq_ipset_support: false,
				dnsmasq_nftset_support: false,
				smartdns_installed: false,
				smartdns_ipset_support: false,
				smartdns_nftset_support: false,
				unbound_installed: false,
				leds: [],
			},
		};
		var status, m, s1, s2, s3, o;

		status = new adb.status();
		m = new form.Map(pkg.Name, _("AdBlock-Fast - Configuration"));
		s1 = m.section(form.NamedSection, "config", pkg.Name);
		s1.tab("tab_basic", _("Basic Configuration"));
		s1.tab("tab_advanced", _("Advanced Configuration"));

		var text = _(
			"DNS resolution option, see the %sREADME%s for details."
		).format(
			'<a href="' + pkg.URL + '#dns-resolver-option" target="_blank">',
			"</a>"
		);
		if (!reply.platform.dnsmasq_installed) {
			text +=
				"<br />" +
				_("Please note that %s is not supported on this system.").format(
					"<i>dnsmasq.addnhosts</i>"
				);
			text +=
				"<br />" +
				_("Please note that %s is not supported on this system.").format(
					"<i>dnsmasq.conf</i>"
				);
			text +=
				"<br />" +
				_("Please note that %s is not supported on this system.").format(
					"<i>dnsmasq.ipset</i>"
				);
			text +=
				"<br />" +
				_("Please note that %s is not supported on this system.").format(
					"<i>dnsmasq.servers</i>"
				);
		} else {
			if (!reply.platform.dnsmasq_ipset_support) {
				text +=
					"<br />" +
					_("Please note that %s is not supported on this system.").format(
						"<i>dnsmasq.ipset</i>"
					);
			}
			if (!reply.platform.dnsmasq_nftset_support) {
				text +=
					"<br />" +
					_("Please note that %s is not supported on this system.").format(
						"<i>dnsmasq.nftset</i>"
					);
			}
		}
		if (!reply.platform.smartdns_installed) {
			text =
				text +
				"<br />" +
				_("Please note that %s is not supported on this system.").format(
					"<i>smartdns.domainset</i>"
				);
		} else {
			if (!reply.platform.smartdns_ipset_support) {
				text +=
					"<br />" +
					_("Please note that %s is not supported on this system.").format(
						"<i>smartdns.ipset</i>"
					);
			}
			if (!reply.platform.smartdns_nftset_support) {
				text +=
					"<br />" +
					_("Please note that %s is not supported on this system.").format(
						"<i>smartdns.nftset</i>"
					);
			}
		}
		if (!reply.platform.unbound_installed) {
			text =
				text +
				"<br />" +
				_("Please note that %s is not supported on this system.").format(
					"<i>unbound.adb_list</i>"
				);
		}

		o = s1.taboption(
			"tab_basic",
			form.ListValue,
			"dns",
			_("DNS Service"),
			text
		);
		if (reply.platform.dnsmasq_installed) {
			o.value("dnsmasq.addnhosts", _("dnsmasq additional hosts"));
			o.value("dnsmasq.conf", _("dnsmasq config"));
			if (reply.platform.dnsmasq_ipset_support) {
				o.value("dnsmasq.ipset", _("dnsmasq ipset"));
			}
			if (reply.platform.dnsmasq_nftset_support) {
				o.value("dnsmasq.nftset", _("dnsmasq nft set"));
			}
			o.value("dnsmasq.servers", _("dnsmasq servers file"));
		}
		if (reply.platform.smartdns_installed) {
			o.value("smartdns.domainset", _("smartdns domain set"));
			if (reply.platform.smartdns_ipset_support) {
				o.value("smartdns.ipset", _("smartdns ipset"));
			}
			if (reply.platform.smartdns_nftset_support) {
				o.value("smartdns.nftset", _("smartdns nft set"));
			}
		}
		if (reply.platform.unbound_installed) {
			o.value("unbound.adb_list", _("unbound adblock list"));
		}
		o.default = "dnsmasq.servers";

		o = s1.taboption(
			"tab_basic",
			form.Value,
			"dnsmasq_config_file_url",
			_("Dnsmasq Config File URL"),
			_(
				"URL to the external dnsmasq config file, see the %sREADME%s for details."
			).format(
				'<a href="' + pkg.URL + '#dnsmasq_config_file_url" target="_blank">',
				"</a>"
			)
		);
		o.depends("dns", "dnsmasq.conf");

		o = s1.taboption(
			"tab_basic",
			form.ListValue,
			"dnsmasq_instance_option",
			_("Use AdBlocking on the dnsmasq instance(s)"),
			_(
				"You can limit the AdBlocking to the specific dnsmasq instance(s) (%smore information%s)."
			).format(
				'<a href="' + pkg.URL + "#dnsmasq_instance" + '" target="_blank">',
				"</a>"
			)
		);
		o.value("*", _("AdBlock on all instances"));
		o.value("+", _("AdBlock on select instances"));
		o.value("-", _("No AdBlock on dnsmasq"));
		o.default = "*";
		o.depends("dns", "dnsmasq.addnhosts");
		o.depends("dns", "dnsmasq.servers");
		o.retain = true;
		o.cfgvalue = function (section_id) {
			let val = this.map.data.get(
				this.map.config,
				section_id,
				"dnsmasq_instance"
			);
			switch (val) {
				case "*":
				case "-":
					return val;
				default:
					return "+";
			}
		};
		o.write = function (section_id, formvalue) {
			L.uci.set(pkg.Name, section_id, "dnsmasq_instance", formvalue);
		};

		o = s1.taboption(
			"tab_basic",
			form.MultiValue,
			"dnsmasq_instance",
			_("Pick the dnsmasq instance(s) for AdBlocking")
		);
		Object.values(L.uci.sections("dhcp", "dnsmasq")).forEach(function (
			element
		) {
			var description;
			var key;
			if (element[".name"] === L.uci.resolveSID("dhcp", element[".name"])) {
				key = element[".index"];
				description = "dnsmasq[" + element[".index"] + "]";
			} else {
				key = element[".name"];
				description = element[".name"];
			}
			o.value(key, _("%s").format(description));
		});
		o.depends("dnsmasq_instance_option", "+");
		o.retain = true;

		o = s1.taboption(
			"tab_basic",
			form.ListValue,
			"smartdns_instance_option",
			_("Use AdBlocking on the SmartDNS instance(s)"),
			_(
				"You can limit the AdBlocking to the specific SmartDNS instance(s) (%smore information%s)."
			).format(
				'<a href="' + pkg.URL + "#smartdns_instance" + '" target="_blank">',
				"</a>"
			)
		);
		o.value("*", _("AdBlock on all instances"));
		o.value("+", _("AdBlock on select instances"));
		o.value("-", _("No AdBlock on SmartDNS"));
		o.default = "*";
		o.depends("dns", "smartdns.domainset");
		o.depends("dns", "smartdns.ipset");
		o.depends("dns", "smartdns.nftset");
		o.retain = true;
		o.cfgvalue = function (section_id) {
			let val = this.map.data.get(
				this.map.config,
				section_id,
				"smartdns_instance"
			);
			switch (val) {
				case "*":
				case "-":
					return val;
				default:
					return "+";
			}
		};
		o.write = function (section_id, formvalue) {
			L.uci.set(pkg.Name, section_id, "smartdns_instance", formvalue);
		};

		o = s1.taboption(
			"tab_basic",
			form.MultiValue,
			"smartdns_instance",
			_("Pick the SmartDNS instance(s) for AdBlocking")
		);
		Object.values(L.uci.sections("smartdns", "smartdns")).forEach(function (
			element
		) {
			var description;
			var key;
			if (element[".name"] === L.uci.resolveSID("smartdns", element[".name"])) {
				key = element[".index"];
				description = "smartdns[" + element[".index"] + "]";
			} else {
				key = element[".name"];
				description = element[".name"];
			}
			o.value(key, _("%s").format(description));
		});
		o.depends("smartdns_instance_option", "+");
		o.retain = true;

		o = s1.taboption(
			"tab_basic",
			form.ListValue,
			"force_dns",
			_("Force Router DNS"),
			_("Forces Router DNS use on local devices, also known as DNS Hijacking.")
		);
		o.value("0", _("Let local devices use their own DNS servers if set"));
		o.value("1", _("Force Router DNS server to all local devices"));
		o.default = "1";

		o = s1.taboption(
			"tab_basic",
			form.ListValue,
			"verbosity",
			_("Output Verbosity Setting"),
			_("Controls system log and console output verbosity.")
		);
		o.value("0", _("Suppress output"));
		o.value("1", _("Some output"));
		o.value("2", _("Verbose output"));
		o.default = "2";

		if (reply.platform.leds.length) {
			o = s1.taboption(
				"tab_basic",
				form.ListValue,
				"led",
				_("LED to indicate status"),
				_(
					"Pick the LED not already used in %sSystem LED Configuration%s."
				).format('<a href="' + L.url("admin", "system", "leds") + '">', "</a>")
			);
			o.value("", _("none"));
			reply.platform.leds.forEach((element) => {
				o.value(element);
			});
		}

		o = s1.taboption(
			"tab_advanced",
			form.ListValue,
			"config_update_enabled",
			_("Automatic Config Update"),
			_("Perform config update before downloading the block/allow-lists.")
		);
		o.value("0", _("Disable"));
		o.value("1", _("Enable"));
		o.default = "0";

		o = s1.taboption(
			"tab_advanced",
			form.ListValue,
			"ipv6_enabled",
			_("IPv6 Support"),
			_("Add IPv6 entries to block-list.")
		);
		o.value("", _("Do not add IPv6 entries"));
		o.value("1", _("Add IPv6 entries"));
		o.depends("dns", "dnsmasq.addnhosts");
		o.depends("dns", "dnsmasq.nftset");
		o.default = "";
		o.rmempty = true;
		o.retain = true;

		o = s1.taboption(
			"tab_advanced",
			form.Value,
			"download_timeout",
			_("Download time-out (in seconds)"),
			_("Stop the download if it is stalled for set number of seconds.")
		);
		o.default = "20";
		o.datatype = "range(1,60)";

		o = s1.taboption(
			"tab_advanced",
			form.Value,
			"curl_max_file_size",
			_("Curl maximum file size (in bytes)"),
			_(
				"If curl is installed and detected, it would not download files bigger than this."
			)
		);
		o.default = "";
		o.datatype = "uinteger";
		o.rmempty = true;

		o = s1.taboption(
			"tab_advanced",
			form.Value,
			"curl_retry",
			_("Curl download retry"),
			_(
				"If curl is installed and detected, it would retry download this many times on timeout/fail."
			)
		);
		o.default = "3";
		o.datatype = "range(0,30)";

		o = s1.taboption(
			"tab_advanced",
			form.ListValue,
			"parallel_downloads",
			_("Simultaneous processing"),
			_(
				"Launch all lists downloads and processing simultaneously, reducing service start time."
			)
		);
		o.value("0", _("Do not use simultaneous processing"));
		o.value("1", _("Use simultaneous processing"));
		o.default = "1";

		o = s1.taboption(
			"tab_advanced",
			form.ListValue,
			"compressed_cache",
			_("Store compressed cache file on router"),
			_(
				"Attempt to create a compressed cache of block-list in the persistent memory."
			)
		);
		o.value("0", _("Do not store compressed cache"));
		o.value("1", _("Store compressed cache"));
		o.default = "0";

		o = s1.taboption(
			"tab_advanced",
			form.Value,
			"compressed_cache_dir",
			_("Directory for compressed cache file"),
			_(
				"Directory for compressed cache file of block-list in the persistent memory."
			)
		);
		o.datatype = "string";
		o.rmempty = true;
		o.default = "/etc";
		o.depends("compressed_cache", "1");
		o.retain = true;

		o = s1.taboption(
			"tab_advanced",
			form.ListValue,
			"debug",
			_("Enable Debugging"),
			_("Enables debug output to /tmp/adblock-fast.log.")
		);
		o.value("0", _("Disable Debugging"));
		o.value("1", _("Enable Debugging"));
		o.default = "0";

		s2 = m.section(
			form.NamedSection,
			"config",
			"adblock-fast",
			_("AdBlock-Fast - Allowed and Blocked Domains")
		);
		o.addremove = true;
		o.rmempty = true;

		o = s2.option(
			form.DynamicList,
			"allowed_domain",
			_("Allowed Domains"),
			_("Individual domains to be allowed.")
		);
		o.addremove = true;

		o = s2.option(
			form.DynamicList,
			"blocked_domain",
			_("Blocked Domains"),
			_("Individual domains to be blocked.")
		);
		o.addremove = true;

		s3 = m.section(
			form.GridSection,
			"file_url",
			_("AdBlock-Fast - Allowed and Blocked Lists URLs"),
			_("URLs to file(s) containing lists to be allowed or blocked.")
		);
		s3.rowcolors = true;
		s3.sortable = true;
		s3.anonymous = true;
		s3.addremove = true;

		o = s3.option(form.DummyValue, "_size", _("Size"));
		o.modalonly = false;
		o.cfgvalue = function (section_id) {
			let url = L.uci.get(pkg.Name, section_id, "url");
			let ret = _("Unknown");
			reply.sizes.forEach((element) => {
				if (element.url === url) {
					ret = element.size === 0 ? ret : pkg.humanFileSize(element.size);
				}
			});
			return _("Size: %s").format(ret);
		};

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

		o = s3.option(form.ListValue, "action", _("Action"));
		o.value("allow", _("Allow"));
		o.value("block", _("Block"));
		o.default = "block";
		o.textvalue = function (section_id) {
			var val = this.cfgvalue(section_id);
			return val == "allow" ? _("Allow") : _("Block");
		};

		o = s3.option(form.Value, "url", _("URL"));
		o.optional = false;

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