December 2009 - xwiki-devs@xwiki.org

Re: [xwiki-devs] [VOTE] Release XE and XEM 2.1.1
by Jean-Vincent Drean 22 Dec '09

22 Dec '09

2.1.1 of course :) JV. On Mon, Dec 21, 2009 at 3:23 PM, Jean-Vincent Drean <jv(a)xwiki.com> wrote: > Hi, > > I'd like to release XE and XEM 2.1.1 tomorrow. 4 important bugs have > been fixed since 2.1: > > - XWIKI-4575 : Horizontal ruler breaks the display of the WYSIWYG > menu bar and toolbox > - XWIKI-4681 : Attachments deletion has no effect before a restart > - XWIKI-4679 : Can't select the macro after inserting it (WYSIWYG) > - XWIKI-4688 : Macro disappears after editing its properties (WYSIWYG) > > Here's my +1. > > Thanks, > JV. >

3 2

[xwiki-devs] [VOTE] Release XE and XEM 2.2.1
by Jean-Vincent Drean 21 Dec '09

21 Dec '09

Hi, I'd like to release XE and XEM 2.1.1 tomorrow. 4 important bugs have been fixed since 2.1: - XWIKI-4575 : Horizontal ruler breaks the display of the WYSIWYG menu bar and toolbox - XWIKI-4681 : Attachments deletion has no effect before a restart - XWIKI-4679 : Can't select the macro after inserting it (WYSIWYG) - XWIKI-4688 : Macro disappears after editing its properties (WYSIWYG) Here's my +1. Thanks, JV.

5 4

[xwiki-devs] [Proposal][Model] ModelContext & getCurrentEntity()
by Vincent Massol 21 Dec '09

21 Dec '09

Hi devs, I'm still working on the Model Reference domain. We've brainstormed with Thomas and we'd like to propose replacing the current ModelContext.getCurrentDocumentName() by ModelContext.getCurrentEntityReference() (which returns an EntityReference). The idea is that a URL could target a document but also a wiki only (e.g the REST API odes that), or a given space only, or even an object or a property. This would mean we would need to have getCurrentDocumentReference() in addition to all the others: getCurrentWikiReference(), getCurrentSpaceReference(). It would also mean a lot of them would be set to null. Last it would mean different ways to access the same information (e.g. getCurrentDocumentReference.getWikiReference() vs getCurrentWikiReference()). We would also add a EntityReference.extractReference(EntityType type) method in order to make it easy to extract information from the a reference path. For example to extract the Wiki from an entity reference: WikiReference wikiRef = context.getCurrentEntityReference(EntityType.WIKI); if (wikiRef != null) .... WDYT? Thanks -Vincent

5 7

[xwiki-devs] [VOTE] Introduce a cache of documents used in the current request
by Sergiu Dumitriu 21 Dec '09

21 Dec '09

Hi devs, Currently the getDocument method always goes to the storage to retrieve the document, even if the same document has just been retrieved. This means that the following code will not work: #set($d = $xwiki.getDocument('X')) $d.setTitle('the title') $xwiki.getDocument('X').getTitle() # will not print 'the title' I'd like to change getDocument so that it first searches in a map of used documents in the current context. This means the following: - getDocument searches in XWikiContext.usedDocuments (or better, in the ExecutionContext) - if found, return the value from there - if not, go to the storage, return it to the caller - when the document is changed for the first time, i.e. when api.Document.getDoc() is called, clone the original document and put it in usedDocuments - as a special case, PreviewAction also puts the updated context document in usedDocuments This means that consecutive calls for retrieving a (changed) document will always return the same object. This prevents possible preview bugs, like http://jira.xwiki.org/jira/browse/XABLOG-14 or http://jira.xwiki.org/jira/browse/XWIKI-4689 Yet this is an important behavior change. Do you think anybody is using this "feature", and actually expects the above code example to work as it does now? Also, we must be careful with the performance, since this new map could get big, holding all the documents in the database. Perhaps a LRU fixed-size map would be better, although this breaks the uniqueness guarantee. So, WDYT? 1. Should we introduce this cache? 2. Should it be limited in size? -- Sergiu Dumitriu http://purl.org/net/sergiu/

4 3

[xwiki-devs] I'm updating from 2.1M1 to 2.1 Final release, and encountered an error.
by Zhaolin Feng 21 Dec '09

21 Dec '09

Hi: I'm updating from 2.1M1 to 2.1 Final release, and encountered an error. Please someone help me out. Many thanks. I did the following things. 1. Export everything from 2.1M1 to backup.xar 2. Import backup.xar to 2.1Final 3. Import official XE XAR, effectively overwrite the things in backup.xar, with the exception of XWiki.XWikiPreference and ***.WebPreference. 4. So far so fine. But after restarting the server, I encounter the following error: HTTP ERROR 500 Problem accessing /xwiki/bin/view/Main/. Reason: Error number 3 in 0: Could not initialize main XWiki context Wrapped Exception: Error number 3001 in 3: Cannot load class com.xpn.xwiki.store.migration.hibernate.XWikiHibernateMigrationManager from param xwiki.store.migration.manager.class Wrapped Exception: Error number 0 in 3: Exception while hibernate execute Wrapped Exception: Could not create a DBCP pool. There is an error in the hibernate configuration file, please review it. -- -- Zhaolin Feng -- www.mapbar.com -- Currahee! We stand alone together!

2 4

Re: [xwiki-devs] [xwiki-users] XWiki + Glassfish 2.1.1 + cglib
by Sergiu Dumitriu 21 Dec '09

21 Dec '09

On 12/18/2009 01:36 PM, Reto Hotz wrote: > Hi, > > FYI: We have experienced problems running XWiki 2.1 on Glassfish 2.1.1 > (see stacktrace at the end). > Our final solution was to replace the bundled cglib-2.1_3.jar with the > newest cglib-2.2.jar So the solution is to also update it in the default distribution, right? -- Sergiu Dumitriu http://purl.org/net/sergiu/

2 2

Re: [xwiki-devs] [xwiki-notifications] r25854 - in platform/core/trunk/xwiki-officeimporter/src/main/java/org/xwiki/officeimporter: . internal
by Thomas Mortagne 20 Dec '09

20 Dec '09

On Sun, Dec 20, 2009 at 16:44, asiri <platform-notifications(a)xwiki.org> wrote: > Author: asiri > Date: 2009-12-20 16:44:32 +0100 (Sun, 20 Dec 2009) > New Revision: 25854 > > Added: > platform/core/trunk/xwiki-officeimporter/src/main/java/org/xwiki/officeimporter/OfficeImporterVelocityBridge.java > Removed: > platform/core/trunk/xwiki-officeimporter/src/main/java/org/xwiki/officeimporter/internal/OfficeImporterVelocityBridge.java > Modified: > platform/core/trunk/xwiki-officeimporter/src/main/java/org/xwiki/officeimporter/internal/OfficeImporterVelocityContextInitializer.java > Log: > [misc] improving officeimporter code - step 1 > > * Moved OfficeImporterVelocityBridge class out from org.xwiki.officeimporter.internal package into org.xwiki.officeimporter package since a velocity bridge represents a public API. > > Added: platform/core/trunk/xwiki-officeimporter/src/main/java/org/xwiki/officeimporter/OfficeImporterVelocityBridge.java > =================================================================== > --- platform/core/trunk/xwiki-officeimporter/src/main/java/org/xwiki/officeimporter/OfficeImporterVelocityBridge.java (rev 0) > +++ platform/core/trunk/xwiki-officeimporter/src/main/java/org/xwiki/officeimporter/OfficeImporterVelocityBridge.java 2009-12-20 15:44:32 UTC (rev 25854) > @@ -0,0 +1,172 @@ > +/* > + * See the NOTICE file distributed with this work for additional > + * information regarding copyright ownership. > + * > + * This is free software; you can redistribute it and/or modify it > + * under the terms of the GNU Lesser General Public License as > + * published by the Free Software Foundation; either version 2.1 of > + * the License, or (at your option) any later version. > + * > + * This software is distributed in the hope that it will be useful, > + * but WITHOUT ANY WARRANTY; without even the implied warranty of > + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU > + * Lesser General Public License for more details. > + * > + * You should have received a copy of the GNU Lesser General Public > + * License along with this software; if not, write to the Free > + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA > + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. > + */ > +package org.xwiki.officeimporter; > + > +import java.io.ByteArrayInputStream; > +import java.util.Map; > + > +import org.xwiki.bridge.DocumentAccessBridge; > +import org.xwiki.component.logging.Logger; > +import org.xwiki.component.manager.ComponentManager; > +import org.xwiki.context.Execution; > +import org.xwiki.model.DocumentNameFactory; > + > +/** > + * A bridge between velocity and office importer. > + * > + * @version $Id: OfficeImporterVelocityBridge.java 24508 2009-10-15 10:05:22Z asiri $ > + * @since 1.8M1 > + */ > +public class OfficeImporterVelocityBridge > +{ > + /** > + * The key used to place any error messages while importing office documents. > + */ > + public static final String OFFICE_IMPORTER_ERROR = "OFFICE_IMPORTER_ERROR"; > + > + /** > + * The {@link Execution} component. > + */ > + private Execution execution; > + > + /** > + * Internal {@link OfficeImporter} component. > + */ > + private OfficeImporter importer; > + > + /** > + * The {@link DocumentAccessBridge} component. > + */ > + private DocumentAccessBridge docBridge; > + > + /** > + * Used for converting string document names to {@link DocumentName} instances. > + */ > + private DocumentNameFactory nameFactory; > + > + /** > + * The {@link Logger} instance. > + */ > + private Logger logger; > + > + /** > + * Default constructor. > + * > + * @param componentManager used to lookup for other necessary components. > + * @param logger logger. > + */ > + public OfficeImporterVelocityBridge(ComponentManager componentManager, Logger logger) > + { > + this.logger = logger; > + try { > + this.execution = componentManager.lookup(Execution.class); > + this.importer = componentManager.lookup(OfficeImporter.class); > + this.docBridge = componentManager.lookup(DocumentAccessBridge.class); > + this.nameFactory = componentManager.lookup(DocumentNameFactory.class); > + } catch (Exception ex) { > + logger.error("Error while initializing office importer velocity bridge.", ex); Shouldn't it be an exception instead of a log ? Since this class depends on this component you should not be able to created it if one of these is missing like when you create a component. > + } > + } > + > + /** > + * Imports the passed Office document into the target wiki page. > + * > + * @param fileContent the binary content of the input document. > + * @param fileName the name of the source document (should have a valid extension since the extension is used to > + * find out the office document's format). > + * @param targetDocument the name of the resulting wiki page. > + * @param options the optional parameters for the conversion. > + * @return true if the operation was a success. > + */ > + public boolean importDocument(byte[] fileContent, String fileName, String targetDocument, > + Map<String, String> options) > + { > + boolean success = false; > + try { > + validateRequest(targetDocument, options); > + importer.importStream(new ByteArrayInputStream(fileContent), fileName, targetDocument, options); > + success = true; > + } catch (OfficeImporterException ex) { > + logger.error(ex.getMessage(), ex); > + execution.getContext().setProperty(OFFICE_IMPORTER_ERROR, ex.getMessage()); > + } catch (Exception ex) { > + logger.error(ex.getMessage(), ex); > + setErrorMessage("Internal error while finalizing the target document."); > + } > + return success; > + } > + > + /** > + * @return an error message set inside current execution (during import process) or null. > + */ > + public String getErrorMessage() > + { > + return (String) execution.getContext().getProperty(OFFICE_IMPORTER_ERROR); > + } > + > + /** > + * Utility method for setting an error message inside current execution. > + * > + * @param message error message. > + */ > + private void setErrorMessage(String message) > + { > + execution.getContext().setProperty(OFFICE_IMPORTER_ERROR, message); > + } > + > + /** > + * @return any error messages thrown while importing. > + * @deprecated use {@link #getErrorMessage()} instead since 2.2M1. > + */ > + @Deprecated > + public String getLastErrorMessage() > + { > + return getErrorMessage(); > + } > + > + /** > + * Checks if this request is valid. For a request to be valid, the target document should be editable by the current > + * user. And if this is not an append request, the target document should not exist. > + * > + * @param targetDocument the target document. > + * @param options additional parameters passed in for the import operation. > + * @throws OfficeImporterException if the request is invalid. > + */ > + private void validateRequest(String targetDocument, Map<String, String> options) throws OfficeImporterException > + { > + if (!docBridge.isDocumentEditable(nameFactory.createDocumentName(targetDocument))) { > + throw new OfficeImporterException("Inadequate privileges."); > + } else if (docBridge.exists(targetDocument) && !isAppendRequest(options)) { > + throw new OfficeImporterException("The target document " + targetDocument + " already exists."); > + } > + } > + > + /** > + * Utility method for checking if a request is made to append the importer result to an existing page. > + * > + * @param options additional parameters passed in for the import operation. > + * @return true if the params indicate that this is an append request. > + */ > + private boolean isAppendRequest(Map<String, String> options) > + { > + String appendParam = options.get("appendContent"); > + return (appendParam != null) ? appendParam.equals("true") : false; > + } > +} > > Deleted: platform/core/trunk/xwiki-officeimporter/src/main/java/org/xwiki/officeimporter/internal/OfficeImporterVelocityBridge.java > =================================================================== > --- platform/core/trunk/xwiki-officeimporter/src/main/java/org/xwiki/officeimporter/internal/OfficeImporterVelocityBridge.java 2009-12-20 02:37:05 UTC (rev 25853) > +++ platform/core/trunk/xwiki-officeimporter/src/main/java/org/xwiki/officeimporter/internal/OfficeImporterVelocityBridge.java 2009-12-20 15:44:32 UTC (rev 25854) > @@ -1,147 +0,0 @@ > -/* > - * See the NOTICE file distributed with this work for additional > - * information regarding copyright ownership. > - * > - * This is free software; you can redistribute it and/or modify it > - * under the terms of the GNU Lesser General Public License as > - * published by the Free Software Foundation; either version 2.1 of > - * the License, or (at your option) any later version. > - * > - * This software is distributed in the hope that it will be useful, > - * but WITHOUT ANY WARRANTY; without even the implied warranty of > - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU > - * Lesser General Public License for more details. > - * > - * You should have received a copy of the GNU Lesser General Public > - * License along with this software; if not, write to the Free > - * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA > - * 02110-1301 USA, or see the FSF site: http://www.fsf.org. > - */ > -package org.xwiki.officeimporter.internal; > - > -import java.io.ByteArrayInputStream; > -import java.util.Map; > - > -import org.xwiki.bridge.DocumentAccessBridge; > -import org.xwiki.component.logging.Logger; > -import org.xwiki.context.Execution; > -import org.xwiki.officeimporter.OfficeImporter; > -import org.xwiki.officeimporter.OfficeImporterException; > - > -/** > - * A bridge between velocity and office importer. > - * > - * @version $Id$ > - * @since 1.8M1 > - */ > -public class OfficeImporterVelocityBridge > -{ > - /** > - * The key used to place any error messages while importing office documents. > - */ > - public static final String OFFICE_IMPORTER_ERROR = "OFFICE_IMPORTER_ERROR"; > - > - /** > - * The {@link Execution} component. > - */ > - private Execution execution; > - > - /** > - * Internal {@link OfficeImporter} component. > - */ > - private OfficeImporter importer; > - > - /** > - * The {@link DocumentAccessBridge} component. > - */ > - private DocumentAccessBridge docBridge; > - > - /** > - * The {@link Logger} instance. > - */ > - private Logger logger; > - > - /** > - * Default constructor. > - * > - * @param execution current execution. > - * @param importer internal office importer component. > - * @param docBridge document access bridge. > - * @param logger logger. > - */ > - public OfficeImporterVelocityBridge(Execution execution, OfficeImporter importer, DocumentAccessBridge docBridge, > - Logger logger) > - { > - this.execution = execution; > - this.importer = importer; > - this.docBridge = docBridge; > - this.logger = logger; > - } > - > - /** > - * Imports the passed Office document into the target wiki page. > - * > - * @param fileContent the binary content of the input document. > - * @param fileName the name of the source document (should have a valid extension since the extension is used to > - * find out the office document's format). > - * @param targetDocument the name of the resulting wiki page. > - * @param options the optional parameters for the conversion. > - * @return true if the operation was a success. > - */ > - public boolean importDocument(byte[] fileContent, String fileName, String targetDocument, > - Map<String, String> options) > - { > - boolean success = false; > - try { > - validateRequest(targetDocument, options); > - importer.importStream(new ByteArrayInputStream(fileContent), fileName, targetDocument, options); > - success = true; > - } catch (OfficeImporterException ex) { > - logger.error(ex.getMessage(), ex); > - execution.getContext().setProperty(OFFICE_IMPORTER_ERROR, ex.getMessage()); > - } catch (Exception ex) { > - logger.error(ex.getMessage(), ex); > - execution.getContext().setProperty(OFFICE_IMPORTER_ERROR, > - "Internal error while finalizing the target document."); > - } > - return success; > - } > - > - /** > - * Checks if this request is valid. For a request to be valid, the target document should be editable by the current > - * user. And if this is not an append request, the target document should not exist. > - * > - * @param targetDocument the target document. > - * @param options additional parameters passed in for the import operation. > - * @throws OfficeImporterException if the request is invalid. > - */ > - private void validateRequest(String targetDocument, Map<String, String> options) throws OfficeImporterException > - { > - if (!docBridge.isDocumentEditable(targetDocument)) { > - throw new OfficeImporterException("Inadequate privileges."); > - } else if (docBridge.exists(targetDocument) && !isAppendRequest(options)) { > - throw new OfficeImporterException("The target document " + targetDocument + " already exists."); > - } > - } > - > - /** > - * Utility method for checking if a request is made to append the importer result to an existing page. > - * > - * @param options additional parameters passed in for the import operation. > - * @return true if the params indicate that this is an append request. > - */ > - private boolean isAppendRequest(Map<String, String> options) > - { > - String appendParam = options.get("appendContent"); > - return (appendParam != null) ? appendParam.equals("true") : false; > - } > - > - /** > - * @return any error messages thrown while importing. > - */ > - public String getLastErrorMessage() > - { > - Object error = execution.getContext().getProperty(OFFICE_IMPORTER_ERROR); > - return (error != null) ? (String) error : null; > - } > -} > > Modified: platform/core/trunk/xwiki-officeimporter/src/main/java/org/xwiki/officeimporter/internal/OfficeImporterVelocityContextInitializer.java > =================================================================== > --- platform/core/trunk/xwiki-officeimporter/src/main/java/org/xwiki/officeimporter/internal/OfficeImporterVelocityContextInitializer.java 2009-12-20 02:37:05 UTC (rev 25853) > +++ platform/core/trunk/xwiki-officeimporter/src/main/java/org/xwiki/officeimporter/internal/OfficeImporterVelocityContextInitializer.java 2009-12-20 15:44:32 UTC (rev 25854) > @@ -20,12 +20,11 @@ > package org.xwiki.officeimporter.internal; > > import org.apache.velocity.VelocityContext; > -import org.xwiki.bridge.DocumentAccessBridge; > import org.xwiki.component.annotation.Component; > import org.xwiki.component.annotation.Requirement; > import org.xwiki.component.logging.AbstractLogEnabled; > -import org.xwiki.context.Execution; > -import org.xwiki.officeimporter.OfficeImporter; > +import org.xwiki.component.manager.ComponentManager; > +import org.xwiki.officeimporter.OfficeImporterVelocityBridge; > import org.xwiki.velocity.VelocityContextInitializer; > > /** > @@ -43,29 +42,16 @@ > public static final String VELOCITY_CONTEXT_KEY = "officeimporter"; > > /** > - * The {@link Execution} component. > + * Used to lookup other components. > */ > @Requirement > - private Execution execution; > + private ComponentManager componentManager; > > /** > - * The {@link OfficeImporter} component. > - */ > - @Requirement > - private OfficeImporter officeImporter; > - > - /** > - * The {@link DocumentAccessBridge}. > - */ > - @Requirement > - private DocumentAccessBridge docBridge; > - > - /** > * {@inheritDoc} > */ > public void initialize(VelocityContext context) > { > - context.put(VELOCITY_CONTEXT_KEY, new OfficeImporterVelocityBridge(execution, officeImporter, docBridge, > - getLogger())); > + context.put(VELOCITY_CONTEXT_KEY, new OfficeImporterVelocityBridge(componentManager, getLogger())); > } > } > > _______________________________________________ > notifications mailing list > notifications(a)xwiki.org > http://lists.xwiki.org/mailman/listinfo/notifications > -- Thomas Mortagne

2 1

[xwiki-devs] [Discussion] extract out an xwiki-openoffice module from xwiki-officeimporter module ?
by Asiri Rathnayake 20 Dec '09

20 Dec '09

Hello Devs, Currently xwiki-officeimporter contains logic for mainly two different tasks: 1. Manage the back-end openoffice process (and provide document conversion facilities). 2. Perform the actual transformation from office documents to wiki pages. (depends on point 1) xwiki-officeimporter module's code might appear a bit complex because of this mix up. Also I believe openoffice related code might have to be reused once we introduce an office-exporter module. I was wondering if it would be beneficial (in the long run) to extract out openoffice related code into a separate module (xwiki-openoffice). The main concern I have is that currently openoffice related code is inside org.xwiki.officeimporter.openoffice package which have to be changed to org.xwiki.openoffice if we are to extract out a xwiki-openoffice module, this could break a few things in public API. Even if we decide to do so, I don't think any of us (devs) would be able to do this within 2.2M1 time period. But I thought it's better to discuss about it a little now. Let me know what you think. Thanks. - Asiri

4 5

[xwiki-devs] mimic relational database one to many relations
by Helenc 19 Dec '09

19 Dec '09

Hi All, I would really like to be able to mimic one to many relations through classes somehow? I noticed there have been a few posts about how one might go about such a thing using dblists, it's not clear yet to me how I could implement such a thing? I'm wondering if any demo application exist that might give me more of a clue? Let's say I want to set up a simple one to many relationship between information about a company and then individuals who worked for that company. How would I go about such a thing? Do I setup a companyclass and a personsclass and then link them somehow with the dblist? What's the best user interface setup for this too so it's easy for users to enter company and people data? Are there any examples of HQL queries about how one would then search to display individuals details along with elements of their companies details? Referencing the relationship? Or is there another way to do this? Any pointers would be very much appreciated? Thanks Helen -- View this message in context: http://n2.nabble.com/mimic-relational-database-one-to-many-relations-tp4185… Sent from the XWiki- Dev mailing list archive at Nabble.com.

3 4

[xwiki-devs] Are velocity bridges part of public API?
by Asiri Rathnayake 19 Dec '09

19 Dec '09

Hi Devs, I just realized that I've been having a velocity bridge class inside an *.internal package for sometime. I think this is wrong because velocity bridges are part of our public API (?). Moving this bridge to a non-internal package would not harm because it would not break any existing velocity scripts. WDYT? - Asiri

1 0