/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.ofbiz.webtools.labelmanager;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import org.apache.commons.lang.StringEscapeUtils;
import org.ofbiz.base.util.Debug;
import org.ofbiz.base.util.FileUtil;
import org.ofbiz.base.util.UtilGenerics;
import org.ofbiz.base.util.UtilMisc;
import org.ofbiz.base.util.UtilProperties;
import org.ofbiz.base.util.UtilValidate;
import org.ofbiz.base.util.UtilXml;
import org.ofbiz.base.util.cache.UtilCache;
import org.ofbiz.service.DispatchContext;
import org.ofbiz.service.ServiceUtil;
import org.w3c.dom.Comment;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
public class SaveLabelsToXmlFile {
private static final String resource = "WebtoolsUiLabels";
private static final String module = SaveLabelsToXmlFile.class.getName();
public static Map<String, Object> saveLabelsToXmlFile(DispatchContext dctx, Map<String, ? extends Object> context) {
Locale locale = (Locale) context.get("locale");
String fileName = (String) context.get("fileName");
if (UtilValidate.isEmpty(fileName)) {
Debug.logError("labelFileName cannot be empty", module);
return ServiceUtil.returnFailure(UtilProperties.getMessage(resource, "saveLabelsToXmlFile.exceptionDuringSaveLabelsToXmlFile", locale));
}
String key = (String) context.get("key");
String keyComment = (String) context.get("keyComment");
String update_label = (String) context.get("update_label");
String confirm = (String) context.get("confirm");
String removeLabel = (String) context.get("removeLabel");
List<String> localeNames = UtilGenerics.cast(context.get("localeNames"));
List<String> localeValues = UtilGenerics.cast(context.get("localeValues"));
List<String> localeComments = UtilGenerics.cast(context.get("localeComments"));
String apacheLicenseText = null;
try {
apacheLicenseText = FileUtil.readString("UTF-8", FileUtil.getFile("component://webtools/config/APACHE2_HEADER_FOR_XML"));
} catch (IOException e) {
Debug.logWarning(e, "Unable to read Apache License text file", module);
}
try {
LabelManagerFactory factory = LabelManagerFactory.getInstance();
LabelFile labelFile = factory.getLabelFile(fileName);
if (labelFile == null) {
Debug.logError("Invalid file name: " + fileName, module);
return ServiceUtil.returnFailure(UtilProperties.getMessage(resource, "saveLabelsToXmlFile.exceptionDuringSaveLabelsToXmlFile", locale));
}
synchronized(SaveLabelsToXmlFile.class) {
factory.findMatchingLabels(null, fileName, null, null);
Map<String, LabelInfo> labels = factory.getLabels();
Set<String> labelsList = factory.getLabelsList();
Set<String> localesFound = factory.getLocalesFound();
for (String localeName : localeNames) {
localesFound.add(localeName);
}
// Remove a Label
if (UtilValidate.isNotEmpty(removeLabel)) {
labels.remove(key + LabelManagerFactory.keySeparator + fileName);
} else if (UtilValidate.isNotEmpty(confirm)) {
LabelInfo label = labels.get(key + LabelManagerFactory.keySeparator + fileName);
// Update a Label
if (update_label.equalsIgnoreCase("Y")) {
if (UtilValidate.isNotEmpty(label)) {
factory.updateLabelValue(localeNames, localeValues, localeComments, label, key, keyComment, fileName);
}
// Insert a new Label
} else {
if (UtilValidate.isNotEmpty(label)) {
return ServiceUtil.returnError(UtilProperties.getMessage(resource, "WebtoolsLabelManagerNewLabelExisting", UtilMisc.toMap("key", key, "fileName", fileName), locale));
} else {
if (UtilValidate.isEmpty(key)) {
return ServiceUtil.returnError(UtilProperties.getMessage(resource, "WebtoolsLabelManagerNewLabelEmptyKey", locale));
} else {
int notEmptyLabels = factory.updateLabelValue(localeNames, localeValues, localeComments, null, key, keyComment, fileName);
if (notEmptyLabels == 0) {
return ServiceUtil.returnError(UtilProperties.getMessage(resource, "WebtoolsLabelManagerNewLabelEmpty", locale));
}
}
}
}
}
Document resourceDocument = UtilXml.makeEmptyXmlDocument("resource");
Element resourceElem = resourceDocument.getDocumentElement();
resourceElem.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
for (String labelKey : labelsList) {
LabelInfo labelInfo = labels.get(labelKey);
if (!(labelInfo.getFileName().equalsIgnoreCase(fileName))) {
continue;
}
Element propertyElem = UtilXml.addChildElement(resourceElem, "property", resourceDocument);
propertyElem.setAttribute("key", StringEscapeUtils.unescapeHtml(labelInfo.getLabelKey()));
if (UtilValidate.isNotEmpty(labelInfo.getLabelKeyComment())) {
Comment labelKeyComment = resourceDocument.createComment(StringEscapeUtils.unescapeHtml(labelInfo.getLabelKeyComment()));
Node parent = propertyElem.getParentNode();
parent.insertBefore(labelKeyComment, propertyElem);
}
for (String localeFound : localesFound) {
LabelValue labelValue = labelInfo.getLabelValue(localeFound);
String valueString = null;
if (labelValue != null) {
valueString = labelValue.getLabelValue();
}
if (UtilValidate.isNotEmpty(valueString)) {
valueString = StringEscapeUtils.unescapeHtml(valueString);
Element valueElem = UtilXml.addChildElementValue(propertyElem, "value", valueString, resourceDocument);
valueElem.setAttribute("xml:lang", localeFound);
if (valueString.trim().length() == 0) {
valueElem.setAttribute("xml:space", "preserve");
}
if (UtilValidate.isNotEmpty(labelValue.getLabelComment())) {
Comment labelComment = resourceDocument.createComment(StringEscapeUtils.unescapeHtml(labelValue.getLabelComment()));
Node parent = valueElem.getParentNode();
parent.insertBefore(labelComment, valueElem);
}
}
}
FileOutputStream fos = new FileOutputStream(labelFile.file);
try {
if (apacheLicenseText != null) {
fos.write(apacheLicenseText.getBytes());
}
UtilXml.writeXmlDocument(resourceElem, fos, "UTF-8", !(apacheLicenseText == null), true, 4);
} finally {
fos.close();
// clear cache to see immediately the new labels and
// translations in OFBiz
UtilCache.clearCache("properties.UtilPropertiesBundleCache");
}
}
}
} catch (Exception e) {
Debug.logError(e, "Exception during save labels to xml file:", module);
return ServiceUtil.returnFailure(UtilProperties.getMessage(resource, "saveLabelsToXmlFile.exceptionDuringSaveLabelsToXmlFile", locale));
}
return ServiceUtil.returnSuccess();
}
}