You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by ro...@apache.org on 2004/11/03 21:32:18 UTC
cvs commit: jakarta-jetspeed-2/portals-bridges/perl/src/java/org/apache/portals/bridges/perl PerlPortlet.java PerlParameters.java
rogerrut 2004/11/03 12:32:18
Added: portals-bridges/perl project.properties project.xml
portals-bridges/perl/src/java/org/apache/portals/bridges/perl
PerlPortlet.java PerlParameters.java
Log:
Moved per portlet code from Application/perl into portals-bridges
Added action processing to perl portlet. Using actions when a user navigates inside the portlet (links in perl/cgi script)
Part of the cleanup effort for the upcoming release
Revision Changes Path
1.1 jakarta-jetspeed-2/portals-bridges/perl/project.properties
Index: project.properties
===================================================================
# Copyright 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.
#
# $Id: project.properties,v 1.1 2004/11/03 20:32:18 rogerrut Exp $
maven.multiproject.type=jar
maven.license.licenseFile=${basedir}/../../LICENSE.TXT
1.1 jakarta-jetspeed-2/portals-bridges/perl/project.xml
Index: project.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 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.
$Id: project.xml,v 1.1 2004/11/03 20:32:18 rogerrut Exp $
-->
<project>
<extend>${basedir}/../../project.xml</extend>
<pomVersion>3</pomVersion>
<groupId>portals-bridges</groupId>
<id>portals-bridges-perl</id>
<name>Apache Portals Perl Framework Bridge</name>
<currentVersion>0.1</currentVersion>
<package>org.apache.portals.bridges.perl</package>
<description>
Apache Portals Perl Framework Bridge
</description>
<shortDescription>Apache Portals Perl Framework Bridge</shortDescription>
<repository>
<connection>scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic:jakarta-jetspeed-2/portals-bridges/perl</connection>
<url>http://cvs.apache.org/viewcvs/jakarta-jetspeed-2/portals-bridges/perl/</url>
</repository>
<developers>
<developer>
<name>Roger Ruttimann</name>
<id>rogerrut</id>
<email>rogerrut@apache.org</email>
<roles>
<role>Java Developer</role>
</roles>
</developer>
</developers>
<dependencies>
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.0.3</version>
</dependency>
<dependency>
<groupId>portlet-api</groupId>
<artifactId>portlet-api</artifactId>
<version>1.0</version>
</dependency>
<dependency>
<groupId>servletapi</groupId>
<artifactId>servletapi</artifactId>
<version>2.3</version>
</dependency>
<dependency>
<groupId>portals-bridges</groupId>
<artifactId>portals-bridges-common</artifactId>
<version>0.1</version>
</dependency>
</dependencies>
<build>
<sourceDirectory>src/java</sourceDirectory>
</build>
<reports>
<report>maven-jdepend-plugin</report>
<!--
<report>maven-checkstyle-plugin</report>
-->
<report>maven-pmd-plugin</report>
<report>maven-changelog-plugin</report>
<report>maven-file-activity-plugin</report>
<report>maven-developer-activity-plugin</report>
<report>maven-license-plugin</report>
<report>maven-javadoc-plugin</report>
<report>maven-jxr-plugin</report>
<report>maven-junit-report-plugin</report>
<report>maven-jcoverage-plugin</report>
<report>maven-linkcheck-plugin</report>
<report>maven-tasklist-plugin</report>
</reports>
</project>
1.1 jakarta-jetspeed-2/portals-bridges/perl/src/java/org/apache/portals/bridges/perl/PerlPortlet.java
Index: PerlPortlet.java
===================================================================
/*
* Copyright 2000-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.portals.bridges.perl;
import javax.portlet.GenericPortlet;
import java.io.BufferedReader;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.util.Iterator;
import javax.servlet.http.HttpServletRequestWrapper;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
import javax.portlet.PortletConfig;
import javax.portlet.PortletException;
import javax.portlet.PortletURL;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
import javax.portlet.PortletSession;
import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;
import javax.servlet.http.HttpServletRequest;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* This portlet is executes a Perl/cgi files in a portlet.
*
* @author <a href="mailto:rogerrut@apache.org">Roger Ruttimann</a>
* @version $Id: PerlPortlet.java,v 1.1 2004/11/03 20:32:18 rogerrut Exp $
*/
public class PerlPortlet extends GenericPortlet {
/**
* INIT parameters required by the Perl Portlet:PerlScript, ScriptPath, DemoMode
*
* Name of the scrip to to execute
*/
public static final String PARAM_PERL_SCRIPT = "PerlScript";
/**
* Name of the Script Path where the perl scripts (among others) are located
*/
public static final String PARAM_SCRIPT_PATH = "ScriptPath";
/**
* DemoMode on or off
*/
public static final String PARAM_DEMO_MODE = "DemoMode";
// Local variables
private final String ACTION_PARAMETER_PERL = "_PERL";
private String perlScript = "perl-demo.cgi";
private String scriptPath = "cgi-bin";
// Switch that shows basic information about the perl script to run
private boolean bDemoMode = false;
private static final Log log = LogFactory.getLog(PerlPortlet.class);
// caching status -- cache the last query
private String lastQuery = null;
public void init(PortletConfig config) throws PortletException
{
super.init(config);
// Get the INIT PARAMETERS for this portlet. If the values are missing
// throw an exception
scriptPath = config.getInitParameter(PARAM_SCRIPT_PATH);
perlScript = config.getInitParameter(PARAM_PERL_SCRIPT);
String demoMode = config.getInitParameter(PARAM_DEMO_MODE);
if (demoMode != null && demoMode.compareToIgnoreCase("on") == 0)
bDemoMode = true;
if (scriptPath == null)
throw new PortletException("Portlet " + config.getPortletName()
+ " is incorrectly configured. Init parameter "
+ PARAM_SCRIPT_PATH + " not specified");
if (perlScript == null)
throw new PortletException("Portlet " + config.getPortletName()
+ " is incorrectly configured. Init parameter "
+ PARAM_PERL_SCRIPT + " not specified");
}
/**
* processAction()
* Checks action initiated by the perl portlet (invoking other perl scripts)
* @param actionRequest
* @param actionResponse
* @throws PortletException
* @throws IOException
*/
public void processAction(ActionRequest actionRequest, ActionResponse actionResponse) throws PortletException, IOException
{
String perlParameter = actionRequest.getParameter(ACTION_PARAMETER_PERL);
//System.out.println("Action parameter for perl " + perlParameter);
/*
* If the perlParameter is not empty create a PerlParameter object and attach it to the session
*/
if ( perlParameter != null && perlParameter.length() > 0)
{
// Separate the values before and after the Query Mark ?
int ixQuery = perlParameter.indexOf('?');
if ( ixQuery != -1)
{
PerlParameters cgi = new PerlParameters();
cgi.setPerlScript(perlParameter.substring(0,ixQuery));
String queryArguments = perlParameter.substring(ixQuery+1);
System.out.println("ProcessRequest -- Script " + perlParameter.substring(0,ixQuery) + " Query string " + queryArguments);
int ixQuerySeparator = queryArguments.indexOf('&');
while ( ixQuerySeparator != -1)
{
cgi.addQueryArgument(queryArguments.substring(0, ixQuerySeparator));
queryArguments = queryArguments.substring(ixQuerySeparator+1);
ixQuerySeparator = queryArguments.indexOf('&');
}
cgi.addQueryArgument(queryArguments);
// Add the PerlParameters to the session
actionRequest.getPortletSession().setAttribute("SELECTED_VIEW", cgi, PortletSession.APPLICATION_SCOPE);
}
}
}
/**
* doView
* Executes the perl script that is defined by the property PerlScript.
* If the incoming request has the query perl-script= defined this script will be executed.
*/
public void doView(RenderRequest request, RenderResponse response)
throws PortletException, IOException
{
// Set the content type
response.setContentType("text/html");
// Get a writer object that can be used to generate the output
HttpServletResponse httpResponse = (HttpServletResponse)((HttpServletResponseWrapper) response).getResponse();
//PrintWriter writer = response.getWriter();
PrintWriter writer = httpResponse.getWriter();
String query = null;
String scriptName = null;
PerlParameters perlParam = null;
/**
* The Perl parameters are either passed by a session attribute (invoked through an action) or as a query string (invoked from the cgi itself).
* The portlet checks first for the query (navigation inside the perl portlet) and then if a session attribute (SELECTED_VIEW) was defined.
*/
// Extract the Query string -- Request initiated from inside the CGI script. This allows navigation within the CGI
String queryString = ((HttpServletRequest)((HttpServletRequestWrapper) request).getRequest()).getQueryString();
if (queryString != null)
{
query = queryString;
// Find the perl script -- last argument
String url = ((HttpServletRequest)((HttpServletRequestWrapper) request).getRequest()).getRequestURI();
perlScript = url.substring(url.lastIndexOf('/')+1);
}
else
{
try
{
perlParam = (PerlParameters)request.getPortletSession().getAttribute("SELECTED_VIEW", PortletSession.APPLICATION_SCOPE);
}
catch (Exception e )
{
perlParam = null;
}
if (perlParam != null)
{
query = perlParam.getQueryString();
perlScript = perlParam.getPerlScript();
}
}
// Open the perl script and extract the perl executable path. It's the same way as apache HTTP executes PERL
String pathTranslated = ((HttpServletRequest)((HttpServletRequestWrapper) request).getRequest()).getPathTranslated();
String contextPath = request.getContextPath();
contextPath = pathTranslated.substring(0, pathTranslated.indexOf("webapps") + 7) + contextPath + "/";
//String contextPath = ((JetspeedPortletContext)this.getPortletContext()).getServletContext().getRealPath( ((HttpServletRequestWrapper) request).getServletPath());
String perlExecutable = null;
//String rootContextPath = contextPath.substring(0, contextPath.lastIndexOf("container") ) ;
contextPath += scriptPath;
contextPath += "/";
String inputPath = contextPath;
contextPath += perlScript;
// command to execute
String command = null;
// Open the script and read the first line to get the executable !/usr/bin/perl OR !c:\bin\perl\perl.exe
try
{
BufferedReader in= new BufferedReader(new FileReader(contextPath));
String lnExecutable = in.readLine();
if (lnExecutable != null )
{
// Make sure that the executable is defined -- could be a compiled cgi with no executable defined
String lnExecutableLower = lnExecutable.toLowerCase();
int px = lnExecutableLower.indexOf("perl");
int ix = lnExecutable.indexOf('!');
if ( ix != -1 && px != -1 )
{
perlExecutable = lnExecutable.substring(ix+1, lnExecutable.indexOf(' ',ix));
}
}
//Close file
in.close();
StringBuffer commandBuffer = new StringBuffer();
if (perlExecutable == null)
commandBuffer.append(contextPath);
else
commandBuffer.append(perlExecutable).append(' ').append(contextPath);
command = new String(commandBuffer.toString());
}
catch(FileNotFoundException e)
{
writer.println("<P><B>File doesn't exist (" + contextPath + ")</B></P>");
}
catch(IOException e)
{
writer.println("<P><B>IO Exception (" + e.getMessage() + ")</B></P>");
}
catch(Exception e)
{
writer.println("<P><B>IO Exception (" + e.getMessage() + ")</B></P>");
}
String envQuery = "QUERY_STRING=" + query ;
String[] env = null;
env = new String[]{"REQUEST_METHOD=GET", envQuery};
if ( bDemoMode == true)
{
// Script info. This is for the Demo only
writer.println("<P>The portlet executes the perl script defined by the init-params. If you don't get an output make sure that the perl executable defined in the script is valid.");
writer.println("The executable is defined on the first line of your script.</P>Examples<ul><li><B>UNIX/Linux:</B>!/usr/bin/perl</li><li><B>Windows:</B>!c:\\bin\\perl\\perl.exe</li></ul>");
writer.println("<B><P>Perl Script:</B>" + contextPath + "<BR>");
writer.println("<B>Perl executable:</B>" + perlExecutable + "<BR>");
writer.println("<B>Query String:</B>" + query + "</P>");
}
//Execute the perl script from the command line
if (command != null )
{
// Execute command in a separate process. The perl output is written to the stdout
try
{
// Start process
Process proc = Runtime.getRuntime().exec(command,env);
// Get stdout of process and create a buffered reader
InputStream in = proc.getInputStream();
BufferedReader perlResult = new BufferedReader(new InputStreamReader(in));
StringBuffer page = new StringBuffer();
//Wait until proc is done
boolean bProcDone = false;
while (bProcDone == false)
{
try
{
proc.exitValue() ;
bProcDone = true;
}
catch(IllegalThreadStateException e)
{
bProcDone = false; //Not done yet
// Read the buffer otherwise the process will be blocked because it can't write to the stdout (max size of buffer)
int ln;
while ((ln = perlResult.read()) != -1)
{
char c = (char)ln;
if (c != '\n' && c != '\r')
page.append((char)ln);
}
}
}
// Perl execution done read the remaining buffer
int ln = -1;
while ((ln = perlResult.read()) != -1)
{
char c = (char)ln;
if (c != '\n' && c != '\r')
page.append((char)ln);
}
// Close stream
perlResult.close();
// Post Process for generated page
// Any HREFs should be extended with the ActionURL
PortletURL actionURL = response.createActionURL();
String finalPage = processHREFS("<a", ">", "href=", "\'", page.toString(), actionURL);
finalPage = processHREFS("<A", ">", "HREF=", "\'", finalPage, actionURL);
finalPage = processHREFS("<AREA", ">", "href=", "\'", finalPage, actionURL);
// Write the page
//writer.println(page.toString());
writer.println(finalPage);
}
catch(IOException ioe)
{
writer.println("<P><B>Exception while reading perl output" + ioe.getMessage() + "</B></P>");
}
}
}
private String processHREFS(String startTag, String endTag, String ref, String quote, String inputPage, PortletURL actionURL)
{
StringBuffer finalPage = new StringBuffer();
String page = inputPage;
int ixTagOpen, ixTagEnd, ixRefStart, ixRefEnd;
ref = ref + quote;
// Start search
ixTagOpen = page.indexOf(startTag);
try
{
while (ixTagOpen != -1 )
{
finalPage.append(page.substring(0, ixTagOpen));
page = page.substring(ixTagOpen);
ixTagEnd = page.indexOf(endTag);
ixRefStart = page.indexOf(ref);
//If reference start tag is after endTag it means that the Tag doesn't include any source links
// just continue...
if ( ixRefStart == -1 || ixRefStart > ixTagEnd )
{
finalPage.append(page.substring(0, ixTagEnd));
page = page.substring(ixTagEnd);
}
else
{
ixRefStart = ixRefStart + ref.length();
finalPage.append(page.substring(0, ixRefStart));
page = page.substring(ixRefStart);
ixRefEnd = page.indexOf(quote);
// Extract the URL
String url = page.substring(0, ixRefEnd);
// Prepend the Action URL
actionURL.setParameter(ACTION_PARAMETER_PERL, url);
finalPage.append(actionURL.toString()).append(quote);
//Remainder
page = page.substring(ixRefEnd+1);
}
// Continue scan
ixTagOpen = page.indexOf(startTag);
}
finalPage.append(page);
}catch(Exception e)
{
System.out.println("ERROR: Exception in processHREFS " + e.getMessage() );
}
return finalPage.toString();
}
}
1.1 jakarta-jetspeed-2/portals-bridges/perl/src/java/org/apache/portals/bridges/perl/PerlParameters.java
Index: PerlParameters.java
===================================================================
/*
* Copyright 2000-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.portals.bridges.perl;
/**
* PerlParameters
* Class holding information about the perl script to execute.This class is typically attached to a PortletAction (as an attribute).
*
* @author <a href="mailto:rogerrut@apache.org">Roger Ruttimann</a>
* @version $Id: PerlParameters.java,v 1.1 2004/11/03 20:32:18 rogerrut Exp $
*/
public class PerlParameters {
private String requestMethod = "GET";
private String queryString = null;
private String perlScript = null;
private String displayMessage = null;
// Getters and setters
public void setRequestMethod(String requestMethod)
{
this.requestMethod = requestMethod;
}
public String getRequestMethod()
{
return this.requestMethod;
}
public void addQueryArgument(String query)
{
if (queryString == null)
{
queryString = query;
}
else
{
queryString += '&';
queryString += query;
}
}
public String getQueryString()
{
return this.queryString;
}
public void setPerlScript(String script)
{
this.perlScript = script;
}
public String getPerlScript()
{
return this.perlScript;
}
public void setDisplayMessage(String msg)
{
this.displayMessage = msg;
}
public String getDisplayMessage()
{
return this.displayMessage;
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jetspeed-dev-help@jakarta.apache.org