This vote is a proposal for how to move the scanpage class out of the core.
The scanpage class is replaced in the core by
org.mmbase.util.PageContext. This small container class acts as a wrapper for HttpServletRequest and HttpServletResponse.
The scanpage class will extend PageContext and be passed by SCAN, so that old scan classes can still its the functionality.
All getList(), replace(), and process() methods in MMObjectBuilder or ProcessorModule classes need to be adapted. In most cases only the parameter types will need to be changed. getList() no longer throws ParseException, so the throws clause should also be removed.
Also, the TransactionHandlerInterface needs to be changed (it also uses sessionInfo, so it needed to changed anyway).
This change is for MMBase 1.8.
START OF VOTING: 2004-10-05 15:30 END OF CALL: 2004-10-08 15:30
[_] +1 (YES) [_] +0 (ABSTAIN ) [_] -1 (NO), because : [_] VETO, because:
-- Pierre van Rooden Mediapark, C 107 tel. +31 (0)35 6772815 "Never summon anything bigger than your head."
/*
This software is OSI Certified Open Source Software. OSI Certified is a certification mark of the Open Source Initiative. The license (Mozilla version 1.0) can be read at the MMBase site. See http://www.MMBase.org/license */ package org.mmbase.util; import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; /** * The PageContext is a container class. * Needed for the ProcessorInterface. * * @since MMBase 1.8 * @author Pierre van Rooden * @version $Id$ */ public class PageContext { /** * The request object associated with the current page. * Not a very good name - and should not be public, but needed for * backward compatibility witH SCAN */ public HttpServletRequest req; /** * The response object associated with the current page. * Not a very good name - and should not be public, but needed for * backward compatibility witH SCAN */ public HttpServletResponse res; /** */ public PageContext() {} /** */ public PageContext(ServletRequest request, ServletResponse response) { setRequest((HttpServletRequest)request); setResponse((HttpServletResponse)response); } public HttpServletRequest getRequest() { return req; } public void setRequest(HttpServletRequest request) { req = request; } public HttpServletResponse getResponse() { return res; } public void setResponse(HttpServletResponse response) { res = response; } }
/* This software is OSI Certified Open Source Software. OSI Certified is a certification mark of the Open Source Initiative. The license (Mozilla version 1.0) can be read at the MMBase site. See http://www.MMBase.org/license */ package org.mmbase.util; import java.net.InetAddress; import java.net.UnknownHostException; import java.util.Vector; import javax.servlet.ServletConfig; import javax.servlet.ServletContext; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.mmbase.module.ProcessorInterface; import org.mmbase.module.sessionInfo; import org.mmbase.module.sessionsInterface; import org.mmbase.servlet.JamesServlet; import org.mmbase.util.logging.Logger; import org.mmbase.util.logging.Logging; /** * The scanpage is a container class. * It holds all information that is needed to identify a user, including * servlet objects and MMBase session information. * It was introduced to make [EMAIL PROTECTED] org.mmbase.servlet.servscan} threadsafe but will probably in the future * hold all request related information, because we want to extend the model * of offline page generation. * * @application SCAN, this class will be troubelsome to move as it is used in MMObjectBuilder and ProcessorModule * @rename ScanPage * @author Daniel Ockeloen * @version $Id: scanpage.java,v 1.26 2004/10/01 08:41:12 pierre Exp $ */ public class scanpage extends PageContext { // logger private static Logger log = Logging.getLoggerInstance(scanpage.class.getName()); /** * The parameters of this page. * These are either set mnaually using [EMAIL PROTECTED] #setParamsVector}, or * determined from the page using the [EMAIL PROTECTED] #req} field */ public Vector params; /** * The processor set for this page. * This values is set and used by scanparser to determine the default * processor to call when interpreting LIST tags. */ public ProcessorInterface processor; /** * Object for accessing values sent by a form using * enctype multipart/form-data. */ public HttpPost poster; /** * The user's MMBase session object, if available. */ public sessionInfo session=null; /** * The session name. */ public String sname=null; public String name=null; public int rstatus=0; public String body; public String req_line; public String wantCache=null; public String mimetype=null; public String querystring=null; public int partlevel=0; public String loadmode="cache"; /** * Indicates whether elements sucha s 'multilevel' should be reloaded, or * whether results stored in cache should be used. */ public boolean reload=false; /** * Empty constructor for code not yet fixed, constructing its own scanpage * Should use new constructor if possible. */ public scanpage() {} /** * Construct a scanpage for a servlet */ public scanpage(JamesServlet servlet, HttpServletRequest req, HttpServletResponse res, sessionsInterface sessions) { super(req,res); req_line = req.getServletPath(); querystring = req.getQueryString(); // needs to be replaced (get the context ones) ServletConfig sc = servlet.getServletConfig(); ServletContext sx = sc.getServletContext(); mimetype = sx.getMimeType(req_line); if (mimetype==null) mimetype = "text/html"; sname = servlet.getCookie(req, res); if (sessions!=null) session = sessions.getSession(this, sname); CheckEditorReload(); } /** * Check whether the page, multilevels etc may be fetched from the caches * or they should be (re-)calculated/retrieved. The session variable RELOAD * will be checked, if it contains the value "R" and the sessionvariable * RELOADTIME contains a time less than the const EXPIRE seconds ago, then * the request for reload will be honoured. * @return the method returns void and sets the field reload to true or false */ private final static int EXPIRE = 120; void CheckEditorReload() { reload = false; // try to obtain and set the reload mode. if (session==null) return; String s=session.getValue("RELOAD"); if ((s==null) || !s.equals("R")) return; // check if it expired s = session.getValue("RELOADTIME"); if (s!=null) { try { int then=Integer.parseInt(s); int now= (int)(System.currentTimeMillis()/1000); if ((now-then)<EXPIRE) { reload = true; if (log.isDebugEnabled()) { log.debug("CheckEditorReload remote user:"+HttpAuth.getRemoteUser(req)); } } else { if (log.isDebugEnabled()) log.debug("CheckEditorReload, reload expired for remote user:"+HttpAuth.getRemoteUser(req)); } } catch(Exception e) {} } if (!reload) session.setValue("RELOAD","N"); } /** * Sets the HttpServletRequest. * This method is invoked either by the MMBase servlets, or through the MMCI. */ public void setReq(HttpServletRequest req) { setRequest(req); } /** * Sets the HttpServletResponse. * This method is invoked either by the MMBase servlets, or through the MMCI. */ public void setRes(HttpServletResponse res) { setResponse(res); } /** * Get the parameter specified. * @param num index of the parameter to retrieve * @return the parametervalue */ public String getParam(int num) { String str; if (params==null) { params=buildparams(); } try { str=(String)params.elementAt(num); } catch(IndexOutOfBoundsException e) { str=null; } return str; } /** * Parse the querystring of the current page to retrieve all paarmeters * @return a <code>Vector</code> of parameter values */ private Vector buildparams() { Vector params=new Vector(); if (querystring!=null) { String paramline=querystring; //StringTokenizer tok=new StringTokenizer(querystring,"+\n\r",true); int pos=paramline.indexOf("+"); while(pos!=-1) { params.addElement(paramline.substring(0,pos)); paramline=paramline.substring(pos+1); pos=paramline.indexOf("+"); } params.addElement(paramline); } return params; } /** * Manually set the parameters of a page. * @param params a <code>Vector</code> of parameter values */ public boolean setParamsVector(Vector params) { this.params=params; return true; } /** * Retrieve all parameters of a page. * @return a <code>Vector</code> of parameter values */ public Vector getParamsVector() { if (params==null) params=buildparams(); if (params.size()==0) return null; return params; } /** * Manually set the parameterline of a page (as if it was a querystring). * @param paramline a string containing teh parametervalues seperated by '+' characters */ public boolean setParamsLine(String paramline) { this.params=new Vector(); //StringTokenizer tok=new StringTokenizer(paramline,"+\n\r"); // rico int pos=paramline.indexOf("+"); while(pos!=-1) { params.addElement(paramline.substring(0,pos)); paramline=paramline.substring(pos+1); pos=paramline.indexOf("+"); } params.addElement(paramline); return true; } /** * Retrieve a HTTP request header, if available * @param name the name of the header * @return the header, <code>nul</code> if it can not be retrieved */ public String getHeader(String name) { if (req!=null) { return req.getHeader(name); } else { return null; } } /** * Return the session name. */ public String getSessionName() { return sname; } /** * Set the session name. */ public void setSessionName(String name) { this.sname=name; } // ------------------------------------------------------------------------------------------------------------ /** * Return page URL and parameters */ public String getUrl() { String result = null; if( req != null ) { result = req.getRequestURI(); if( req.getQueryString() != null ) result += "?" + req.getQueryString(); return result; } else { return null; } } // ------------------------------------------------------------------------------------------------------------ private static String VPROProxyName = "vpro6d.vpro.nl"; // name of proxyserver private static String VPROProxyAddress = "145.58.172.6"; // address of proxyserver // methods // ------- /** * Extract hostname from scanpage, get address and determine the proxies between it. * Needed to determine if user comes from internal or external host, because * we use two streaming servers, one for external users and one for internal users. * <br /> * input : scanpage sp, contains hostname as ipaddress<br /> * output : String "clientproxy.clientside.com->dialin07.clientside.com"<br /> * <br /> * uses : VPROProxyName, VPROProxyAddress */ public String getAddress() { String result = null; boolean fromProxy = false; String addr = req.getRemoteHost(); // check whether the user came through a proxy // This code tests for a specific vpro proxy server // should probably be made generic // Not sure how to do this, maybe just test for X-Forwarded-For header? if( addr != null && (addr.indexOf( VPROProxyName ) != -1 || addr.indexOf( VPROProxyAddress ) != -1 )) { // get real address fromProxy = true; addr = req.getHeader("X-Forwarded-For"); } if (addr != null) { // get hostnames for this user result = getHostNames( addr ); // extend the path with a proxy (?) server // vpro specific server, so should be made generic // (no idea how, maybe make configurable?) if( fromProxy ) { result = "zen.vpro.nl->" + result; } } return result; } /** * Determine the host names of a String containing a comma-separated list of * ip addresses and/or host names. * Used to retrieve a list of proxies. * @param host an comma-seperated String containing ip-addressed and/or host names * @return a strong containing hostnames separated by "->" tokens */ private String getHostNames(String host) { String result = null; String hn = null; // comes client from his own proxy? // -------------------------------- if( host.indexOf(",") != -1 ) { int pos; // filter and display the clientproxies // ------------------------------------ while( (pos = host.indexOf(",")) != -1 ) { hn = host.substring( 0, pos ); host = host.substring( pos + 2 ); if( result == null ) result = getHostName( hn ); else result += "->" + getHostName( hn ); } // which results in "proxy.clientside.com->dailin07.clientside.com" } else { result = getHostName( host ); } return result; } /** * Determine the host name of a passed ip address or host name. * If the passed parameter is an IP-address, the hostname for * that address is retrieved if possible. * @param hostname an ip-address or host name * @return the resulting hostname */ private String getHostName( String hostname ) { // if hostname == ipaddress, try to get a hostname for it String hn = hostname; if( hn != null && !hn.equals("")) { try { hn = InetAddress.getByName( hostname ).getHostName(); } catch( UnknownHostException e) { } } return hn; } /** * Gets the referrer from the request header. * @return a <code>String</code> with the referer, * <code>null</code> when reqheader is <code>null</code>. */ public String getReferer() { if (req==null) { log.error("scanpage:getReferer: req="+req+", can't get referer."); return null; } else { return req.getHeader("Referer"); } } /** * Creates a duplicate of this scanpage * @return the duplicate scanpage */ public scanpage duplicate() { scanpage dup=new scanpage(); dup.res=null; dup.req=null; dup.params=null; dup.processor=this.processor; dup.session=this.session; dup.sname=this.sname; dup.name=this.name; dup.rstatus=this.rstatus; dup.body=this.body; dup.req_line=this.req_line; dup.wantCache=this.wantCache; dup.mimetype=this.mimetype; dup.querystring=this.querystring; dup.partlevel=this.partlevel; dup.loadmode=this.loadmode; dup.reload=this.reload; return dup; } }
/* This software is OSI Certified Open Source Software. OSI Certified is a certification mark of the Open Source Initiative. The license (Mozilla version 1.0) can be read at the MMBase site. See http://www.MMBase.org/license */ package org.mmbase.module; import java.util.*; import org.mmbase.module.core.*; import org.mmbase.util.*; /** * @javadoc */ public interface ProcessorInterface { /** * Returns a virtual builder. * Used to create node lists from the results returned by [EMAIL PROTECTED] #getList}. * The default method does not associate the builder with a cloud (mmbase module), * so processormodules that need this association need to override this method. * Note that different lists may return different builders. * @param command the LIST command for which to retrieve the builder * @param params contains the attributes for the list */ public MMObjectBuilder getListBuilder(String command, Map params); /** * Generate a list of values from a command to the processor. * The values are grouped into nodes. * @param context the context of the page or calling application (currently, this should be a PageContext object) * @param command the list command to execute. * @param params contains the attributes for the list * @return a <code>Vector</code> that contains the list values contained in MMObjectNode objects */ public Vector getNodeList(Object context, String command, Map params); /** * Generate a list of values from a command to the processor. * @param sp the page context * @param tagger contains the attributes for the list * @param command the list command to execute. */ public Vector getList(PageContext context, StringTagger tagger, String value); /** * Execute the commands provided in the form values. * @param sp the page context * @param cmds contains the list of commands to run * @param vars contains the attributes for the process */ public boolean process(PageContext context, Hashtable cmds, Hashtable vars); /** * Replace a command by a string. * @param sp the page context * @param command the command to execute. */ public String replace (PageContext context, String command); /** * Replace a command by a string. * @param sp the page context * @param command the command to execute */ public String replace (PageContext context, StringTagger command); /** * Do a cache check (304) for this request. * @param sp the page context * @param command the command to execute. */ public boolean cacheCheck(PageContext context, String command); }
/* This software is OSI Certified Open Source Software. OSI Certified is a certification mark of the Open Source Initiative. The license (Mozilla version 1.0) can be read at the MMBase site. See http://www.MMBase.org/license */ package org.mmbase.module; import org.mmbase.util.*; /** * interface for TransactionHandler * * @move to org.mmbase.applications.xmlimporter.TransactionHandlerInterface * @author John balder * @version $Id: TransactionHandlerInterface.java,v 1.5 2003/08/29 09:36:52 pierre Exp $ */ public interface TransactionHandlerInterface { public void handleTransaction(String template, String userId, PageContext sp); }
