greenshot/GreenshotPlugin/Controls/SaveImageFileDialog.cs

/*
 * Greenshot - a free and open source screenshot tool
 * Copyright (C) 2007-2020 Thomas Braun, Jens Klingen, Robin Krom
 * 
 * For more information see: http://getgreenshot.org/
 * The Greenshot project is hosted on GitHub https://github.com/greenshot/greenshot
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 1 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
using System;
using System.IO;
using System.Windows.Forms;
using GreenshotPlugin.Core;
using GreenshotPlugin.IniFile;
using GreenshotPlugin.Interfaces;
using log4net;

namespace GreenshotPlugin.Controls {
	/// <summary>
	/// Custom dialog for saving images, wraps SaveFileDialog.
	/// For some reason SFD is sealed :(
	/// </summary>
	public class SaveImageFileDialog : IDisposable {
		private static readonly ILog LOG = LogManager.GetLogger(typeof(SaveImageFileDialog));
		private static readonly CoreConfiguration conf = IniConfig.GetIniSection<CoreConfiguration>();
		protected SaveFileDialog SaveFileDialog;
		private FilterOption[] _filterOptions;
		private DirectoryInfo _eagerlyCreatedDirectory;
		private readonly ICaptureDetails _captureDetails;

		public void Dispose() {
			Dispose(true);
			GC.SuppressFinalize(this);
		}

		protected virtual void Dispose(bool disposing) {
			if (disposing) {
				if (SaveFileDialog != null) {
					SaveFileDialog.Dispose();
					SaveFileDialog = null;
				}
			}
		}

		public SaveImageFileDialog() {
			Init();
		}

		public SaveImageFileDialog(ICaptureDetails captureDetails) {
			_captureDetails = captureDetails;
			Init();
		}

		private void Init() {
			SaveFileDialog = new SaveFileDialog();
			ApplyFilterOptions();
			string initialDirectory = null;
			try {
				conf.ValidateAndCorrectOutputFileAsFullpath();
				initialDirectory = Path.GetDirectoryName(conf.OutputFileAsFullpath);
			} catch {
				LOG.WarnFormat("OutputFileAsFullpath was set to {0}, ignoring due to problem in path.", conf.OutputFileAsFullpath);
			}
			
			if (!string.IsNullOrEmpty(initialDirectory) && Directory.Exists(initialDirectory)) {
				SaveFileDialog.InitialDirectory = initialDirectory;
			} else if (Directory.Exists(conf.OutputFilePath)) {
				SaveFileDialog.InitialDirectory = conf.OutputFilePath;
			}
			// The following property fixes a problem that the directory where we save is locked (bug #2899790)
			SaveFileDialog.RestoreDirectory = true;
			SaveFileDialog.OverwritePrompt = true;
			SaveFileDialog.CheckPathExists = false;
			SaveFileDialog.AddExtension = true;
			ApplySuggestedValues();
		}

		private void ApplyFilterOptions() {
			PrepareFilterOptions();
			string fdf = string.Empty;
			int preselect = 0;
			var outputFileFormatAsString = Enum.GetName(typeof(OutputFormat), conf.OutputFileFormat);
			for(int i=0; i<_filterOptions.Length; i++){
				FilterOption fo = _filterOptions[i];
				fdf +=  fo.Label + "|*." + fo.Extension + "|";
				if(outputFileFormatAsString == fo.Extension)
					preselect = i;
			}
			fdf = fdf.Substring(0, fdf.Length-1);
			SaveFileDialog.Filter = fdf;
			SaveFileDialog.FilterIndex = preselect + 1;
		}
		
		private void PrepareFilterOptions() {
			OutputFormat[] supportedImageFormats = (OutputFormat[])Enum.GetValues(typeof(OutputFormat));
			_filterOptions = new FilterOption[supportedImageFormats.Length];
			for(int i=0; i<_filterOptions.Length; i++){
				string ifo = supportedImageFormats[i].ToString();
				if (ifo.ToLower().Equals("jpeg")) ifo = "Jpg"; // we dont want no jpeg files, so let the dialog check for jpg
				FilterOption fo = new FilterOption
				{
					Label = ifo.ToUpper(),
					Extension = ifo.ToLower()
				};
				_filterOptions.SetValue(fo, i);
			}
		}
		
		/// <summary>
		/// filename exactly as typed in the filename field
		/// </summary>
		public string FileName {
			get {return SaveFileDialog.FileName;}
			set {SaveFileDialog.FileName = value;}
		}
		
		/// <summary>
		/// initial directory of the dialog
		/// </summary>
		public string InitialDirectory {
			get {return SaveFileDialog.InitialDirectory;}
			set {SaveFileDialog.InitialDirectory = value;}
		}
		
		/// <summary>
		/// returns filename as typed in the filename field with extension.
		/// if filename field value ends with selected extension, the value is just returned.
		/// otherwise, the selected extension is appended to the filename.
		/// </summary>
		public string FileNameWithExtension {
			get {
				string fn = SaveFileDialog.FileName;
				// if the filename contains a valid extension, which is the same like the selected filter item's extension, the filename is okay
				if(fn.EndsWith(Extension,StringComparison.CurrentCultureIgnoreCase)) return fn;
				// otherwise we just add the selected filter item's extension
				else return fn + "." + Extension;
			}
			set {
				FileName = Path.GetFileNameWithoutExtension(value);
				Extension = Path.GetExtension(value);
			}
		}
		
		/// <summary>
		/// gets or sets selected extension
		/// </summary>
		public string Extension {
			get {
				return _filterOptions[SaveFileDialog.FilterIndex-1].Extension;
			}
			set {
				for(int i=0; i<_filterOptions.Length; i++) {
					if(value.Equals(_filterOptions[i].Extension, StringComparison.CurrentCultureIgnoreCase)) {
						SaveFileDialog.FilterIndex = i + 1;
					}
				}
			}
		}
		
		public DialogResult ShowDialog() {
			DialogResult ret = SaveFileDialog.ShowDialog();
			CleanUp();
			return ret;
		}
		
		/// <summary>
		/// sets InitialDirectory and FileName property of a SaveFileDialog smartly, considering default pattern and last used path
		/// </summary>
		private void ApplySuggestedValues() {
			// build the full path and set dialog properties
			FileName = FilenameHelper.GetFilenameWithoutExtensionFromPattern(conf.OutputFileFilenamePattern, _captureDetails);
		}

		private class FilterOption {
			public string Label;
			public string Extension;
		}
		
		private void CleanUp() {
			// fix for bug #3379053
			try {
				if(_eagerlyCreatedDirectory != null && _eagerlyCreatedDirectory.GetFiles().Length == 0  && _eagerlyCreatedDirectory.GetDirectories().Length == 0) {
					_eagerlyCreatedDirectory.Delete();
					_eagerlyCreatedDirectory = null;
				}
			} catch (Exception e) {
				LOG.WarnFormat("Couldn't cleanup directory due to: {0}", e.Message);
				_eagerlyCreatedDirectory = null;
			}
		}
	}
}