cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hu...@apache.org
Subject cvs commit: xml-cocoon2/src/scratchpad/src/org/apache/cocoon/acting ExtendedResourceExistsAction.java LinkTranslatorMapAction.java
Date Mon, 06 Jan 2003 21:56:00 GMT
huber       2003/01/06 13:56:00

  Added:       src/scratchpad/src/org/apache/cocoon/acting
                        ExtendedResourceExistsAction.java
                        LinkTranslatorMapAction.java
  Log:
  initial version
  
  Revision  Changes    Path
  1.1                  xml-cocoon2/src/scratchpad/src/org/apache/cocoon/acting/ExtendedResourceExistsAction.java
  
  Index: ExtendedResourceExistsAction.java
  ===================================================================
  /*
  
   ============================================================================
                     The Apache Software License, Version 1.1
   ============================================================================
  
   Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
  
   Redistribution and use in source and binary forms, with or without modifica-
   tion, are permitted provided that the following conditions are met:
  
   1. Redistributions of  source code must  retain the above copyright  notice,
      this list of conditions and the following disclaimer.
  
   2. Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
  
   3. The end-user documentation included with the redistribution, if any, must
      include  the following  acknowledgment:  "This product includes  software
      developed  by the  Apache Software Foundation  (http://www.apache.org/)."
      Alternately, this  acknowledgment may  appear in the software itself,  if
      and wherever such third-party acknowledgments normally appear.
  
   4. The names "Apache Cocoon" and  "Apache Software Foundation" must  not  be
      used to  endorse or promote  products derived from  this software without
      prior written permission. For written permission, please contact
      apache@apache.org.
  
   5. Products  derived from this software may not  be called "Apache", nor may
      "Apache" appear  in their name,  without prior written permission  of the
      Apache Software Foundation.
  
   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   FITNESS  FOR A PARTICULAR  PURPOSE ARE  DISCLAIMED.  IN NO  EVENT SHALL  THE
   APACHE SOFTWARE  FOUNDATION  OR ITS CONTRIBUTORS  BE LIABLE FOR  ANY DIRECT,
   INDIRECT, INCIDENTAL, SPECIAL,  EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLU-
   DING, BUT NOT LIMITED TO, PROCUREMENT  OF SUBSTITUTE GOODS OR SERVICES; LOSS
   OF USE, DATA, OR  PROFITS; OR BUSINESS  INTERRUPTION)  HOWEVER CAUSED AND ON
   ANY  THEORY OF LIABILITY,  WHETHER  IN CONTRACT,  STRICT LIABILITY,  OR TORT
   (INCLUDING  NEGLIGENCE OR  OTHERWISE) ARISING IN  ANY WAY OUT OF THE  USE OF
   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  
   This software  consists of voluntary contributions made  by many individuals
   on  behalf of the Apache Software  Foundation and was  originally created by
   Stefano Mazzocchi  <stefano@apache.org>. For more  information on the Apache
   Software Foundation, please see <http://www.apache.org/>.
  
  */
  package org.apache.cocoon.acting;
  
  import org.apache.avalon.framework.parameters.Parameters;
  import org.apache.avalon.framework.thread.ThreadSafe;
  import org.apache.cocoon.environment.Redirector;
  import org.apache.cocoon.environment.SourceResolver;
  import org.apache.excalibur.source.Source;
  
  import java.util.Map;
  import java.util.HashMap;
  
  /**
   * This action simply checks to see if a given resource exists. 
   * It checks whether the specified in the src attribute source is resolvable, or not.
   * The action returns a <code>Map</code> if it exists, setting the parameter
   * <code>resource-exists</code> to <code>true</code>, otherwise
the parameter
   * <code>resource-exists</code> is set to <code>false</code>.
   *
   * <p>Instead of src attribute, source can be specified using
   * parameter named 'url' (this is old syntax).
   *
   * You might want to test the parameter <code>resouce-exists</code> in a
   * following <code>&ltmap:select type="parameter"&gt;</code> in the
sitemap.
   *
   * @author <a href="mailto:balld@apache.org">Donald Ball</a>
   * @author <a href="mailto:huber@apache.org">Bernhard Huber</a>
   *
   * @version CVS $Id: ExtendedResourceExistsAction.java,v 1.1 2003/01/06 21:56:00 huber Exp
$
   * @since 2.1
   */
  public class ExtendedResourceExistsAction extends ComposerAction implements ThreadSafe {
  
      /**
       * This parameter name is put into the objectModel map, setting it to <code>true</code>,
       * or <code>false</code>
       */
      public final static String RESOURCE_EXISTS_PARAM_NAME = "resource-exists";
      
      /**
       * Execute the ExtendedResourceExistsAction.
       *
       * @param redirector Cocoon's redirector
       * @param resolver Cocoon's source resolver, used for testing if a source is resolvable
       * @param source the source, e.g.: index.html
       * @param parameters of this action
       * @return Map having an entry named as defined in <code>RESOURCE_EXISTS_PARAM_NAME</code>
having
       *   value <code>"true"</code>, iff source is resolvable, else having value
<code>"false"</code>.
       */
      public Map act(Redirector redirector, SourceResolver resolver, Map objectModel, String
source, Parameters parameters) throws Exception {
          String urlstring = parameters.getParameter("url", source);
          Source src = null;
          
          Map result = new HashMap();
          
          try {
              // try to resolve the source
              src = resolver.resolveURI(urlstring);
              src.getInputStream();
              
              // as no exception has been thrown assume that
              // the source exists, and is accessible
              result.put( RESOURCE_EXISTS_PARAM_NAME, "true" );
  
          } catch (Exception e) {
              
              // as an exception is thrown assume that the source
              // can not be resolved, and does not exists
              getLogger().warn( "Resource " + String.valueOf(urlstring) + " does not exist,
" +
                "set parameter " + RESOURCE_EXISTS_PARAM_NAME + " to false" );
  
              result.put( RESOURCE_EXISTS_PARAM_NAME, "false" );
          } finally {
              // do houskeeping release the resolved src
              resolver.release(src);
          }
          return result;
      }
  }
  
  
  
  
  1.1                  xml-cocoon2/src/scratchpad/src/org/apache/cocoon/acting/LinkTranslatorMapAction.java
  
  Index: LinkTranslatorMapAction.java
  ===================================================================
  /*
   *  The Apache Software License, Version 1.1
   *
   *
   *  Copyright (c) 2001 The Apache Software Foundation.  All rights
   *  reserved.
   *
   *  Redistribution and use in source and binary forms, with or without
   *  modification, are permitted provided that the following conditions
   *  are met:
   *
   *  1. Redistributions of source code must retain the above copyright
   *  notice, this list of conditions and the following disclaimer.
   *
   *  2. Redistributions in binary form must reproduce the above copyright
   *  notice, this list of conditions and the following disclaimer in
   *  the documentation and/or other materials provided with the
   *  distribution.
   *
   *  3. The end-user documentation included with the redistribution,
   *  if any, must include the following acknowledgment:
   *  "This product includes software developed by the
   *  Apache Software Foundation (http://www.apache.org/)."
   *  Alternately, this acknowledgment may appear in the software itself,
   *  if and wherever such third-party acknowledgments normally appear.
   *
   *  4. The names "Apache Cocoon" and "Apache Software Foundation" must
   *  not be used to endorse or promote products derived from this
   *  software without prior written permission. For written
   *  permission, please contact apache@apache.org.
   *
   *  5. Products derived from this software may not be called "Apache",
   *  nor may "Apache" appear in their name, without prior written
   *  permission of the Apache Software Foundation.
   *
   *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   *  DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   *  ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   *  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   *  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   *  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   *  SUCH DAMAGE.
   *  ====================================================================
   *
   *  This software consists of voluntary contributions made by many
   *  individuals on behalf of the Apache Software Foundation.  For more
   *  information on the Apache Software Foundation, please see
   *  <http://www.apache.org/>.
   */
  package org.apache.cocoon.acting;
  import java.util.HashMap;
  
  import java.util.Map;
  import org.apache.avalon.framework.logger.LogEnabled;
  import org.apache.avalon.framework.logger.Logger;
  
  import org.apache.avalon.framework.parameters.Parameters;
  import org.apache.avalon.framework.thread.ThreadSafe;
  
  import org.apache.cocoon.Constants;
  import org.apache.cocoon.environment.ObjectModelHelper;
  import org.apache.cocoon.environment.Redirector;
  import org.apache.cocoon.environment.Request;
  import org.apache.cocoon.environment.SourceResolver;
  import org.apache.cocoon.util.NetUtils;
  import org.apache.excalibur.source.Source;
  
  /**
   * This action sets a new LINK_OBJECT entry in the objectModel entry.
   *
   *@author     <a href="mailto:huber@apache.org">Bernhard Huber</a>
   *@created    16. Dezember 2002
   *@version    CVS $Id: LinkTranslatorMapAction.java,v 1.1 2003/01/06 21:56:00 huber Exp
$
   *@since      2.1
   */
  public class LinkTranslatorMapAction extends ComposerAction implements ThreadSafe {
  
      /**
       * Execute the LinkTranslatorMapAction.
       *
       *@param  redirector     Cocoon's redirector
       *@param  resolver       Cocoon's source resolver, used for testing if a source is resolvable
       *@param  source         the source, e.g.: index.html
       *@param  parameters     of this action
       *@param  objectModel    Description of the Parameter
       *@exception  Exception  Description of the Exception
       */
      public Map act(Redirector redirector, SourceResolver resolver, Map objectModel, String
source, Parameters parameters) throws Exception {
          Map linkObjectMap = (Map) objectModel.get(Constants.LINK_OBJECT);
  
          String[] parameterNames = parameters.getNames();
          for (int i = 0; i < parameterNames.length; i++) {
              String parameterName = parameterNames[i];
              final String LINK_MAP_PREFIX = "linkMap:";
              if (parameterName.startsWith(LINK_MAP_PREFIX)) {
                  String linkKey = parameterName.substring(LINK_MAP_PREFIX.length());
                  String linkValue = parameters.getParameter(parameterName, null);
  
                  if (linkValue != null) {
                      if (linkObjectMap == null) {
                          linkObjectMap = new HashMap();
                          objectModel.put(Constants.LINK_OBJECT, linkObjectMap);
                      }
                      getLogger().debug("Add mapping from " +
                              String.valueOf(linkKey) + " to " + String.valueOf(linkValue));
                      linkObjectMap.put(linkKey, linkValue);
                  }
              }
          }
  
          /*
           *  expect base = "/.."
           */
          String base = parameters.getParameter("url-base", "");
          // get the extension with starting dot
          Request request = ObjectModelHelper.getRequest(objectModel);
          String requestURI = request.getRequestURI();
  
          String extension = NetUtils.getExtension(requestURI);
          String path = NetUtils.getPath(requestURI);
          getLogger().debug("LinkMapTranslator 1 " + "path " + String.valueOf(path) );
          path = path + base;
          getLogger().debug("LinkMapTranslator 2 " + "path " + String.valueOf(path) );
          path = NetUtils.normalize(path);
  
          getLogger().debug("LinkMapTranslator 3 " +
                  "path " + String.valueOf(path) + ", " +
                  "base " + String.valueOf(base) + ", " +
                  "ext " + String.valueOf(extension));
  
          if (extension != null) {
              LinkPatternHashMap lphm = new LinkPatternHashMap(path, extension);
              lphm.setParent(linkObjectMap);
              lphm.enableLogging(getLogger());
  
              objectModel.put(Constants.LINK_OBJECT, lphm);
          }
  
          return null;
      }
  
  
      /**
       * A special links map
       *
       *@author     Administrator
       *@created    16. Dezember 2002
       *@version    CVS Version: $Id: LinkTranslatorMapAction.java,v 1.1 2003/01/06 21:56:00
huber Exp $
       */
      public static class LinkPatternHashMap extends HashMap implements LogEnabled {
          Logger logger;
          String pageExtension;
          String path;
  
          Map parent;
  
  
          /**
           *Constructor for the LinkPatternHashMap object
           *
           *@param  pageExtension  Description of the Parameter
           *@param  path           Description of the Parameter
           */
          public LinkPatternHashMap(String path, String pageExtension) {
              this.pageExtension = pageExtension;
              this.path = path;
              this.parent = null;
          }
  
  
          /**
           *  Sets the parent attribute of the LinkPatternHashMap object
           *
           *@param  parent  The new parent value
           */
          public void setParent(Map parent) {
              this.parent = parent;
          }
  
  
          /**
           * assume that LinkTranslator wants to check iff a href link
           * is a URI mapped to some URI.
           *
           *@param  key  Description of the Parameter
           *@return      Description of the Return Value
           */
          public Object get(Object key) {
              String newHref = null;
              if (key instanceof String) {
                  String keyString = (String) key;
                  final String PAGE_SCHEMA = "page:";
                  final int PAGE_SCHEMA_LENGTH = PAGE_SCHEMA.length();
  
                  // does key is a page:* URI ?
                  if (keyString.startsWith(PAGE_SCHEMA)) {
                      // strip page, append pageExtension
                      // that's the new href!
                      String strippedPageSchema = keyString.substring(PAGE_SCHEMA_LENGTH);
                      // to-do: handle parameters!!, like page:index?a=b&c=d
                      newHref = strippedPageSchema + pageExtension;
  
                      if (logger != null && logger.isDebugEnabled()) {
                          logger.debug("href " + String.valueOf(keyString) + " mapped to "
+ String.valueOf(newHref));
                      }
                  }
  
                  if (newHref == null) {
                      // try simple get
                      newHref = (String) super.get(key);
                      if (newHref == null && parent != null) {
                          // if parent is defined try parent get
                          newHref = (String) parent.get(key);
                      }
                  }
  
                  if (newHref == null) {
                      newHref = keyString;
                  }
  
                  // strip path
                  logger.debug("newHref " + String.valueOf(newHref) + ", " + " path " + String.valueOf(path));
                  if (newHref.startsWith(this.path)) {
                      final int pathLength = path.length();
  
                      newHref = newHref.substring(pathLength);
                      if (newHref.startsWith("/") && newHref.length() > 1) {
                          newHref = newHref.substring(1);
                      }
                  }
                  logger.debug("newHref stripped " + String.valueOf(newHref));
              }
  
              // now nearly finished
              Object result = null;
  
              if (newHref != null) {
                  // if href is non null, take it as result
                  result = newHref;
              } else {
                  // try simple get
                  result = super.get(key);
                  if (result == null && parent != null) {
                      // if parent is defined try parent get
                      result = parent.get(key);
                  }
              }
              logger.debug("For key " + String.valueOf(key) +
                      " result is " + String.valueOf(result));
  
              return result;
          }
  
  
          /**
           *  Description of the Method
           *
           *@param  logger  Description of the Parameter
           */
          public void enableLogging(Logger logger) {
              this.logger = logger;
          }
      }
  }
  
  
  
  

----------------------------------------------------------------------
In case of troubles, e-mail:     webmaster@xml.apache.org
To unsubscribe, e-mail:          cocoon-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: cocoon-cvs-help@xml.apache.org


Mime
View raw message