/*
    * 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.jetspeed.container;
  
  import java.io.InputStream;
  import java.util.Collection;
  import java.util.Enumeration;
  import java.util.Iterator;
  
  import javax.servlet.ServletContext;
  import javax.servlet.RequestDispatcher;
  
  import javax.portlet.PortletContext;
  import javax.portlet.PortletRequestDispatcher;
  
  import org.apache.jetspeed.dispatcher.JetspeedRequestDispatcher;
  import org.apache.jetspeed.om.common.JetspeedServiceReference;
  import org.apache.jetspeed.om.common.portlet.MutablePortletApplication;
  import org.apache.jetspeed.services.JetspeedPortletServices;
  import org.apache.jetspeed.services.PortletServices;
  import org.apache.pluto.om.portlet.PortletApplicationDefinition;
  
  /***
   * Implements the Portlet API Portlet Context class
   *
   * TODO: on LOCAL apps, we need to merge in web.xml props. See PLT 10.3
   *
   * @author <a href="mailto:david@bluesunrise.com">David Sean Taylor</a>
   * @version $Id: JetspeedPortletContext.java 516448 2007-03-09 16:25:47Z ate $
   */
  public class JetspeedPortletContext implements PortletContext, InternalPortletContext
  {
      /***
       * The path to the Local Portlet Apps directory
       */
      public static final String LOCAL_PA_ROOT = "/WEB-INF/apps";
  
      private ServletContext servletContext;
      private MutablePortletApplication application;
  
      public JetspeedPortletContext(ServletContext servletContext, PortletApplicationDefinition application)
      {
          this.servletContext = servletContext;
          this.application = (MutablePortletApplication)application;
      }
  
      public int getMajorVersion()
      {
          return ContainerInfo.getMajorSpecificationVersion();
      }
  
      public int getMinorVersion()
      {
          return ContainerInfo.getMinorSpecificationVersion();
      }
  
      // Delegated methods
  
      public java.util.Set getResourcePaths(String path)
      {
          return servletContext.getResourcePaths(path);
      }
  
      public javax.portlet.PortletRequestDispatcher getRequestDispatcher(String path)
      {
          String localizedPath = localizePath(path, this.application);
          RequestDispatcher rd = null;
          
          try
          {
              rd = servletContext.getRequestDispatcher(localizedPath);
          }
          catch (Exception e)
          {
              // Portlet API says: return null
          }
  
          // TODO: factory
          if ( rd != null )
          {
              return new JetspeedRequestDispatcher(rd);
          }
          return null;
      }
  
     public PortletRequestDispatcher getNamedDispatcher(String name)
     {
         // TODO: localize name
 
         RequestDispatcher rd = null;
         
         try
         {
             rd = servletContext.getNamedDispatcher(name);
         }
         catch (Exception e)
         {
             // Portlet API says: return null
         }
         
         // TODO: factory
 
         if ( rd != null )
         {
             return new JetspeedRequestDispatcher(rd);
         }
         return null;
     }
 
     public String getMimeType(String file)
     {
         return servletContext.getMimeType(file);
     }
 
     public InputStream getResourceAsStream(String path)
     {
         return servletContext.getResourceAsStream(localizePath(path, this.application));
     }
 
     public java.lang.Object getAttribute(java.lang.String name)
     {
         if ( name == null )
         {
             throw new IllegalArgumentException("Required parameter name is null");
         }
         
         if (name.startsWith("cps:"))
         {
             String serviceName = name.substring("cps:".length());
             
             // validate service
             Collection validServices = application.getJetspeedServices();
             if (null == validServices)
             {
                 return null;
             }
             boolean found = false;
             Iterator iterator = validServices.iterator();
             while (iterator.hasNext())
             {
                 JetspeedServiceReference validService = (JetspeedServiceReference)iterator.next();
                 if (validService.getName().equals(serviceName))
                 {
                     found = true;
                     break;
                 }
             }
             
             if (!found)
             {
                 return null;
             }
             
             // return the service
             PortletServices services = JetspeedPortletServices.getSingleton();
             return services.getService(serviceName);
         }
         return servletContext.getAttribute(name);
     }
 
     public void log(java.lang.String msg)
     {
         // TODO: setup a logger for the portlet application
         servletContext.log(msg);
     }
 
     public void log(java.lang.String message, java.lang.Throwable throwable)
     {
         // TODO: setup a logger for the portlet application
         servletContext.log(message, throwable);
     }
 
     public String getRealPath(String path)
     {
         return servletContext.getRealPath(localizePath(path, this.application));
     }
 
     public java.net.URL getResource(String path) throws java.net.MalformedURLException
     {
         return servletContext.getResource(localizePath(path, this.application));
     }
 
     public Enumeration getAttributeNames()
     {
         return servletContext.getAttributeNames();
     }
 
     public java.lang.String getInitParameter(java.lang.String name)
     {
         if ( name == null )
         {
             throw new IllegalArgumentException("Required parameter name is null");
         }
         return servletContext.getInitParameter(name);
     }
 
     public java.util.Enumeration getInitParameterNames()
     {
         return servletContext.getInitParameterNames();
     }
 
     public void removeAttribute(java.lang.String name)
     {
         if (name == null)
         {
             throw new IllegalArgumentException("Attribute name == null");
         }
 
         servletContext.removeAttribute(name);
     }
 
     public void setAttribute(java.lang.String name, java.lang.Object object)
     {
         if (name == null)
         {
             throw new IllegalArgumentException("Attribute name == null");
         }
         servletContext.setAttribute(name, object);
     }
 
     public String getServerInfo()
     {
         return ContainerInfo.getServerInfo();
     }
 
     // internal portlet context implementation
 
     public ServletContext getServletContext()
     {
         return this.servletContext;
     }
 
     /***
      * @see org.apache.jetspeed.container.InternalPortletContext#getApplication()
      */
     public PortletApplicationDefinition getApplication()
     {
         return this.application;
     }
 
     public String getPortletContextName()
     {
         return servletContext.getServletContextName();
     }
 
     private String localizePath(String path, MutablePortletApplication app)
     {
         if (path == null)
         {
             return "/";
         }
         return path;
         // TODO: local PA with own/extra resource paths support
 /*        
         if (app.getApplicationType() == MutablePortletApplication.WEBAPP)
         {
             return path;
         }
 
         StringBuffer pathBuffer = new StringBuffer(LOCAL_PA_ROOT);
         pathBuffer.append(app.getWebApplicationDefinition().getContextRoot());
         if (!path.startsWith("/"))
         {
             pathBuffer.append("/");
         }
         pathBuffer.append(path);
         String result = pathBuffer.toString();
         return result;
 */        
     }
 }