aboutsummaryrefslogtreecommitdiff
path: root/src/utils.c
blob: 5539c5cd6983e697c44127201797ba14185b2a16 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
/* -*- Mode: C; coding: utf-8; indent-tabs-mode: nil; tab-width: 2 -*-

A dialog for setting time and date preferences.

Copyright 2010 Canonical Ltd.

Authors:
    Michael Terry <michael.terry@canonical.com>

This program is free software: you can redistribute it and/or modify it 
under the terms of the GNU General Public License version 3, as published 
by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranties of 
MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR 
PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along 
with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#include <glib/gi18n-lib.h>
#include <gio/gio.h>
#include <locale.h>
#include <langinfo.h>
#include <string.h>
#include "utils.h"
#include "settings-shared.h"

/* Check the system locale setting to see if the format is 24-hour
   time or 12-hour time */
gboolean
is_locale_12h (void)
{
	static const char *formats_24h[] = {"%H", "%R", "%T", "%OH", "%k", NULL};
	const char *t_fmt = nl_langinfo (T_FMT);
	int i;

	for (i = 0; formats_24h[i]; ++i) {
		if (strstr (t_fmt, formats_24h[i])) {
			return FALSE;
		}
	}

	return TRUE;
}

void
split_settings_location (const gchar * location, gchar ** zone, gchar ** name)
{
  gchar * location_dup;
  gchar * first;

  location_dup = g_strdup (location);
  g_strstrip (location_dup);

  if ((first = strchr (location_dup, ' ')))
    *first = '\0';

  if (zone != NULL)
    {
      *zone = location_dup;
    }

  if (name != NULL)
    {
      gchar * after = first ? g_strstrip (first + 1) : NULL;

      if (after && *after)
        {
          *name = g_strdup (after);
        }
      else /* make the name from zone */
        {
          gchar * chr = strrchr (location_dup, '/');
          after = g_strdup (chr ? chr + 1 : location_dup);

          /* replace underscores with spaces */
          for (chr=after; chr && *chr; chr++)
            if (*chr == '_')
              *chr = ' ';

          *name = after;
        }
    }
}

gchar *
get_current_zone_name (const gchar * location, GSettings * settings)
{
  gchar * new_zone, * new_name;
  gchar * tz_name;
  gchar * old_zone, * old_name;
  gchar * rv;

  split_settings_location (location, &new_zone, &new_name);

  tz_name = g_settings_get_string (settings, SETTINGS_TIMEZONE_NAME_S);
  split_settings_location (tz_name, &old_zone, &old_name);
  g_free (tz_name);

  /* new_name is always just a sanitized version of a timezone.
     old_name is potentially a saved "pretty" version of a timezone name from
     geonames.  So we prefer to use it if available and the zones match. */

  if (g_strcmp0 (old_zone, new_zone) == 0) {
    rv = old_name;
    old_name = NULL;
  }
  else {
    rv = new_name;
    new_name = NULL;
  }

  g_free (new_zone);
  g_free (old_zone);
  g_free (new_name);
  g_free (old_name);

  return rv;
}

/* Translate msg according to the locale specified by LC_TIME */
static const char *
T_(const char *msg)
{
	/* General strategy here is to make sure LANGUAGE is empty (since that
	   trumps all LC_* vars) and then to temporarily swap LC_TIME and
	   LC_MESSAGES.  Then have gettext translate msg.

	   We strdup the strings because the setlocale & *env functions do not
	   guarantee anything about the storage used for the string, and thus
	   the string may not be portably safe after multiple calls.

	   Note that while you might think g_dcgettext would do the trick here,
	   that actually looks in /usr/share/locale/XX/LC_TIME, not the
	   LC_MESSAGES directory, so we won't find any translation there.
	*/
	char *message_locale = g_strdup(setlocale(LC_MESSAGES, NULL));
	const char *time_locale = setlocale (LC_TIME, NULL);
	char *language = g_strdup(g_getenv("LANGUAGE"));
	const char *rv;
	if (language)
		g_unsetenv("LANGUAGE");
	setlocale(LC_MESSAGES, time_locale);

	/* Get the LC_TIME version */
	rv = _(msg);

	/* Put everything back the way it was */
	setlocale(LC_MESSAGES, message_locale);
	if (language)
		g_setenv("LANGUAGE", language, TRUE);
	g_free(message_locale);
	g_free(language);
	return rv;
}

gchar *
join_date_and_time_format_strings (const char * date_string,
                                   const char * time_string)
{
  gchar * str;

  if (date_string && time_string)
    {
      /* TRANSLATORS: This is a format string passed to strftime to combine the
       * date and the time.  The value of "%s\xE2\x80\x82%s" will result in a
       * string like this in US English 12-hour time: 'Fri Jul 16 11:50 AM'.
       * The space in between date and time is a Unicode en space
       * (E28082 in UTF-8 hex). */
      str =  g_strdup_printf (T_("%s\xE2\x80\x82%s"), date_string, time_string);
    }
  else if (date_string)
    {
      str = g_strdup_printf (T_("%s"), date_string);
    }
  else /* time_string */
    {
      str = g_strdup_printf (T_("%s"), time_string);
    }

  return str;
}

/***
****
***/

typedef enum
{
  DATE_PROXIMITY_TODAY,
  DATE_PROXIMITY_TOMORROW,
  DATE_PROXIMITY_WEEK,
  DATE_PROXIMITY_FAR
}
date_proximity_t;

static date_proximity_t
get_date_proximity (GDateTime * now, GDateTime * time)
{
  date_proximity_t prox = DATE_PROXIMITY_FAR;
  gint now_year, now_month, now_day;
  gint time_year, time_month, time_day;

  /* does it happen today? */
  g_date_time_get_ymd (now, &now_year, &now_month, &now_day);
  g_date_time_get_ymd (time, &time_year, &time_month, &time_day);
  if ((now_year == time_year) && (now_month == time_month) && (now_day == time_day))
    prox = DATE_PROXIMITY_TODAY;

  /* does it happen tomorrow? */
  if (prox == DATE_PROXIMITY_FAR)
    {
      GDateTime * tomorrow;
      gint tom_year, tom_month, tom_day;

      tomorrow = g_date_time_add_days (now, 1);
      g_date_time_get_ymd (tomorrow, &tom_year, &tom_month, &tom_day);
      if ((tom_year == time_year) && (tom_month == time_month) && (tom_day == time_day))
        prox = DATE_PROXIMITY_TOMORROW;

      g_date_time_unref (tomorrow);
    }

  /* does it happen this week? */
  if (prox == DATE_PROXIMITY_FAR)
    {
      GDateTime * week;
      GDateTime * week_bound;

      week = g_date_time_add_days (now, 6);
      week_bound = g_date_time_new_local (g_date_time_get_year(week),
                                          g_date_time_get_month (week),
                                          g_date_time_get_day_of_month(week),
                                          23, 59, 59.9);

      if (g_date_time_compare (time, week_bound) <= 0)
        prox = DATE_PROXIMITY_WEEK;

      g_date_time_unref (week_bound);
      g_date_time_unref (week);
    }

  return prox;
}


/*
 * "Terse" time & date format strings
 * 
 * Used on the phone menu where space is at a premium, these strings
 * express the time and date in as brief a form as possible.
 *
 * Examples from spec:
 *  1. "Daily 6:30 AM"
 *  2. "5:07 PM" (note date is omitted; today's date is implicit)
 *  3. "Daily 12 PM" (note minutes are omitted for on-the-hour times)
 *  4. "Tomorrow 7 AM" (note "Tomorrow" is used instead of a day of week)
 */

static const gchar *
get_terse_date_format_string (date_proximity_t proximity)
{
  const gchar * fmt;

  switch (proximity)
    {
      case DATE_PROXIMITY_TODAY:
        /* 'Today' is implicit in the terse case, so no string needed */
        fmt = NULL;
        break;

      case DATE_PROXIMITY_TOMORROW:
        fmt = T_("Tomorrow");
        break;

      case DATE_PROXIMITY_WEEK:
        /* a strftime(3) fmt string for abbreviated day of week */
        fmt = T_("%a");
        break;

      default:
        /* a strftime(3) fmt string for day-of-month and abbreviated month */
        fmt = T_("%d %b");
        break;
    }

  return fmt;
}

const gchar*
get_terse_header_time_format_string (void)
{
  /* a strftime(3) fmt string for a H:MM 12 hour time, eg "6:59 PM" */
  return T_("%l:%M %p");
}

const gchar *
get_terse_time_format_string (GDateTime * time)
{
  const gchar * fmt;

  if (g_date_time_get_minute (time) != 0)
    {
      fmt = get_terse_header_time_format_string ();
    }
  else
    {
      /* a strftime(3) fmt string for a 12 hour on-the-hour time, eg "7 PM" */
      fmt = T_("%l %p");
    }

  return fmt;
}

gchar *
generate_terse_format_string_at_time (GDateTime * now, GDateTime * time)
{
  const date_proximity_t prox = get_date_proximity (now, time);
  const gchar * date_fmt = get_terse_date_format_string (prox);
  const gchar * time_fmt = get_terse_time_format_string (time);
  return join_date_and_time_format_strings (date_fmt, time_fmt);
}

/***
****  FULL
***/

static const gchar *
get_full_date_format_string (gboolean show_day, gboolean show_date, gboolean show_year)
{
  const char * fmt;

  if (show_day && show_date && show_year)
    /* TRANSLATORS: a strftime(3) format showing the weekday, date, and year */
    fmt = T_("%a %b %e %Y");
  else if (show_day && show_date)
    /* TRANSLATORS: a strftime(3) format showing the weekday and date */
    fmt = T_("%a %b %e");
  else if (show_day && show_year)
    /* TRANSLATORS: a strftime(3) format showing the weekday and year. */
    fmt = T_("%a %Y");
  else if (show_day)
    /* TRANSLATORS: a strftime(3) format showing the weekday. */
    fmt = T_("%a");
  else if (show_date && show_year)
    /* TRANSLATORS: a strftime(3) format showing the date and year */
    fmt = T_("%b %e %Y");
  else if (show_date)
    /* TRANSLATORS: a strftime(3) format showing the date */
    fmt = T_("%b %e");
  else if (show_year)
    /* TRANSLATORS: a strftime(3) format showing the year */
    fmt = T_("%Y");
  else
    fmt = NULL;

  return fmt;
}


/*
 * "Full" time & date format strings
 * 
 * These are used on the desktop menu & header and honors the
 * GSettings entries for 12/24hr mode and whether or not to show seconds.
 *
 */

const gchar *
get_full_time_format_string (GSettings * settings)
{
  gboolean twelvehour;
  gboolean show_seconds;
  const gchar * fmt;

  g_return_val_if_fail (settings != NULL, NULL);

  show_seconds = g_settings_get_boolean (settings, SETTINGS_SHOW_SECONDS_S);

  switch (g_settings_get_enum (settings, SETTINGS_TIME_FORMAT_S))
    {
      case TIME_FORMAT_MODE_LOCALE_DEFAULT:
        twelvehour = is_locale_12h();
        break;

      case TIME_FORMAT_MODE_24_HOUR:
        twelvehour = FALSE;
        break;

      default:
        twelvehour = TRUE;
        break;
    }

  if (twelvehour && show_seconds)
    /* TRANSLATORS: a strftime(3) format for 12hr time w/seconds */
    fmt = T_("%l:%M:%S %p");
  else if (twelvehour)
    /* TRANSLATORS: a strftime(3) format for 12hr time */
    fmt = T_("%l:%M %p");
  else if (show_seconds)
    /* TRANSLATORS: a strftime(3) format for 24hr time w/seconds */
    fmt = T_("%H:%M:%S");
  else
    /* TRANSLATORS: a strftime(3) format for 24hr time */
    fmt = T_("%H:%M");

  return fmt;
}

gchar *
generate_full_format_string (gboolean show_day, gboolean show_date, gboolean show_year, GSettings * settings)
{
  const gchar * date_fmt = get_full_date_format_string (show_day, show_date, show_year);
  const gchar * time_fmt = get_full_time_format_string (settings);
  return join_date_and_time_format_strings (date_fmt, time_fmt);
}
  
gchar *
generate_full_format_string_at_time (GDateTime * now, GDateTime * time, GSettings * settings)
{
  gboolean show_day;
  gboolean show_date;

  g_return_val_if_fail (now != NULL, NULL);
  g_return_val_if_fail (time != NULL, NULL);
  g_return_val_if_fail (settings != NULL, NULL);

  switch (get_date_proximity (now, time))
    {
      case DATE_PROXIMITY_TODAY:
        show_day = FALSE;
        show_date = FALSE;
        break;

      case DATE_PROXIMITY_TOMORROW:  
      case DATE_PROXIMITY_WEEK:
        show_day = FALSE;
        show_date = TRUE;
        break;

      default:
        show_day = TRUE;
        show_date = TRUE;
        break;
    }

  return generate_full_format_string (show_day, show_date, FALSE, settings);
}