After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 765112 - Match Reply credits line time parts to LC_MESSAGES
Match Reply credits line time parts to LC_MESSAGES
Status: RESOLVED FIXED
Product: evolution
Classification: Applications
Component: Composer
3.20.x (obsolete)
Other All
: Normal minor
: ---
Assigned To: evolution-mail-maintainers
Evolution QA team
Depends on:
Blocks:
 
 
Reported: 2016-04-15 15:18 UTC by g.trentalancia
Modified: 2016-04-21 10:08 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Proposed patch to use the correct language for the day of the week in quoted messages (1.80 KB, patch)
2016-04-15 15:18 UTC, g.trentalancia
none Details | Review
Proposed patch (version 2, requires patching evolution code too) (4.17 KB, patch)
2016-04-15 16:39 UTC, g.trentalancia
rejected Details | Review
Proposed patch (version 2) for the evolution code (2.53 KB, patch)
2016-04-15 16:40 UTC, g.trentalancia
reviewed Details | Review
Reviewed patch for the evolution code (2.47 KB, patch)
2016-04-15 18:12 UTC, Guido Trentalancia
none Details | Review
Reviewed patch for the evolution-data-server code (4.19 KB, patch)
2016-04-15 18:12 UTC, Guido Trentalancia
none Details | Review
Patch for the evolution data server code (v4) (4.43 KB, patch)
2016-04-18 15:36 UTC, Guido Trentalancia
none Details | Review
Patch for the evolution code (v3) (7.52 KB, patch)
2016-04-18 15:37 UTC, Guido Trentalancia
none Details | Review
Proposed patch (v4) for the evolution code (4.18 KB, patch)
2016-04-19 15:25 UTC, Guido Trentalancia
reviewed Details | Review

Description g.trentalancia 2016-04-15 15:18:21 UTC
Created attachment 326111 [details] [review]
Proposed patch to use the correct language for the day of the week in quoted messages

The language used for the day of the week when quoting a message in a reply does not match the language used for the quoting text generated by evolution (i.e. the application language).

Such a bug is triggered, for example, when LC_MESSAGE is set to "C" (not
infrequent at all) and the other locale variables are set to the user
first language.

A patch which fixes this issue is attached.
Comment 1 g.trentalancia 2016-04-15 16:39:29 UTC
Created attachment 326117 [details] [review]
Proposed patch (version 2, requires patching evolution code too)

Requires patching the evolution code too.
Comment 2 g.trentalancia 2016-04-15 16:40:59 UTC
Created attachment 326118 [details] [review]
Proposed patch (version 2) for the evolution code

Requires patching the evolution-data-server code too.
Comment 3 Milan Crha 2016-04-15 17:00:23 UTC
Review of attachment 326117 [details] [review]:

Thanks for a bug report and patch, but I'm rejecting it. There are couple issues:
a) you leak saved_locale if the locale_fmt is NULL
b) you do not check for NULL and pass the saved_locale to setlocale() and
   free() (you might better use g_strdup() and g_free() here)
c) what if the user has set those locale variables differently intentionally?
Comment 4 Milan Crha 2016-04-15 17:04:42 UTC
Review of attachment 326118 [details] [review]:

I'm setting this to reviewed. The change at line with "case ATTRIB_STRFTIME:" is not needed. Otherwise this is better approach than changing whole e_utf8_strftime, as you had it initially, but still the other concerns apply here.
Comment 5 g.trentalancia 2016-04-15 17:40:33 UTC
Thanks very much for reviewing the patch. I'll submit a new patchset shortly.

As for point c), it's impossible: no one would ever want to compose (or read) a sentence in two different languages (would you like to read a sentence such as "Today venerdì 15 April 2016 I submitted a patch to evolution development"). No way !
Comment 6 Milan Crha 2016-04-15 17:52:13 UTC
Honestly, I do not recall when I heard the last time about LC_MESSAGES not matching LC_TIME. Evolution has an option for that particular string, not only available for translators, but users can define their own string in gsettings, which lets then user their native language for the UI, but reply with quotation "header" in one language, line in English. That's for your "No way!".

By the way, the "April" should also honour the LC_TIME, but it's in English. Isn't it weird? (I didn't check the code, I do not know off head.)

It would be also good to use evolution-data-server coding style, and GLib types, not plain 'char' for example. And if you could avoid code duplication, because the only thing you really want to do is to change the locale before calling strftime, otherwise the rest should stay as is, then your wrapper can call the original function, instead of duplicating the code, and do it always, not only for that single format (if I'd pass set of attributes at once then the function would simply fail and use "the wrong" language for the week day name).

Finally, there is a little concern about portability. I think that the construction you use is portable, like to Win32, but I'm not completely sure.
Comment 7 Guido Trentalancia 2016-04-15 18:12:09 UTC
Created attachment 326124 [details] [review]
Reviewed patch for the evolution code

Requires patching the evolution-data-server code too.
Comment 8 Guido Trentalancia 2016-04-15 18:12:59 UTC
Created attachment 326126 [details] [review]
Reviewed patch for the evolution-data-server code

Requires patching of the evolution code too.
Comment 9 Guido Trentalancia 2016-04-15 18:18:25 UTC
I have just submitted the two new patches.

I really believe that we need to keep things simple to use (so, the string should be in only one language by default, without the need to tweak with gsettings which is not trivial for most users).

As for you comment about the month, from what I can see, the current code does not use the formatted month name yet.
Comment 10 Milan Crha 2016-04-18 11:54:43 UTC
Review of attachment 326126 [details] [review]:

I see you didn't do everything I wanted from you. At least these two things should be addressed:
a) do not duplicate the code, instead call the e_utf8_strftime() from within the e_utf8_strftime_matched_lang()
b) the LC_MESSAGES is not portable, you should count with it: https://msdn.microsoft.com/en-us/library/x99tb11d.aspx
Comment 11 Milan Crha 2016-04-18 12:05:07 UTC
Review of attachment 326124 [details] [review]:

::: evolution-3.20.1-orig/mail/em-composer-utils.c
@@ +3025,2 @@
 	{ "{AmPmUpper}", ATTRIB_STRFTIME, { "%p", NULL } },
 	{ "{AmPmLower}", ATTRIB_STRFTIME, { "%P", NULL } },

All the ATTRIB_STRFTIME should be using the MATCH_LANG variant, otherwise you still keep the inconsistency. That is, the name of the attribute could be left the same, just the corresponding case at the bottom should call a different function, but, ideally, with a hidden (gsettings) option with its default to 'false', to use the matched_lang() variant, which is actually match_lc_messages(), not matched_lang(). The default will be 'false', to not use the new function.
Comment 12 Milan Crha 2016-04-18 12:08:06 UTC
Thinking of it, I do not see any other usage of that new function at the moment, thus it might be better to not touch the eds code at all and define such function in the evolution only, at the place where it is currently used. To avoid unnecessary repeated calls for the "does LC_TIME match LC_MESSAGES" test, a caching on the evolution side would be also useful, ideally only within the attribution_format() call.
Comment 13 Guido Trentalancia 2016-04-18 12:18:42 UTC
(In reply to Milan Crha from comment #10)
> Review of attachment 326126 [details] [review] [review]:
> 
> I see you didn't do everything I wanted from you. At least these two things
> should be addressed:
> a) do not duplicate the code, instead call the e_utf8_strftime() from within
> the e_utf8_strftime_matched_lang()

If you call the e_utf8_strftime() from within the e_utf8_strftime_matched_lang(), then it is not possible to free saved_locale (with trivial code) if an error occurs.

> b) the LC_MESSAGES is not portable, you should count with it:
> https://msdn.microsoft.com/en-us/library/x99tb11d.aspx

Thanks for pointing that out. I have now introduced conditional code compilation there.
Comment 14 Guido Trentalancia 2016-04-18 12:31:44 UTC
(In reply to guido from comment #13)
> (In reply to Milan Crha from comment #10)
> > Review of attachment 326126 [details] [review] [review] [review]:
> > 
> > I see you didn't do everything I wanted from you. At least these two things
> > should be addressed:
> > a) do not duplicate the code, instead call the e_utf8_strftime() from within
> > the e_utf8_strftime_matched_lang()
> 
> If you call the e_utf8_strftime() from within the
> e_utf8_strftime_matched_lang(), then it is not possible to free saved_locale
> (with trivial code) if an error occurs.

The e_utf8_strftime_matched_lang() function can be removed completely and the e_utf8_strftime() function can be modified to (always) support this fix. There shouldn't be undesired side-effects.
Comment 15 Milan Crha 2016-04-18 13:08:38 UTC
(In reply to guido from comment #13)
> If you call the e_utf8_strftime() from within the
> e_utf8_strftime_matched_lang(), then it is not possible to free saved_locale
> (with trivial code) if an error occurs.

Are you sure?

   e_utf8_strftime_match_lc_messages()
   {
      possibly change locale;
      res = e_utf8_strftime();
      free whatever is needed from 'change locale';
      return res;
   }

(In reply to guido from comment #14)
> The e_utf8_strftime_matched_lang() function can be removed completely and
> the e_utf8_strftime() function can be modified to (always) support this fix.
> There shouldn't be undesired side-effects.

No, the e_utf8_strftime() is not used only in this single place, then it would be an error. You had it this way at the initial patch, but you replaced it before I rejected it for this reason.
Comment 16 Guido Trentalancia 2016-04-18 13:14:56 UTC
(In reply to Milan Crha from comment #15)
> (In reply to guido from comment #13)
> > If you call the e_utf8_strftime() from within the
> > e_utf8_strftime_matched_lang(), then it is not possible to free saved_locale
> > (with trivial code) if an error occurs.
> 
> Are you sure?
> 
>    e_utf8_strftime_match_lc_messages()
>    {
>       possibly change locale;
>       res = e_utf8_strftime();
>       free whatever is needed from 'change locale';
>       return res;
>    }

What's the point of creating an inconsistency that it might shows up as a bug elsewhere in the code now or in the future ?

It LC_MESSAGES should override LC_TIME for time formatting, then that is is likely to be desirable everywhere throughout the application code. So there is no point of having two functions...

Also, I have now changed e_strftime() too, for exactly the same reason (consistency of behaviour throughout all parts of the application).

> (In reply to guido from comment #14)
> > The e_utf8_strftime_matched_lang() function can be removed completely and
> > the e_utf8_strftime() function can be modified to (always) support this fix.
> > There shouldn't be undesired side-effects.
> 
> No, the e_utf8_strftime() is not used only in this single place, then it
> would be an error. You had it this way at the initial patch, but you
> replaced it before I rejected it for this reason.

I know, it's not only used there (see above) ! I now believe it's an error to use the fix only in the mail message composer...
Comment 17 Guido Trentalancia 2016-04-18 13:17:19 UTC
I have just spotted another time formatting inconsistency in other parts of the application: in the calendar the month is formatted as LC_MESSAGES="C", while the day of the week is formatted as LC_TIME.
Comment 18 Milan Crha 2016-04-18 15:28:50 UTC
(In reply to guido from comment #16)
> What's the point of creating an inconsistency that it might shows up as a
> bug elsewhere in the code now or in the future ?

It's not any inconsistency. The only reason I would accept your proposal is in this particular use case, in the reply credits.

> Also, I have now changed e_strftime() too, for exactly the same reason
> (consistency of behaviour throughout all parts of the application).

No, as I said above, I'll not approve it. The change in the reply credits is special, because it is *in the message body*, everywhere else (in most other places) the e_utf8_strftime() is used properly, for date/time-related values in date/time related columns/fields/places.

P.S.: I need short bug summary for commit messages; please do not fight even for this.
Comment 19 Guido Trentalancia 2016-04-18 15:35:12 UTC
I cannot report a bug and then propose a patch that does not fix it properly !

Please have a look at the new version of the patchset.

The problem is not only in the mailer but also in the composer. Therefore, the new patchset reflects the vision that time and date formatting should be consistent.
Comment 20 Guido Trentalancia 2016-04-18 15:36:45 UTC
Created attachment 326274 [details] [review]
Patch for the evolution data server code (v4)
Comment 21 Guido Trentalancia 2016-04-18 15:37:30 UTC
Created attachment 326275 [details] [review]
Patch for the evolution code (v3)
Comment 22 Guido Trentalancia 2016-04-18 15:40:50 UTC
The problem is wider than originally reported.

Therefore, the title is currently wrong.

I am not fighting, I am just being correct. You are figthing to change the bug title, since you changed it a second time...

If the new title I proposed is too long, then it can be changed to a shorter one, with a similar meaning.
Comment 23 Guido Trentalancia 2016-04-18 19:03:32 UTC
I am getting there, it's just that testing is very slow, due to my machine being slow to re-compile and re-install and also due to the fact, that I am multi-tasking many things...

For some reason, at some point earlier on, I ended up with having the month in English and the name of the day in another language in the composer, so I want to be sure that it does not happen.

It takes some time, also because I don't know the code well, it's the first time I look at it ! But we'll get there soon, trust me !
Comment 24 Guido Trentalancia 2016-04-18 19:12:42 UTC
The latest patchset, always overrides LC_TIME, that's probably wrong and it should be avoided. If LC_TIME is different from LC_MESSAGES, then the other parts of the application should usually honour the choice.

Also, I am now confining the issue to the evolution code, without changing the evolution-data-server code...
Comment 25 Guido Trentalancia 2016-04-18 19:20:28 UTC
Now, it is somewhat more clear to me which parts of the application are using the strftime() functions.

What is not clear yet to me is why the evolution code uses both the e_*_strftime() code from eds and the g_data_strftime() code from Gnome GLib...
Comment 26 Milan Crha 2016-04-19 11:14:39 UTC
Thanks. It sounds to me that we are on the same line finally. Just to summarize my point of view:
- users can have different LC_MESSAGES and LC_TIME on purpose
- the Evolution (and basically any application in general) should honour this
  user decision and show data/time values according to LC_TIME setting and
  the messages (and in general UI) with the LC_MESSAGES
- the date/time values can be part of the UI, but as long as they are
  "separate" date/time values, they should honour LC_TIME
- I agree with you about the exception in the Reply credits line in
  the Evolution, which mixes date/time value with a raw text. Due to the value
  being a mixture, I agree with you that it should follow the LC_MESSAGES for
  the date/time value, rather than use the LC_TIME
- the Reply credits line is the only exception in the Evolution code
- if there happen to be a place in the UI where the date/time value is mixed,
  as you wrote with the calendar, then it should be fixed, but not by
  overriding the LC_TIME, but by using strftime consistently there

(In reply to guido from comment #25)
> What is not clear yet to me is why the evolution code uses both the
> e_*_strftime() code from eds and the g_data_strftime() code from Gnome
> GLib...

Partly historical reasons, partly because it's easier to call the GLib function when the structure in use is the GLib structure, rather than to convert the value and call the eds function.
Comment 27 Guido Trentalancia 2016-04-19 15:25:31 UTC
Created attachment 326332 [details] [review]
Proposed patch (v4) for the evolution code

This version of the patch no longer requires the companion patch for the evolution-data-server code.
Comment 28 Guido Trentalancia 2016-04-19 15:35:11 UTC
(In reply to Milan Crha from comment #26)
> Thanks. It sounds to me that we are on the same line finally. Just to
> summarize my point of view:

[...]

> - if there happen to be a place in the UI where the date/time value is mixed,
>   as you wrote with the calendar, then it should be fixed, but not by
>   overriding the LC_TIME, but by using strftime consistently there

I cannot reproduce the problem, therefore it was probably some sort of transitory problem introduced unintentionally in some way while producing and testing the patch.

A new version of the patch has been posted (v4): it tackles the mail composer only.

Can you test and/or commit the changes ? I tested it and it works fine. Time and date formatting elsewhere (e.g. calendar) follow LC_TIME settings as per original Open Group specifications.
Comment 29 Milan Crha 2016-04-21 08:12:29 UTC
Thanks for the update. This is basically what I was looking for. I made some minor changes, like the function rename, adding to the documentation and fixed the documentation comment for it too.

Created commit 833410a in evo master (3.21.1+)
Comment 30 Guido Trentalancia 2016-04-21 10:08:32 UTC
Thanks. I like very much the new name you gave to the function !