From: <jbo...@li...> - 2005-10-18 20:55:40
|
Author: szimano Date: 2005-10-18 16:55:27 -0400 (Tue, 18 Oct 2005) New Revision: 1406 Added: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/etc/WikiInsidePlugins.xml Removed: trunk/forge/portal-extensions/jbosswiki/wiki-common/doc/ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/etc/org/jboss/wiki/WikiInsidePlugins.xml Modified: trunk/forge/portal-extensions/jbosswiki/forge-wiki/src/java/org/jboss/wiki/WikiPortlet.java trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/AttachmentDataSource.java trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/Credentials.java trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/JBossPortalCredentials.java trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/MediaDataSource.java trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/SimpleCredentials.java trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiEngine.java trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiInsidePlugin.java trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiPageDictionary.java trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiPlugin.java trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/plugins/AddTranslatorPartsPlugin.java trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/plugins/AttachementInfoPlugin.java trunk/forge/portal-extensions/jbosswiki/wiki-common/src/test/java/org/jboss/wiki/test/GetSavePageTest.java trunk/forge/portal-extensions/jbosswiki/wiki-common/src/test/java/org/jboss/wiki/test/WikiTest.java Log: cleanuping before releasex Modified: trunk/forge/portal-extensions/jbosswiki/forge-wiki/src/java/org/jboss/wiki/WikiPortlet.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/forge-wiki/src/java/org/jboss/wiki/WikiPortlet.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/forge-wiki/src/java/org/jboss/wiki/WikiPortlet.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -288,7 +288,7 @@ if ((rReq.getParameter("action") != null) && (rReq.getParameter("action").equals("Edit")) - && (credentials.isLogedIn())) { + && (credentials.isLoggedIn())) { page = "Edit.jsp"; showPage = false; @@ -431,7 +431,7 @@ rReq.setAttribute("author", pageToShow.getLastAuthor()); - rReq.setAttribute("logedIn", credentials.isLogedIn()); + rReq.setAttribute("logedIn", credentials.isLoggedIn()); rReq.setAttribute("defaultPage", defaultPage); Added: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/etc/WikiInsidePlugins.xml =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/etc/WikiInsidePlugins.xml 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/etc/WikiInsidePlugins.xml 2005-10-18 20:55:27 UTC (rev 1406) @@ -0,0 +1,7 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"> +<properties> +<comment>Here are defined inside plugins</comment> +<entry key="tomek">org.jboss.wiki.plugins.TomekInsidePlugin</entry> +<entry key="InsertPage">org.jboss.wiki.plugins.InsertPageInsidePlugin</entry> +</properties> \ No newline at end of file Deleted: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/etc/org/jboss/wiki/WikiInsidePlugins.xml =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/etc/org/jboss/wiki/WikiInsidePlugins.xml 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/etc/org/jboss/wiki/WikiInsidePlugins.xml 2005-10-18 20:55:27 UTC (rev 1406) @@ -1,7 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"> -<properties> -<comment>Here are defined inside plugins</comment> -<entry key="tomek">org.jboss.wiki.plugins.TomekInsidePlugin</entry> -<entry key="InsertPage">org.jboss.wiki.plugins.InsertPageInsidePlugin</entry> -</properties> \ No newline at end of file Modified: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/AttachmentDataSource.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/AttachmentDataSource.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/AttachmentDataSource.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -12,7 +12,7 @@ import java.util.Set; /** - * @author Tomasz Szymański + * @author <a href="mailto:tom...@jb...">Tomasz Szymanski</a> * */ public interface AttachmentDataSource { Modified: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/Credentials.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/Credentials.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/Credentials.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -12,23 +12,41 @@ import javax.portlet.ActionRequest; import javax.portlet.RenderRequest; -/** +/**@author <a href="mailto:tom...@jb...">Tomasz Szymanski</a><br /> * <p></p> * */ public abstract class Credentials { + /**Gets userName + * @return userName of current user. + */ public abstract String getName(); - public abstract boolean isLogedIn(); + /**Checks if any user is logged in. + * @return true if anyone is logged in, false othwerwise. + */ + public abstract boolean isLoggedIn(); + /**Checks if logged in user is Admin. + * @return true if user is admin, false othwerwise. + */ public abstract boolean isAdmin(); + /* (non-Javadoc) + * @see java.lang.Object#toString() + */ public String toString() { return getName(); } + /**Sets RenderRequest for current credentials. + * @param rReq RenderRequest to set. + */ public abstract void setRenderRequest(RenderRequest rReq); + /**Sets ActionRequest for current credentials. + * @param rReq ActionRequest to set. + */ public abstract void setActionRequest(ActionRequest rReq); } Modified: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/JBossPortalCredentials.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/JBossPortalCredentials.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/JBossPortalCredentials.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -59,7 +59,7 @@ public boolean isAdmin() { return isAdmin; } - public boolean isLogedIn() { + public boolean isLoggedIn() { return logedIn; } Modified: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/MediaDataSource.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/MediaDataSource.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/MediaDataSource.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -11,7 +11,7 @@ import java.util.Set; /** - * @author Tomasz Szymański + * @author <a href="mailto:tom...@jb...">Tomasz Szymanski</a> * */ public interface MediaDataSource { Modified: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/SimpleCredentials.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/SimpleCredentials.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/SimpleCredentials.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -17,7 +17,7 @@ return name; } - public boolean isLogedIn() { + public boolean isLoggedIn() { return false; } Modified: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiEngine.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiEngine.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiEngine.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -429,7 +429,7 @@ try { props.loadFromXML(WikiTypeHandler.class - .getResourceAsStream("WikiInsidePlugins.xml")); + .getResourceAsStream("/WikiInsidePlugins.xml")); } catch (InvalidPropertiesFormatException e) { System.err.println("WikiInsidePlugins.xml has bad format !"); e.printStackTrace(); Modified: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiInsidePlugin.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiInsidePlugin.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiInsidePlugin.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -13,14 +13,24 @@ import java.util.Properties; /** - * <p></p> - * - */ -/** * - * @author <a href="mailto:ds...@jb...">Damon Sicore</a> - * @author <a href="mailto:tom...@jb...">Tomasz Szymanski</a> - * @version $Id$ + * @author <a href="mailto:ds...@jb...">Damon Sicore</a><br /> + * @author <a href="mailto:tom...@jb...">Tomasz Szymanski</a><br /> + * <br /> + * <br /> + * This class is for making WikiInsidePlugins.<br /> + * <br /> + * The only difference is that they are processed in HTMLTranslatorParts plugin and return + * String to insert inside showed page.<br /> + * <br /> + * WikiSession attributes are the same as in {@link WikiPlugin} <br /> + * <br /> + * To add definition of WikiInsidePlugin you need to add + * coresponding part to <i>wiki-common/src/etc/WikiInsidePlugins.xml:</i> + * <pre> + * <entry key="<i>unique plugin name - this will be used in page source</i>"><i>plugin class name</i></entry> + * </pre> + * @see WikiPlugin */ public abstract class WikiInsidePlugin { @@ -31,29 +41,27 @@ private String name; final static String propFileName = "wikiPlugins.properties"; -/** - * <p></p> - * - */ -/** - * <p>Does ...</p> - * - * - * @return - * @param content - */ + /** + * Processes the given page, and attributes and return String to show in the apropriate place on the page. + * + * @param wikiPage Page where from the plugin was executed. + * @param wikiSession Session for passing attibutes etc. + * @param attributes Attributes given to plugin. + * @return String to show. + */ public abstract String process(final WikiPage wikiPage, WikiSession wikiSession, HashMap<String, String> attributes); - -/** - * <p>Does ...</p> - * - * - * @return - */ + /** + * It's run after initiating plugin. + */ public abstract void init(); + /** + * Sets wikiEngine. + * + * @param wikiEngine WikiEngine to set. + */ public void setWikiEngine(WikiEngine wikiEngine) { this.wikiEngine = wikiEngine; @@ -73,14 +81,30 @@ } } + /** + * Gets property from wikiPlugins.properties + * + * @param propertyName Name of the property to get + * @return Apripriate property. + */ protected String getProperty(String propertyName) { return pluginProps.getProperty(propertyName); } + /** + * Returns name of that plugin. + * + * @return name of current plugin. + */ public String getName() { return name; } + /** + * Sets name of current plugin. + * + * @param name Name of the plugin. + */ public void setName(String name) { this.name = name; } Modified: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiPageDictionary.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiPageDictionary.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiPageDictionary.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -1,20 +1,60 @@ +/************************************************** + * * + * JBoss Labs: Creating Professional Open Source * + * * + * Distributable under LGPL license. * + * See terms of license at gnu.org. * + * * + *************************************************/ package org.jboss.wiki; -import org.jboss.wiki.exceptions.PageAlreadyExistsException; import org.jboss.wiki.exceptions.PageRenamingException; +/** + * @author <a href="mailto:tom...@jb...">Tomasz Szymanski</a> + * + */ public interface WikiPageDictionary { + /**Return RealName of given UID - this is what will be shown on the page (what user gets) + * + * @param uid uid to translate + * @return apropriate UID + */ public String getRealName(String uid); + /**Return UID of RealName (uid is what JBoss Wiki uses for unique recognition of a page) + * + * @param realName realName to translate + * @return apropriate RealName + */ public String getUid(String realName); + /**Function that adds renaming for current page. You have to remember about all the consequences. + * + * @param uid Uid of a page. + * @param newName New name of a page + * @throws PageRenamingException If there is page with "newName" etc. + */ public void rename(String uid, String newName) throws PageRenamingException; + /** + * @param uid + * @return True if there is mapping for given uid. + */ public boolean uidInDictionary(String uid); + /** + * @param realName + * @return True if there is mapping for given realName + */ public boolean realNameInDictionary(String realName); + /**Removes mapping for given page. If there is no mapping for a page UID = RealName. + * + * @param uid + * @throws PageRenamingException + */ public void removeDictForPage(String uid) throws PageRenamingException; /**Sets wikiEngine reference Modified: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiPlugin.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiPlugin.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/WikiPlugin.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -12,14 +12,35 @@ import java.util.Properties; /** - * <p></p> - * - */ -/** * - * @author <a href="mailto:ds...@jb...">Damon Sicore</a> - * @author <a href="mailto:tom...@jb...">Tomasz Szymanski</a> - * @version $Id$ + * @author <a href="mailto:ds...@jb...">Damon Sicore</a><br /> + * @author <a href="mailto:tom...@jb...">Tomasz Szymanski</a><br /> + * <br /> + * <br /> + * This class is used for making own plugins, that allow page processing.<br /> + * <br /> + * From inside WikiPlugin you can acess WikiEngine, WikiPage you're processing and some session attributes passed to the plugin in WikiSession.<br /> + * <br /> + * They are:<br /> + * <br /> + * <table> + * <tr><th>Attribute</th><th>Type</th><th>What is it?</th></tr> + * <tr><td>actionURL</td><td>String</td><td>Action url to create links</td></tr> + * <tr><td>hostURL</td><td>String</td><td>Url of the host</td></tr> + * <tr><td>credentials</td><td>org.jboss.wiki.Credentials</td><td>Credentials of browsing user</td></tr> + * </table> + * <br /> + * Also if you add to actionURL parameter val1 val2 ... valn they will be all added to WikiSesion and passed to plugins.<br /> + * <br /> + * To add a plugin to a WikiType you have to add coresponding xml part to + * <i>wiki-common/src/etc/WikiTypes.xml</i>:<br /> + * <pre> + * <plugin> + * <name><i>plugin name</i></name> + * <class><i>plugin class</i><name> + * </plugin> + * </pre> + * @see WikiInsidePlugin */ public abstract class WikiPlugin { @@ -30,29 +51,25 @@ private String name; final static String propFileName = "wikiPlugins.properties"; -/** - * <p></p> - * - */ -/** - * <p>Does ...</p> - * - * - * @return - * @param content - */ + /**Processes given WikiPage and returns processed one. + * + * @param wikiPage WikiPage to process + * @param wikiSession Session for passing attributes and getting some stuff from it. + * @return Processed WikiPage + */ public abstract WikiPage process(final WikiPage wikiPage, WikiSession wikiSession); - -/** - * <p>Does ...</p> - * - * - * @return - */ + /** + * It's run after initiating plugin. + */ public abstract void init(); + /** + * Sets WikiEngine. If you're not sure why would you like to override it, leave that one. + * + * @param wikiEngine + */ public void setWikiEngine(WikiEngine wikiEngine) { this.wikiEngine = wikiEngine; @@ -72,14 +89,30 @@ } } + /** + * Gets property from wikiPlugins.properties + * + * @param propertyName Name of the property to get + * @return Apripriate property. + */ protected String getProperty(String propertyName) { return pluginProps.getProperty(propertyName); } + /** + * Returns name of that plugin. + * + * @return name of current plugin. + */ public String getName() { return name; } + /** + * Sets name of current plugin. + * + * @param name Name of the plugin. + */ public void setName(String name) { this.name = name; } Modified: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/plugins/AddTranslatorPartsPlugin.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/plugins/AddTranslatorPartsPlugin.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/plugins/AddTranslatorPartsPlugin.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -1,3 +1,11 @@ +/************************************************** + * * + * JBoss Labs: Creating Professional Open Source * + * * + * Distributable under LGPL license. * + * See terms of license at gnu.org. * + * * + *************************************************/ package org.jboss.wiki.plugins; import org.jboss.wiki.WikiPage; @@ -4,6 +12,10 @@ import org.jboss.wiki.WikiPlugin; import org.jboss.wiki.WikiSession; +/** + * @author <a href="mailto:tom...@jb...">Tomasz Szymanski</a> + * + */ public class AddTranslatorPartsPlugin extends WikiPlugin { @Override Modified: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/plugins/AttachementInfoPlugin.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/plugins/AttachementInfoPlugin.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/java/org/jboss/wiki/plugins/AttachementInfoPlugin.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -20,7 +20,7 @@ String actionURL = (String) wikiSession.getAttribute("actionURL"); if (((wikiPage.isEditable())||(credentials.isAdmin()))&&(rollbackToVer != null) - && (credentials.isLogedIn()) + && (credentials.isLoggedIn()) && (Integer.valueOf((String) rollbackToVer) < wikiEngine.getLastAttachmentVersion( wikiPage.getName(), attachementName))) { WikiAttachment wikiAttachment = wikiEngine.getAttachment( @@ -53,22 +53,22 @@ if (i != lastVer) { history.append("<td>"); - if ((credentials.isLogedIn())&&((wikiPage.isEditable())||(credentials.isAdmin()))) + if ((credentials.isLoggedIn())&&((wikiPage.isEditable())||(credentials.isAdmin()))) history.append("<a href=\"").append(actionURL).append( "&type=fileInfo&page=").append(wikiPage.getName()) .append("&var1=").append(attachementName).append( "&var2=").append(i).append("\" >"); if (wikiPage.isEditable()) { - history.append((!credentials.isLogedIn()) ? "<i>" : "").append( + history.append((!credentials.isLoggedIn()) ? "<i>" : "").append( "Rollback version ").append(i).append( - (!credentials.isLogedIn()) ? " (after login)</i>" : ""); + (!credentials.isLoggedIn()) ? " (after login)</i>" : ""); } else { history.append("<i>This page IS NOT editable</i>"); } - if ((credentials.isLogedIn())&&((wikiPage.isEditable())||(credentials.isAdmin()))) + if ((credentials.isLoggedIn())&&((wikiPage.isEditable())||(credentials.isAdmin()))) history.append("</a>"); history.append("<td>"); Modified: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/test/java/org/jboss/wiki/test/GetSavePageTest.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/test/java/org/jboss/wiki/test/GetSavePageTest.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/test/java/org/jboss/wiki/test/GetSavePageTest.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -1,6 +1,5 @@ package org.jboss.wiki.test; -import java.util.Set; import java.util.Vector; import org.jboss.wiki.WikiContext; Modified: trunk/forge/portal-extensions/jbosswiki/wiki-common/src/test/java/org/jboss/wiki/test/WikiTest.java =================================================================== --- trunk/forge/portal-extensions/jbosswiki/wiki-common/src/test/java/org/jboss/wiki/test/WikiTest.java 2005-10-18 18:51:50 UTC (rev 1405) +++ trunk/forge/portal-extensions/jbosswiki/wiki-common/src/test/java/org/jboss/wiki/test/WikiTest.java 2005-10-18 20:55:27 UTC (rev 1406) @@ -106,11 +106,11 @@ @Override public String getName() { - return (isLogedIn()) ? ((isAdmin()) ? "admin" : "test-user") : "Unknown"; + return (isLoggedIn()) ? ((isAdmin()) ? "admin" : "test-user") : "Unknown"; } @Override - public boolean isLogedIn() { + public boolean isLoggedIn() { return logedIn; } |