Author: tmortagne
Date: 2007-10-10 11:51:53 +0200 (Wed, 10 Oct 2007)
New Revision: 5341
Added:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/resources/
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/resources/applicationmanager/
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/resources/applicationmanager/ApplicationResources.properties
Modified:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManager.java
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManagerPluginApi.java
Log:
XAAM-18: Add internationnalised comments to plugin's actions that support
comments (Document.save, XWiki.saveDocument, etc) using XAAM-17
Modified:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManager.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManager.java
2007-10-10 09:46:23 UTC (rev 5340)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManager.java
2007-10-10 09:51:53 UTC (rev 5341)
@@ -78,7 +78,8 @@
XWikiDocument doc = xwiki.getDocument(docFullName, context);
if (!doc.isNew()) {
- return
(XWikiApplication)XWikiApplicationClass.getInstance(context).newSuperDocument(doc,
context);
+ return (XWikiApplication)
XWikiApplicationClass.getInstance(context)
+ .newSuperDocument(doc, context);
}
}
@@ -97,14 +98,15 @@
List applicationList = new ArrayList(documentList.size());
for (Iterator it = documentList.iterator(); it.hasNext();) {
-
applicationList.add(XWikiApplicationClass.getInstance(context).newSuperDocument((XWikiDocument)
it.next(), context));
+
applicationList.add(XWikiApplicationClass.getInstance(context).newSuperDocument(
+ (XWikiDocument) it.next(), context));
}
return applicationList;
}
public void createApplication(XWikiApplication userAppSuperDoc, boolean
failOnExist,
- XWikiContext context) throws XWikiException
+ String comment, XWikiContext context) throws XWikiException
{
XWiki xwiki = context.getWiki();
XWikiApplicationClass appClass =
XWikiApplicationClass.getInstance(context);
@@ -128,11 +130,13 @@
}
- XWikiApplication appSuperDocToSave =
(XWikiApplication)XWikiApplicationClass.getInstance(context).newSuperDocument(docToSave,
context);
+ XWikiApplication appSuperDocToSave =
+ (XWikiApplication)
XWikiApplicationClass.getInstance(context).newSuperDocument(
+ docToSave, context);
appSuperDocToSave.mergeBaseObject(userAppSuperDoc);
- appSuperDocToSave.save();
+ appSuperDocToSave.save(comment);
// Update user document with the new document name
userAppSuperDoc.setFullName(appSuperDocToSave.getFullName());
@@ -152,7 +156,8 @@
validate);
}
- public void updateAllApplicationTranslation(XWikiContext context) throws
XWikiException
+ public void updateAllApplicationTranslation(String comment, XWikiContext
context)
+ throws XWikiException
{
XWiki xwiki = context.getWiki();
@@ -175,12 +180,12 @@
if (updateprefs) {
prefsObject.setStringValue("documentBundles",
StringUtils.join(translationPrefs
.toArray(), ","));
- xwiki.saveDocument(prefsDoc, context);
+ xwiki.saveDocument(prefsDoc, comment, context);
}
}
- public void updateApplicationTranslation(XWikiApplication app,
XWikiContext context)
- throws XWikiException
+ public void updateApplicationTranslation(XWikiApplication app, String
comment,
+ XWikiContext context) throws XWikiException
{
XWiki xwiki = context.getWiki();
@@ -195,7 +200,7 @@
if (updateprefs) {
prefsObject.setStringValue("documentBundles",
StringUtils.join(translationPrefs
.toArray(), ","));
- xwiki.saveDocument(prefsDoc, context);
+ xwiki.saveDocument(prefsDoc, comment, context);
}
}
@@ -217,8 +222,8 @@
return updateprefs;
}
- public void exportApplicationXAR(String appName, boolean recurse, boolean
withDocHistory, XWikiContext context) throws XWikiException,
- IOException
+ public void exportApplicationXAR(String appName, boolean recurse, boolean
withDocHistory,
+ XWikiContext context) throws XWikiException, IOException
{
XWikiApplication app =
ApplicationManager.getInstance().getApplication(appName, context,
true);
@@ -231,13 +236,13 @@
for (Iterator it = documents.iterator(); it.hasNext();) {
export.add((String) it.next(), DocumentInfo.ACTION_OVERWRITE);
}
-
+
export.setWithVersions(withDocHistory);
export.export();
}
- public void importApplication(XWikiDocument packageDoc, String packageName,
+ public void importApplication(XWikiDocument packageDoc, String
packageName, String comment,
XWikiContext context) throws XWikiException
{
XWiki xwiki = context.getWiki();
@@ -278,14 +283,15 @@
if (XWikiApplicationClass.getInstance(context).isInstance(doc,
context))
updateprefs |=
- updateApplicationTranslation(translationPrefs,
(XWikiApplication)XWikiApplicationClass.getInstance(context).newSuperDocument(doc,
- context), context);
+ updateApplicationTranslation(translationPrefs,
+ (XWikiApplication)
XWikiApplicationClass.getInstance(context)
+ .newSuperDocument(doc, context), context);
}
if (updateprefs) {
prefsObject.setStringValue("documentBundles",
StringUtils.join(translationPrefs
.toArray(), ","));
- xwiki.saveDocument(prefsDoc, context);
+ xwiki.saveDocument(prefsDoc, comment, context);
}
}
}
Modified:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManagerPluginApi.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManagerPluginApi.java
2007-10-10 09:46:23 UTC (rev 5340)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManagerPluginApi.java
2007-10-10 09:51:53 UTC (rev 5341)
@@ -24,8 +24,11 @@
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
+import java.util.Locale;
+import java.util.ResourceBundle;
import com.xpn.xwiki.plugin.applicationmanager.core.api.XWikiExceptionApi;
+import
com.xpn.xwiki.plugin.applicationmanager.core.plugin.XWikiPluginMessageTool;
import com.xpn.xwiki.plugin.PluginApi;
import com.xpn.xwiki.plugin.applicationmanager.doc.XWikiApplication;
import com.xpn.xwiki.plugin.applicationmanager.doc.XWikiApplicationClass;
@@ -49,12 +52,21 @@
private XWikiExceptionApi defaultException;
+ private XWikiPluginMessageTool messageTool;
+
public ApplicationManagerPluginApi(ApplicationManagerPlugin plugin,
XWikiContext context)
{
super(plugin, context);
+ // Default Exception
defaultException =
new
XWikiExceptionApi(ApplicationManagerException.getDefaultException(), context);
+
+ // Message Tool
+ Locale locale = (Locale) context.get("locale");
+ ResourceBundle bundle =
+ ResourceBundle.getBundle(getPlugin().getName() +
"/ApplicationResources", locale);
+ this.messageTool = new XWikiPluginMessageTool(bundle, context);
}
public XWikiExceptionApi getDefaultException()
@@ -62,6 +74,11 @@
return defaultException;
}
+ public XWikiPluginMessageTool getMessageTool()
+ {
+ return this.messageTool;
+ }
+
//
////////////////////////////////////////////////////////////////////////////
// Applications management
@@ -105,8 +122,11 @@
// TODO : check rights
try {
-
ApplicationManager.getInstance().createApplication(appSuperDocument,
failOnExist,
- context);
+ ApplicationManager.getInstance().createApplication(
+ appSuperDocument,
+ failOnExist,
+
this.messageTool.get("applicationmanager.plugin.createapplication.comment",
+ appSuperDocument.toString()), context);
} catch (ApplicationManagerException e) {
LOG.error("Try to create application \"" + appSuperDocument +
"\"", e);
@@ -293,8 +313,11 @@
int returncode = XWikiExceptionApi.ERROR_NOERROR;
try {
-
ApplicationManager.getInstance().importApplication(context.getDoc(),
packageName,
- context);
+ ApplicationManager.getInstance().importApplication(
+ context.getDoc(),
+ packageName,
+
this.messageTool.get("applicationmanager.plugin.importapplication.comment",
+ packageName), context);
} catch (ApplicationManagerException e) {
LOG.error("Try to get application document", e);
@@ -336,7 +359,10 @@
try {
XWikiApplication app =
ApplicationManager.getInstance().getApplication(appName,
context, true);
- ApplicationManager.getInstance().updateApplicationTranslation(app,
context);
+ ApplicationManager.getInstance().updateApplicationTranslation(
+ app,
+
this.messageTool.get("applicationmanager.plugin.reloadapplication.comment", app
+ .getAppName()), context);
} catch (ApplicationManagerException e) {
LOG.error("Try to get application document", e);
@@ -372,7 +398,10 @@
List applist =
ApplicationManager.getInstance().getApplicationList(context);
for (Iterator it = applist.iterator(); it.hasNext();) {
XWikiApplication app = (XWikiApplication) it.next();
-
ApplicationManager.getInstance().updateApplicationTranslation(app, context);
+ ApplicationManager.getInstance().updateApplicationTranslation(
+ app,
+
this.messageTool.get("applicationmanager.plugin.reloadapplication.comment",
+ app.getAppName()), context);
}
} catch (ApplicationManagerException e) {
LOG.error("Try to get application document", e);
@@ -385,14 +414,6 @@
return returncode;
}
-
- /**
- * @deprecated use [EMAIL PROTECTED] #getRootApplication()}.
- */
- public XWikiApplication getRootApplication(XWikiContext context) throws
XWikiException
- {
- return getRootApplication();
- }
/**
* Get the current wiki root application.
Added:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/resources/applicationmanager/ApplicationResources.properties
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/resources/applicationmanager/ApplicationResources.properties
(rev 0)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/resources/applicationmanager/ApplicationResources.properties
2007-10-10 09:51:53 UTC (rev 5341)
@@ -0,0 +1,3 @@
+applicationmanager.plugin.createapplication.comment=create application \"{0}\"
+applicationmanager.plugin.importapplication.comment=import application \"{0}\"
+applicationmanager.plugin.reloadapplication.comment=reload application \"{0}\"
\ No newline at end of file
_______________________________________________
notifications mailing list
notifications@xwiki.org
http://lists.xwiki.org/mailman/listinfo/notifications
