1 karl 1.25 //%2006////////////////////////////////////////////////////////////////////////
|
2 humberto 1.8 //
|
3 karl 1.10 // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
4 // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
5 // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
|
6 karl 1.9 // IBM Corp.; EMC Corporation, The Open Group.
|
7 karl 1.10 // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
8 // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
|
9 karl 1.11 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
10 // EMC Corporation; VERITAS Software Corporation; The Open Group.
|
11 karl 1.25 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
12 // EMC Corporation; Symantec Corporation; The Open Group.
|
13 humberto 1.8 //
14 // Permission is hereby granted, free of charge, to any person obtaining a copy
15 // of this software and associated documentation files (the "Software"), to
16 // deal in the Software without restriction, including without limitation the
17 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
18 // sell copies of the Software, and to permit persons to whom the Software is
19 // furnished to do so, subject to the following conditions:
20 //
21 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
22 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
23 // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
24 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
25 // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
26 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
27 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 //
30 //==============================================================================
31 //
32 //%/////////////////////////////////////////////////////////////////////////////
33
34 humberto 1.8 #include <Pegasus/Common/LanguageParser.h>
35 #include <Pegasus/Common/InternalException.h>
36 #include <Pegasus/Common/Tracer.h>
|
37 kumpf 1.30 #include <Pegasus/Common/MessageLoader.h>
|
38 humberto 1.8 #include <cstring>
39
|
40 kumpf 1.21 #ifdef PEGASUS_HAS_ICU
41 # include <unicode/locid.h>
42 #endif
43
|
44 humberto 1.8 PEGASUS_NAMESPACE_BEGIN
45
|
46 kumpf 1.21 static char LANGUAGE_TAG_SEPARATOR_CHAR = '-';
|
47 kumpf 1.26 static char LOCALE_ID_SEPARATOR_CHAR = '_';
|
48 kumpf 1.21
|
49 kumpf 1.23 AcceptLanguageList LanguageParser::parseAcceptLanguageHeader(
|
50 kumpf 1.21 const String& acceptLanguageHeader)
51 {
52 PEG_METHOD_ENTER(TRC_L10N, "LanguageParser::parseAcceptLanguageHeader");
53
|
54 kumpf 1.23 AcceptLanguageList acceptLanguages;
|
55 kumpf 1.21
56 try
57 {
58 Array<String> languageElements;
59 LanguageParser::_parseLanguageHeader(
60 acceptLanguageHeader,
61 languageElements);
62
63 for (Uint32 i = 0; i < languageElements.size(); i++)
64 {
65 String languageTagString;
66 Real32 qualityValue;
67 LanguageParser::_parseAcceptLanguageElement(
68 languageElements[i], languageTagString, qualityValue);
|
69 kumpf 1.30 acceptLanguages.insert(
70 LanguageTag(languageTagString), qualityValue);
|
71 kumpf 1.21 }
72 }
73 catch (Exception& e)
74 {
75 throw InvalidAcceptLanguageHeader(e.getMessage());
76 }
77
78 PEG_METHOD_EXIT();
79 return acceptLanguages;
80 }
81
|
82 kumpf 1.23 ContentLanguageList LanguageParser::parseContentLanguageHeader(
|
83 kumpf 1.21 const String& contentLanguageHeader)
84 {
85 PEG_METHOD_ENTER(TRC_L10N, "LanguageParser::parseContentLanguageHeader");
86
|
87 kumpf 1.23 ContentLanguageList contentLanguages;
|
88 kumpf 1.21
89 try
90 {
91 Array<String> languageElements;
92 LanguageParser::_parseLanguageHeader(
93 contentLanguageHeader,
94 languageElements);
95
96 for (Uint32 i = 0; i < languageElements.size(); i++)
97 {
98 contentLanguages.append(LanguageTag(languageElements[i]));
99 }
100 }
101 catch (Exception& e)
102 {
103 throw InvalidContentLanguageHeader(e.getMessage());
104 }
105
106 PEG_METHOD_EXIT();
107 return contentLanguages;
108 }
109 kumpf 1.21
110 void LanguageParser::parseLanguageTag(
|
111 kumpf 1.24 const String& languageTagString,
|
112 kumpf 1.21 String& language,
113 String& country,
114 String& variant)
115 {
116 PEG_METHOD_ENTER(TRC_L10N, "LanguageParser::parseLanguageTag");
117
118 language.clear();
119 country.clear();
120 variant.clear();
121
122 if (languageTagString == "*")
123 {
124 // Parsing and validation is complete
125 PEG_METHOD_EXIT();
126 return;
127 }
128
129 Boolean isStandardFormat = true; // RFC 3066 (ISO 639, ISO 3166)
130 Array<String> subtags;
131
132 _parseLanguageSubtags(subtags, languageTagString);
133 kumpf 1.21
134 // _parseLanguageSubtags() always returns at least one subtag.
135 PEGASUS_ASSERT(subtags.size() > 0);
136
137 // Validate the primary subtag.
138 // Given a languageTagString "en-US-mn" the language is "en".
139
140 language = subtags[0];
141
142 if ((language == "i") || (language == "x"))
143 {
144 // These primary tags are allowed, but are not ISO 639 compliant
145 isStandardFormat = false;
146 language.clear();
147 }
148 else if ((language.size() != 2) && (language.size() != 3))
149 {
150 // Except for "i" and "x", primary tags must be 2 or 3 characters,
151 // according to RFC 3066.
|
152 kumpf 1.33
153 // Do not localize this message; it could cause recursion.
|
154 kumpf 1.21 PEG_METHOD_EXIT();
|
155 kumpf 1.33 throw Exception(Formatter::format(
156 "Invalid language tag \"$0\".",
157 languageTagString));
|
158 kumpf 1.21 }
159
160 if (subtags.size() == 1)
161 {
162 // If only the primary subtag is present, we are done!
163 PEG_METHOD_EXIT();
164 return;
165 }
166
167 // Validate the second subtag.
168 // Given a languageTagString "en-US-mn" the country is "US".
169
170 if (subtags[1].size() == 1)
171 {
172 // The second subtag may not be a single character according to
173 // RFC 3066.
|
174 kumpf 1.33
175 // Do not localize this message; it could cause recursion.
|
176 kumpf 1.21 PEG_METHOD_EXIT();
|
177 kumpf 1.33 throw Exception(Formatter::format(
178 "Invalid language tag \"$0\".",
179 languageTagString));
|
180 kumpf 1.21 }
181
182 if (isStandardFormat)
183 {
184 Uint32 variantIndex = 1;
185
186 if (subtags[1].size() == 2)
187 {
188 country = subtags[1];
189 variantIndex = 2;
190 }
191
192 Uint32 numSubtags = subtags.size();
193
194 if (variantIndex < numSubtags)
195 {
196 variant = subtags[variantIndex++];
197
198 while (variantIndex < numSubtags)
199 {
200 variant.append(LANGUAGE_TAG_SEPARATOR_CHAR);
201 kumpf 1.21 variant.append(subtags[variantIndex++]);
202 }
203 }
204 }
205
206 PEG_METHOD_EXIT();
207 }
208
209 void LanguageParser::validateQualityValue(Real32 quality)
210 {
211 if ((quality > 1.0) || (quality < 0.0))
212 {
213 MessageLoaderParms parms(
214 "Common.LanguageParser.INVALID_QUALITY_VALUE",
215 "AcceptLanguage contains an invalid quality value");
216 throw InvalidAcceptLanguageHeader(MessageLoader::getMessage(parms));
217 }
218 }
219
220 String LanguageParser::buildAcceptLanguageHeader(
|
221 kumpf 1.23 const AcceptLanguageList& acceptLanguages)
|
222 kumpf 1.21 {
223 String alString;
224 Uint32 numAcceptLanguages = acceptLanguages.size();
225
226 for (Uint32 i = 0; i < numAcceptLanguages; i++)
227 {
228 alString.append(acceptLanguages.getLanguageTag(i).toString());
229
230 Real32 q = acceptLanguages.getQualityValue(i);
231 if (q != 1.0)
232 {
233 char qValueString[6];
234 sprintf(qValueString, "%4.3f", q);
235 alString.append(";q=");
236 alString.append(qValueString);
237 }
238
239 if (i < numAcceptLanguages - 1)
240 {
241 alString.append(",");
242 }
243 kumpf 1.21 }
244
245 return alString;
246 }
247
248 String LanguageParser::buildContentLanguageHeader(
|
249 kumpf 1.23 const ContentLanguageList& contentLanguages)
|
250 kumpf 1.21 {
251 String clString;
252 Uint32 numContentLanguages = contentLanguages.size();
253
254 for (Uint32 i = 0; i < numContentLanguages; i++)
255 {
256 clString.append(contentLanguages.getLanguageTag(i).toString());
257
258 if (i < numContentLanguages - 1)
259 {
260 clString.append(",");
261 }
262 }
263
264 return clString;
265 }
266
|
267 kumpf 1.26 #ifdef PEGASUS_HAS_ICU
268 String& LanguageParser::convertLocaleIdToLanguageTag(String& localeId)
269 {
270 Uint32 index = 0;
271 while ((index = localeId.find(index, LOCALE_ID_SEPARATOR_CHAR)) !=
272 PEG_NOT_FOUND)
273 {
274 localeId[index] = LANGUAGE_TAG_SEPARATOR_CHAR;
275 }
276 return localeId;
277 }
278 #endif
279
|
280 kumpf 1.23 AcceptLanguageList LanguageParser::getDefaultAcceptLanguages()
|
281 kumpf 1.21 {
282 #if defined(PEGASUS_HAS_MESSAGES) && defined(PEGASUS_HAS_ICU)
283 Locale default_loc = Locale::getDefault();
284
|
285 kumpf 1.26 String localeId = default_loc.getName();
286
|
287 kumpf 1.21 try
288 {
|
289 kumpf 1.26 return LanguageParser::parseAcceptLanguageHeader(
290 convertLocaleIdToLanguageTag(localeId));
|
291 kumpf 1.21 }
292 catch (const InvalidAcceptLanguageHeader& e)
293 {
294 Logger::put_l(Logger::ERROR_LOG, System::CIMSERVER, Logger::SEVERE,
|
295 kumpf 1.32 "src.Server.cimserver.FAILED_TO_SET_PROCESS_LOCALE",
296 "Cannot convert the system process locale into a valid "
297 "Accept-Language format.");
|
298 kumpf 1.21 Logger::put(Logger::ERROR_LOG, System::CIMSERVER, Logger::SEVERE,
299 e.getMessage());
|
300 kumpf 1.23 AcceptLanguageList al;
|
301 kumpf 1.22 al.insert(LanguageTag("*"), 1);
302 return al;
|
303 kumpf 1.21 }
|
304 kumpf 1.22 #else
|
305 kumpf 1.23 return AcceptLanguageList();
|
306 kumpf 1.21 #endif
307 }
308
309 void LanguageParser::_parseLanguageHeader(
310 const String& languageHeaderValue,
311 Array<String>& languageElements)
312 {
313 PEG_METHOD_ENTER(TRC_L10N, "LanguageParser::_parseLanguageHeader");
314
315 languageElements.clear();
316 String element;
317
318 for (Uint32 i=0, len=languageHeaderValue.size(); i<len; i++)
319 {
320 Char16 nextChar = languageHeaderValue[i];
321
322 if (isascii(nextChar) && isspace(nextChar))
323 {
324 // Ignore whitespace
325 }
326 else if (nextChar == '(')
327 kumpf 1.21 {
328 // Ignore comments
329 while (i < len)
330 {
331 // Search for the closing parenthesis
332 if (languageHeaderValue[i] == ')')
333 {
334 break;
335 }
336
337 // Skip over escape characters
338 if (languageHeaderValue[i] == '\\')
339 {
340 i++;
341 }
342
343 i++;
344 }
345
346 // Check for a missing closing parenthesis
347 if (i >= len)
348 kumpf 1.21 {
349 MessageLoaderParms parms(
350 "Common.LanguageParser.DOES_NOT_CONTAIN_TERMINATING",
351 "Closing \")\" character is missing.");
352 throw Exception(MessageLoader::getMessage(parms));
353 }
354 }
355 else if (nextChar == ',')
356 {
357 // Check for the end of the element
358 languageElements.append(element);
359 element.clear();
360 }
361 else
362 {
363 // Unescape an escape character
364 if ((nextChar == '\\') && (i < len-1))
365 {
366 nextChar = languageHeaderValue[++i];
367 }
368
369 kumpf 1.21 // Include this character in the value
370 element.append(nextChar);
371 }
372 }
373
374 // Include the last element in the languageElements array
375 languageElements.append(element);
376
377 PEG_METHOD_EXIT();
378 }
379
380 void LanguageParser::_parseAcceptLanguageElement(
381 const String& acceptLanguageElement,
382 String& languageTag,
383 Real32& quality)
384 {
385 PEG_METHOD_ENTER(TRC_L10N, "LanguageParser::_parseAcceptLanguageElement");
386
387 // look for ';' in acceptLanguageElement, that means we have a
388 // quality value to capture. If not present, we only have a language tag.
389
390 kumpf 1.21 Uint32 semicolonIndex = acceptLanguageElement.find(";");
391 if (semicolonIndex != PEG_NOT_FOUND)
392 {
393 // Separate the language tag and quality value
394
395 String qualityString =
396 acceptLanguageElement.subString(semicolonIndex+1);
397 languageTag = acceptLanguageElement.subString(0, semicolonIndex);
398
399 // Parse the quality value
|
400 humberto 1.8
|
401 kumpf 1.21 char dummyChar;
402 int scanfConversions = sscanf(
403 qualityString.getCString(),
404 "q=%f%c", &quality, &dummyChar);
405
406 if ((scanfConversions != 1) ||
407 (qualityString.size() > 7))
408 {
409 MessageLoaderParms parms(
410 "Common.LanguageParser.INVALID_QUALITY_VALUE",
411 "AcceptLanguage contains an invalid quality value");
412 PEG_METHOD_EXIT();
413 throw Exception(MessageLoader::getMessage(parms));
414 }
415 }
416 else
417 {
418 languageTag = acceptLanguageElement;
419 quality = 1.0;
420 }
421
422 kumpf 1.21 PEG_METHOD_EXIT();
423 }
424
425 void LanguageParser::_parseLanguageSubtags(
426 Array<String>& subtags,
427 const String& languageTagString)
428 {
429 PEG_METHOD_ENTER(TRC_L10N, "LanguageParser::_parseLanguageSubtags");
430
431 // Parse the language tag into subtags
432
433 Uint32 subtagIndex = 0;
434 Uint32 separatorIndex;
435 while ((separatorIndex = languageTagString.find(
436 subtagIndex, LANGUAGE_TAG_SEPARATOR_CHAR)) != PEG_NOT_FOUND)
437 {
438 subtags.append(languageTagString.subString(
439 subtagIndex, separatorIndex - subtagIndex));
440 subtagIndex = separatorIndex + 1;
441 }
442 subtags.append(languageTagString.subString(subtagIndex));
443 kumpf 1.21
444 // Validate the syntax of each of the subtags
445
446 for (Uint32 i = 0, n = subtags.size(); i < n; i++)
447 {
448 if (((i == 0) && !_isValidPrimarySubtagSyntax(subtags[i])) ||
449 ((i > 0) && !_isValidSubtagSyntax(subtags[i])))
450 {
451 MessageLoaderParms parms(
452 "Common.LanguageParser.MALFORMED_LANGUAGE_TAG",
453 "Malformed language tag \"$0\".", languageTagString);
454 PEG_METHOD_EXIT();
|
455 marek 1.29 // throw Exception(MessageLoader::getMessage(parms));
|
456 marek 1.28 // do not localize message, requires a language tag for this
457 // localization can cause recursion here
458 throw Exception(parms.toString());
|
459 kumpf 1.21 }
460 }
461
462 PEG_METHOD_EXIT();
|
463 humberto 1.8 }
464
|
465 kumpf 1.21 Boolean LanguageParser::_isValidPrimarySubtagSyntax(const String& subtag)
466 {
467 if ((subtag.size() == 0) || (subtag.size() > 8))
468 {
469 return false;
470 }
471
472 for (Uint32 i = 0, n = subtag.size(); i < n; i++)
473 {
474 if (!(isascii(subtag[i]) && isalpha(subtag[i])))
475 {
476 return false;
477 }
478 }
479
480 return true;
481 }
482
483 Boolean LanguageParser::_isValidSubtagSyntax(const String& subtag)
484 {
485 if ((subtag.size() == 0) || (subtag.size() > 8))
486 kumpf 1.21 {
487 return false;
488 }
489
490 for (Uint32 i = 0, n = subtag.size(); i < n; i++)
491 {
492 if (!(isascii(subtag[i]) && isalnum(subtag[i])))
493 {
494 return false;
495 }
496 }
497
498 return true;
499 }
|
500 humberto 1.8
501 PEGASUS_NAMESPACE_END
|