org.tinymediamanager.ui.panels.MediaScraperConfigurationPanel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tinyMediaManager Show documentation
The newest version!
/*
 * Copyright 2012 - 2019 Manuel Laggner
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.tinymediamanager.ui.panels;

import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.util.Map;
import java.util.Map.Entry;
import java.util.ResourceBundle;

import javax.swing.JCheckBox;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JPasswordField;
import javax.swing.JTextField;
import javax.swing.event.AncestorEvent;
import javax.swing.event.AncestorListener;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;

import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.tinymediamanager.scraper.config.MediaProviderConfig;
import org.tinymediamanager.scraper.config.MediaProviderConfigObject;
import org.tinymediamanager.scraper.mediaprovider.IMediaProvider;
import org.tinymediamanager.ui.IconManager;
import org.tinymediamanager.ui.UTF8Control;
import org.tinymediamanager.ui.components.TmmLabel;

/**
 * The class MediaScraperConfigurationPanel is used to display configurable scraper options
 * 
 * @author Manuel Laggner
 */
public class MediaScraperConfigurationPanel extends JPanel {
  private static final long           serialVersionUID = -4120483383064864579L;
  /** @wbp.nls.resourceBundle messages */
  private static final ResourceBundle BUNDLE           = ResourceBundle.getBundle("messages", new UTF8Control()); //$NON-NLS-1$
  private final static Logger         LOGGER           = LoggerFactory.getLogger(MediaScraperConfigurationPanel.class);

  private IMediaProvider              mediaProvider;
  private boolean                     dirty            = false;

  private JPanel                      configPanel;

  public MediaScraperConfigurationPanel(IMediaProvider mediaProvider) {
    this.mediaProvider = mediaProvider;

    setLayout(new BorderLayout());

    JPanel panelHead = new JPanel(new FlowLayout(FlowLayout.LEFT, 20, 0));
    add(panelHead, BorderLayout.NORTH);

    JLabel lblScraperOptions = new TmmLabel(BUNDLE.getString("Settings.scraper.options"), 1.2); //$NON-NLS-1$
    panelHead.add(lblScraperOptions);

    configPanel = createConfigPanel();
    add(configPanel, BorderLayout.CENTER);

    // add a listener to determine when to save the settings
    addAncestorListener(new AncestorListener() {
      @Override
      public void ancestorRemoved(AncestorEvent event) {
        // check if anything has been changed
        if (dirty) {
          saveSettings();
        }
      }

      @Override
      public void ancestorMoved(AncestorEvent event) {
        // nothing needed here
      }

      @Override
      public void ancestorAdded(AncestorEvent event) {
        // nothing needed here
      }
    });
  }

  private JPanel createConfigPanel() {
    JPanel panel = new JPanel();
    GridBagLayout gridBagLayout = new GridBagLayout();
    gridBagLayout.columnWidths = new int[] { 0 };
    gridBagLayout.rowHeights = new int[] { 0 };
    gridBagLayout.columnWeights = new double[] { Double.MIN_VALUE };
    gridBagLayout.rowWeights = new double[] { Double.MIN_VALUE };
    panel.setLayout(gridBagLayout);

    GridBagConstraints constraints = new GridBagConstraints();
    constraints.gridy = 0;

    // build up the panel for being displayed in the popup
    MediaProviderConfig config = mediaProvider.getProviderInfo().getConfig();
    for (Entry entry : config.getConfigObjects().entrySet()) {
      if (!entry.getValue().isVisible()) {
        continue;
      }

      constraints.anchor = GridBagConstraints.LINE_START;
      constraints.ipadx = 20;

      // label
      // try different ways to get a meaningful key description
      String keyDescription = getStringFromBundle("scraper." + mediaProvider.getProviderInfo().getId() + "." + entry.getKey());//$NON-NLS-1$
      if (StringUtils.isBlank(keyDescription)) {
        keyDescription = getStringFromBundle(entry.getValue().getKeyDescription());
      }
      if (StringUtils.isBlank(keyDescription)) {
        keyDescription = entry.getValue().getKeyDescription();
      }
      JLabel label = new JLabel(keyDescription);
      constraints.gridx = 0;
      panel.add(label, constraints);

      JComponent comp;
      switch (entry.getValue().getType()) {
        case BOOL:
          // display as checkbox
          JCheckBox checkbox = new JCheckBox();
          checkbox.setSelected(entry.getValue().getValueAsBool());
          checkbox.addActionListener(e -> dirty = true);
          comp = checkbox;
          break;

        case SELECT:
        case SELECT_INDEX:
          // display as combobox
          JComboBox combobox = new JComboBox<>(entry.getValue().getPossibleValues().toArray(new String[0]));
          combobox.setSelectedItem(entry.getValue().getValueAsString());
          combobox.addActionListener(e -> dirty = true);
          comp = combobox;
          break;

        default:
          // display as text
          JTextField tf;
          if (entry.getValue().isEncrypt()) {
            tf = new JPasswordField(config.getValue(entry.getKey()));
          }
          else {
            tf = new JTextField(config.getValue(entry.getKey()));
          }

          tf.setPreferredSize(new Dimension(250, 24));
          tf.getDocument().addDocumentListener(new DocumentListener() {
            @Override
            public void removeUpdate(DocumentEvent e) {
              dirty = true;
            }

            @Override
            public void insertUpdate(DocumentEvent e) {
              dirty = true;
            }

            @Override
            public void changedUpdate(DocumentEvent e) {
              dirty = true;
            }
          });
          comp = tf;
          break;
      }

      comp.putClientProperty(entry.getKey(), entry.getKey());
      constraints.ipadx = 0;
      constraints.gridx = 1;
      panel.add(comp, constraints);

      // add a hint if a long text has been found
      try {
        String desc = getStringFromBundle("scraper." + mediaProvider.getProviderInfo().getId() + "." + entry.getKey() + ".desc"); //$NON-NLS-1$
        if (StringUtils.isNotBlank(desc)) {
          JLabel lblHint = new JLabel(IconManager.HINT);
          lblHint.setToolTipText(desc);
          constraints.gridx = 2;
          panel.add(lblHint, constraints);
        }
      }
      catch (Exception e) {
        LOGGER.debug("failed to add a hint: {}", e.getMessage());
      }
      constraints.gridy++;
    }
    return panel;
  }

  /**
   * get the String from the bundle w/o throwing an exception
   * 
   * @param key
   *          the key to get the String for
   * @return the desired String or an empty String
   */
  private String getStringFromBundle(String key) {
    try {
      return BUNDLE.getString(key);
    }
    catch (Exception ignored) {
      // an exception if thrown here if no string in the resources has been found -> silently ignore
    }
    return "";
  }

  private void saveSettings() {
    Map config = mediaProvider.getProviderInfo().getConfig().getConfigObjects();
    // transfer the items from the components to the config
    for (Entry entry : config.entrySet()) {
      for (Component comp : configPanel.getComponents()) {
        // get the right component for this setting
        if (!(comp instanceof JComponent)) {
          continue;
        }

        Object param = ((JComponent) comp).getClientProperty(entry.getKey());
        if (!entry.getKey().equals(param)) {
          continue;
        }

        // parse the value and write it back to the new config
        try {
          if (comp instanceof JCheckBox) {
            mediaProvider.getProviderInfo().getConfig().setValue(entry.getKey(), ((JCheckBox) comp).isSelected());
          }
          else if (comp instanceof JComboBox) {
            mediaProvider.getProviderInfo().getConfig().setValue(entry.getKey(), ((JComboBox) comp).getSelectedItem().toString());
          }
          else {
            mediaProvider.getProviderInfo().getConfig().setValue(entry.getKey(), ((JTextField) comp).getText());
          }
        }
        catch (Exception ignored) {
        }
      }
    }

    mediaProvider.getProviderInfo().getConfig().save();
  }
}