/*******************************************************************************
 * Copyright (c) 2000, 2003 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.ui.views.markers.internal;

import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IWorkspaceRunnable;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.ErrorDialog;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;

/**
 * Shows the properties of a new or existing marker
 */
class DialogMarkerProperties extends Dialog {

	/**
	 * The marker being shown, or <code>null</code> for a new marker
	 */
	private IMarker marker = null;

	/**
	 * The resource on which to create a new marker
	 */
	private IResource resource = null;
	
	/**
	 * The type of marker to be created
	 */
	private String type = IMarker.MARKER;

	/**
	 * The initial attributes to use when creating a new marker
	 */
	private Map initialAttributes = null;

	/**
	 * The text control for the Description field.
	 */
	private Text descriptionText;

	/**
	 * The control for the Creation Time field.
	 */
	private Label creationTime;

	/**
	 * The text control for the Resource field.
	 */
	private Text resourceText;

	/**
	 * The text control for the Folder field.
	 */
	private Text folderText;

	/**
	 * The text control for the Location field.
	 */
	private Text locationText;

	/**
	 * Dirty flag.  True if any changes have been made.
	 */
	private boolean dirty;

	private String title;

	/**
	 * Creates the dialog.  By default this dialog creates a new marker.
	 * To set the resource and initial attributes for the new marker, 
	 * use <code>setResource</code> and <code>setInitialAttributes</code>.
	 * To show or modify an existing marker, use <code>setMarker</code>.
	 * 
	 * @param shell the parent shell
	 */
	DialogMarkerProperties(Shell parentShell) {
		super(parentShell);
	}

	/**
	 * Creates the dialog.  By default this dialog creates a new marker.
	 * To set the resource and initial attributes for the new marker, 
	 * use <code>setResource</code> and <code>setInitialAttributes</code>.
	 * To show or modify an existing marker, use <code>setMarker</code>.
	 * 
	 * @param shell the parent shell
	 * @param title the title of the dialog
	 */
	DialogMarkerProperties(Shell parentShell, String title) {
		super(parentShell);
		this.title = title;
	}

	/**
	 * @see org.eclipse.jface.window.Window#create()
	 */
	public void create() {
		super.create();
	}

	/**
	 * Sets the marker to show or modify.
	 * 
	 * @param marker the marker, or <code>null</code> to create a new marker
	 */
	void setMarker(IMarker marker) {
		this.marker = marker;
		if (marker != null) {
			try {
				type = marker.getType();
			}
			catch (CoreException e) {
			}
		}
	}

	/**
	 * Returns the marker being created or modified.
	 * For a new marker, this returns <code>null</code> until
	 * the dialog returns, but is non-null after.
	 */
	IMarker getMarker() {
		return marker;
	}

	/**
	 * Sets the resource to use when creating a new marker.
	 * If not set, the new marker is created on the workspace root.
	 */
	public void setResource(IResource resource) {
		this.resource = resource;
	}

	/**
	 * Returns the resource to use when creating a new marker,
	 * or <code>null</code> if none has been set.
	 * If not set, the new marker is created on the workspace root.
	 */
	IResource getResource() {
		return resource;
	}

	/**
	 * Sets initial attributes to use when creating a new marker.
	 * If not set, the new marker is created with default attributes.
	 */
	void setInitialAttributes(Map initialAttributes) {
		this.initialAttributes = initialAttributes;
	}

	/**
	 * Returns the initial attributes to use when creating a new marker,
	 * or <code>null</code> if not set.
	 * If not set, the new marker is created with default attributes.
	 */
	Map getInitialAttributes() {
		if (initialAttributes == null) {
			initialAttributes = new HashMap();
		}
		return initialAttributes;
	}

	/**
	 * Method declared on Window.
	 */
	protected void configureShell(Shell newShell) {
		super.configureShell(newShell);
		if (title == null)
			newShell.setText(
				Messages.getString("propertiesDialog.title")); //$NON-NLS-1$
		else
			newShell.setText(title);
	}

	/**
	 * Method declared on Dialog.
	 */
	protected Control createDialogArea(Composite parent) {
		//initialize resources/properties
		if (marker != null) {
			resource = marker.getResource();
			try {
				initialAttributes = marker.getAttributes();
			}
			catch (CoreException e) {
			}
		}
		else if (resource == null) {
			resource = ResourcesPlugin.getWorkspace().getRoot();
		}
		
		Composite composite = (Composite) super.createDialogArea(parent);
		initializeDialogUnits(composite);
		createDescriptionArea(composite);
		if (marker != null) {
			createCreationTimeArea(composite);
		}
		createAttributesArea(composite);
		if (resource != null)
			createResourceArea(composite);
		updateDialogFromMarker();
		updateEnablement();
		return composite;
	}
	/**
	 * Method createCreationTimeArea.
	 * @param composite
	 */
	private void createCreationTimeArea(Composite parent) {
		String creation = Messages.getString("propertiesDialog.creationTime.text");//$NON-NLS-1$
		
		Font font = parent.getFont();
		Composite composite = new Composite(parent, SWT.NONE);
		GridLayout layout = new GridLayout();
		layout.numColumns = 2;
		composite.setLayout(layout);

		Label label = new Label(composite, SWT.NONE);
		label.setText(creation); 
		label.setFont(font);

		creationTime = new Label(composite, SWT.NONE);
		creationTime.setFont(font);
	}

	/**
	 * Creates the OK and Cancel buttons.
	 */
	protected void createButtonsForButtonBar(Composite parent) {
		createButton(
			parent,
			IDialogConstants.OK_ID,
			IDialogConstants.OK_LABEL,
			true);
		createButton(
			parent,
			IDialogConstants.CANCEL_ID,
			IDialogConstants.CANCEL_LABEL,
			false);
	}

	/**
	 * Creates the area for the Description field.
	 */
	private void createDescriptionArea(Composite parent) {
		Font font = parent.getFont();
		Composite composite = new Composite(parent, SWT.NONE);
		GridLayout layout = new GridLayout();
		layout.numColumns = 2;
		composite.setLayout(layout);
		Label label = new Label(composite, SWT.NONE);
		label.setText(Messages.getString("propertiesDialog.description.text")); //$NON-NLS-1$
		label.setFont(font);
		int style = SWT.SINGLE | SWT.BORDER;
		descriptionText = new Text(composite, style);
		GridData gridData = new GridData(GridData.FILL_HORIZONTAL);
		gridData.widthHint = convertHorizontalDLUsToPixels(400);
		descriptionText.setLayoutData(gridData);
		descriptionText.setFont(font);
		
		descriptionText.addModifyListener(new ModifyListener() {
			public void modifyText(ModifyEvent e) {
				markDirty();
			}
		});
	}
	
	/**
	 * This method is intended to be overridden by subclasses. The attributes area is created between
	 * the creation time area and the resource area.
	 * 
	 * @param parent the parent composite
	 */
	protected void createAttributesArea(Composite parent) {
	}

	/**
	 * Creates the area for the Resource field.
	 */
	private void createResourceArea(Composite parent) {
		Font font = parent.getFont();
		Composite composite = new Composite(parent, SWT.NONE);
		GridData gridData = new GridData(GridData.FILL_HORIZONTAL);
		composite.setLayoutData(gridData);
		GridLayout layout = new GridLayout();
		layout.numColumns = 2;
		composite.setLayout(layout);

		Label resourceLabel = new Label(composite, SWT.NONE);
		resourceLabel.setText(Messages.getString("propertiesDialog.resource.text")); //$NON-NLS-1$
		resourceLabel.setFont(font);
		resourceText =
			new Text(
				composite,
				SWT.SINGLE | SWT.WRAP | SWT.READ_ONLY | SWT.BORDER);
		gridData = new GridData(GridData.FILL_HORIZONTAL);
		resourceText.setLayoutData(gridData);
		resourceText.setFont(font);

		Label folderLabel = new Label(composite, SWT.NONE);
		folderLabel.setText(Messages.getString("propertiesDialog.folder.text")); //$NON-NLS-1$
		folderLabel.setFont(font);
		folderText =
			new Text(
				composite,
				SWT.SINGLE | SWT.WRAP | SWT.READ_ONLY | SWT.BORDER);
		gridData = new GridData(GridData.FILL_HORIZONTAL);
		folderText.setLayoutData(gridData);
		folderText.setFont(font);

		Label locationLabel = new Label(composite, SWT.NONE);
		locationLabel.setText(Messages.getString("propertiesDialog.location.text")); //$NON-NLS-1$
		locationLabel.setFont(font);
		locationText =
			new Text(
				composite,
				SWT.SINGLE | SWT.WRAP | SWT.READ_ONLY | SWT.BORDER);
		gridData = new GridData(GridData.FILL_HORIZONTAL);
		locationText.setLayoutData(gridData);
		locationText.setFont(font);
	}

	/**
	 * Updates the dialog from the marker state.
	 */
	protected void updateDialogFromMarker() {
		if (marker == null) {
			updateDialogForNewMarker();
			return;			
		}
		descriptionText.setText(Util.getProperty(IMarker.MESSAGE, marker));
		if (creationTime != null)
			creationTime.setText(Util.getCreationTime(marker));
		if (resourceText != null)
			resourceText.setText(Util.getResourceName(marker));
		if (folderText != null)
			folderText.setText(Util.getContainerName(marker));
		if (locationText != null) {
			String line = Util.getProperty(IMarker.LINE_NUMBER, marker);
			if (line.equals("")) //$NON-NLS-1$
				locationText.setText(""); //$NON-NLS-1$
			else
				locationText.setText(Messages.format("label.lineNumber", new String[] {line})); //$NON-NLS-1$
		}

		descriptionText.selectAll();
	}
	
	/**
	 * Updates the dialog from the predefined attributes.
	 */
	protected void updateDialogForNewMarker() {
		if (resource != null && resourceText != null && folderText != null) {
			resourceText.setText(resource.getName());
			
			IPath path = resource.getFullPath();
			int n = path.segmentCount() - 1; // n is the number of segments in container, not path
			if (n > 0) {
				int len = 0;
				for (int i = 0; i < n; ++i)
					len += path.segment(i).length();
				// account for /'s
				if (n > 1)
					len += n-1;
				StringBuffer sb = new StringBuffer(len);
				for (int i = 0; i < n; ++i) {
					if (i != 0)
						sb.append('/');
					sb.append(path.segment(i));
				}
				folderText.setText(sb.toString());
			}
		}
		
		if (initialAttributes != null) {
			Object description = initialAttributes.get(IMarker.MESSAGE);
			if (description != null && description instanceof String)
				descriptionText.setText((String) description);
			descriptionText.selectAll();
				
			Object line = initialAttributes.get(IMarker.LINE_NUMBER);
			if (line != null && line instanceof Integer && locationText != null)
				locationText.setText(Messages.format("label.lineNumber", new Object[] {line})); //$NON-NLS-1$
		}
	}

	/**
	 * Method declared on Dialog
	 */
	protected void okPressed() {
		if (marker == null || Util.isEditable(marker)) {
			saveChanges();
		}
		super.okPressed();
	}

	/**
	 * Sets the dialog's dirty flag to <code>true</code>
	 */
	protected void markDirty() {
		dirty = true;
	}

	/**
	 * @return
	 * <ul>
	 * <li><code>true</code> if the dirty flag has been set to true.</li>
	 * <li><code>false</code> otherwise.</li>
	 * </ul>
	 */
	protected boolean isDirty() {
		return dirty;
	}

	/**
	 * Saves the changes made in the dialog if needed.
	 * Creates a new marker if needed.
	 * Updates the existing marker only if there have been changes.
	 */
	private void saveChanges() {
		try {
			ResourcesPlugin.getWorkspace().run(new IWorkspaceRunnable() {
				public void run(IProgressMonitor monitor)
					throws CoreException {
					if (marker == null)
						createMarker();
					if (isDirty())
						updateMarker();
				}
			}, null);
		} catch (CoreException e) {
			ErrorDialog.openError(getShell(), Messages.getString("Error"), null, e.getStatus()); //$NON-NLS-1$
			return;
		}
	}

	/**
	 * Creates or updates the marker.  Must be called within a workspace runnable.
	 */
	private void updateMarker() throws CoreException {
		// Set the marker attributes from the current dialog field values.
		// Do not use setAttributes(Map) as that overwrites any attributes
		// not covered by the dialog.
		Map attrs = getMarkerAttributes();
		for (Iterator i = attrs.keySet().iterator(); i.hasNext();) {
			String key = (String) i.next();
			Object val = attrs.get(key);
			marker.setAttribute(key, val);
		}
	}

	/**
	 * Returns the marker attributes to save back to the marker, 
	 * based on the current dialog fields.
	 */
	protected Map getMarkerAttributes() {
		Map attrs;
		if (initialAttributes == null) {
			attrs = initialAttributes;
		}
		else {
			attrs = new HashMap();
		}
		attrs.put(IMarker.MESSAGE, descriptionText.getText());
		return attrs;
	}
	
	private void createMarker() {
		if (resource == null) {
			return;
		}
			
		try {
			marker = resource.createMarker(type);
		}
		catch (CoreException e) {
		}
	}
	
	/**
	 * Updates widget enablement for the dialog. Should be overridden by subclasses. 
	 */
	protected void updateEnablement() {
		descriptionText.setEditable(isEditable());
	}
	
	/**
	 * @return
	 * <ul>
	 * <li><code>true</code> if the marker is editable or the dialog is creating a new marker.</li>
	 * <li><code>false</code> if the marker is not editable.</li>
	 * </ul>
	 */
	protected boolean isEditable() {
		if (marker == null) {
			return true;
		}
		return Util.isEditable(marker);
	}
	
	/**
	 * Sets the marker type when creating a new marker.
	 * 
	 * @param type the marker type
	 */
	void setType(String type) {
		this.type = type;
	}
}