Author: tmortagne
Date: 2008-01-11 14:31:13 +0100 (Fri, 11 Jan 2008)
New Revision: 6778
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/doc/XWikiDocument.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/packaging/Package.java
Log:
XWIKI-1921: Packager import from directory does not support files with any name
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/doc/XWikiDocument.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/doc/XWikiDocument.java
2008-01-11 13:26:31 UTC (rev 6777)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/doc/XWikiDocument.java
2008-01-11 13:31:13 UTC (rev 6778)
@@ -2439,7 +2439,39 @@
// Note: We don't set the original document as it's already been set
in the constructor
// when this object was instantiated.
}
+
+ /**
+ * Check if provided xml stream contains wiki document.
+ *
+ * @param is the xml stream to read.
+ * @return true if provided stream contains wiki document.
+ */
+ public static boolean isXMLWikiDocument(InputStream is)
+ {
+ boolean validWikiDoc = false;
+ try {
+ SAXReader reader = new SAXReader();
+ Document domdoc = reader.read(is);
+
+ validWikiDoc = isXMLWikiDocument(domdoc);
+ } catch (DocumentException e1) {
+ }
+
+ return validWikiDoc;
+ }
+
+ /**
+ * Check if provided xml document is a wiki document.
+ *
+ * @param is the xml document.
+ * @return true if provided xml document is a wiki document.
+ */
+ public static boolean isXMLWikiDocument(Document domdoc)
+ {
+ return domdoc.getRootElement().getName().equals("xwikidoc");
+ }
+
public void setAttachmentList(List list)
{
attachmentList = list;
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/packaging/Package.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/packaging/Package.java
2008-01-11 13:26:31 UTC (rev 6777)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/packaging/Package.java
2008-01-11 13:31:13 UTC (rev 6778)
@@ -29,7 +29,6 @@
import java.io.OutputStream;
import java.io.StringWriter;
import java.util.ArrayList;
-import java.util.Date;
import java.util.Iterator;
import java.util.List;
import java.util.zip.ZipEntry;
@@ -140,9 +139,9 @@
}
/**
- * If true, the package will preserve the original author
- * during import, rather than updating the author to the current
(importing) user.
- *
+ * If true, the package will preserve the original author during import,
rather than updating
+ * the author to the current (importing) user.
+ *
* @see #isWithVersions()
* @see #isVersionPreserved()
*/
@@ -157,9 +156,9 @@
}
/**
- * If true, the package will preserve the current document version
- * during import, regardless of whether or not the document history is
included.
- *
+ * If true, the package will preserve the current document version during
import, regardless of
+ * whether or not the document history is included.
+ *
* @see #isWithVersions()
* @see #isBackupPack()
*/
@@ -189,15 +188,15 @@
}
/**
- * If set to true, Package will include the change history for the document
- * when exporting the package. This implies that the old version is
preserved.
- *
+ * If set to true, Package will include the change history for the
document when exporting the
+ * package. This implies that the old version is preserved.
+ *
* @see #isVersionPreserved(boolean)
*/
public void setWithVersions(boolean withVersions)
{
this.withVersions = withVersions;
- if ( withVersions ) {
+ if (withVersions) {
this.preserveVersion = true;
}
}
@@ -575,7 +574,7 @@
doc.getDoc().setAuthor(context.getUser());
}
- if ((!preserveVersion)&&(!withVersions)) {
+ if ((!preserveVersion) && (!withVersions)) {
doc.getDoc().setVersion("1.1");
}
@@ -590,12 +589,13 @@
if (withVersions) {
// we need to force the saving the document archive.
- if (doc.getDoc().getDocumentArchive()!=null)
-
context.getWiki().getVersioningStore().saveXWikiDocArchive(doc.getDoc().getDocumentArchive(context),
true, context);
+ if (doc.getDoc().getDocumentArchive() != null)
+
context.getWiki().getVersioningStore().saveXWikiDocArchive(
+ doc.getDoc().getDocumentArchive(context), true,
context);
}
// if there is no archive in xml and content&metaData Dirty is
not set
- // then archive was not saved
- // so we need save it via resetArchive
+ // then archive was not saved
+ // so we need save it via resetArchive
if ((doc.getDoc().getDocumentArchive() == null)
|| (doc.getDoc().getDocumentArchive().getNodes() == null)
|| (!withVersions)) {
doc.getDoc().resetArchive(context);
@@ -690,17 +690,38 @@
return new ByteArrayInputStream(baos.toByteArray());
}
+ /**
+ * Create a [EMAIL PROTECTED] XWikiDocument} from xml stream.
+ *
+ * @param is the xml stream.
+ * @return the [EMAIL PROTECTED] XWikiDocument}.
+ * @throws XWikiException error when creating the [EMAIL PROTECTED]
XWikiDocument}.
+ */
private XWikiDocument readFromXML(InputStream is) throws XWikiException
{
XWikiDocument doc = new com.xpn.xwiki.doc.XWikiDocument();
- if (withVersions)
- doc.fromXML(is, true);
- else {
- doc.fromXML(is);
- }
+
+ doc.fromXML(is, withVersions);
+
return doc;
}
+ /**
+ * Create a [EMAIL PROTECTED] XWikiDocument} from xml [EMAIL PROTECTED]
Document}.
+ *
+ * @param domDoc the xml [EMAIL PROTECTED] Document}.
+ * @return the [EMAIL PROTECTED] XWikiDocument}.
+ * @throws XWikiException error when creating the [EMAIL PROTECTED]
XWikiDocument}.
+ */
+ private XWikiDocument readFromXML(Document domDoc) throws XWikiException
+ {
+ XWikiDocument doc = new com.xpn.xwiki.doc.XWikiDocument();
+
+ doc.fromXML(domDoc, withVersions);
+
+ return doc;
+ }
+
private Document ReadZipInfoFile(ZipInputStream zis) throws IOException,
DocumentException
{
ZipEntry entry;
@@ -851,8 +872,7 @@
if (!context.getWiki().getRightService().hasAdminRights(context)) {
xml =
context.getUtil().substitute(
-
"s/<password>.*?<\\/password>/<password>********<\\/password>/goi",
- xml);
+
"s/<password>.*?<\\/password>/<password>********<\\/password>/goi", xml);
}
FileOutputStream fos = new FileOutputStream(file);
fos.write(xml.getBytes(context.getWiki().getEncoding()));
@@ -946,69 +966,99 @@
}
}
- public String readFromDir(File dir, XWikiContext context) throws
IOException, XWikiException
+ /**
+ * Load document files from provided directory and sub-directories into
packager.
+ *
+ * @param dir the directory from where to load documents.
+ * @param context the XWiki context.
+ * @param description the package descriptor.
+ * @return the number of loaded documents.
+ * @throws IOException error when loading documents.
+ * @throws XWikiException error when loading documents.
+ */
+ public int readFromDir(File dir, XWikiContext context, Document
description)
+ throws IOException, XWikiException
{
- Document description = null;
- setBackupPack(true);
+ File[] files = dir.listFiles();
+
+ SAXReader reader = new SAXReader();
+
int count = 0;
- try {
- File infofile = new File(dir, DefaultPackageFileName);
- description = fromXml(new FileInputStream(infofile));
- if (description == null) {
- throw new
PackageException(PackageException.ERROR_PACKAGE_NODESCRIPTION,
- "Cannot read package description file");
- }
+ for (int i = 0; i < files.length; ++i) {
+ File file = files[i];
- Element docFiles = description.getRootElement();
- Element infosFiles = docFiles.element("files");
+ if (file.isDirectory()) {
+ count += readFromDir(file, context, description);
+ } else {
+ boolean validWikiDoc = false;
+ Document domdoc = null;
- List ListFile = infosFiles.elements("file");
- if (log.isInfoEnabled()) {
- log.info("Package declares " + ListFile.size() + " documents");
- }
- for (int i = 0; i < ListFile.size(); i++) {
- Element el = (Element) ListFile.get(i);
- String defaultAction = el.attributeValue("defaultAction");
- String language = el.attributeValue("language");
- if (language == null) {
- language = "";
+ try {
+ domdoc = reader.read(new FileInputStream(file));
+ validWikiDoc = XWikiDocument.isXMLWikiDocument(domdoc);
+ } catch (DocumentException e1) {
}
- String docName = el.getStringValue();
- XWikiDocument doc = new XWikiDocument();
- doc.setFullName(docName, context);
- doc.setLanguage(language);
- if (log.isDebugEnabled()) {
- log
- .debug("Package adding document " + docName + " with
language "
- + language);
- }
+ if (validWikiDoc) {
+ XWikiDocument doc = readFromXML(domdoc);
- File space = new File(dir, doc.getSpace());
- String filename = doc.getName();
- if ((doc.getLanguage() != null) &&
(!doc.getLanguage().equals(""))) {
- filename += "." + doc.getLanguage();
- }
- File docfile = new File(space, filename);
- doc = readFromXML(new FileInputStream(docfile));
- if (doc == null) {
- if (log.isErrorEnabled()) {
- log.info("Package readFrom XML read null doc for " +
docName
- + " language " + language);
+ try {
+ filter(doc, context);
+
+ if (documentExistInPackageFile(doc.getFullName(),
doc.getLanguage(),
+ description)) {
+ add(doc, context);
+
+ ++count;
+ } else {
+ throw new
PackageException(XWikiException.ERROR_XWIKI_UNKNOWN,
+ "document " + doc.getFullName()
+ + " does not exist in package definition");
+ }
+ } catch (ExcludeDocumentException e) {
+ log.info("Skip the document '" + doc.getFullName() +
"'");
}
+ } else if (!file.getName().equals(DefaultPackageFileName)) {
+ log.info(file.getAbsolutePath() + " is not a valid wiki
document");
}
- DocumentInfo di = new DocumentInfo(doc);
- di.setAction(Integer.parseInt(defaultAction));
- files.add(di);
- count++;
}
+ }
+
+ return count;
+ }
+
+ /**
+ * Load document files from provided directory and sub-directories into
packager.
+ *
+ * @param dir the directory from where to load documents.
+ * @param context the XWiki context.
+ * @return
+ * @throws IOException error when loading documents.
+ * @throws XWikiException error when loading documents.
+ */
+ public String readFromDir(File dir, XWikiContext context) throws
IOException, XWikiException
+ {
+ if (!dir.isDirectory()) {
+ throw new PackageException(PackageException.ERROR_PACKAGE_UNKNOWN,
dir
+ .getAbsolutePath()
+ + " is not a directory");
+ }
+
+ int count = 0;
+ try {
+ File infofile = new File(dir, DefaultPackageFileName);
+ Document description = fromXml(new FileInputStream(infofile));
+
+ count = readFromDir(dir, context, description);
+
+ updateFileInfos(description);
} catch (DocumentException e) {
throw new PackageException(PackageException.ERROR_PACKAGE_UNKNOWN,
"Error when reading the XML");
}
- if (log.isInfoEnabled()) {
- log.info("Package read " + count + " documents");
- }
+
+ log.info("Package read " + count + " documents");
+
return "";
}
}
_______________________________________________
notifications mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/notifications
