- xwiki-devs@xwiki.org - lists.xwiki.org

Re: [xwiki-devs] [xwiki-notifications] r28878 - in contrib/sandbox: . xwiki-wiki-components xwiki-wiki-components/src xwiki-wiki-components/src/main xwiki-wiki-components/src/main/java xwiki-wiki-components/src/main/java/com xwiki-wiki-components/src/main/java/co
by Thomas Mortagne 16 May '10

16 May '10

On Sat, May 15, 2010 at 17:08, jvelociter <contrib-notifications(a)xwiki.org> wrote: > > Author: jvelociter > Date: 2010-05-15 17:08:25 +0200 (Sat, 15 May 2010) > New Revision: 28878 > > Added: > contrib/sandbox/xwiki-wiki-components/ > contrib/sandbox/xwiki-wiki-components/pom.xml > contrib/sandbox/xwiki-wiki-components/src/ > contrib/sandbox/xwiki-wiki-components/src/main/ > contrib/sandbox/xwiki-wiki-components/src/main/java/ > contrib/sandbox/xwiki-wiki-components/src/main/java/com/ > contrib/sandbox/xwiki-wiki-components/src/main/java/com/xpn/ > contrib/sandbox/xwiki-wiki-components/src/main/java/com/xpn/xwiki/ > contrib/sandbox/xwiki-wiki-components/src/main/java/com/xpn/xwiki/internal/ > contrib/sandbox/xwiki-wiki-components/src/main/java/com/xpn/xwiki/internal/DefaultWikiComponentBuilder.java > contrib/sandbox/xwiki-wiki-components/src/main/java/com/xpn/xwiki/internal/WikiComponentInitializer.java > contrib/sandbox/xwiki-wiki-components/src/main/java/org/ > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/ > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/ > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/ > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/InvalidComponentDefinitionException.java > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/MethodOutputHandler.java > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponent.java > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentBuilder.java > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentException.java > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentInvocationHandler.java > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentManager.java > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/internal/ > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/internal/DefaultMethodOutputHandler.java > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/internal/DefaultWikiComponent.java > contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/internal/DefaultWikiComponentManager.java > contrib/sandbox/xwiki-wiki-components/src/main/resources/ > contrib/sandbox/xwiki-wiki-components/src/main/resources/META-INF/ > contrib/sandbox/xwiki-wiki-components/src/main/resources/META-INF/components.txt > contrib/sandbox/xwiki-wiki-components/src/test/ > contrib/sandbox/xwiki-wiki-components/src/test/java/ > contrib/sandbox/xwiki-wiki-components/src/test/java/org/ > contrib/sandbox/xwiki-wiki-components/src/test/java/org/xwiki/ > contrib/sandbox/xwiki-wiki-components/src/test/java/org/xwiki/component/ > contrib/sandbox/xwiki-wiki-components/src/test/java/org/xwiki/component/wiki/ > contrib/sandbox/xwiki-wiki-components/src/test/java/org/xwiki/component/wiki/WikiComponentManagerTest.java > Log: > XWIKI-5195 Make possible to implement any component from the wiki, using objects > > Proposal implementation, for review. Right now supports definition of component implementation as wiki objects, with support for multiple interfaces implementations and methods return value via explicit call or plain block rendering if no explicit call and return type is String. > > Missing : > - More tests > - Support for requirements bindings > - Support for inputs handling (method arguments bindings) > > Open questions I can think of : > - Should we refuse to register a component if it does not declare implementation of all its role methods ? (to avoid potential NPEs, for example) Why NPE ? The proxy is supposed to generate a proper exception when something is calling unimplemented method. > - Better name for XWiki.ComponentInterfaceClass ? (It's the class representing an extra interface the component implementation implements)= > > Note: module right now relies on XWIKI-5194 (bridge event for XWiki initialized) being applied to xwiki-core/xwiki-bridge > > [...] > > Added: contrib/sandbox/xwiki-wiki-components/src/main/java/com/xpn/xwiki/internal/DefaultWikiComponentBuilder.java > =================================================================== > --- contrib/sandbox/xwiki-wiki-components/src/main/java/com/xpn/xwiki/internal/DefaultWikiComponentBuilder.java (rev 0) > +++ contrib/sandbox/xwiki-wiki-components/src/main/java/com/xpn/xwiki/internal/DefaultWikiComponentBuilder.java 2010-05-15 15:08:25 UTC (rev 28878) > @@ -0,0 +1,167 @@ [...] > +/** > + * Default implementation of a wiki component builder, that is using the legacy XWiki core module. > + * > + * @since 2.4-M2 > + * @version $Id$ > + */ > +@Component > +public class DefaultWikiComponentBuilder implements WikiComponentBuilder > +{ > + > + /** > + * The name of the document that holds the XClass definition of an implementation of an interface by a component. > + */ > + private static final String XWIKI_COMPONENT_INTERFACE_CLASS = "XWiki.ComponentInterfaceClass"; > + > + /** > + * The name of the document that holds the XClass definition of a method of a component. > + */ > + private static final String XWIKI_COMPONENT_METHOD_CLASS = "XWiki.ComponentMethodClass"; > + > + /** > + * The property name of the name of a component method. > + */ > + private static final String COMPONENT_METHOD_NAME_FIELD = "name"; > + > + /** > + * The property name of the name of an implemented interface. (Checkstyle fix). > + */ > + private static final String COMPONENT_INTERFACE_NAME_FIELD = COMPONENT_METHOD_NAME_FIELD; > + > + /** > + * Execution, needed to access the XWiki context map. > + */ > + @Requirement > + private Execution execution; > + > + /** > + * {@inheritDoc} > + */ > + public WikiComponent build(DocumentReference reference) throws InvalidComponentDefinitionException, > + WikiComponentException > + { > + try { > + XWikiDocument componentDocument = getXWikiContext().getWiki().getDocument(reference, getXWikiContext()); > + BaseObject componentObject = componentDocument.getObject("XWiki.ComponentClass"); > + > + if (componentObject == null) { > + throw new InvalidComponentDefinitionException("No component object could be found"); > + } > + > + String role = componentObject.getStringValue("role"); > + > + if (StringUtils.isBlank(role)) { > + throw new InvalidComponentDefinitionException("No role were precised in the component"); > + } > + > + Class< ? > roleAsClass; > + try { > + roleAsClass = Class.forName(role); > + } catch (ClassNotFoundException e) { > + throw new InvalidComponentDefinitionException("The role class could not be found", e); > + } > + > + String roleHint = StringUtils.defaultIfEmpty(componentObject.getStringValue("roleHint"), "default"); > + > + DefaultWikiComponent component = new DefaultWikiComponent(reference, roleAsClass, roleHint); > + component.setHandledMethods(this.getHandledMethods(componentDocument)); > + component.setImplementedInterfaces(this.getDeclaredInterfaces(componentDocument)); > + > + return component; > + > + } catch (XWikiException e) { > + throw new WikiComponentException("Failed to build wiki component for document " + reference.toString()); > + } > + } > + > + /** > + * @param componentDocument the document holding the component description > + * @return the map of component handled methods/method body > + */ > + private Map<String, String> getHandledMethods(XWikiDocument componentDocument) > + { > + Map<String, String> handledMethods = new HashMap<String, String>(); > + if (componentDocument.getObjectNumbers(XWIKI_COMPONENT_METHOD_CLASS) > 0) { > + for (BaseObject iface : componentDocument.getObjects(XWIKI_COMPONENT_METHOD_CLASS)) { > + if (!StringUtils.isBlank(iface.getStringValue(COMPONENT_METHOD_NAME_FIELD))) { > + handledMethods.put(iface.getStringValue(COMPONENT_METHOD_NAME_FIELD), iface.getStringValue("code")); > + } > + } > + } > + return handledMethods; > + > + } > + > + /** > + * @param componentDocument the document holding the component description > + * @return the array of interfaces declared (and actually existing) by the document > + */ > + private Class< ? >[] getDeclaredInterfaces(XWikiDocument componentDocument) > + { > + List<Class< ? >> interfaces = new ArrayList<Class< ? >>(); > + if (componentDocument.getObjectNumbers(XWIKI_COMPONENT_INTERFACE_CLASS) > 0) { > + for (BaseObject iface : componentDocument.getObjects(XWIKI_COMPONENT_INTERFACE_CLASS)) { > + if (!StringUtils.isBlank(iface.getStringValue(COMPONENT_INTERFACE_NAME_FIELD))) { > + try { > + Class< ? > implemented = Class.forName(iface.getStringValue(COMPONENT_INTERFACE_NAME_FIELD)); > + interfaces.add(implemented); > + } catch (ClassNotFoundException e) { > + // Silent > + } > + } > + } > + } > + return interfaces.toArray(new Class< ? >[] {}); > + } > + > + /** > + * @return a XWikiContext, retrieved from our execution > + */ > + private XWikiContext getXWikiContext() > + { > + return (XWikiContext) execution.getContext().getProperty("xwikicontext"); > + } > + > +} > > Added: contrib/sandbox/xwiki-wiki-components/src/main/java/com/xpn/xwiki/internal/WikiComponentInitializer.java > =================================================================== > --- contrib/sandbox/xwiki-wiki-components/src/main/java/com/xpn/xwiki/internal/WikiComponentInitializer.java (rev 0) > +++ contrib/sandbox/xwiki-wiki-components/src/main/java/com/xpn/xwiki/internal/WikiComponentInitializer.java 2010-05-15 15:08:25 UTC (rev 28878) > @@ -0,0 +1,339 @@ [...] > +/** > + * Initializes the Wiki Component feature. First ensure all needed XClasses are up-to-date, then registers existing > + * components. > + * > + * @since 2.4-M2 > + * @version $Id$ > + */ > +@Component("wikiComponentInitializer") > +public class WikiComponentInitializer extends AbstractLogEnabled implements EventListener > +{ > + /** > + * The XClass defining a component implementation. > + */ > + private static final String WIKI_COMPONENT_CLASS = "XWiki.ComponentClass"; > + > + /** > + * The XClass defining a component requirement. > + */ > + private static final String WIKI_COMPONENT_REQUIREMENT_CLASS = "XWiki.ComponentRequirementClass"; > + > + /** > + * The XClass defining a component method. > + */ > + private static final String WIKI_COMPONENT_METHOD_CLASS = "XWiki.ComponentMethodClass"; > + > + /** > + * The XClass defining a component interface implementation. > + */ > + private static final String WIKI_COMPONENT_INTERFACE_CLASS = "XWiki.ComponentInterfaceClass"; > + > + /** > + * The name property of the {@link WIKI_COMPONENT_INTERFACE_CLASS} XClass. > + */ > + private static final String INTERFACE_NAME_FIELD = "name"; > + > + /** > + * The name property of the {@link WIKI_COMPONENT_METHOD_CLASS} XClass. (Fix checkstyle). > + */ > + private static final String METHOD_NAME_FIELD = INTERFACE_NAME_FIELD; > + > + /** > + * The role property of both {@link WIKI_COMPONENT_CLASS} and {@link WIKI_COMPONENT_REQUIREMENT_CLASS}. > + */ > + private static final String COMPONENT_ROLE_HINT_FIELD = "roleHint"; > + > + /** > + * The role hint property of both {@link WIKI_COMPONENT_CLASS} and {@link WIKI_COMPONENT_REQUIREMENT_CLASS}. > + */ > + private static final String COMPONENT_ROLE_FIELD = "role"; > + > + /** > + * Our execution. Needed to access the XWiki context. > + */ > + @Requirement > + private Execution execution; > + > + /** > + * The wiki component manager that knows how to register component definition against the underlying CM. > + */ > + @Requirement > + private WikiComponentManager wikiComponentManager; > + > + /** > + * Builder that creates component description from document references. > + */ > + @Requirement > + private WikiComponentBuilder wikiComponentBuilder; > + > + /** > + * {@inheritDoc} > + */ > + public List<Event> getEvents() > + { > + return Arrays.<Event> asList(new XWikiInitializedBridgeEvent()); > + } > + > + /** > + * {@inheritDoc} > + */ > + public String getName() > + { > + return "wikiComponentInitializer"; > + } > + > + /** > + * {@inheritDoc} > + */ > + public void onEvent(Event arg0, Object arg1, Object arg2) > + { > + // First step, verify that all XClasses exists and are up-to-date (act if not). > + this.installOrUpdateComponentXClasses(); > + // Second step, lookup and register existing components. > + this.registerExistingWikiComponents(); > + } > + > + /** > + * Registers existing components. Query them against the store, and if they are built properly (valid definition) > + * register them against the CM. > + */ > + private void registerExistingWikiComponents() > + { > + String query = > + ", BaseObject as obj, StringProperty as role where obj.className='XWiki.ComponentClass'" > + + " and obj.name=doc.fullName and role.id.id=obj.id and role.id.name='role' and role.value <>''"; > + try { > + for (DocumentReference ref : getXWikiContext().getWiki().getStore().searchDocumentReferences(query, > + getXWikiContext())) { > + try { > + WikiComponent component = this.wikiComponentBuilder.build(ref); > + > + this.wikiComponentManager.registerWikiComponent(component); > + } catch (InvalidComponentDefinitionException e) { > + // Fail quietly and only log at the debug level. > + getLogger().debug("Invalid wiki component definition for reference " + ref.toString(), e); > + } catch (WikiComponentException e) { > + // Fail quietly and only log at the debug level. > + getLogger().debug("Failed to register wiki component for reference " + ref.toString(), e); > + } > + } > + } catch (XWikiException e) { > + getLogger().error("Failed to register existing wiki components", e); > + } > + > + } > + > + /** > + * Verify that all XClasses exists and are up-to-date (act if not). > + */ > + private void installOrUpdateComponentXClasses() > + { > + try { > + this.installOrUpdateComponentXClass(); > + this.installOrUpdateComponentRequirementXClass(); > + this.installOrUpdateComponentMethodXClass(); > + this.installOrUpdateComponentInterfaceXClass(); > + } catch (XWikiException e) { > + getLogger().error("Failed to install or update wiki component XClasses", e); > + } > + } > + > + /** > + * Verify that the {@link #WIKI_COMPONENT_INTERFACE_CLASS} exists and is up-to-date (act if not). > + * > + * @throws XWikiException on failure > + */ > + private void installOrUpdateComponentInterfaceXClass() throws XWikiException > + { > + XWikiContext xcontext = getXWikiContext(); > + XWikiDocument doc = xcontext.getWiki().getDocument(WIKI_COMPONENT_INTERFACE_CLASS, xcontext); > + > + BaseClass bclass = doc.getXClass(); > + bclass.setName(WIKI_COMPONENT_INTERFACE_CLASS); > + > + boolean needsUpdate = false; > + > + needsUpdate |= this.initializeXClassDocumentMetadata(doc, "Wiki Component Implements Interface XWiki Class"); > + needsUpdate |= bclass.addTextField(INTERFACE_NAME_FIELD, "Interface Qualified Name", 30); > + > + if (needsUpdate) { > + this.update(doc); > + } > + } > + > + /** > + * Verify that the {@link #WIKI_COMPONENT_CLASS} exists and is up-to-date (act if not). > + * > + * @throws XWikiException on failure > + */ > + private void installOrUpdateComponentXClass() throws XWikiException > + { > + XWikiContext xcontext = getXWikiContext(); > + XWikiDocument doc = xcontext.getWiki().getDocument(WIKI_COMPONENT_CLASS, xcontext); > + > + BaseClass bclass = doc.getXClass(); > + bclass.setName(WIKI_COMPONENT_CLASS); > + > + boolean needsUpdate = false; > + > + needsUpdate |= this.initializeXClassDocumentMetadata(doc, "Wiki Component XWiki Class"); > + needsUpdate |= bclass.addTextField(COMPONENT_ROLE_FIELD, "Component role", 30); > + needsUpdate |= bclass.addTextField(COMPONENT_ROLE_HINT_FIELD, "Component role hint", 30); > + > + if (needsUpdate) { > + this.update(doc); > + } > + } > + > + /** > + * Verify that the {@link #WIKI_COMPONENT_REQUIREMENT_CLASS} exists and is up-to-date (act if not). > + * > + * @throws XWikiException on failure > + */ > + private void installOrUpdateComponentRequirementXClass() throws XWikiException > + { > + XWikiContext xcontext = getXWikiContext(); > + XWikiDocument doc = xcontext.getWiki().getDocument(WIKI_COMPONENT_REQUIREMENT_CLASS, xcontext); > + > + BaseClass bclass = doc.getXClass(); > + bclass.setName(WIKI_COMPONENT_REQUIREMENT_CLASS); > + > + boolean needsUpdate = false; > + > + needsUpdate |= this.initializeXClassDocumentMetadata(doc, "Wiki Component Requirement XWiki Class"); > + needsUpdate |= bclass.addTextField(COMPONENT_ROLE_FIELD, "Requirement role", 30); > + needsUpdate |= bclass.addTextField(COMPONENT_ROLE_HINT_FIELD, "Requirement role hint", 30); > + needsUpdate |= bclass.addTextField("bindingName", "Binding name", 30); > + needsUpdate |= bclass.addStaticListField("type", "Requirement type", "single=Single|list=List|map=Map"); > + > + if (needsUpdate) { > + this.update(doc); > + } > + } > + > + /** > + * Verify that the {@link #WIKI_COMPONENT_METHOD_CLASS} exists and is up-to-date (act if not). > + * > + * @throws XWikiException on failure > + */ > + private void installOrUpdateComponentMethodXClass() throws XWikiException > + { > + XWikiContext xcontext = getXWikiContext(); > + XWikiDocument doc = xcontext.getWiki().getDocument(WIKI_COMPONENT_METHOD_CLASS, xcontext); > + > + BaseClass bclass = doc.getXClass(); > + bclass.setName(WIKI_COMPONENT_METHOD_CLASS); > + > + boolean needsUpdate = false; > + > + needsUpdate |= this.initializeXClassDocumentMetadata(doc, "Wiki Component Method XWiki Class"); > + needsUpdate |= bclass.addTextField(METHOD_NAME_FIELD, "Method name", 30); > + needsUpdate |= bclass.addTextAreaField("code", "Method body code", 40, 20); > + > + if (needsUpdate) { > + this.update(doc); > + } > + } > + > + /** > + * Utility method for updating a wiki macro class definition document. > + * > + * @param doc xwiki document containing the wiki macro class. > + * @throws XWikiException if an error occurs while saving the document. > + */ > + private void update(XWikiDocument doc) throws XWikiException > + { > + XWikiContext xcontext = getXWikiContext(); > + xcontext.getWiki().saveDocument(doc, xcontext); > + } > + > + /** > + * Helper method to prepare a document that will hold an XClass definition, setting its initial metadata, if needed > + * (author, title, parent, content, etc.). > + * > + * @param doc the document to prepare > + * @param title the title to set > + * @return true if the doc has been modified and needs saving, false otherwise > + */ > + private boolean initializeXClassDocumentMetadata(XWikiDocument doc, String title) > + { > + boolean needsUpdate = false; > + > + if (StringUtils.isBlank(doc.getCreator())) { > + needsUpdate = true; > + doc.setCreator(XWikiRightService.SUPERADMIN_USER); > + } > + if (StringUtils.isBlank(doc.getAuthor())) { > + needsUpdate = true; > + doc.setAuthor(doc.getCreator()); > + } > + if (StringUtils.isBlank(doc.getParent())) { > + needsUpdate = true; > + doc.setParent("XWiki.XWikiClasses"); > + } > + if (StringUtils.isBlank(doc.getTitle())) { > + needsUpdate = true; > + doc.setTitle(title); > + } > + if (StringUtils.isBlank(doc.getContent()) || !XWikiDocument.XWIKI20_SYNTAXID.equals(doc.getSyntaxId())) { > + needsUpdate = true; > + doc.setContent("{{include document=\"XWiki.ClassSheet\" /}}"); > + doc.setSyntaxId(XWikiDocument.XWIKI20_SYNTAXID); > + } > + return needsUpdate; > + } > + > + /** > + * @return the XWikiContext extracted from the execution. > + */ > + private XWikiContext getXWikiContext() > + { > + return (XWikiContext) this.execution.getContext().getProperty("xwikicontext"); > + } > + > +} > > Added: contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/InvalidComponentDefinitionException.java > =================================================================== > --- contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/InvalidComponentDefinitionException.java (rev 0) > +++ contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/InvalidComponentDefinitionException.java 2010-05-15 15:08:25 UTC (rev 28878) > @@ -0,0 +1,59 @@ [...] > +/** > + * Exception thrown by component builders when a document holds an invalid compoentn definition. > + * (For example if no role has been specified). > + * > + * @since 2.4-M2 > + * @version $Id$ > + */ > +public class InvalidComponentDefinitionException extends Exception > +{ > + /** > + * Constructor of this exception. > + */ > + public InvalidComponentDefinitionException() > + { > + super(); > + } > + > + /** > + * Constructor of this exception. > + * > + * @param message a message associated with the exception, that explains why the definition is invalid > + */ > + public InvalidComponentDefinitionException(String message) > + { > + super(message); > + } > + > + /** > + * Constructor of this exception. > + * > + * @param message a message associated with the exception, that explains why the definition is invalid > + * @param t the root cause > + */ > + public InvalidComponentDefinitionException(String message, Throwable t) > + { > + super(message); > + } > +} > > Added: contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/MethodOutputHandler.java > =================================================================== > --- contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/MethodOutputHandler.java (rev 0) > +++ contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/MethodOutputHandler.java 2010-05-15 15:08:25 UTC (rev 28878) > @@ -0,0 +1,44 @@ [...] > +/** > + * Utility for wiki methods to return a value. An implementation of this interface is binded in the context of a > + * wiki method execution, so that such method scripts can return a value using {@link #returnValue(Object)}. > + * > + * @since 2.4-M2 > + * @version $Id$ > + */ > +public interface MethodOutputHandler > +{ > + > + /** > + * Stores a value in the method invocation context for further return. > + * Note that if this method is called multiple times during the invocation, the last one wins. > + * > + * @param value the value to return > + */ > + void returnValue(Object value); > + > + /** > + * @return the current stored return value (null if not set yet). > + */ > + Object getReturnValue(); > +} > > Added: contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponent.java > =================================================================== > --- contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponent.java (rev 0) > +++ contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponent.java 2010-05-15 15:08:25 UTC (rev 28878) > @@ -0,0 +1,58 @@ [...] > +/** > + * Represents the definition of a wiki component implementation. > + * > + * @since 2.4-M2 > + * @version $Id$ > + */ > +public interface WikiComponent > +{ > + /** > + * @return the reference to the document holding this wiki component definition. > + */ > + DocumentReference getDocumentReference(); > + > + /** > + * @return the role implemented by this component implementation. > + */ > + Class< ? > getRole(); > + > + /** > + * @return the hint of the role implemented by this component implementation. > + */ > + String getRoleHint(); > + > + /** > + * @return the extra list of interfaces this component implementation implements. > + */ > + Class< ? >[] getImplementedInterfaces(); > + > + /** > + * @return the map of method name/wiki code this component implementation handles. > + */ > + Map<String, String> getHandledMethods(); > +} > > Added: contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentBuilder.java > =================================================================== > --- contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentBuilder.java (rev 0) > +++ contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentBuilder.java 2010-05-15 15:08:25 UTC (rev 28878) > @@ -0,0 +1,46 @@ [...] > +/** > + * Constructs a {@link WikiComponent} out of the data contained in the document pointed by a {@link DocumentReference}. > + * > + * @since 2.4-M2 > + * @version $Id$ > + */ > +@ComponentRole > +public interface WikiComponentBuilder > +{ > + > + /** > + * Builds a wiki component representation extracting the data stored as objects of document. > + * > + * @param reference the reference to the document that holds component definition objects > + * @return the constructed component definition > + * @throws InvalidComponentDefinitionException when the data in the document is not a valid component definition > + * @throws WikiComponentException the builder failed to create the component out of the document (for example due to > + * a failure by tge underlying store, etc.) > + */ > + WikiComponent build(DocumentReference reference) throws InvalidComponentDefinitionException, WikiComponentException; > + > +} > > Added: contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentException.java > =================================================================== > --- contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentException.java (rev 0) > +++ contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentException.java 2010-05-15 15:08:25 UTC (rev 28878) > @@ -0,0 +1,51 @@ [...] > +/** > + * A generic exception thrown by this module, usually a wrapper around lower level exceptions. > + * > + * @since 2.4-M2 > + * @version $Id$ > + */ > +public class WikiComponentException extends Exception > +{ > + /** > + * Constructor of this exception. > + * > + * @param message the message associated with the exception > + */ > + public WikiComponentException(String message) > + { > + super(message); > + } > + > + /** > + * Constructor of this exception. > + * > + * @param message the message associated with the exception > + * @param t the root cause > + */ > + public WikiComponentException(String message, Throwable t) > + { > + super(message, t); > + } > + > +} > > Added: contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentInvocationHandler.java > =================================================================== > --- contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentInvocationHandler.java (rev 0) > +++ contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentInvocationHandler.java 2010-05-15 15:08:25 UTC (rev 28878) > @@ -0,0 +1,245 @@ [...] > +/** > + * Method invocation handler for wiki component proxy instances. Has a reference on a map of name/body wiki code of > + * supported methods. > + * > + * @since 2.4-M2 > + * @version $Id$ > + */ > +public class WikiComponentInvocationHandler implements InvocationHandler > +{ > + /** > + * The key under which the output is kept in the method invocation context. > + */ > + private static final String METHOD_CONTEXT_OUTPUT_KEY = "output"; > + > + /** > + * The key under which the context document is kept in the XWiki context. > + */ > + private static final String XWIKI_CONTEXT_DOC_KEY = "doc"; > + > + /** > + * Pre-loaded hasCode Method. > + * > + * @see {@link Object#hashCode()} > + */ > + private static Method hashCodeMethod; > + > + /** > + * Pre-loaded equals method. > + * > + * @see {@link Object#equals(Object)} > + */ > + private static Method equalsMethod; > + > + /** > + * Pre-loaded toString method. > + * > + * @see {@link Object#toString()} > + */ > + private static Method toStringMethod; > + > + static { > + try { > + hashCodeMethod = Object.class.getMethod("hashCode", null); > + equalsMethod = Object.class.getMethod("equals", new Class[] {Object.class}); > + toStringMethod = Object.class.getMethod("toString", null); > + } catch (NoSuchMethodException e) { > + throw new NoSuchMethodError(e.getMessage()); > + } > + } > + > + /** > + * Map hosting handled methods. Keys are method names and values are wiki code to "execute". > + */ > + private Map<String, String> handledMethods; > + > + /** > + * Our component manager. > + */ > + private ComponentManager componentManager; > + > + /** > + * The reference to the document. > + */ > + private DocumentReference componentReference; > + > + /** > + * Constructor of this invocation handler. > + * > + * @param componentReference reference to the document holding the component definition > + * @param methods the map of methods handled by the component instance > + * @param componentManager the component manager > + */ > + public WikiComponentInvocationHandler(DocumentReference componentReference, Map<String, String> methods, > + ComponentManager componentManager) > + { > + this.componentReference = componentReference; > + this.handledMethods = methods; > + this.componentManager = componentManager; > + } > + > + /** > + * {@inheritDoc} > + */ > + public Object invoke(Object proxy, Method method, Object[] args) throws Throwable > + { > + if (!this.handledMethods.containsKey(method.getName())) { > + if (method.getDeclaringClass() == Object.class) { > + return this.proxyObjectMethod(proxy, method, args); > + } else { > + throw new NoSuchMethodException(); > + } > + } else { > + return this.executeWikiContent(method); > + } > + > + } > + > + /** > + * "Executes" the wiki content associated to the passed method. > + * > + * @param method the method to execute > + * @return the result of the execution > + * @throws Exception when an error occurs during execution > + */ > + @SuppressWarnings("unchecked") > + private Object executeWikiContent(Method method) throws Exception > + { > + XDOM xdom; > + Map xwikiContext = null; > + Object contextDoc = null; > + > + Parser parser = componentManager.lookup(Parser.class, Syntax.XWIKI_2_0.toIdString()); > + xdom = parser.parse(new StringReader(this.handledMethods.get(method.getName()))); > + > + Execution execution = componentManager.lookup(Execution.class); > + Transformation macroTransformation = componentManager.lookup(Transformation.class, "macro"); > + DocumentAccessBridge docBridge = componentManager.lookup(DocumentAccessBridge.class); > + > + Map<String, Object> methodContext = new HashMap<String, Object>(); > + methodContext.put(METHOD_CONTEXT_OUTPUT_KEY, new DefaultMethodOutputHandler()); > + > + // Place macro context inside xwiki context ($context.macro). > + xwikiContext = (Map) execution.getContext().getProperty("xwikicontext"); > + xwikiContext.put("method", methodContext); > + // Save current context document. > + contextDoc = xwikiContext.get(XWIKI_CONTEXT_DOC_KEY); > + // Make sure has prog rights > + xwikiContext.put(XWIKI_CONTEXT_DOC_KEY, docBridge.getDocument(this.componentReference)); > + > + // Perform internal macro transformations. > + macroTransformation.transform(xdom, Syntax.XWIKI_2_0); > + > + if (methodContext.get(METHOD_CONTEXT_OUTPUT_KEY) != null > + && ((MethodOutputHandler) methodContext.get(METHOD_CONTEXT_OUTPUT_KEY)).getReturnValue() != null) { > + return method.getReturnType().cast(((MethodOutputHandler) > + methodContext.get(METHOD_CONTEXT_OUTPUT_KEY)).getReturnValue()); > + } else if (method.getReturnType().equals(String.class)) { > + // If return type is String and no specific return value has been provided during the macro > + // expansion, then we return the content redered as > + WikiPrinter printer = new DefaultWikiPrinter(); > + BlockRenderer renderer = componentManager.lookup(BlockRenderer.class, Syntax.PLAIN_1_0.toIdString()); > + renderer.render(xdom, printer); > + return printer.toString(); > + } else { > + // surrender > + return null; > + } > + } Don't do the same mistake than wik macros (see http://jira.xwiki.org/jira/browse/XWIKI-5030) you should store the XDOM instead of the source to avoid reparsing it each time you execute a virtual method. > + > + /** > + * Proxies a method of the {@link Object} class. > + * > + * @param proxy the proxy instance > + * @param method the method to proxy > + * @param args possible arguments to the method invocation > + * @return the result of the proxied call > + */ > + private Object proxyObjectMethod(Object proxy, Method method, Object[] args) > + { > + if (method.equals(hashCodeMethod)) { > + return proxyHashCode(proxy); > + } else if (method.equals(equalsMethod)) { > + return proxyEquals(proxy, args[0]); > + } else if (method.equals(toStringMethod)) { > + return proxyToString(proxy); > + } else { > + throw new InternalError("unexpected Object method dispatched: " + method); > + } > + } > + > + /** > + * Default behavior for {@link Object#hashCode()} when not overridden in the wiki component definition. > + * > + * @param proxy the proxy object > + * @return a hash code for the proxy object, as if using standard {Object{@link #hashCode()}. > + */ > + protected Integer proxyHashCode(Object proxy) > + { > + return new Integer(System.identityHashCode(proxy)); > + } > + > + /** > + * Default behavior for {@link Object#equals(Object)} when not overridden in the wiki component definition. > + * > + * @param proxy the proxy object > + * @param other the other object of the comparison > + * @return the result of the equality comparison between the passed proxy and other object > + */ > + protected Boolean proxyEquals(Object proxy, Object other) > + { > + return (proxy == other ? Boolean.TRUE : Boolean.FALSE); > + } > + > + /** > + * Default behavior for {@link Object#toString()} when not overridden in the wiki component definition. > + * > + * @param proxy the proxy object > + * @return the String representation of the passed proxy object > + */ > + protected String proxyToString(Object proxy) > + { > + return proxy.getClass().getName() + '@' + Integer.toHexString(proxy.hashCode()); > + } > + > +} > > Added: contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentManager.java > =================================================================== > --- contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentManager.java (rev 0) > +++ contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/WikiComponentManager.java 2010-05-15 15:08:25 UTC (rev 28878) > @@ -0,0 +1,46 @@ [...] > +package org.xwiki.component.wiki; > + > +import org.xwiki.component.annotation.ComponentRole; > + > +/** > + * A WikiComponentManager is responsible for registering and unregistering components that are defined as wiki pages. > + * Each {@link WikiComponent} managed by such manager is associated to a {@link org.xwiki.model.DocumentReference}. The > + * referred document contains XObjects that define the role, hint and behavior (method bodies) of the component. This > + * document may also define requirements (other components to be binded in the method bodies execution context) and > + * possible extra interfaces (for example to implement {@link org.xwiki.component.phase.Initializable}). > + * > + * @since 2.4-M2 > + * @version $Id$ > + */ > +@ComponentRole > +public interface WikiComponentManager > +{ > + > + /** > + * Registers the passed component against the underlying component repository. > + * > + * @param component the component to register > + * @throws WikiComponentException when failed to register the component against the CM > + */ > + void registerWikiComponent(WikiComponent component) throws WikiComponentException; > + > +} > > Added: contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/internal/DefaultMethodOutputHandler.java > =================================================================== > --- contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/internal/DefaultMethodOutputHandler.java (rev 0) > +++ contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/internal/DefaultMethodOutputHandler.java 2010-05-15 15:08:25 UTC (rev 28878) > @@ -0,0 +1,54 @@ [...] > +package org.xwiki.component.wiki.internal; > + > +import org.xwiki.component.wiki.MethodOutputHandler; > + > +/** > + * Default method output handler. > + * > + * @since 2.4-M2 > + * @version $Id$ > + */ > +public class DefaultMethodOutputHandler implements MethodOutputHandler > +{ > + > + /** > + * The stored return value. > + */ > + private Object returnValue; > + > + /** > + * {@inheritDoc} > + */ > + public void returnValue(Object value) > + { > + this.returnValue = value; > + } > + > + /** > + * {@inheritDoc} > + */ > + public Object getReturnValue() > + { > + return this.returnValue; > + } > + > +} > > Added: contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/internal/DefaultWikiComponent.java > =================================================================== > --- contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/internal/DefaultWikiComponent.java (rev 0) > +++ contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/internal/DefaultWikiComponent.java 2010-05-15 15:08:25 UTC (rev 28878) > @@ -0,0 +1,139 @@ [...] > +package org.xwiki.component.wiki.internal; > + > +import java.util.HashMap; > +import java.util.Map; > + > +import org.xwiki.component.wiki.WikiComponent; > +import org.xwiki.model.reference.DocumentReference; > + > +/** > + * Default implementation of a wiki component definition. > + * > + * @since 2.4-M2 > + * @version $Id$ > + */ > +public class DefaultWikiComponent implements WikiComponent > +{ > + /** > + * @see {@link #getDocumentReference()} > + */ > + private DocumentReference documentReference; > + > + /** > + * @see {@link #getHandledMethods()} > + */ > + private Map<String, String> handledMethods = new HashMap<String, String>(); > + > + /** > + * @see {@link #getRole()} > + */ > + private Class< ? > role; > + > + /** > + * @see {@link #getRoleHint()} > + */ > + private String roleHint; > + > + /** > + * @see {@link #getImplementedInterfaces()} > + */ > + private Class< ? >[] implementedInterfaces = new Class< ? >[]{}; > + > + /** > + * Constructor of this component. > + * > + * @param reference the document holding the component definition > + * @param role the role implemented > + * @param roleHint the role hint for this role implementation > + */ > + public DefaultWikiComponent(DocumentReference reference, Class< ? > role, String roleHint) > + { > + this.documentReference = reference; > + this.role = role; > + this.roleHint = roleHint; > + } > + > + /** > + * {@inheritDoc} > + */ > + public DocumentReference getDocumentReference() > + { > + return this.documentReference; > + } > + > + /** > + * {@inheritDoc} > + */ > + public Map<String, String> getHandledMethods() > + { > + return this.handledMethods; > + } > + > + /** > + * {@inheritDoc} > + */ > + public Class< ? > getRole() > + { > + return this.role; > + } > + > + /** > + * {@inheritDoc} > + */ > + public String getRoleHint() > + { > + return this.roleHint; > + } > + > + /** > + * {@inheritDoc} > + */ > + public Class< ? >[] getImplementedInterfaces() > + { > + return this.implementedInterfaces; > + } > + > + /** > + * Sets the handled method. > + * > + * @see {@link #getHandledMethods()} > + * > + * @param methods the methods this component will handle > + */ > + public void setHandledMethods(Map<String, String> methods) > + { > + this.handledMethods = methods; > + } > + > + /** > + * Sets the implemented interfaces. > + * > + * @see {@link #getImplementedInterfaces()} > + * > + * @param interfaces the interfaces this component will implement. > + */ > + public void setImplementedInterfaces(Class< ? >[] interfaces) > + { > + this.implementedInterfaces = interfaces; > + } > + > +} > > Added: contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/internal/DefaultWikiComponentManager.java > =================================================================== > --- contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/internal/DefaultWikiComponentManager.java (rev 0) > +++ contrib/sandbox/xwiki-wiki-components/src/main/java/org/xwiki/component/wiki/internal/DefaultWikiComponentManager.java 2010-05-15 15:08:25 UTC (rev 28878) > @@ -0,0 +1,130 @@ [...] > + > +/** > + * Default implementation of {@link WikiComponentManager}. Creates proxy objects which method invocation handler keeps a > + * reference on a set of declared method and associated wiki content to "execute". > + * > + * @since 2.4-M2 > + * @version $Id$ > + */ > +@Component > +public class DefaultWikiComponentManager extends AbstractLogEnabled implements WikiComponentManager > +{ > + /** > + * Component manager against which wiki component will be registered. > + */ > + @Requirement > + private ComponentManager mainComponentManager; > + > + /** > + * {@inheritDoc} > + */ > + @SuppressWarnings("unchecked") > + public void registerWikiComponent(WikiComponent component) throws WikiComponentException > + { > + try { > + // Get the component role interface > + Class< ? > role = component.getRole(); > + > + // Create the method invocation handler of the proxy > + InvocationHandler handler = > + new WikiComponentInvocationHandler(component.getDocumentReference(), component.getHandledMethods(), > + mainComponentManager); > + > + // Prepare array of all interfaces the component implementation declares, that is the interface declared as > + // component role > + // plus possible extra other interfaces > + Class< ? >[] allImplementedInterfaces = new Class< ? >[component.getImplementedInterfaces().length + 1]; > + System.arraycopy(component.getImplementedInterfaces(), 0, allImplementedInterfaces, 0, component > + .getImplementedInterfaces().length); > + allImplementedInterfaces[component.getImplementedInterfaces().length] = role; > + > + // Create the component instance and its descritor > + Object instance = Proxy.newProxyInstance(role.getClassLoader(), allImplementedInterfaces, handler); > + ComponentDescriptor componentDescriptor = this.createComponentDescriptor(role, component.getRoleHint()); > + > + // Since we are responsible to create the component instance, > + // we also are responsible of its initialization (if needed) > + if (this.isInitializable(allImplementedInterfaces)) { > + try { > + ((Initializable) instance).initialize(); > + } catch (InitializationException e) { > + getLogger().error("Failed to initialize wiki component", e); > + } > + } > + > + // Finally, register the component against the CM > + this.mainComponentManager.registerComponent(componentDescriptor, role.cast(instance)); > + } catch (ComponentRepositoryException e) { > + throw new WikiComponentException("Failed to register wiki component against component repository", e); > + } > + } > + > + /** > + * Helper method to create a component descriptor from role and hint. > + * > + * @param role the component role of the descriptor to create > + * @param roleHint the hint of the implementation for the descriptor to create > + * @return the constructed {@link ComponentDescriptor} > + */ > + @SuppressWarnings("unchecked") > + private ComponentDescriptor createComponentDescriptor(Class role, String roleHint) > + { > + DefaultComponentDescriptor cd = new DefaultComponentDescriptor(); > + cd.setRole(role); > + cd.setRoleHint(roleHint); > + return cd; > + } > + > + /** > + * Helper method that checks if at least one of an array of interfaces is the {@link Initializable} class. > + * > + * @param interfaces the array of interfaces to test > + * @return true if at least one of the passed interfaces is the is the {@link Initializable} class. > + */ > + private boolean isInitializable(Class< ? >[] interfaces) > + { > + for (Class< ? > iface : interfaces) { > + if (Initializable.class.equals(iface)) { > + return true; > + } > + } > + return false; > + } > +} > [...] > > Added: contrib/sandbox/xwiki-wiki-components/src/test/java/org/xwiki/component/wiki/WikiComponentManagerTest.java > =================================================================== > --- contrib/sandbox/xwiki-wiki-components/src/test/java/org/xwiki/component/wiki/WikiComponentManagerTest.java (rev 0) > +++ contrib/sandbox/xwiki-wiki-components/src/test/java/org/xwiki/component/wiki/WikiComponentManagerTest.java 2010-05-15 15:08:25 UTC (rev 28878) > @@ -0,0 +1,34 @@ [...] > + > +public class WikiComponentManagerTest extends AbstractComponentTestCase > +{ > + private WikiComponentManager manager; > + > + @Before > + public void setUp() throws Exception > + { > + manager = getComponentManager().lookup(WikiComponentManager.class); > + } > + > + @Test > + public void testRegisterWikiComponent() throws Exception > + { > + DocumentReference pseudoReference = new DocumentReference("somewiki","XWiki","MyComponent"); > + > + DefaultWikiComponent wc = new DefaultWikiComponent(pseudoReference, WikiComponentManager.class, "test"); > + > + this.manager.registerWikiComponent(wc); > + > + WikiComponentManager registered = this.getComponentManager().lookup(WikiComponentManager.class, "test"); > + > + Assert.assertNotNull(registered); > + } > +} -- Thomas Mortagne

1 0

[xwiki-devs] [VOTE] Add bridge event for notifying components XWiki has been initialized (XWIKI-5194)
by Jerome Velociter 16 May '10

16 May '10

Hi Devs, I'd like to add a bridge event to allow components to get notified when old core has been initialized (at the end of XWiki#initXWiki for example). This would be useful for components that needs to access the store, for example to register XWiki classes. I recognize this solution is not perfect since it's more bridged code, but it would be better that what we have been doing so far (hard-coded component initialization in XWiki.java, for example for the wiki macro bridge to register its classes) I've attached a patch proposal to http://jira.xwiki.org/jira/browse/XWIKI-5194. Note that I would also fix the wiki macro bridge initialization. +1 from me to go ahead with that. WDYT ? Thanks, Jerome

3 4

[xwiki-devs] [VOTE] Configuration based generic rendering cache
by Thomas Mortagne 15 May '10

15 May '10

Hi devs, I would like to commit my configuration based rendering cache system before 2.4M1 for it to be well tested and improved during 2.4 dev. You can find details about it on http://markmail.org/message/tnggdulplm73cxm5 Here is my +1 Thanks, -- Thomas Mortagne

5 7

[xwiki-devs] Question on correct behavior regarding velocity macros.
by Caleb James DeLisle 15 May '10

15 May '10

I'd like to know if this behavior is correct/desired. 1. Users without PR can register skins. 2. Skins can override global velocity macros. 3. Macros are evaluated in the security context of the caller. If the answer to these questions is yes, then a document which invokes a global macro such as #livetable does not know that the macro may be overridden by the skin and it may be doing something in their name which is a security gotcha and should be loudly documented. If this behavior is not desired then maybe the best solution is to prevent skin macros from overriding global macros unless the skin author has PR. WDYT? Caleb

1 0

Re: [xwiki-devs] [xwiki-notifications] r28862 - in enterprise/trunk/distribution-test/ui-tests/src/test/it/org/xwiki/it/ui: . elements
by Thomas Mortagne 14 May '10

14 May '10

On Thu, May 13, 2010 at 22:51, sdumitriu <enterprise-notifications(a)xwiki.org > wrote: > Author: sdumitriu > Date: 2010-05-13 22:51:35 +0200 (Thu, 13 May 2010) > New Revision: 28862 > > Added: > > enterprise/trunk/distribution-test/ui-tests/src/test/it/org/xwiki/it/ui/TemplateTest.java > > enterprise/trunk/distribution-test/ui-tests/src/test/it/org/xwiki/it/ui/elements/WikiEditPage.java > Log: > XWIKI-2580: Improve file access sandboxing > Added some more tests. > Patch from Alex Busenius applied with minor changes. > > Added: > enterprise/trunk/distribution-test/ui-tests/src/test/it/org/xwiki/it/ui/TemplateTest.java > =================================================================== > --- > enterprise/trunk/distribution-test/ui-tests/src/test/it/org/xwiki/it/ui/TemplateTest.java > (rev 0) > +++ > enterprise/trunk/distribution-test/ui-tests/src/test/it/org/xwiki/it/ui/TemplateTest.java > 2010-05-13 20:51:35 UTC (rev 28862) > @@ -0,0 +1,135 @@ > +/* > + * 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.it.ui; > + > +import junit.framework.Assert; > + > +import org.junit.Before; > +import org.junit.Test; > +import org.openqa.selenium.By; > +import org.xwiki.it.ui.elements.WikiEditPage; > +import org.xwiki.it.ui.framework.AbstractAdminAuthenticatedTest; > + > + > +/** > + * Test template handling > + * > + * @version $Id$ > + * @since 2.4M1 > + */ > +public class TemplateTest extends AbstractAdminAuthenticatedTest > +{ > + /** Page used for testing: Main.TemplateTest */ > + private WikiEditPage editPage; > + > + > + @Before > + @Override > + public void setUp() > + { > + super.setUp(); > + > + editPage = new WikiEditPage(getDriver()); > + } > + > + /** > + * Test that velocity is rendered > + */ > + @Test > + public void testHelloVelocity() > + { > + String hello = "Hello Velocity Test Test Test"; > + saveVelocity(hello); > + > Assert.assertTrue(getDriver().findElement(By.id("xwikicontent")).getText().contains(hello)); > + } > + > + /** > + * Test that an included existing template is displayed correctly > + */ > + @Test > + public void testCorrectTemplate() > + { > + saveVelocity(includeTemplate("code.vm"), true); > + Assert.assertNotNull(getDriver().findElement( > + > By.xpath("//div[@id='xwikicontent']//textarea[@class='wiki-code']"))); > + } > + > + /** > + * See XWIKI-2580 > + */ > + @Test > + public void testWrongTemplate() > + { > + saveVelocity(includeTemplate("../../")); > + Assert.assertTrue("root directory", > + > getDriver().findElement(By.id("xwikicontent")).getText().isEmpty()); > String#isEmpty is JAVA 6 API so that will fail to build with our maven configuration. > + > + saveVelocity(includeTemplate("asdfasdf")); > + Assert.assertTrue("not existing template", > + > getDriver().findElement(By.id("xwikicontent")).getText().isEmpty()); > + > + saveVelocity(includeTemplate("../redirect")); > + Assert.assertTrue("file in the parent directory", > + > getDriver().findElement(By.id("xwikicontent")).getText().isEmpty()); > + > + saveVelocity(includeTemplate("../WEB-INF/version.properties")); > + Assert.assertTrue("file in the wrong directory", > + > getDriver().findElement(By.id("xwikicontent")).getText().isEmpty()); > + > + > saveVelocity(includeTemplate("/chw/../../WEB-INF/../WEB-INF/lib/../version.properties")); > + Assert.assertTrue("file in the wrong directory, not normalized > path", > + > getDriver().findElement(By.id("xwikicontent")).getText().isEmpty()); > + } > + > + /** > + * @see #saveVelocity(String, boolean) > + */ > + private void saveVelocity(String code) > + { > + saveVelocity(code, false); > + } > + > + /** > + * Save a page with given velocity code and switch to view. Encloses > <code>code</code> > + * into the {{velocity}} macro and optionally also {{html}} macro. > + * > + * @param code velocity code to save > + * @param html additionally enclose <code>code</code> in {{html}} if > true > + */ > + private void saveVelocity(String code, boolean html) > + { > + editPage.switchToEdit("Main", "TemplateTest"); > + if (html) { > + code = "{{html wiki=\"false\"}}\n" + code + "\n{{/html}}"; > + } > + editPage.setContent("{{velocity filter=\"none\"}}\n" + code + > "\n{{/velocity}}\n"); > + editPage.clickSaveAndView(); > + } > + > + /** > + * Return velocity code to include a velocity template > <code>name</code> > + * > + * @param name template to use > + */ > + private String includeTemplate(String name) > + { > + return "#template(\"" + name + "\")\n"; > + } > +} > > > Property changes on: > enterprise/trunk/distribution-test/ui-tests/src/test/it/org/xwiki/it/ui/TemplateTest.java > ___________________________________________________________________ > Name: svn:keywords > + Author Id Revision HeadURL > Name: svn:eol-style > + native > > Added: > enterprise/trunk/distribution-test/ui-tests/src/test/it/org/xwiki/it/ui/elements/WikiEditPage.java > =================================================================== > --- > enterprise/trunk/distribution-test/ui-tests/src/test/it/org/xwiki/it/ui/elements/WikiEditPage.java > (rev 0) > +++ > enterprise/trunk/distribution-test/ui-tests/src/test/it/org/xwiki/it/ui/elements/WikiEditPage.java > 2010-05-13 20:51:35 UTC (rev 28862) > @@ -0,0 +1,108 @@ > +/* > + * 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.it.ui.elements; > + > +import org.openqa.selenium.WebDriver; > +import org.openqa.selenium.WebElement; > +import org.openqa.selenium.support.FindBy; > +import org.xwiki.it.ui.framework.TestUtils; > + > +/** > + * Represents the common actions possible on all Pages when using the > "edit" action with "wiki" > + * editor > + * > + * @version $Id$ > + * @since 2.4M1 > + */ > +public class WikiEditPage extends EditPage > +{ > + @FindBy(id = "xwikidoctitleinput") > + private WebElement titleInput; > + > + @FindBy(id = "content") > + private WebElement contentText; > + > + @FindBy(name = "minorEdit") > + private WebElement minorEditCheckBox; > + > + @FindBy(name = "comment") > + private WebElement commentInput; > + > + > + public WikiEditPage(WebDriver driver) > + { > + super(driver); > + } > + > + /** > + * Set the <code>title</code> of the page > + * > + * @param title > + */ > + public void setTitle(String title) > + { > + titleInput.clear(); > + titleInput.sendKeys(title); > + } > + > + /** > + * Set the <code>content</code> of the page > + * > + * @param content > + */ > + public void setContent(String content) > + { > + contentText.clear(); > + contentText.sendKeys(content); > + } > + > + /** > + * Set the minor edit check box value > + * > + * @param value > + */ > + public void setMinorEdit(boolean value) > + { > + if (minorEditCheckBox.isSelected() != value) > + minorEditCheckBox.toggle(); > + } > + > + /** > + * Set <code>comment</code> for this change > + * > + * @param comment > + */ > + public void setEditComment(String comment) > + { > + commentInput.clear(); > + commentInput.sendKeys(comment); > + } > + > + /** > + * Start editing page, create first if needed > + * > + * @param space > + * @param page > + */ > + public void switchToEdit(String space, String page) > + { > + TestUtils.gotoPage(space, page, "edit", "editor=wiki", > getDriver()); > + } > +} > > > Property changes on: > enterprise/trunk/distribution-test/ui-tests/src/test/it/org/xwiki/it/ui/elements/WikiEditPage.java > ___________________________________________________________________ > Name: svn:keywords > + Author Id Revision HeadURL > Name: svn:eol-style > + native > > _______________________________________________ > notifications mailing list > notifications(a)xwiki.org > http://lists.xwiki.org/mailman/listinfo/notifications > -- Thomas Mortagne

2 2

Re: [xwiki-devs] [xwiki-notifications] r28861 - in platform/core/branches/xwiki-core-2.2/xwiki-core/src: main/java/com/xpn/xwiki main/java/com/xpn/xwiki/web test/java/com/xpn/xwiki/web
by Vincent Massol 14 May '10

14 May '10

On May 13, 2010, at 10:45 PM, sdumitriu (SVN) wrote: > Author: sdumitriu > Date: 2010-05-13 22:45:42 +0200 (Thu, 13 May 2010) > New Revision: 28861 > > Modified: > platform/core/branches/xwiki-core-2.2/xwiki-core/src/main/java/com/xpn/xwiki/XWiki.java > platform/core/branches/xwiki-core-2.2/xwiki-core/src/main/java/com/xpn/xwiki/web/SkinAction.java > platform/core/branches/xwiki-core-2.2/xwiki-core/src/test/java/com/xpn/xwiki/web/SkinActionTest.java > Log: > XWIKI-2580: Improve file access sandboxing > Fixed. > Patch from Alex Busenius applied with minor changes. > Merged from trunk@r28858 [snip] > > Modified: platform/core/branches/xwiki-core-2.2/xwiki-core/src/test/java/com/xpn/xwiki/web/SkinActionTest.java > =================================================================== > --- platform/core/branches/xwiki-core-2.2/xwiki-core/src/test/java/com/xpn/xwiki/web/SkinActionTest.java 2010-05-13 20:45:29 UTC (rev 28860) > +++ platform/core/branches/xwiki-core-2.2/xwiki-core/src/test/java/com/xpn/xwiki/web/SkinActionTest.java 2010-05-13 20:45:42 UTC (rev 28861) > @@ -20,6 +20,8 @@ > */ > package com.xpn.xwiki.web; > > +import java.io.IOException; > + > import org.jmock.cglib.MockObjectTestCase; > > /** > @@ -66,4 +68,54 @@ > { > assertFalse(this.action.isJavascriptMimeType(null)); > } > + > + public void testIncorrectSkinFile() > + { > + try { > + this.action.getSkinFilePath("../../resources/js/xwiki/xwiki.js", "colibri"); > + assertTrue("should fail", false); > + } catch (IOException e) { > + // good > + } > + try { > + this.action.getSkinFilePath("../../../", "colibri"); > + assertTrue("should fail", false); > + } catch (IOException e) { > + // good > + } > + try { > + this.action.getSkinFilePath("resources/js/xwiki/xwiki.js", ".."); > + assertTrue("should fail", false); > + } catch (IOException e) { > + // good > + } > + try { > + this.action.getSkinFilePath("../resources/js/xwiki/xwiki.js", "."); > + assertTrue("should fail", false); > + } catch (IOException e) { > + // good > + } > + } > + This should be 4 separate tests. -Vincent > + public void testIncorrectResourceFile() > + { > + try { > + this.action.getResourceFilePath("../../skins/js/xwiki/xwiki.js"); > + assertTrue("should fail", false); > + } catch (IOException e) { > + // good > + } > + try { > + this.action.getResourceFilePath("../../../"); > + assertTrue("should fail", false); > + } catch (IOException e) { > + // good > + } > + try { > + this.action.getResourceFilePath("../../redirect"); > + assertTrue("should fail", false); > + } catch (IOException e) { > + // good > + } > + } > } > > _______________________________________________ > notifications mailing list > notifications(a)xwiki.org > http://lists.xwiki.org/mailman/listinfo/notifications

1 0

Re: [xwiki-devs] [xwiki-notifications] r28858 - in platform/core/trunk/xwiki-core/src: main/java/com/xpn/xwiki main/java/com/xpn/xwiki/web test/java/com/xpn/xwiki/web
by Vincent Massol 14 May '10

14 May '10

On May 13, 2010, at 10:43 PM, sdumitriu (SVN) wrote: > Author: sdumitriu > Date: 2010-05-13 22:43:41 +0200 (Thu, 13 May 2010) > New Revision: 28858 > > Modified: > platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/XWiki.java > platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/web/SkinAction.java > platform/core/trunk/xwiki-core/src/test/java/com/xpn/xwiki/web/SkinActionTest.java > Log: > XWIKI-2580: Improve file access sandboxing > Fixed. > Patch from Alex Busenius applied with minor changes. [snip] > Modified: platform/core/trunk/xwiki-core/src/test/java/com/xpn/xwiki/web/SkinActionTest.java > =================================================================== > --- platform/core/trunk/xwiki-core/src/test/java/com/xpn/xwiki/web/SkinActionTest.java 2010-05-13 20:24:25 UTC (rev 28857) > +++ platform/core/trunk/xwiki-core/src/test/java/com/xpn/xwiki/web/SkinActionTest.java 2010-05-13 20:43:41 UTC (rev 28858) > @@ -20,6 +20,8 @@ > */ > package com.xpn.xwiki.web; > > +import java.io.IOException; > + > import org.jmock.cglib.MockObjectTestCase; > > /** > @@ -66,4 +68,54 @@ > { > assertFalse(this.action.isJavascriptMimeType(null)); > } > + > + public void testIncorrectSkinFile() > + { > + try { > + this.action.getSkinFilePath("../../resources/js/xwiki/xwiki.js", "colibri"); > + assertTrue("should fail", false); This should be fail(....) > + } catch (IOException e) { This should be "exception" instead of "e" Same below. Note: Using junit4 this should be done using an annotation: @Test(expected=IOException.class) Thanks -Vincent > + // good > + } > + try { > + this.action.getSkinFilePath("../../../", "colibri"); > + assertTrue("should fail", false); > + } catch (IOException e) { > + // good > + } > + try { > + this.action.getSkinFilePath("resources/js/xwiki/xwiki.js", ".."); > + assertTrue("should fail", false); > + } catch (IOException e) { > + // good > + } > + try { > + this.action.getSkinFilePath("../resources/js/xwiki/xwiki.js", "."); > + assertTrue("should fail", false); > + } catch (IOException e) { > + // good > + } > + } > + > + public void testIncorrectResourceFile() > + { > + try { > + this.action.getResourceFilePath("../../skins/js/xwiki/xwiki.js"); > + assertTrue("should fail", false); > + } catch (IOException e) { > + // good > + } > + try { > + this.action.getResourceFilePath("../../../"); > + assertTrue("should fail", false); > + } catch (IOException e) { > + // good > + } > + try { > + this.action.getResourceFilePath("../../redirect"); > + assertTrue("should fail", false); > + } catch (IOException e) { > + // good > + } > + } > }

1 0

Re: [xwiki-devs] [xwiki-notifications] r28837 - platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki
by Vincent Massol 12 May '10

12 May '10

On May 12, 2010, at 6:06 AM, sdumitriu (SVN) wrote: > Author: sdumitriu > Date: 2010-05-12 06:06:25 +0200 (Wed, 12 May 2010) > New Revision: 28837 > > Modified: > platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/XWiki.java > Log: > [cleanup] Applied codestyle, fixed some deprecated calls, replaced string names with proper document references > > Modified: platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/XWiki.java > =================================================================== > --- platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/XWiki.java 2010-05-11 17:47:17 UTC (rev 28836) > +++ platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/XWiki.java 2010-05-12 04:06:25 UTC (rev 28837) > @@ -67,6 +67,7 @@ > import org.apache.commons.httpclient.auth.AuthScope; > import org.apache.commons.httpclient.methods.GetMethod; > import org.apache.commons.httpclient.util.URIUtil; > +import org.apache.commons.io.IOUtils; > import org.apache.commons.lang.RandomStringUtils; > import org.apache.commons.lang.StringEscapeUtils; > import org.apache.commons.lang.StringUtils; > @@ -106,6 +107,8 @@ > import org.xwiki.observation.event.DocumentUpdateEvent; > import org.xwiki.query.QueryException; > import org.xwiki.rendering.macro.wikibridge.WikiMacroInitializer; > +import org.xwiki.url.XWikiEntityURL; > +import org.xwiki.url.standard.XWikiURLBuilder; > > import com.xpn.xwiki.api.Api; > import com.xpn.xwiki.api.Document; > @@ -180,13 +183,15 @@ > import com.xpn.xwiki.web.XWikiURLFactoryService; > import com.xpn.xwiki.web.XWikiURLFactoryServiceImpl; > import com.xpn.xwiki.web.includeservletasstring.IncludeServletAsString; > -import org.xwiki.url.XWikiEntityURL; > -import org.xwiki.url.standard.XWikiURLBuilder; > > public class XWiki implements XWikiDocChangeNotificationInterface > { > protected static final Log LOG = LogFactory.getLog(XWiki.class); > > + /** Frequently used Document reference, the class which holds virtual wiki definitions. */ > + private static final DocumentReference VIRTUAL_WIKI_DEFINITION_CLASSNAME = > + new DocumentReference("xwiki", "XWiki", "XWikiServerClass"); I'd use CLASS_REFERENCE instead of Classname. > + > private XWikiConfig config; > > private XWikiStoreInterface store; > @@ -212,6 +217,7 @@ > > private XWikiPluginManager pluginManager; > > + @SuppressWarnings("deprecation") > private XWikiNotificationManager notificationManager; Why suppress the warning? We should use the new notification manager and remove this one. > private XWikiAuthService authService; > @@ -297,15 +303,18 @@ > /** > * Used to convert a proper Document Reference to string (standard form). > */ > + @SuppressWarnings("unchecked") > private EntityReferenceSerializer<String> defaultEntityReferenceSerializer = > Utils.getComponent(EntityReferenceSerializer.class); [snip] (haven't really checked the rest) Thanks -Vincent

3 3

[xwiki-devs] [VOTE] Add a page size chooser to livetables
by Denis Gervalle 12 May '10

12 May '10

Hi devs, I want to add a control to choose the page size of livetables. I have made a proposal, and Guillaume Lerouge has suggested to show it by the default when using the #livetable macro. This addition is not intrusive, takes no additional place in the UI and does not require additional support on the server side. My updated proposal is resumed here: http://incubator.myxwiki.org/xwiki/bin/view/Improvements/LivetablePageSizer I would like to apply this patch for XE2.4M1. Here is my +1 Denis -- Denis Gervalle SOFTEC sa - CEO eGuilde sarl - CTO

6 8

[xwiki-devs] [Discussion] Make Invitation Application storage and configuration comparable with Invitation Manager plugin.
by Caleb James DeLisle 11 May '10

11 May '10

In http://www.mail-archive.com/[email protected]/msg14717.html Ludovic said "We need to be as compatible as possible with how the current invitation manager stores it's configuration and state (current invitation and requests)" I think this concept is worthy of it's own discussion thread. When I approached this project, I hadn't considered a need for an upgrade path from the Invitation Manager (I assume that's what this is for.) The application as it stands is quite dependent on a different configuration/storage model and changing will take a long time. Do we really want to use the same configuration/storage as the Invitation Manager? * The Invitation Manager plug-in uses configuration parameters defined in the now deprecated xwiki.cfg file while Invitation Application uses a custom configuration class through the XWiki.ConfigurableClass system. * Invitation Manager and Invitation Application both store message status as a number, Invitation Application uses additional codes for "sending failed", "reported as spam", and "reported and investigated". * Invitation Manager has an additional field "space" which will make no sense without Space Manager plug-in in the invitation application setup and will have to be replaced by "groups". * To copy Invitation Manager setup will block further feature addition such as invitations which expire after a given amount of time (for mailing lists). * Invitation Manager templates are coded in a format similar to XWiki/1.0 syntax (but not exactly the same) Invitation Application templates are (currently) to be coded in XWiki/2.0 syntax. Options: We could continue the Invitation Application as is and if an upgrade path is needed, add a script for upgrading legacy data later on. Drop the current work and get the Invitation Manager plugin to build (It would be a shame to dump so much work over one requirement.) Rewrite the current work to be compatible with the old Invitation Manager, accept using depricated configuration and sacrifice features (this will take the most time.) What are your thoughts? Caleb

3 2