help: add config to hide server host from help listing #1459
Conversation
|
Fiiinee.. |
HumorBaby
force-pushed
the
feat-help-hide-server
branch
from
bd837da
to
1c30b70
Compare
HumorBaby
force-pushed
the
feat-help-hide-server
branch
2 times, most recently
from
d9816b8
to
1f87da9
Compare
There was a problem hiding this comment.
OK, I think going without a shutdown() method that removes the setting cache from memory makes sense. Reloading the module shouldn't reset the cached setting values, nor the cached pastebin URL. It makes sense to me right now, and it can easily be changed later if it stops making sense.
Maybe just fix the commit message format since the original and revising commits were made so far apart. Squashing would destroy that bit of history (feature development timeline), so I'm not actually inclined to ask for a straight-up rebase this time around.
HumorBaby
force-pushed
the
feat-help-hide-server
branch
from
e273764
to
3803366
Compare
Done. |
|
Bleh, this needs rebasing. :/ It's #1451 what did it. |
HumorBaby
force-pushed
the
feat-help-hide-server
branch
2 times, most recently
from
90e2552
to
2f47078
Compare
|
Boy, that was a fun one 🙃 |
There was a problem hiding this comment.
If only I'd just hit "Merge" and not gone back for one final check to make sure the rebase didn't break anything obvious… Now we have more change requests. I guess @HumorBaby won't be bored today!
Adds a config section to help.py that has a setting to show the server host in the first line of a full help listing. Defaults to true. Additionally implements cache validation accounting for changes to config during runtime.
Co-Authored-By: dgw <dgw@technobabbl.es>
HumorBaby
force-pushed
the
feat-help-hide-server
branch
from
2f47078
to
232bb09
Compare
Can confirm... was not bored. |
Regression introduced by #1459 (`dict.iteritems()` no longer exists in Python 3; only `dict.items()` does, with the same internal behavior as what `dict.iteritems()` did in Python 2)
I have been disabling the
helpmodule because it shows the name of my server in a full.helplisting. This would be okay if the bot connected directly to a public server, but if it goes through a private bouncer, it may not be desirable to share this information.Of course I can modify
help.pyto prevent this, but I thought "Why not make it configurable?". So, here it is 🎉A config section is defined for the
helpmodule (section calledhelp, of course), which for now, only has one setting:show_server_host, a boolean that determines whether the server name will be printed or not; e.g.,Command listing for ro-bot-o@znc.roboto.org(true) vsCommand listing for ro-bot-o(false). Aconfiguremethod was also added to provide config wizard support.This required implementing cache validation of a sorts because a change in the setting would not have trigger a new help listing to be generated unless the total number of available commands changed somehow. I think this caching bust/validation implementation could also help #1451 if still needed.