/*
* Copyright 1999-2002,2004 The Apache Software Foundation.
*
* Licensed 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 org.apache.cocoon.portal.impl;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.apache.avalon.framework.activity.Disposable;
import org.apache.avalon.framework.context.Context;
import org.apache.avalon.framework.context.ContextException;
import org.apache.avalon.framework.context.Contextualizable;
import org.apache.avalon.framework.logger.AbstractLogEnabled;
import org.apache.avalon.framework.service.ServiceException;
import org.apache.avalon.framework.service.ServiceManager;
import org.apache.avalon.framework.service.Serviceable;
import org.apache.avalon.framework.thread.ThreadSafe;
import org.apache.cocoon.components.ContextHelper;
import org.apache.cocoon.environment.Request;
import org.apache.cocoon.portal.LinkService;
import org.apache.cocoon.portal.event.ComparableEvent;
import org.apache.cocoon.portal.event.Event;
import org.apache.cocoon.portal.event.EventConverter;
import org.apache.cocoon.portal.event.RequestEvent;
import org.apache.excalibur.source.SourceUtil;
/**
*
* @author <a href="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
* @author <a href="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a>
*
* @version CVS $Id: DefaultLinkService.java,v 1.13 2004/04/28 13:58:16 cziegeler Exp $
*/
public class DefaultLinkService
extends AbstractLogEnabled
implements ThreadSafe, LinkService, Serviceable, Disposable, Contextualizable {
/**
* Helper class containing the information about the request uri
*/
class Info {
StringBuffer linkBase = new StringBuffer();
boolean hasParameters = false;
ArrayList comparableEvents = new ArrayList(5);
}
/** The converter used to convert an event into a request parameter */
protected EventConverter converter;
/** The service manager */
protected ServiceManager manager;
/** The cocoon context */
protected Context context;
/* (non-Javadoc)
* @see org.apache.avalon.framework.service.Serviceable#service(org.apache.avalon.framework.service.ServiceManager)
*/
public void service(ServiceManager manager) throws ServiceException {
this.manager = manager;
this.converter = (EventConverter)this.manager.lookup(EventConverter.ROLE);
}
/**
* Return the current info for the request
* @return An Info object
*/
protected Info getInfo() {
final Request request = ContextHelper.getRequest( this.context );
Info info = (Info)request.getAttribute(DefaultLinkService.class.getName());
if ( info == null ) {
synchronized ( this ) {
info = (Info)request.getAttribute(DefaultLinkService.class.getName());
if ( info == null ) {
info = new Info();
request.setAttribute(DefaultLinkService.class.getName(), info);
String baseURI = request.getSitemapURI();
final int pos = baseURI.lastIndexOf('/');
if ( pos != -1 ) {
baseURI = baseURI.substring(pos+1);
}
info.linkBase.append(baseURI);
}
}
}
return info;
}
/* (non-Javadoc)
* @see org.apache.cocoon.portal.LinkService#getLinkURI(org.apache.cocoon.portal.event.Event)
*/
public String getLinkURI(Event event) {
if ( event == null ) {
return this.getRefreshLinkURI();
}
final Info info = this.getInfo();
final StringBuffer buffer = new StringBuffer(info.linkBase.toString());
boolean hasParams = info.hasParameters;
// add comparable events
final boolean comparableEvent = event instanceof ComparableEvent;
Iterator iter = info.comparableEvents.iterator();
while (iter.hasNext()) {
Object[] objects = (Object[])iter.next();
ComparableEvent current = (ComparableEvent)objects[0];
if ( !comparableEvent || !current.equalsEvent((ComparableEvent)event)) {
if ( hasParams ) {
buffer.append('&');
} else {
buffer.append('?');
}
buffer.append((String)objects[1]).append('=').append(SourceUtil.encode((String)objects[2]));
hasParams = true;
}
}
// now add event
hasParams = this.addEvent(buffer, event, hasParams);
return buffer.toString();
}
/**
* Add one event to the buffer
* @return Returns true, if the link contains a parameter
*/
protected boolean addEvent(StringBuffer buffer, Event event, boolean hasParams) {
if ( hasParams ) {
buffer.append('&');
} else {
buffer.append('?');
}
String parameterName = DEFAULT_REQUEST_EVENT_PARAMETER_NAME;
if (event instanceof RequestEvent ) {
final String eventParName = ((RequestEvent)event).getRequestParameterName();
if ( eventParName != null ) {
parameterName = eventParName;
}
}
final String value = this.converter.encode( event );
buffer.append(parameterName).append('=').append(SourceUtil.encode(value));
return true;
}
/* (non-Javadoc)
* @see org.apache.cocoon.portal.LinkService#getLinkURI(java.util.List)
*/
public String getLinkURI(List events) {
if ( events == null || events.size() == 0) {
return this.getRefreshLinkURI();
}
final Info info = this.getInfo();
boolean hasParams = info.hasParameters;
final StringBuffer buffer = new StringBuffer(info.linkBase.toString());
// add comparable events
Iterator iter = info.comparableEvents.iterator();
while (iter.hasNext()) {
Object[] objects = (Object[])iter.next();
ComparableEvent current = (ComparableEvent)objects[0];
Iterator eventIterator = events.iterator();
boolean found = false;
while (!found && eventIterator.hasNext()) {
Event inEvent = (Event)eventIterator.next();
if ( inEvent instanceof ComparableEvent
&& current.equalsEvent((ComparableEvent)inEvent)) {
found = true;
}
}
if (!found) {
if ( hasParams ) {
buffer.append('&');
} else {
buffer.append('?');
}
buffer.append((String)objects[1]).append('=').append(SourceUtil.encode((String)objects[2]));
hasParams = true;
}
}
// now add events
iter = events.iterator();
while ( iter.hasNext()) {
final Event current = (Event)iter.next();
hasParams = this.addEvent(buffer, current, hasParams);
}
return buffer.toString();
}
/* (non-Javadoc)
* @see org.apache.cocoon.portal.LinkService#addEventToLink(org.apache.cocoon.portal.event.Event)
*/
public void addEventToLink(Event event) {
if ( event == null ) {
return;
}
String parameterName = DEFAULT_REQUEST_EVENT_PARAMETER_NAME;
if (event instanceof RequestEvent ) {
final String eventParName = ((RequestEvent)event).getRequestParameterName();
if ( eventParName != null ) {
parameterName = eventParName;
}
}
final String value = this.converter.encode( event );
final Info info = this.getInfo();
if ( event instanceof ComparableEvent) {
// search if we already have an event for this!
final Iterator iter = info.comparableEvents.iterator();
boolean found = false;
while ( !found && iter.hasNext() ) {
Object[] objects = (Object[])iter.next();
if ( ((ComparableEvent)objects[0]).equalsEvent((ComparableEvent)event) ) {
found = true;
info.comparableEvents.remove(objects);
}
}
info.comparableEvents.add( new Object[] {event, parameterName, value} );
} else {
this.addParameterToLink(parameterName, value);
}
}
/* (non-Javadoc)
* @see org.apache.cocoon.portal.LinkService#addParameterToLink(java.lang.String, java.lang.String)
*/
public void addParameterToLink(String name, String value) {
final Info info = this.getInfo();
if ( info.hasParameters ) {
info.linkBase.append('&');
} else {
info.linkBase.append('?');
}
info.linkBase.append(name).append('=').append(SourceUtil.encode(value));
info.hasParameters = true;
}
/* (non-Javadoc)
* @see org.apache.cocoon.portal.LinkService#getRefreshLinkURI()
*/
public String getRefreshLinkURI() {
final Info info = this.getInfo();
final StringBuffer buffer = new StringBuffer(info.linkBase.toString());
// add comparable events
Iterator iter = info.comparableEvents.iterator();
boolean hasParams = info.hasParameters;
while (iter.hasNext()) {
Object[] objects = (Object[])iter.next();
if ( hasParams ) {
buffer.append('&');
} else {
buffer.append('?');
}
buffer.append((String)objects[1]).append('=').append(SourceUtil.encode((String)objects[2]));
hasParams = true;
}
return buffer.toString();
}
/* (non-Javadoc)
* @see org.apache.avalon.framework.activity.Disposable#dispose()
*/
public void dispose() {
if (this.manager != null) {
this.manager.release( this.converter );
this.converter = null;
this.manager = null;
}
}
/* (non-Javadoc)
* @see org.apache.avalon.framework.context.Contextualizable#contextualize(org.apache.avalon.framework.context.Context)
*/
public void contextualize(Context context) throws ContextException {
this.context = context;
}
}