Move source code into "Source" folder

Source/LibationWinForms/grid/GridEntry.cs

@@ -0,0 +1,310 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Drawing;
+using System.Linq;
+using ApplicationServices;
+using DataLayer;
+using Dinah.Core.DataBinding;
+using Dinah.Core;
+using Dinah.Core.Drawing;
+using LibationFileManager;
+using System.Threading.Tasks;
+
+namespace LibationWinForms
+{
+	/// <summary>
+	/// The View Model for a LibraryBook
+	/// </summary>
+	internal class GridEntry : AsyncNotifyPropertyChanged, IMemberComparable
+	{
+		#region implementation properties NOT exposed to the view
+		// hide from public fields from Data Source GUI with [Browsable(false)]
+
+		[Browsable(false)]
+		public string AudibleProductId => Book.AudibleProductId;
+		[Browsable(false)]
+		public LibraryBook LibraryBook { get; private set; }
+		#endregion
+
+		#region Model properties exposed to the view
+		private Image _cover;
+		public Image Cover
+		{
+			get => _cover;
+			private set
+			{
+				_cover = value;
+				NotifyPropertyChanged();
+			}
+		}
+
+		public bool DownloadInProgress { get; private set; }
+		public string ProductRating { get; private set; }
+		public string PurchaseDate { get; private set; }
+		public string MyRating { get; private set; }
+		public string Series { get; private set; }
+		public string Title { get; private set; }
+		public string Length { get; private set; }
+		public string Authors { get; private set; }
+		public string Narrators { get; private set; }
+		public string Category { get; private set; }
+		public string Misc { get; private set; }
+		public string Description { get; private set; }
+		public string DisplayTags
+		{
+			get => string.Join("\r\n", Book.UserDefinedItem.TagsEnumerated);
+			set => Book.UserDefinedItem.Tags = value;
+		}
+
+		// these 2 values being in 1 field is the trick behind getting the liberated+pdf 'stoplight' icon to draw. See: LiberateDataGridViewImageButtonCell.Paint
+		public (LiberatedStatus BookStatus, LiberatedStatus? PdfStatus) Liberate
+		{
+			get => (LibraryCommands.Liberated_Status(LibraryBook.Book), LibraryCommands.Pdf_Status(LibraryBook.Book));
+			
+			set
+			{
+				LibraryBook.Book.UserDefinedItem.BookStatus = value.BookStatus;
+				LibraryBook.Book.UserDefinedItem.PdfStatus = value.PdfStatus;
+			}
+		}
+		#endregion
+
+		public event EventHandler<string> LibraryBookUpdated;
+		public event EventHandler Committed;
+
+		// alias
+		private Book Book => LibraryBook.Book;
+
+		public GridEntry(LibraryBook libraryBook) => setLibraryBook(libraryBook);
+
+		public async Task DownloadBook()
+		{
+			if (!DownloadInProgress)
+			{
+				try
+				{
+					DownloadInProgress = true;
+					await BookLiberation.ProcessorAutomationController.BackupSingleBookAsync(LibraryBook);
+				}
+				finally
+				{
+					DownloadInProgress = false;
+				}
+			}
+		}
+
+		public void UpdateLibraryBook(LibraryBook libraryBook)
+		{
+			if (AudibleProductId != libraryBook.Book.AudibleProductId)
+				throw new Exception("Invalid grid entry update. IDs must match");
+
+			setLibraryBook(libraryBook);
+		}
+
+		private void setLibraryBook(LibraryBook libraryBook)
+		{
+			LibraryBook = libraryBook;
+			_memberValues = CreateMemberValueDictionary();
+
+			// Get cover art. If it's default, subscribe to PictureCached
+			{
+				(bool isDefault, byte[] picture) = PictureStorage.GetPicture(new PictureDefinition(Book.PictureId, PictureSize._80x80));
+
+				if (isDefault)
+					PictureStorage.PictureCached += PictureStorage_PictureCached;
+
+				// Mutable property. Set the field so PropertyChanged isn't fired.
+				_cover = ImageReader.ToImage(picture);
+			}
+
+			// Immutable properties
+			{
+				Title = Book.Title;
+				Series = Book.SeriesNames;
+				Length = Book.LengthInMinutes == 0 ? "" : $"{Book.LengthInMinutes / 60} hr {Book.LengthInMinutes % 60} min";
+				MyRating = Book.UserDefinedItem.Rating?.ToStarString()?.DefaultIfNullOrWhiteSpace("");
+				PurchaseDate = libraryBook.DateAdded.ToString("d");
+				ProductRating = Book.Rating?.ToStarString()?.DefaultIfNullOrWhiteSpace("");
+				Authors = Book.AuthorNames;
+				Narrators = Book.NarratorNames;
+				Category = string.Join(" > ", Book.CategoriesNames);
+				Misc = GetMiscDisplay(libraryBook);
+				Description = GetDescriptionDisplay(Book);
+			}
+
+			UserDefinedItem.ItemChanged += UserDefinedItem_ItemChanged;
+
+			// this will never have a value when triggered by ctor b/c nothing can subscribe to the event until after ctor is complete
+			LibraryBookUpdated?.Invoke(this, AudibleProductId);
+		}
+
+		private void PictureStorage_PictureCached(object sender, PictureCachedEventArgs e)
+		{
+			if (e.Definition.PictureId == Book.PictureId)
+			{
+				Cover = ImageReader.ToImage(e.Picture);
+				PictureStorage.PictureCached -= PictureStorage_PictureCached;
+			}
+		}
+
+		#region detect changes to the model, update the view, and save to database.
+
+		/// <summary>
+		/// This event handler receives notifications from the model that it has changed.
+		/// Save to the database and notify the view that it's changed.
+		/// </summary>
+		private void UserDefinedItem_ItemChanged(object sender, string itemName)
+		{
+			var udi = sender as UserDefinedItem;
+
+			if (udi.Book.AudibleProductId != Book.AudibleProductId)
+				return;
+
+			switch (itemName)
+			{
+				case nameof(udi.Tags):
+					Book.UserDefinedItem.Tags = udi.Tags;
+					NotifyPropertyChanged(nameof(DisplayTags));
+					break;
+				case nameof(udi.BookStatus):
+					Book.UserDefinedItem.BookStatus = udi.BookStatus;
+					NotifyPropertyChanged(nameof(Liberate));
+					break;
+				case nameof(udi.PdfStatus):
+					Book.UserDefinedItem.PdfStatus = udi.PdfStatus;
+					NotifyPropertyChanged(nameof(Liberate));
+					break;
+			}
+
+			if (!suspendCommit)
+				Commit();
+		}
+		private bool suspendCommit = false;
+
+		/// <summary>
+		/// Begin editing the model, suspending commits until <see cref="EndEdit"/> is called.
+		/// </summary>
+		public void BeginEdit() => suspendCommit = true;
+
+		/// <summary>
+		/// Save all edits to the database.
+		/// </summary>
+		public void EndEdit()
+		{
+			Commit();
+			suspendCommit = false;
+		}
+
+		private void Commit()
+		{
+			// We don't want LiberatedStatus.PartialDownload to be a persistent status.
+			// If display/icon status is PartialDownload then save NotLiberated to db then restore PartialDownload for display
+			var displayStatus = Book.UserDefinedItem.BookStatus;
+			var saveStatus = displayStatus == LiberatedStatus.PartialDownload ? LiberatedStatus.NotLiberated : displayStatus;
+			Book.UserDefinedItem.BookStatus = saveStatus;
+
+			LibraryCommands.UpdateUserDefinedItem(Book);
+
+			Book.UserDefinedItem.BookStatus = displayStatus;
+
+			Committed?.Invoke(this, null);
+		}
+
+		#endregion
+
+		#region Data Sorting
+		// These methods are implementation of Dinah.Core.DataBinding.IMemberComparable
+		// Used by Dinah.Core.DataBinding.SortableBindingList<T> for all sorting
+		public virtual object GetMemberValue(string memberName) => _memberValues[memberName]();
+		public virtual IComparer GetMemberComparer(Type memberType) => _memberTypeComparers[memberType];
+
+		private Dictionary<string, Func<object>> _memberValues { get; set; }
+
+		/// <summary>
+		/// Create getters for all member object values by name
+		/// </summary>
+		private Dictionary<string, Func<object>> CreateMemberValueDictionary() => new()
+		{
+			{ nameof(Title), () => Book.TitleSortable },
+			{ nameof(Series), () => Book.SeriesSortable },
+			{ nameof(Length), () => Book.LengthInMinutes },
+			{ nameof(MyRating), () => Book.UserDefinedItem.Rating.FirstScore },
+			{ nameof(PurchaseDate), () => LibraryBook.DateAdded },
+			{ nameof(ProductRating), () => Book.Rating.FirstScore },
+			{ nameof(Authors), () => Authors },
+			{ nameof(Narrators), () => Narrators },
+			{ nameof(Description), () => Description },
+			{ nameof(Category), () => Category },
+			{ nameof(Misc), () => Misc },
+			{ nameof(DisplayTags), () => DisplayTags },
+			{ nameof(Liberate), () => Liberate.BookStatus }
+		};
+
+		// Instantiate comparers for every exposed member object type.
+		private static readonly Dictionary<Type, IComparer> _memberTypeComparers = new()
+		{
+			{ typeof(string), new ObjectComparer<string>() },
+			{ typeof(int), new ObjectComparer<int>() },
+			{ typeof(float), new ObjectComparer<float>() },
+			{ typeof(DateTime), new ObjectComparer<DateTime>() },
+			{ typeof(LiberatedStatus), new ObjectComparer<LiberatedStatus>() },
+		};
+
+		#endregion
+
+		#region Static library display functions
+		
+		/// <summary>
+		/// This information should not change during <see cref="GridEntry"/> lifetime, so call only once.
+		/// </summary>
+		private static string GetDescriptionDisplay(Book book)
+		{
+			var doc = new HtmlAgilityPack.HtmlDocument();
+			doc.LoadHtml(book?.Description ?? "");
+			var noHtml = doc.DocumentNode.InnerText;
+			return
+				noHtml.Length < 63 ?
+				noHtml :
+				noHtml.Substring(0, 60) + "...";
+		}
+
+		/// <summary>
+		/// This information should not change during <see cref="GridEntry"/> lifetime, so call only once.
+		/// Maximum of 5 text rows will fit in 80-pixel row height.
+		/// </summary>
+		private static string GetMiscDisplay(LibraryBook libraryBook)
+		{
+			var details = new List<string>();
+
+			var locale = libraryBook.Book.Locale.DefaultIfNullOrWhiteSpace("[unknown]");
+			var acct = libraryBook.Account.DefaultIfNullOrWhiteSpace("[unknown]");
+
+			details.Add($"Account: {locale} - {acct}");
+
+			if (libraryBook.Book.HasPdf)
+				details.Add("Has PDF");
+			if (libraryBook.Book.IsAbridged)
+				details.Add("Abridged");
+			if (libraryBook.Book.DatePublished.HasValue)
+				details.Add($"Date pub'd: {libraryBook.Book.DatePublished.Value:MM/dd/yyyy}");
+			// this goes last since it's most likely to have a line-break
+			if (!string.IsNullOrWhiteSpace(libraryBook.Book.Publisher))
+				details.Add($"Pub: {libraryBook.Book.Publisher.Trim()}");
+
+			if (!details.Any())
+				return "[details not imported]";
+
+			return string.Join("\r\n", details);
+		}
+
+		#endregion
+
+		~GridEntry()
+		{
+			UserDefinedItem.ItemChanged -= UserDefinedItem_ItemChanged;
+			PictureStorage.PictureCached -= PictureStorage_PictureCached;
+		}
+	}
+}