This is an automated email from the ASF dual-hosted git repository. juanpablo pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/jspwiki.git
commit 25f87fd386a76ce06b022c0702c905800bb4821f Author: juanpablo <[email protected]> AuthorDate: Mon Feb 24 17:11:59 2020 +0100 JSPWIKI-120: propagate WikiContext#getEngine() now returns Engine instead of WikiEngine (3) --- .../main/java/org/apache/wiki/rss/AtomFeed.java | 11 ++--- .../src/main/java/org/apache/wiki/rss/Feed.java | 31 +++++++------- .../main/java/org/apache/wiki/rss/RSS10Feed.java | 36 ++++++++-------- .../main/java/org/apache/wiki/rss/RSS20Feed.java | 48 +++++++++++----------- .../java/org/apache/wiki/rss/RSSGenerator.java | 8 ++-- 5 files changed, 70 insertions(+), 64 deletions(-) diff --git a/jspwiki-main/src/main/java/org/apache/wiki/rss/AtomFeed.java b/jspwiki-main/src/main/java/org/apache/wiki/rss/AtomFeed.java index 4d38bc0..887accb 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/rss/AtomFeed.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/rss/AtomFeed.java @@ -21,10 +21,11 @@ package org.apache.wiki.rss; import org.apache.commons.lang3.time.DateFormatUtils; import org.apache.wiki.Release; import org.apache.wiki.WikiContext; -import org.apache.wiki.WikiEngine; import org.apache.wiki.WikiPage; +import org.apache.wiki.api.core.Engine; import org.apache.wiki.api.exceptions.ProviderException; import org.apache.wiki.attachment.Attachment; +import org.apache.wiki.attachment.AttachmentManager; import org.jdom2.Element; import org.jdom2.Namespace; import org.jdom2.output.Format; @@ -76,7 +77,7 @@ public class AtomFeed extends Feed { private Collection<Element> getItems() { final ArrayList< Element > list = new ArrayList<>(); - final WikiEngine engine = m_wikiContext.getEngine(); + final Engine engine = m_wikiContext.getEngine(); ServletContext servletContext = null; if( m_wikiContext.getHttpRequest() != null ) { servletContext = m_wikiContext.getHttpRequest().getSession().getServletContext(); @@ -97,9 +98,9 @@ public class AtomFeed extends Feed { entryEl.addContent( getElement( "content" ).setAttribute( "type", "html" ).setText( e.getContent() ) ); // Check for enclosures - if( engine.getAttachmentManager().hasAttachments( p ) && servletContext != null ) { + if( engine.getManager( AttachmentManager.class ).hasAttachments( p ) && servletContext != null ) { try { - final List< Attachment > c = engine.getAttachmentManager().listAttachments( p ); + final List< Attachment > c = engine.getManager( AttachmentManager.class ).listAttachments( p ); for( final Attachment att : c ) { final Element attEl = getElement( "link" ); attEl.setAttribute( "rel", "enclosure" ); @@ -126,7 +127,7 @@ public class AtomFeed extends Feed { @Override public String getString() { final Element root = getElement("feed"); - final WikiEngine engine = m_wikiContext.getEngine(); + final Engine engine = m_wikiContext.getEngine(); Date lastModified = new Date(0L); diff --git a/jspwiki-main/src/main/java/org/apache/wiki/rss/Feed.java b/jspwiki-main/src/main/java/org/apache/wiki/rss/Feed.java index 08bbcdf..92af083 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/rss/Feed.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/rss/Feed.java @@ -20,8 +20,9 @@ package org.apache.wiki.rss; import org.apache.commons.text.StringEscapeUtils; import org.apache.wiki.WikiContext; -import org.apache.wiki.WikiEngine; +import org.apache.wiki.api.core.Engine; import org.apache.wiki.api.exceptions.NoSuchVariableException; +import org.apache.wiki.variables.VariableManager; import javax.servlet.ServletContext; import java.util.ArrayList; @@ -31,7 +32,7 @@ import java.util.List; * Represents an abstract feed. */ public abstract class Feed { - protected List<Entry> m_entries = new ArrayList<Entry>(); + protected List<Entry> m_entries = new ArrayList<>(); protected String m_feedURL; protected String m_channelTitle; @@ -53,14 +54,14 @@ public abstract class Feed { * @param context the wiki context * @return the site name */ - public static String getSiteName(WikiContext context) { - WikiEngine engine = context.getEngine(); + public static String getSiteName( final WikiContext context ) { + final Engine engine = context.getEngine(); String blogname = null; try { - blogname = engine.getVariableManager().getValue(context, VAR_BLOGNAME); - } catch (NoSuchVariableException e) { + blogname = engine.getManager( VariableManager.class ).getValue(context, VAR_BLOGNAME); + } catch( final NoSuchVariableException e ) { } if (blogname == null) { @@ -75,7 +76,7 @@ public abstract class Feed { * * @param context The WikiContext. */ - public Feed(WikiContext context) { + public Feed( final WikiContext context) { m_wikiContext = context; } @@ -91,7 +92,7 @@ public abstract class Feed { * * @param mode As defined in RSSGenerator. */ - public void setMode(String mode) { + public void setMode( final String mode) { m_mode = mode; } @@ -100,7 +101,7 @@ public abstract class Feed { * * @param e The Entry to add. */ - public void addEntry(Entry e) { + public void addEntry( final Entry e) { m_entries.add(e); } @@ -121,7 +122,7 @@ public abstract class Feed { /** * @param description The m_channelDescription to set. */ - public void setChannelDescription(String description) { + public void setChannelDescription( final String description) { m_channelDescription = description; } @@ -135,7 +136,7 @@ public abstract class Feed { /** * @param language The m_channelLanguage to set. */ - public void setChannelLanguage(String language) { + public void setChannelLanguage( final String language) { m_channelLanguage = language; } @@ -149,7 +150,7 @@ public abstract class Feed { /** * @param title The m_channelTitle to set. */ - public void setChannelTitle(String title) { + public void setChannelTitle( final String title) { m_channelTitle = title; } @@ -163,7 +164,7 @@ public abstract class Feed { /** * @param feedurl The m_feedURL to set. */ - public void setFeedURL(String feedurl) { + public void setFeedURL( final String feedurl) { m_feedURL = feedurl; } @@ -174,7 +175,7 @@ public abstract class Feed { * @param name The filename * @return Something sane for a MIME type. */ - protected String getMimeType(ServletContext c, String name) { + protected String getMimeType( final ServletContext c, final String name) { String type = c.getMimeType(name); if (type == null) { @@ -190,7 +191,7 @@ public abstract class Feed { * @param s The String to format. Null is safe. * @return A formatted string. */ - public static String format( String s ) { + public static String format( final String s ) { return StringEscapeUtils.escapeXml11( s ); } } diff --git a/jspwiki-main/src/main/java/org/apache/wiki/rss/RSS10Feed.java b/jspwiki-main/src/main/java/org/apache/wiki/rss/RSS10Feed.java index 12f8625..57c8d07 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/rss/RSS10Feed.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/rss/RSS10Feed.java @@ -19,8 +19,8 @@ package org.apache.wiki.rss; import org.apache.wiki.WikiContext; -import org.apache.wiki.WikiEngine; import org.apache.wiki.WikiPage; +import org.apache.wiki.api.core.Engine; import org.apache.wiki.util.XhtmlUtil; import org.jdom2.Element; import org.jdom2.Namespace; @@ -46,16 +46,16 @@ public class RSS10Feed extends Feed { * * @param context The WikiContext. */ - public RSS10Feed( WikiContext context ) { + public RSS10Feed( final WikiContext context ) { super( context ); } private Element getRDFItems() { - Element items = new Element( "items", NS_XMNLS ); - Element rdfseq = new Element( "Seq", NS_RDF ); + final Element items = new Element( "items", NS_XMNLS ); + final Element rdfseq = new Element( "Seq", NS_RDF ); - for( Entry e : m_entries ) { - String url = e.getURL(); + for( final Entry e : m_entries ) { + final String url = e.getURL(); rdfseq.addContent( new Element( "li", NS_RDF ).setAttribute( "resource", url, NS_RDF ) ); } items.addContent( rdfseq ); @@ -63,24 +63,24 @@ public class RSS10Feed extends Feed { return items; } - private void addItemList( Element root ) { - SimpleDateFormat iso8601fmt = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'"); - WikiEngine engine = m_wikiContext.getEngine(); + private void addItemList( final Element root ) { + final SimpleDateFormat iso8601fmt = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'"); + final Engine engine = m_wikiContext.getEngine(); - for( Entry entry : m_entries ) { - String url = entry.getURL(); + for( final Entry entry : m_entries ) { + final String url = entry.getURL(); - Element item = new Element( "item", NS_XMNLS ); + final Element item = new Element( "item", NS_XMNLS ); item.setAttribute( "about", url, NS_RDF ); item.addContent( new Element( "title", NS_XMNLS ).addContent( entry.getTitle() ) ); item.addContent( new Element( "link", NS_XMNLS ).addContent( url ) ); - Element content = new Element( "description", NS_XMNLS ); + final Element content = new Element( "description", NS_XMNLS ); // TODO: Add a size limiter here content.addContent( entry.getContent() ); item.addContent( content ); - WikiPage p = entry.getPage(); + final WikiPage p = entry.getPage(); if( p.getVersion() != -1 ) { item.addContent( new Element( "version", NS_WIKI ).addContent( Integer.toString( p.getVersion() ) ) ); } @@ -92,7 +92,7 @@ public class RSS10Feed extends Feed { // // Modification date. - Calendar cal = Calendar.getInstance(); + final Calendar cal = Calendar.getInstance(); cal.setTime(p.getLastModified()); cal.add( Calendar.MILLISECOND, - ( cal.get( Calendar.ZONE_OFFSET ) + @@ -108,7 +108,7 @@ public class RSS10Feed extends Feed { author = "unknown"; } - Element contributor = new Element( "creator", NS_DC ); + final Element contributor = new Element( "creator", NS_DC ); item.addContent( contributor ); /* @@ -136,7 +136,7 @@ public class RSS10Feed extends Feed { } private Element getChannelElement() { - Element channel = new Element( "channel", NS_XMNLS ); + final Element channel = new Element( "channel", NS_XMNLS ); channel.setAttribute( "about", m_feedURL, NS_RDF ) .addContent( new Element( "link", NS_XMNLS ).addContent( m_feedURL ) ); @@ -161,7 +161,7 @@ public class RSS10Feed extends Feed { */ @Override public String getString() { - Element root = new Element( "RDF", NS_RDF ); + final Element root = new Element( "RDF", NS_RDF ); root.addContent( getChannelElement() ); root.addNamespaceDeclaration( NS_XMNLS ); root.addNamespaceDeclaration( NS_RDF ); diff --git a/jspwiki-main/src/main/java/org/apache/wiki/rss/RSS20Feed.java b/jspwiki-main/src/main/java/org/apache/wiki/rss/RSS20Feed.java index d5026c2..a14b8d8 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/rss/RSS20Feed.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/rss/RSS20Feed.java @@ -20,10 +20,12 @@ package org.apache.wiki.rss; import org.apache.wiki.Release; import org.apache.wiki.WikiContext; -import org.apache.wiki.WikiEngine; import org.apache.wiki.WikiPage; +import org.apache.wiki.api.core.Engine; import org.apache.wiki.api.exceptions.ProviderException; import org.apache.wiki.attachment.Attachment; +import org.apache.wiki.attachment.AttachmentManager; +import org.apache.wiki.variables.VariableManager; import org.jdom2.Element; import org.jdom2.output.Format; import org.jdom2.output.XMLOutputter; @@ -50,30 +52,30 @@ public class RSS20Feed extends Feed * * @param context The WikiContext. */ - public RSS20Feed( WikiContext context ) + public RSS20Feed( final WikiContext context ) { super( context ); } private List<Element> getItems() { - ArrayList<Element> list = new ArrayList<>(); - SimpleDateFormat fmt = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss 'GMT'"); + final ArrayList<Element> list = new ArrayList<>(); + final SimpleDateFormat fmt = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss 'GMT'"); - WikiEngine engine = m_wikiContext.getEngine(); + final Engine engine = m_wikiContext.getEngine(); ServletContext servletContext = null; if( m_wikiContext.getHttpRequest() != null ) servletContext = m_wikiContext.getHttpRequest().getSession().getServletContext(); - for( Iterator< Entry > i = m_entries.iterator(); i.hasNext(); ) + for( final Iterator< Entry > i = m_entries.iterator(); i.hasNext(); ) { - Entry e = i.next(); - WikiPage p = e.getPage(); + final Entry e = i.next(); + final WikiPage p = e.getPage(); - String url = e.getURL(); + final String url = e.getURL(); - Element item = new Element("item"); + final Element item = new Element("item"); item.addContent( new Element("link").setText(url) ); @@ -85,17 +87,17 @@ public class RSS20Feed extends Feed // Attachments for enclosures // - if( engine.getAttachmentManager().hasAttachments(p) && servletContext != null ) + if( engine.getManager( AttachmentManager.class ).hasAttachments(p) && servletContext != null ) { try { - List< Attachment > c = engine.getAttachmentManager().listAttachments(p); + final List< Attachment > c = engine.getManager( AttachmentManager.class ).listAttachments(p); - for( Iterator< Attachment > a = c.iterator(); a.hasNext(); ) + for( final Iterator< Attachment > a = c.iterator(); a.hasNext(); ) { - Attachment att = a.next(); + final Attachment att = a.next(); - Element attEl = new Element("enclosure"); + final Element attEl = new Element("enclosure"); attEl.setAttribute( "url", engine.getURL( WikiContext.ATTACH, att.getName(), null ) ); attEl.setAttribute( "length", Long.toString(att.getSize()) ); attEl.setAttribute( "type", getMimeType( servletContext, att.getFileName() ) ); @@ -103,7 +105,7 @@ public class RSS20Feed extends Feed item.addContent( attEl ); } } - catch( ProviderException ex ) + catch( final ProviderException ex ) { // FIXME: log.info("Can't get attachment data",ex); } @@ -112,7 +114,7 @@ public class RSS20Feed extends Feed // // Modification date. // - Calendar cal = Calendar.getInstance(); + final Calendar cal = Calendar.getInstance(); cal.setTime( p.getLastModified() ); cal.add( Calendar.MILLISECOND, - (cal.get( Calendar.ZONE_OFFSET ) + @@ -132,11 +134,11 @@ public class RSS20Feed extends Feed @Override public String getString() { - WikiEngine engine = m_wikiContext.getEngine(); - Element root = new Element("rss"); + final Engine engine = m_wikiContext.getEngine(); + final Element root = new Element("rss"); root.setAttribute("version","2.0"); - Element channel = new Element("channel"); + final Element channel = new Element("channel"); root.addContent( channel ); // @@ -152,10 +154,10 @@ public class RSS20Feed extends Feed channel.addContent( new Element("language").setText(getChannelLanguage())); channel.addContent( new Element("generator").setText("JSPWiki "+Release.VERSTR)); - String mail = engine.getVariableManager().getVariable(m_wikiContext,RSSGenerator.PROP_RSS_AUTHOREMAIL); + String mail = engine.getManager( VariableManager.class ).getVariable(m_wikiContext,RSSGenerator.PROP_RSS_AUTHOREMAIL); if( mail != null ) { - String editor = engine.getVariableManager().getVariable( m_wikiContext,RSSGenerator.PROP_RSS_AUTHOR ); + final String editor = engine.getManager( VariableManager.class ).getVariable( m_wikiContext,RSSGenerator.PROP_RSS_AUTHOR ); if( editor != null ) mail = mail + " ("+editor+")"; @@ -172,7 +174,7 @@ public class RSS20Feed extends Feed // // aaand output // - XMLOutputter output = new XMLOutputter(); + final XMLOutputter output = new XMLOutputter(); output.setFormat( Format.getPrettyFormat() ); diff --git a/jspwiki-main/src/main/java/org/apache/wiki/rss/RSSGenerator.java b/jspwiki-main/src/main/java/org/apache/wiki/rss/RSSGenerator.java index d7df53c..cb48eb9 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/rss/RSSGenerator.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/rss/RSSGenerator.java @@ -26,6 +26,8 @@ import org.apache.wiki.WikiProvider; import org.apache.wiki.WikiSession; import org.apache.wiki.attachment.Attachment; import org.apache.wiki.auth.permissions.PagePermission; +import org.apache.wiki.diff.DifferenceManager; +import org.apache.wiki.pages.PageManager; import org.apache.wiki.pages.PageTimeComparator; import org.apache.wiki.util.TextUtil; @@ -180,7 +182,7 @@ public class RSSGenerator { final String author = getAuthor( page ); final WikiContext ctx = new WikiContext( m_engine, page ); if( page.getVersion() > 1 ) { - final String diff = m_engine.getDifferenceManager().getDiff( ctx, + final String diff = m_engine.getManager( DifferenceManager.class ).getDiff( ctx, page.getVersion() - 1, // FIXME: Will fail when non-contiguous versions page.getVersion() ); @@ -311,7 +313,7 @@ public class RSSGenerator { feed.setChannelLanguage( m_channelLanguage ); feed.setChannelDescription( m_channelDescription ); - final Set< WikiPage > changed = m_engine.getPageManager().getRecentChanges(); + final Set< WikiPage > changed = m_engine.getManager( PageManager.class ).getRecentChanges(); final WikiSession session = WikiSession.guestSession( m_engine ); int items = 0; @@ -449,7 +451,7 @@ public class RSSGenerator { e.setURL( url ); // Title - String pageText = m_engine.getPageManager().getPureText( page.getName(), WikiProvider.LATEST_VERSION ); + String pageText = m_engine.getManager( PageManager.class ).getPureText( page.getName(), WikiProvider.LATEST_VERSION ); String title = ""; final int firstLine = pageText.indexOf('\n');
