Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't use zero to signal failure #310

Merged
merged 1 commit into from Dec 29, 2022
Merged

Don't use zero to signal failure #310

merged 1 commit into from Dec 29, 2022

Conversation

yubiuser
Copy link
Member

@yubiuser yubiuser commented Dec 23, 2022

What does this PR aim to accomplish?:

We use GetFTLData "dns-port" to figure out the DNS port FTL is listening on.

PADD/padd.sh

Line 423 in 1cf30ee

ftl_dns_port=$(GetFTLData "dns-port")

This port can be 0 if the DNS function of the internal dnsmasq is disabled. (https://docs.pi-hole.net/ftldns/telnet-api/#dns-port)

However, we use 0 within GetFTLData(), to signal an error when we fail to get the telnet API port (for whatever reason)

PADD/padd.sh

Lines 114 to 124 in 1cf30ee

GetFTLData() {
local ftl_port data
ftl_port=$(getFTLAPIPort)
if [ -n "$ftl_port" ]; then
# Send command to FTL and ask to quit when finished
data="$(echo ">$1 >quit" | nc 127.0.0.1 "${ftl_port}")"
echo "${data}"
else
echo "0"
fi
}

We should not use a number as return code that could have another meaning. As GetFTLData "dns-port" is the only place we actually checked for 0 (read as: we never checked anywhere else) I removed the code to signal a failure on getting the API port.

Issue discovered in #307. (This PR won't fix the issue, but can help to improve investigation)


By submitting this pull request, I confirm the following:

  1. I have read and understood the contributors guide, as well as this entire template. I understand which branch to base my commits and Pull Requests against.
  2. I have commented my proposed changes within the code and I have tested my changes.
  3. I am willing to help maintain this change if there are issues with it later.
  4. It is compatible with the EUPL 1.2 license
  5. I have squashed any insignificant commits. (git rebase)
  6. I have checked that another pull request for this purpose does not exist.
  7. I have considered, and confirmed that this submission will be valuable to others.
  8. I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  9. I give this submission freely, and claim no ownership to its content.

  • I have read the above and my PR is ready for review. Check this box to confirm

Signed-off-by: Christian König <ckoenig@posteo.de>
@yubiuser yubiuser merged commit 1b06852 into development Dec 29, 2022
@yubiuser yubiuser deleted the no_zero branch December 29, 2022 07:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants