// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.cms.servlet.csadmin;

import java.util.Enumeration;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.velocity.Template;
import org.apache.velocity.context.Context;

import com.netscape.certsrv.apps.CMS;

public abstract class ConfigBaseServlet extends BaseServlet {
    /**
     *
     */
    private static final long serialVersionUID = 7692352201878710530L;

    public boolean isDisplayMode(HttpServletRequest request,
            HttpServletResponse response,
            Context context) {
        String display = request.getParameter("display");

        if (display == null) {
            return true;
        } else {
            return false;
        }
    }

    public abstract void display(HttpServletRequest request,
            HttpServletResponse response, Context context);

    public abstract void update(HttpServletRequest request,
            HttpServletResponse response, Context context);

    public abstract Template getTemplate(HttpServletRequest request,
            HttpServletResponse response,
            Context context);

    public void outputHttpParameters(HttpServletRequest httpReq) {
        CMS.debug("ConfigBaseServlet:service() uri = " + httpReq.getRequestURI());
        @SuppressWarnings("unchecked")
        Enumeration<String> paramNames = httpReq.getParameterNames();

        while (paramNames.hasMoreElements()) {
            String pn = paramNames.nextElement();
            // added this facility so that password can be hidden,
            // all sensitive parameters should be prefixed with
            // __ (double underscores); however, in the event that
            // a security parameter slips through, we perform multiple
            // additional checks to insure that it is NOT displayed
            if (pn.startsWith("__") ||
                    pn.endsWith("password") ||
                    pn.endsWith("passwd") ||
                    pn.endsWith("pwd") ||
                    pn.equalsIgnoreCase("admin_password_again") ||
                    pn.equalsIgnoreCase("directoryManagerPwd") ||
                    pn.equalsIgnoreCase("bindpassword") ||
                    pn.equalsIgnoreCase("bindpwd") ||
                    pn.equalsIgnoreCase("passwd") ||
                    pn.equalsIgnoreCase("password") ||
                    pn.equalsIgnoreCase("pin") ||
                    pn.equalsIgnoreCase("pwd") ||
                    pn.equalsIgnoreCase("pwdagain") ||
                    pn.equalsIgnoreCase("uPasswd")) {
                CMS.debug("ConfigBaseServlet::service() param name='" + pn +
                         "' value='(sensitive)'");
            } else {
                CMS.debug("ConfigBaseServlet::service() param name='" + pn +
                         "' value='" + httpReq.getParameter(pn) + "'");
            }
        }
    }

    /**
     * Processes request.
     */
    public Template process(HttpServletRequest request,
            HttpServletResponse response,
            Context context) {

        if (CMS.debugOn()) {
            outputHttpParameters(request);
        }

        if (isDisplayMode(request, response, context)) {
            display(request, response, context);
        } else {
            update(request, response, context);
        }

        Template template = null;

        try {
            context.put("name", "Velocity Test");
            template = getTemplate(request, response, context);
        } catch (Exception e) {
            System.err.println("Exception caught: " + e.getMessage());
        }

        return template;
    }
}