luci-mod-network: DHCP tabs redesign phase 2 #7178

systemcrash · 2024-06-27T21:12:31Z

This is a continuation of the work done in #6705. It implements GUI for dnsmasq based tags. Tags can trigger DHCP options (to be sent in DHCP responses), and vice-versa: DHCP client options and properties e.g. MAC/Vendor/User Class can trigger creation of tags. Recommended for users who know what they are doing, since invalid option:value combos can crash dnsmasq.

To describe tags succinctly is a challenge, such that a newcomer understands them more deeply, since they operate in two domains: ingress and egress. I spent a while coming up with the current descriptions. Suggestions welcome, but modifier beware. Syntax and descriptions are terse since you are expected to know what options and values you need.

Note: tags are still called 'networkid' in the dnsmasq.init script, which is really old terminology and should be updated. Current dnsmasq manpage and docu details 'tags' as the current terminology with little more than a footnote mentioning networkid any more.

This PR is not from my main or master branch 💩, but a separate branch ✅
Each commit has a valid ✒️ Signed-off-by: <my@email.address> row (via git commit --signoff)
Each commit and PR title has a valid 📝 <package name>: title first line subject for packages
Tested on: 23.05.3
( Preferred ) Screenshot or mp4 of changes:
Description: (describe the changes proposed in this PR)

dhcp-phase2.mp4

Signed-off-by: Paul Donald <newtwen+github@gmail.com>

tag names shall not match: - network devices/interfaces - service names Signed-off-by: Paul Donald <newtwen+github@gmail.com>

feckert · 2024-06-28T06:20:19Z

modules/luci-mod-network/htdocs/luci-static/resources/view/network/dhcp.js

+			_('Options to be added for this tag.'));
+		so.rmempty = true;
+		so.optional = true;
+		so.placeholder = '3,192.168.10.1,10.10.10.1';


Wouldn't it be nice to add a validation there so that a combination of wrong option doesn't crach the dnsmasq?

Or even better can we not abstract this further without having to look up in the documentation of dnsmasq what option for example '3' exactly means?

Maybe code golf one day.

But the user is nevertheless expected to know what settings they need. (There are lots of them).

feckert · 2024-06-28T06:30:57Z

modules/luci-mod-network/htdocs/luci-static/resources/view/network/dhcp.js

+		so.rmempty = false;
+		so.optional = false;
+
+		so = ss.option(form.Value, 'networkid', _('Set this Tag'));


should we not replace this string Set this Tag with string ... To this matching Tag, then it would remain consistent.

In short: no. That would change the meaning of how this tag tab works.

feckert · 2024-06-28T06:39:37Z

modules/luci-mod-network/htdocs/luci-static/resources/view/network/dhcp.js

+		ss.rowcolors = true;
+
+		so = ss.option(form.DynamicList, 'dhcp_option',
+			_('Apply these DHCP Options...'),


Since it is a table I would prefer that we change the following strings Apply these DHCP Options... and ... To this matching Tag. This text should not be seen as a sentence. Maybe this can`t be translated like this in other languages.

Apply these DHCP Options... -> DHCP options
... To this matching Tag -> Matching tag

Other languages are very capable of expressing this. I want these settings to be abundantly clear, because tags are evidently tough to grasp.

feckert · 2024-06-28T06:39:46Z

modules/luci-mod-network/htdocs/luci-static/resources/view/network/dhcp.js

+		so.optional = true;
+		so.placeholder = '3,192.168.10.1,10.10.10.1';
+
+		so = ss.option(form.Value, 'tag', _('...To this matching Tag'));


Change text ...To this matching Tag?
See above.

That would confuse its meaning (implying how tags are used here)

feckert · 2024-06-28T06:45:57Z

modules/luci-mod-network/htdocs/luci-static/resources/view/network/dhcp.js

+		ss.modaltitle = _('Edit Match');
+		ss.rowcolors = true;
+
+		so = ss.option(form.Value, 'match', _('Match this client option(+value)...'));


I'm not sure whether we can form a sentence from the table headings in all languages.

Match this client option(+value)... to Matching client option
...to Set this Tag to Setting tag

I chose verb here as more concrete than gerund. Setting tag becomes very confusing. Is it a noun? No - it isn't. It is not an instantiation either. It needs to describe the action.

feckert · 2024-06-28T06:46:06Z

modules/luci-mod-network/htdocs/luci-static/resources/view/network/dhcp.js

+		so.optional = false;
+		so.placeholder = '61,8c:80:90:01:02:03';
+
+		so = ss.option(form.Value, 'networkid', _('...to Set this Tag'));


...to: this is to say: in order to. There is a clear consequence. Cause and effect.

feckert · 2024-06-28T06:47:44Z

modules/luci-mod-network/htdocs/luci-static/resources/view/network/dhcp.js

+		ss.modaltitle = _('Edit UC');
+		ss.rowcolors = true;
+
+		so = ss.option(form.Value, 'userclass', _('Match User Class...'));


I'm not sure whether we can form a sentence from the table headings in all languages.

Match User Class... to Matching user class
...to Set this Tag to Setting tag

See previous comment about gerund vs verb.

feckert · 2024-06-28T06:47:53Z

modules/luci-mod-network/htdocs/luci-static/resources/view/network/dhcp.js

+		so.rmempty = false;
+		so.optional = false;
+
+		so = ss.option(form.Value, 'networkid', _('...to set this Tag'));


See previous :)

feckert · 2024-06-28T06:48:54Z

modules/luci-mod-network/htdocs/luci-static/resources/view/network/dhcp.js

+		ss.modaltitle = _('Edit VC');
+		ss.rowcolors = true;
+
+		so = ss.option(form.Value, 'vendorclass', _('Match Vendor Class...'));


I'm not sure whether we can form a sentence from the table headings in all languages.

Match Vendor Class... to Matching vendor class
...to Set this Tag to Setting tag

Translators do a fine job.

feckert · 2024-06-28T06:49:01Z

modules/luci-mod-network/htdocs/luci-static/resources/view/network/dhcp.js

+		so.rmempty = false;
+		so.optional = false;
+
+		so = ss.option(form.Value, 'networkid', _('...to set this Tag'));


systemcrash · 2024-06-28T15:14:33Z

Thanks for the ideas @feckert. Tags are difficult...

Signed-off-by: Paul Donald <newtwen+github@gmail.com>

This regards the confusingly named 'match' entries. Signed-off-by: Paul Donald <newtwen+github@gmail.com>

Signed-off-by: Paul Donald <newtwen+github@gmail.com>

jjm2473 · 2024-12-04T15:25:21Z

modules/luci-mod-network/htdocs/luci-static/resources/view/network/dhcp.js

+		so.optional = true;
+		so.placeholder = '3,192.168.10.1,10.10.10.1';
+
+		so = ss.option(form.Value, 'tag', _('...To this matching Tag'));


There is not 'tag' option, 'tag' is actually the section name: https://github.com/openwrt/openwrt/blob/a9ff3ba24b9466d9c06b9a9e1c2e9672bdd9f6f9/package/network/services/dnsmasq/files/dnsmasq.init#L461

systemcrash added 3 commits June 27, 2024 21:04

luci-mod-network: Add MAC tab.

289a9ff

Signed-off-by: Paul Donald <newtwen+github@gmail.com>

luci-mod-network: Add Match Tags (via matching Opt+Val) tab.

dfb2875

Signed-off-by: Paul Donald <newtwen+github@gmail.com>

luci-mod-network: Match Tags tab: validate tag names

8b075b5

tag names shall not match: - network devices/interfaces - service names Signed-off-by: Paul Donald <newtwen+github@gmail.com>

feckert reviewed Jun 28, 2024

View reviewed changes

systemcrash mentioned this pull request Jun 30, 2024

luci-mod-network: dhcp tags improvements #6840

Closed

systemcrash added 4 commits July 16, 2024 16:29

luci-mod-network: Add VendorClass tab.

8acbb3d

Signed-off-by: Paul Donald <newtwen+github@gmail.com>

luci-mod-network: Add UserClass tab.

8438cfc

Signed-off-by: Paul Donald <newtwen+github@gmail.com>

luci-mod-network: Add Set Tags (via Match (Option+Value)) tab.

4dcadf0

This regards the confusingly named 'match' entries. Signed-off-by: Paul Donald <newtwen+github@gmail.com>

luci-mod-network: merge tag related tabs under Tags tab

c8acf94

Signed-off-by: Paul Donald <newtwen+github@gmail.com>

systemcrash force-pushed the dhcp_redesign_phase2 branch from 02fe101 to c8acf94 Compare July 16, 2024 14:31

jjm2473 reviewed Dec 4, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

luci-mod-network: DHCP tabs redesign phase 2 #7178

luci-mod-network: DHCP tabs redesign phase 2 #7178

systemcrash commented Jun 27, 2024

feckert Jun 28, 2024

systemcrash Jun 28, 2024

feckert Jun 28, 2024

systemcrash Jun 28, 2024

feckert Jun 28, 2024

systemcrash Jun 28, 2024

feckert Jun 28, 2024

systemcrash Jun 28, 2024

feckert Jun 28, 2024

systemcrash Jun 28, 2024

feckert Jun 28, 2024

systemcrash Jun 28, 2024

feckert Jun 28, 2024

systemcrash Jun 28, 2024

feckert Jun 28, 2024

systemcrash Jun 28, 2024

feckert Jun 28, 2024

systemcrash Jun 28, 2024

feckert Jun 28, 2024

systemcrash commented Jun 28, 2024

jjm2473 Dec 4, 2024

luci-mod-network: DHCP tabs redesign phase 2 #7178

Are you sure you want to change the base?

luci-mod-network: DHCP tabs redesign phase 2 #7178

Conversation

systemcrash commented Jun 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

systemcrash commented Jun 28, 2024

Choose a reason for hiding this comment