EDIT

/**

* Copyright (C) 2007 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.taxeditor.ui.group.grantedauthority;

import java.util.ArrayList;

import java.util.EnumSet;

import java.util.Iterator;

import java.util.List;

import java.util.Set;

import org.eclipse.jface.viewers.ContentViewer;

import org.eclipse.jface.viewers.ISelection;

import org.eclipse.swt.SWT;

import org.eclipse.swt.custom.ScrolledComposite;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Control;

import org.springframework.security.core.GrantedAuthority;

import eu.etaxonomy.cdm.model.common.CdmBase;

import eu.etaxonomy.cdm.model.permission.GrantedAuthorityImpl;

import eu.etaxonomy.cdm.model.permission.Group;

import eu.etaxonomy.cdm.model.permission.CRUD;

import eu.etaxonomy.cdm.persistence.hibernate.permission.CdmAuthority;

import eu.etaxonomy.taxeditor.model.IDirtyMarkable;

import eu.etaxonomy.taxeditor.model.MessagingUtils;

/**

 * Viewer class for the {@link CdmAuthorityComposite} used in the editing of CDM Authorities.

 *

 * @author cmathew

 * @created Mar 28, 2013

 *

 */

//FIXME:move warning dialogs to the table class

public class CdmAuthorityCompositeViewer extends ContentViewer {

	private IDirtyMarkable dirtyMarkerEditor;

	private CdmAuthorityComposite cdmAuthorityComposite;

	private Group group;

	private boolean isDirty = false;

	/**

	 * List which contains already existing authority objects.

	 */

	private List<GrantedAuthorityImpl> cdmAuthorities;

	/**

	 * List which contains newly added (unsaved) authority objects.

	 * Used to make sure that new authority objects are always added

	 * to the top of the table.

	 */

	private List<GrantedAuthorityImpl> newCdmAuthorities;

	/**

	 * Creates a viewer with a {@link CdmAuthorityComposite} table, {@link Group} object as input

	 *

	 * @param composite parent of generated {@link CdmAuthorityComposite}

	 * @param dirtyMarkerEditor provider to mark as dirty

	 * @param group input data object

	 */

	public CdmAuthorityCompositeViewer(Composite composite,

			IDirtyMarkable dirtyMarkerEditor,

			Group group) {

		this.dirtyMarkerEditor = dirtyMarkerEditor;

		this.group = group;

		newCdmAuthorities = new ArrayList<GrantedAuthorityImpl>();

		updateAuthorities();

		ScrolledComposite sc = new ScrolledComposite(composite, SWT.H_SCROLL | SWT.V_SCROLL);

		this.cdmAuthorityComposite = new CdmAuthorityComposite(sc, SWT.H_SCROLL | SWT.V_SCROLL, this);

		sc.setContent(cdmAuthorityComposite);

		sc.setExpandHorizontal(true);

		sc.setExpandVertical(true);

	}

	/**

	 * Gets the {@link CdmAuthorityComposite}

	 *

	 * @return {@link CdmAuthorityComposite} generated by this viewer

	 */

	public CdmAuthorityComposite getCdmAuthorityComposite() {

		return cdmAuthorityComposite;

	}

	/**

	 * Retrieves the {@link GrantedAuthorityImpl} objects of the group attached to this viewer

	 * creates a sub-list of only {@link CdmAuthority} objects.

	 *

	 * @return list of {@link CdmAuthority} objects belonging to the input group

	 */

	public List<GrantedAuthorityImpl> updateAuthorities()  {

		// get all granted authorities

		Set<GrantedAuthority> grantedAuthorities = group.getGrantedAuthorities();

		cdmAuthorities = new ArrayList<GrantedAuthorityImpl>();

		Iterator<GrantedAuthority> itr = grantedAuthorities.iterator();

		while (itr.hasNext()) {

			GrantedAuthority grantedAuthority = itr.next();

			try {

				if(grantedAuthority != null && grantedAuthority instanceof GrantedAuthorityImpl) {

					// create a cdm authority from a granted authority

					// this could fail in which case an exception is thrown

					CdmAuthority cdmAuthority = CdmAuthority.fromGrantedAuthority(grantedAuthority);

					cdmAuthorities.add((GrantedAuthorityImpl)grantedAuthority);

				}

			} catch (Exception e) {

				// not a CdmAuthority

				//e.printStackTrace();

			}

		}

		return cdmAuthorities;

	}

	public boolean isDirty() {

		return isDirty;

	}

	/**

	 * Adds a new {@link CdmAuthority} to the group attached to this viewer

	 * based on the input {@link CdmBase} object.

	 *

	 * @param cb {@link CdmBase} object used to construct the cdm authority

	 */

	public void addCdmAuthority(CdmBase cb) {

		// Default permission is to READ

		EnumSet<CRUD> defaultOperation = EnumSet.noneOf(CRUD.class);

		defaultOperation.add(CRUD.READ);

		CdmAuthority cdma = new CdmAuthority(cb, defaultOperation);

		GrantedAuthorityImpl gai;

		try {

			// create a granted authority from a cdm authority

			gai = cdma.asNewGrantedAuthority();

		} catch (Exception e) {

			MessagingUtils.warningDialog("Parsing Error", this, "Could not parse authority string");

			return;

		}

		//FIXME : this contains call will allow users to add authorities which differ only in CRUD operation choice.

		//        need to have a comparator which only checks permission class and uuid

		if(cdmAuthorities.contains(gai) || newCdmAuthorities.contains(gai)) {

			MessagingUtils.warningDialog("Duplicate CDM Authority", this, "Chosen CDM Authority is already attached to current group");

		} else {

			group.addGrantedAuthority(gai);

			newCdmAuthorities.add(gai);

			isDirty = true;

			dirtyMarkerEditor.changed(group);

			cdmAuthorityComposite.refresh();

		}

	}

	/**

	 * Removes the given {@link GrantedAuthorityImpl} object from the list of

	 * granted authorities belonging to the group attached to this viewer.

	 *

	 * @param gai {@link GrantedAuthorityImpl} object to remove

	 */

	public void removeCdmAuthority(GrantedAuthorityImpl gai) {

		if(cdmAuthorities.contains(gai)) {

			cdmAuthorities.remove(gai);

			isDirty = true;

		} else {

			newCdmAuthorities.remove(gai);

			if(newCdmAuthorities.isEmpty() && !isDirty) {

				isDirty = false;

			}

		}

		group.removeGrantedAuthority(gai);

		dirtyMarkerEditor.changed(group);

		cdmAuthorityComposite.refresh();

	}

	/**

	 * Updates an existing {@link GrantedAuthorityImpl} object using a {@link CdmAuthority} object.

	 *

	 * @param grantedAuthorityI to update.

	 * @param cdmAuthority to use in updating the granted authority object.

	 */

	public GrantedAuthorityImpl updateGrantedAuthority(GrantedAuthorityImpl grantedAuthorityI, CdmAuthority cdmAuthority) {

		if(grantedAuthorityI.getAuthority().equals(cdmAuthority.getAuthority())) {

		} else {

			try {

				// since granted authority is just a wrapper object around a string

				// we can't really 'update' the granted authority.

				// so we first add the new authority (hope no exception) is thrown

				// and then remove the old one.

				GrantedAuthorityImpl gai = cdmAuthority.asNewGrantedAuthority();

				group.addGrantedAuthority(gai);

				group.removeGrantedAuthority(grantedAuthorityI);

				isDirty = true;

				dirtyMarkerEditor.changed(grantedAuthorityI);

				return gai;

			} catch(Exception e) {

				// Not a CDM Authority

				//e.printStackTrace();

			}

		}

		return grantedAuthorityI;

	}

	/**

	 * @return list of existing cdm authority objects

	 */

	public List<GrantedAuthorityImpl> getCdmAuthorities() {

		return cdmAuthorities;

	}

	/**

	 * @return list of newly added cdm authority objects

	 */

	public List<GrantedAuthorityImpl> getNewCdmAuthorities() {

		return newCdmAuthorities;

	}

	/**

	 * Empty the list of newly create autrity objects

	 */

	public void clearNewCdmAuthorities() {

		newCdmAuthorities.clear();

	}

	/**

	 *

	 *

	 */

	public void save() {

		clearNewCdmAuthorities();

		refresh();

	}

	/* (non-Javadoc)

	 * @see org.eclipse.jface.viewers.Viewer#getControl()

	 */

	@Override

	public Control getControl() {

		return cdmAuthorityComposite;

	}

	/* (non-Javadoc)

	 * @see org.eclipse.jface.viewers.Viewer#getSelection()

	 */

	@Override

	public ISelection getSelection() {

		// TODO Auto-generated method stub

		return null;

	}

	/* (non-Javadoc)

	 * @see org.eclipse.jface.viewers.Viewer#refresh()

	 */

	@Override

	public void refresh() {

		updateAuthorities();

		cdmAuthorityComposite.refresh();

	}

	/* (non-Javadoc)

	 * @see org.eclipse.jface.viewers.Viewer#setSelection(org.eclipse.jface.viewers.ISelection, boolean)

	 */

	@Override

	public void setSelection(ISelection selection, boolean reveal) {

		// TODO Auto-generated method stub

	}

}