Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A Class that implements login methods

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

 *             National Center for Ecological Analysis and Synthesis

 *    ors: Michael Daigle

 *

 *   '$or: daigle $'

 *     '$Date: 2011-06-07 09:53:46 -0700 (Tue, 07 Jun 2011) $'

 * '$Revision: 6124 $'

 *

 * 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.util.Vector;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.apache.log4j.Logger;

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

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

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

/**

 * Control the display of the login page 

 */

public class LoginAdmin extends MetacatAdmin {

	private static LoginAdmin Admin = null;

	private static Logger logMetacat = Logger.getLogger(LoginAdmin.class);

	/**

	 * private constructor since this is a singleton

	 */

	private LoginAdmin() {}

	/**

	 * Get the single instance of LoginAdmin.

	 * 

	 * @return the single instance of LoginAdmin

	 */

	public static LoginAdmin getInstance() {

		if (Admin == null) {

			Admin = new LoginAdmin();

		}

		return Admin;

	}

	/**

	 * Handle configuration of the Authentication properties

	 * 

	 * @param request

	 *            the http request information

	 * @param response

	 *            the http response to be sent back to the client

	 */

	public void authenticateUser(HttpServletRequest request,

			HttpServletResponse response) throws AdminException {

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

		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 {

				request.setAttribute("adminList", AuthUtil.getAdministrators());

				// Forward the request to the JSP page

				RequestUtil.forwardRequest(request, response,

						"/admin/admin-login.jsp", null);

			} catch (MetacatUtilException mue) {

				throw new AdminException("LoginAdmin.authenticateUser - Utility problem while " + 

						"processing login page: " + mue.getMessage());

			} 

		} else {

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

			// processed.

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

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

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

			String userName = "";

				userName = request.getParameter("username");

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

				// 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));

				if (validationErrors.size() == 0) {

					try {

						AuthUtil.logUserIn(request, userName, password);

					} catch (MetacatUtilException ue) {

						String errorMessage = "LoginAdmin.authenticateUser - Could not log in as: " + userName

						+ " : " + ue.getMessage() + ". Please try again";

						processingErrors.add(errorMessage);

						logMetacat.error(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 {

					// Reload the main metacat configuration page

					processingSuccess.add("User logged in as: " + userName);

					RequestUtil.clearRequestMessages(request);

					RequestUtil.setUserId(request, userName);

					RequestUtil.setRequestSuccess(request, processingSuccess);

					RequestUtil.forwardRequest(request, response,

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

				}

			} catch (MetacatUtilException mue) {

				throw new AdminException("LoginAdmin.authenticateUser - IO problem while processing login page: " 

						+ mue.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;

	}

}