luci-app-adguardhome: Add new app #5853

cricalix · 2022-06-25T19:14:46Z

Summary

There is no integration into the web UI for AdGuard Home. This PR adds

A Lua script for rpcd to interface with the AGH REST API
ACL controls allowing JS code to call rpcd, uci, logread
Menu entries to put AdGuard Home under Services
Three UIs - status, logs, config

The Lua script supports three API calls:

get_status - maps to /control/status in the AGH REST API
get_statistics - maps to /control/stats in the AGH REST API
get_config - converts /etc/adguardhome.yaml to JSON

Authentication details must be provided by the user, as the password in the YAML file is encrypted. This results in the AGH password being stored cleartext in /etc/config/adguardhome.

The Lua script will log if it encounters an error, in an effort to make it easier to debug. These logs are visible in the Logs UI of the application.

Testing

I could not find any unit testing for things like the UI or the Lua code, so the only testing done was by hand.

The credentials were removed from the config, and both the ubus call and the web UI render the failure to acquire the credentials.

Incorrect credentials were supplied, and the UI was verified as showing a RPC error message.

ACLs were checked by removing luci-compat.json (which wildcard allows saving/reading), and ensuring that the UI could read and save the config.

Package was built and tested with

 make package/luci-app-adguardhome/compile  -j20
 scp bin/packages/i386_pentium4/cricalixluci/luci-app-adguardhome_unknown_all.ipk root@192.168.0.1:
 ssh root@192.168.0.1
 opkg remove luci-app-adguardhome && opkg install luci-app-adguardhome_unknown_all.ipk && rm luci-app-adguardhome_unknown_all.ipk

and then browsing the UI to make sure the deployment was clean and behaved as expected.

Signed-off-by: Duncan Hill github.com@cricalix.net

cricalix · 2022-06-25T19:16:45Z

What's missing is translations; I haven't worked out how to set up the master template for that yet.

jow- · 2022-06-25T20:10:39Z

./build/i18n-scan.pl applications/luci-app-adguardhome/ > applications/luci-app-adguardhome/po/templates/adguardhome.pot

cricalix · 2022-06-26T06:42:33Z

./build/i18n-scan.pl applications/luci-app-adguardhome/ > applications/luci-app-adguardhome/po/templates/adguardhome.pot

Thanks @jow- ; done and squashed in.

cricalix · 2022-06-27T13:57:55Z

OpenWrt2020

Status

Logs

Configuration

BootstrapDark

Status

Logs

Configuration

Material

Status

Logs

Configuration

There is no integration into the web UI for AdGuard Home. This PR adds * A Lua script for rpcd to interface with the AGH REST API * ACL controls allowing JS code to call rpcd, uci, logread * Menu entries to put AdGuard Home under Services * Three UIs - status, logs, config The Lua script supports three API calls: * get_status - maps to /control/status in the AGH REST API * get_statistics - maps to /control/stats in the AGH REST API * get_config - converts /etc/adguardhome.yaml to JSON Authentication details must be provided by the user, as the password in the YAML file is encrypted. This results in the AGH password being stored cleartext in /etc/config/adguardhome. The Lua script will log if it encounters an error, in an effort to make it easier to debug. These logs are visible in the Logs UI of the application. I could not find any unit testing for things like the UI or the Lua code, so the only testing done was by hand. The credentials were removed from the config, and both the ubus call and the web UI render the failure to acquire the credentials. Incorrect credentials were supplied, and the UI was verified as showing a RPC error message. ACLs were checked by removing luci-compat.json (which wildcard allows saving/reading), and ensuring that the UI could read and save the config. Package was built and tested with ``` make package/luci-app-adguardhome/compile -j20 scp bin/packages/i386_pentium4/cricalixluci/luci-app-adguardhome_unknown_all.ipk root@192.168.0.1: ssh root@192.168.0.1 opkg remove luci-app-adguardhome && opkg install luci-app-adguardhome_unknown_all.ipk && rm luci-app-adguardhome_unknown_all.ipk ``` and then browsing the UI to make sure the deployment was clean and behaved as expected. Signed-off-by: Duncan Hill <openwrt-dev@cricalix.net>

systemcrash · 2022-10-05T13:29:17Z

Can't this go in, as-is?

cricalix · 2023-06-16T19:44:55Z

Can't this go in, as-is?

I would have thought so, but apparently no one responsible for luci agrees (or has seen this PR).

systemcrash · 2023-12-04T02:17:18Z

OK by me, if you commit to keeping this working. Have you verified this works with the latest (master, 23.05)? Could you please summarize what the LUA does?

systemcrash · 2023-12-04T02:18:35Z

If possible, remove those merge commits, and just rebase your original commits onto a current master.

systemcrash · 2023-12-30T23:47:32Z

ping @cricalix

cricalix · 2024-01-06T08:56:16Z

ping @cricalix

Yeah, back now. Christmas period was very busy with an international move in play.

Let me work out how to remove merge commits; not used to Github/git - use Mercurial in my day-to-day work.

Happy to keep it supported as LuCI/OpenWrt move onwards.

What kind of clarification on the Lua do you want to see, and where (inline, README, other)?

…t on 23.05, format code

cricalix · 2024-01-06T18:07:57Z

root@OpenWrt:~# opkg install luci-app-adguardhome_git-23.217.49857-0efa0b3_all.ipk 
Installing luci-app-adguardhome (git-23.217.49857-0efa0b3) to root...
Installing luasocket (3.1.0-1) to root...
Downloading https://downloads.openwrt.org/releases/23.05.2/packages/x86_64/packages/luasocket_3.1.0-1_x86_64.ipk
Installing libyaml (0.2.5-1) to root...
Downloading https://downloads.openwrt.org/releases/23.05.2/packages/x86_64/packages/libyaml_0.2.5-1_x86_64.ipk
Installing lyaml (6.2.7-2) to root...
Downloading https://downloads.openwrt.org/releases/23.05.2/packages/x86_64/packages/lyaml_6.2.7-2_x86_64.ipk
Configuring luasocket.
Configuring libyaml.
Configuring lyaml.
Configuring luci-app-adguardhome.

Testing config file parsing failure handling:

Page renders on 23.05 with update for AGH config changes:

stangri · 2024-01-06T19:03:17Z

@jow- are you OK with the lua dependency in the new luci package?

cricalix · 2024-01-07T13:32:37Z

If there are other preferred languages, I can probably rewrite the RPC portion (though it depends if I have to go learn that language first). At the time this was first offered, the example app and a lot of other apps used Lua for the RPC side.

cricalix · 2024-01-07T17:02:36Z

I also get the feeling that, to pass "Test formalities", I should probably just take all the code in this PR, export it out, and start a new PR with a single commit (and a pointer to this PR for discussion history). I don't see how I can fix the intermediate commits to have the right prefix, and a signed-off line.

stangri · 2024-01-07T22:14:29Z

If there are other preferred languages, I can probably rewrite the RPC portion (though it depends if I have to go learn that language first). At the time this was first offered, the example app and a lot of other apps used Lua for the RPC side.

As far as I understand, the ucode or shell script are preferred as there's a goal of decreasing dependency on lua. I know the new luci apps are not accepted if the WebUI is written in lua, not sure what the policy is for use of lua in the RPCD scripts.

systemcrash · 2024-01-07T22:27:01Z

I'd draw the line at fixes (ok) but not new features. To be fair, I do not master either, so let testing be the judge. This way the code should survive a decade until the next paradigm comes along. Perhaps legislation will change how ads happen and how they're tackled.

cricalix · 2024-01-13T08:23:27Z

As far as I understand, the ucode or shell script are preferred as there's a goal of decreasing dependency on lua. I know the new luci apps are not accepted if the WebUI is written in lua, not sure what the policy is for use of lua in the RPCD scripts.

Parsing yaml in shell will be unfun. Ditto in ucode, which doesn't appear to have yaml support (given the origins, why would it?). Python would be trivial (if you're running AGH on OpenWrt, you're probably on a device with enough CPU to run a small Python script quickly enough).

MkQtS · 2024-01-13T16:10:50Z

Parsing yaml in shell will be unfun

How about using yq?

systemcrash · 2024-07-26T00:41:18Z

Hi @cricalix if you can amend your commits to correct the subject lines, we can merge this. Also remove merge commits, just rebase on master.

cricalix force-pushed the luci-app-adguardhome branch from 51d2f6a to a9ff41e Compare June 26, 2022 06:41

cricalix force-pushed the luci-app-adguardhome branch 5 times, most recently from ae97242 to 6e51693 Compare June 27, 2022 12:53

cricalix changed the title ~~Add new LuCI app - luci-app-adguardhome~~ luci-app-adguardhome: Add new app Jun 27, 2022

cricalix force-pushed the luci-app-adguardhome branch from 6e51693 to ace79f8 Compare June 27, 2022 13:03

cricalix marked this pull request as draft June 27, 2022 13:24

cricalix force-pushed the luci-app-adguardhome branch from ace79f8 to ac9827a Compare June 27, 2022 13:47

cricalix marked this pull request as ready for review June 27, 2022 13:47

cricalix force-pushed the luci-app-adguardhome branch from ac9827a to 3253c26 Compare June 27, 2022 16:57

aparcar mentioned this pull request Feb 4, 2023

Unsupported package(s): luci-app-argon-config, luci-app-adguardhome, luci-theme-argon openwrt/asu#385

Closed

Merge branch 'openwrt:master' into luci-app-adguardhome

913cb4f

cricalix and others added 2 commits August 5, 2023 14:50

Use lua-language-server, clean up warnings, docs

0efa0b3

Merge branch 'openwrt:master' into luci-app-adguardhome

f6f18a3

systemcrash added feature pull request adding a new feature Work needed Needs work by the pullrequest creator labels Dec 5, 2023

Merge branch 'openwrt:master' into luci-app-adguardhome

2d6502c

Rebase on recent pull, update README, handle new AGH config file, tes…

04effa4

…t on 23.05, format code

Update translations

903e9ad

stangri requested a review from jow- January 13, 2024 17:43

systemcrash removed the request for review from jow- July 26, 2024 00:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

luci-app-adguardhome: Add new app #5853

luci-app-adguardhome: Add new app #5853

cricalix commented Jun 25, 2022 •

edited

Loading

cricalix commented Jun 25, 2022

jow- commented Jun 25, 2022 •

edited

Loading

cricalix commented Jun 26, 2022

cricalix commented Jun 27, 2022

systemcrash commented Oct 5, 2022

cricalix commented Jun 16, 2023

systemcrash commented Dec 4, 2023

systemcrash commented Dec 4, 2023

systemcrash commented Dec 30, 2023

cricalix commented Jan 6, 2024

cricalix commented Jan 6, 2024

stangri commented Jan 6, 2024

cricalix commented Jan 7, 2024

cricalix commented Jan 7, 2024

stangri commented Jan 7, 2024

systemcrash commented Jan 7, 2024 via email

cricalix commented Jan 13, 2024

MkQtS commented Jan 13, 2024

systemcrash commented Jul 26, 2024 •

edited

Loading

luci-app-adguardhome: Add new app #5853

Are you sure you want to change the base?

luci-app-adguardhome: Add new app #5853

Conversation

cricalix commented Jun 25, 2022 • edited Loading

Summary

Testing

cricalix commented Jun 25, 2022

jow- commented Jun 25, 2022 • edited Loading

cricalix commented Jun 26, 2022

cricalix commented Jun 27, 2022

OpenWrt2020

BootstrapDark

Material

systemcrash commented Oct 5, 2022

cricalix commented Jun 16, 2023

systemcrash commented Dec 4, 2023

systemcrash commented Dec 4, 2023

systemcrash commented Dec 30, 2023

cricalix commented Jan 6, 2024

cricalix commented Jan 6, 2024

stangri commented Jan 6, 2024

cricalix commented Jan 7, 2024

cricalix commented Jan 7, 2024

stangri commented Jan 7, 2024

systemcrash commented Jan 7, 2024 via email

cricalix commented Jan 13, 2024

MkQtS commented Jan 13, 2024

systemcrash commented Jul 26, 2024 • edited Loading

cricalix commented Jun 25, 2022 •

edited

Loading

jow- commented Jun 25, 2022 •

edited

Loading

systemcrash commented Jul 26, 2024 •

edited

Loading