PostgreSQL Source Code  git master
chklocale.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * chklocale.c
4  * Functions for handling locale-related info
5  *
6  *
7  * Copyright (c) 1996-2022, PostgreSQL Global Development Group
8  *
9  *
10  * IDENTIFICATION
11  * src/port/chklocale.c
12  *
13  *-------------------------------------------------------------------------
14  */
15 
16 #ifndef FRONTEND
17 #include "postgres.h"
18 #else
19 #include "postgres_fe.h"
20 #endif
21 
22 #ifdef HAVE_LANGINFO_H
23 #include <langinfo.h>
24 #endif
25 
26 #include "mb/pg_wchar.h"
27 
28 
29 /*
30  * This table needs to recognize all the CODESET spellings for supported
31  * backend encodings, as well as frontend-only encodings where possible
32  * (the latter case is currently only needed for initdb to recognize
33  * error situations). On Windows, we rely on entries for codepage
34  * numbers (CPnnn).
35  *
36  * Note that we search the table with pg_strcasecmp(), so variant
37  * capitalizations don't need their own entries.
38  */
40 {
41  enum pg_enc pg_enc_code;
42  const char *system_enc_name;
43 };
44 
45 static const struct encoding_match encoding_match_list[] = {
46  {PG_EUC_JP, "EUC-JP"},
47  {PG_EUC_JP, "eucJP"},
48  {PG_EUC_JP, "IBM-eucJP"},
49  {PG_EUC_JP, "sdeckanji"},
50  {PG_EUC_JP, "CP20932"},
51 
52  {PG_EUC_CN, "EUC-CN"},
53  {PG_EUC_CN, "eucCN"},
54  {PG_EUC_CN, "IBM-eucCN"},
55  {PG_EUC_CN, "GB2312"},
56  {PG_EUC_CN, "dechanzi"},
57  {PG_EUC_CN, "CP20936"},
58 
59  {PG_EUC_KR, "EUC-KR"},
60  {PG_EUC_KR, "eucKR"},
61  {PG_EUC_KR, "IBM-eucKR"},
62  {PG_EUC_KR, "deckorean"},
63  {PG_EUC_KR, "5601"},
64  {PG_EUC_KR, "CP51949"},
65 
66  {PG_EUC_TW, "EUC-TW"},
67  {PG_EUC_TW, "eucTW"},
68  {PG_EUC_TW, "IBM-eucTW"},
69  {PG_EUC_TW, "cns11643"},
70  /* No codepage for EUC-TW ? */
71 
72  {PG_UTF8, "UTF-8"},
73  {PG_UTF8, "utf8"},
74  {PG_UTF8, "CP65001"},
75 
76  {PG_LATIN1, "ISO-8859-1"},
77  {PG_LATIN1, "ISO8859-1"},
78  {PG_LATIN1, "iso88591"},
79  {PG_LATIN1, "CP28591"},
80 
81  {PG_LATIN2, "ISO-8859-2"},
82  {PG_LATIN2, "ISO8859-2"},
83  {PG_LATIN2, "iso88592"},
84  {PG_LATIN2, "CP28592"},
85 
86  {PG_LATIN3, "ISO-8859-3"},
87  {PG_LATIN3, "ISO8859-3"},
88  {PG_LATIN3, "iso88593"},
89  {PG_LATIN3, "CP28593"},
90 
91  {PG_LATIN4, "ISO-8859-4"},
92  {PG_LATIN4, "ISO8859-4"},
93  {PG_LATIN4, "iso88594"},
94  {PG_LATIN4, "CP28594"},
95 
96  {PG_LATIN5, "ISO-8859-9"},
97  {PG_LATIN5, "ISO8859-9"},
98  {PG_LATIN5, "iso88599"},
99  {PG_LATIN5, "CP28599"},
100 
101  {PG_LATIN6, "ISO-8859-10"},
102  {PG_LATIN6, "ISO8859-10"},
103  {PG_LATIN6, "iso885910"},
104 
105  {PG_LATIN7, "ISO-8859-13"},
106  {PG_LATIN7, "ISO8859-13"},
107  {PG_LATIN7, "iso885913"},
108 
109  {PG_LATIN8, "ISO-8859-14"},
110  {PG_LATIN8, "ISO8859-14"},
111  {PG_LATIN8, "iso885914"},
112 
113  {PG_LATIN9, "ISO-8859-15"},
114  {PG_LATIN9, "ISO8859-15"},
115  {PG_LATIN9, "iso885915"},
116  {PG_LATIN9, "CP28605"},
117 
118  {PG_LATIN10, "ISO-8859-16"},
119  {PG_LATIN10, "ISO8859-16"},
120  {PG_LATIN10, "iso885916"},
121 
122  {PG_KOI8R, "KOI8-R"},
123  {PG_KOI8R, "CP20866"},
124 
125  {PG_KOI8U, "KOI8-U"},
126  {PG_KOI8U, "CP21866"},
127 
128  {PG_WIN866, "CP866"},
129  {PG_WIN874, "CP874"},
130  {PG_WIN1250, "CP1250"},
131  {PG_WIN1251, "CP1251"},
132  {PG_WIN1251, "ansi-1251"},
133  {PG_WIN1252, "CP1252"},
134  {PG_WIN1253, "CP1253"},
135  {PG_WIN1254, "CP1254"},
136  {PG_WIN1255, "CP1255"},
137  {PG_WIN1256, "CP1256"},
138  {PG_WIN1257, "CP1257"},
139  {PG_WIN1258, "CP1258"},
140 
141  {PG_ISO_8859_5, "ISO-8859-5"},
142  {PG_ISO_8859_5, "ISO8859-5"},
143  {PG_ISO_8859_5, "iso88595"},
144  {PG_ISO_8859_5, "CP28595"},
145 
146  {PG_ISO_8859_6, "ISO-8859-6"},
147  {PG_ISO_8859_6, "ISO8859-6"},
148  {PG_ISO_8859_6, "iso88596"},
149  {PG_ISO_8859_6, "CP28596"},
150 
151  {PG_ISO_8859_7, "ISO-8859-7"},
152  {PG_ISO_8859_7, "ISO8859-7"},
153  {PG_ISO_8859_7, "iso88597"},
154  {PG_ISO_8859_7, "CP28597"},
155 
156  {PG_ISO_8859_8, "ISO-8859-8"},
157  {PG_ISO_8859_8, "ISO8859-8"},
158  {PG_ISO_8859_8, "iso88598"},
159  {PG_ISO_8859_8, "CP28598"},
160 
161  {PG_SJIS, "SJIS"},
162  {PG_SJIS, "PCK"},
163  {PG_SJIS, "CP932"},
164  {PG_SJIS, "SHIFT_JIS"},
165 
166  {PG_BIG5, "BIG5"},
167  {PG_BIG5, "BIG5HKSCS"},
168  {PG_BIG5, "Big5-HKSCS"},
169  {PG_BIG5, "CP950"},
170 
171  {PG_GBK, "GBK"},
172  {PG_GBK, "CP936"},
173 
174  {PG_UHC, "UHC"},
175  {PG_UHC, "CP949"},
176 
177  {PG_JOHAB, "JOHAB"},
178  {PG_JOHAB, "CP1361"},
179 
180  {PG_GB18030, "GB18030"},
181  {PG_GB18030, "CP54936"},
182 
183  {PG_SHIFT_JIS_2004, "SJIS_2004"},
184 
185  {PG_SQL_ASCII, "US-ASCII"},
186 
187  {PG_SQL_ASCII, NULL} /* end marker */
188 };
189 
190 #ifdef WIN32
191 /*
192  * On Windows, use CP<code page number> instead of the nl_langinfo() result
193  *
194  * Visual Studio 2012 expanded the set of valid LC_CTYPE values, so have its
195  * locale machinery determine the code page. See comments at IsoLocaleName().
196  * For other compilers, follow the locale's predictable format.
197  *
198  * Visual Studio 2015 should still be able to do the same, but the declaration
199  * of lc_codepage is missing in _locale_t, causing this code compilation to
200  * fail, hence this falls back instead on GetLocaleInfoEx. VS 2015 may be an
201  * exception and post-VS2015 versions should be able to handle properly the
202  * codepage number using _create_locale(). So, instead of the same logic as
203  * VS 2012 and VS 2013, this routine uses GetLocaleInfoEx to parse short
204  * locale names like "de-DE", "fr-FR", etc. If those cannot be parsed correctly
205  * process falls back to the pre-VS-2010 manual parsing done with
206  * using <Language>_<Country>.<CodePage> as a base.
207  *
208  * Returns a malloc()'d string for the caller to free.
209  */
210 static char *
211 win32_langinfo(const char *ctype)
212 {
213  char *r = NULL;
214 
215 #if defined(_MSC_VER) && (_MSC_VER < 1900)
216  _locale_t loct = NULL;
217 
218  loct = _create_locale(LC_CTYPE, ctype);
219  if (loct != NULL)
220  {
221  r = malloc(16); /* excess */
222  if (r != NULL)
223  sprintf(r, "CP%u", loct->locinfo->lc_codepage);
224  _free_locale(loct);
225  }
226 #else
227  char *codepage;
228 
229 #if defined(_MSC_VER) && (_MSC_VER >= 1900)
230  uint32 cp;
231  WCHAR wctype[LOCALE_NAME_MAX_LENGTH];
232 
233  memset(wctype, 0, sizeof(wctype));
234  MultiByteToWideChar(CP_ACP, 0, ctype, -1, wctype, LOCALE_NAME_MAX_LENGTH);
235 
236  if (GetLocaleInfoEx(wctype,
237  LOCALE_IDEFAULTANSICODEPAGE | LOCALE_RETURN_NUMBER,
238  (LPWSTR) &cp, sizeof(cp) / sizeof(WCHAR)) > 0)
239  {
240  r = malloc(16); /* excess */
241  if (r != NULL)
242  {
243  /*
244  * If the return value is CP_ACP that means no ANSI code page is
245  * available, so only Unicode can be used for the locale.
246  */
247  if (cp == CP_ACP)
248  strcpy(r, "utf8");
249  else
250  sprintf(r, "CP%u", cp);
251  }
252  }
253  else
254 #endif
255  {
256  /*
257  * Locale format on Win32 is <Language>_<Country>.<CodePage>. For
258  * example, English_United States.1252. If we see digits after the
259  * last dot, assume it's a codepage number. Otherwise, we might be
260  * dealing with a Unix-style locale string; Windows' setlocale() will
261  * take those even though GetLocaleInfoEx() won't, so we end up here.
262  * In that case, just return what's after the last dot and hope we can
263  * find it in our table.
264  */
265  codepage = strrchr(ctype, '.');
266  if (codepage != NULL)
267  {
268  size_t ln;
269 
270  codepage++;
271  ln = strlen(codepage);
272  r = malloc(ln + 3);
273  if (r != NULL)
274  {
275  if (strspn(codepage, "0123456789") == ln)
276  sprintf(r, "CP%s", codepage);
277  else
278  strcpy(r, codepage);
279  }
280  }
281  }
282 #endif
283 
284  return r;
285 }
286 
287 #ifndef FRONTEND
288 /*
289  * Given a Windows code page identifier, find the corresponding PostgreSQL
290  * encoding. Issue a warning and return -1 if none found.
291  */
292 int
293 pg_codepage_to_encoding(UINT cp)
294 {
295  char sys[16];
296  int i;
297 
298  sprintf(sys, "CP%u", cp);
299 
300  /* Check the table */
301  for (i = 0; encoding_match_list[i].system_enc_name; i++)
304 
306  (errmsg("could not determine encoding for codeset \"%s\"", sys)));
307 
308  return -1;
309 }
310 #endif
311 #endif /* WIN32 */
312 
313 #if (defined(HAVE_LANGINFO_H) && defined(CODESET)) || defined(WIN32)
314 
315 /*
316  * Given a setting for LC_CTYPE, return the Postgres ID of the associated
317  * encoding, if we can determine it. Return -1 if we can't determine it.
318  *
319  * Pass in NULL to get the encoding for the current locale setting.
320  * Pass "" to get the encoding selected by the server's environment.
321  *
322  * If the result is PG_SQL_ASCII, callers should treat it as being compatible
323  * with any desired encoding.
324  *
325  * If running in the backend and write_message is false, this function must
326  * cope with the possibility that elog() and palloc() are not yet usable.
327  */
328 int
329 pg_get_encoding_from_locale(const char *ctype, bool write_message)
330 {
331  char *sys;
332  int i;
333 
334  /* Get the CODESET property, and also LC_CTYPE if not passed in */
335  if (ctype)
336  {
337  char *save;
338  char *name;
339 
340  /* If locale is C or POSIX, we can allow all encodings */
341  if (pg_strcasecmp(ctype, "C") == 0 ||
342  pg_strcasecmp(ctype, "POSIX") == 0)
343  return PG_SQL_ASCII;
344 
345  save = setlocale(LC_CTYPE, NULL);
346  if (!save)
347  return -1; /* setlocale() broken? */
348  /* must copy result, or it might change after setlocale */
349  save = strdup(save);
350  if (!save)
351  return -1; /* out of memory; unlikely */
352 
353  name = setlocale(LC_CTYPE, ctype);
354  if (!name)
355  {
356  free(save);
357  return -1; /* bogus ctype passed in? */
358  }
359 
360 #ifndef WIN32
361  sys = nl_langinfo(CODESET);
362  if (sys)
363  sys = strdup(sys);
364 #else
365  sys = win32_langinfo(name);
366 #endif
367 
368  setlocale(LC_CTYPE, save);
369  free(save);
370  }
371  else
372  {
373  /* much easier... */
374  ctype = setlocale(LC_CTYPE, NULL);
375  if (!ctype)
376  return -1; /* setlocale() broken? */
377 
378  /* If locale is C or POSIX, we can allow all encodings */
379  if (pg_strcasecmp(ctype, "C") == 0 ||
380  pg_strcasecmp(ctype, "POSIX") == 0)
381  return PG_SQL_ASCII;
382 
383 #ifndef WIN32
384  sys = nl_langinfo(CODESET);
385  if (sys)
386  sys = strdup(sys);
387 #else
388  sys = win32_langinfo(ctype);
389 #endif
390  }
391 
392  if (!sys)
393  return -1; /* out of memory; unlikely */
394 
395  /* Check the table */
396  for (i = 0; encoding_match_list[i].system_enc_name; i++)
397  {
399  {
400  free(sys);
402  }
403  }
404 
405  /* Special-case kluges for particular platforms go here */
406 
407 #ifdef __darwin__
408 
409  /*
410  * Current macOS has many locales that report an empty string for CODESET,
411  * but they all seem to actually use UTF-8.
412  */
413  if (strlen(sys) == 0)
414  {
415  free(sys);
416  return PG_UTF8;
417  }
418 #endif
419 
420  /*
421  * We print a warning if we got a CODESET string but couldn't recognize
422  * it. This means we need another entry in the table.
423  */
424  if (write_message)
425  {
426 #ifdef FRONTEND
427  fprintf(stderr, _("could not determine encoding for locale \"%s\": codeset is \"%s\""),
428  ctype, sys);
429  /* keep newline separate so there's only one translatable string */
430  fputc('\n', stderr);
431 #else
433  (errmsg("could not determine encoding for locale \"%s\": codeset is \"%s\"",
434  ctype, sys)));
435 #endif
436  }
437 
438  free(sys);
439  return -1;
440 }
441 #else /* (HAVE_LANGINFO_H && CODESET) || WIN32 */
442 
443 /*
444  * stub if no multi-language platform support
445  *
446  * Note: we could return -1 here, but that would have the effect of
447  * forcing users to specify an encoding to initdb on such platforms.
448  * It seems better to silently default to SQL_ASCII.
449  */
450 int
451 pg_get_encoding_from_locale(const char *ctype, bool write_message)
452 {
453  return PG_SQL_ASCII;
454 }
455 
456 #endif /* (HAVE_LANGINFO_H && CODESET) || WIN32 */
unsigned int uint32
Definition: c.h:452
static const struct encoding_match encoding_match_list[]
Definition: chklocale.c:45
int pg_get_encoding_from_locale(const char *ctype, bool write_message)
Definition: chklocale.c:451
int errmsg(const char *fmt,...)
Definition: elog.c:904
#define _(x)
Definition: elog.c:89
#define WARNING
Definition: elog.h:30
#define ereport(elevel,...)
Definition: elog.h:143
const char * name
Definition: encode.c:561
#define free(a)
Definition: header.h:65
#define malloc(a)
Definition: header.h:50
int i
Definition: isn.c:73
pg_enc
Definition: pg_wchar.h:223
@ PG_WIN1254
Definition: pg_wchar.h:255
@ PG_LATIN4
Definition: pg_wchar.h:235
@ PG_LATIN9
Definition: pg_wchar.h:240
@ PG_JOHAB
Definition: pg_wchar.h:267
@ PG_GB18030
Definition: pg_wchar.h:266
@ PG_SQL_ASCII
Definition: pg_wchar.h:224
@ PG_KOI8R
Definition: pg_wchar.h:246
@ PG_ISO_8859_6
Definition: pg_wchar.h:250
@ PG_WIN1253
Definition: pg_wchar.h:254
@ PG_KOI8U
Definition: pg_wchar.h:258
@ PG_LATIN6
Definition: pg_wchar.h:237
@ PG_LATIN5
Definition: pg_wchar.h:236
@ PG_EUC_CN
Definition: pg_wchar.h:226
@ PG_UHC
Definition: pg_wchar.h:265
@ PG_LATIN2
Definition: pg_wchar.h:233
@ PG_ISO_8859_5
Definition: pg_wchar.h:249
@ PG_LATIN10
Definition: pg_wchar.h:241
@ PG_WIN1250
Definition: pg_wchar.h:253
@ PG_ISO_8859_7
Definition: pg_wchar.h:251
@ PG_SJIS
Definition: pg_wchar.h:262
@ PG_LATIN8
Definition: pg_wchar.h:239
@ PG_EUC_JP
Definition: pg_wchar.h:225
@ PG_GBK
Definition: pg_wchar.h:264
@ PG_LATIN3
Definition: pg_wchar.h:234
@ PG_WIN1256
Definition: pg_wchar.h:242
@ PG_LATIN1
Definition: pg_wchar.h:232
@ PG_EUC_TW
Definition: pg_wchar.h:228
@ PG_WIN1258
Definition: pg_wchar.h:243
@ PG_SHIFT_JIS_2004
Definition: pg_wchar.h:268
@ PG_WIN1252
Definition: pg_wchar.h:248
@ PG_LATIN7
Definition: pg_wchar.h:238
@ PG_UTF8
Definition: pg_wchar.h:230
@ PG_WIN1255
Definition: pg_wchar.h:256
@ PG_WIN1257
Definition: pg_wchar.h:257
@ PG_WIN1251
Definition: pg_wchar.h:247
@ PG_EUC_KR
Definition: pg_wchar.h:227
@ PG_WIN866
Definition: pg_wchar.h:244
@ PG_ISO_8859_8
Definition: pg_wchar.h:252
@ PG_WIN874
Definition: pg_wchar.h:245
@ PG_BIG5
Definition: pg_wchar.h:263
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
#define sprintf
Definition: port.h:227
#define fprintf
Definition: port.h:229
enum pg_enc pg_enc_code
Definition: chklocale.c:41
const char * system_enc_name
Definition: chklocale.c:42
#define setlocale(a, b)
Definition: win32_port.h:446