/*
JSPWiki - a JSP-based WikiWiki clone.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/
package com.ecyrd.jspwiki.plugin;
import java.util.*;
import com.ecyrd.jspwiki.*;
import com.ecyrd.jspwiki.attachment.AttachmentManager;
import com.ecyrd.jspwiki.attachment.Attachment;
import com.ecyrd.jspwiki.providers.ProviderException;
/**
* Provides an image plugin for better control than is possible with a simple image inclusion.
* <br> Most parameters are equivalents of the html image attributes.
*
* <p>Parameters : </p>
* <ul>
* <li><b>src</b> - the source (a URL) of the image (required parameter)</li>
* <li><b>align</b> - the alignment of the image</li>
* <li><b>height</b> - the height of the image</li>
* <li><b>width</b> - the width of the image</li>
* <li><b>alt</b> - alternate text</li>
* <li><b>caption</b> - the caption for the image</li>
* <li><b>link</b> - the hyperlink for the image</li>
* <li><b>target</b> - the target (frame) to be used for opening the image</li>
* <li><b>style</b> - the style attribute of the image</li>
* <li><b>class</b> - the associated class for the image</li>
* <li><b>border</b> - the border for the image</li>
* </ul>
*
* @since 2.1.4.
*/
// FIXME: It is not yet possible to do wiki internal links. In order to
// do this cleanly, a TranslatorReader revamp is needed.
public class Image
implements WikiPlugin
{
/** The parameter name for setting the src. Value is <tt>{@value}</tt>. */
public static final String PARAM_SRC = "src";
/** The parameter name for setting the align. Value is <tt>{@value}</tt>. */
public static final String PARAM_ALIGN = "align";
/** The parameter name for setting the height. Value is <tt>{@value}</tt>. */
public static final String PARAM_HEIGHT = "height";
/** The parameter name for setting the width. Value is <tt>{@value}</tt>. */
public static final String PARAM_WIDTH = "width";
/** The parameter name for setting the alt. Value is <tt>{@value}</tt>. */
public static final String PARAM_ALT = "alt";
/** The parameter name for setting the caption. Value is <tt>{@value}</tt>. */
public static final String PARAM_CAPTION = "caption";
/** The parameter name for setting the link. Value is <tt>{@value}</tt>. */
public static final String PARAM_LINK = "link";
/** The parameter name for setting the target. Value is <tt>{@value}</tt>. */
public static final String PARAM_TARGET = "target";
/** The parameter name for setting the style. Value is <tt>{@value}</tt>. */
public static final String PARAM_STYLE = "style";
/** The parameter name for setting the class. Value is <tt>{@value}</tt>. */
public static final String PARAM_CLASS = "class";
// public static final String PARAM_MAP = "map";
/** The parameter name for setting the border. Value is <tt>{@value}</tt>. */
public static final String PARAM_BORDER = "border";
/**
* This method is used to clean away things like quotation marks which
* a malicious user could use to stop processing and insert javascript.
*/
private static final String getCleanParameter( Map params, String paramId )
{
return TextUtil.replaceEntities( (String) params.get( paramId ) );
}
/**
* {@inheritDoc}
*/
public String execute( WikiContext context, Map params )
throws PluginException
{
WikiEngine engine = context.getEngine();
String src = getCleanParameter( params, PARAM_SRC );
String align = getCleanParameter( params, PARAM_ALIGN );
String ht = getCleanParameter( params, PARAM_HEIGHT );
String wt = getCleanParameter( params, PARAM_WIDTH );
String alt = getCleanParameter( params, PARAM_ALT );
String caption = getCleanParameter( params, PARAM_CAPTION );
String link = getCleanParameter( params, PARAM_LINK );
String target = getCleanParameter( params, PARAM_TARGET );
String style = getCleanParameter( params, PARAM_STYLE );
String cssclass= getCleanParameter( params, PARAM_CLASS );
// String map = getCleanParameter( params, PARAM_MAP );
String border = getCleanParameter( params, PARAM_BORDER );
if( src == null )
{
throw new PluginException("Parameter 'src' is required for Image plugin");
}
if( cssclass == null ) cssclass = "imageplugin";
if( target != null && !validTargetValue(target) )
{
target = null; // not a valid value so ignore
}
try
{
AttachmentManager mgr = engine.getAttachmentManager();
Attachment att = mgr.getAttachmentInfo( context, src );
if( att != null )
{
src = context.getURL( WikiContext.ATTACH, att.getName() );
}
}
catch( ProviderException e )
{
throw new PluginException( "Attachment info failed: "+e.getMessage() );
}
StringBuffer result = new StringBuffer();
result.append( "<table border=\"0\" class=\""+cssclass+"\"" );
//if( align != null ) result.append(" align=\""+align+"\"");
//if( style != null ) result.append(" style=\""+style+"\"");
//
// Do some magic to make sure centering also work on FireFox
//
if( style != null )
{
result.append(" style=\""+style);
// Make sure that we add a ";" to the end of the style string
if( result.charAt( result.length()-1 ) != ';' ) result.append(";");
if( align != null && align.equals("center") )
{
result.append(" margin-left: auto; margin-right: auto;");
}
result.append("\"");
}
else
{
if( align != null && align.equals("center") ) result.append(" style=\"margin-left: auto; margin-right: auto;\"");
}
if( align != null && !(align.equals("center")) ) result.append(" align=\""+align+"\"");
result.append( ">\n" );
if( caption != null )
{
result.append("<caption align=bottom>"+TextUtil.replaceEntities(caption)+"</caption>\n");
}
result.append( "<tr><td>" );
if( link != null )
{
result.append("<a href=\""+link+"\"");
if( target != null )
{
result.append(" target=\""+target+"\"");
}
result.append(">");
}
result.append( "<img src=\""+src+"\"" );
if( ht != null ) result.append(" height=\""+ht+"\"");
if( wt != null ) result.append(" width=\""+wt+"\"");
if( alt != null ) result.append(" alt=\""+alt+"\"");
if( border != null ) result.append(" border=\""+border+"\"");
// if( map != null ) result.append(" map=\""+map+"\"");
result.append(" />");
if( link != null ) result.append("</a>");
result.append("</td></tr>\n");
result.append("</table>\n");
return result.toString();
}
private boolean validTargetValue( String s )
{
if( s.equals("_blank")
|| s.equals("_self")
|| s.equals("_parent")
|| s.equals("_top") )
{
return true;
}
else if( s.length() > 0 ) // check [a-zA-z]
{
char c = s.charAt(0);
return Character.isLowerCase(c) || Character.isUpperCase(c);
}
return false;
}
}