September 2010 - xwiki-devs@xwiki.org

Re: [xwiki-devs] [xwiki-notifications] r31022 - platform/web/trunk/standard/src/main/webapp/templates
by Sergiu Dumitriu 13 Sep '10

13 Sep '10

On 09/09/2010 01:59 PM, cjdelisle (SVN) wrote: > Author: cjdelisle > Date: 2010-09-09 13:59:55 +0200 (Thu, 09 Sep 2010) > New Revision: 31022 > > Modified: > platform/web/trunk/standard/src/main/webapp/templates/commentsinline.vm > Log: > XWIKI-2110: Made comments be rendered in the context of the document "XWiki.XWikiComments" > > Modified: platform/web/trunk/standard/src/main/webapp/templates/commentsinline.vm > =================================================================== > --- platform/web/trunk/standard/src/main/webapp/templates/commentsinline.vm 2010-09-09 08:37:05 UTC (rev 31021) > +++ platform/web/trunk/standard/src/main/webapp/templates/commentsinline.vm 2010-09-09 11:59:55 UTC (rev 31022) > @@ -110,7 +110,7 @@ > ## > ## > ## > -#macro(displayThread $key $commentThreads) > +#macro(displayThread $key $commentThreads, $commentDoc) > ## If request parameter replyto is specified then we show the form under that comment. > #if($replyTo == "$key") > #displayCommentForm() > @@ -134,7 +134,7 @@ > ## > ## > ## > -#macro(displayComment $comment) > +#macro(displayComment $comment, $commentDoc) > <div id="xwikicomment_${comment.number}" class="xwikicomment#if($comment.getProperty('author').value == $doc.creator) commentByCreator#end"> > ##<div class="commentavatar">#useravatar($comment.author)</div> > <div class="commentheader"> > @@ -156,7 +156,7 @@ > #end > </span>## commenttools > </div>## commentheader > -<div class="commentcontent">$doc.display('comment', 'view', $comment)</div> > +<div class="commentcontent">$commentDoc.getRenderedContent($comment.getProperty('comment').getValue(), $doc.getSyntax().toIdString())</div> > </div>## xwikicomment > #end > ## > @@ -302,7 +302,11 @@ > #foreach($comment in $comments) > #addCommentToThreads($comment, $commentThreads, $rootKey) > #end > - #displayThread($rootKey, $commentThreads) > + ## > + ## Comments will be rendered in the context of this document. > + #set($commentDoc = $xwiki.getDocument('XWiki.XWikiComments')) What if the user does not have the right to view XWiki.XWikiComments? $commentDoc will be null, and the display will fail. You should fall back to $doc in this case. Note that this is not so absurd, since it's a good practice to forbid access to the XWiki space. One incompatible use case is that all code using $doc will show different results now, but I don't think this is a very valid use case. > + ## > + #displayThread($rootKey, $commentThreads, $commentDoc) > #else > <p class="noitems">$msg.get('core.viewers.comments.noComments')</p> > #end -- Sergiu Dumitriu http://purl.org/net/sergiu/

3 2

Re: [xwiki-devs] [xwiki-notifications] r31053 - in platform/core/trunk/xwiki-rendering: xwiki-rendering-api/src/main/java/org/xwiki/rendering/configuration xwiki-rendering-api/src/main/java/org/xwiki/rendering/internal/configuration xwiki-rendering-a
by Thomas Mortagne 13 Sep '10

13 Sep '10

On Mon, Sep 13, 2010 at 09:08, Vincent Massol <vincent(a)massol.net> wrote: > Hi Marius, > > I think there are some changes we need to discuss in this commit: > - new config api methods > - new wiki model api methods > - new deps introduced in the rendering module (makes it harder to use without maven) > > These 2 are important as they are important public apis. The WikiModel one is the most important and we need to be 100% sure we want to add a new methods. There must absolutely be the minimal number of methods in this class. Also we're going to break people using the rendering module outside of xwiki (guys from eXo for example, so we need to be careful). > > I haven't thought too much about it yet but my first feeling is that the methods added look quite specific. I'd like to have Thomas's opinion on this since he's the one who's the most knowledgeable about the rendering module. > > Thanks > -Vincent > > On Sep 12, 2010, at 1:30 PM, mflorea (SVN) wrote: > >> Author: mflorea >> Date: 2010-09-12 13:30:15 +0200 (Sun, 12 Sep 2010) >> New Revision: 31053 >> >> Modified: >> platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/configuration/RenderingConfiguration.java >> platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/internal/configuration/DefaultRenderingConfiguration.java >> platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/internal/renderer/xhtml/DefaultXHTMLImageRenderer.java >> platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/wiki/WikiModel.java >> platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/pom.xml >> platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/main/java/org/xwiki/rendering/internal/configuration/XWikiRenderingConfiguration.java >> platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/main/java/org/xwiki/rendering/internal/wiki/XWikiWikiModel.java >> platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/test/java/org/xwiki/rendering/internal/configuration/XWikiRenderingConfigurationTest.java >> platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/test/java/org/xwiki/rendering/internal/wiki/XWikiWikiModelTest.java >> Log: >> XWIKI-5479: Include image dimensions in the image URL for server side image resizing >> >> Modified: platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/configuration/RenderingConfiguration.java >> =================================================================== >> --- platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/configuration/RenderingConfiguration.java 2010-09-11 17:15:46 UTC (rev 31052) >> +++ platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/configuration/RenderingConfiguration.java 2010-09-12 11:30:15 UTC (rev 31053) >> @@ -50,7 +50,7 @@ >> * </ul> >> * Note that if the page title is empty or not defined then it defaults to %p. This is also the case >> * if the title cannot be retrieved for the document. >> - * >> + * >> * The default is "%p". Some examples: "%s.%p", "%w:%s.%p". >> * >> * @return the format to use to display link labels when the user hasn't specified a label >> @@ -63,4 +63,42 @@ >> * descriptor (ie defined by the macro author) will be used >> */ >> Properties getMacroCategories(); >> + >> + /** >> + * @return {@code true} to include the image dimensions extracted from the image parameters in the image URL, >> + * {@code false} otherwise; when image dimensions are included in the image URL the image can be resized >> + * on the server side before being downloaded. >> + * @since 2.5M2 >> + */ >> + boolean isIncludeImageDimensionsInImageURL(); >> + >> + /** >> + * One way to improve page load speed is to resize images on the server side just before rendering the page. The >> + * rendering module can use the image width provided by the user to scale the image. When the user doesn't specify >> + * the image width the rendering module can limit the width of the image based on this configuration parameter. >> + * <p> >> + * The default value is {@code -1} which means image width is not limited by default. Use a value greater than 0 to >> + * limit the image width (pixels). Note that the aspect ratio is kept even when both the width and the height of the >> + * image are limited. >> + * >> + * @return the maximum image width when there's no user supplied width >> + * @see #isIncludeImageDimensionsInImageURL() >> + * @since 2.5M2 >> + */ >> + int getImageWidthLimit(); >> + >> + /** >> + * One way to improve page load speed is to resize images on the server side just before rendering the page. The >> + * rendering module can use the image height provided by the user to scale the image. When the user doesn't specify >> + * the image height the rendering module can limit the height of the image based on this configuration parameter. >> + * <p> >> + * The default value is {@code -1} which means image height is not limited by default. Use a value greater than 0 to >> + * limit the image height (pixels). Note that the aspect ratio is kept even when both the width and the height of >> + * the image are limited. >> + * >> + * @return the maximum image height when there's no user supplied height >> + * @see #isIncludeImageDimensionsInImageURL() >> + * @since 2.5M2 >> + */ >> + int getImageHeightLimit(); >> } This is very wrong. Theses configuration is supposed to be a rendering-xwiki specific thing so it has nothing to do in the standard rendering configuration. >> >> Modified: platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/internal/configuration/DefaultRenderingConfiguration.java >> =================================================================== >> --- platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/internal/configuration/DefaultRenderingConfiguration.java 2010-09-11 17:15:46 UTC (rev 31052) >> +++ platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/internal/configuration/DefaultRenderingConfiguration.java 2010-09-12 11:30:15 UTC (rev 31053) >> @@ -45,6 +45,21 @@ >> private Properties macroCategories = new Properties(); >> >> /** >> + * @see #getImageWidthLimit() >> + */ >> + private int imageWidthLimit = -1; >> + >> + /** >> + * @see #getImageHeightLimit() >> + */ >> + private int imageHeightLimit = -1; >> + >> + /** >> + * @see #isIncludeImageDimensionsInImageURL() >> + */ >> + private boolean includeImageDimensionsInImageURL = true; >> + >> + /** >> * {@inheritDoc} >> * >> * @see org.xwiki.rendering.configuration.RenderingConfiguration#getLinkLabelFormat() >> @@ -84,4 +99,66 @@ >> // to work even without a configuration store. >> this.macroCategories.setProperty(macroId.toString(), category); >> } >> + >> + /** >> + * {@inheritDoc} >> + * >> + * @see org.xwiki.rendering.configuration.RenderingConfiguration#getImageWidthLimit() >> + */ >> + public int getImageWidthLimit() >> + { >> + return this.imageWidthLimit; >> + } >> + >> + /** >> + * @param imageWidthLimit the maximum image width when there's no user supplied width >> + */ >> + public void setImageWidthLimit(int imageWidthLimit) >> + { >> + // This method is useful for those using the XWiki Rendering in standalone mode since it allows the rendering >> + // to work even without a configuration store. >> + this.imageWidthLimit = imageWidthLimit; >> + } >> + >> + /** >> + * {@inheritDoc} >> + * >> + * @see org.xwiki.rendering.configuration.RenderingConfiguration#getImageHeightLimit() >> + */ >> + public int getImageHeightLimit() >> + { >> + return this.imageHeightLimit; >> + } >> + >> + /** >> + * @param imageHeightLimit the maximum image height when there's no user supplied height >> + */ >> + public void setImageHeightLimit(int imageHeightLimit) >> + { >> + // This method is useful for those using the XWiki Rendering in standalone mode since it allows the rendering >> + // to work even without a configuration store. >> + this.imageHeightLimit = imageHeightLimit; >> + } >> + >> + /** >> + * {@inheritDoc} >> + * >> + * @see org.xwiki.rendering.configuration.RenderingConfiguration#isIncludeImageDimensionsInImageURL() >> + */ >> + public boolean isIncludeImageDimensionsInImageURL() >> + { >> + return this.includeImageDimensionsInImageURL; >> + } >> + >> + /** >> + * @param includeImageDimensionsInImageURL {@code true} to include image dimensions extracted from the image >> + * parameters in the image URL so that the image can be resized on the server side before being >> + * downloaded, {@code false} otherwise >> + */ >> + public void setIncludeImageDimensionsInImageURL(boolean includeImageDimensionsInImageURL) >> + { >> + // This method is useful for those using the XWiki Rendering in standalone mode since it allows the rendering >> + // to work even without a configuration store. >> + this.includeImageDimensionsInImageURL = includeImageDimensionsInImageURL; >> + } >> } >> >> Modified: platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/internal/renderer/xhtml/DefaultXHTMLImageRenderer.java >> =================================================================== >> --- platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/internal/renderer/xhtml/DefaultXHTMLImageRenderer.java 2010-09-11 17:15:46 UTC (rev 31052) >> +++ platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/internal/renderer/xhtml/DefaultXHTMLImageRenderer.java 2010-09-12 11:30:15 UTC (rev 31053) >> @@ -42,10 +42,9 @@ >> * Default implementation for rendering images as XHTML. We handle both cases: >> * <ul> >> * <li>when inside a wiki (ie when an implementation of {@link WikiModel} is provided.</li> >> - * <li>when outside of a wiki. In this case we only handle external images and document images don't >> - * display anything.</li> >> + * <li>when outside of a wiki. In this case we only handle external images and document images don't display anything.</li> >> * </ul> >> - * >> + * >> * @version $Id$ >> * @since 2.0M3 >> */ >> @@ -68,6 +67,7 @@ >> >> /** >> * {@inheritDoc} >> + * >> * @see Initializable#initialize() >> */ >> public void initialize() throws InitializationException >> @@ -83,7 +83,7 @@ >> >> /** >> * {@inheritDoc} >> - * >> + * >> * @see XHTMLImageRenderer#setXHTMLWikiPrinter(XHTMLWikiPrinter) >> */ >> public void setXHTMLWikiPrinter(XHTMLWikiPrinter printer) >> @@ -103,7 +103,7 @@ >> >> /** >> * {@inheritDoc} >> - * >> + * >> * @see XHTMLImageRenderer#onImage(Image, boolean, Map) >> */ >> public void onImage(Image image, boolean isFreeStandingURI, Map<String, String> parameters) >> @@ -118,8 +118,9 @@ >> // that would not honor this contract. >> if (this.wikiModel != null) { >> DocumentImage documentImage = DocumentImage.class.cast(image); >> - imageURL = this.wikiModel.getAttachmentURL(documentImage.getDocumentName(), >> - documentImage.getAttachmentName()); >> + imageURL = >> + this.wikiModel.getImageURL(documentImage.getDocumentName(), documentImage.getAttachmentName(), >> + parameters); >> } else { >> throw new RuntimeException("Invalid Image type. In non wiki mode, all image types must be URL images."); >> } >> >> Modified: platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/wiki/WikiModel.java >> =================================================================== >> --- platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/wiki/WikiModel.java 2010-09-11 17:15:46 UTC (rev 31052) >> +++ platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/wiki/WikiModel.java 2010-09-12 11:30:15 UTC (rev 31053) >> @@ -19,13 +19,15 @@ >> */ >> package org.xwiki.rendering.wiki; >> >> +import java.util.Map; >> + >> import org.xwiki.component.annotation.ComponentRole; >> >> /** >> * Bridge between the Rendering module and a Wiki Model. Contains wiki APIs required by Rendering classes such as >> - * Renderers. For example the XHTML Link Renderer needs to know if a wiki document exists in order to know how to >> - * generate the HTML (in order to display a question mark for non existing documents) and it also needs to get the >> - * URL pointing the wiki document. >> + * Renderers. For example the XHTML Link Renderer needs to know if a wiki document exists in order to know how to >> + * generate the HTML (in order to display a question mark for non existing documents) and it also needs to get the URL >> + * pointing the wiki document. >> * >> * @version $Id$ >> * @since 2.0M1 >> @@ -34,36 +36,48 @@ >> public interface WikiModel >> { >> /** >> - * @param documentName the document name of the document containing the attachment. The syntax used depends on >> - * the underlying wiki system used. For example for XWiki a valid documentName would be >> - * {@code wiki:Space.Page} >> + * @param documentName the document name of the document containing the attachment. The syntax used depends on the >> + * underlying wiki system used. For example for XWiki a valid documentName would be >> + * {@code wiki:Space.Page} >> * @param attachmentName the name of the attachment in the passed document wikip page >> * @return the URL to the attachment >> */ >> String getAttachmentURL(String documentName, String attachmentName); >> >> /** >> - * @param documentName the document name as a String. The syntax used depends on >> - * the underlying wiki system used. For example for XWiki a valid documentName would be >> - * {@code wiki:Space.Page} >> + * Generate image specific URL. The difference with {@link #getAttachmentURL(String, String)} is that in some >> + * implementation we want to make a distinction between displayed image and a simple link targeting an attachment >> + * file. >> + * >> + * @param documentName the document name of the document containing the attachment. The syntax used depends on the >> + * underlying wiki system used. For example for XWiki a valid documentName would be >> + * {@code wiki:Space.Page} >> + * @param attachmentName the name of the attachment in the passed document wiki page >> + * @param parameters custom parameters >> + * @return the URL to the image >> + * @since 2.5M2 >> + */ >> + String getImageURL(String documentName, String attachmentName, Map<String, String> parameters); >> + >> + /** >> + * @param documentName the document name as a String. The syntax used depends on the underlying wiki system used. >> + * For example for XWiki a valid documentName would be {@code wiki:Space.Page} >> * @return true if the document exists and can be viewed or false otherwise >> */ >> boolean isDocumentAvailable(String documentName); >> >> /** >> - * @param documentName the document name as a String. The syntax used depends on >> - * the underlying wiki system used. For example for XWiki a valid documentName would be >> - * {@code wiki:Space.Page} >> + * @param documentName the document name as a String. The syntax used depends on the underlying wiki system used. >> + * For example for XWiki a valid documentName would be {@code wiki:Space.Page} >> * @param anchor an anchor pointing to some place inside the document or null >> * @param queryString a query string specifying some parameters or null >> * @return the URL to view the specified wiki document >> */ >> String getDocumentViewURL(String documentName, String anchor, String queryString); >> - >> + >> /** >> - * @param documentName the document name as a String. The syntax used depends on >> - * the underlying wiki system used. For example for XWiki a valid documentName would be >> - * {@code wiki:Space.Page} >> + * @param documentName the document name as a String. The syntax used depends on the underlying wiki system used. >> + * For example for XWiki a valid documentName would be {@code wiki:Space.Page} >> * @param anchor an anchor pointing to some place inside the document or null >> * @param queryString a query string specifying some parameters or null >> * @return the URL to edit the specified wiki document >> >> Modified: platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/pom.xml >> =================================================================== >> --- platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/pom.xml 2010-09-11 17:15:46 UTC (rev 31052) >> +++ platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/pom.xml 2010-09-12 11:30:15 UTC (rev 31053) >> @@ -54,6 +54,12 @@ >> <artifactId>xwiki-core-script</artifactId> >> <version>${pom.version}</version> >> </dependency> >> + <dependency> >> +  >> + <groupId>net.sourceforge.cssparser</groupId> >> + <artifactId>cssparser</artifactId> >> + <version>0.9.5</version> >> + </dependency> >>  >> <dependency> >> <groupId>org.xwiki.platform</groupId> >> >> Modified: platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/main/java/org/xwiki/rendering/internal/configuration/XWikiRenderingConfiguration.java >> =================================================================== >> --- platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/main/java/org/xwiki/rendering/internal/configuration/XWikiRenderingConfiguration.java 2010-09-11 17:15:46 UTC (rev 31052) >> +++ platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/main/java/org/xwiki/rendering/internal/configuration/XWikiRenderingConfiguration.java 2010-09-12 11:30:15 UTC (rev 31053) >> @@ -19,13 +19,13 @@ >> */ >> package org.xwiki.rendering.internal.configuration; >> >> +import java.util.Properties; >> + >> import org.xwiki.component.annotation.Component; >> import org.xwiki.component.annotation.Requirement; >> import org.xwiki.configuration.ConfigurationSource; >> import org.xwiki.rendering.configuration.RenderingConfiguration; >> >> -import java.util.Properties; >> - >> /** >> * All configuration options for the rendering subsystem. >> * >> @@ -46,7 +46,7 @@ >> private static final String DEFAULT_LINK_LABEL_FORMAT = "%p"; >> >> /** >> - * Defines from where to read the rendering configuration data. >> + * Defines from where to read the rendering configuration data. >> */ >> @Requirement >> private ConfigurationSource configuration; >> @@ -58,16 +58,46 @@ >> */ >> public String getLinkLabelFormat() >> { >> - return this.configuration.getProperty(PREFIX + "linkLabelFormat", DEFAULT_LINK_LABEL_FORMAT); >> + return this.configuration.getProperty(PREFIX + "linkLabelFormat", DEFAULT_LINK_LABEL_FORMAT); >> } >> >> /** >> * {@inheritDoc} >> - * >> + * >> * @see org.xwiki.rendering.configuration.RenderingConfiguration#getMacroCategories() >> */ >> public Properties getMacroCategories() >> { >> return this.configuration.getProperty(PREFIX + "macroCategories", Properties.class); >> } >> + >> + /** >> + * {@inheritDoc} >> + * >> + * @see org.xwiki.rendering.configuration.RenderingConfiguration#getImageWidthLimit() >> + */ >> + public int getImageWidthLimit() >> + { >> + return this.configuration.getProperty(PREFIX + "imageWidthLimit", -1); >> + } >> + >> + /** >> + * {@inheritDoc} >> + * >> + * @see org.xwiki.rendering.configuration.RenderingConfiguration#getImageHeightLimit() >> + */ >> + public int getImageHeightLimit() >> + { >> + return this.configuration.getProperty(PREFIX + "imageHeightLimit", -1); >> + } >> + >> + /** >> + * {@inheritDoc} >> + * >> + * @see org.xwiki.rendering.configuration.RenderingConfiguration#isIncludeImageDimensionsInImageURL() >> + */ >> + public boolean isIncludeImageDimensionsInImageURL() >> + { >> + return this.configuration.getProperty(PREFIX + "includeImageDimensionsInImageURL", true); >> + } >> } >> >> Modified: platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/main/java/org/xwiki/rendering/internal/wiki/XWikiWikiModel.java >> =================================================================== >> --- platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/main/java/org/xwiki/rendering/internal/wiki/XWikiWikiModel.java 2010-09-11 17:15:46 UTC (rev 31052) >> +++ platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/main/java/org/xwiki/rendering/internal/wiki/XWikiWikiModel.java 2010-09-12 11:30:15 UTC (rev 31053) >> @@ -19,17 +19,25 @@ >> */ >> package org.xwiki.rendering.internal.wiki; >> >> +import java.io.IOException; >> +import java.io.StringReader; >> import java.io.UnsupportedEncodingException; >> import java.net.URLEncoder; >> +import java.util.Map; >> >> import org.apache.commons.lang.StringUtils; >> +import org.w3c.css.sac.InputSource; >> +import org.w3c.dom.css.CSSStyleDeclaration; >> import org.xwiki.bridge.DocumentAccessBridge; >> -import org.xwiki.model.reference.DocumentReference; >> import org.xwiki.component.annotation.Component; >> import org.xwiki.component.annotation.Requirement; >> +import org.xwiki.model.reference.DocumentReference; >> import org.xwiki.model.reference.EntityReferenceSerializer; >> +import org.xwiki.rendering.configuration.RenderingConfiguration; >> import org.xwiki.rendering.wiki.WikiModel; >> >> +import com.steadystate.css.parser.CSSOMParser; >> + >> /** >> * Implementation using the Document Access Bridge ({@link DocumentAccessBridge}). >> * >> @@ -39,14 +47,47 @@ >> @Component >> public class XWikiWikiModel implements WikiModel >> { >> + /** >> + * The suffix used to mark an amount of pixels. >> + */ >> + private static final String PIXELS = "px"; >> + >> + /** >> + * The name of the {@code width} image parameter. >> + */ >> + private static final String WIDTH = "width"; >> + >> + /** >> + * The name of the {@code height} image parameter. >> + */ >> + private static final String HEIGHT = "height"; >> + >> + /** >> + * The component used to access configuration parameters. >> + */ >> @Requirement >> + private RenderingConfiguration renderingConfiguration; >> + >> + /** >> + * The component used to access the underlying XWiki model. >> + */ >> + @Requirement >> private DocumentAccessBridge documentAccessBridge; >> >> + /** >> + * The component used to serialize entity references to strings. >> + */ >> @Requirement >> private EntityReferenceSerializer<String> entityReferenceSerializer; >> >> /** >> + * The object used to parse the CSS from the image style parameter. >> + */ >> + private final CSSOMParser cssParser = new CSSOMParser(); >> + >> + /** >> * {@inheritDoc} >> + * >> * @see WikiModel#getAttachmentURL(String, String) >> */ >> public String getAttachmentURL(String documentName, String attachmentName) >> @@ -55,7 +96,112 @@ >> } >> >> /** >> + * Extracts the specified image dimension from the image parameters. >> + * >> + * @param dimension either {@code width} or {@code height} >> + * @param imageParameters the image parameters; may include the {@code width}, {@code height} and {@code style} >> + * parameters >> + * @return the value of the passed dimension if it is specified in the image parameters, {@code null} otherwise >> + */ >> + private String getImageDimension(String dimension, Map<String, String> imageParameters) >> + { >> + // Check first if the style parameter contains information about the given dimension. In-line style has priority >> + // over the dimension parameters. >> + String value = null; >> + String style = imageParameters.get("style"); >> + if (StringUtils.isNotBlank(style)) { >> + try { >> + CSSStyleDeclaration sd = cssParser.parseStyleDeclaration(new InputSource(new StringReader(style))); >> + value = sd.getPropertyValue(dimension); >> + } catch (IOException e) { >> + // Ignore the style parameter. >> + } >> + } >> + if (StringUtils.isBlank(value)) { >> + // Fall back on the value of the dimension parameter. >> + value = imageParameters.get(dimension); >> + } >> + return value; >> + } >> + >> + /** >> + * Creates the query string that can be added to an image URL to resize the image on the server side. >> + * >> + * @param imageParameters image parameters, including width and height then they are specified >> + * @return the query string to be added to an image URL in order to resize the image on the server side >> + */ >> + private StringBuilder getImageURLQueryString(Map<String, String> imageParameters) >> + { >> + String width = StringUtils.chomp(getImageDimension(WIDTH, imageParameters), PIXELS); >> + String height = StringUtils.chomp(getImageDimension(HEIGHT, imageParameters), PIXELS); >> + boolean useHeight = StringUtils.isNotEmpty(height) && StringUtils.isNumeric(height); >> + StringBuilder queryString = new StringBuilder(); >> + if (StringUtils.isEmpty(width) || !StringUtils.isNumeric(width)) { >> + // Width is unspecified or is not measured in pixels. >> + if (useHeight) { >> + // Height is specified in pixels. >> + queryString.append('&').append(HEIGHT).append('=').append(height); >> + } else { >> + // If image width and height are unspecified or if they are not expressed in pixels then limit the image >> + // size to best fit the rectangle specified in the configuration (keeping aspect ratio). >> + int widthLimit = renderingConfiguration.getImageWidthLimit(); >> + if (widthLimit > 0) { >> + queryString.append('&').append(WIDTH).append('=').append(widthLimit); >> + } >> + int heightLimit = renderingConfiguration.getImageHeightLimit(); >> + if (heightLimit > 0) { >> + queryString.append('&').append(HEIGHT).append('=').append(heightLimit); >> + } >> + if (widthLimit > 0 && heightLimit > 0) { >> + queryString.append("&keepAspectRatio=").append(true); >> + } >> + } >> + } else { >> + // Width is specified in pixels. >> + queryString.append('&').append(WIDTH).append('=').append(width); >> + if (useHeight) { >> + // Height is specified in pixels. >> + queryString.append('&').append(HEIGHT).append('=').append(height); >> + } >> + } >> + return queryString; >> + } >> + >> + /** >> * {@inheritDoc} >> + * >> + * @see org.xwiki.rendering.wiki.WikiModel#getImageURL(java.lang.String, java.lang.String, java.util.Map) >> + */ >> + public String getImageURL(String documentName, String attachmentName, Map<String, String> parameters) >> + { >> + String url = getAttachmentURL(documentName, attachmentName); >> + if (!renderingConfiguration.isIncludeImageDimensionsInImageURL()) { >> + return url; >> + } >> + >> + StringBuilder queryString = getImageURLQueryString(parameters); >> + if (queryString.length() == 0) { >> + return url; >> + } >> + >> + // Determine the insertion point. >> + int insertionPoint = url.lastIndexOf('#'); >> + if (insertionPoint < 0) { >> + // No fragment identifier. >> + insertionPoint = url.length(); >> + } >> + if (url.lastIndexOf('?', insertionPoint) < 0) { >> + // No query string. >> + queryString.setCharAt(0, '?'); >> + } >> + >> + // Insert the query string. >> + return new StringBuilder(url).insert(insertionPoint, queryString).toString(); >> + } >> + >> + /** >> + * {@inheritDoc} >> + * >> * @see WikiModel#isDocumentAvailable(String) >> */ >> public boolean isDocumentAvailable(String documentName) >> @@ -65,6 +211,7 @@ >> >> /** >> * {@inheritDoc} >> + * >> * @see WikiModel#getDocumentViewURL(String, String, String) >> */ >> public String getDocumentViewURL(String documentName, String anchor, String queryString) >> @@ -74,6 +221,7 @@ >> >> /** >> * {@inheritDoc} >> + * >> * @see WikiModel#getDocumentEditURL(String, String, String) >> */ >> public String getDocumentEditURL(String documentName, String anchor, String queryString) >> @@ -89,17 +237,17 @@ >> // See http://www.w3.org/TR/html40/appendix/notes.html#non-ascii-chars >> // TODO: Once the xwiki-url module is usable, refactor this code to use it and remove the need to >> // perform explicit encoding here. >> - modifiedQueryString = >> + modifiedQueryString = >> "parent=" + URLEncoder.encode(this.entityReferenceSerializer.serialize(reference), "UTF-8"); >> } catch (UnsupportedEncodingException e) { >> // Not supporting UTF-8 as a valid encoding for some reasons. We consider XWiki cannot work >> // without that encoding. >> - throw new RuntimeException("Failed to URL encode [" + this.entityReferenceSerializer.serialize( >> - reference) + "] using UTF-8.", e); >> + throw new RuntimeException("Failed to URL encode [" >> + + this.entityReferenceSerializer.serialize(reference) + "] using UTF-8.", e); >> } >> } >> } >> - >> + >> return this.documentAccessBridge.getURL(documentName, "create", modifiedQueryString, anchor); >> } >> } >> >> Modified: platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/test/java/org/xwiki/rendering/internal/configuration/XWikiRenderingConfigurationTest.java >> =================================================================== >> --- platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/test/java/org/xwiki/rendering/internal/configuration/XWikiRenderingConfigurationTest.java 2010-09-11 17:15:46 UTC (rev 31052) >> +++ platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/test/java/org/xwiki/rendering/internal/configuration/XWikiRenderingConfigurationTest.java 2010-09-12 11:30:15 UTC (rev 31053) >> @@ -22,9 +22,9 @@ >> import java.util.Properties; >> >> import org.jmock.Expectations; >> -import org.xwiki.configuration.ConfigurationSource; >> import org.junit.Assert; >> import org.junit.Test; >> +import org.xwiki.configuration.ConfigurationSource; >> import org.xwiki.test.AbstractMockingComponentTestCase; >> import org.xwiki.test.annotation.MockingRequirement; >> >> @@ -43,10 +43,13 @@ >> public void testGetLinkLabelFormat() throws Exception >> { >> final ConfigurationSource source = getComponentManager().lookup(ConfigurationSource.class); >> - getMockery().checking(new Expectations() {{ >> - allowing(source).getProperty("rendering.linkLabelFormat", "%p"); >> + getMockery().checking(new Expectations() >> + { >> + { >> + allowing(source).getProperty("rendering.linkLabelFormat", "%p"); >> will(returnValue("%p")); >> - }}); >> + } >> + }); >> >> Assert.assertEquals("%p", this.configuration.getLinkLabelFormat()); >> } >> @@ -55,12 +58,60 @@ >> public void testGetMacroCategories() throws Exception >> { >> final ConfigurationSource source = getComponentManager().lookup(ConfigurationSource.class); >> - getMockery().checking(new Expectations() {{ >> - allowing(source).getProperty("rendering.macroCategories", Properties.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + allowing(source).getProperty("rendering.macroCategories", Properties.class); >> will(returnValue(new Properties())); >> - }}); >> + } >> + }); >> >> Assert.assertNotNull(this.configuration.getMacroCategories()); >> Assert.assertEquals(0, this.configuration.getMacroCategories().size()); >> } >> + >> + @Test >> + public void testGetImageWidthLimit() throws Exception >> + { >> + final ConfigurationSource source = getComponentManager().lookup(ConfigurationSource.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + allowing(source).getProperty("rendering.imageWidthLimit", -1); >> + will(returnValue(100)); >> + } >> + }); >> + >> + Assert.assertEquals(100, this.configuration.getImageWidthLimit()); >> + } >> + >> + @Test >> + public void testGetImageHeightLimit() throws Exception >> + { >> + final ConfigurationSource source = getComponentManager().lookup(ConfigurationSource.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + allowing(source).getProperty("rendering.imageHeightLimit", -1); >> + will(returnValue(150)); >> + } >> + }); >> + >> + Assert.assertEquals(150, this.configuration.getImageHeightLimit()); >> + } >> + >> + @Test >> + public void testIsIncludeImageDimensionsInImageURL() throws Exception >> + { >> + final ConfigurationSource source = getComponentManager().lookup(ConfigurationSource.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + allowing(source).getProperty("rendering.includeImageDimensionsInImageURL", true); >> + will(returnValue(false)); >> + } >> + }); >> + >> + Assert.assertFalse(this.configuration.isIncludeImageDimensionsInImageURL()); >> + } >> } >> >> Modified: platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/test/java/org/xwiki/rendering/internal/wiki/XWikiWikiModelTest.java >> =================================================================== >> --- platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/test/java/org/xwiki/rendering/internal/wiki/XWikiWikiModelTest.java 2010-09-11 17:15:46 UTC (rev 31052) >> +++ platform/core/trunk/xwiki-rendering/xwiki-rendering-xwiki/src/test/java/org/xwiki/rendering/internal/wiki/XWikiWikiModelTest.java 2010-09-12 11:30:15 UTC (rev 31053) >> @@ -19,12 +19,20 @@ >> */ >> package org.xwiki.rendering.internal.wiki; >> >> +import java.util.Collections; >> +import java.util.HashMap; >> +import java.util.Map; >> + >> +import junit.framework.Assert; >> + >> import org.jmock.Expectations; >> -import org.jmock.Mockery; >> +import org.junit.Test; >> import org.xwiki.bridge.DocumentAccessBridge; >> import org.xwiki.model.reference.DocumentReference; >> -import org.xwiki.component.util.ReflectionUtils; >> import org.xwiki.model.reference.EntityReferenceSerializer; >> +import org.xwiki.rendering.configuration.RenderingConfiguration; >> +import org.xwiki.test.AbstractMockingComponentTestCase; >> +import org.xwiki.test.annotation.MockingRequirement; >> >> /** >> * Unit tests for {@link XWikiWikiModel}. >> @@ -32,31 +40,321 @@ >> * @version $Id$ >> * @since 2.0M1 >> */ >> -public class XWikiWikiModelTest >> +public class XWikiWikiModelTest extends AbstractMockingComponentTestCase >> { >> - @org.junit.Test >> + @MockingRequirement >> + private XWikiWikiModel wikiModel; >> + >> + @Test >> public void testGetDocumentEditURLWhenNoQueryStringSpecified() throws Exception >> { >> - Mockery mockery = new Mockery(); >> - XWikiWikiModel wikiModel = new XWikiWikiModel(); >> + final EntityReferenceSerializer< ? > entityReferenceSerializer = >> + getComponentManager().lookup(EntityReferenceSerializer.class); >> + final DocumentAccessBridge documentAccessBridge = getComponentManager().lookup(DocumentAccessBridge.class); >> + final DocumentReference documentReference = new DocumentReference("wiki", "Space", "Page"); >> + getMockery().checking(new Expectations() >> + { >> + { >> + oneOf(documentAccessBridge).getCurrentDocumentReference(); >> + will(returnValue(documentReference)); >> + oneOf(entityReferenceSerializer).serialize(documentReference); >> + will(returnValue("wiki:Space.Page\u20AC")); >> >> - final EntityReferenceSerializer mockEntityReferenceSerializer = mockery.mock(EntityReferenceSerializer.class); >> - ReflectionUtils.setFieldValue(wikiModel, "entityReferenceSerializer", mockEntityReferenceSerializer); >> + // The test is here: we verify that getURL is called with the query string already encoded since >> + // getURL() doesn't encode it. >> + oneOf(documentAccessBridge).getURL("Space.Page\u20AC", "create", "parent=wiki%3ASpace.Page%E2%82%AC", >> + "anchor"); >> + } >> + }); >> >> - final DocumentAccessBridge mockDocumentAccessBridge = mockery.mock(DocumentAccessBridge.class); >> - ReflectionUtils.setFieldValue(wikiModel, "documentAccessBridge", mockDocumentAccessBridge); >> + wikiModel.getDocumentEditURL("Space.Page\u20AC", "anchor", null); >> + } >> >> - final DocumentReference docReference = new DocumentReference("wiki", "Space", "Page"); >> - mockery.checking(new Expectations() {{ >> - oneOf(mockDocumentAccessBridge).getCurrentDocumentReference(); will(returnValue(docReference)); >> - oneOf(mockEntityReferenceSerializer).serialize(docReference); will(returnValue("wiki:Space.Page\u20AC")); >> + /** >> + * Tests that the proper image URL is generated when both the width and the height image parameters are specified. >> + * >> + * @throws Exception if an exception occurs while running the test >> + */ >> + @Test >> + public void testGetImageURLWhenBothWidthAndHeightAttributesAreSpecified() throws Exception >> + { >> + final DocumentAccessBridge documentAccessBridge = getComponentManager().lookup(DocumentAccessBridge.class); >> + final RenderingConfiguration configuration = getComponentManager().lookup(RenderingConfiguration.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + oneOf(documentAccessBridge).getAttachmentURL("", ""); >> + will(returnValue("")); >> + oneOf(configuration).isIncludeImageDimensionsInImageURL(); >> + will(returnValue(true)); >> + } >> + }); >> + Map<String, String> parameters = new HashMap<String, String>(); >> + parameters.put("width", "100px"); >> + parameters.put("height", "50"); >> + Assert.assertEquals("?width=100&height=50", wikiModel.getImageURL("", "", parameters)); >> + } >> >> - // The test is here: we verify that getURL is called with the query string already encoded since getURL() >> - // doesn't encode it. >> - oneOf(mockDocumentAccessBridge).getURL("Space.Page\u20AC", "create", "parent=wiki%3ASpace.Page%E2%82%AC", >> - "anchor"); >> - }}); >> + /** >> + * Tests that the proper image URL is generated when both the width and the height image parameters are specified >> + * but including them in the image URL is forbidden from the rendering configuration. >> + * >> + * @throws Exception if an exception occurs while running the test >> + */ >> + @Test >> + public void testGetImageURLWhenIncludingImageDimensionsIsForbidden() throws Exception >> + { >> + final DocumentAccessBridge documentAccessBridge = getComponentManager().lookup(DocumentAccessBridge.class); >> + final RenderingConfiguration configuration = getComponentManager().lookup(RenderingConfiguration.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + oneOf(documentAccessBridge).getAttachmentURL("", ""); >> + will(returnValue("")); >> + oneOf(configuration).isIncludeImageDimensionsInImageURL(); >> + will(returnValue(false)); >> + } >> + }); >> + Map<String, String> parameters = new HashMap<String, String>(); >> + parameters.put("width", "101px"); >> + parameters.put("height", "55px"); >> + Assert.assertEquals("", wikiModel.getImageURL("", "", parameters)); >> + } >> >> - wikiModel.getDocumentEditURL("Space.Page\u20AC", "anchor", null); >> + /** >> + * Tests that the proper image URL is generated when both the width and the height CSS properties are specified. >> + * >> + * @throws Exception if an exception occurs while running the test >> + */ >> + @Test >> + public void testGetImageURLWhenBothWidthAndHeightCSSPropertiesAreSpecified() throws Exception >> + { >> + final DocumentAccessBridge documentAccessBridge = getComponentManager().lookup(DocumentAccessBridge.class); >> + final RenderingConfiguration configuration = getComponentManager().lookup(RenderingConfiguration.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + oneOf(documentAccessBridge).getAttachmentURL("", ""); >> + will(returnValue("")); >> + oneOf(configuration).isIncludeImageDimensionsInImageURL(); >> + will(returnValue(true)); >> + } >> + }); >> + Map<String, String> parameters = new HashMap<String, String>(); >> + parameters.put("style", "border: 1px; height: 30px; margin-top: 2em; width: 70px"); >> + Assert.assertEquals("?width=70&height=30", wikiModel.getImageURL("", "", parameters)); >> } >> + >> + /** >> + * Tests that the proper image URL is generated when only the width image parameter is specified. >> + * >> + * @throws Exception if an exception occurs while running the test >> + */ >> + @Test >> + public void testGetImageURLWhenOnlyWidthAttributeIsSpecified() throws Exception >> + { >> + final DocumentAccessBridge documentAccessBridge = getComponentManager().lookup(DocumentAccessBridge.class); >> + final RenderingConfiguration configuration = getComponentManager().lookup(RenderingConfiguration.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + oneOf(documentAccessBridge).getAttachmentURL("", ""); >> + will(returnValue("")); >> + oneOf(configuration).isIncludeImageDimensionsInImageURL(); >> + will(returnValue(true)); >> + } >> + }); >> + Map<String, String> parameters = new HashMap<String, String>(); >> + parameters.put("width", "150"); >> + parameters.put("height", "30%"); >> + Assert.assertEquals("?width=150", wikiModel.getImageURL("", "", parameters)); >> + } >> + >> + /** >> + * Tests that the proper image URL is generated when only the height CSS property is specified. >> + * >> + * @throws Exception if an exception occurs while running the test >> + */ >> + @Test >> + public void testGetImageURLWhenOnlyHeightCSSPropertyIsSpecified() throws Exception >> + { >> + final DocumentAccessBridge documentAccessBridge = getComponentManager().lookup(DocumentAccessBridge.class); >> + final RenderingConfiguration configuration = getComponentManager().lookup(RenderingConfiguration.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + oneOf(documentAccessBridge).getAttachmentURL("", ""); >> + will(returnValue("")); >> + oneOf(configuration).isIncludeImageDimensionsInImageURL(); >> + will(returnValue(true)); >> + } >> + }); >> + Map<String, String> parameters = new HashMap<String, String>(); >> + parameters.put("style", "width: 5cm; height: 80px"); >> + Assert.assertEquals("?height=80", wikiModel.getImageURL("", "", parameters)); >> + } >> + >> + /** >> + * Tests that the proper image URL is generated when both the width and the height are unspecified and image size is >> + * limited in the configuration. >> + * >> + * @throws Exception if an exception occurs while running the test >> + */ >> + @Test >> + public void testGetImageURLWhenBothWidthAndHeightAreUnspecifiedAndImageSizeIsLimited() throws Exception >> + { >> + final DocumentAccessBridge documentAccessBridge = getComponentManager().lookup(DocumentAccessBridge.class); >> + final RenderingConfiguration configuration = getComponentManager().lookup(RenderingConfiguration.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + oneOf(documentAccessBridge).getAttachmentURL("", ""); >> + will(returnValue("")); >> + oneOf(configuration).isIncludeImageDimensionsInImageURL(); >> + will(returnValue(true)); >> + oneOf(configuration).getImageWidthLimit(); >> + will(returnValue(200)); >> + oneOf(configuration).getImageHeightLimit(); >> + will(returnValue(170)); >> + } >> + }); >> + Map<String, String> parameters = Collections.emptyMap(); >> + Assert.assertEquals("?width=200&height=170&keepAspectRatio=true", wikiModel.getImageURL("", "", parameters)); >> + } >> + >> + /** >> + * Tests that the proper image URL is generated when both the width and the height are unspecified and only the >> + * image width is limited in the configuration. >> + * >> + * @throws Exception if an exception occurs while running the test >> + */ >> + @Test >> + public void testGetImageURLWhenBothWidthAndHeightAreUnspecifiedAndOnlyImageWidthIsLimited() throws Exception >> + { >> + final DocumentAccessBridge documentAccessBridge = getComponentManager().lookup(DocumentAccessBridge.class); >> + final RenderingConfiguration configuration = getComponentManager().lookup(RenderingConfiguration.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + oneOf(documentAccessBridge).getAttachmentURL("", ""); >> + will(returnValue("")); >> + oneOf(configuration).isIncludeImageDimensionsInImageURL(); >> + will(returnValue(true)); >> + oneOf(configuration).getImageWidthLimit(); >> + will(returnValue(25)); >> + oneOf(configuration).getImageHeightLimit(); >> + will(returnValue(-1)); >> + } >> + }); >> + Map<String, String> parameters = new HashMap<String, String>(); >> + parameters.put("width", "45%"); >> + parameters.put("style", "height:10em"); >> + Assert.assertEquals("?width=25", wikiModel.getImageURL("", "", parameters)); >> + } >> + >> + /** >> + * Tests that the proper image URL is generated when both the width and the height are unspecified and the image >> + * size is not limited in the configuration. >> + * >> + * @throws Exception if an exception occurs while running the test >> + */ >> + @Test >> + public void testGetImageURLWhenBothWidthAndHeightAreUnspecifiedAndImageSizeIsNotLimited() throws Exception >> + { >> + final DocumentAccessBridge documentAccessBridge = getComponentManager().lookup(DocumentAccessBridge.class); >> + final RenderingConfiguration configuration = getComponentManager().lookup(RenderingConfiguration.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + oneOf(documentAccessBridge).getAttachmentURL("", ""); >> + will(returnValue("")); >> + oneOf(configuration).isIncludeImageDimensionsInImageURL(); >> + will(returnValue(true)); >> + oneOf(configuration).getImageWidthLimit(); >> + will(returnValue(-1)); >> + oneOf(configuration).getImageHeightLimit(); >> + will(returnValue(-1)); >> + } >> + }); >> + Map<String, String> parameters = new HashMap<String, String>(); >> + parameters.put("style", "bad CSS declaration"); >> + Assert.assertEquals("", wikiModel.getImageURL("", "", parameters)); >> + } >> + >> + /** >> + * Tests that the proper image URL is generated when the attachment URL has a fragment identifier. >> + * >> + * @throws Exception if an exception occurs while running the test >> + */ >> + @Test >> + public void testGetImageURLWhenAttachmentURLHasFragmentIdentifier() throws Exception >> + { >> + final DocumentAccessBridge documentAccessBridge = getComponentManager().lookup(DocumentAccessBridge.class); >> + final RenderingConfiguration configuration = getComponentManager().lookup(RenderingConfiguration.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + oneOf(documentAccessBridge).getAttachmentURL("", ""); >> + will(returnValue("test#fragment")); >> + oneOf(configuration).isIncludeImageDimensionsInImageURL(); >> + will(returnValue(true)); >> + } >> + }); >> + Map<String, String> parameters = new HashMap<String, String>(); >> + parameters.put("width", "23"); >> + Assert.assertEquals("test?width=23#fragment", wikiModel.getImageURL("", "", parameters)); >> + } >> + >> + /** >> + * Tests that the proper image URL is generated when the attachment URL has a query string and a fragment >> + * identifier. >> + * >> + * @throws Exception if an exception occurs while running the test >> + */ >> + @Test >> + public void testGetImageURLWhenAttachmentURLHasQueryStringAndFragmentIdentifier() throws Exception >> + { >> + final DocumentAccessBridge documentAccessBridge = getComponentManager().lookup(DocumentAccessBridge.class); >> + final RenderingConfiguration configuration = getComponentManager().lookup(RenderingConfiguration.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + oneOf(documentAccessBridge).getAttachmentURL("", ""); >> + will(returnValue("test?param=value#fragment")); >> + oneOf(configuration).isIncludeImageDimensionsInImageURL(); >> + will(returnValue(true)); >> + } >> + }); >> + Map<String, String> parameters = new HashMap<String, String>(); >> + parameters.put("height", "17"); >> + Assert.assertEquals("test?param=value&height=17#fragment", wikiModel.getImageURL("", "", parameters)); >> + } >> + >> + /** >> + * Tests that the proper image URL is generated when both the style and the dimension parameters are specified. >> + * >> + * @throws Exception if an exception occurs while running the test >> + */ >> + @Test >> + public void testGetImageURLWhenBothStyleAndDimensionParametersAreSpecified() throws Exception >> + { >> + final DocumentAccessBridge documentAccessBridge = getComponentManager().lookup(DocumentAccessBridge.class); >> + final RenderingConfiguration configuration = getComponentManager().lookup(RenderingConfiguration.class); >> + getMockery().checking(new Expectations() >> + { >> + { >> + oneOf(documentAccessBridge).getAttachmentURL("", ""); >> + will(returnValue("")); >> + oneOf(configuration).isIncludeImageDimensionsInImageURL(); >> + will(returnValue(true)); >> + } >> + }); >> + Map<String, String> parameters = new HashMap<String, String>(); >> + parameters.put("height", "46"); >> + parameters.put("width", "101px"); >> + parameters.put("style", "width: 20%; height:75px"); >> + // Note that the style parameter take precedence over the dimension parameters and the width is actually 20% but >> + // we can't use it for resizing the image on the server side so it's omitted from the query string. >> + Assert.assertEquals("?height=75", wikiModel.getImageURL("", "", parameters)); >> + } >> } > > _______________________________________________ > devs mailing list > devs(a)xwiki.org > http://lists.xwiki.org/mailman/listinfo/devs > -- Thomas Mortagne

1 0

[xwiki-devs] Help--Issue building JspWikiImporter Class
by Jins Jacob 09 Sep '10

09 Sep '10

Hi All, I am trying to convert JSPwiki pages to Xwiki pages.For that i used the code which is in the link http://code.xwiki.org/xwiki/bin/view/Extensions/JSPWikiToXWikiExtension .All the needed jar files had been added to the classpath and try to build this java class.Then it showed the following error Starting up background thread: JSPWiki Lucene Indexer. Starting up background thread: WatchDog for 'Wiki'. com.ecyrd.jspwiki.InternalWikiException: java.io.IOException: Unable to find web.xml for processing. at com.ecyrd.jspwiki.auth.authorize.WebContainerAuthorizer.initialize(WebContainerAuthorizer.java:127) at com.ecyrd.jspwiki.auth.AuthorizationManager.initialize(AuthorizationManager.java:404) at com.ecyrd.jspwiki.WikiEngine.initialize(WikiEngine.java:559) at com.ecyrd.jspwiki.WikiEngine.<init>(WikiEngine.java:369) at JspWikiImporter.export(JspWikiImporter.java:76) at JspWikiImporter.main(JspWikiImporter.java:50) com.ecyrd.jspwiki.WikiException: Failed to start managers: java.io.IOException: Unable to find web.xml for processing. at com.ecyrd.jspwiki.WikiEngine.initialize(WikiEngine.java:610) at com.ecyrd.jspwiki.WikiEngine.<init>(WikiEngine.java:369) at JspWikiImporter.export(JspWikiImporter.java:76) at JspWikiImporter.main(JspWikiImporter.java:50) Caused by: com.ecyrd.jspwiki.InternalWikiException: java.io.IOException: Unable to find web.xml for processing. at com.ecyrd.jspwiki.auth.authorize.WebContainerAuthorizer.initialize(WebContainerAuthorizer.java:127) at com.ecyrd.jspwiki.auth.AuthorizationManager.initialize(AuthorizationManager.java:404) at com.ecyrd.jspwiki.WikiEngine.initialize(WikiEngine.java:559) ... 3 more I added a dummy web.xml in WEB-INF directory.But the same issue occurs.What is to be done to rectify this issue and what are the essential components that are needed in the said web.xml? Please help me. If anybody have any idea please let me know. Thanks, Jins Jacob

1 0

[xwiki-devs] [proposal] Develop form, field, and validation constraint classes and abandon the practice of storing form information in the class.
by Caleb James DeLisle 08 Sep '10

08 Sep '10

Hi, I would like to propose a change in direction. I think the practice of marrying form fields to class properties should be discontinued. Including form information in the class property makes certain jobs easier but XObjects do not always represent forms and marrying something as high level as forms with something as low level as objects makes code maintenance exceedingly difficult, not to mention the general ugliness of code in xwiki-core which generates HTML. I would like to start development of 3 new XWikiDocuments: XWiki.FormClass, XWiki.FormFieldClass and XWiki.FormFieldConstraintClass. Much of the code in XWiki.Registration will be ported to these classes. The fields will be validated twice, once at the client side with LiveValidation, and once at the server side. I would then like to deprecate the use of the display related settings in the class editor and eventually remove them from the class editor entirely. I envision a form being made and fields added similar to the way we add objects to a document. Likewise, each field will be defined by selecting a display type from a predefined list then adding validation constraint objects to the field. I have not started development on this and I am sure there will be plenty more to discuss later. What I want to know is whether people think this is the right direction. WDYT? Caleb

4 4

[xwiki-devs] Issue building JspWikiImporter Class
by Jins Jacob 08 Sep '10

08 Sep '10

Hi All, I am trying to convert JSPwiki pages to Xwiki pages.For that i used the code which is in the link http://code.xwiki.org/xwiki/bin/view/Extensions/JSPWikiToXWikiExtension.All the needed jar files had been added to the classpath and try to build this java class.Then it showed the following error * * * Starting up background thread: JSPWiki Lucene Indexer. Starting up background thread: WatchDog for 'Wiki'. com.ecyrd.jspwiki.InternalWikiException: java.io.IOException: Unable to find web.xml for processing. at com.ecyrd.jspwiki.auth.authorize.WebContainerAuthorizer.initialize(WebContainerAuthorizer.java:127) at com.ecyrd.jspwiki.auth.AuthorizationManager.initialize(AuthorizationManager.java:404) at com.ecyrd.jspwiki.WikiEngine.initialize(WikiEngine.java:559) at com.ecyrd.jspwiki.WikiEngine.<init>(WikiEngine.java:369) at JspWikiImporter.export(JspWikiImporter.java:76) at JspWikiImporter.main(JspWikiImporter.java:50) com.ecyrd.jspwiki.WikiException: Failed to start managers: java.io.IOException: Unable to find web.xml for processing. at com.ecyrd.jspwiki.WikiEngine.initialize(WikiEngine.java:610) at com.ecyrd.jspwiki.WikiEngine.<init>(WikiEngine.java:369) at JspWikiImporter.export(JspWikiImporter.java:76) at JspWikiImporter.main(JspWikiImporter.java:50) Caused by: com.ecyrd.jspwiki.InternalWikiException: java.io.IOException: Unable to find web.xml for processing. at com.ecyrd.jspwiki.auth.authorize.WebContainerAuthorizer.initialize(WebContainerAuthorizer.java:127) at com.ecyrd.jspwiki.auth.AuthorizationManager.initialize(AuthorizationManager.java:404) at com.ecyrd.jspwiki.WikiEngine.initialize(WikiEngine.java:559) ... 3 more* ** I added a dummy web.xml in WEB-INF directory.But the same issue occurs.What is to be done to rectify this issue and what are the essential components that are needed in the said web.xml? Please help me. Thanks, Jins Jacob

1 0

Re: [xwiki-devs] [Proposal][UX] Recent Changes Improvements
by Jerome Velociter 08 Sep '10

08 Sep '10

----- "Fabio Mancinelli" <fabio.mancinelli(a)xwiki.com> wrote: > On 08/30/2010 05:46 PM, Ecaterina Valica wrote: > > Hi Fabio, > > > > This means I am iterating and I gather feedback and depending on > that > > feedback we must agree on a version. > > > Ok. I thought that "old" meant "superseded by" :) > > > On a wiki platform, what do you think is more relevant: the user or > page > > centric approach? > > What are the things that make this version (the page centric one) > not to fit > > the Wiki 3.0 specification? > > > What is missing basically boils down to the "Share your thoughts" box Yes, user updates should be mixed in the stream ultimately, I think. > > and the type of information we can convey with it. > > The "user centric" view, imho, is also useful because a "user" could > also be an application that sends events (e.g., meeting or deadlines > reminders, etc.) that can be shown in a more natural way in a user > centric view. Basically even applications might share their thoughts > through the activity stream ;) I completely agree with the last sentence. BUT I think it's not incompatible with a document/user mixed-approched (I don't think either full document-centric or full user-centric can embrace the versatility of XWiki) I see two types of entries : * Document updates. Basically what is currently in latest proposal (though I would add little user pictures here as well, even before the click). This is KM, collaboration, etc. * Users/applications updates. Those are less structured, more a-la facebook. I see something like http://incubator.myxwiki.org/xwiki/bin/view/Improvements/ActivityStreamMixed (raw picture, would have to be refined) (Note I also have right-padded a bit more the comment/annotation/pencil/etc icons that are on top of user photos, I think they were a bit too masked by them) Jerome. > > > Jerome missed the avatars, so if you did too, please try to expand > the items > > in the prototype (when you hover the items an arrow appears in the > right > > part suggesting that the item can be expanded ). > > > Yes I missed them too, but then I saw it. > Still the previously mentioned types of information are not available > > anymore. > > Thanks, > Fabio > _______________________________________________ > devs mailing list > devs(a)xwiki.org > http://lists.xwiki.org/mailman/listinfo/devs

5 11

[xwiki-devs] [proposal] Stop saving documents in the cache when they are stored in the database.
by Caleb James DeLisle 08 Sep '10

08 Sep '10

Hi, There are 2 reasons I want to stop caching documents when they are stored. 1. Coherence, it should be impossible for the cache to have a different entry than the store. Suppose a document is stored and the storage fails without throwing any error, the document will appear to be stored correctly until the cache is purged. Another more likely scenario is that the document loaded from the store is slightly different than the document saved to the store and thus the cache will be lying. 2. Performance, when an attachment is added to a document, the document contains all of the attachment's content. My analysis tells me switching to holding the content with a soft reference would be quite complex and proving that nothing depends on the attachment content not being null is very difficult. The proposed change will prevent the attachment content from ever being stored in the cache and provide an improvement in allowable cache capacity and memory footprint. WDYT? Caleb

3 3

[xwiki-devs] [Proposal] Start introducing XWiki Syntax 2.1 (experimental)
by Vincent Massol 07 Sep '10

07 Sep '10

Hi everyone, In the rendering module we need to progress on some issues. For example I'd like to implement support for relative URLs: http://jira.xwiki.org/jira/browse/XWIKI-3611 This means introducing XWiki Syntax 2.1 which will a point release after XWiki Syntax 2.0. Of course any page in XWiki Syntax 2.0 will be able to be converted in 2.1 syntax. FTM we haven't fully defined yet the full list of changes in XWiki Syntax 2.1. The idea is to introduce in 2.5 an experimental XWiki Syntax 2.1 syntax to show it's not finished yet (in the UI the syntax name will be "XWiki Syntax 2.1 (experimental)") and start introducing changes, the first one being support for relative URLs. WDYT? Thanks -Vincent

6 7

[xwiki-devs] XEM, Workspaces and Wiki3.0
by Fabio Mancinelli 07 Sep '10

07 Sep '10

Hi everybody, I am writing to the list in order to discuss an architectural choice which I had the chance to talk about with Vincent. In the framework of the Wiki3.0 [1] projects we are building a social extension of XWiki that will introduce social-oriented functionalities in the platform. One of these functionalities are related to "Workspaces" which have been defined as a "virtual place where a group of users can collaborate on a given topic. A workspace implicitly defines a social-network which consists of the users that participate to the activities in the context of a given workspace." A workspace, besides having a set of users subscribed to it, has also a set of applications that are related to the type of the interactions that are carried in the workspace itself (e.g., a blog, a meeting manager, etc.) This is the abstract picture. At the architectural level this could be implemented in different ways. What we briefly discussed with Vincent is that workspaces could be easily handled by using XEM. In this case, instead of having a mapping Workspace <-> space in a single Wiki we would have a Workspace <-> wiki in a multiwiki setup managed by XEM. This has several advantages since the current features can be already leveraged and extended in order to implement workspace functionalities: 1) existing applications are already ready-to-deploy 2) rights management is already enough to manage subscriptions 3) being a workspace a full wiki this gives the users more flexibility (e.g., they are not constrained to a single space for organizing their content) In this picture the main wiki could be used only as a "user container" and will have all the functionalities (UI + code) to manage workspaces' lifecycle (i.e., creation, deletion). Additional functionalities will the be present in the workspace wiki for actually managing the workspace (i.e., adding/removing members, subscription management for open workspaces, workspace attributes management and so on). Initially I haven't thought about workspaces as wikis in a XEM context by the idea is very powerful and I think we should build it in this way. WDYT? Thanks, -Fabio [1] https://wiki30.xwikisas.com

5 6

[xwiki-devs] [proposal] Remove the old rights UI
by Alex Busenius 06 Sep '10

06 Sep '10

Hi devs, I propose to remove the old rights interface (called "stable"). This interface was replaced by the current version (the one with livetable) in XWiki 1.2 several years ago, but the old code is still there. The following files are affected: web/standard/**/templates/rightsUI.vm applications/administration/**/XWiki/AdminGroupsSheet.xml applications/administration/**/XWiki/AdminUsersSheet.xml applications/administration/**/XWiki/XWikiGroupSheet.xml applications/panels/**/Panels/GlobalRightsEditorWelcome.xml applications/panels/**/Panels/RightsEditorWelcome.xml core/xwiki-core/**/plugin/rightsmanager/RightsManagerPluginApi.java The Java file contains the method getDefaultUi() to read the xwiki.rights.defaultui configuration property, the rest has parts of the interface. WDYT? Alex

8 7