[thirdparty/cups.git] / cups / langprintf.c

/*
 * "$Id: langprintf.c 10996 2013-05-29 11:51:34Z msweet $"
 *
 *   Localized printf/puts functions for CUPS.
 *
 *   Copyright 2007-2012 by Apple Inc.
 *   Copyright 2002-2007 by Easy Software Products.
 *
 *   These coded instructions, statements, and computer programs are the
 *   property of Apple Inc. and are protected by Federal copyright
 *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
 *   which should have been included with this file.  If this file is
 *   file is missing or damaged, see the license at "http://www.cups.org/".
 *
 *   This file is subject to the Apple OS-Developed Software exception.
 *
 * Contents:
 *
 *   _cupsLangPrintError()  - Print a message followed by a standard error.
 *   _cupsLangPrintFilter() - Print a formatted filter message string to a file.
 *   _cupsLangPrintf()      - Print a formatted message string to a file.
 *   _cupsLangPuts()        - Print a static message string to a file.
 *   _cupsSetLocale()       - Set the current locale and transcode the
 *                            command-line.
 */

/*
 * Include necessary headers...
 */

#include "cups-private.h"


/*
 * '_cupsLangPrintError()' - Print a message followed by a standard error.
 */

void
_cupsLangPrintError(const char *prefix,	/* I - Non-localized message prefix */
                    const char *message)/* I - Message */
{
  int		bytes;			/* Number of bytes formatted */
  int		last_errno;		/* Last error */
  char		buffer[2048],		/* Message buffer */
		*bufptr,		/* Pointer into buffer */
		output[8192];		/* Output buffer */
  _cups_globals_t *cg;			/* Global data */


 /*
  * Range check...
  */

  if (!message)
    return;

 /*
  * Save the errno value...
  */

  last_errno = errno;

 /*
  * Get the message catalog...
  */

  cg = _cupsGlobals();

  if (!cg->lang_default)
    cg->lang_default = cupsLangDefault();

 /*
  * Format the message...
  */

  if (prefix)
  {
    snprintf(buffer, sizeof(buffer), "%s:", prefix);
    bufptr = buffer + strlen(buffer);
  }
  else
    bufptr = buffer;

  snprintf(bufptr, sizeof(buffer) - (bufptr - buffer),
	   /* TRANSLATORS: Message is "subject: error" */
	   _cupsLangString(cg->lang_default, _("%s: %s")),
	   _cupsLangString(cg->lang_default, message), strerror(last_errno));
  strlcat(buffer, "\n", sizeof(buffer));

 /*
  * Convert and write to stderr...
  */

  bytes = cupsUTF8ToCharset(output, (cups_utf8_t *)buffer, sizeof(output),
                            cg->lang_default->encoding);

  if (bytes > 0)
    fwrite(output, 1, bytes, stderr);
}


/*
 * '_cupsLangPrintFilter()' - Print a formatted filter message string to a file.
 */

int					/* O - Number of bytes written */
_cupsLangPrintFilter(
    FILE       *fp,			/* I - File to write to */
    const char *prefix,			/* I - Non-localized message prefix */
    const char *message,		/* I - Message string to use */
    ...)				/* I - Additional arguments as needed */
{
  int		bytes;			/* Number of bytes formatted */
  char		temp[2048],		/* Temporary format buffer */
		buffer[2048],		/* Message buffer */
		output[8192];		/* Output buffer */
  va_list 	ap;			/* Pointer to additional arguments */
  _cups_globals_t *cg;			/* Global data */


 /*
  * Range check...
  */

  if (!fp || !message)
    return (-1);

  cg = _cupsGlobals();

  if (!cg->lang_default)
    cg->lang_default = cupsLangDefault();

 /*
  * Format the string...
  */

  va_start(ap, message);
  snprintf(temp, sizeof(temp), "%s: %s\n", prefix,
	   _cupsLangString(cg->lang_default, message));
  vsnprintf(buffer, sizeof(buffer), temp, ap);
  va_end(ap);

 /*
  * Transcode to the destination charset...
  */

  bytes = cupsUTF8ToCharset(output, (cups_utf8_t *)buffer, sizeof(output),
                            cg->lang_default->encoding);

 /*
  * Write the string and return the number of bytes written...
  */

  if (bytes > 0)
    return ((int)fwrite(output, 1, bytes, fp));
  else
    return (bytes);
}


/*
 * '_cupsLangPrintf()' - Print a formatted message string to a file.
 */

int					/* O - Number of bytes written */
_cupsLangPrintf(FILE       *fp,		/* I - File to write to */
		const char *message,	/* I - Message string to use */
	        ...)			/* I - Additional arguments as needed */
{
  int		bytes;			/* Number of bytes formatted */
  char		buffer[2048],		/* Message buffer */
		output[8192];		/* Output buffer */
  va_list 	ap;			/* Pointer to additional arguments */
  _cups_globals_t *cg;			/* Global data */


 /*
  * Range check...
  */

  if (!fp || !message)
    return (-1);

  cg = _cupsGlobals();

  if (!cg->lang_default)
    cg->lang_default = cupsLangDefault();

 /*
  * Format the string...
  */

  va_start(ap, message);
  vsnprintf(buffer, sizeof(buffer) - 1,
	    _cupsLangString(cg->lang_default, message), ap);
  va_end(ap);

  strlcat(buffer, "\n", sizeof(buffer));

 /*
  * Transcode to the destination charset...
  */

  bytes = cupsUTF8ToCharset(output, (cups_utf8_t *)buffer, sizeof(output),
                            cg->lang_default->encoding);

 /*
  * Write the string and return the number of bytes written...
  */

  if (bytes > 0)
    return ((int)fwrite(output, 1, bytes, fp));
  else
    return (bytes);
}


/*
 * '_cupsLangPuts()' - Print a static message string to a file.
 */

int					/* O - Number of bytes written */
_cupsLangPuts(FILE       *fp,		/* I - File to write to */
              const char *message)	/* I - Message string to use */
{
  int		bytes;			/* Number of bytes formatted */
  char		output[8192];		/* Message buffer */
  _cups_globals_t *cg;			/* Global data */


 /*
  * Range check...
  */

  if (!fp || !message)
    return (-1);

  cg = _cupsGlobals();

  if (!cg->lang_default)
    cg->lang_default = cupsLangDefault();

 /*
  * Transcode to the destination charset...
  */

  bytes = cupsUTF8ToCharset(output,
			    (cups_utf8_t *)_cupsLangString(cg->lang_default,
							   message),
			    sizeof(output) - 4, cg->lang_default->encoding);
  bytes += cupsUTF8ToCharset(output + bytes, (cups_utf8_t *)"\n",
                             sizeof(output) - bytes,
			     cg->lang_default->encoding);

 /*
  * Write the string and return the number of bytes written...
  */

  if (bytes > 0)
    return ((int)fwrite(output, 1, bytes, fp));
  else
    return (bytes);
}


/*
 * '_cupsSetLocale()' - Set the current locale and transcode the command-line.
 */

void
_cupsSetLocale(char *argv[])		/* IO - Command-line arguments */
{
  int		i;			/* Looping var */
  char		buffer[8192];		/* Command-line argument buffer */
  _cups_globals_t *cg;			/* Global data */
#ifdef LC_TIME
  const char	*lc_time;		/* Current LC_TIME value */
  char		new_lc_time[255],	/* New LC_TIME value */
		*charset;		/* Pointer to character set */
#endif /* LC_TIME */


 /*
  * Set the locale so that times, etc. are displayed properly.
  *
  * Unfortunately, while we need the localized time value, we *don't*
  * want to use the localized charset for the time value, so we need
  * to set LC_TIME to the locale name with .UTF-8 on the end (if
  * the locale includes a character set specifier...)
  */

  setlocale(LC_ALL, "");

#ifdef LC_TIME
  if ((lc_time = setlocale(LC_TIME, NULL)) == NULL)
    lc_time = setlocale(LC_ALL, NULL);

  if (lc_time)
  {
    strlcpy(new_lc_time, lc_time, sizeof(new_lc_time));
    if ((charset = strchr(new_lc_time, '.')) == NULL)
      charset = new_lc_time + strlen(new_lc_time);

    strlcpy(charset, ".UTF-8", sizeof(new_lc_time) - (charset - new_lc_time));
  }
  else
    strlcpy(new_lc_time, "C", sizeof(new_lc_time));

  setlocale(LC_TIME, new_lc_time);
#endif /* LC_TIME */

 /*
  * Initialize the default language info...
  */

  cg = _cupsGlobals();

  if (!cg->lang_default)
    cg->lang_default = cupsLangDefault();

 /*
  * Transcode the command-line arguments from the locale charset to
  * UTF-8...
  */

  if (cg->lang_default->encoding != CUPS_US_ASCII &&
      cg->lang_default->encoding != CUPS_UTF8)
  {
    for (i = 1; argv[i]; i ++)
    {
     /*
      * Try converting from the locale charset to UTF-8...
      */

      if (cupsCharsetToUTF8((cups_utf8_t *)buffer, argv[i], sizeof(buffer),
                            cg->lang_default->encoding) < 0)
        continue;

     /*
      * Save the new string if it differs from the original...
      */

      if (strcmp(buffer, argv[i]))
        argv[i] = strdup(buffer);
    }
  }
}


/*
 * End of "$Id: langprintf.c 10996 2013-05-29 11:51:34Z msweet $".
 */
Commit	Line	Data
ef416fc2	1	/*
61515785	2	* "$Id: langprintf.c 10996 2013-05-29 11:51:34Z msweet $"
ef416fc2	3	*
71e16022	4	* Localized printf/puts functions for CUPS.
ef416fc2	5	*
5a9febac	6	* Copyright 2007-2012 by Apple Inc.
b86bc4cf	7	* Copyright 2002-2007 by Easy Software Products.
ef416fc2	8	*
ef416fc2	9	* These coded instructions, statements, and computer programs are the
bc44d920	10	* property of Apple Inc. and are protected by Federal copyright
	11	* law. Distribution and use rights are outlined in the file "LICENSE.txt"
	12	* which should have been included with this file. If this file is
	13	* file is missing or damaged, see the license at "http://www.cups.org/".
ef416fc2	14	*
	15	* This file is subject to the Apple OS-Developed Software exception.
	16	*
	17	* Contents:
	18	*
0837b7e8 MS	19	* _cupsLangPrintError() - Print a message followed by a standard error.
	20	* _cupsLangPrintFilter() - Print a formatted filter message string to a file.
	21	* _cupsLangPrintf() - Print a formatted message string to a file.
	22	* _cupsLangPuts() - Print a static message string to a file.
	23	* _cupsSetLocale() - Set the current locale and transcode the
	24	* command-line.
ef416fc2	25	*/
	26
	27	/*
	28	* Include necessary headers...
	29	*/
	30
71e16022	31	#include "cups-private.h"
080811b1 MS	32
	33
	34	/*
	35	* '_cupsLangPrintError()' - Print a message followed by a standard error.
	36	*/
	37
	38	void
0837b7e8 MS	39	_cupsLangPrintError(const char prefix, / I - Non-localized message prefix */
0837b7e8 MS	40	const char message)/ I - Message */
080811b1 MS	41	{
	42	int bytes; /* Number of bytes formatted */
	43	int last_errno; /* Last error */
	44	char buffer[2048], /* Message buffer */
84315f46	45	bufptr, / Pointer into buffer */
080811b1 MS	46	output[8192]; /* Output buffer */
	47	_cups_globals_t cg; / Global data */
	48
	49
	50	/*
	51	* Range check...
	52	*/
	53
	54	if (!message)
	55	return;
	56
	57	/*
	58	* Save the errno value...
	59	*/
	60
	61	last_errno = errno;
	62
	63	/*
	64	* Get the message catalog...
	65	*/
	66
	67	cg = _cupsGlobals();
	68
	69	if (!cg->lang_default)
	70	cg->lang_default = cupsLangDefault();
	71
	72	/*
	73	* Format the message...
	74	*/
	75
84315f46 MS	76	if (prefix)
	77	{
	78	snprintf(buffer, sizeof(buffer), "%s:", prefix);
	79	bufptr = buffer + strlen(buffer);
	80	}
	81	else
	82	bufptr = buffer;
	83
	84	snprintf(bufptr, sizeof(buffer) - (bufptr - buffer),
	85	/* TRANSLATORS: Message is "subject: error" */
	86	_cupsLangString(cg->lang_default, _("%s: %s")),
1f0275e3	87	_cupsLangString(cg->lang_default, message), strerror(last_errno));
84315f46	88	strlcat(buffer, "\n", sizeof(buffer));
080811b1 MS	89
	90	/*
	91	* Convert and write to stderr...
	92	*/
	93
	94	bytes = cupsUTF8ToCharset(output, (cups_utf8_t *)buffer, sizeof(output),
	95	cg->lang_default->encoding);
	96
	97	if (bytes > 0)
	98	fwrite(output, 1, bytes, stderr);
	99	}
ef416fc2	100
ef416fc2	101
0837b7e8 MS	102	/*
	103	* '_cupsLangPrintFilter()' - Print a formatted filter message string to a file.
	104	*/
	105
	106	int /* O - Number of bytes written */
	107	_cupsLangPrintFilter(
	108	FILE fp, / I - File to write to */
	109	const char prefix, / I - Non-localized message prefix */
	110	const char message, / I - Message string to use */
	111	...) /* I - Additional arguments as needed */
	112	{
	113	int bytes; /* Number of bytes formatted */
	114	char temp[2048], /* Temporary format buffer */
	115	buffer[2048], /* Message buffer */
	116	output[8192]; /* Output buffer */
	117	va_list ap; /* Pointer to additional arguments */
	118	_cups_globals_t cg; / Global data */
	119
	120
	121	/*
	122	* Range check...
	123	*/
	124
	125	if (!fp \|\| !message)
	126	return (-1);
	127
	128	cg = _cupsGlobals();
	129
	130	if (!cg->lang_default)
	131	cg->lang_default = cupsLangDefault();
	132
	133	/*
	134	* Format the string...
	135	*/
	136
	137	va_start(ap, message);
	138	snprintf(temp, sizeof(temp), "%s: %s\n", prefix,
	139	_cupsLangString(cg->lang_default, message));
	140	vsnprintf(buffer, sizeof(buffer), temp, ap);
	141	va_end(ap);
	142
	143	/*
	144	* Transcode to the destination charset...
	145	*/
	146
	147	bytes = cupsUTF8ToCharset(output, (cups_utf8_t *)buffer, sizeof(output),
	148	cg->lang_default->encoding);
	149
	150	/*
	151	* Write the string and return the number of bytes written...
	152	*/
	153
	154	if (bytes > 0)
	155	return ((int)fwrite(output, 1, bytes, fp));
	156	else
	157	return (bytes);
	158	}
	159
	160
ef416fc2	161	/*
	162	* '_cupsLangPrintf()' - Print a formatted message string to a file.
	163	*/
	164
	165	int /* O - Number of bytes written */
0837b7e8 MS	166	_cupsLangPrintf(FILE fp, / I - File to write to */
0837b7e8 MS	167	const char message, / I - Message string to use */
ef416fc2	168	...) /* I - Additional arguments as needed */
	169	{
	170	int bytes; /* Number of bytes formatted */
	171	char buffer[2048], /* Message buffer */
	172	output[8192]; /* Output buffer */
	173	va_list ap; /* Pointer to additional arguments */
fa73b229	174	_cups_globals_t cg; / Global data */
ef416fc2	175
	176
	177	/*
	178	* Range check...
	179	*/
	180
	181	if (!fp \|\| !message)
	182	return (-1);
	183
fa73b229	184	cg = _cupsGlobals();
	185
	186	if (!cg->lang_default)
	187	cg->lang_default = cupsLangDefault();
ef416fc2	188
	189	/*
	190	* Format the string...
	191	*/
	192
	193	va_start(ap, message);
0837b7e8 MS	194	vsnprintf(buffer, sizeof(buffer) - 1,
0837b7e8 MS	195	_cupsLangString(cg->lang_default, message), ap);
ef416fc2	196	va_end(ap);
ef416fc2	197
0837b7e8 MS	198	strlcat(buffer, "\n", sizeof(buffer));
0837b7e8 MS	199
ef416fc2	200	/*
	201	* Transcode to the destination charset...
	202	*/
	203
	204	bytes = cupsUTF8ToCharset(output, (cups_utf8_t *)buffer, sizeof(output),
fa73b229	205	cg->lang_default->encoding);
ef416fc2	206
	207	/*
	208	* Write the string and return the number of bytes written...
	209	*/
	210
	211	if (bytes > 0)
b86bc4cf	212	return ((int)fwrite(output, 1, bytes, fp));
ef416fc2	213	else
	214	return (bytes);
	215	}
	216
	217
	218	/*
	219	* '_cupsLangPuts()' - Print a static message string to a file.
	220	*/
	221
	222	int /* O - Number of bytes written */
0837b7e8 MS	223	_cupsLangPuts(FILE fp, / I - File to write to */
0837b7e8 MS	224	const char message) / I - Message string to use */
ef416fc2	225	{
ef416fc2	226	int bytes; /* Number of bytes formatted */
0837b7e8	227	char output[8192]; /* Message buffer */
fa73b229	228	_cups_globals_t cg; / Global data */
ef416fc2	229
	230
	231	/*
	232	* Range check...
	233	*/
	234
	235	if (!fp \|\| !message)
	236	return (-1);
	237
fa73b229	238	cg = _cupsGlobals();
	239
	240	if (!cg->lang_default)
	241	cg->lang_default = cupsLangDefault();
ef416fc2	242
	243	/*
	244	* Transcode to the destination charset...
	245	*/
	246
	247	bytes = cupsUTF8ToCharset(output,
0837b7e8 MS	248	(cups_utf8_t *)_cupsLangString(cg->lang_default,
	249	message),
	250	sizeof(output) - 4, cg->lang_default->encoding);
	251	bytes += cupsUTF8ToCharset(output + bytes, (cups_utf8_t *)"\n",
	252	sizeof(output) - bytes,
	253	cg->lang_default->encoding);
ef416fc2	254
	255	/*
	256	* Write the string and return the number of bytes written...
	257	*/
	258
	259	if (bytes > 0)
b86bc4cf	260	return ((int)fwrite(output, 1, bytes, fp));
ef416fc2	261	else
	262	return (bytes);
	263	}
	264
	265
	266	/*
07725fee	267	* '_cupsSetLocale()' - Set the current locale and transcode the command-line.
d09495fa	268	*/
	269
	270	void
07725fee	271	_cupsSetLocale(char argv[]) / IO - Command-line arguments */
d09495fa	272	{
07725fee	273	int i; /* Looping var */
	274	char buffer[8192]; /* Command-line argument buffer */
	275	_cups_globals_t cg; / Global data */
d09495fa	276	#ifdef LC_TIME
07725fee	277	const char lc_time; / Current LC_TIME value */
07725fee	278	char new_lc_time[255], /* New LC_TIME value */
d09495fa	279	charset; / Pointer to character set */
	280	#endif /* LC_TIME */
	281
	282
	283	/*
	284	* Set the locale so that times, etc. are displayed properly.
	285	*
	286	* Unfortunately, while we need the localized time value, we don't
	287	* want to use the localized charset for the time value, so we need
	288	* to set LC_TIME to the locale name with .UTF-8 on the end (if
	289	* the locale includes a character set specifier...)
	290	*/
	291
	292	setlocale(LC_ALL, "");
	293
	294	#ifdef LC_TIME
	295	if ((lc_time = setlocale(LC_TIME, NULL)) == NULL)
	296	lc_time = setlocale(LC_ALL, NULL);
	297
	298	if (lc_time)
	299	{
	300	strlcpy(new_lc_time, lc_time, sizeof(new_lc_time));
	301	if ((charset = strchr(new_lc_time, '.')) == NULL)
	302	charset = new_lc_time + strlen(new_lc_time);
	303
	304	strlcpy(charset, ".UTF-8", sizeof(new_lc_time) - (charset - new_lc_time));
	305	}
	306	else
5a9febac	307	strlcpy(new_lc_time, "C", sizeof(new_lc_time));
d09495fa	308
	309	setlocale(LC_TIME, new_lc_time);
	310	#endif /* LC_TIME */
07725fee	311
	312	/*
	313	* Initialize the default language info...
	314	*/
	315
	316	cg = _cupsGlobals();
	317
	318	if (!cg->lang_default)
	319	cg->lang_default = cupsLangDefault();
	320
	321	/*
	322	* Transcode the command-line arguments from the locale charset to
	323	* UTF-8...
	324	*/
	325
	326	if (cg->lang_default->encoding != CUPS_US_ASCII &&
	327	cg->lang_default->encoding != CUPS_UTF8)
	328	{
	329	for (i = 1; argv[i]; i ++)
	330	{
	331	/*
	332	* Try converting from the locale charset to UTF-8...
	333	*/
	334
	335	if (cupsCharsetToUTF8((cups_utf8_t *)buffer, argv[i], sizeof(buffer),
	336	cg->lang_default->encoding) < 0)
	337	continue;
	338
	339	/*
	340	* Save the new string if it differs from the original...
	341	*/
	342
	343	if (strcmp(buffer, argv[i]))
	344	argv[i] = strdup(buffer);
	345	}
	346	}
d09495fa	347	}
	348
	349
	350	/*
61515785	351	* End of "$Id: langprintf.c 10996 2013-05-29 11:51:34Z msweet $".
ef416fc2	352	*/