Cache and restore system LC_CTYPE option after all other locales are set

[michalkleiner]

Description:

Tweak for #21126 that should be functionally equivalent.
Even repeated calls to changing the locale should persist the value for LC_CTYPE from the very first call.

Review

• Functional review done
• Potential edge cases thought about (behavior of the code with strange input, with strange internal state or possible interactions with other Matomo subsystems)
• Usability review done (is anything maybe unclear or think about anything that would cause people to reach out to support)
• Security review done
• Wording review done
• Code review done
• Tests were added if useful/possible
• Reviewed for breaking changes
• Developer changelog updated if needed
• Documentation added if needed
• Existing documentation updated if needed

[caddoo]

According to the PHP docs, https://www.php.net/manual/en/function.setlocale.php

When the argument category is passed as an empty string, it takes the value from the environment variables (in this order):

1. $LC_CTYPE
2. $LANG

Are these both blank/empty string for your local environment. The reason for asking the question is to really nail down exactly why it was breaking in the first place.

echo $LC_CTYPE & echo $LANG

[michalkleiner]

$LANG has a value, $LC_CTYPE is empty, locale returns both.

[michalkleiner]

I think it's not just what I can access as a user in my shell, it's about what nginx or php-fpm is running with, and when testing from plain php script with

<?php

setlocale(LC_CTYPE, '');

it immediately failed the same way.

[michalkleiner]

I also tried setting LC_CTYPE and LC_ALL to en_NZ.UTF-8 via fastcgi_param LANG "en_NZ.UTF-8"; in /opt/homebrew/etc/nginx/fastcgi_params and other places without luck, but it's possible that I haven't tried everything-everything.

[github-actions]

This issue is in "needs review" but there has been no activity for 7 days. ping @matomo-org/core-reviewers

[samjf]

@shafeek-innocraft Had this problem setting up a new matomo install too.

[caddoo]

@shafeek-innocraft Had this problem setting up a new matomo install too.

I did as well switching from using the built in PHP server to using Nginx + PHP-FPM ➕

[github-actions]

If you don't want this PR to be closed automatically in 28 days then you need to assign the label 'Do not close'.

[rikwillems]

I can confirm this PR resolves the issue for me.

[michalkleiner]

Hi @rikwillems, could you please let us know a bit about your current dev environment setup?
Are you using Docker, Ddev, Laravel Valet, MAMP/WAMP or something else?
When did you start seeing the issue, has it started randomly or after an upgrade or similar?
Any other info you can share to help us understand what might be the original cause?

[rikwillems]

Hi @michalkleiner I just started experimenting with Matomo a little bit. Last week I was able to install without any issue. Today I tried again and ran into this issue. I'm using Valet on php 8.1. Also tried php 8.0, same issue.

For debug I tried a try/catch but that didn't do anything, same 502 error.

[samjf]

@michalkleiner I forgot to mention at the time that when we encountered this the PR did actually solve the issue.
It was also experienced in a Dev environment using Nginx / Valet.