/*

    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

    *

    * Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.

    *

    * The contents of this file are subject to the terms of either the GNU

    * General Public License Version 2 only ("GPL") or the Common Development

    * and Distribution License("CDDL") (collectively, the "License").  You

    * may not use this file except in compliance with the License.  You can

   * obtain a copy of the License at

   * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html

   * or packager/legal/LICENSE.txt.  See the License for the specific

   * language governing permissions and limitations under the License.

   *

   * When distributing the software, include this License Header Notice in each

   * file and include the License file at packager/legal/LICENSE.txt.

   *

   * GPL Classpath Exception:

   * Oracle designates this particular file as subject to the "Classpath"

   * exception as provided by Oracle in the GPL Version 2 section of the License

   * file that accompanied this code.

   *

   * Modifications:

   * If applicable, add the following below the License Header, with the fields

   * enclosed by brackets [] replaced by your own identifying information:

   * "Portions Copyright [year] [name of copyright owner]"

   *

   * Contributor(s):

   * If you wish your version of this file to be governed by only the CDDL or

   * only the GPL Version 2, indicate your decision by adding "[Contributor]

   * elects to include this software in this distribution under the [CDDL or GPL

   * Version 2] license."  If you don't indicate a single choice of license, a

   * recipient has the option to distribute your version of this file under

   * either the CDDL, the GPL Version 2 or to extend the choice of license to

   * its licensees as provided above.  However, if you add GPL Version 2 code

   * and therefore, elected the GPL Version 2 license, then the option applies

   * only if the new code is made subject to such option by the copyright

   * holder.

   */

  package com.sun.enterprise.web;

  import com.sun.enterprise.config.serverbeans.ApplicationRef;

  import com.sun.enterprise.config.serverbeans.Applications;

  import com.sun.enterprise.config.serverbeans.AuthRealm;

  import com.sun.enterprise.config.serverbeans.Config;

  import com.sun.enterprise.config.serverbeans.ConfigBeansUtilities;

  import com.sun.enterprise.config.serverbeans.Domain;

  import com.sun.enterprise.config.serverbeans.HttpService;

  import com.sun.enterprise.config.serverbeans.SecurityService;

  import com.sun.enterprise.config.serverbeans.ServerTags;

  import com.sun.enterprise.deploy.shared.ArchiveFactory;

  import com.sun.enterprise.deployment.Application;

  import com.sun.enterprise.security.web.GlassFishSingleSignOn;

  import com.sun.enterprise.server.logging.GFFileHandler;

  import com.sun.enterprise.util.StringUtils;

  import com.sun.enterprise.v3.common.PlainTextActionReporter;

  import com.sun.enterprise.v3.services.impl.GrizzlyProxy;

  import com.sun.enterprise.v3.services.impl.GrizzlyService;

  import com.sun.enterprise.web.logger.CatalinaLogger;

  import com.sun.enterprise.web.logger.FileLoggerHandler;

  import com.sun.enterprise.web.logger.FileLoggerHandlerFactory;

  import com.sun.enterprise.web.pluggable.WebContainerFeatureFactory;

  import com.sun.enterprise.web.session.SessionCookieConfig;

  import com.sun.web.security.RealmAdapter;

  import org.apache.catalina.*;

  import org.apache.catalina.authenticator.AuthenticatorBase;

  import org.apache.catalina.authenticator.SingleSignOn;

  import org.apache.catalina.core.StandardContext;

  import org.apache.catalina.core.StandardHost;

  import org.apache.catalina.connector.Response;

  import org.apache.catalina.connector.Request;

  import org.apache.catalina.deploy.ErrorPage;

  import org.apache.catalina.valves.RemoteAddrValve;

  import org.apache.catalina.valves.RemoteHostValve;

  import org.glassfish.api.ActionReport;

  import org.glassfish.api.admin.ServerEnvironment;

  import org.glassfish.api.deployment.DeployCommandParameters;

  import org.glassfish.api.deployment.OpsParams;

  import org.glassfish.api.deployment.UndeployCommandParameters;

  import org.glassfish.api.deployment.archive.ArchiveHandler;

  import org.glassfish.api.deployment.archive.ReadableArchive;

  import org.glassfish.deployment.common.ApplicationConfigInfo;

  import org.glassfish.deployment.common.DeploymentContextImpl;

  import org.glassfish.deployment.common.DeploymentUtils;

  import org.glassfish.embeddable.CommandRunner;

  import org.glassfish.embeddable.GlassFishException;

  import org.glassfish.embeddable.web.Context;

  import org.glassfish.embeddable.web.ConfigException;

  import org.glassfish.embeddable.web.WebListener;

  import org.glassfish.embeddable.web.config.VirtualServerConfig;

  import org.glassfish.grizzly.Buffer;

  import org.glassfish.grizzly.Connection;

  import org.glassfish.grizzly.ConnectionProbe;

  import org.glassfish.grizzly.config.GenericGrizzlyListener;

  import org.glassfish.grizzly.config.dom.NetworkListener;

  import org.glassfish.grizzly.http.ContentEncoding;

 import org.glassfish.grizzly.http.HttpContent;

 import org.glassfish.grizzly.http.HttpCodecFilter;

 import org.glassfish.grizzly.http.HttpProbe;

 import org.glassfish.grizzly.http.HttpHeader;

 import org.glassfish.grizzly.http.HttpPacket;

 import org.glassfish.grizzly.http.HttpRequestPacket;

 import org.glassfish.grizzly.http.HttpResponsePacket;

 import org.glassfish.grizzly.http.TransferEncoding;

 import org.glassfish.grizzly.http.util.HttpStatus;

 import org.glassfish.grizzly.filterchain.FilterChainContext;

 import org.glassfish.hk2.api.ServiceLocator;

 import org.glassfish.hk2.api.ServiceLocatorFactory;

 import org.glassfish.logging.annotation.LogMessageInfo;

 import org.glassfish.web.admin.monitor.RequestProbeProvider;

 import org.glassfish.web.deployment.archivist.WebArchivist;

 import org.glassfish.web.deployment.descriptor.WebBundleDescriptorImpl;

 import org.glassfish.internal.api.ClassLoaderHierarchy;

 import org.glassfish.internal.api.ServerContext;

 import org.glassfish.internal.api.Globals;

 import org.glassfish.internal.data.ApplicationInfo;

 import org.glassfish.internal.data.ApplicationRegistry;

 import org.glassfish.internal.deployment.Deployment;

 import org.glassfish.internal.deployment.ExtendedDeploymentContext;

 import org.glassfish.web.loader.WebappClassLoader;

 import org.glassfish.web.valve.GlassFishValve;

 import org.glassfish.hk2.api.ServiceLocator;

 import org.jvnet.hk2.config.Transaction;

 import org.jvnet.hk2.config.TransactionFailure;

 import org.jvnet.hk2.config.types.Property;

 import java.io.File;

 import java.io.IOException;

 import java.security.AccessController;

 import java.security.PrivilegedAction;

 import java.util.*;

 import java.util.logging.Handler;

 import java.util.logging.Level;

 import java.util.logging.LogManager;

 import java.util.logging.Logger;

 import java.util.logging.LogRecord;

 import javax.servlet.http.Cookie;

 import javax.servlet.http.HttpServletRequest;

 import javax.xml.parsers.DocumentBuilderFactory;

 import javax.xml.parsers.DocumentBuilder;

 import javax.xml.transform.OutputKeys;

 import javax.xml.transform.Transformer;

 import javax.xml.transform.TransformerFactory;

 import javax.xml.transform.dom.DOMSource;

 import javax.xml.transform.stream.StreamResult;

 import org.w3c.dom.*;

 public class VirtualServer extends StandardHost 

         implements org.glassfish.embeddable.web.VirtualServer {

     private static final String STATE = "state";

     private static final String SSO_MAX_IDLE ="sso-max-inactive-seconds";

     private static final String SSO_REAP_INTERVAL ="sso-reap-interval-seconds";

     private static final String SSO_COOKIE_SECURE ="sso-cookie-secure";

     private static final String DISABLED = "disabled";

     private static final String OFF = "off";

     private static final String ON = "on";

    

     private static final Logger DEFAULT_LOGGER = WebContainer.logger;

    

     protected static final ResourceBundle rb = DEFAULT_LOGGER.getResourceBundle();

     @LogMessageInfo(

             message = "The web module {0} has been designated as the default-web-module for virtual server {1}",

             level = "FINE")

     public static final String VS_DEFAULT_WEB_MODULE = "AS-WEB-00100";

     @LogMessageInfo(

             message = "Error looking up the configuration information of the default-web-module {0} for virtual server {1}",

             level = "SEVERE",

             cause = "The web module specified is either not found or disabled or does not specify this virtual server, " +

                     "or there was an error loading its deployment descriptors",

             action = "Verify if the virtual server's default web module is valid")

     public static final String VS_DEFAULT_WEB_MODULE_NOT_FOUND = "AS-WEB-00101";

     @LogMessageInfo(

             message = "The default-web-module {0} is either disabled or does not specify virtual server {1}",

             level = "SEVERE",

             cause = "The default web module is disabled or does not specify virtual server",

             action = "Verify if the default web module is enabled and specify virtual server")

     public static final String VS_DEFAULT_WEB_MODULE_DISABLED = "AS-WEB-00102";

     @LogMessageInfo(

             message = "Virtual server {0} has invalid authentication realm {1}",

             level = "SEVERE",

             cause = "The realm {1} could not be found",

             action = "Verify if the realm {1} exits for virtual server {0}")

     public static final String INVALID_AUTH_REALM = "AS-WEB-00103";

     @LogMessageInfo(

             message = "Invalid sso-cookie-secure configuration {0} for virtual server {1}",

             level = "INFO")

     public static final String INVALID_SSO_COOKIE_SECURE = "AS-WEB-00104";

     @LogMessageInfo(

             message = "Realm {0} is not an instance of {1}, and will be ignored",

             level = "SEVERE",

             cause = "The realm {0} is either NULL or is not an instance of {1}",

             action = "Verify if the realm {0} is an instance of {1}")

     public static final String IGNORE_INVALID_REALM = "AS-WEB-00105";

     @LogMessageInfo(

             message = "Virtual server {0} has a property with missing name or value",

             level = "WARNING")

     public static final String NULL_VIRTUAL_SERVER_PROPERTY = "AS-WEB-00106";

     @LogMessageInfo(

             message = "Invalid redirect property value {0} for virtual server {1}: More than one {2} component",

             level = "WARNING")

     public static final String REDIRECT_MULTIPLE_ELEMENT = "AS-WEB-00107";

     @LogMessageInfo(

             message = "Invalid redirect property value {0} for virtual server {1}: Missing url or url-prefix component",

             level = "WARNING")

     public static final String REDIRECT_MISSING_URL_OR_URL_PREFIX = "AS-WEB-00108";

     @LogMessageInfo(

             message = "Invalid redirect property value {0} for virtual server {1}: Both url and url-prefix specified",

             level = "WARNING")

     public static final String REDIRECT_BOTH_URL_AND_URL_PREFIX = "AS-WEB-00109";

     @LogMessageInfo(

             message = "Invalid redirect property value {0} for virtual server {1}: escape must be equal to yes or no",

             level = "WARNING")

     public static final String REDIRECT_INVALID_ESCAPE = "AS-WEB-00110";

     @LogMessageInfo(

             message = "Invalid send-error property value {0} for virtual server {1}: More than one {2} component",

             level = "WARNING")

     public static final String SEND_ERROR_MULTIPLE_ELEMENT = "AS-WEB-00111";

     @LogMessageInfo(

             message = "Invalid send-error property value {0} for virtual server {1}: Missing path component",

             level = "WARNING")

     public static final String SEND_ERROR_MISSING_PATH = "AS-WEB-00112";

     @LogMessageInfo(

             message = "Unable to add listener of type {0} to virtual server {1}",

             level = "SEVERE",

             cause = "The listener is not an instance of ContainerListener or LifecycleListener",

             action = "Verify if the listener type is supported")

     public static final String INVALID_LISTENER = "AS-WEB-00113";

     @LogMessageInfo(

             message = " Unable to load extension class {0} from web module {1}",

             level = "SEVERE",

             cause = "An exception occurred loading extension class",

             action = "Check the exception for the error")

     public static final String UNABLE_TO_LOAD_EXTENSION = "AS-WEB-00114";

     @LogMessageInfo(

             message = "Object of type classname {0} not an instance of Valve or GlassFishValve",

             level = "WARNING")

     public static final String NOT_A_VALVE = "AS-WEB-00115";

     @LogMessageInfo(

             message = "Error adding HttpProbes. NetworkListener {0}'s HttpCodecFilter is {1}",

             level = "SEVERE",

             cause = "HttpCodecFilter is either NULL or empty",

             action = "Verify the NetworkListener is valid")

     public static final String CODE_FILTERS_NULL = "AS-WEB-00116";

     @LogMessageInfo(

             message = "Error adding HttpProbes",

             level = "SEVERE",

             cause = "An exception occurred adding HttpProbes",

             action = "Check the exception for the error")

     public static final String ADD_HTTP_PROBES_ERROR = "AS-WEB-00117";

     @LogMessageInfo(

             message = "Disabling Single Sign On (SSO) for virtual server {0} as configured",

             level = "FINE")

     public static final String DISABLE_SSO= "AS-WEB-00118";

     @LogMessageInfo(

             message = "Enabling Single Sign On (SSO) for virtual server {0} as configured",

             level = "FINE")

     public static final String ENABLE_SSO = "AS-WEB-00119";

     @LogMessageInfo(

             message = "SSO entry max idle time set to {0} for virtual server {1}",

             level = "FINE")

     public static final String SSO_MAX_INACTIVE_SET= "AS-WEB-00120";

     @LogMessageInfo(

             message = "SSO expire thread interval set to {0} for virtual server {1}",

             level = "FINE")

     public static final String SSO_REAP_INTERVAL_SET = "AS-WEB-00121";

     @LogMessageInfo(

             message = "Allowing access to {0} from {1}",

             level = "FINE")

     public static final String ALLOW_ACCESS = "AS-WEB-00122";

     @LogMessageInfo(

             message = "Denying access to {0} from {1}",

             level = "FINE")

     public static final String DENY_ACCESS = "AS-WEB-00123";

     @LogMessageInfo(

             message = "Virtual server {0} enabled context {1}",

             level = "FINE")

     public static final String VS_ENABLED_CONTEXT = "AS-WEB-00124";

     @LogMessageInfo(

             message = "Unable to delete {0}",

             level = "WARNING")

     public static final String UNABLE_TO_DELETE = "AS-WEB-00125";

     @LogMessageInfo(

             message = "Unable to reconfigure access log valve",

             level = "SEVERE",

             cause = "An exception occurred during access log valve reconfiguration",

             action = "Check the exception for error")

     public static final String UNABLE_RECONFIGURE_ACCESS_LOG = "AS-WEB-00126";

     @LogMessageInfo(

             message = "Virtual server {0} added context {1}",

             level = "FINE")

     public static final String VS_ADDED_CONTEXT = "AS-WEB-00127";

     @LogMessageInfo(

             message = "Application {0} is not found",

             level = "SEVERE",

             cause = "The deployed application is not found",

             action = "Check if the application is valid")

     public static final String APP_NOT_FOUND = "AS-WEB-00128";

     @LogMessageInfo(

             message = "Cannot create context for undeployment",

             level = "SEVERE",

             cause = "An IOException occurred during undeployment",

             action = "Check the exception for error")

     public static final String REMOVE_CONTEXT_ERROR = "AS-WEB-00129";

     @LogMessageInfo(

             message = "Successfully removed context {0}",

             level = "FINE")

     public static final String REMOVED_CONTEXT = "AS-WEB-00130";

     @LogMessageInfo(

             message = "Modifying web.xml {0}",

             level = "FINE")

     public static final String MODIFYING_WEB_XML = "AS-WEB-00131";

     @LogMessageInfo(

             message = "Error adding HttpProbes. NetworkListener {0}'s GrizzlyProxy is NULL",

             level = "SEVERE",

             cause = "GrizzlyProxy is NULL",

             action = "Verify the NetworkListener is valid")

     public static final String PROXY_NULL = "AS-WEB-00132";

     // ------------------------------------------------------------ Constructor

     public VirtualServer() {

         origPipeline = pipeline;

         vsPipeline = new VirtualServerPipeline(this);

         accessLogValve = new PEAccessLogValve();

         accessLogValve.setContainer(this);

     }

     // ----------------------------------------------------- Instance Variables

     /*

      * The custom pipeline of this VirtualServer, which implements the

      * following virtual server features:

      *

      * - state (disabled/off)

      * - redirects

      */

     private VirtualServerPipeline vsPipeline;

     /*

      * The original (standard) pipeline of this VirtualServer.

      *

      * Only one (custom or original) pipeline may be active at any given time.

      * Any updates (such as adding or removing valves) to the currently

      * active pipeline are propagated to the other.

      */

     private Pipeline origPipeline;

    

     private String _id = null;

    

     protected Logger _logger = DEFAULT_LOGGER;

    

     private static final String _info =

         "com.sun.enterprise.web.VirtualServer/1.0";

    

     private com.sun.enterprise.config.serverbeans.VirtualServer vsBean;

    

     private MimeMap mimeMap;

     /*

      * Indicates whether symbolic links from this virtual server's docroot

      * are followed. This setting is inherited by all web modules deployed on

      * this virtual server, unless overridden by a web modules allowLinking

      * property in sun-web.xml.

      */

     private boolean allowLinking = false;

     private String[] cacheControls;

     private ClassLoaderHierarchy clh;

     private Domain domain;

     private ServiceLocator services;

     // Is this virtual server active?

     private boolean isActive;

     private String authRealmName;

     /*

      * The accesslog valve of this VirtualServer.

      *

      * This valve is activated, that is, added to this virtual server's

      * pipeline, only when access logging has been enabled. When acess logging

      * has been disabled, this valve is removed from this virtual server's

      * pipeline.

      */

     private PEAccessLogValve accessLogValve;

     // The value of the ssoCookieSecure property

     private String ssoCookieSecure = null;

     private boolean ssoCookieHttpOnly = false;

     private String defaultContextPath = null;

     private ServerContext serverContext;

     private Config serverConfig;

     private GrizzlyService grizzlyService;

     private WebContainer webContainer;

     private boolean ssoFailoverEnabled = false;

     private volatile FileLoggerHandler fileLoggerHandler = null;

     private volatile FileLoggerHandlerFactory fileLoggerHandlerFactory = null;

     private Deployment deployment = null;

     private ArchiveFactory factory = null;

     private ActionReport report = null;

     private HttpProbeImpl httpProbe = null;

     // ------------------------------------------------------------- Properties

     public String getID() {

         return _id;

     }

    

     public void setID(String id) {

         _id = id;

     }

    

     public void setIsActive(boolean isActive) {

         this.isActive = isActive;

         if (isActive) {

             vsPipeline.setIsDisabled(false);

             vsPipeline.setIsOff(false);

             if (pipeline == vsPipeline && !vsPipeline.hasRedirects()) {

                 // Restore original pipeline

                 setPipeline(origPipeline);

             }

         }

     }
    
    

     public boolean getAllowLinking() {

         return allowLinking;

     }

    

     public void setAllowLinking(boolean allowLinking) {

         this.allowLinking = allowLinking;

     }

    

     public com.sun.enterprise.config.serverbeans.VirtualServer getBean(){

         return vsBean;

     }

    

     public void setBean(

             com.sun.enterprise.config.serverbeans.VirtualServer vsBean){

         this.vsBean = vsBean;

     }

    

     public MimeMap getMimeMap(){

         return mimeMap;

     }

    

     public void setMimeMap(MimeMap mimeMap){

         this.mimeMap = mimeMap;

     }

    

     public String[] getCacheControls() {

         return cacheControls;

     }

    

     public void setCacheControls(String[] cacheControls) {

         this.cacheControls = cacheControls;

     }

     public void setServices(ServiceLocator services) {

         this.services = services;

     }

     public String getInfo() {

         return _info;

     }

     public void setDefaultContextPath(String defaultContextPath) {

         this.defaultContextPath = defaultContextPath;

     }

     public void setFileLoggerHandlerFactory(FileLoggerHandlerFactory factory) {

         fileLoggerHandlerFactory = factory;

     }

     public void setClassLoaderHierarchy(ClassLoaderHierarchy clh) {

         this.clh = clh;

     }

     public void setDomain(Domain domain) {

         this.domain = domain;

     }

     @Override

     public Container findChild(String contextRoot) {

         if (defaultContextPath != null && "/".equals(contextRoot)) {

             return super.findChild(defaultContextPath);

         } else {

             return super.findChild(contextRoot);

         }

     }

     // --------------------------------------------------------- Public Methods

     @Override

     public void configureSingleSignOnCookieSecure(Cookie ssoCookie,

                                                   HttpServletRequest hreq) {

         super.configureSingleSignOnCookieSecure(ssoCookie, hreq);

         if (ssoCookieSecure != null &&

                 !ssoCookieSecure.equals(SessionCookieConfig.DYNAMIC_SECURE)) {

             ssoCookie.setSecure(Boolean.parseBoolean(ssoCookieSecure));

         }

     }

     @Override

     public void configureSingleSignOnCookieHttpOnly(Cookie ssoCookie) {

         ssoCookie.setHttpOnly(ssoCookieHttpOnly);

     }

     // ------------------------------------------------------ Lifecycle Methods

     public synchronized void addValve(GlassFishValve valve) {

         super.addValve(valve);

         if (pipeline == vsPipeline) {

             origPipeline.addValve(valve);

         } else {

             vsPipeline.addValve(valve);

         }

     }


    

     public synchronized void addValve(Valve valve) {

         super.addValve(valve);

         if (pipeline == vsPipeline) {

             origPipeline.addValve(valve);

         } else {

             vsPipeline.addValve(valve);

         }

     }


    

     public synchronized void removeValve(GlassFishValve valve) {

         super.removeValve(valve);

         if (pipeline == vsPipeline) {

             origPipeline.removeValve(valve);

         } else {

             vsPipeline.removeValve(valve);

         }

     }

     private ConfigBeansUtilities getConfigBeansUtilities() {

     	if (services == null) return null;

     	return services.getService(ConfigBeansUtilities.class);

     }

     // ------------------------------------------------------ Protected Methods

     protected String getDefaultContextPath(Domain domain,

             ApplicationRegistry appRegistry) {

         String contextRoot = null;

         String wmID = getDefaultWebModuleID();

         if (wmID != null) {

             // Check if the default-web-module is part of a

             // j2ee-application

             Applications appsBean = domain.getApplications();

             WebModuleConfig wmInfo = findWebModuleInJ2eeApp(appsBean, wmID,

                                                             appRegistry);