Attachment #24894 for bug #102461

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Lines 239-241 Link Here

(-)plugin.properties (+2 lines)
239		239
240	RepoPreference.Name=CVS Repositories	240	RepoPreference.Name=CVS Repositories
241	RepoPreference.Description=Preferences that contain the CVS repository connection information	241	RepoPreference.Description=Preferences that contain the CVS repository connection information
		242
		243	CommentTemplatesPreferencePage.name=Comment Templates




   <extension
         point="org.eclipse.ui.preferencePages">
      <page
            name="%CommentTemplatesPreferencePage.name"
            category="org.eclipse.team.cvs.ui.CVSPreferences"
            class="org.eclipse.team.internal.ccvs.ui.CommentTemplatesPreferencePage"
            id="org.eclipse.team.cvs.ui.CommentTemplatesPreferences">
            <keywordReference id="org.eclipse.team.cvs.ui.cvs"/>
      </page>
   </extension>
   <extension
         point="org.eclipse.ui.preferencePages">
      <page
            name="%ConsolePreferencePage.name"
            category="org.eclipse.team.cvs.ui.CVSPreferences"
            class="org.eclipse.team.internal.ccvs.ui.console.ConsolePreferencesPage"




	public static String CommitCommentArea_2;
	public static String CommitCommentArea_3;
	public static String CommitCommentArea_4;
    public static String CommitCommentArea_5;

	public static String CheckoutProjectOperation_8;
	public static String CheckoutProjectOperation_9;


    public static String OpenChangeSetAction_0;
    public static String OpenChangeSetAction_1;
    
    public static String CommentTemplatesPreferencePage_Description;
    public static String CommentTemplatesPreferencePage_New;
    public static String CommentTemplatesPreferencePage_Edit;
    public static String CommentTemplatesPreferencePage_Remove;
    public static String CommentTemplatesPreferencePage_EditCommentTemplateTitle;
    public static String CommentTemplatesPreferencePage_EditCommentTemplateMessage;
}

Lines 41-46 Link Here

(-)src/org/eclipse/team/internal/ccvs/ui/CVSUIPlugin.java (+1 lines)
41	import org.eclipse.team.internal.ui.TeamUIPlugin;	41	import org.eclipse.team.internal.ui.TeamUIPlugin;
42	import org.eclipse.team.internal.ui.Utils;	42	import org.eclipse.team.internal.ui.Utils;
43	import org.eclipse.ui.*;	43	import org.eclipse.ui.*;
		44	import org.eclipse.ui.dialogs.PreferencesUtil;
44	import org.eclipse.ui.plugin.AbstractUIPlugin;	45	import org.eclipse.ui.plugin.AbstractUIPlugin;
45	import org.osgi.framework.BundleContext;	46	import org.osgi.framework.BundleContext;
46		47




import org.eclipse.team.internal.ccvs.core.*;
import org.eclipse.team.internal.ui.SWTUtils;
import org.eclipse.team.internal.ui.dialogs.DialogArea;
import org.eclipse.ui.dialogs.PreferencesUtil;

/**
 * This area provides the widgets for providing the CVS commit comment

        
        private final String fMessage;
        private final String [] fComments;
        private final String[] fCommentTemplates;
        private final Combo fCombo;
        
        
        public ComboBox(Composite composite, String message, String [] options,
                String[] commentTemplates) {
            
            fMessage= message;
            fComments= options;
            fCommentTemplates = commentTemplates;
            
            fCombo = new Combo(composite, SWT.READ_ONLY);
            fCombo.setLayoutData(SWTUtils.createHFillGridData());
            
            // populate the previous comment list
            populateList(fCommentTemplates, fComments);
            for (int i = 0; i < fComments.length; i++) {
                fCombo.add(HistoryView.flattenText(fComments[i]));
            }
            fCombo.setText(fMessage);
            
            // We don't want to have an initial selection
            // (see bug 32078: http://bugs.eclipse.org/bugs/show_bug.cgi?id=32078)
            fCombo.addFocusListener(this);
            fCombo.addSelectionListener(this);
        }

		private void populateList(String[] templates, String[] comments) {
			fCombo.removeAll();
			
			fCombo.add(fMessage);
            for (int i = 0; i < templates.length; i++) {
                fCombo.add("TEMPL: " + HistoryView.flattenText(templates[i]));
            }
            // TODO: add divider here and remove "TEMPL:" above
            // (note: widgetSelected() below must be changed accordingly)
            for (int i = 0; i < comments.length; i++) {
                fCombo.add(HistoryView.flattenText(comments[i]));
            }
            fCombo.setText(fMessage);
		}
        
        public void widgetSelected(SelectionEvent e) {
            int index = fCombo.getSelectionIndex();
            if (index > 0) {
                index--;
                setChanged();
                
                // map from combo box index to array index
                String message;
                if (index < fCommentTemplates.length) {
                	message = fCommentTemplates[index];
                } else {
                	message = fComments[index - fCommentTemplates.length];
                }
                notifyObservers(message);
            }
        }
        

        public void setEnabled(boolean enabled) {
            fCombo.setEnabled(enabled);
        }

		void setCommentTemplates(String[] templates) {
			populateList(templates, fComments);
		}
    }
    
    private static final String EMPTY_MESSAGE= CVSUIMessages.CommitCommentArea_0; //$NON-NLS-1$
    private static final String COMBO_MESSAGE= CVSUIMessages.CommitCommentArea_1; //$NON-NLS-1$
    private static final String CONFIGURE_TEMPLATES_MESSAGE= CVSUIMessages.CommitCommentArea_5; //$NON-NLS-1$
    
    public static final String OK_REQUESTED = "OkRequested";//$NON-NLS-1$
    public static final String COMMENT_MODIFIED = "CommentModified";//$NON-NLS-1$

        fTextBox= new TextBox(fComposite, EMPTY_MESSAGE, getInitialComment());
        
        final String [] comments = CVSUIPlugin.getPlugin().getRepositoryManager().getPreviousComments();
        final String[] commentTemplates = CVSUIPlugin.getPlugin().getRepositoryManager().getCommentTemplates();
        fComboBox= new ComboBox(fComposite, COMBO_MESSAGE, comments, commentTemplates);
        
        Link templatesPrefsLink = new Link(fComposite, 0);
        templatesPrefsLink.setText("<a href=\"configureTemplates\">" + //$NON-NLS-1$
        		CONFIGURE_TEMPLATES_MESSAGE + "</a>"); //$NON-NLS-1$
        templatesPrefsLink.addSelectionListener(new SelectionListener() {
			public void widgetDefaultSelected(SelectionEvent e) {
				openCommentTemplatesPreferencePage();
			}
		
			public void widgetSelected(SelectionEvent e) {
				openCommentTemplatesPreferencePage();
			}
		});
        
        fComboBox.addObserver(fTextBox);
    }
    
    void openCommentTemplatesPreferencePage() {
		PreferencesUtil.createPreferenceDialogOn(
				null,
				"org.eclipse.team.cvs.ui.CommentTemplatesPreferences",
				new String[] { "org.eclipse.team.cvs.ui.CommentTemplatesPreferences" },
				null).open();
		fComboBox.setCommentTemplates(
				CVSUIPlugin.getPlugin().getRepositoryManager().getCommentTemplates());
	}

	public String getComment(boolean save) {
        final String comment= fTextBox.getText();
        if (comment == null)
            return ""; //$NON-NLS-1$
        
        final String stripped= strip(comment);
        if (save && comment.length() > 0)
            CVSUIPlugin.getPlugin().getRepositoryManager().addComment(comment, false);

        return stripped;
    }




CommitCommentArea_2=Empty commit comment
CommitCommentArea_3=The commit comment is empty. Are you sure you would like to continue with an empty comment?
CommitCommentArea_4=Re&member decision?
CommitCommentArea_5=Configure Comment Templates...




UncommittedChangesDialog_3=&The dirty resources contained in ''{0}''
UncommittedChangesDialog_4=&The full path of ''{0}''
AddWizard_0=Add to Version Control

CommentTemplatesPreferencePage_Description=Create, edit or remove comment templates:
CommentTemplatesPreferencePage_New=New...
CommentTemplatesPreferencePage_Edit=Edit...
CommentTemplatesPreferencePage_Remove=Remove
CommentTemplatesPreferencePage_EditCommentTemplateTitle=Enter Comment Template
CommentTemplatesPreferencePage_EditCommentTemplateMessage=Please enter a comment template:




	// new state file
	private static final String REPOSITORIES_VIEW_FILE = "repositoriesView.xml"; //$NON-NLS-1$
	private static final String COMMENT_HIST_FILE = "commitCommentHistory.xml"; //$NON-NLS-1$
    private static final String COMMENT_TEMPLATES_FILE = "commentTemplates.xml"; //$NON-NLS-1$
	static final String ELEMENT_COMMIT_COMMENT = "CommitComment"; //$NON-NLS-1$
	static final String ELEMENT_COMMIT_HISTORY = "CommitComments"; //$NON-NLS-1$
    static final String ELEMENT_COMMENT_TEMPLATES = "CommitCommentTemplates"; //$NON-NLS-1$

	private Map repositoryRoots = new HashMap();
	


	// The previously remembered comment
	static String[] previousComments = new String[0];
    static String[] commentTemplates = new String[0];
	
	public static boolean notifyRepoView = true;
	

	public void startup() {
		loadState();
		loadCommentHistory();
        loadCommentTemplates();
		CVSProviderPlugin.getPlugin().addRepositoryListener(new ICVSListener() {
			public void repositoryAdded(ICVSRepositoryLocation root) {
				rootAdded(root);

	public void shutdown() throws TeamException {
		saveState();
		saveCommentHistory();
        saveCommentTemplates();
	}
	
	private void loadState() {

			CVSUIPlugin.log(e);
		}
	}
    private void loadCommentTemplates() {
        IPath pluginStateLocation = CVSUIPlugin.getPlugin().getStateLocation().append(COMMENT_TEMPLATES_FILE);
        File file = pluginStateLocation.toFile();
        if (!file.exists()) return;
        try {
            BufferedInputStream is = new BufferedInputStream(new FileInputStream(file));
            try {
                readCommentTemplates(is);
            } finally {
                is.close();
            }
        } catch (IOException e) {
            CVSUIPlugin.log(Status.ERROR, CVSUIMessages.RepositoryManager_ioException, e); //$NON-NLS-1$
        } catch (TeamException e) {
            CVSUIPlugin.log(e);
        }
    }
	
	protected void saveState() throws TeamException {
		IPath pluginStateLocation = CVSUIPlugin.getPlugin().getStateLocation();

			throw new CVSException(NLS.bind(CVSUIMessages.RepositoryManager_parsingProblem, new String[] { COMMENT_HIST_FILE }), ex); //$NON-NLS-1$
		}
	}
    private void readCommentTemplates(InputStream stream) throws IOException, TeamException {
        try {
            SAXParserFactory factory = SAXParserFactory.newInstance();
            SAXParser parser = factory.newSAXParser();
            parser.parse(new InputSource(stream), new CommentTemplatesContentHandler());
        } catch (SAXException ex) {
            throw new CVSException(NLS.bind(CVSUIMessages.RepositoryManager_parsingProblem, new String[] { COMMENT_TEMPLATES_FILE }), ex); //$NON-NLS-1$
        } catch (ParserConfigurationException ex) {
            throw new CVSException(NLS.bind(CVSUIMessages.RepositoryManager_parsingProblem, new String[] { COMMENT_TEMPLATES_FILE }), ex); //$NON-NLS-1$
        }
    }
	
	private void readOldState(DataInputStream dis) throws IOException, TeamException {
		int repoSize = dis.readInt();

		 		 throw new TeamException(new Status(Status.ERROR, CVSUIPlugin.ID, TeamException.UNABLE, NLS.bind(CVSUIMessages.RepositoryManager_save, new String[] { histFile.getAbsolutePath() }), e)); //$NON-NLS-1$
		 }
	}
    protected void saveCommentTemplates() throws TeamException {
        IPath pluginStateLocation = CVSUIPlugin.getPlugin().getStateLocation();
        File tempFile = pluginStateLocation.append(COMMENT_TEMPLATES_FILE + ".tmp").toFile(); //$NON-NLS-1$
        File histFile = pluginStateLocation.append(COMMENT_TEMPLATES_FILE).toFile();
        try {
                 XMLWriter writer = new XMLWriter(new BufferedOutputStream(new FileOutputStream(tempFile)));
                 try {
                         writeCommentTemplates(writer);
                 } finally {
                         writer.close();
                 }
                 if (histFile.exists()) {
                         histFile.delete();
                 }
                 boolean renamed = tempFile.renameTo(histFile);
                 if (!renamed) {
                         throw new TeamException(new Status(Status.ERROR, CVSUIPlugin.ID, TeamException.UNABLE, NLS.bind(CVSUIMessages.RepositoryManager_rename, new String[] { tempFile.getAbsolutePath() }), null)); //$NON-NLS-1$
                 }
         } catch (IOException e) {
                 throw new TeamException(new Status(Status.ERROR, CVSUIPlugin.ID, TeamException.UNABLE, NLS.bind(CVSUIMessages.RepositoryManager_save, new String[] { histFile.getAbsolutePath() }), e)); //$NON-NLS-1$
         }
    }
	private void writeCommentHistory(XMLWriter writer) {
		writer.startTag(ELEMENT_COMMIT_HISTORY, null, false);
		for (int i=0; i<previousComments.length && i<MAX_COMMENTS; i++)
			writer.printSimpleTag(ELEMENT_COMMIT_COMMENT, previousComments[i]);
		writer.endTag(ELEMENT_COMMIT_HISTORY);
	}
    private void writeCommentTemplates(XMLWriter writer) {
        writer.startTag(ELEMENT_COMMENT_TEMPLATES, null, false);
        for (int i=0; i<commentTemplates.length; i++)
            writer.printSimpleTag(ELEMENT_COMMIT_COMMENT, commentTemplates[i]);
        writer.endTag(ELEMENT_COMMENT_TEMPLATES);
    }
		 
	public void addRepositoryListener(IRepositoryListener listener) {
		listeners.add(listener);

		return previousComments;
	}

    /**
     * Get list of comment templates.
     */
    public String[] getCommentTemplates() {
        return commentTemplates;
    }
    
	/**
	 * Method addComment.
	 * @param string
	 */
	public void addComment(String comment, boolean template) {
        if (template) {
            addCommentTemplate(comment);
        } else {
            addComment(comment);
        }
	}
    
    private void addCommentTemplate(String comment) {
        // Only add the comment if its not there already
        if (containsCommentTemplate(comment))
            return;

        // remove from list of regular comments if there
        if (containsComment(comment)) {
            List newComments = new ArrayList();
            for (int i = 0; i < previousComments.length; i++) {
                if (!previousComments[i].equals(comment))
                    newComments.add(previousComments[i]);
            }
            previousComments = (String[]) newComments.toArray(new String[0]);
        }

        // Insert the comment as first element
        String[] newComments = new String[commentTemplates.length + 1];
        System.arraycopy(commentTemplates, 0, newComments, 1, commentTemplates.length);
        newComments[0] = comment;
        commentTemplates = newComments;
    }
    
    private void addComment(String comment) {
        // Only add the comment if its not there already
        if (containsComment(comment))
            return;

        // remove from list of comment templates if there
        if (containsCommentTemplate(comment)) {
            List newComments = new ArrayList();
            for (int i = 0; i < commentTemplates.length; i++) {
                if (!commentTemplates[i].equals(comment))
                    newComments.add(commentTemplates[i]);
            }
            commentTemplates = (String[]) newComments.toArray(new String[0]);
        }
        
        // Insert the comment as the first element
        String[] newComments = new String[Math.min(
                previousComments.length + 1, MAX_COMMENTS)];
        newComments[0] = comment;
        for (int i = 1; i < newComments.length; i++) {
            newComments[i] = previousComments[i - 1];
        }
        previousComments = newComments;
    }

	private boolean containsComment(String comment) {
		for (int i = 0; i < previousComments.length; i++) {

		}
		return false;
	}
    
    private boolean containsCommentTemplate(String comment) {
        for (int i = 0; i < commentTemplates.length; i++) {
            if (commentTemplates[i].equals(comment)) {
                return true;
            }
        }
        return false;
    }
    
    public void replaceAndSaveCommentTemplates(String[] templates) throws TeamException {
    	commentTemplates = templates;
    	saveCommentTemplates();
    }
}




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

import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.dialogs.IInputValidator;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Button;
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;

/**
 * A simple input dialog for soliciting an input string from the user.
 * <p>
 * This concrete dialog class can be instantiated as is, or further subclassed as
 * required.
 * </p>
 */
public class CommentTemplateEditDialog extends Dialog {
    /**
     * The title of the dialog.
     */
    private String title;

    /**
     * The message to display, or <code>null</code> if none.
     */
    private String message;

    /**
     * The input value; the empty string by default.
     */
    private String value = "";//$NON-NLS-1$

    /**
     * The input validator, or <code>null</code> if none.
     */
    private IInputValidator validator;

    /**
     * Ok button widget.
     */
    private Button okButton;

    /**
     * Input text widget.
     */
    private Text text;

    /**
     * Error message label widget.
     */
    private Text errorMessageText;

    /**
     * Creates an input dialog with OK and Cancel buttons. Note that the dialog
     * will have no visual representation (no widgets) until it is told to open.
     * <p>
     * Note that the <code>open</code> method blocks for input dialogs.
     * </p>
     * 
     * @param parentShell
     *            the parent shell, or <code>null</code> to create a top-level
     *            shell
     * @param dialogTitle
     *            the dialog title, or <code>null</code> if none
     * @param dialogMessage
     *            the dialog message, or <code>null</code> if none
     * @param initialValue
     *            the initial input value, or <code>null</code> if none
     *            (equivalent to the empty string)
     * @param validator
     *            an input validator, or <code>null</code> if none
     */
    public CommentTemplateEditDialog(Shell parentShell, String dialogTitle,
            String dialogMessage, String initialValue, IInputValidator validator) {
        super(parentShell);
        this.title = dialogTitle;
        message = dialogMessage;
        if (initialValue == null)
            value = "";//$NON-NLS-1$
        else
            value = initialValue;
        this.validator = validator;
    }

    /*
     * (non-Javadoc) Method declared on Dialog.
     */
    protected void buttonPressed(int buttonId) {
        if (buttonId == IDialogConstants.OK_ID) {
            value = text.getText();
        } else {
            value = null;
        }
        super.buttonPressed(buttonId);
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.jface.window.Window#configureShell(org.eclipse.swt.widgets.Shell)
     */
    protected void configureShell(Shell shell) {
        super.configureShell(shell);
        if (title != null)
            shell.setText(title);
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.jface.dialogs.Dialog#createButtonsForButtonBar(org.eclipse.swt.widgets.Composite)
     */
    protected void createButtonsForButtonBar(Composite parent) {
        // create OK and Cancel buttons by default
        okButton = createButton(parent, IDialogConstants.OK_ID,
                IDialogConstants.OK_LABEL, true);
        createButton(parent, IDialogConstants.CANCEL_ID,
                IDialogConstants.CANCEL_LABEL, false);
        //do this here because setting the text will set enablement on the ok
        // button
        text.setFocus();
        if (value != null) {
            text.setText(value);
            text.selectAll();
        }
    }

    /*
     * (non-Javadoc) Method declared on Dialog.
     */
    protected Control createDialogArea(Composite parent) {
        // create composite
        Composite composite = (Composite) super.createDialogArea(parent);
        // create message
        if (message != null) {
            Label label = new Label(composite, SWT.WRAP);
            label.setText(message);
            GridData data = new GridData(GridData.GRAB_HORIZONTAL
                    | GridData.GRAB_VERTICAL | GridData.HORIZONTAL_ALIGN_FILL
                    | GridData.VERTICAL_ALIGN_CENTER);
            data.widthHint = convertHorizontalDLUsToPixels(IDialogConstants.MINIMUM_MESSAGE_AREA_WIDTH);
            label.setLayoutData(data);
            label.setFont(parent.getFont());
        }
        text = new Text(composite, SWT.MULTI | SWT.BORDER);
        GridData gd = new GridData(GridData.GRAB_HORIZONTAL
                | GridData.HORIZONTAL_ALIGN_FILL);
		gd.heightHint = convertHeightInCharsToPixels(5);
		text.setLayoutData(gd);
        text.addModifyListener(new ModifyListener() {
            public void modifyText(ModifyEvent e) {
                validateInput();
            }
        });
        errorMessageText = new Text(composite, SWT.READ_ONLY);
        errorMessageText.setLayoutData(new GridData(GridData.GRAB_HORIZONTAL
                | GridData.HORIZONTAL_ALIGN_FILL));
        errorMessageText.setBackground(errorMessageText.getDisplay()
                .getSystemColor(SWT.COLOR_WIDGET_BACKGROUND));

        applyDialogFont(composite);
        return composite;
    }

    /**
     * Returns the error message label.
     * 
     * @return the error message label
     * @deprecated use setErrorMessage(String) instead
     */
    protected Label getErrorMessageLabel() {
        return null;
    }

    /**
     * Returns the ok button.
     * 
     * @return the ok button
     */
    protected Button getOkButton() {
        return okButton;
    }

    /**
     * Returns the text area.
     * 
     * @return the text area
     */
    protected Text getText() {
        return text;
    }

    /**
     * Returns the validator.
     * 
     * @return the validator
     */
    protected IInputValidator getValidator() {
        return validator;
    }

    /**
     * Returns the string typed into this input dialog.
     * 
     * @return the input string
     */
    public String getValue() {
        return value;
    }

    /**
     * Validates the input.
     * <p>
     * The default implementation of this framework method delegates the request
     * to the supplied input validator object; if it finds the input invalid,
     * the error message is displayed in the dialog's message line. This hook
     * method is called whenever the text changes in the input field.
     * </p>
     */
    protected void validateInput() {
        String errorMessage = null;
        if (validator != null) {
            errorMessage = validator.isValid(text.getText());
        }
        // Bug 16256: important not to treat "" (blank error) the same as null
        // (no error)
        setErrorMessage(errorMessage);
    }

    /**
     * Sets or clears the error message.
     * If not <code>null</code>, the OK button is disabled.
     * 
     * @param errorMessage
     *            the error message, or <code>null</code> to clear
     * @since 3.0
     */
    public void setErrorMessage(String errorMessage) {
        errorMessageText.setText(errorMessage == null ? "" : errorMessage); //$NON-NLS-1$
        okButton.setEnabled(errorMessage == null);
        errorMessageText.getParent().update();
    }
}




package org.eclipse.team.internal.ccvs.ui;

import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.preference.PreferencePage;
import org.eclipse.jface.viewers.DoubleClickEvent;
import org.eclipse.jface.viewers.IDoubleClickListener;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.jface.viewers.ListViewer;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerSorter;
import org.eclipse.jface.window.Window;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.List;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Text;
import org.eclipse.team.core.TeamException;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;

public class CommentTemplatesPreferencePage extends PreferencePage implements
		IWorkbenchPreferencePage, ISelectionChangedListener {

	private ListViewer viewer;
	private Button editButton;
	private Button removeButton;
	private Text preview;

	protected Control createContents(Composite ancestor) {
		Composite parent = new Composite(ancestor, SWT.NONE);
		GridLayout layout = new GridLayout();
		layout.marginWidth = 0;
		layout.marginHeight = 0;
		layout.numColumns = 1;
		parent.setLayout(layout);
		parent.setLayoutData(new GridData(GridData.FILL_BOTH));

		createListAndButtons(parent);

		Label previewLabel = new Label(parent, SWT.NONE);
		previewLabel.setText("Preview:");
		
		preview = new Text(parent, SWT.MULTI | SWT.READ_ONLY | SWT.BORDER);
		GridData gd = new GridData(GridData.FILL_HORIZONTAL);
		gd.heightHint = convertHeightInCharsToPixels(5);
		preview.setLayoutData(gd);
		
		Dialog.applyDialogFont(ancestor);
		
		return parent;
	}

	private Composite createListAndButtons(Composite parent) {
		Composite listAndButtons = new Composite(parent, SWT.NONE);
		GridLayout layout = new GridLayout();
		layout.marginWidth = 0;
		layout.marginHeight = 0;
		layout.numColumns = 2;
		listAndButtons.setLayout(layout);
		listAndButtons.setLayoutData(new GridData(GridData.FILL_BOTH));
		
		viewer = new ListViewer(listAndButtons);
		viewer.setLabelProvider(new LabelProvider() {
			public String getText(Object element) {
				String template = (String) element;
				return HistoryView.flattenText(template);
			}
		});
		viewer.addSelectionChangedListener(this);
		viewer.setSorter(new ViewerSorter() {
			public int compare(Viewer viewer, Object e1, Object e2) {
				String template1 = HistoryView.flattenText((String) e1);
				String template2 = HistoryView.flattenText((String) e2);
				return template1.compareToIgnoreCase(template2);
			}
		});
		viewer.addDoubleClickListener(new IDoubleClickListener() {
			public void doubleClick(DoubleClickEvent event) {
				editTemplate();
			}
		});
		List list = viewer.getList();
		list.setLayoutData(new GridData(GridData.FILL_BOTH));
		
		// populate list
		String[] templates =
			CVSUIPlugin.getPlugin().getRepositoryManager().getCommentTemplates();
		for (int i = 0; i < templates.length; i++) {
			viewer.add(templates[i]);
		}

		createButtons(listAndButtons);
		return listAndButtons;
	}

	private void createButtons(Composite parent) {
		Composite buttons = new Composite(parent, SWT.NONE);
		buttons.setLayoutData(new GridData(GridData.VERTICAL_ALIGN_BEGINNING));
		GridLayout layout = new GridLayout();
		layout.marginHeight = 0;
		layout.marginWidth = 0;
		buttons.setLayout(layout);

		Button newButton = new Button(buttons, SWT.PUSH);
		newButton.setText(CVSUIMessages.CommentTemplatesPreferencePage_New);
		GridData data = new GridData();
		data.horizontalAlignment = GridData.FILL;
		int widthHint = convertHorizontalDLUsToPixels(IDialogConstants.BUTTON_WIDTH);
		data.widthHint = Math.max(widthHint,
				newButton.computeSize(SWT.DEFAULT, SWT.DEFAULT, true).x);
		newButton.setLayoutData(data);
		newButton.setEnabled(true);
		newButton.addListener(SWT.Selection, new Listener() {
			public void handleEvent(Event event) {
				newTemplate();
			}
		});

		editButton = new Button(buttons, SWT.PUSH);
		editButton.setText(CVSUIMessages.CommentTemplatesPreferencePage_Edit);
		data = new GridData();
		data.horizontalAlignment = GridData.FILL;
		widthHint = convertHorizontalDLUsToPixels(IDialogConstants.BUTTON_WIDTH);
		data.widthHint = Math.max(widthHint,
				editButton.computeSize(SWT.DEFAULT, SWT.DEFAULT, true).x);
		editButton.setLayoutData(data);
		editButton.setEnabled(false);
		editButton.addListener(SWT.Selection, new Listener() {
			public void handleEvent(Event e) {
				editTemplate();
			}
		});

		removeButton = new Button(buttons, SWT.PUSH);
		removeButton.setText(CVSUIMessages.CommentTemplatesPreferencePage_Remove);
		data = new GridData();
		data.horizontalAlignment = GridData.FILL;
		widthHint = convertHorizontalDLUsToPixels(IDialogConstants.BUTTON_WIDTH);
		data.widthHint = Math.max(widthHint,
				removeButton.computeSize(SWT.DEFAULT, SWT.DEFAULT, true).x);
		removeButton.setLayoutData(data);
		removeButton.setEnabled(false);
		removeButton.addListener(SWT.Selection, new Listener() {
			public void handleEvent(Event e) {
				remove();
			}
		});
	}
	
	public void init(IWorkbench workbench) {
		setDescription(CVSUIMessages.CommentTemplatesPreferencePage_Description);
	}

	public void selectionChanged(SelectionChangedEvent event) {
		IStructuredSelection selection = (IStructuredSelection) event.getSelection();
		switch (selection.size()) {
			case 0:
				editButton.setEnabled(false);
				removeButton.setEnabled(false);
				preview.setText("");
				break;
			
			case 1:
				editButton.setEnabled(true);
				removeButton.setEnabled(true);
				preview.setText((String) selection.getFirstElement());
				break;
			
			default:
				editButton.setEnabled(false);
				removeButton.setEnabled(true);
				preview.setText("");
				break;
		}
	}
	
	void newTemplate() {
		CommentTemplateEditDialog dialog = new CommentTemplateEditDialog(
				getShell(),
				CVSUIMessages.CommentTemplatesPreferencePage_EditCommentTemplateTitle,
				CVSUIMessages.CommentTemplatesPreferencePage_EditCommentTemplateMessage,
				"", null);
		if (dialog.open() == Window.OK) {
			viewer.add(dialog.getValue());
		}
	}

	void editTemplate() {
		IStructuredSelection selection = (IStructuredSelection) viewer.getSelection();
		if (selection.size() == 1) {
			String oldTemplate = (String) selection.getFirstElement();
			CommentTemplateEditDialog dialog = new CommentTemplateEditDialog(
					getShell(),
					CVSUIMessages.CommentTemplatesPreferencePage_EditCommentTemplateTitle,
					CVSUIMessages.CommentTemplatesPreferencePage_EditCommentTemplateMessage,
					oldTemplate, null);
			if (dialog.open() == Window.OK) {
				viewer.remove(oldTemplate);
				viewer.add(dialog.getValue());
			}
		}
	}
	
	void remove() {
		IStructuredSelection selection = (IStructuredSelection) viewer.getSelection();
		viewer.remove(selection.toArray());
	}
	
	public boolean performOk() {
		int numTemplates = viewer.getList().getItemCount();
		String[] templates = new String[numTemplates];
		for (int i = 0; i < numTemplates; i++) {
			templates[i] = (String) viewer.getElementAt(i);
		}
		try {
			CVSUIPlugin.getPlugin().getRepositoryManager()
				.replaceAndSaveCommentTemplates(templates);
		} catch (TeamException e) {
			// TODO: handle save error
		}
		
		return super.performOk();
	}
}




/*******************************************************************************
 * 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 Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.team.internal.ccvs.ui.repo;

import java.util.Vector;

import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
import org.xml.sax.Attributes;

class CommentTemplatesContentHandler extends DefaultHandler {

	private StringBuffer buffer;
	private Vector comments;
	public CommentTemplatesContentHandler() {
	}

	/**
	 * @see ContentHandler#characters(char[], int, int)
	 */
	public void characters(char[] chars, int startIndex, int length) throws SAXException {
		if (buffer == null) return;
		buffer.append(chars, startIndex, length);
	}

	/**
	 * @see ContentHandler#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
	 */
	public void startElement(
			String namespaceURI,
			String localName,
			String qName,
			Attributes atts)
			throws SAXException {
		
		String elementName = getElementName(namespaceURI, localName, qName);
		if (elementName.equals(RepositoryManager.ELEMENT_COMMIT_COMMENT)) {
			buffer = new StringBuffer();
			return;
		} 
		if (elementName.equals(RepositoryManager.ELEMENT_COMMENT_TEMPLATES)) {
			comments = new Vector();
			return;
		}
	}
	
	/**
	 * @see org.xml.sax.ContentHandler#endElement(java.lang.String, java.lang.String, java.lang.String)
	 */
	public void endElement(String namespaceURI, String localName, String qName) {
		String elementName = getElementName(namespaceURI, localName, qName);
		if (elementName.equals(RepositoryManager.ELEMENT_COMMIT_COMMENT)) {
			comments.add(buffer.toString());
			buffer = null;
			return;
		} 
		if (elementName.equals(RepositoryManager.ELEMENT_COMMENT_TEMPLATES)) {
			RepositoryManager.commentTemplates = new String[comments.size()];
			comments.copyInto(RepositoryManager.commentTemplates);
			return;
		} 
	}
	
	/*
	 * Couldn't figure out from the SAX API exactly when localName vs. qName is used.
	 * However, the XML for project sets doesn't use namespaces so either of the two names
	 * is fine. Therefore, use whichever one is provided.
	 */
	private String getElementName(String namespaceURI, String localName, String qName) {
		if (localName != null && localName.length() > 0) {
			return localName;
		} else {
			return qName;
		}
	}
}

Return to bug 102461

Lines 681-686 Link Here

(-)plugin.xml (+10 lines)
681	<extension	681	<extension
682	point="org.eclipse.ui.preferencePages">	682	point="org.eclipse.ui.preferencePages">
683	<page	683	<page
		684	name="%CommentTemplatesPreferencePage.name"
		685	category="org.eclipse.team.cvs.ui.CVSPreferences"
		686	class="org.eclipse.team.internal.ccvs.ui.CommentTemplatesPreferencePage"
		687	id="org.eclipse.team.cvs.ui.CommentTemplatesPreferences">
		688	<keywordReference id="org.eclipse.team.cvs.ui.cvs"/>
		689	</page>
		690	</extension>
		691	<extension
		692	point="org.eclipse.ui.preferencePages">
		693	<page
684	name="%ConsolePreferencePage.name"	694	name="%ConsolePreferencePage.name"
685	category="org.eclipse.team.cvs.ui.CVSPreferences"	695	category="org.eclipse.team.cvs.ui.CVSPreferences"
686	class="org.eclipse.team.internal.ccvs.ui.console.ConsolePreferencesPage"	696	class="org.eclipse.team.internal.ccvs.ui.console.ConsolePreferencesPage"

Lines 815-820 Link Here

(-)src/org/eclipse/team/internal/ccvs/ui/CVSUIMessages.java (-1 / +9 lines)
815	public static String CommitCommentArea_2;	815	public static String CommitCommentArea_2;
816	public static String CommitCommentArea_3;	816	public static String CommitCommentArea_3;
817	public static String CommitCommentArea_4;	817	public static String CommitCommentArea_4;
		818	public static String CommitCommentArea_5;
818		819
819	public static String CheckoutProjectOperation_8;	820	public static String CheckoutProjectOperation_8;
820	public static String CheckoutProjectOperation_9;	821	public static String CheckoutProjectOperation_9;
Lines 985-988 Link Here
985		986
986	public static String OpenChangeSetAction_0;	987	public static String OpenChangeSetAction_0;
987	public static String OpenChangeSetAction_1;	988	public static String OpenChangeSetAction_1;
988	}	989
		990	public static String CommentTemplatesPreferencePage_Description;
		991	public static String CommentTemplatesPreferencePage_New;
		992	public static String CommentTemplatesPreferencePage_Edit;
		993	public static String CommentTemplatesPreferencePage_Remove;
		994	public static String CommentTemplatesPreferencePage_EditCommentTemplateTitle;
		995	public static String CommentTemplatesPreferencePage_EditCommentTemplateMessage;
		996	}

Lines 26-31 Link Here

(-)src/org/eclipse/team/internal/ccvs/ui/CommitCommentArea.java (-11 / +64 lines)
26	import org.eclipse.team.internal.ccvs.core.*;	26	import org.eclipse.team.internal.ccvs.core.*;
27	import org.eclipse.team.internal.ui.SWTUtils;	27	import org.eclipse.team.internal.ui.SWTUtils;
28	import org.eclipse.team.internal.ui.dialogs.DialogArea;	28	import org.eclipse.team.internal.ui.dialogs.DialogArea;
		29	import org.eclipse.ui.dialogs.PreferencesUtil;
29		30
30	/**	31	/**
31	* This area provides the widgets for providing the CVS commit comment	32	* This area provides the widgets for providing the CVS commit comment
Lines 125-159 Link Here
125		126
126	private final String fMessage;	127	private final String fMessage;
127	private final String [] fComments;	128	private final String [] fComments;
		129	private final String[] fCommentTemplates;
128	private final Combo fCombo;	130	private final Combo fCombo;
129		131
130		132
131	public ComboBox(Composite composite, String message, String [] options) {	133	public ComboBox(Composite composite, String message, String [] options,
		134	String[] commentTemplates) {
132		135
133	fMessage= message;	136	fMessage= message;
134	fComments= options;	137	fComments= options;
		138	fCommentTemplates = commentTemplates;
135		139
136	fCombo = new Combo(composite, SWT.READ_ONLY);	140	fCombo = new Combo(composite, SWT.READ_ONLY);
137	fCombo.setLayoutData(SWTUtils.createHFillGridData());	141	fCombo.setLayoutData(SWTUtils.createHFillGridData());
138		142
139	// populate the previous comment list	143	// populate the previous comment list
140	fCombo.add(fMessage);	144	populateList(fCommentTemplates, fComments);
141	for (int i = 0; i < fComments.length; i++) {
142	fCombo.add(HistoryView.flattenText(fComments[i]));
143	}
144	fCombo.setText(fMessage);
145		145
146	// We don't want to have an initial selection	146	// We don't want to have an initial selection
147	// (see bug 32078: http://bugs.eclipse.org/bugs/show_bug.cgi?id=32078)	147	// (see bug 32078: http://bugs.eclipse.org/bugs/show_bug.cgi?id=32078)
148	fCombo.addFocusListener(this);	148	fCombo.addFocusListener(this);
149	fCombo.addSelectionListener(this);	149	fCombo.addSelectionListener(this);
150	}	150	}
		151
		152	private void populateList(String[] templates, String[] comments) {
		153	fCombo.removeAll();
		154
		155	fCombo.add(fMessage);
		156	for (int i = 0; i < templates.length; i++) {
		157	fCombo.add("TEMPL: " + HistoryView.flattenText(templates[i]));
		158	}
		159	// TODO: add divider here and remove "TEMPL:" above
		160	// (note: widgetSelected() below must be changed accordingly)
		161	for (int i = 0; i < comments.length; i++) {
		162	fCombo.add(HistoryView.flattenText(comments[i]));
		163	}
		164	fCombo.setText(fMessage);
		165	}
151		166
152	public void widgetSelected(SelectionEvent e) {	167	public void widgetSelected(SelectionEvent e) {
153	final int index = fCombo.getSelectionIndex();	168	int index = fCombo.getSelectionIndex();
154	if (index > 0) {	169	if (index > 0) {
		170	index--;
155	setChanged();	171	setChanged();
156	notifyObservers(fComments[index - 1]);	172
		173	// map from combo box index to array index
		174	String message;
		175	if (index < fCommentTemplates.length) {
		176	message = fCommentTemplates[index];
		177	} else {
		178	message = fComments[index - fCommentTemplates.length];
		179	}
		180	notifyObservers(message);
157	}	181	}
158	}	182	}
159		183
Lines 178-187 Link Here
178	public void setEnabled(boolean enabled) {	202	public void setEnabled(boolean enabled) {
179	fCombo.setEnabled(enabled);	203	fCombo.setEnabled(enabled);
180	}	204	}
		205
		206	void setCommentTemplates(String[] templates) {
		207	populateList(templates, fComments);
		208	}
181	}	209	}
182		210
183	private static final String EMPTY_MESSAGE= CVSUIMessages.CommitCommentArea_0; //$NON-NLS-1$	211	private static final String EMPTY_MESSAGE= CVSUIMessages.CommitCommentArea_0; //$NON-NLS-1$
184	private static final String COMBO_MESSAGE= CVSUIMessages.CommitCommentArea_1; //$NON-NLS-1$	212	private static final String COMBO_MESSAGE= CVSUIMessages.CommitCommentArea_1; //$NON-NLS-1$
		213	private static final String CONFIGURE_TEMPLATES_MESSAGE= CVSUIMessages.CommitCommentArea_5; //$NON-NLS-1$
185		214
186	public static final String OK_REQUESTED = "OkRequested";//$NON-NLS-1$	215	public static final String OK_REQUESTED = "OkRequested";//$NON-NLS-1$
187	public static final String COMMENT_MODIFIED = "CommentModified";//$NON-NLS-1$	216	public static final String COMMENT_MODIFIED = "CommentModified";//$NON-NLS-1$
Lines 206-224 Link Here
206	fTextBox= new TextBox(fComposite, EMPTY_MESSAGE, getInitialComment());	235	fTextBox= new TextBox(fComposite, EMPTY_MESSAGE, getInitialComment());
207		236
208	final String [] comments = CVSUIPlugin.getPlugin().getRepositoryManager().getPreviousComments();	237	final String [] comments = CVSUIPlugin.getPlugin().getRepositoryManager().getPreviousComments();
209	fComboBox= new ComboBox(fComposite, COMBO_MESSAGE, comments);	238	final String[] commentTemplates = CVSUIPlugin.getPlugin().getRepositoryManager().getCommentTemplates();
		239	fComboBox= new ComboBox(fComposite, COMBO_MESSAGE, comments, commentTemplates);
		240
		241	Link templatesPrefsLink = new Link(fComposite, 0);
		242	templatesPrefsLink.setText("<a href=\"configureTemplates\">" + //$NON-NLS-1$
		243	CONFIGURE_TEMPLATES_MESSAGE + "</a>"); //$NON-NLS-1$
		244	templatesPrefsLink.addSelectionListener(new SelectionListener() {
		245	public void widgetDefaultSelected(SelectionEvent e) {
		246	openCommentTemplatesPreferencePage();
		247	}
		248
		249	public void widgetSelected(SelectionEvent e) {
		250	openCommentTemplatesPreferencePage();
		251	}
		252	});
210		253
211	fComboBox.addObserver(fTextBox);	254	fComboBox.addObserver(fTextBox);
212	}	255	}
213		256
214	public String getComment(boolean save) {	257	void openCommentTemplatesPreferencePage() {
		258	PreferencesUtil.createPreferenceDialogOn(
		259	null,
		260	"org.eclipse.team.cvs.ui.CommentTemplatesPreferences",
		261	new String[] { "org.eclipse.team.cvs.ui.CommentTemplatesPreferences" },
		262	null).open();
		263	fComboBox.setCommentTemplates(
		264	CVSUIPlugin.getPlugin().getRepositoryManager().getCommentTemplates());
		265	}
		266
		267	public String getComment(boolean save) {
215	final String comment= fTextBox.getText();	268	final String comment= fTextBox.getText();
216	if (comment == null)	269	if (comment == null)
217	return ""; //$NON-NLS-1$	270	return ""; //$NON-NLS-1$
218		271
219	final String stripped= strip(comment);	272	final String stripped= strip(comment);
220	if (save && comment.length() > 0)	273	if (save && comment.length() > 0)
221	CVSUIPlugin.getPlugin().getRepositoryManager().addComment(comment);	274	CVSUIPlugin.getPlugin().getRepositoryManager().addComment(comment, false);
222		275
223	return stripped;	276	return stripped;
224	}	277	}

Lines 853-858 Link Here

(-)src/org/eclipse/team/internal/ccvs/ui/messages.properties (+8 lines)
853	CommitCommentArea_2=Empty commit comment	853	CommitCommentArea_2=Empty commit comment
854	CommitCommentArea_3=The commit comment is empty. Are you sure you would like to continue with an empty comment?	854	CommitCommentArea_3=The commit comment is empty. Are you sure you would like to continue with an empty comment?
855	CommitCommentArea_4=Re&member decision?	855	CommitCommentArea_4=Re&member decision?
		856	CommitCommentArea_5=Configure Comment Templates...
856		857
857		858
858		859
Lines 1039-1041 Link Here
1039	UncommittedChangesDialog_3=&The dirty resources contained in ''{0}''	1040	UncommittedChangesDialog_3=&The dirty resources contained in ''{0}''
1040	UncommittedChangesDialog_4=&The full path of ''{0}''	1041	UncommittedChangesDialog_4=&The full path of ''{0}''
1041	AddWizard_0=Add to Version Control	1042	AddWizard_0=Add to Version Control
		1043
		1044	CommentTemplatesPreferencePage_Description=Create, edit or remove comment templates:
		1045	CommentTemplatesPreferencePage_New=New...
		1046	CommentTemplatesPreferencePage_Edit=Edit...
		1047	CommentTemplatesPreferencePage_Remove=Remove
		1048	CommentTemplatesPreferencePage_EditCommentTemplateTitle=Enter Comment Template
		1049	CommentTemplatesPreferencePage_EditCommentTemplateMessage=Please enter a comment template:

Lines 47-54 Link Here

(-)src/org/eclipse/team/internal/ccvs/ui/repo/RepositoryManager.java (-11 / +136 lines)
47	// new state file	47	// new state file
48	private static final String REPOSITORIES_VIEW_FILE = "repositoriesView.xml"; //$NON-NLS-1$	48	private static final String REPOSITORIES_VIEW_FILE = "repositoriesView.xml"; //$NON-NLS-1$
49	private static final String COMMENT_HIST_FILE = "commitCommentHistory.xml"; //$NON-NLS-1$	49	private static final String COMMENT_HIST_FILE = "commitCommentHistory.xml"; //$NON-NLS-1$
		50	private static final String COMMENT_TEMPLATES_FILE = "commentTemplates.xml"; //$NON-NLS-1$
50	static final String ELEMENT_COMMIT_COMMENT = "CommitComment"; //$NON-NLS-1$	51	static final String ELEMENT_COMMIT_COMMENT = "CommitComment"; //$NON-NLS-1$
51	static final String ELEMENT_COMMIT_HISTORY = "CommitComments"; //$NON-NLS-1$	52	static final String ELEMENT_COMMIT_HISTORY = "CommitComments"; //$NON-NLS-1$
		53	static final String ELEMENT_COMMENT_TEMPLATES = "CommitCommentTemplates"; //$NON-NLS-1$
52		54
53	private Map repositoryRoots = new HashMap();	55	private Map repositoryRoots = new HashMap();
54		56
Lines 56-61 Link Here
56		58
57	// The previously remembered comment	59	// The previously remembered comment
58	static String[] previousComments = new String[0];	60	static String[] previousComments = new String[0];
		61	static String[] commentTemplates = new String[0];
59		62
60	public static boolean notifyRepoView = true;	63	public static boolean notifyRepoView = true;
61		64
Lines 303-308 Link Here
303	public void startup() {	306	public void startup() {
304	loadState();	307	loadState();
305	loadCommentHistory();	308	loadCommentHistory();
		309	loadCommentTemplates();
306	CVSProviderPlugin.getPlugin().addRepositoryListener(new ICVSListener() {	310	CVSProviderPlugin.getPlugin().addRepositoryListener(new ICVSListener() {
307	public void repositoryAdded(ICVSRepositoryLocation root) {	311	public void repositoryAdded(ICVSRepositoryLocation root) {
308	rootAdded(root);	312	rootAdded(root);
Lines 316-321 Link Here
316	public void shutdown() throws TeamException {	320	public void shutdown() throws TeamException {
317	saveState();	321	saveState();
318	saveCommentHistory();	322	saveCommentHistory();
		323	saveCommentTemplates();
319	}	324	}
320		325
321	private void loadState() {	326	private void loadState() {
Lines 372-377 Link Here
372	CVSUIPlugin.log(e);	377	CVSUIPlugin.log(e);
373	}	378	}
374	}	379	}
		380	private void loadCommentTemplates() {
		381	IPath pluginStateLocation = CVSUIPlugin.getPlugin().getStateLocation().append(COMMENT_TEMPLATES_FILE);
		382	File file = pluginStateLocation.toFile();
		383	if (!file.exists()) return;
		384	try {
		385	BufferedInputStream is = new BufferedInputStream(new FileInputStream(file));
		386	try {
		387	readCommentTemplates(is);
		388	} finally {
		389	is.close();
		390	}
		391	} catch (IOException e) {
		392	CVSUIPlugin.log(Status.ERROR, CVSUIMessages.RepositoryManager_ioException, e); //$NON-NLS-1$
		393	} catch (TeamException e) {
		394	CVSUIPlugin.log(e);
		395	}
		396	}
375		397
376	protected void saveState() throws TeamException {	398	protected void saveState() throws TeamException {
377	IPath pluginStateLocation = CVSUIPlugin.getPlugin().getStateLocation();	399	IPath pluginStateLocation = CVSUIPlugin.getPlugin().getStateLocation();
Lines 430-435 Link Here
430	throw new CVSException(NLS.bind(CVSUIMessages.RepositoryManager_parsingProblem, new String[] { COMMENT_HIST_FILE }), ex); //$NON-NLS-1$	452	throw new CVSException(NLS.bind(CVSUIMessages.RepositoryManager_parsingProblem, new String[] { COMMENT_HIST_FILE }), ex); //$NON-NLS-1$
431	}	453	}
432	}	454	}
		455	private void readCommentTemplates(InputStream stream) throws IOException, TeamException {
		456	try {
		457	SAXParserFactory factory = SAXParserFactory.newInstance();
		458	SAXParser parser = factory.newSAXParser();
		459	parser.parse(new InputSource(stream), new CommentTemplatesContentHandler());
		460	} catch (SAXException ex) {
		461	throw new CVSException(NLS.bind(CVSUIMessages.RepositoryManager_parsingProblem, new String[] { COMMENT_TEMPLATES_FILE }), ex); //$NON-NLS-1$
		462	} catch (ParserConfigurationException ex) {
		463	throw new CVSException(NLS.bind(CVSUIMessages.RepositoryManager_parsingProblem, new String[] { COMMENT_TEMPLATES_FILE }), ex); //$NON-NLS-1$
		464	}
		465	}
433		466
434	private void readOldState(DataInputStream dis) throws IOException, TeamException {	467	private void readOldState(DataInputStream dis) throws IOException, TeamException {
435	int repoSize = dis.readInt();	468	int repoSize = dis.readInt();
Lines 512-523 Link Here
512	throw new TeamException(new Status(Status.ERROR, CVSUIPlugin.ID, TeamException.UNABLE, NLS.bind(CVSUIMessages.RepositoryManager_save, new String[] { histFile.getAbsolutePath() }), e)); //$NON-NLS-1$	545	throw new TeamException(new Status(Status.ERROR, CVSUIPlugin.ID, TeamException.UNABLE, NLS.bind(CVSUIMessages.RepositoryManager_save, new String[] { histFile.getAbsolutePath() }), e)); //$NON-NLS-1$
513	}	546	}
514	}	547	}
		548	protected void saveCommentTemplates() throws TeamException {
		549	IPath pluginStateLocation = CVSUIPlugin.getPlugin().getStateLocation();
		550	File tempFile = pluginStateLocation.append(COMMENT_TEMPLATES_FILE + ".tmp").toFile(); //$NON-NLS-1$
		551	File histFile = pluginStateLocation.append(COMMENT_TEMPLATES_FILE).toFile();
		552	try {
		553	XMLWriter writer = new XMLWriter(new BufferedOutputStream(new FileOutputStream(tempFile)));
		554	try {
		555	writeCommentTemplates(writer);
		556	} finally {
		557	writer.close();
		558	}
		559	if (histFile.exists()) {
		560	histFile.delete();
		561	}
		562	boolean renamed = tempFile.renameTo(histFile);
		563	if (!renamed) {
		564	throw new TeamException(new Status(Status.ERROR, CVSUIPlugin.ID, TeamException.UNABLE, NLS.bind(CVSUIMessages.RepositoryManager_rename, new String[] { tempFile.getAbsolutePath() }), null)); //$NON-NLS-1$
		565	}
		566	} catch (IOException e) {
		567	throw new TeamException(new Status(Status.ERROR, CVSUIPlugin.ID, TeamException.UNABLE, NLS.bind(CVSUIMessages.RepositoryManager_save, new String[] { histFile.getAbsolutePath() }), e)); //$NON-NLS-1$
		568	}
		569	}
515	private void writeCommentHistory(XMLWriter writer) {	570	private void writeCommentHistory(XMLWriter writer) {
516	writer.startTag(ELEMENT_COMMIT_HISTORY, null, false);	571	writer.startTag(ELEMENT_COMMIT_HISTORY, null, false);
517	for (int i=0; i<previousComments.length && i<MAX_COMMENTS; i++)	572	for (int i=0; i<previousComments.length && i<MAX_COMMENTS; i++)
518	writer.printSimpleTag(ELEMENT_COMMIT_COMMENT, previousComments[i]);	573	writer.printSimpleTag(ELEMENT_COMMIT_COMMENT, previousComments[i]);
519	writer.endTag(ELEMENT_COMMIT_HISTORY);	574	writer.endTag(ELEMENT_COMMIT_HISTORY);
520	}	575	}
		576	private void writeCommentTemplates(XMLWriter writer) {
		577	writer.startTag(ELEMENT_COMMENT_TEMPLATES, null, false);
		578	for (int i=0; i<commentTemplates.length; i++)
		579	writer.printSimpleTag(ELEMENT_COMMIT_COMMENT, commentTemplates[i]);
		580	writer.endTag(ELEMENT_COMMENT_TEMPLATES);
		581	}
521		582
522	public void addRepositoryListener(IRepositoryListener listener) {	583	public void addRepositoryListener(IRepositoryListener listener) {
523	listeners.add(listener);	584	listeners.add(listener);
Lines 778-798 Link Here
778	return previousComments;	839	return previousComments;
779	}	840	}
780		841
		842	/**
		843	* Get list of comment templates.
		844	*/
		845	public String[] getCommentTemplates() {
		846	return commentTemplates;
		847	}
		848
781	/**	849	/**
782	* Method addComment.	850	* Method addComment.
783	* @param string	851	* @param string
784	*/	852	*/
785	public void addComment(String comment) {	853	public void addComment(String comment, boolean template) {
786	// Only add the comment if its not there already	854	if (template) {
787	if (containsComment(comment)) return;	855	addCommentTemplate(comment);
788	// Insert the comment as the first element	856	} else {
789	String[] newComments = new String[Math.min(previousComments.length + 1, MAX_COMMENTS)];	857	addComment(comment);
790	newComments[0] = comment;	858	}
791	for (int i = 1; i < newComments.length; i++) {	859	}
792	newComments[i] = previousComments[i-1];	860
793	}	861	private void addCommentTemplate(String comment) {
794	previousComments = newComments;	862	// Only add the comment if its not there already
795	}	863	if (containsCommentTemplate(comment))
		864	return;
		865
		866	// remove from list of regular comments if there
		867	if (containsComment(comment)) {
		868	List newComments = new ArrayList();
		869	for (int i = 0; i < previousComments.length; i++) {
		870	if (!previousComments[i].equals(comment))
		871	newComments.add(previousComments[i]);
		872	}
		873	previousComments = (String[]) newComments.toArray(new String[0]);
		874	}
		875
		876	// Insert the comment as first element
		877	String[] newComments = new String[commentTemplates.length + 1];
		878	System.arraycopy(commentTemplates, 0, newComments, 1, commentTemplates.length);
		879	newComments[0] = comment;
		880	commentTemplates = newComments;
		881	}
		882
		883	private void addComment(String comment) {
		884	// Only add the comment if its not there already
		885	if (containsComment(comment))
		886	return;
		887
		888	// remove from list of comment templates if there
		889	if (containsCommentTemplate(comment)) {
		890	List newComments = new ArrayList();
		891	for (int i = 0; i < commentTemplates.length; i++) {
		892	if (!commentTemplates[i].equals(comment))
		893	newComments.add(commentTemplates[i]);
		894	}
		895	commentTemplates = (String[]) newComments.toArray(new String[0]);
		896	}
		897
		898	// Insert the comment as the first element
		899	String[] newComments = new String[Math.min(
		900	previousComments.length + 1, MAX_COMMENTS)];
		901	newComments[0] = comment;
		902	for (int i = 1; i < newComments.length; i++) {
		903	newComments[i] = previousComments[i - 1];
		904	}
		905	previousComments = newComments;
		906	}
796		907
797	private boolean containsComment(String comment) {	908	private boolean containsComment(String comment) {
798	for (int i = 0; i < previousComments.length; i++) {	909	for (int i = 0; i < previousComments.length; i++) {
Lines 802-805 Link Here
802	}	913	}
803	return false;	914	return false;
804	}	915	}
		916
		917	private boolean containsCommentTemplate(String comment) {
		918	for (int i = 0; i < commentTemplates.length; i++) {
		919	if (commentTemplates[i].equals(comment)) {
		920	return true;
		921	}
		922	}
		923	return false;
		924	}
		925
		926	public void replaceAndSaveCommentTemplates(String[] templates) throws TeamException {
		927	commentTemplates = templates;
		928	saveCommentTemplates();
		929	}
805	}	930	}

Added Link Here

(-)src/org/eclipse/team/internal/ccvs/ui/CommentTemplateEditDialog.java (+260 lines)
1	/*******************************************************************************
2	* Copyright (c) 2000, 2005 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.team.internal.ccvs.ui;
12
13	import org.eclipse.jface.dialogs.Dialog;
14	import org.eclipse.jface.dialogs.IDialogConstants;
15	import org.eclipse.jface.dialogs.IInputValidator;
16	import org.eclipse.swt.SWT;
17	import org.eclipse.swt.events.ModifyEvent;
18	import org.eclipse.swt.events.ModifyListener;
19	import org.eclipse.swt.layout.GridData;
20	import org.eclipse.swt.widgets.Button;
21	import org.eclipse.swt.widgets.Composite;
22	import org.eclipse.swt.widgets.Control;
23	import org.eclipse.swt.widgets.Label;
24	import org.eclipse.swt.widgets.Shell;
25	import org.eclipse.swt.widgets.Text;
26
27	/**
28	* A simple input dialog for soliciting an input string from the user.
29	* <p>
30	* This concrete dialog class can be instantiated as is, or further subclassed as
31	* required.
32	* </p>
33	*/
34	public class CommentTemplateEditDialog extends Dialog {
35	/**
36	* The title of the dialog.
37	*/
38	private String title;
39
40	/**
41	* The message to display, or <code>null</code> if none.
42	*/
43	private String message;
44
45	/**
46	* The input value; the empty string by default.
47	*/
48	private String value = "";//$NON-NLS-1$
49
50	/**
51	* The input validator, or <code>null</code> if none.
52	*/
53	private IInputValidator validator;
54
55	/**
56	* Ok button widget.
57	*/
58	private Button okButton;
59
60	/**
61	* Input text widget.
62	*/
63	private Text text;
64
65	/**
66	* Error message label widget.
67	*/
68	private Text errorMessageText;
69
70	/**
71	* Creates an input dialog with OK and Cancel buttons. Note that the dialog
72	* will have no visual representation (no widgets) until it is told to open.
73	* <p>
74	* Note that the <code>open</code> method blocks for input dialogs.
75	* </p>
76	*
77	* @param parentShell
78	* the parent shell, or <code>null</code> to create a top-level
79	* shell
80	* @param dialogTitle
81	* the dialog title, or <code>null</code> if none
82	* @param dialogMessage
83	* the dialog message, or <code>null</code> if none
84	* @param initialValue
85	* the initial input value, or <code>null</code> if none
86	* (equivalent to the empty string)
87	* @param validator
88	* an input validator, or <code>null</code> if none
89	*/
90	public CommentTemplateEditDialog(Shell parentShell, String dialogTitle,
91	String dialogMessage, String initialValue, IInputValidator validator) {
92	super(parentShell);
93	this.title = dialogTitle;
94	message = dialogMessage;
95	if (initialValue == null)
96	value = "";//$NON-NLS-1$
97	else
98	value = initialValue;
99	this.validator = validator;
100	}
101
102	/*
103	* (non-Javadoc) Method declared on Dialog.
104	*/
105	protected void buttonPressed(int buttonId) {
106	if (buttonId == IDialogConstants.OK_ID) {
107	value = text.getText();
108	} else {
109	value = null;
110	}
111	super.buttonPressed(buttonId);
112	}
113
114	/*
115	* (non-Javadoc)
116	*
117	* @see org.eclipse.jface.window.Window#configureShell(org.eclipse.swt.widgets.Shell)
118	*/
119	protected void configureShell(Shell shell) {
120	super.configureShell(shell);
121	if (title != null)
122	shell.setText(title);
123	}
124
125	/*
126	* (non-Javadoc)
127	*
128	* @see org.eclipse.jface.dialogs.Dialog#createButtonsForButtonBar(org.eclipse.swt.widgets.Composite)
129	*/
130	protected void createButtonsForButtonBar(Composite parent) {
131	// create OK and Cancel buttons by default
132	okButton = createButton(parent, IDialogConstants.OK_ID,
133	IDialogConstants.OK_LABEL, true);
134	createButton(parent, IDialogConstants.CANCEL_ID,
135	IDialogConstants.CANCEL_LABEL, false);
136	//do this here because setting the text will set enablement on the ok
137	// button
138	text.setFocus();
139	if (value != null) {
140	text.setText(value);
141	text.selectAll();
142	}
143	}
144
145	/*
146	* (non-Javadoc) Method declared on Dialog.
147	*/
148	protected Control createDialogArea(Composite parent) {
149	// create composite
150	Composite composite = (Composite) super.createDialogArea(parent);
151	// create message
152	if (message != null) {
153	Label label = new Label(composite, SWT.WRAP);
154	label.setText(message);
155	GridData data = new GridData(GridData.GRAB_HORIZONTAL
156	\| GridData.GRAB_VERTICAL \| GridData.HORIZONTAL_ALIGN_FILL
157	\| GridData.VERTICAL_ALIGN_CENTER);
158	data.widthHint = convertHorizontalDLUsToPixels(IDialogConstants.MINIMUM_MESSAGE_AREA_WIDTH);
159	label.setLayoutData(data);
160	label.setFont(parent.getFont());
161	}
162	text = new Text(composite, SWT.MULTI \| SWT.BORDER);
163	GridData gd = new GridData(GridData.GRAB_HORIZONTAL
164	\| GridData.HORIZONTAL_ALIGN_FILL);
165	gd.heightHint = convertHeightInCharsToPixels(5);
166	text.setLayoutData(gd);
167	text.addModifyListener(new ModifyListener() {
168	public void modifyText(ModifyEvent e) {
169	validateInput();
170	}
171	});
172	errorMessageText = new Text(composite, SWT.READ_ONLY);
173	errorMessageText.setLayoutData(new GridData(GridData.GRAB_HORIZONTAL
174	\| GridData.HORIZONTAL_ALIGN_FILL));
175	errorMessageText.setBackground(errorMessageText.getDisplay()
176	.getSystemColor(SWT.COLOR_WIDGET_BACKGROUND));
177
178	applyDialogFont(composite);
179	return composite;
180	}
181
182	/**
183	* Returns the error message label.
184	*
185	* @return the error message label
186	* @deprecated use setErrorMessage(String) instead
187	*/
188	protected Label getErrorMessageLabel() {
189	return null;
190	}
191
192	/**
193	* Returns the ok button.
194	*
195	* @return the ok button
196	*/
197	protected Button getOkButton() {
198	return okButton;
199	}
200
201	/**
202	* Returns the text area.
203	*
204	* @return the text area
205	*/
206	protected Text getText() {
207	return text;
208	}
209
210	/**
211	* Returns the validator.
212	*
213	* @return the validator
214	*/
215	protected IInputValidator getValidator() {
216	return validator;
217	}
218
219	/**
220	* Returns the string typed into this input dialog.
221	*
222	* @return the input string
223	*/
224	public String getValue() {
225	return value;
226	}
227
228	/**
229	* Validates the input.
230	* <p>
231	* The default implementation of this framework method delegates the request
232	* to the supplied input validator object; if it finds the input invalid,
233	* the error message is displayed in the dialog's message line. This hook
234	* method is called whenever the text changes in the input field.
235	* </p>
236	*/
237	protected void validateInput() {
238	String errorMessage = null;
239	if (validator != null) {
240	errorMessage = validator.isValid(text.getText());
241	}
242	// Bug 16256: important not to treat "" (blank error) the same as null
243	// (no error)
244	setErrorMessage(errorMessage);
245	}
246
247	/**
248	* Sets or clears the error message.
249	* If not <code>null</code>, the OK button is disabled.
250	*
251	* @param errorMessage
252	* the error message, or <code>null</code> to clear
253	* @since 3.0
254	*/
255	public void setErrorMessage(String errorMessage) {
256	errorMessageText.setText(errorMessage == null ? "" : errorMessage); //$NON-NLS-1$
257	okButton.setEnabled(errorMessage == null);
258	errorMessageText.getParent().update();
259	}
260	}

Added Link Here

(-)src/org/eclipse/team/internal/ccvs/ui/repo/CommentTemplatesContentHandler.java (+85 lines)
1	/*******************************************************************************
2	* Copyright (c) 2000, 2003 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11
12	package org.eclipse.team.internal.ccvs.ui.repo;
13
14	import java.util.Vector;
15
16	import org.xml.sax.SAXException;
17	import org.xml.sax.helpers.DefaultHandler;
18	import org.xml.sax.Attributes;
19
20	class CommentTemplatesContentHandler extends DefaultHandler {
21
22	private StringBuffer buffer;
23	private Vector comments;
24	public CommentTemplatesContentHandler() {
25	}
26
27	/**
28	* @see ContentHandler#characters(char[], int, int)
29	*/
30	public void characters(char[] chars, int startIndex, int length) throws SAXException {
31	if (buffer == null) return;
32	buffer.append(chars, startIndex, length);
33	}
34
35	/**
36	* @see ContentHandler#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
37	*/
38	public void startElement(
39	String namespaceURI,
40	String localName,
41	String qName,
42	Attributes atts)
43	throws SAXException {
44
45	String elementName = getElementName(namespaceURI, localName, qName);
46	if (elementName.equals(RepositoryManager.ELEMENT_COMMIT_COMMENT)) {
47	buffer = new StringBuffer();
48	return;
49	}
50	if (elementName.equals(RepositoryManager.ELEMENT_COMMENT_TEMPLATES)) {
51	comments = new Vector();
52	return;
53	}
54	}
55
56	/**
57	* @see org.xml.sax.ContentHandler#endElement(java.lang.String, java.lang.String, java.lang.String)
58	*/
59	public void endElement(String namespaceURI, String localName, String qName) {
60	String elementName = getElementName(namespaceURI, localName, qName);
61	if (elementName.equals(RepositoryManager.ELEMENT_COMMIT_COMMENT)) {
62	comments.add(buffer.toString());
63	buffer = null;
64	return;
65	}
66	if (elementName.equals(RepositoryManager.ELEMENT_COMMENT_TEMPLATES)) {
67	RepositoryManager.commentTemplates = new String[comments.size()];
68	comments.copyInto(RepositoryManager.commentTemplates);
69	return;
70	}
71	}
72
73	/*
74	* Couldn't figure out from the SAX API exactly when localName vs. qName is used.
75	* However, the XML for project sets doesn't use namespaces so either of the two names
76	* is fine. Therefore, use whichever one is provided.
77	*/
78	private String getElementName(String namespaceURI, String localName, String qName) {
79	if (localName != null && localName.length() > 0) {
80	return localName;
81	} else {
82	return qName;
83	}
84	}
85	}