You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@roller.apache.org by ag...@apache.org on 2006/06/16 02:10:54 UTC

svn commit: r414707 - in /incubator/roller/branches/roller_3.0/src/org/apache/roller: business/ business/hibernate/ model/ pojos/ ui/authoring/struts/actions/ ui/authoring/tags/ ui/rendering/velocity/deprecated/

Author: agilliland
Date: Thu Jun 15 17:10:54 2006
New Revision: 414707

URL: http://svn.apache.org/viewvc?rev=414707&view=rev
Log:
tidying up PluginManager methods.

- renamed createAndInitPagePlugins() to getWeblogEntryPlugins()
- renamed applyPagePlugins() to applyWeblogEntryPlugins()


Modified:
    incubator/roller/branches/roller_3.0/src/org/apache/roller/business/PluginManagerImpl.java
    incubator/roller/branches/roller_3.0/src/org/apache/roller/business/hibernate/HibernateRollerPlanetManagerImpl.java
    incubator/roller/branches/roller_3.0/src/org/apache/roller/model/PluginManager.java
    incubator/roller/branches/roller_3.0/src/org/apache/roller/pojos/PlanetEntryData.java
    incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WeblogEntryFormAction.java
    incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WeblogEntryPageModel.java
    incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WebsiteFormAction.java
    incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntryContentTag.java
    incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntrySummaryTag.java
    incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntryTextTag.java
    incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/rendering/velocity/deprecated/PageHelper.java

Modified: incubator/roller/branches/roller_3.0/src/org/apache/roller/business/PluginManagerImpl.java
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.0/src/org/apache/roller/business/PluginManagerImpl.java?rev=414707&r1=414706&r2=414707&view=diff
==============================================================================
--- incubator/roller/branches/roller_3.0/src/org/apache/roller/business/PluginManagerImpl.java (original)
+++ incubator/roller/branches/roller_3.0/src/org/apache/roller/business/PluginManagerImpl.java Thu Jun 15 17:10:54 2006
@@ -95,7 +95,7 @@
     /**
      * Create and init plugins for processing entries in a specified website. 
      */
-    public Map createAndInitPagePlugins(WebsiteData website, Map model) {
+    public Map getWeblogEntryPlugins(WebsiteData website, Map model) {
         Map ret = new LinkedHashMap();
         Iterator it = getPagePluginClasses().values().iterator();
         while (it.hasNext()) {
@@ -111,8 +111,7 @@
         return ret;
     }
     
-    public String applyPagePlugins(
-        WeblogEntryData entry, Map pagePlugins, String str, boolean singleEntry) { 
+    public String applyWeblogEntryPlugins(Map pagePlugins, WeblogEntryData entry, String str) { 
         String ret = str;
         WeblogEntryData copy = new WeblogEntryData(entry);        
         List entryPlugins = copy.getPluginsList();

Modified: incubator/roller/branches/roller_3.0/src/org/apache/roller/business/hibernate/HibernateRollerPlanetManagerImpl.java
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.0/src/org/apache/roller/business/hibernate/HibernateRollerPlanetManagerImpl.java?rev=414707&r1=414706&r2=414707&view=diff
==============================================================================
--- incubator/roller/branches/roller_3.0/src/org/apache/roller/business/hibernate/HibernateRollerPlanetManagerImpl.java (original)
+++ incubator/roller/branches/roller_3.0/src/org/apache/roller/business/hibernate/HibernateRollerPlanetManagerImpl.java Thu Jun 15 17:10:54 2006
@@ -137,7 +137,7 @@
                 
                 // Populate subscription object with new entries
                 PluginManager ppmgr = RollerFactory.getRoller().getPagePluginManager();
-                Map pagePlugins = ppmgr.createAndInitPagePlugins(website, new HashMap());
+                Map pagePlugins = ppmgr.getWeblogEntryPlugins(website, new HashMap());
                 Iterator entryIter = entries.iterator();
                 while (entryIter.hasNext()) {
                     try {

Modified: incubator/roller/branches/roller_3.0/src/org/apache/roller/model/PluginManager.java
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.0/src/org/apache/roller/model/PluginManager.java?rev=414707&r1=414706&r2=414707&view=diff
==============================================================================
--- incubator/roller/branches/roller_3.0/src/org/apache/roller/model/PluginManager.java (original)
+++ incubator/roller/branches/roller_3.0/src/org/apache/roller/model/PluginManager.java Thu Jun 15 17:10:54 2006
@@ -1 +1 @@
-/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  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.  For additional information regarding
 * copyright in this work, please see the NOTICE file in the top level
 * directory of this distribution.
 */

package org.apache.roller.model;

import java.util.Map;
import org.apache.roller.pojos.WeblogEntryData;
import org.apache.roller.pojos.WebsiteData;

 /**
 * Manages Roller plugins.
 */
public interface PluginManager {
    
    /**
     * Returns true if plugins are present
     */
    public boolean hasPagePlugins();
    
    
    /**
     * Create and init plugins for processing entries in a specified website.
     * @param website        Website being processed
     * @param servletContext ServetContext or null if running outside webapp
     * @param contextURL     Absolute URL of webapp
     * @param ctx            Velocity context
     */
    public Map createAndInitPagePlugins(WebsiteData website, Map model);
    
    
    /**
     * Accepts weblog entry, creates copy, applies plugins to copy and
     * returns the results.
     * @param entry       Original weblog entry
     * @param plugins     Map of plugins to apply
     * @param str         String to which to apply plugins
     * @param singleEntry Rendering for single entry page?
     * @return        Copy of weblog entry with plugins applied
     */
    public
  String applyPagePlugins(
            WeblogEntryData entry, Map pagePlugins, String str, boolean singleEntry);
    
    
    /**
     * Release all resources associated with Roller session.
     */
    public void release();
    
}
\ No newline at end of file
+/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  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.  For additional information regarding
 * copyright in this work, please see the NOTICE file in the top level
 * directory of this distribution.
 */

package org.apache.roller.model;

import java.util.Map;
import org.apache.roller.pojos.WeblogEntryData;
import org.apache.roller.pojos.WebsiteData;

 /**
 * Manages Roller plugins.
 */
public interface PluginManager {
    
    /**
     * Returns true if plugins are present
     */
    public boolean hasPagePlugins();
    
    
    /**
     * Returns a list of all registered weblog entry plugins initialized for
     * use with the specified weblog.
     *
     * @param website        Website being processed
     * @param model          Rendering model
     */
    public Map getWeblogEntryPlugins(WebsiteData website, Map model);
    
    
    /**
     * Apply a set of weblog entry plugins to the specified string and
     * return the results.  This method must *NOT* alter the contents of
     * the original entry object.
     *
     * @param entry       Original weblog entry
     * @param plugins     Map of plugins to apply
     * @param str         String to which to apply plugins
     * @return        the transformed text
     */
    public String applyWeblogEntryPlugins(Map pagePlugins, WeblogEntryData entry, String str)
 ;
    
    
    /**
     * Release all resources associated with Roller session.
     */
    public void release();
    
}
\ No newline at end of file

Modified: incubator/roller/branches/roller_3.0/src/org/apache/roller/pojos/PlanetEntryData.java
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.0/src/org/apache/roller/pojos/PlanetEntryData.java?rev=414707&r1=414706&r2=414707&view=diff
==============================================================================
--- incubator/roller/branches/roller_3.0/src/org/apache/roller/pojos/PlanetEntryData.java (original)
+++ incubator/roller/branches/roller_3.0/src/org/apache/roller/pojos/PlanetEntryData.java Thu Jun 15 17:10:54 2006
@@ -158,7 +158,7 @@
         } else {
             content = rollerEntry.getSummary();
         }
-        content = ppmgr.applyPagePlugins(rollerEntry, pagePlugins, content, true);
+        content = ppmgr.applyWeblogEntryPlugins(pagePlugins, rollerEntry, content);
         
         setAuthor(    rollerEntry.getCreator().getFullName());
         setTitle(     rollerEntry.getTitle());

Modified: incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WeblogEntryFormAction.java
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WeblogEntryFormAction.java?rev=414707&r1=414706&r2=414707&view=diff
==============================================================================
--- incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WeblogEntryFormAction.java (original)
+++ incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WeblogEntryFormAction.java Thu Jun 15 17:10:54 2006
@@ -641,7 +641,7 @@
             if (rses.isUserAuthorizedToAuthor(entry.getWebsite())) {
                 // Run entry through registered PagePlugins
                 PluginManager ppmgr = roller.getPagePluginManager();
-                Map plugins = ppmgr.createAndInitPagePlugins(
+                Map plugins = ppmgr.getWeblogEntryPlugins(
                         entry.getWebsite(),
                         new HashMap());
                 
@@ -651,7 +651,7 @@
                 } else {
                     content = entry.getSummary();
                 }
-                content = ppmgr.applyPagePlugins(entry, plugins, content, true);
+                content = ppmgr.applyWeblogEntryPlugins(plugins, entry, content);
 
                 String title = entry.getTitle();
                 String excerpt = StringUtils.left( Utilities.removeHTML(content),255 );

Modified: incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WeblogEntryPageModel.java
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WeblogEntryPageModel.java?rev=414707&r1=414706&r2=414707&view=diff
==============================================================================
--- incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WeblogEntryPageModel.java (original)
+++ incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WeblogEntryPageModel.java Thu Jun 15 17:10:54 2006
@@ -228,7 +228,7 @@
             {
                 Roller roller = RollerFactory.getRoller();
                 PluginManager ppmgr = roller.getPagePluginManager();
-                Map plugins = ppmgr.createAndInitPagePlugins(
+                Map plugins = ppmgr.getWeblogEntryPlugins(
                     getWebsite(),
                     new HashMap());
                 Iterator it = plugins.values().iterator();

Modified: incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WebsiteFormAction.java
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WebsiteFormAction.java?rev=414707&r1=414706&r2=414707&view=diff
==============================================================================
--- incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WebsiteFormAction.java (original)
+++ incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/struts/actions/WebsiteFormAction.java Thu Jun 15 17:10:54 2006
@@ -363,7 +363,7 @@
                 if (getHasPagePlugins()) {
                     Roller roller = RollerFactory.getRoller();
                     PluginManager ppmgr = roller.getPagePluginManager();
-                    Map plugins = ppmgr.createAndInitPagePlugins(
+                    Map plugins = ppmgr.getWeblogEntryPlugins(
                             getWebsite(),
                             new HashMap());
                     Iterator it = plugins.values().iterator();

Modified: incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntryContentTag.java
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntryContentTag.java?rev=414707&r1=414706&r2=414707&view=diff
==============================================================================
--- incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntryContentTag.java (original)
+++ incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntryContentTag.java Thu Jun 15 17:10:54 2006
@@ -67,11 +67,11 @@
                         RollerContext.getRollerContext();
                     try {
                         PluginManager ppmgr = roller.getPagePluginManager();
-                        Map plugins = ppmgr.createAndInitPagePlugins(
+                        Map plugins = ppmgr.getWeblogEntryPlugins(
                             entry.getWebsite(),
                             new HashMap());
-                        xformed = ppmgr.applyPagePlugins(
-                            entry, plugins, entry.getText(), singleEntry);
+                        xformed = ppmgr.applyWeblogEntryPlugins(
+                            plugins, entry, entry.getText());
                     } catch (Exception e) {
                         mLogger.error(e);
                     }

Modified: incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntrySummaryTag.java
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntrySummaryTag.java?rev=414707&r1=414706&r2=414707&view=diff
==============================================================================
--- incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntrySummaryTag.java (original)
+++ incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntrySummaryTag.java Thu Jun 15 17:10:54 2006
@@ -63,11 +63,11 @@
                     RollerContext rctx = 
                         RollerContext.getRollerContext();
                     PluginManager ppmgr = roller.getPagePluginManager();
-                    Map plugins = ppmgr.createAndInitPagePlugins(
+                    Map plugins = ppmgr.getWeblogEntryPlugins(
                         entry.getWebsite(),
                         new HashMap());
-                    xformed = ppmgr.applyPagePlugins(
-                        entry, plugins, entry.getSummary(), true);
+                    xformed = ppmgr.applyWeblogEntryPlugins(
+                        plugins, entry, entry.getSummary());
                 }               
                 pageContext.getOut().println(xformed);
             } catch (Throwable e) {

Modified: incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntryTextTag.java
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntryTextTag.java?rev=414707&r1=414706&r2=414707&view=diff
==============================================================================
--- incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntryTextTag.java (original)
+++ incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/authoring/tags/ShowEntryTextTag.java Thu Jun 15 17:10:54 2006
@@ -77,11 +77,11 @@
                         RollerContext.getRollerContext();
                     try {
                         PluginManager ppmgr = roller.getPagePluginManager();
-                        Map plugins = ppmgr.createAndInitPagePlugins(
+                        Map plugins = ppmgr.getWeblogEntryPlugins(
                                 entry.getWebsite(),
                                 new HashMap());
 
-                        xformed = ppmgr.applyPagePlugins(entry, plugins, sourceText, true);
+                        xformed = ppmgr.applyWeblogEntryPlugins(plugins, entry, sourceText);
 
                     } catch (Exception e) {
                         mLogger.error(e);

Modified: incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/rendering/velocity/deprecated/PageHelper.java
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/rendering/velocity/deprecated/PageHelper.java?rev=414707&r1=414706&r2=414707&view=diff
==============================================================================
--- incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/rendering/velocity/deprecated/PageHelper.java (original)
+++ incubator/roller/branches/roller_3.0/src/org/apache/roller/ui/rendering/velocity/deprecated/PageHelper.java Thu Jun 15 17:10:54 2006
@@ -103,7 +103,7 @@
         if (mVelocityContext == null) mVelocityContext = new HashMap();
         Roller roller = RollerFactory.getRoller(); 
         PluginManager ppmgr = roller.getPagePluginManager();
-        mPagePlugins = ppmgr.createAndInitPagePlugins(mWebsite, ctx);
+        mPagePlugins = ppmgr.getWeblogEntryPlugins(mWebsite, ctx);
     }
        
     //------------------------------------------------------------------------