/*
 * PasswordLogin.java
 * 
 * Version: $Revision: 3705 $
 * 
 * Date: $Date: 2009-04-11 13:02:24 -0400 (Sat, 11 Apr 2009) $
 * 
 * Copyright (c) 2002-2005, Hewlett-Packard Company and Massachusetts Institute
 * of Technology. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 * 
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * 
 * - Neither the name of the Hewlett-Packard Company nor the name of the
 * Massachusetts Institute of Technology nor the names of their contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package org.dspace.app.xmlui.aspect.eperson;

import java.io.IOException;
import java.io.Serializable;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;

import javax.servlet.http.HttpSession;

import org.apache.avalon.framework.parameters.Parameters;
import org.apache.cocoon.ProcessingException;
import org.apache.cocoon.caching.CacheableProcessingComponent;
import org.apache.cocoon.environment.ObjectModelHelper;
import org.apache.cocoon.environment.Request;
import org.apache.cocoon.environment.SourceResolver;
import org.apache.excalibur.source.SourceValidity;
import org.apache.excalibur.source.impl.validity.NOPValidity;
import org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer;
import org.dspace.app.xmlui.utils.AuthenticationUtil;
import org.dspace.app.xmlui.wing.Message;
import org.dspace.app.xmlui.wing.WingException;
import org.dspace.app.xmlui.wing.element.Body;
import org.dspace.app.xmlui.wing.element.Cell;
import org.dspace.app.xmlui.wing.element.Division;
import org.dspace.app.xmlui.wing.element.PageMeta;
import org.dspace.app.xmlui.wing.element.Row;
import org.dspace.app.xmlui.wing.element.Table;
import org.dspace.app.xmlui.wing.element.Text;
import org.xml.sax.SAXException;

/**
 * Query the user for their authentication credentials.
 * 
 * The parameter "return-url" may be passed to give a location where to redirect
 * the user to after successfully authenticating.
 * 
 * @author Sid
 * @author Scott Phillips
 * @author Kevin Clarke
 */
public class PasswordLogin extends AbstractDSpaceTransformer implements
		CacheableProcessingComponent {
	/** language strings */
	public static final Message T_title = message("xmlui.EPerson.PasswordLogin.title");

	public static final Message T_dspace_home = message("xmlui.general.dspace_home");

	public static final Message T_trail = message("xmlui.EPerson.PasswordLogin.trail");

	public static final Message T_head1 = message("xmlui.EPerson.PasswordLogin.head1");
	
	public static final Message T_reglogin_head = message("xmlui.EPerson.RegLogin.head");

	public static final Message T_email_address = message("xmlui.EPerson.PasswordLogin.email_address");

	public static final Message T_error_bad_login = message("xmlui.EPerson.PasswordLogin.error_bad_login");

	public static final Message T_password = message("xmlui.EPerson.PasswordLogin.password");

	public static final Message T_forgot_link = message("xmlui.EPerson.PasswordLogin.forgot_link");

	public static final Message T_submit_register = message("xmlui.EPerson.PasswordLogin.submitReg");

	public static final Message T_submit_login = message("xmlui.EPerson.PasswordLogin.submitLogin");

	public static final Message T_head2 = message("xmlui.EPerson.PasswordLogin.head2");

	public static final Message T_para1 = message("xmlui.EPerson.PasswordLogin.para1");

	public static final Message T_register_link = message("xmlui.EPerson.PasswordLogin.register_link");

	private static final Message T_email_address_help = message("xmlui.EPerson.StartRegistration.email_address_help");

	/** The email address previously entered */
	private String email;

	/**
	 * Determine if the user failed on their last attempt to enter an email
	 * address
	 */
	private java.util.List<String> errors;

	/**
	 * Determine if the last failed attempt was because an account allready
	 * existed for the given email address
	 */
	private boolean accountExists;

	public void setup(SourceResolver resolver, Map objectModel, String src,
			Parameters parameters) throws ProcessingException, SAXException,
			IOException {
		super.setup(resolver, objectModel, src, parameters);

		this.email = parameters.getParameter("email", "");
		this.accountExists = parameters.getParameterAsBoolean("accountExists",
				false);
		String errors = parameters.getParameter("errors", "");
		if (errors.length() > 0)
			this.errors = Arrays.asList(errors.split(","));
		else
			this.errors = new ArrayList<String>();
	}

	/**
	 * Generate the unique caching key. This key must be unique inside the space
	 * of this component.
	 */
	public Serializable getKey() {
		Request request = ObjectModelHelper.getRequest(objectModel);
		String previous_email = request.getParameter("login_email");

		// Get any message parameters
		HttpSession session = request.getSession();
		String header = (String) session
				.getAttribute(AuthenticationUtil.REQUEST_INTERRUPTED_HEADER);
		String message = (String) session
				.getAttribute(AuthenticationUtil.REQUEST_INTERRUPTED_MESSAGE);
		String characters = (String) session
				.getAttribute(AuthenticationUtil.REQUEST_INTERRUPTED_CHARACTERS);

		// If there is a message or previous email attempt then the page is not
		// cacheable
		if (header == null && message == null && characters == null
				&& previous_email == null && accountExists == false
				&& errors != null && errors.size() == 0)
			// cacheable
			return "1";
		else
			// Uncacheable
			return "0";
	}

	/**
	 * Generate the cache validity object.
	 */
	public SourceValidity getValidity() {
		Request request = ObjectModelHelper.getRequest(objectModel);
		String previous_email = request.getParameter("login_email");

		// Get any message parameters
		HttpSession session = request.getSession();
		String header = (String) session
				.getAttribute(AuthenticationUtil.REQUEST_INTERRUPTED_HEADER);
		String message = (String) session
				.getAttribute(AuthenticationUtil.REQUEST_INTERRUPTED_MESSAGE);
		String characters = (String) session
				.getAttribute(AuthenticationUtil.REQUEST_INTERRUPTED_CHARACTERS);

		// If there is a message or previous email attempt then the page is not
		// cacheable
		if (header == null && message == null && characters == null
				&& previous_email == null && errors != null
				&& errors.size() == 0 && accountExists == false)
			// Always valid
			return NOPValidity.SHARED_INSTANCE;
		else
			// invalid
			return null;
	}

	/**
	 * Set the page title and trail.
	 */
	public void addPageMeta(PageMeta pageMeta) throws WingException {
		pageMeta.addMetadata("title").addContent(T_title);

		pageMeta.addTrailLink(contextPath + "/", T_dspace_home);
		pageMeta.addTrail().addContent(T_trail);
	}

	/**
	 * Display the login form.
	 */
	public void addBody(Body body) throws SQLException, SAXException,
			WingException {
		// Check if the user has previously attempted to login.
		Request request = ObjectModelHelper.getRequest(objectModel);
		HttpSession session = request.getSession();
		String previousEmail = request.getParameter("login_email");
		boolean accountExists = parameters.getParameterAsBoolean(
				"accountExists", false);

		if (previousEmail != null) {
			email = previousEmail;
		}
		else {
			previousEmail = request.getParameter("email");
		}
		
		// Get any message parameters
		String header = (String) session
				.getAttribute(AuthenticationUtil.REQUEST_INTERRUPTED_HEADER);
		String message = (String) session
				.getAttribute(AuthenticationUtil.REQUEST_INTERRUPTED_MESSAGE);
		String characters = (String) session
				.getAttribute(AuthenticationUtil.REQUEST_INTERRUPTED_CHARACTERS);

		if (header != null || message != null || characters != null) {
			Division reason = body.addDivision("login-reason");

			if (header != null)
				reason.setHead(message(header));
			else
				// Always have a head.
				reason.setHead("Authentication Required");

			if (message != null)
				reason.addPara(message(message));

			if (characters != null)
				reason.addPara(characters);
		}

		body.addDivision("reglogin-header", "").addPara(T_reglogin_head);

	//	Division register = body.addInteractiveDivision("register",
	//			contextPath + "/register", Division.METHOD_POST,
	//			"register-left");

	// Table regTable = register.addTable("register", 2, 2);

	  //  regTable.setHead(T_head1);
	//	Row regRow1 = regTable.addRow();
	//	Cell regRow1Cell1 = regRow1.addCell();
	//	Cell regRow1Cell2 = regRow1.addCell();
	  //  regRow1Cell1.addContent(T_email_address);
	//	Text regEmail = regRow1Cell2.addText("email");
	//	regEmail.setRequired();
	//	regEmail.setLabel(T_email_address);
	//	regEmail.setHelp(T_email_address_help);
	//	if (previousEmail != null) {
	//		regEmail.setValue(previousEmail);
	//		regEmail.addError(T_error_bad_login);
	//	}

	//	Row regRow3 = regTable.addRow();
	 //   Cell regRow3Cell1 = regRow3.addCell();
	//	Cell regRow3Cell2 = regRow3.addCell();
	//	if (knot != null) {
	//		regRow3Cell1.addHidden("eperson-continue").setValue(knot.getId());
	//	}
	//	regRow3Cell2.addButton("submit").setValue(T_submit_register);

		Division login = body.addInteractiveDivision("login", contextPath
				+ "/password-login", Division.METHOD_POST, "login-right");

		Table loginTable = login.addTable("login", 3, 2);
		loginTable.setHead(T_head2);

		Row loginRow1 = loginTable.addRow();
		Cell loginRow1Cell1 = loginRow1.addCell();
		Cell loginRow1Cell2 = loginRow1.addCell();
		loginRow1Cell1.addContent(T_email_address);
		Text loginEmail = loginRow1Cell2.addText("login_email");
		loginEmail.setRequired();
		loginEmail.setLabel(T_email_address);
		if (previousEmail != null) {
			loginEmail.setValue(previousEmail);
			loginEmail.addError(T_error_bad_login);
		}

		Row loginRow2 = loginTable.addRow();
		Cell loginRow2Cell1 = loginRow2.addCell();
		Cell loginRow2Cell2 = loginRow2.addCell();
		loginRow2Cell1.addContent(T_password);
		loginRow2Cell2.addPassword("login_password").setRequired();

		Row loginRow3 = loginTable.addRow();
		Cell loginRow3Cell1 = loginRow3.addCell();
		Cell loginRow3Cell2 = loginRow3.addCell();
		loginRow3Cell2.addButton("submit").setValue(T_submit_login);
		
		// login.addPara().addXref("/forgot", T_forgot_link);
	}

	// HttpServletRequest  httpRequest  = (HttpServletRequest)  objectModel.get(HttpEnvironment.HTTP_REQUEST_OBJECT);
	
	/**
	 * Recycle
	 */
	public void recycle() {
		this.email = null;
		this.errors = null;
		super.recycle();
	}
}