// --- 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.io.IOException;
import java.io.FileInputStream;
import java.util.Locale;

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

import org.w3c.dom.Node;

import com.netscape.certsrv.apps.CMS;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.IConfigStore;
import com.netscape.cms.servlet.base.CMSServlet;
import com.netscape.cms.servlet.base.UserInfo;
import com.netscape.cms.servlet.common.CMSRequest;
import com.netscape.cmsutil.xml.XMLObject;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;

public class GetStatus extends CMSServlet {

    /**
     *
     */
    private static final long serialVersionUID = -2852842030221659847L;
    // File below will be a member of a pki theme package.
    private static final String productVersionFILE = "/usr/share/pki/CS_SERVER_VERSION";

    public GetStatus() {
        super();
    }

    /**
     * initialize the servlet.
     *
     * @param sc servlet configuration, read from the web.xml file
     */
    public void init(ServletConfig sc) throws ServletException {
        super.init(sc);
    }

    /**
     * Process the HTTP request.
     *
     * @param cmsReq the object holding the request and response information
     */
    protected void process(CMSRequest cmsReq) throws EBaseException {
        HttpServletResponse httpResp = cmsReq.getHttpResp();
        IConfigStore config = CMS.getConfigStore();

        String state = config.getString("cs.state", "");
        String type = config.getString("cs.type", "");
        String status = CMS.getServerStatus();
        String version = GetStatus.class.getPackage().getImplementationVersion();

        try {
            XMLObject xmlObj = null;

            xmlObj = new XMLObject();

            Node root = xmlObj.createRoot("XMLResponse");

            xmlObj.addItemToContainer(root, "State", state);
            xmlObj.addItemToContainer(root, "Type", type);
            xmlObj.addItemToContainer(root, "Status", status);
            xmlObj.addItemToContainer(root, "Version", version);
            // File below will be a member of a pki theme package.
            String productVersion = getProductVersion(productVersionFILE);

            if(!StringUtils.isEmpty(productVersion)) {
                xmlObj.addItemToContainer(root,"ProductVersion", productVersion);
            }

            byte[] cb = xmlObj.toByteArray();

            outputResult(httpResp, "application/xml", cb);
        } catch (Exception e) {
            CMS.debug("Failed to send the XML output");
        }
    }

    protected void renderResult(CMSRequest cmsReq) throws IOException {// do nothing, ie, it will not return the default javascript.
    }

    /**
     * Retrieves locale based on the request.
     */
    protected Locale getLocale(HttpServletRequest req) {
        Locale locale = null;
        String lang = req.getHeader("accept-language");

        if (lang == null) {
            // use server locale
            locale = Locale.getDefault();
        } else {
            locale = new Locale(UserInfo.getUserLanguage(lang),
                    UserInfo.getUserCountry(lang));
        }
        return locale;
    }

    /**
     * Return the product version if the file: /usr/share/pki/CS_SERVER_VERSION
     * exists.
     *
     * Caller only cares if there is a string or not, exceptions handled here.
     */
    private String getProductVersion(String versionFilePathName) {
        String version = null;
        FileInputStream inputStream = null;

        if(StringUtils.isEmpty(versionFilePathName)) {
            CMS.debug("Missing product version file path!");
            return null;
        }

        try {
            inputStream = new FileInputStream(versionFilePathName);
            String contents = IOUtils.toString(inputStream);

            if(contents != null) {
                CMS.debug("Returning product version: " + version);
                version = contents.trim();
            }
        } catch (Exception e) {
            CMS.debug("Failed to read product version String. " + e);
        }
        finally {
            if(inputStream != null) {
                try {
                    inputStream.close();
                } catch (IOException e) {
                }
            }
        }
        return version;
    }
}
