Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A Class that implements database configuration methods

 *  Copyright: 2008 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Michael Daigle

 * 

 *   '$Author: leinfelder $'

 *     '$Date: 2011-12-16 16:24:17 -0800 (Fri, 16 Dec 2011) $'

 * '$Revision: 6803 $'

 *

 * 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; either version 2 of the License, or

 * (at your option) any later version.

 *

 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.admin;

import java.io.File;

import java.util.Vector;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.apache.log4j.Logger;

import org.dataone.client.CNode;

import org.dataone.client.D1Client;

import org.dataone.client.auth.CertificateManager;

import org.dataone.service.exceptions.BaseException;

import org.dataone.service.exceptions.IdentifierNotUnique;

import org.dataone.service.exceptions.InvalidRequest;

import org.dataone.service.exceptions.InvalidToken;

import org.dataone.service.exceptions.NotAuthorized;

import org.dataone.service.exceptions.NotFound;

import org.dataone.service.exceptions.NotImplemented;

import org.dataone.service.exceptions.ServiceFailure;

import org.dataone.service.types.v1.Node;

import org.dataone.service.types.v1.NodeList;

import org.dataone.service.types.v1.NodeReference;

import org.dataone.service.types.v1.Session;

import edu.ucsb.nceas.metacat.dataone.MNodeService;

import edu.ucsb.nceas.metacat.properties.PropertyService;

import edu.ucsb.nceas.metacat.shared.MetacatUtilException;

import edu.ucsb.nceas.metacat.util.RequestUtil;

import edu.ucsb.nceas.metacat.util.SystemUtil;

import edu.ucsb.nceas.utilities.FileUtil;

import edu.ucsb.nceas.utilities.GeneralPropertyException;

import edu.ucsb.nceas.utilities.PropertyNotFoundException;

/**

 * Control the display of the database configuration page and the processing

 * of the configuration values.

 */

public class D1Admin extends MetacatAdmin {

	private static D1Admin instance = null;

	private Logger logMetacat = Logger.getLogger(D1Admin.class);

	/**

	 * private constructor since this is a singleton

	 */

	private D1Admin() throws AdminException {

	}

	/**

	 * Get the single instance of D1Admin.

	 * 

	 * @return the single instance of D1Admin

	 */

	public static D1Admin getInstance() throws AdminException {

		if (instance == null) {

			instance = new D1Admin();

		}

		return instance;

	}

	/**

	 * Handle configuration of the database the first time that Metacat starts

	 * or when it is explicitly called. Collect necessary update information

	 * from the administrator.

	 * 

	 * @param request

	 *            the http request information

	 * @param response

	 *            the http response to be sent back to the client

	 */

	public void configureDataONE(HttpServletRequest request,

			HttpServletResponse response) throws AdminException {

		String processForm = request.getParameter("processForm");

		String bypass = request.getParameter("bypass");

		String formErrors = (String) request.getAttribute("formErrors");

		if (processForm == null || !processForm.equals("true") || formErrors != null) {

			// The servlet configuration parameters have not been set, or there

			// were form errors on the last attempt to configure, so redirect to

			// the web form for configuring metacat

			try {

				// get the current configuration values

				String nodeName = PropertyService.getProperty("dataone.nodeName");

				String nodeDescription = PropertyService.getProperty("dataone.nodeDescription");

				String memberNodeId = PropertyService.getProperty("dataone.memberNodeId");

				String nodeSynchronize = PropertyService.getProperty("dataone.nodeSynchronize");

				String nodeReplicate = PropertyService.getProperty("dataone.nodeReplicate");

				String subject = PropertyService.getProperty("dataone.subject");

				String certpath = PropertyService.getProperty("D1Client.certificate.file");

				//the synch schedule

				String year = PropertyService.getProperty("dataone.nodeSynchronization.schedule.year");

				String mon = PropertyService.getProperty("dataone.nodeSynchronization.schedule.mon");

				String mday = PropertyService.getProperty("dataone.nodeSynchronization.schedule.mday");

				String wday = PropertyService.getProperty("dataone.nodeSynchronization.schedule.wday");

				String hour = PropertyService.getProperty("dataone.nodeSynchronization.schedule.hour");

				String min = PropertyService.getProperty("dataone.nodeSynchronization.schedule.min");

				String sec = PropertyService.getProperty("dataone.nodeSynchronization.schedule.sec");

				/**

				dataone.nodeSynchronization.schedule.year=*

				dataone.nodeSynchronization.schedule.mon=*

				dataone.nodeSynchronization.schedule.mday=*

				dataone.nodeSynchronization.schedule.wday=?

				dataone.nodeSynchronization.schedule.hour=*

				dataone.nodeSynchronization.schedule.min=0/3

				dataone.nodeSynchronization.schedule.sec=10

				**/

				boolean synchronize = false;

				if (nodeSynchronize != null) {

					synchronize = Boolean.parseBoolean(nodeSynchronize);

				}

				boolean replicate = false;

				if (nodeReplicate != null) {

					replicate = Boolean.parseBoolean(nodeReplicate);

				}

				request.setAttribute("dataone.nodeName", nodeName);

				request.setAttribute("dataone.nodeDescription", nodeDescription);

				request.setAttribute("dataone.memberNodeId", memberNodeId);

				request.setAttribute("dataone.nodeSynchronize", synchronize);

				request.setAttribute("dataone.nodeReplicate", replicate);

				request.setAttribute("dataone.subject", subject);

				request.setAttribute("D1Client.certificate.file", certpath);

				// synch schedule

				request.setAttribute("dataone.nodeSynchronization.schedule.year", year);

				request.setAttribute("dataone.nodeSynchronization.schedule.mon", mon);

				request.setAttribute("dataone.nodeSynchronization.schedule.mday", mday);

				request.setAttribute("dataone.nodeSynchronization.schedule.wday", wday);

				request.setAttribute("dataone.nodeSynchronization.schedule.hour", hour);

				request.setAttribute("dataone.nodeSynchronization.schedule.min", min);

				request.setAttribute("dataone.nodeSynchronization.schedule.sec", sec);

				// Forward the request to the JSP page

				RequestUtil.forwardRequest(request, response, "/admin/dataone-configuration.jsp", null);

			} catch (GeneralPropertyException gpe) {

				throw new AdminException("D1Admin.configureDataONE - Problem getting or " + 

						"setting property while initializing system properties page: " + gpe.getMessage());

			} catch (MetacatUtilException mue) {

				throw new AdminException("D1Admin.configureDataONE - utility problem while initializing "

						+ "system properties page:" + mue.getMessage());

			} 

		} else if (bypass != null && bypass.equals("true")) {

			Vector<String> processingErrors = new Vector<String>();

			Vector<String> processingSuccess = new Vector<String>();

			// Bypass the D1 configuration. 

			// This will keep Metacat running

			try {

				PropertyService.setProperty("configutil.dataoneConfigured", PropertyService.BYPASSED);

			} catch (GeneralPropertyException gpe) {

				String errorMessage = "D1Admin.configureDataONE - Problem getting or setting property while "

					+ "processing system properties page: " + gpe.getMessage();

				logMetacat.error(errorMessage);

				processingErrors.add(errorMessage);

			}

			try {

				if (processingErrors.size() > 0) {

					RequestUtil.clearRequestMessages(request);

					RequestUtil.setRequestErrors(request, processingErrors);

					RequestUtil.forwardRequest(request, response, "/admin", null);

				} else {			

					// Reload the main metacat configuration page

					processingSuccess.add("DataONE configuration successfully bypassed");

					RequestUtil.clearRequestMessages(request);

					RequestUtil.setRequestSuccess(request, processingSuccess);

					RequestUtil.forwardRequest(request, response, 

							"/admin?configureType=configure&processForm=false", null);

				}

			} catch (MetacatUtilException mue) {

				throw new AdminException("D1Admin.configureDataONE - utility problem while processing dataone page: "

						+ mue.getMessage());

			} 

		} else {

			// The configuration form is being submitted and needs to be

			// processed, setting the properties in the configuration file

			// then restart metacat

			// The configuration form is being submitted and needs to be

			// processed.

			Vector<String> validationErrors = new Vector<String>();

			Vector<String> processingErrors = new Vector<String>();

			Vector<String> processingSuccess = new Vector<String>();

			try {

				// Validate that the options provided are legitimate. Note that

				// we've allowed them to persist their entries. As of this point

				// there is no other easy way to go back to the configure form

				// and preserve their entries.

				validationErrors.addAll(validateOptions(request));

				String nodeName = (String)request.getParameter("dataone.nodeName");

				String nodeDescription = (String)request.getParameter("dataone.nodeDescription");

				String memberNodeId = (String)request.getParameter("dataone.memberNodeId");

				String nodeSynchronize = (String)request.getParameter("dataone.nodeSynchronize");

				String nodeReplicate = (String)request.getParameter("dataone.nodeReplicate");

				String subject = (String)request.getParameter("dataone.subject");

				String certpath = (String)request.getParameter("D1Client.certificate.file");

				// the synch schedule

				String year = (String) request.getParameter("dataone.nodeSynchronization.schedule.year");

				String mon = (String) request.getParameter("dataone.nodeSynchronization.schedule.mon");

				String mday = (String) request.getParameter("dataone.nodeSynchronization.schedule.mday");

				String wday = (String) request.getParameter("dataone.nodeSynchronization.schedule.wday");

				String hour = (String) request.getParameter("dataone.nodeSynchronization.schedule.hour");

				String min = (String) request.getParameter("dataone.nodeSynchronization.schedule.min");

				String sec = (String) request.getParameter("dataone.nodeSynchronization.schedule.sec");

				boolean synchronize = false;

				if (nodeSynchronize != null) {

					synchronize = Boolean.parseBoolean(nodeSynchronize);

				}

				boolean replicate = false;

				if (nodeReplicate != null) {

					replicate = Boolean.parseBoolean(nodeReplicate);

				}

				// process the values, checking for nulls etc..

				if (nodeName == null ) {

					validationErrors.add("nodeName cannot be null");

				} else {

					PropertyService.setPropertyNoPersist("dataone.nodeName", nodeName);

					PropertyService.setPropertyNoPersist("dataone.nodeDescription", nodeDescription);

					PropertyService.setPropertyNoPersist("dataone.memberNodeId", memberNodeId);

					PropertyService.setPropertyNoPersist("dataone.nodeSynchronize", Boolean.toString(synchronize));

					PropertyService.setPropertyNoPersist("dataone.nodeReplicate", Boolean.toString(replicate));

					PropertyService.setPropertyNoPersist("dataone.subject", subject);

					PropertyService.setPropertyNoPersist("D1Client.certificate.file", certpath);

					// the synch schedule

					PropertyService.setPropertyNoPersist("dataone.nodeSynchronization.schedule.year", year);

					PropertyService.setPropertyNoPersist("dataone.nodeSynchronization.schedule.mon", mon);

					PropertyService.setPropertyNoPersist("dataone.nodeSynchronization.schedule.mday", mday);

					PropertyService.setPropertyNoPersist("dataone.nodeSynchronization.schedule.wday", wday);

					PropertyService.setPropertyNoPersist("dataone.nodeSynchronization.schedule.hour", hour);

					PropertyService.setPropertyNoPersist("dataone.nodeSynchronization.schedule.min", min);

					PropertyService.setPropertyNoPersist("dataone.nodeSynchronization.schedule.sec", sec);

					PropertyService.persistProperties();

					// write the backup properties to a location outside the

					// application directories so they will be available after

					// the next upgrade

					PropertyService.persistMainBackupProperties();

			        // Register as a DataONE Member Node

					if (replicate) {

						registerDataONEMemberNode();

					}

				}

			} catch (GeneralPropertyException gpe) {

				String errorMessage = "D1Admin.configureDataONE - Problem getting or setting property while "

						+ "processing system properties page: " + gpe.getMessage();

				logMetacat.error(errorMessage);

				processingErrors.add(errorMessage);

			}

			try {

				if (validationErrors.size() > 0 || processingErrors.size() > 0) {

					RequestUtil.clearRequestMessages(request);

					RequestUtil.setRequestFormErrors(request, validationErrors);

					RequestUtil.setRequestErrors(request, processingErrors);

					RequestUtil.forwardRequest(request, response, "/admin", null);

				} else {

					// Now that the options have been set, change the

					// 'dataoneConfigured' option to 'true'

					PropertyService.setProperty("configutil.dataoneConfigured",

							PropertyService.CONFIGURED);

					// Reload the main metacat configuration page

					processingSuccess.add("DataONE successfully configured");

					RequestUtil.clearRequestMessages(request);

					RequestUtil.setRequestSuccess(request, processingSuccess);

					RequestUtil.forwardRequest(request, response, 

							"/admin?configureType=configure&processForm=false", null);

				}

			} catch (MetacatUtilException mue) {

				throw new AdminException("D1Admin.configureDataONE - utility problem while processing geoservices "

						+ "geoservices page: " + mue.getMessage());

			} catch (GeneralPropertyException gpe) {

				throw new AdminException("D1Admin.configureDataONE - problem with properties while "

						+ "processing geoservices configuration page: " + gpe.getMessage());

			}

		}

	}

	/**

	 * Register as a member node on the DataONE network.  The node description is

	 * retrieved from the getCapabilities() service, and so this should only be called

	 * after the properties have been properly set up in Metacat.

	 */

	private void registerDataONEMemberNode() {

        CNode cn;

        try {

            logMetacat.debug("Get the Node description.");

            Node node = MNodeService.getInstance(null).getCapabilities();

            logMetacat.debug("Setting client certificate location.");

            String mnCertificatePath = PropertyService.getProperty("D1Client.certificate.file");

            CertificateManager.getInstance().setCertificateLocation(mnCertificatePath);

            cn = D1Client.getCN();

            // check if this is new or an update

            boolean update = false;

            NodeList nodes = cn.listNodes();

            for (Node n: nodes.getNodeList()) {

            	if (n.getIdentifier().getValue().equals(node.getIdentifier().getValue())) {

            		update = true;

            		break;

            	}

            }

            // Session is null, because the libclient code automatically sets up an

            // SSL session for us using the client certificate provided

            Session session = null;

            if (update) {

            	logMetacat.debug("Updating node with DataONE. " + cn.getNodeBaseServiceUrl());

	            boolean result = cn.updateNodeCapabilities(session, node.getIdentifier(), node);

            } else {

	            logMetacat.debug("Registering node with DataONE. " + cn.getNodeBaseServiceUrl());

	            NodeReference mnodeRef = cn.register(session, node);

	            // save this assigned node id

	            PropertyService.setProperty("dataone.memberNodeId", mnodeRef.getValue());

            }

        } catch (BaseException e) {

            logMetacat.warn("Could not register as node with DataONE (" + e.getCode() + "/" + e.getDetail_code() + "): " + e.getDescription());

        } catch (PropertyNotFoundException e) {

            logMetacat.warn("Could not find the location for client certificates: " + e.getMessage());

        } catch (GeneralPropertyException e) {

            logMetacat.warn("Could not set the assigned node id: " + e.getMessage());

		}

	}

	/**

	 * Validate the most important configuration options submitted by the user.

	 * 

	 * @return a vector holding error message for any fields that fail

	 *         validation.

	 */

	protected Vector<String> validateOptions(HttpServletRequest request) {

		Vector<String> errorVector = new Vector<String>();

		// TODO MCD validate options.

		return errorVector;

	}

}