GeneralPreferencesPage.java

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

package com.microsoft.copilot.eclipse.ui.preferences;

import org.eclipse.core.runtime.preferences.ConfigurationScope;
import org.eclipse.core.runtime.preferences.IEclipsePreferences;
import org.eclipse.jface.layout.GridDataFactory;
import org.eclipse.jface.preference.BooleanFieldEditor;
import org.eclipse.jface.preference.FieldEditorPreferencePage;
import org.eclipse.jface.preference.StringFieldEditor;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Group;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;
import org.osgi.service.prefs.BackingStoreException;

import com.microsoft.copilot.eclipse.core.Constants;
import com.microsoft.copilot.eclipse.core.CopilotCore;
import com.microsoft.copilot.eclipse.ui.CopilotUi;

/**
 * General preference page.
 */
public class GeneralPreferencesPage extends FieldEditorPreferencePage implements IWorkbenchPreferencePage {

  public static final String ID = "com.microsoft.copilot.eclipse.ui.preferences.GeneralPreferencesPage";

  /**
   * Constructor.
   */
  public GeneralPreferencesPage() {
    super(GRID);
  }

  @Override
  public void createFieldEditors() {
    Composite parent = getFieldEditorParent();
    parent.setLayout(new GridLayout(1, true));
    GridLayout gl = new GridLayout(1, true);
    gl.marginTop = 2;
    gl.marginLeft = 2;

    GridDataFactory gdf = GridDataFactory.fillDefaults().span(2, 1).align(SWT.FILL, SWT.FILL).grab(true, false);

    // proxy group
    Group grpProxy = new Group(parent, SWT.NONE);
    grpProxy.setLayout(gl);
    gdf.applyTo(grpProxy);
    grpProxy.setText(Messages.preferences_page_proxy_settings);
    // add proxy configuration link
    Composite linkContainer = new Composite(grpProxy, SWT.NONE);
    GridLayout glTextIndent = new GridLayout(1, false);
    glTextIndent.marginLeft = -3;
    glTextIndent.marginBottom = 1;
    linkContainer.setLayout(glTextIndent);
    PreferencePageUtils.createPreferenceLink(getShell(), linkContainer, Messages.preferences_page_proxy_config_link,
        Messages.preferences_page_proxy_config_link_tooltip, "org.eclipse.ui.net.NetPreferences");

    // add strict ssl field
    Composite ctnSsl = new Composite(grpProxy, SWT.NONE);
    ctnSsl.setLayout(gl);
    BooleanFieldEditor bfeSsl = new BooleanFieldEditor(Constants.ENABLE_STRICT_SSL,
        Messages.preferences_page_enable_strict_ssl, ctnSsl);
    bfeSsl.getDescriptionControl(ctnSsl).setToolTipText(Messages.preferences_page_enable_strict_ssl_tooltip);
    addField(bfeSsl);

    // add Note using WrappableNoteLabel
    new WrappableNoteLabel(grpProxy, Messages.preferences_page_note_prefix + " ",
        Messages.preferences_page_note_content);

    // auth group
    Group grpAuth = new Group(parent, SWT.NONE);
    grpAuth.setLayout(gl);
    gdf.applyTo(grpAuth);
    grpAuth.setText(Messages.preferences_page_auth_settings);
    // add github enterprise field
    Composite ctnGhe = new Composite(grpAuth, SWT.NONE);
    ctnGhe.setLayout(gl);
    ctnGhe.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, false));
    StringFieldEditor sftGhe = new StringFieldEditor(Constants.GITHUB_ENTERPRISE,
        Messages.preferences_page_github_enterprise, ctnGhe);
    sftGhe.getLabelControl(ctnGhe).setToolTipText(Messages.preferences_page_github_enterprise_tooltip);
    addField(sftGhe);

    // What's new group
    Group whatsNewGroup = new Group(parent, SWT.NONE);
    whatsNewGroup.setLayout(gl);
    gdf.applyTo(whatsNewGroup);
    whatsNewGroup.setText(Messages.preferences_page_whats_new_settings);

    // auto show "What is new" field
    Composite whatsNewComposite = new Composite(whatsNewGroup, SWT.NONE);
    whatsNewComposite.setLayout(gl);
    whatsNewComposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
    BooleanFieldEditor showWhatsNewField = new BooleanFieldEditor(Constants.AUTO_SHOW_WHAT_IS_NEW,
        Messages.preferences_page_enable_whats_new, whatsNewComposite);
    showWhatsNewField.getDescriptionControl(whatsNewComposite)
        .setToolTipText(Messages.preferences_page_enable_whats_new_tooltip);
    addField(showWhatsNewField);
  }

  @Override
  public void init(IWorkbench workbench) {
    setPreferenceStore(CopilotUi.getPlugin().getPreferenceStore());
  }

  @Override
  public boolean performOk() {
    boolean result = super.performOk();
    boolean newWhatsNewValue = getPreferenceStore().getBoolean(Constants.AUTO_SHOW_WHAT_IS_NEW);

    // Update the new value for fields that must persist in configuration scope
    IEclipsePreferences configPrefs = ConfigurationScope.INSTANCE
        .getNode(CopilotUi.getPlugin().getBundle().getSymbolicName());
    boolean oldWhatsNewValue = configPrefs.getBoolean(Constants.AUTO_SHOW_WHAT_IS_NEW, true);

    // Ensure the preference change is updated in configuration scope too
    if (oldWhatsNewValue ^ newWhatsNewValue) {
      try {
        configPrefs.putBoolean(Constants.AUTO_SHOW_WHAT_IS_NEW, newWhatsNewValue);
        configPrefs.flush();
      } catch (BackingStoreException ex) {
        CopilotCore.LOGGER.error("Failed to persist 'Auto show What's New' preference in ConfigurationScope", ex);
      }
    }

    return result;
  }

}