Use IpHelper to get IP in Logger

[SharkyKZ]

Pull Request for Issue #25518 .

Summary of Changes

Use IpHelper to get IP in Joomla\CMS\Log\Logger\FormattedtextLogger.

Testing Instructions

Install Joomla behind a reverse proxy which provides both remote_addr and http_x_forwarded_for headers.
Perform a login failure on /administrator
Check the /logs/error.php log

Expected result

To see the ip address from http_x_forwarded_for reported as the offending IP address.

Actual result

To see the ip address from remote_addr reported as the offending IP address.

Documentation Changes Required

No.

[SharkyKZ]

Failing tests related to framework. Submitted PR there joomla-framework/utilities#23.

[richard67]

I can't test because I don't have a reverse proxy.

@twrhills As you had the issue handled by this PR, could you test?

[twrhills]

I can't test because I don't have a reverse proxy.

@twrhills As you had the issue handled by this PR, could you test?

@richard67 I have tested this and it is the correct solution for my case. I am unfamiliar with github so if you need me to confirm in another way I would be grateful if you can link documentation / instructions.

[Quy]

Thank you for testing!

Please mark your test here: https://issues.joomla.org/tracker/joomla-cms/25520

[richard67]

@twrhills Follow the link posted in comment before by Quy, then click the "Test this" button at the top left corner above the description, then in the "Submit test result" select your test result with the check box, then click "Submit test result" button below the text field for the (otional) comment.

[twrhills]

I have tested this item ✅ successfully on 6ed695e

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/25520.}

[alikon]

I have tested this item ✅ successfully on 6ed695e

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/25520.}

[ghost]

Status "Ready To Commit".

[HLeithner]

@SharkyKZ can you please fix the error messages found by travis?

1. JLogLoggerFormattedTextTest::testAddEntry
   Undefined index: REMOTE_ADDR
   /home/travis/build/joomla/joomla-cms/tests/unit/core/helper.php:55
   /home/travis/build/joomla/joomla-cms/libraries/vendor/joomla/utilities/src/IpHelper.php:488
   /home/travis/build/joomla/joomla-cms/libraries/vendor/joomla/utilities/src/IpHelper.php:440
   /home/travis/build/joomla/joomla-cms/libraries/vendor/joomla/utilities/src/IpHelper.php:57
   /home/travis/build/joomla/joomla-cms/libraries/src/Log/Logger/FormattedtextLogger.php:195
   /home/travis/build/joomla/joomla-cms/libraries/src/Log/Logger/FormattedtextLogger.php:171
   /home/travis/build/joomla/joomla-cms/tests/unit/suites/libraries/joomla/log/loggers/JLogLoggerFormattedTextTest.php:174
2. JLogLoggerFormattedTextTest::testDeferWritingEntry
   Undefined index: REMOTE_ADDR
   /home/travis/build/joomla/joomla-cms/tests/unit/core/helper.php:55
   /home/travis/build/joomla/joomla-cms/libraries/vendor/joomla/utilities/src/IpHelper.php:488
   /home/travis/build/joomla/joomla-cms/libraries/vendor/joomla/utilities/src/IpHelper.php:440
   /home/travis/build/joomla/joomla-cms/libraries/vendor/joomla/utilities/src/IpHelper.php:57
   /home/travis/build/joomla/joomla-cms/libraries/src/Log/Logger/FormattedtextLogger.php:195
   /home/travis/build/joomla/joomla-cms/libraries/src/Log/Logger/FormattedtextLogger.php:139
   /home/travis/build/joomla/joomla-cms/tests/unit/suites/libraries/joomla/log/loggers/JLogLoggerFormattedTextTest.php:237
3. JLogLoggerW3CTest::testAddEntry
   Undefined index: REMOTE_ADDR
   /home/travis/build/joomla/joomla-cms/tests/unit/core/helper.php:55
   /home/travis/build/joomla/joomla-cms/libraries/vendor/joomla/utilities/src/IpHelper.php:488
   /home/travis/build/joomla/joomla-cms/libraries/vendor/joomla/utilities/src/IpHelper.php:440
   /home/travis/build/joomla/joomla-cms/libraries/vendor/joomla/utilities/src/IpHelper.php:57
   /home/travis/build/joomla/joomla-cms/libraries/src/Log/Logger/FormattedtextLogger.php:195
   /home/travis/build/joomla/joomla-cms/libraries/src/Log/Logger/FormattedtextLogger.php:171
   /home/travis/build/joomla/joomla-cms/tests/unit/suites/libraries/joomla/log/loggers/JLogLoggerW3CTest.php:37

[SharkyKZ]

@HLeithner need to update Framework's Utilities package to fix the notice. Submitted a separate PR #25601.

[HLeithner]

@SharkyKZ thx for the info so this is RTC when the composer update is merged.

[HLeithner]

I created pr #26000 please test.

[richard67]

@HLeithner Ist this a duplicate then to @SharkyKZ 's PR #25601 ?

[SharkyKZ]

@richard67 almost. But just realized my PR reverts some changes to Composer (I was using older version). So I'll close it.

[HLeithner]

@SharkyKZ IpHelper::getIp(); seams to behave different then the current code in the testing. Could you please have a look?

[SharkyKZ]

@HLeithner should I change the PR so it does not break tests or update tests?

[mbabker]

The tests should be updated. I’m going to take a wild guess that superglobal values aren’t being properly set and reset.

[SharkyKZ]

There's also discrepancy between empty IP values. Before it was null, now it's an empty string 😕

[HLeithner]

The w3c logger returned - with the old code now it shows an empty stringand I think thats wrong. So the null seams to be right.

[SharkyKZ]

Added empty string check in the logger.

[HLeithner]

Thanks