/*
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.xmlrpc;
import java.io.ByteArrayInputStream;
import java.util.*;
import org.apache.log4j.Logger;
import org.apache.xmlrpc.XmlRpcException;
import com.ecyrd.jspwiki.PageTimeComparator;
import com.ecyrd.jspwiki.WikiContext;
import com.ecyrd.jspwiki.WikiEngine;
import com.ecyrd.jspwiki.WikiPage;
import com.ecyrd.jspwiki.attachment.Attachment;
import com.ecyrd.jspwiki.attachment.AttachmentManager;
import com.ecyrd.jspwiki.auth.AuthenticationManager;
import com.ecyrd.jspwiki.auth.AuthorizationManager;
import com.ecyrd.jspwiki.auth.WikiSecurityException;
import com.ecyrd.jspwiki.auth.permissions.PermissionFactory;
import com.ecyrd.jspwiki.plugin.WeblogEntryPlugin;
import com.ecyrd.jspwiki.plugin.WeblogPlugin;
import com.ecyrd.jspwiki.providers.ProviderException;
/**
* Provides handlers for all RPC routines of the MetaWeblog API.
* <P>
* JSPWiki does not support categories, and therefore we always return
* an empty list for getCategories(). Note also that this API is not
* suitable for general Wiki editing, since JSPWiki formats the entries
* in a wiki-compatible manner. And you cannot choose your page names
* either. Since 2.1.94 the entire MetaWeblog API is supported.
*
* @since 2.1.7
*/
public class MetaWeblogHandler
implements WikiRPCHandler
{
private static Logger log = Logger.getLogger( MetaWeblogHandler.class );
private WikiContext m_context;
/**
* {@inheritDoc}
*/
public void initialize( WikiContext context )
{
m_context = context;
}
/**
* Does a quick check against the current user
* and does he have permissions to do the stuff
* that he really wants to.
* <p>
* If there is no authentication enabled, returns normally.
*
* @throw XmlRpcException with the correct error message, if auth fails.
*/
private void checkPermissions( WikiPage page,
String username,
String password,
String permission )
throws XmlRpcException
{
try
{
AuthenticationManager amm = m_context.getEngine().getAuthenticationManager();
AuthorizationManager mgr = m_context.getEngine().getAuthorizationManager();
if( amm.login( m_context.getWikiSession(), m_context.getHttpRequest(), username, password ) )
{
if( !mgr.checkPermission( m_context.getWikiSession(), PermissionFactory.getPagePermission( page, permission ) ))
{
throw new XmlRpcException( 1, "No permission" );
}
}
else
{
throw new XmlRpcException( 1, "Unknown login" );
}
}
catch( WikiSecurityException e )
{
throw new XmlRpcException( 1, e.getMessage(), e );
}
return;
}
/**
* JSPWiki does not support categories, therefore JSPWiki
* always returns an empty list for categories.
*
* @param blogid The id of the blog.
* @param username The username to use
* @param password The password
* @throws XmlRpcException If something goes wrong
* @return An empty hashtable.
*/
public Hashtable getCategories( String blogid,
String username,
String password )
throws XmlRpcException
{
WikiPage page = m_context.getEngine().getPage( blogid );
checkPermissions( page, username, password, "view" );
Hashtable ht = new Hashtable();
return ht;
}
private String getURL( String page )
{
return m_context.getEngine().getURL( WikiContext.VIEW,
page,
null,
true ); // Force absolute urls
}
/**
* Takes a wiki page, and creates a metaWeblog struct
* out of it.
* @param page The actual entry page
* @return A metaWeblog entry struct.
*/
private Hashtable<String,Object> makeEntry( WikiPage page )
{
Hashtable<String, Object> ht = new Hashtable<String, Object>();
WikiPage firstVersion = m_context.getEngine().getPage( page.getName(), 1 );
ht.put("dateCreated", firstVersion.getLastModified());
ht.put("link", getURL(page.getName()));
ht.put("permaLink", getURL(page.getName()));
ht.put("postid", page.getName());
ht.put("userid", page.getAuthor());
String pageText = m_context.getEngine().getText(page.getName());
String title = "";
int firstLine = pageText.indexOf('\n');
if( firstLine > 0 )
{
title = pageText.substring( 0, firstLine );
}
if( title.trim().length() == 0 ) title = page.getName();
// Remove wiki formatting
while( title.startsWith("!") ) title = title.substring(1);
ht.put("title", title);
ht.put("description", pageText);
return ht;
}
/**
* Returns a list of the recent posts to this weblog.
*
* @param blogid The id of the blog.
* @param username The username to use
* @param password The password
* @param numberOfPosts How many posts to find
* @throws XmlRpcException If something goes wrong
* @return As per MetaweblogAPI specification
*/
// FIXME: The implementation is suboptimal, as it
// goes through all of the blog entries.
@SuppressWarnings("unchecked")
public Hashtable getRecentPosts( String blogid,
String username,
String password,
int numberOfPosts)
throws XmlRpcException
{
Hashtable<String, Hashtable<String, Object>> result = new Hashtable<String, Hashtable<String, Object>>();
log.info( "metaWeblog.getRecentPosts() called");
WikiPage page = m_context.getEngine().getPage( blogid );
checkPermissions( page, username, password, "view" );
try
{
WeblogPlugin plugin = new WeblogPlugin();
List<WikiPage> changed = plugin.findBlogEntries(m_context.getEngine().getPageManager(),
blogid,
new Date(0L),
new Date());
Collections.sort( changed, new PageTimeComparator() );
int items = 0;
for( Iterator i = changed.iterator(); i.hasNext() && items < numberOfPosts; items++ )
{
WikiPage p = (WikiPage) i.next();
result.put( "entry", makeEntry( p ) );
}
}
catch( ProviderException e )
{
log.error( "Failed to list recent posts", e );
throw new XmlRpcException( 0, e.getMessage() );
}
return result;
}
/**
* Adds a new post to the blog.
*
* @param blogid The id of the blog.
* @param username The username to use
* @param password The password
* @param content As per Metaweblogapi contract
* @param publish This parameter is ignored for JSPWiki.
* @return Returns an empty string
* @throws XmlRpcException If something goes wrong
*/
public String newPost( String blogid,
String username,
String password,
Hashtable content,
boolean publish )
throws XmlRpcException
{
log.info("metaWeblog.newPost() called");
WikiEngine engine = m_context.getEngine();
WikiPage page = engine.getPage( blogid );
checkPermissions( page, username, password, "createPages" );
try
{
WeblogEntryPlugin plugin = new WeblogEntryPlugin();
String pageName = plugin.getNewEntryPage( engine, blogid );
WikiPage entryPage = new WikiPage( engine, pageName );
entryPage.setAuthor( username );
WikiContext context = new WikiContext( engine, entryPage );
StringBuffer text = new StringBuffer();
text.append( "!"+content.get("title") );
text.append( "\n\n" );
text.append( content.get("description") );
log.debug("Writing entry: "+text);
engine.saveText( context, text.toString() );
}
catch( Exception e )
{
log.error("Failed to create weblog entry",e);
throw new XmlRpcException( 0, "Failed to create weblog entry: "+e.getMessage() );
}
return ""; // FIXME:
}
/**
* Creates an attachment and adds it to the blog. The attachment
* is created into the main blog page, not the actual post page,
* because we do not know it at this point.
*
* @param blogid The id of the blog.
* @param username The username to use
* @param password The password
* @param content As per the MetaweblogAPI contract
* @return As per the MetaweblogAPI contract
* @throws XmlRpcException If something goes wrong
*
*/
public Hashtable newMediaObject( String blogid,
String username,
String password,
Hashtable content )
throws XmlRpcException
{
WikiEngine engine = m_context.getEngine();
String url = "";
log.info("metaWeblog.newMediaObject() called");
WikiPage page = engine.getPage( blogid );
checkPermissions( page, username, password, "upload" );
String name = (String) content.get( "name" );
byte[] data = (byte[]) content.get( "bits" );
AttachmentManager attmgr = engine.getAttachmentManager();
try
{
Attachment att = new Attachment( engine, blogid, name );
att.setAuthor( username );
attmgr.storeAttachment( att, new ByteArrayInputStream( data ) );
url = engine.getURL( WikiContext.ATTACH, att.getName(), null, true );
}
catch( Exception e )
{
log.error( "Failed to upload attachment", e );
throw new XmlRpcException( 0, "Failed to upload media object: "+e.getMessage() );
}
Hashtable<String, Object> result = new Hashtable<String, Object>();
result.put("url", url);
return result;
}
/**
* Allows the user to edit a post. It does not allow general
* editability of wiki pages, because of the limitations of the
* metaWeblog API.
*/
boolean editPost( String postid,
String username,
String password,
Hashtable content,
boolean publish )
throws XmlRpcException
{
WikiEngine engine = m_context.getEngine();
log.info("metaWeblog.editPost("+postid+") called");
// FIXME: Is postid correct? Should we determine it from the page name?
WikiPage page = engine.getPage( postid );
checkPermissions( page, username, password, "edit" );
try
{
WikiPage entryPage = (WikiPage)page.clone();
entryPage.setAuthor( username );
WikiContext context = new WikiContext( engine, entryPage );
StringBuffer text = new StringBuffer();
text.append( "!"+content.get("title") );
text.append( "\n\n" );
text.append( content.get("description") );
log.debug("Updating entry: "+text);
engine.saveText( context, text.toString() );
}
catch( Exception e )
{
log.error("Failed to create weblog entry",e);
throw new XmlRpcException( 0, "Failed to update weblog entry: "+e.getMessage() );
}
return true;
}
/**
* Gets the text of any page. The title of the page is parsed
* (if any is provided).
*/
Hashtable getPost( String postid,
String username,
String password )
throws XmlRpcException
{
String wikiname = "FIXME";
WikiPage page = m_context.getEngine().getPage( wikiname );
checkPermissions( page, username, password, "view" );
return makeEntry( page );
}
}