Ignore options feature

src/main/com/google/code/tvrenamer/model/UserPreferences.java

@@ -1,6 +1,8 @@
 package com.google.code.tvrenamer.model;
 
 import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Observable;
 import java.util.logging.Logger;
 
@@ -24,6 +26,7 @@ public class UserPreferences extends Observable {
 	private ProxySettings proxy;
 	private boolean checkForUpdates;
 	private boolean recursivelyAddFolders;
+	private List<String> ignoreKeywords;
 
 	private final static UserPreferences INSTANCE = load();
 
@@ -40,6 +43,8 @@ private UserPreferences() {
 		this.proxy = new ProxySettings();
 		this.checkForUpdates = true;
 		this.recursivelyAddFolders = true;
+		this.ignoreKeywords = new ArrayList<String>();
+		this.ignoreKeywords.add("sample");
 
 		ensurePath();
 	}
@@ -176,6 +181,20 @@ public void setRecursivelyAddFolders(boolean recursivelyAddFolders) {
 	public boolean isRecursivelyAddFolders() {
 		return this.recursivelyAddFolders;
 	}
+
+	public void setIgnoreKeywords(List<String> ignoreKeywords) {
+		if(hasChanged(this.ignoreKeywords, ignoreKeywords)) {
+			// Convert commas into pipes for proper regex, remove periods
+			this.ignoreKeywords = ignoreKeywords;
+
+			setChanged();
+			notifyObservers(new UserPreferencesChangeEvent("ignoreKeywordsRegex", ignoreKeywords));
+		}
+	}
+
+	public List<String> getIgnoreKeywords() {
+		return this.ignoreKeywords;
+	}
 
 	public void setSeasonPrefix(String prefix) {
 		// Remove the displayed "

src/main/com/google/code/tvrenamer/view/PreferencesDialog.java

@@ -1,5 +1,7 @@
 package com.google.code.tvrenamer.view;
 
+import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.regex.Matcher;
@@ -30,11 +32,12 @@
 import org.eclipse.swt.widgets.DirectoryDialog;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Event;
-import org.eclipse.swt.widgets.Group;
 import org.eclipse.swt.widgets.Label;
 import org.eclipse.swt.widgets.List;
 import org.eclipse.swt.widgets.Listener;
 import org.eclipse.swt.widgets.Shell;
+import org.eclipse.swt.widgets.TabFolder;
+import org.eclipse.swt.widgets.TabItem;
 import org.eclipse.swt.widgets.Text;
 
 import com.google.code.tvrenamer.model.ProxySettings;
@@ -43,23 +46,22 @@
 import com.google.code.tvrenamer.model.TVRenamerIOException;
 import com.google.code.tvrenamer.model.UserPreferences;
 
-/**
- * The Preferences Dialog box.
- */
 public class PreferencesDialog extends Dialog {
-
+	
 	private static final String REPLACEMENT_OPTIONS_LIST_ENTRY_REGEX = "(.*) :.*";
 	private static Logger logger = Logger.getLogger(PreferencesDialog.class.getName());
 	private static Shell preferencesShell;
 	private static int DND_OPERATIONS = DND.DROP_MOVE;
+	private TabFolder tabFolder;
 
 	private final UserPreferences prefs;
-
+	
 	// The controls to save
 	private Button moveEnabledCheckbox;
 	private Text destDirText;
 	private Text seasonPrefixText;
 	private Text replacementStringText;
+	private Text ignoreWordsText;
 	private Button proxyEnabledCheckbox;
 	private Text proxyHostText;
 	private Text proxyPortText;
@@ -68,7 +70,7 @@ public class PreferencesDialog extends Dialog {
 	private Text proxyPasswordText;
 	private Button checkForUpdatesCheckbox;
 	private Button recurseFoldersCheckbox;
-
+	
 	/**
 	 * PreferencesDialog constructor
 	 * 
@@ -79,7 +81,7 @@ public PreferencesDialog(Shell parent) {
 		super(parent, SWT.DIALOG_TRIM | SWT.APPLICATION_MODAL);
 		this.prefs = UserPreferences.getInstance();
 	}
-
+	
 	public void open() {
 		// Create the dialog window
 		preferencesShell = new Shell(getParent(), getStyle());
@@ -97,60 +99,54 @@ public void open() {
 			}
 		}
 	}
-
-	/**
-	 * Creates the dialog's contents.
-	 * 
-	 * @param preferencesShell
-	 *            the dialog window
-	 */
+
 	private void createContents() {
 		GridLayout shellGridLayout = new GridLayout(3, false);
 		preferencesShell.setLayout(shellGridLayout);
-
+		
 		Label helpLabel = new Label(preferencesShell, SWT.NONE);
 		helpLabel.setText("Hover mouse over [?] to get help");
 		helpLabel.setLayoutData(new GridData(SWT.END, SWT.CENTER, true, true, shellGridLayout.numColumns, 1));
-
-		createMoveGroup();
-
-		createRenameGroup();
 
-		createProxyGroup();
+		tabFolder = new TabFolder(preferencesShell, getStyle());
+		tabFolder.setLayoutData(new GridData(SWT.END, SWT.CENTER, true, true, shellGridLayout.numColumns, 1));
 
-		createCheckForUpdatesGroup();
+		createGeneralTab();
+		createRenameTab();
+		createProxyTab();
 
-		createAddFolderGroup();
-
 		createActionButtonGroup();
 	}
-
-	private void createMoveGroup() {
-		Group moveGroup = new Group(preferencesShell, SWT.NONE);
-		moveGroup.setText("Move To TV Folder [?]");
-		moveGroup.setLayout(new GridLayout(3, false));
-		moveGroup.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, true, 3, 1));
-		moveGroup
+
+
+	private void createGeneralTab() {
+		TabItem item = new TabItem(tabFolder, SWT.NULL);
+		item.setText("General");
+
+		Composite generalGroup= new Composite(tabFolder, SWT.NONE);
+		generalGroup.setLayout(new GridLayout(3, false));
+		generalGroup.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, true, 3, 1));
+		generalGroup
 			.setToolTipText(" - TVRenamer will automatically move the files to your 'TV' folder if you want it to.  \n"
 				+ " - It will move the file to <tv directory>/<show name>/<season prefix> #/ \n"
 				+ " - Once enabled, set the location below.");
 
-		moveEnabledCheckbox = new Button(moveGroup, SWT.CHECK);
+		moveEnabledCheckbox = new Button(generalGroup, SWT.CHECK);
 		moveEnabledCheckbox.setText("Move Enabled [?]");
 		moveEnabledCheckbox.setSelection(prefs.isMovedEnabled());
 		moveEnabledCheckbox.setLayoutData(new GridData(GridData.BEGINNING, GridData.CENTER, true, true, 3, 1));
 		moveEnabledCheckbox.setToolTipText("Whether the 'move to TV location' functionality is enabled");
 
-		Label destDirLabel = new Label(moveGroup, SWT.NONE);
+		Label destDirLabel = new Label(generalGroup, SWT.NONE);
 		destDirLabel.setText("TV Directory [?]");
 		destDirLabel.setToolTipText("The location of your 'TV' folder");
 
-		destDirText = new Text(moveGroup, SWT.BORDER);
+		destDirText = new Text(generalGroup, SWT.BORDER);
 		destDirText.setText(prefs.getDestinationDirectory().toString());
 		destDirText.setTextLimit(99);
 		destDirText.setLayoutData(new GridData(GridData.FILL, GridData.CENTER, true, true));
 
-		final Button destDirButton = new Button(moveGroup, SWT.PUSH);
+		final Button destDirButton = new Button(generalGroup, SWT.PUSH);
 		destDirButton.setText("Select directory");
 		destDirButton.addListener(SWT.Selection, new Listener() {
 			@Override
@@ -167,13 +163,13 @@ public void handleEvent(Event event) {
 			}
 		});
 
-		Label seasonPrefixLabel = new Label(moveGroup, SWT.NONE);
+		Label seasonPrefixLabel = new Label(generalGroup, SWT.NONE);
 		seasonPrefixLabel.setText("Season Prefix [?]");
 		seasonPrefixLabel.setToolTipText(" - The prefix of the season when renaming and moving the file.  It is usually \"Season \" or \"s'\"." +
 			"\n - If no value is entered (or \"\"), the season folder will not be created, putting all files in the show name folder" +
 			"\n - The \" will not be included, just displayed here to show whitespace");
 
-		seasonPrefixText = new Text(moveGroup, SWT.BORDER);
+		seasonPrefixText = new Text(generalGroup, SWT.BORDER);
 		seasonPrefixText.setText(prefs.getSeasonPrefixForDisplay());
 		seasonPrefixText.setTextLimit(99);
 		seasonPrefixText.setLayoutData(new GridData(GridData.FILL, GridData.CENTER, true, true, 2, 1));
@@ -209,11 +205,40 @@ public void widgetSelected(SelectionEvent e) {
 				toggleEnableControls(moveEnabledCheckbox, destDirText, destDirButton, seasonPrefixText);
 			}
 		});
+
+		Label ignoreLabel = new Label(generalGroup, SWT.NONE);
+		ignoreLabel.setText("Ignore files containing [?]");
+		ignoreLabel.setToolTipText("Provide comma separated list of words that will cause a file to be ignored if they appear in the file's path or name.");
+
+		ignoreWordsText = new Text(generalGroup, SWT.BORDER);
+		java.util.List<String> ignoreList = prefs.getIgnoreKeywords();
+		String ignoreWords = "";
+		for(String s : ignoreList) {
+			ignoreWords += s;
+			ignoreWords += ",";
+		}
+		ignoreWordsText.setText(ignoreWords);
+		ignoreWordsText.setTextLimit(99);
+		ignoreWordsText.setLayoutData(new GridData(GridData.FILL, GridData.CENTER, true, true));
+
+		recurseFoldersCheckbox = new Button(generalGroup, SWT.CHECK);
+		recurseFoldersCheckbox.setText("Recursively add shows in subdirectories");
+		recurseFoldersCheckbox.setLayoutData(new GridData(GridData.BEGINNING, GridData.CENTER, true, true, 3, 1));
+		recurseFoldersCheckbox.setSelection(prefs.isRecursivelyAddFolders());
+
+		checkForUpdatesCheckbox = new Button(generalGroup, SWT.CHECK);
+		checkForUpdatesCheckbox.setText("Check for Updates at startup");
+		checkForUpdatesCheckbox.setLayoutData(new GridData(GridData.BEGINNING, GridData.CENTER, true, true, 3, 1));
+		checkForUpdatesCheckbox.setSelection(prefs.checkForUpdates());
+
+		item.setControl(generalGroup);
 	}
-
-	private void createRenameGroup() {
-		Group replacementGroup = new Group(preferencesShell, SWT.NONE);
-		replacementGroup.setText("Rename Options");
+
+	private void createRenameTab() {
+		TabItem item = new TabItem(tabFolder, SWT.NULL);
+		item.setText("Renaming");
+
+		Composite replacementGroup = new Composite(tabFolder, SWT.NONE);
 		replacementGroup.setLayout(new GridLayout(3, false));
 		replacementGroup.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, true, 3, 1));
 
@@ -249,6 +274,8 @@ private void createRenameGroup() {
 
 		createDragSource(renameTokensList);
 		createDropTarget(replacementStringText);
+
+		item.setControl(replacementGroup);
 	}
 
 	private static void createDragSource(final List sourceList) {
@@ -324,11 +351,13 @@ public void dropAccept(DropTargetEvent event) {
 		});
 	}
 
-	private void createProxyGroup() {
+	private void createProxyTab() {
 		ProxySettings proxy = prefs.getProxy();
 
-		Group proxyGroup = new Group(preferencesShell, SWT.NONE);
-		proxyGroup.setText("Proxy Settings [?]");
+		TabItem item = new TabItem(tabFolder, SWT.NULL);
+		item.setText("Proxy");
+
+		Composite proxyGroup = new Composite(tabFolder, SWT.NONE);
 		proxyGroup.setLayout(new GridLayout(3, false));
 		proxyGroup.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, true, 3, 1));
 		proxyGroup.setToolTipText("If you connect to the internet via a proxy server, enable and set the properties");
@@ -401,35 +430,13 @@ public void widgetSelected(SelectionEvent e) {
 				toggleEnableControls(proxyAuthenticationRequiredCheckbox, proxyUsernameText, proxyPasswordText);
 			}
 		});
-	}
-
-	private void createCheckForUpdatesGroup() {
-		Group checkForUpdateGroup = new Group(preferencesShell, SWT.FILL);
-		checkForUpdateGroup.setText("Check for Updates");
-		checkForUpdateGroup.setLayout(new GridLayout(3, false));
-		checkForUpdateGroup.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, true, 3, 1));
 
-		checkForUpdatesCheckbox = new Button(checkForUpdateGroup, SWT.CHECK);
-		checkForUpdatesCheckbox.setText("Check for Updates at startup");
-		checkForUpdatesCheckbox.setLayoutData(new GridData(GridData.BEGINNING, GridData.CENTER, true, true, 3, 1));
-		checkForUpdatesCheckbox.setSelection(prefs.checkForUpdates());
+		item.setControl(proxyGroup);
 	}
 
-	private void createAddFolderGroup() {
-		Group createAddFolderGroup = new Group( preferencesShell, SWT.FILL);
-		createAddFolderGroup.setText("Adding Folders");
-		createAddFolderGroup.setLayout(new GridLayout(3, false));
-		createAddFolderGroup.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, true, 3, 1));
-
-		recurseFoldersCheckbox = new Button(createAddFolderGroup, SWT.CHECK);
-		recurseFoldersCheckbox.setText("Recursively add shows in subdirectories");
-		recurseFoldersCheckbox.setLayoutData(new GridData(GridData.BEGINNING, GridData.CENTER, true, true, 3, 1));
-		recurseFoldersCheckbox.setSelection(prefs.isRecursivelyAddFolders());
-
-	}
-
 	private void createActionButtonGroup() {
 		Composite bottomButtonsComposite = new Composite(preferencesShell, SWT.FILL);
+		bottomButtonsComposite.setLayoutData(new GridData(SWT.END, SWT.CENTER, true, true, 0, 1));
 		bottomButtonsComposite.setLayout(new GridLayout(2, false));
 		GridData bottomButtonsCompositeGridData = new GridData(SWT.FILL, SWT.CENTER, true, true, 2, 1);
 		bottomButtonsComposite.setLayoutData(bottomButtonsCompositeGridData);
@@ -477,6 +484,7 @@ private void savePreferences() {
 		prefs.setMovedEnabled(moveEnabledCheckbox.getSelection());
 		prefs.setSeasonPrefix(seasonPrefixText.getText());
 		prefs.setRenameReplacementString(replacementStringText.getText());
+		prefs.setIgnoreKeywords(Arrays.asList(ignoreWordsText.getText().split("\\s*,\\s*")));
 
 		ProxySettings proxySettings = new ProxySettings();
 		proxySettings.setEnabled(proxyEnabledCheckbox.getSelection());
@@ -504,7 +512,8 @@ private void savePreferences() {
 	}
 
 	/**
-	 * Toggle whether the or not the listed {@link Control}s are enabled, based off the of the selection value of the checkbox
+	 * Toggle whether the or not the listed {@link Control}s are enabled, based off the of 
+	 * the selection value of the checkbox
 	 * @param decidingCheckbox the checkbox the enable flag is taken off
 	 * @param controls the list of controls to update
 	 */
@@ -514,4 +523,6 @@ private void toggleEnableControls(Button decidingCheckbox, Control... controls)
 		}
 		preferencesShell.redraw();
 	}
+
+
 }

src/main/com/google/code/tvrenamer/view/UIStarter.java

@@ -93,6 +93,7 @@ public class UIStarter {
 	private static Shell shell;
 	private Display display;
 	private static UserPreferences prefs;
+	private static List<String> ignoreKeywords;
 
 	private Button addFilesButton;
 	private Button addFolderButton;
@@ -691,6 +692,9 @@ public void onFile(final File f) {
 	}
 
 	private void addFiles(final List<String> fileNames) {
+		// Update the list of ignored keywords
+		ignoreKeywords = prefs.getIgnoreKeywords();
+
 		for (final String fileName : fileNames) {
 			final FileEpisode episode = TVRenamer.parseFilename(fileName);
 			if (episode == null) {
@@ -861,8 +865,11 @@ private static TableItem createTableItem(Table tblResults, String fileName, File
 		TableItem item = new TableItem(tblResults, SWT.NONE);
 		String newFilename = fileName;
 		try {
+			// Set if the item is checked or not according
+			// to a list of banned keywords
+			item.setChecked(!isNameIgnored(newFilename));
+
 			newFilename = episode.getNewFilename();
-			item.setChecked(true);
 		} catch (NotFoundException e) {
 			newFilename = e.getMessage();
 			item.setChecked(false);
@@ -874,6 +881,15 @@ private static TableItem createTableItem(Table tblResults, String fileName, File
 		return item;
 	}
 
+	private static boolean isNameIgnored(String fileName) {
+		for (int i = 0; i < ignoreKeywords.size(); i++) {
+			if(fileName.toLowerCase().contains(ignoreKeywords.get(i))) {
+				return true;
+			}
+		}
+		return false;
+	}
+
 	private void deleteTableItem (int index) {
 		if( resultsTable.getItems().length > 0 ) {
     		files.remove(resultsTable.getItem(index).getText(CURRENT_FILE_COLUMN));