Mercurial > repos > IBBoard
annotate Lang/Translation.cs @ 23:fb4fdab841db
* Ignore schema location attribute for translations
* Make sure exceptions get passed as exceptions to log notify listeners if they were passed as the only parameter
no-open-ticket
| author | IBBoard <dev@ibboard.co.uk> |
|---|---|
| date | Sat, 14 Mar 2009 20:12:29 +0000 |
| parents | ea058f9ea9d4 |
| children | 2b5e73cb83a3 |
| rev | line source |
|---|---|
| 16 | 1 // This file (Translation.cs) is a part of the IBBoard library and is copyright 2009 IBBoard. |
| 2 // | |
| 3 // The file and the library/program it is in are licensed under the GNU LGPL license, either version 3 of the License or (at your option) any later version. Please see COPYING.LGPL for more information and the full license. | |
| 4 | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
5 using System; |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
6 using System.IO; |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
7 using System.Xml; |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
8 using System.Xml.Schema; |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
9 using System.Collections.Generic; |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
10 using System.Reflection; |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
11 using System.ComponentModel; |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
12 using IBBoard.IO; |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
13 using IBBoard.Logging; |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
14 using IBBoard.Xml; |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
15 |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
16 namespace IBBoard.Lang |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
17 { |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
18 /// <summary> |
| 6 | 19 /// A basic string translator that loads a default language and a specified language and returns translated strings that correspond to translation IDs. |
| 20 /// If the string doesn't exist in the specified language then the translator falls back to the default language. If the translation doesn't exist in the default language | |
| 21 /// then either a supplied value or a "no validation available" message is returned. | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
22 /// </summary> |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
23 public class Translation |
| 6 | 24 { |
| 25 private static readonly string DEFAULT_LANGUAGE = "en"; | |
| 26 private static readonly string DIVIDER_STRING = "-"; | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
27 private static string lang = ""; |
| 6 | 28 private static DirectoryInfo translationDir; |
| 29 private static Dictionary<string, string> translationsLocal; | |
|
22
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
30 private static Dictionary<string, string> translationsDefault; |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
31 private static XmlReaderSettings settings; |
| 6 | 32 |
| 33 /// <summary> | |
|
21
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
34 /// Initialises the translations for the language specified and the default translations so that the Translation class can be used. |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
35 /// Throws a TranslationLoadException if a problem occurred while loading translations. If this occurs then the translation methods can |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
36 /// still be called but no translation will be performed. |
| 6 | 37 /// </summary> |
| 38 /// <param name="appPath"> | |
| 39 /// The full path that the application is running from. Must contain the "translations" folder. | |
| 40 /// </param> | |
| 41 /// <param name="language"> | |
| 42 /// The language to use as the load language | |
| 43 /// </param> | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
44 public static void InitialiseTranslations(string appPath, string language) |
| 6 | 45 { |
| 46 InitialiseDefaults(appPath); | |
| 47 FileInfo file = GetTranslationFile(DEFAULT_LANGUAGE); | |
| 48 XmlDocument doc = LoadTranslationDocument(file); | |
| 49 LoadTranslationsFromDocument(doc, translationsDefault); | |
|
10
3b7a321e7c4c
Fixes #4 - unexpected exception in translations
IBBoard <dev@ibboard.co.uk>
parents:
9
diff
changeset
|
50 LoadTranslationForLanguage(language); |
| 6 | 51 } |
| 52 | |
| 53 private static void InitialiseDefaults(string appPath) | |
| 54 { | |
| 55 string translationPath = appPath.TrimEnd(Constants.DirectoryChar) + Constants.DirectoryString + "translations"; | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
56 |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
57 if (Directory.Exists(translationPath)) |
| 6 | 58 { |
| 59 translationsDefault = new Dictionary<string,string>(); | |
| 60 translationsLocal = new Dictionary<string,string>(); | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
61 translationDir = new DirectoryInfo(translationPath); |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
62 } |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
63 else |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
64 { |
|
21
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
65 throw new TranslationLoadException("Translation path not found ("+translationPath+")"); |
| 6 | 66 } |
| 67 } | |
| 68 | |
| 69 private static XmlDocument LoadTranslationDocument(FileInfo file) | |
| 70 { | |
|
22
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
71 XmlDocument doc = new XmlDocument(); |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
72 XmlReader valReader = XmlReader.Create(file.FullName, GetReaderSettings()); |
|
21
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
73 |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
74 try |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
75 { |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
76 doc.Load(valReader); |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
77 } |
|
22
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
78 catch (DirectoryNotFoundException ex) |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
79 { |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
80 throw new TranslationLoadException("Problem validating schema for translation: " + ex.Message, ex); |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
81 } |
|
21
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
82 catch (XmlSchemaException ex) |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
83 { |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
84 throw new TranslationLoadException("Problem validating schema for translation: " + ex.Message, ex); |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
85 } |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
86 catch (XmlException ex) |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
87 { |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
88 throw new TranslationLoadException("Problem reading data for translation: " + ex.Message, ex); |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
89 } |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
90 finally |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
91 { |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
92 valReader.Close(); |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
93 } |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
94 |
| 6 | 95 return doc; |
| 96 } | |
| 97 | |
|
22
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
98 /// <summary> |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
99 /// Lazy-getter for XML reader settings. May throw a <see cref="TranslationLoadException"/> if there is a problem with the translation schema. |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
100 /// </summary> |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
101 /// <returns> |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
102 /// A <see cref="XmlReaderSettings"/> with the default values for validating the translation document against the translation schema |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
103 /// </returns> |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
104 private static XmlReaderSettings GetReaderSettings() |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
105 { |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
106 if (settings == null) |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
107 { |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
108 try |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
109 { |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
110 settings = new XmlReaderSettings(); |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
111 settings.XmlResolver = new IBBXmlResolver(translationDir.Parent.FullName); |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
112 settings.ValidationType = ValidationType.Schema; |
|
23
fb4fdab841db
* Ignore schema location attribute for translations
IBBoard <dev@ibboard.co.uk>
parents:
22
diff
changeset
|
113 settings.ValidationFlags = XmlSchemaValidationFlags.ReportValidationWarnings; |
|
22
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
114 settings.ValidationEventHandler+= new ValidationEventHandler(ValidationEventMethod); |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
115 XmlSchemaSet cache = new XmlSchemaSet(); |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
116 cache.Add("http://ibboard.co.uk/translation", translationDir.Parent.FullName + "/dtds/translation.xsd"); |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
117 settings.Schemas.Add(cache); |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
118 } |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
119 catch (DirectoryNotFoundException ex) |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
120 { |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
121 throw new TranslationLoadException("Problem validating schema for translation: " + ex.Message, ex); |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
122 } |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
123 catch (XmlSchemaException ex) |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
124 { |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
125 throw new TranslationLoadException("Problem validating schema for translation: " + ex.Message, ex); |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
126 } |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
127 catch (XmlException ex) |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
128 { |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
129 throw new TranslationLoadException("Problem reading data for schema: " + ex.Message, ex); |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
130 } |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
131 } |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
132 |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
133 return settings; |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
134 } |
|
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
135 |
| 6 | 136 private static FileInfo GetTranslationFile(string language) |
| 137 { | |
| 138 FileInfo file = new FileInfo(translationDir.FullName + Constants.DirectoryString + language + ".translation"); | |
| 139 | |
| 140 if (!file.Exists) | |
| 141 { | |
|
21
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
142 throw new TranslationLoadException(language + ".translation could not be found in "+translationDir.FullName); |
| 6 | 143 } |
| 144 | |
| 145 return file; | |
| 146 } | |
| 147 | |
| 148 private static void LoadTranslationsFromDocument(XmlDocument doc, Dictionary<string, string> translationTable) | |
| 149 { | |
| 150 try | |
| 151 { | |
| 152 XmlNodeList translations = doc.GetElementsByTagName("translation"); | |
| 153 | |
| 154 if (translations.Count==0) | |
| 155 { | |
| 156 throw new InvalidFileException("No translations found in "+GetLanguageOfDocument(doc)+".translation"); | |
| 157 } | |
| 158 | |
| 159 Dictionary<string, string> tempTranslationTable = new Dictionary<string,string>(); | |
| 160 | |
| 161 foreach (XmlNode node in translations) | |
| 162 { | |
| 163 tempTranslationTable.Add(node.Attributes["id"].Value, node.InnerText); | |
| 164 } | |
| 165 | |
| 166 translationTable.Clear(); | |
| 167 | |
| 168 foreach (string key in tempTranslationTable.Keys) | |
| 169 { | |
| 170 string translation; | |
| 171 tempTranslationTable.TryGetValue(key, out translation); | |
| 172 translationTable.Add(key, translation); | |
| 173 } | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
174 } |
| 6 | 175 catch(Exception ex) |
| 176 { | |
|
21
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
177 throw new TranslationLoadException("Error while parsing " + GetLanguageOfDocument(doc)+" translation: "+ex.Message, ex); |
| 6 | 178 } |
| 179 } | |
| 180 | |
| 181 private static string GetLanguageOfDocument(XmlDocument doc) | |
| 182 { | |
| 183 return doc != null ? doc.DocumentElement.GetAttribute("lang") : ""; | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
184 } |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
185 |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
186 private static void ValidationEventMethod(object sender, ValidationEventArgs e) |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
187 { |
|
22
ea058f9ea9d4
Closes #15 - Migrate to schema for translations
IBBoard <dev@ibboard.co.uk>
parents:
21
diff
changeset
|
188 throw new TranslationLoadException("Problem validating schema for translation: " + e.Exception.Message, e.Exception); |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
189 } |
| 6 | 190 |
| 191 /// <summary> | |
|
21
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
192 /// Loads translations for a given language and sets them as the local language. |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
193 /// hrows a TranslationLoadException if a problem occurred while loading translations. If this occurs then the translation methods can |
|
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
194 /// still be called but all translations will fall back to the default translation. |
| 6 | 195 /// </summary> |
| 196 /// <param name="translationLang"> | |
| 197 /// The new local language to load | |
| 198 /// </param> | |
|
7
f4da31cb09d9
* Add translation DTD to utils project
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
199 public static void LoadTranslation(string translationLanguage) |
|
f4da31cb09d9
* Add translation DTD to utils project
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
200 { |
|
f4da31cb09d9
* Add translation DTD to utils project
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
201 if (translationLanguage == "" || translationLanguage == null) |
| 6 | 202 { |
|
10
3b7a321e7c4c
Fixes #4 - unexpected exception in translations
IBBoard <dev@ibboard.co.uk>
parents:
9
diff
changeset
|
203 throw new ArgumentException("Translation language cannot be null or empty"); |
| 6 | 204 } |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
205 |
|
8
d6ce8764e92b
Fix typo in method name reference
IBBoard <dev@ibboard.co.uk>
parents:
7
diff
changeset
|
206 LoadTranslationForLanguage(translationLanguage); |
|
7
f4da31cb09d9
* Add translation DTD to utils project
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
207 } |
|
f4da31cb09d9
* Add translation DTD to utils project
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
208 |
|
f4da31cb09d9
* Add translation DTD to utils project
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
209 private static void LoadTranslationForLanguage(string translationLanguage) |
|
f4da31cb09d9
* Add translation DTD to utils project
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
210 { |
|
21
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
211 CheckInitialisation(); |
|
7
f4da31cb09d9
* Add translation DTD to utils project
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
212 |
|
f4da31cb09d9
* Add translation DTD to utils project
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
213 if (translationLanguage != DEFAULT_LANGUAGE && translationLanguage != "" && translationLanguage != null) |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
214 { |
| 9 | 215 FileInfo file = GetTranslationFile(translationLanguage); |
| 6 | 216 XmlDocument doc = LoadTranslationDocument(file); |
| 217 LoadTranslationsFromDocument(doc, translationsLocal); | |
| 218 } | |
| 219 else | |
| 220 { | |
| 221 translationsLocal.Clear(); | |
| 222 } | |
| 223 | |
| 9 | 224 lang = translationLanguage; |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
225 } |
| 6 | 226 |
| 227 /// <summary> | |
| 228 /// Gets a translation for a given ID, falling back to a "missing translation" message if none can be found. Also optionally replaces any placeholders with the supplied values. | |
| 229 /// </summary> | |
| 230 /// <param name="translationID"> | |
| 231 /// The ID to look up the translation for | |
| 232 /// </param> | |
| 233 /// <param name="replacements"> | |
| 234 /// A collection of <see cref="System.Object"/>s to replace placeholders with | |
| 235 /// </param> | |
| 236 /// <returns> | |
| 237 /// The translation with the placeholders replaced or a "missing translation" message | |
| 238 /// </returns> | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
239 public static string GetTranslation(string translationID, params object[] replacements) |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
240 { |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
241 return GetTranslation(translationID, false, replacements); |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
242 } |
| 6 | 243 |
| 244 /// <summary> | |
| 245 /// Gets a translation for a given ID, falling back to null or a warning message if a translation cannot be found. Also optionally replaces any placeholders with the supplied values. | |
| 246 /// </summary> | |
| 247 /// <param name="translationID"> | |
| 248 /// The ID to look up the translation for | |
| 249 /// </param> | |
| 250 /// <param name="returnNullOnFail"> | |
| 251 /// TRUE if null should be returned when no translation can be found, or FALSE if a "missing translation" message should be returned | |
| 252 /// </param> | |
| 253 /// <param name="replacements"> | |
| 254 /// A collection of <see cref="System.Object"/>s to replace placeholders with | |
| 255 /// </param> | |
| 256 /// <returns> | |
| 257 /// The translation with the placeholders replaced, or a "missing translation" message or null depending on <param name="returnNullOnFail"> | |
| 258 /// </returns> | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
259 public static string GetTranslation(string translationID, bool returnNullOnFail, params object[] replacements) |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
260 { |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
261 return GetTranslation(translationID, returnNullOnFail ? null : "", replacements); |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
262 } |
| 6 | 263 |
| 264 /// <summary> | |
| 265 /// Gets a translation for a given ID, falling back to a supplied default if a translation cannot be found. Also optionally replaces any placeholders with the supplied values. | |
| 266 /// </summary> | |
| 267 /// <param name="translationID"> | |
| 268 /// The ID to look up the translation for | |
| 269 /// </param> | |
| 270 /// <param name="defaultTranslation"> | |
| 271 /// The string to return if no translation can be found. Can be null or any string. | |
| 272 /// </param> | |
| 273 /// <param name="replacements"> | |
| 274 /// A collection of <see cref="System.Object"/>s to replace placeholders with | |
| 275 /// </param> | |
| 276 /// <returns> | |
| 277 /// The translation, if one exists, or the supplied default with the placeholders replaced | |
| 278 /// </returns> | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
279 public static string GetTranslation(string translationID, string defaultTranslation, params object[] replacements) |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
280 { |
|
21
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
281 CheckInitialisation(); |
| 6 | 282 string trans = GetTranslationFromTables(translationID); |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
283 |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
284 if (trans == null) |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
285 { |
| 6 | 286 trans = GetDefaultTranslation(translationID, defaultTranslation); |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
287 } |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
288 |
| 6 | 289 trans = AddVariablesToTranslation(trans, replacements); |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
290 |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
291 return trans; |
| 6 | 292 } |
| 293 | |
| 294 private static string GetTranslationFromTables(string translationID) | |
| 295 { | |
| 296 string translation = null; | |
| 297 | |
| 298 if (translationsLocal!=null) | |
| 299 { | |
| 300 translationsLocal.TryGetValue(translationID, out translation); | |
| 301 } | |
| 302 | |
| 303 if (translation == null) | |
| 304 { | |
| 305 translationsDefault.TryGetValue(translationID, out translation); | |
| 306 } | |
| 307 | |
| 308 return translation; | |
| 309 } | |
| 310 | |
| 311 private static string GetDefaultTranslation(string translationID, string defaultTranslation) | |
| 312 { | |
| 313 return (defaultTranslation != "" && defaultTranslation != null) ? defaultTranslation : GetMissingTranslationMessage(translationID); | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
314 } |
| 6 | 315 |
| 316 private static string GetMissingTranslationMessage(string translationID) | |
| 317 { | |
| 318 return "++ Missing Translation "+translationID+" ++"; | |
| 319 } | |
| 320 | |
| 321 private static string AddVariablesToTranslation(string translation, object[] replacements) | |
| 322 { | |
| 323 if (translation != null && replacements != null && replacements.Length > 0) | |
| 324 { | |
| 325 translation = String.Format(translation, replacements); | |
| 326 } | |
| 327 | |
| 328 return translation; | |
| 329 } | |
| 330 | |
|
21
c8d74202182a
Closes #14 - Throw specific exceptions from translations
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
331 private static void CheckInitialisation() |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
332 { |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
333 if (translationDir==null) |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
334 { |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
335 throw new InvalidOperationException("Translation class has not been initialised"); |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
336 } |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
337 } |
| 6 | 338 |
| 339 /// <summary> | |
| 340 /// Translate an <see cref="ITranslatable"/> item, with optional string replacement | |
| 341 /// </summary> | |
| 342 /// <param name="item"> | |
| 343 /// A <see cref="ITranslatable"/> to set the text for | |
| 344 /// </param> | |
| 345 /// <param name="replacements"> | |
| 346 /// A collection of <see cref="System.Object"/>s that will be used to fill place-holders | |
| 347 /// </param> | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
348 public static void Translate(ITranslatable item, params object[] replacements) |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
349 { |
| 6 | 350 if (item.Text == "" || item.Text == DIVIDER_STRING) |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
351 { |
| 6 | 352 //it doesn't need translating - either there is no text from the developer or it's a hyphen for a divider |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
353 return; |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
354 } |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
355 |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
356 item.Text = GetTranslation(item.Name, replacements); |
| 6 | 357 } |
| 358 | |
| 359 /// <summary> | |
| 360 /// Get the current local translation language. This is an arbitrary string used in the translation file's name and will not necessarily match the ISO language code. | |
| 361 /// </summary> | |
| 362 /// <returns> | |
| 363 /// The string used in the file name of the current local translation | |
| 364 /// </returns> | |
| 365 public static string GetTranslationLanguage() | |
| 366 { | |
| 367 return lang; | |
|
0
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
368 } |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
369 } |
|
961030992bd2
Initial commit of IBBoard libraries
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
370 } |