package be.nikiroo.utils.resources; import java.awt.Color; import java.io.BufferedWriter; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStreamReader; import java.io.OutputStreamWriter; import java.io.Reader; import java.io.Writer; import java.lang.reflect.Field; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Locale; import java.util.Map; import java.util.MissingResourceException; import java.util.PropertyResourceBundle; import java.util.ResourceBundle; /** * This class encapsulate a {@link ResourceBundle} in UTF-8. It allows to * retrieve values associated to an enumeration, and allows some additional * methods. *
* It also sports a writable change map, and you can save back the
* {@link Bundle} to file with {@link Bundle#updateFile(String)}.
*
* @author niki
*
* @param
* Will use the most likely candidate as base if the file does not already
* exists and this resource is translatable (for instance, "en_US" will use
* "en" as a base if the resource is a translation file).
*
* @param path
* the path where the .properties files are
*
* @throws IOException
* in case of IO errors
*/
public void updateFile(String path) throws IOException {
File file = getUpdateFile(path);
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(
new FileOutputStream(file), "UTF-8"));
writeHeader(writer);
writer.write("\n");
writer.write("\n");
for (Field field : type.getDeclaredFields()) {
Meta meta = field.getAnnotation(Meta.class);
if (meta != null) {
E id = E.valueOf(type, field.getName());
String info = getMetaInfo(meta);
if (info != null) {
writer.write(info);
writer.write("\n");
}
writeValue(writer, id);
}
}
writer.close();
}
/**
* Reload the {@link Bundle} data files.
*
* @param resetToDefault
* reset to the default configuration (do not look into the
* possible user configuration files, only take the original
* configuration)
*/
public void reload(boolean resetToDefault) {
setBundle(name, null, resetToDefault);
}
/**
* Check if the internal map contains the given key.
*
* @param key
* the key to check for
*
* @return true if it does
*/
protected boolean containsKey(String key) {
if (changeMap.containsKey(key)) {
return true;
}
if (map != null) {
try {
map.getObject(key);
return true;
} catch (MissingResourceException e) {
}
}
return false;
}
/**
* Get the value for the given key if it exists in the internal map, or NULL
* if not.
*
* @param key
* the key to check for
*
* @return the value, or NULL
*/
protected String getString(String key) {
if (changeMap.containsKey(key)) {
return changeMap.get(key);
}
if (map != null && containsKey(key)) {
return map.getString(key);
}
return null;
}
/**
* Set the value for this key, in the change map (it is kept in memory, not
* yet on disk).
*
* @param key
* the key
* @param value
* the associated value
*/
protected void setString(String key, String value) {
changeMap.put(key, value);
}
/**
* Return formated, display-able information from the {@link Meta} field
* given. Each line will always starts with a "#" character.
*
* @param meta
* the {@link Meta} field
*
* @return the information to display or NULL if none
*/
protected String getMetaInfo(Meta meta) {
String what = meta.what();
String where = meta.where();
String format = meta.format();
String info = meta.info();
int opt = what.length() + where.length() + format.length();
if (opt + info.length() == 0)
return null;
StringBuilder builder = new StringBuilder();
builder.append("# ");
if (opt > 0) {
builder.append("(");
if (what.length() > 0) {
builder.append("WHAT: " + what);
if (where.length() + format.length() > 0)
builder.append(", ");
}
if (where.length() > 0) {
builder.append("WHERE: " + where);
if (format.length() > 0)
builder.append(", ");
}
if (format.length() > 0) {
builder.append("FORMAT: " + format);
}
builder.append(")");
if (info.length() > 0) {
builder.append("\n# ");
}
}
builder.append(info);
return builder.toString();
}
/**
* The display name used in the .properties file.
*
* @return the name
*/
protected String getBundleDisplayName() {
return name.toString();
}
/**
* Write the header found in the configuration .properties file of
* this {@link Bundles}.
*
* @param writer
* the {@link Writer} to write the header in
*
* @throws IOException
* in case of IO error
*/
protected void writeHeader(Writer writer) throws IOException {
writer.write("# " + getBundleDisplayName() + "\n");
writer.write("#\n");
}
/**
* Write the given id to the config file, i.e., "MY_ID = my_curent_value"
* followed by a new line
*
* @param writer
* the {@link Writer} to write into
* @param id
* the id to write
*
* @throws IOException
* in case of IO error
*/
protected void writeValue(Writer writer, E id) throws IOException {
writeValue(writer, id.name(), getString(id));
}
/**
* Write the given data to the config file, i.e., "MY_ID = my_curent_value"
* followed by a new line
*
* @param writer
* the {@link Writer} to write into
* @param id
* the id to write
* @param value
* the id's value
*
* @throws IOException
* in case of IO error
*/
protected void writeValue(Writer writer, String id, String value)
throws IOException {
writer.write(id);
writer.write(" = ");
if (value == null) {
value = "";
}
String[] lines = value.replaceAll("\t", "\\\\\\t").split("\n");
for (int i = 0; i < lines.length; i++) {
writer.write(lines[i]);
if (i < lines.length - 1) {
writer.write("\\n\\");
}
writer.write("\n");
}
}
/**
* Return the source file for this {@link Bundles} from the given path.
*
* @param path
* the path where the .properties files are
*
* @return the source {@link File}
*
* @throws IOException
* in case of IO errors
*/
protected File getUpdateFile(String path) {
return new File(path, name.name() + ".properties");
}
/**
* Change the currently used bundle, and reset all changes.
*
* @param name
* the name of the bundle to load
* @param locale
* the {@link Locale} to use
* @param resetToDefault
* reset to the default configuration (do not look into the
* possible user configuration files, only take the original
* configuration)
*/
protected void setBundle(Enum> name, Locale locale, boolean resetToDefault) {
map = null;
changeMap.clear();
String dir = Bundles.getDirectory();
if (!resetToDefault && dir != null) {
try {
File file = getPropertyFile(dir, name.name(), locale);
if (file != null) {
Reader reader = new InputStreamReader(new FileInputStream(
file), "UTF8");
map = new PropertyResourceBundle(reader);
}
} catch (IOException e) {
e.printStackTrace();
}
}
if (map == null) {
try {
map = ResourceBundle.getBundle(type.getPackage().getName()
+ "." + name.name(), locale,
new FixedResourceBundleControl());
} catch (Exception e) {
// We have no bundle for this Bundle
map = null;
}
}
}
/**
* Take a snapshot of the changes in memory in this {@link Bundle} made by
* the "set" methods ( {@link Bundle#setString(Enum, String)}...) at the
* current time.
*
* @return a snapshot to use with {@link Bundle#restoreChanges(Object)}
*/
protected Object takeChangesSnapshot() {
return new HashMap