/*
* 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 org.apache.lenya.cms.cocoon.components.modules.input;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Iterator;
import java.util.Map;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.cocoon.environment.ObjectModelHelper;
import org.apache.lenya.cms.publication.Document;
import org.apache.lenya.cms.publication.PageEnvelope;
import org.apache.lenya.cms.repository.RepositoryUtil;
import org.apache.lenya.cms.repository.Session;
import org.apache.lenya.cms.workflow.WorkflowUtil;
import org.apache.lenya.workflow.Version;
import org.apache.lenya.workflow.Workflow;
import org.apache.lenya.workflow.WorkflowManager;
import org.apache.lenya.workflow.Workflowable;
/**
* Module for workflow access.
*
* @version $Id: WorkflowModule.java 565823 2007-08-14 16:25:29Z rfrovarp $
*/
public class WorkflowModule extends AbstractPageEnvelopeModule {
/**
* <code>STATE</code> The state
*/
public static final String STATE = "state";
/**
* <code>VARIABLE_PREFIX</code> The variable prefix
*/
public static final String VARIABLE_PREFIX = "variable.";
/**
* The prefix to get the last user who invoked a certain event.
*/
public static final String LAST_USER_PREFIX = "lastUser.";
/**
* The prefix to get the last date at which a certain event was invoked.
* @see #DATE_FORMAT
*/
public static final String LAST_DATE_PREFIX = "lastDate.";
private final DateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
private final Object lock = new Object();
static final String[] PARAMETER_NAMES = { STATE };
/**
* @see org.apache.cocoon.components.modules.input.InputModule#getAttribute(java.lang.String,
* org.apache.avalon.framework.configuration.Configuration, java.util.Map)
*/
public Object getAttribute(String name, Configuration modeConf, Map objectModel)
throws ConfigurationException {
Object value = null;
WorkflowManager wfManager = null;
try {
PageEnvelope envelope = getEnvelope(objectModel, name);
Document document = envelope.getDocument();
if (document != null && document.exists()) {
wfManager = (WorkflowManager) this.manager.lookup(WorkflowManager.ROLE);
Session session = RepositoryUtil.getSession(this.manager,
ObjectModelHelper.getRequest(objectModel));
Workflowable workflowable = WorkflowUtil.getWorkflowable(this.manager,
session,
getLogger(),
document);
if (wfManager.hasWorkflow(workflowable)) {
Version latestVersion = workflowable.getLatestVersion();
if (name.equals(STATE)) {
if (latestVersion == null) {
Workflow workflow = wfManager.getWorkflowSchema(workflowable);
value = workflow.getInitialState();
} else {
value = latestVersion.getState();
}
} else if (name.startsWith(VARIABLE_PREFIX)) {
String variableName = name.substring(VARIABLE_PREFIX.length());
Workflow workflow = wfManager.getWorkflowSchema(workflowable);
String[] variableNames = workflow.getVariableNames();
if (Arrays.asList(variableNames).contains(variableName)) {
if (latestVersion == null) {
value = Boolean.valueOf(workflow.getInitialValue(variableName));
} else {
value = Boolean.valueOf(latestVersion.getValue(variableName));
}
}
} else if (name.startsWith(LAST_USER_PREFIX)) {
String event = name.substring(LAST_USER_PREFIX.length());
Version latestEventVersion = getLatestVersion(workflowable, event);
if (latestEventVersion != null) {
value = latestEventVersion.getUserId();
}
} else if (name.startsWith(LAST_DATE_PREFIX)) {
String event = name.substring(LAST_DATE_PREFIX.length());
Version latestEventVersion = getLatestVersion(workflowable, event);
if (latestEventVersion != null) {
synchronized(lock) {
value = this.DATE_FORMAT.format(latestEventVersion.getDate());
}
}
} else {
throw new ConfigurationException("The attribute [" + name
+ "] is not supported!");
}
}
}
} catch (ConfigurationException e) {
throw e;
} catch (Exception e) {
throw new ConfigurationException("Resolving attribute failed: ", e);
} finally {
if (wfManager != null) {
this.manager.release(wfManager);
}
}
return value;
}
protected Version getLatestVersion(Workflowable workflowable, String event) {
Version latestEventVersion = null;
Version versions[] = workflowable.getVersions();
int i = versions.length - 1;
while (i > -1 && !versions[i].getEvent().equals(event)) {
i--;
}
if (i > -1) {
latestEventVersion = versions[i];
}
return latestEventVersion;
}
/**
* @see org.apache.cocoon.components.modules.input.InputModule#getAttributeNames(org.apache.avalon.framework.configuration.Configuration,
* java.util.Map)
*/
public Iterator getAttributeNames(Configuration modeConf, Map objectModel)
throws ConfigurationException {
return Arrays.asList(PARAMETER_NAMES).iterator();
}
/**
* @see org.apache.cocoon.components.modules.input.InputModule#getAttributeValues(java.lang.String,
* org.apache.avalon.framework.configuration.Configuration, java.util.Map)
*/
public Object[] getAttributeValues(String name, Configuration modeConf, Map objectModel)
throws ConfigurationException {
Object[] objects = { getAttribute(name, modeConf, objectModel) };
return objects;
}
}