/*

    * 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.felix.webconsole.internal.servlet;

  import java.io.IOException;

  import java.net.URL;

  import java.security.AccessController;

  import java.security.PrivilegedActionException;

  import java.security.PrivilegedExceptionAction;

  import java.text.MessageFormat;

  import java.util.ArrayList;

  import java.util.Arrays;

  import java.util.Dictionary;

  import java.util.Enumeration;

  import java.util.HashMap;

  import java.util.HashSet;

  import java.util.Hashtable;

  import java.util.Iterator;

  import java.util.List;

  import java.util.Locale;

  import java.util.Map;

  import java.util.Map.Entry;

  import java.util.ResourceBundle;

  import java.util.Set;

  import javax.servlet.GenericServlet;

  import javax.servlet.ServletConfig;

  import javax.servlet.ServletContext;

  import javax.servlet.ServletException;

  import javax.servlet.ServletRequest;

  import javax.servlet.ServletResponse;

  import javax.servlet.http.Cookie;

  import javax.servlet.http.HttpServletRequest;

  import javax.servlet.http.HttpServletRequestWrapper;

  import javax.servlet.http.HttpServletResponse;

  import org.apache.commons.io.FilenameUtils;

  import org.apache.felix.webconsole.AbstractWebConsolePlugin;

  import org.apache.felix.webconsole.BrandingPlugin;

  import org.apache.felix.webconsole.WebConsoleConstants;

  import org.apache.felix.webconsole.WebConsoleSecurityProvider;

  import org.apache.felix.webconsole.internal.OsgiManagerPlugin;

  import org.apache.felix.webconsole.internal.Util;

  import org.apache.felix.webconsole.internal.core.BundlesServlet;

  import org.apache.felix.webconsole.internal.filter.FilteringResponseWrapper;

  import org.apache.felix.webconsole.internal.i18n.ResourceBundleManager;

  import org.apache.felix.webconsole.internal.servlet.PluginHolder.InternalPlugin;

  import org.osgi.framework.Bundle;

  import org.osgi.framework.BundleContext;

  import org.osgi.framework.Constants;

  import org.osgi.framework.Filter;

  import org.osgi.framework.InvalidSyntaxException;

  import org.osgi.framework.ServiceFactory;

  import org.osgi.framework.ServiceReference;

  import org.osgi.framework.ServiceRegistration;

  import org.osgi.service.http.HttpContext;

  import org.osgi.service.http.HttpService;

  import org.osgi.service.log.LogService;

  import org.osgi.util.tracker.ServiceTracker;

  public class OsgiManager extends GenericServlet

  {

    

      private static final long serialVersionUID = 1L;

    

      private static final String ATTR_APP_ROOT_OLD = OsgiManager.class.getName()

          + ".appRoot";

    

     private static final String ATTR_LABEL_MAP_OLD = OsgiManager.class.getName()

         + ".labelMap";

    

     public static final String ATTR_LABEL_MAP_CATEGORIZED = WebConsoleConstants.ATTR_LABEL_MAP + ".categorized";

    

     public static final String PARAM_NO_REDIRECT_AFTER_ACTION = "_noredir_";

    

     private static final String COOKIE_LOCALE = "felix-webconsole-locale"; //$NON-NLS-1$

     private static final String FRAMEWORK_PROP_MANAGER_ROOT = "felix.webconsole.manager.root"; //$NON-NLS-1$

     private static final String FRAMEWORK_PROP_REALM = "felix.webconsole.realm"; //$NON-NLS-1$

     private static final String FRAMEWORK_PROP_USER_NAME = "felix.webconsole.username"; //$NON-NLS-1$

     private static final String FRAMEWORK_PROP_PASSWORD = "felix.webconsole.password"; //$NON-NLS-1$

     private static final String FRAMEWORK_PROP_LOG_LEVEL = "felix.webconsole.loglevel"; //$NON-NLS-1$

     private static final String FRAMEWORK_PROP_LOCALE = "felix.webconsole.locale"; //$NON-NLS-1$

     static final String PROP_MANAGER_ROOT = "manager.root"; //$NON-NLS-1$

     static final String PROP_DEFAULT_RENDER = "default.render"; //$NON-NLS-1$

     static final String PROP_REALM = "realm"; //$NON-NLS-1$

     static final String PROP_USER_NAME = "username"; //$NON-NLS-1$

     static final String PROP_PASSWORD = "password"; //$NON-NLS-1$

     static final String PROP_CATEGORY = "category"; //$NON-NLS-1$

     static final String PROP_ENABLED_PLUGINS = "plugins"; //$NON-NLS-1$

     static final String PROP_LOG_LEVEL = "loglevel"; //$NON-NLS-1$

     static final String PROP_LOCALE = "locale"; //$NON-NLS-1$

     static final String PROP_HTTP_SERVICE_SELECTOR = "http.service.filter"; //$NON-NLS-1$

     public static final int DEFAULT_LOG_LEVEL = LogService.LOG_WARNING;

     static final String DEFAULT_PAGE = BundlesServlet.NAME;

     static final String DEFAULT_REALM = "OSGi Management Console"; //$NON-NLS-1$

     static final String DEFAULT_USER_NAME = "admin"; //$NON-NLS-1$

     static final String DEFAULT_PASSWORD = "{sha-256}jGl25bVBBBW96Qi9Te4V37Fnqchz/Eu4qB9vKrRIqRg="; //$NON-NLS-1$

     static final String DEFAULT_CATEGORY = "Main"; //$NON-NLS-1$

     static final String DEFAULT_HTTP_SERVICE_SELECTOR = ""; //$NON-NLS-1$

     static final String DEFAULT_MANAGER_ROOT = "/system/console"; //$NON-NLS-1$

     private static final String OLD_CONFIG_MANAGER_CLASS = "org.apache.felix.webconsole.internal.compendium.ConfigManager"; //$NON-NLS-1$

     private static final String NEW_CONFIG_MANAGER_CLASS = "org.apache.felix.webconsole.internal.configuration.ConfigManager"; //$NON-NLS-1$

     static final String[] PLUGIN_CLASSES = {

             "org.apache.felix.webconsole.internal.configuration.ConfigurationAdminConfigurationPrinter", //$NON-NLS-1$

             "org.apache.felix.webconsole.internal.compendium.PreferencesConfigurationPrinter", //$NON-NLS-1$

             "org.apache.felix.webconsole.internal.compendium.WireAdminConfigurationPrinter", //$NON-NLS-1$

             "org.apache.felix.webconsole.internal.core.BundlesConfigurationPrinter", //$NON-NLS-1$

             "org.apache.felix.webconsole.internal.core.PermissionsConfigurationPrinter", //$NON-NLS-1$

             "org.apache.felix.webconsole.internal.core.ServicesConfigurationPrinter", //$NON-NLS-1$

             "org.apache.felix.webconsole.internal.misc.SystemPropertiesPrinter", //$NON-NLS-1$

             "org.apache.felix.webconsole.internal.misc.ThreadPrinter", }; //$NON-NLS-1$

     static final String[] PLUGIN_MAP = {

             NEW_CONFIG_MANAGER_CLASS, "configMgr", //$NON-NLS-1$ //$NON-NLS-2$

             "org.apache.felix.webconsole.internal.compendium.LogServlet", "logs", //$NON-NLS-1$ //$NON-NLS-2$

             "org.apache.felix.webconsole.internal.core.BundlesServlet", "bundles", //$NON-NLS-1$ //$NON-NLS-2$

             "org.apache.felix.webconsole.internal.core.ServicesServlet", "services", //$NON-NLS-1$ //$NON-NLS-2$

             "org.apache.felix.webconsole.internal.misc.LicenseServlet", "licenses", //$NON-NLS-1$ //$NON-NLS-2$

             "org.apache.felix.webconsole.internal.system.VMStatPlugin", "vmstat", //$NON-NLS-1$ //$NON-NLS-2$

     };

     private BundleContext bundleContext;

     private HttpServiceTracker httpServiceTracker;

     private HttpService httpService;

     private PluginHolder holder;

     private ServiceTracker brandingTracker;

     private ServiceTracker securityProviderTracker;

     private ServiceRegistration configurationListener;

     // list of OsgiManagerPlugin instances activated during init. All these

     // instances will have to be deactivated during destroy

     private List osgiManagerPlugins = new ArrayList();

     private String webManagerRoot;

     // true if the OsgiManager is registered as a Servlet with the HttpService

     private boolean httpServletRegistered;

     // true if the resources have been registered with the HttpService

     private boolean httpResourcesRegistered;

     // default configuration from framework properties

     private HashMap defaultConfiguration;

     // configuration from Configuration Admin

     private HashMap configuration;

     // See https://issues.apache.org/jira/browse/FELIX-2267

     private Locale configuredLocale;

     private Set enabledPlugins;

     ResourceBundleManager resourceBundleManager;

     private int logLevel = DEFAULT_LOG_LEVEL;

     private String defaultCategory = DEFAULT_CATEGORY;

     public OsgiManager(BundleContext bundleContext)

     {

         this.bundleContext = bundleContext;

         this.holder = new PluginHolder(bundleContext);

         // new plugins setup

         for (int i = 0; i < PLUGIN_MAP.length; i++)

         {

             final String pluginClassName = PLUGIN_MAP[i++];

             final String label = PLUGIN_MAP[i];

             holder.addInternalPlugin(this, pluginClassName, label);

         }

         // setup the included plugins

         ClassLoader classLoader = getClass().getClassLoader();

         for (int i = 0; i < PLUGIN_CLASSES.length; i++)

         {

             String pluginClassName = PLUGIN_CLASSES[i];

             try

             {

                 Class pluginClass = classLoader.loadClass(pluginClassName);

                 Object plugin = pluginClass.newInstance();

                 if (plugin instanceof OsgiManagerPlugin)

                 {

                     ((OsgiManagerPlugin) plugin).activate(bundleContext);

                     osgiManagerPlugins.add(plugin);

                 }

                 if (plugin instanceof BrandingPlugin)

                 {

                     AbstractWebConsolePlugin.setBrandingPlugin((BrandingPlugin) plugin);

                 }

             }

             catch (NoClassDefFoundError ncdfe)

             {

                 String message = ncdfe.getMessage();

                 if (message == null)

                 {

                     // no message, construct it

                     message = "Class definition not found (NoClassDefFoundError)";

                 }

                 else if (message.indexOf(' ') < 0)

                 {

                     // message is just a class name, try to be more descriptive

                     message = "Class " + message + " missing";

                 }

                 log(LogService.LOG_INFO, pluginClassName + " not enabled. Reason: "

                     + message);

             }

             catch (Throwable t)

             {

                 log(LogService.LOG_INFO, "Failed to instantiate plugin "

                     + pluginClassName + ". Reason: " + t);

             }

         }

         // the resource bundle manager

         resourceBundleManager = new ResourceBundleManager(getBundleContext());

         // start the configuration render, providing the resource bundle manager

         //ConfigurationRender cr = new ConfigurationRender(resourceBundleManager);

         //cr.activate(bundleContext);

         //osgiManagerPlugins.add(cr);

         //holder.addOsgiManagerPlugin(cr);

         // start tracking external plugins after setting up our own plugins

         holder.open();

         // accept new console branding service

         brandingTracker = new BrandingServiceTracker(this);

         brandingTracker.open();

         // add support for pluggable security

         securityProviderTracker = new ServiceTracker(bundleContext,

             WebConsoleSecurityProvider.class.getName(), null);

         securityProviderTracker.open();

         // load the default configuration from the framework

         this.defaultConfiguration = new HashMap();

         this.defaultConfiguration.put( PROP_MANAGER_ROOT,

             ConfigurationUtil.getProperty( bundleContext, FRAMEWORK_PROP_MANAGER_ROOT, DEFAULT_MANAGER_ROOT ) );

         this.defaultConfiguration.put( PROP_REALM,

             ConfigurationUtil.getProperty( bundleContext, FRAMEWORK_PROP_REALM, DEFAULT_REALM ) );

         this.defaultConfiguration.put( PROP_USER_NAME,

             ConfigurationUtil.getProperty( bundleContext, FRAMEWORK_PROP_USER_NAME, DEFAULT_USER_NAME ) );

         this.defaultConfiguration.put( PROP_PASSWORD,

             ConfigurationUtil.getProperty( bundleContext, FRAMEWORK_PROP_PASSWORD, DEFAULT_PASSWORD ) );

         this.defaultConfiguration.put( PROP_LOG_LEVEL,

             new Integer( ConfigurationUtil.getProperty( bundleContext, FRAMEWORK_PROP_LOG_LEVEL, DEFAULT_LOG_LEVEL ) ) );

         this.defaultConfiguration.put( PROP_LOCALE,

             ConfigurationUtil.getProperty( bundleContext, FRAMEWORK_PROP_LOCALE, null ) );

         // configure and start listening for configuration

         updateConfiguration(null);

         // register managed service as a service factory

         this.configurationListener = bundleContext.registerService( "org.osgi.service.cm.ManagedService", //$NON-NLS-1$

             new ServiceFactory()

             {

                 public Object getService( Bundle bundle, ServiceRegistration registration )

                 {

                     /*

                      * Explicitly load the class through the class loader to dynamically

                      * wire the API if not wired yet. Implicit loading by creating a

                      * class instance does not seem to properly work wiring the API

                      * in time.

                      */

                     try

                     {

                         OsgiManager.this.getClass().getClassLoader()

                             .loadClass( "org.osgi.service.metatype.MetaTypeProvider" );

                         return new ConfigurationMetatypeSupport( OsgiManager.this );

                     }

                     catch ( ClassNotFoundException cnfe )

                     {

                         // ignore

                     }

                     return new ConfigurationSupport( OsgiManager.this );

                 }

                 public void ungetService( Bundle bundle, ServiceRegistration registration, Object service )

                 {

                     // do nothing

                 }

             }, new Hashtable()

             {

                 {

                     put( Constants.SERVICE_VENDOR, "The Apache Software Foundation" ); //$NON-NLS-1$

                     put( Constants.SERVICE_DESCRIPTION, "OSGi Management Console Configuration Receiver" ); //$NON-NLS-1$

                     put( Constants.SERVICE_PID, getConfigurationPid() );

                 }

             } );

     }

     public void dispose()

     {

         // dispose off held plugins

         holder.close();

         // dispose off the resource bundle manager

         if (resourceBundleManager != null)

         {

             resourceBundleManager.dispose();

             resourceBundleManager = null;

         }

         // stop listening for brandings

         if (brandingTracker != null)

         {

             brandingTracker.close();

             brandingTracker = null;

         }

         // deactivate any remaining plugins

         for (Iterator pi = osgiManagerPlugins.iterator(); pi.hasNext();)

         {

             Object plugin = pi.next();

             ((OsgiManagerPlugin) plugin).deactivate();

         }

         // simply remove all operations, we should not be used anymore

         this.osgiManagerPlugins.clear();

         // now drop the HttpService and continue with further destroyals

         if (httpServiceTracker != null)

         {

             httpServiceTracker.close();

             httpServiceTracker = null;

         }

         // stop listening for configuration

         if (configurationListener != null)

         {

             configurationListener.unregister();

             configurationListener = null;

         }

         // stop tracking security provider

         if (securityProviderTracker != null)

         {

             securityProviderTracker.close();

             securityProviderTracker = null;

         }

         this.bundleContext = null;

     }

     //---------- Servlet API

     public void init()

     {

         // base class initialization not needed, since the GenericServlet.init

         // is an empty method

         holder.setServletContext(getServletContext());

     }

    

     public void service(final ServletRequest req, final ServletResponse res)

         throws ServletException, IOException

     {

         // don't really expect to be called within a non-HTTP environment

         try

         {

             AccessController.doPrivileged(new PrivilegedExceptionAction()

             {

                 public Object run() throws Exception

                 {

                     service((HttpServletRequest) req, (HttpServletResponse) res);

                     return null;

                 }

             });

         }

         catch (PrivilegedActionException e)

         {

             Exception x = e.getException();

             if (x instanceof IOException)

             {

                 throw (IOException) x;

             }

             else if (x instanceof ServletException)

             {

                 throw (ServletException) x;

             }

             else

             {

                 throw new IOException(x.toString());

             }

         }

         // ensure response has been sent back and response is committed

         // (we are authorative for our URL space and no other servlet should interfere)

         res.flushBuffer();

     }

     private void ensureLocaleCookieSet(HttpServletRequest request, HttpServletResponse response, Locale locale) {

         Cookie[] cookies = request.getCookies();

         boolean hasCookie = false;

         for(int i=0; cookies != null && i<cookies.length;i++) {

             if (COOKIE_LOCALE.equals(cookies[i].getName()) ) {

                 hasCookie = true;

                 break;

             }

         }

         if (!hasCookie) {

             Cookie cookie = new Cookie(COOKIE_LOCALE, locale.toString());

             cookie.setPath((String)request.getAttribute(WebConsoleConstants.ATTR_APP_ROOT));

             cookie.setMaxAge(20 * 365 * 24 * 60 * 60); // 20 years

             response.addCookie(cookie);

         }

     }

     void service(HttpServletRequest request, HttpServletResponse response)

         throws ServletException, IOException

     {

         // check whether we are not at .../{webManagerRoot}

         final String pathInfo = request.getPathInfo();

         if (pathInfo == null || pathInfo.equals("/")) //$NON-NLS-1$

         {

             String path = request.getRequestURI();

             if (!path.endsWith("/")) //$NON-NLS-1$

             {

                 path = path.concat("/"); //$NON-NLS-1$

             }

             path = path.concat(holder.getDefaultPluginLabel());

             response.sendRedirect(path);

             return;

         }

         int slash = pathInfo.indexOf("/", 1);

         if (slash < 2)

         {

             slash = pathInfo.length();

         }

         final Locale locale = getConfiguredLocale(request);

         final String label = pathInfo.substring(1, slash);

         AbstractWebConsolePlugin plugin = getConsolePlugin(label);

         if (plugin != null)

         {

             final Map labelMap = holder.getLocalizedLabelMap( resourceBundleManager, locale, this.defaultCategory );

             final Object flatLabelMap = labelMap.remove( WebConsoleConstants.ATTR_LABEL_MAP );

             // the official request attributes

             request.setAttribute(WebConsoleConstants.ATTR_LANG_MAP, getLangMap());

             request.setAttribute(WebConsoleConstants.ATTR_LABEL_MAP, flatLabelMap);

             request.setAttribute( ATTR_LABEL_MAP_CATEGORIZED, labelMap );

             request.setAttribute(WebConsoleConstants.ATTR_APP_ROOT,

                 request.getContextPath() + request.getServletPath());

             request.setAttribute(WebConsoleConstants.ATTR_PLUGIN_ROOT,

                 request.getContextPath() + request.getServletPath() + '/' + label);

             // deprecated request attributes

             request.setAttribute(ATTR_LABEL_MAP_OLD, flatLabelMap);

             request.setAttribute(ATTR_APP_ROOT_OLD,

                 request.getContextPath() + request.getServletPath());

             // fix for https://issues.apache.org/jira/browse/FELIX-3408

             ensureLocaleCookieSet(request, response, locale);

             // wrap the response for localization and template variable replacement

             request = wrapRequest(request, locale);

             response = wrapResponse(request, response, plugin);

             plugin.service(request, response);

         }

         else

         {

             final String body404 = MessageFormat.format(

                 resourceBundleManager.getResourceBundle(bundleContext.getBundle(), locale).getString(

                     "404"), //$NON-NLS-1$

                 new Object[] { request.getContextPath() + request.getServletPath() + '/'

                     + BundlesServlet.NAME });

             response.setCharacterEncoding("utf-8"); //$NON-NLS-1$

             response.setContentType("text/html"); //$NON-NLS-1$

             response.setStatus(HttpServletResponse.SC_NOT_FOUND);

             response.getWriter().println(body404);

         }

     }

     private final AbstractWebConsolePlugin getConsolePlugin(final String label)

     {

         // backwards compatibility for the former "install" action which is

         // used by the Maven Sling Plugin

         if ("install".equals(label)) //$NON-NLS-1$

         {

             return holder.getPlugin(BundlesServlet.NAME);

         }

         AbstractWebConsolePlugin plugin = holder.getPlugin( label );

         if ( plugin == null && label.indexOf( '.' ) > 0 )

         {

             int last = 0;

             for ( int dot = label.indexOf( '.', last ); plugin == null && dot > last; last = dot + 1, dot = label

                 .indexOf( '.', last ) )

             {

                 final String pluginLabel = label.substring( 0, dot );

                 plugin = holder.getPlugin( pluginLabel );

             }

         }

         return plugin;

     }

     // See https://issues.apache.org/jira/browse/FELIX-2267

     private final Locale getConfiguredLocale(HttpServletRequest request)

     {

         Locale locale = null;

         Cookie[] cookies = request.getCookies();

         for (int i = 0; cookies != null && i < cookies.length; i++)

         {

             if (COOKIE_LOCALE.equals(cookies[i].getName()))

             {

                 locale = Util.parseLocaleString(cookies[i].getValue());

                 break;

             }

         }

         // TODO: check UserAdmin ?

         if (locale == null)

             locale = configuredLocale;

         if (locale == null)

             locale = request.getLocale();

         return locale;

     }

    

     public void destroy()

     {

         // base class destroy not needed, since the GenericServlet.destroy

         // is an empty method

         holder.setServletContext(null);

     }

     //---------- internal

     BundleContext getBundleContext()

     {

         return bundleContext;

     }

    

     String getConfigurationPid()

     {

         return getClass().getName();

     }


    

     void log(int level, String message)

     {

         if (logLevel >= level)

         {

             ServletConfig config = getServletConfig();

             if ( config != null )

             {

                 ServletContext context = config.getServletContext();

                 if ( context != null )

                 {

                     context.log( message );

                     return;

                 }

             }

             System.err.println( message );

         }

     }