Ensure "Title Missing" shows for appropriate books (BL-16027)

Author: StephenMcConnel

src/BloomExe/Book/BookInfo.cs

@@ -341,6 +341,8 @@ public string Copyright
         /// </summary>
         public string QuickTitleUserDisplay => FolderName;
 
+        public string ThumbnailLabel;
+
         public bool TryGetPremadeThumbnail(out Image image)
         {
             string path = Path.Combine(FolderPath, "thumbnail.png");

src/BloomExe/Collection/BookCollection.cs

@@ -24,7 +24,11 @@ public enum CollectionType
             SourceCollection,
         }
 
-        public delegate BookCollection Factory(string path, CollectionType collectionType); //autofac uses this
+        public delegate BookCollection Factory(
+            string path,
+            CollectionType collectionType,
+            CollectionSettings settings = null
+        ); //autofac uses this
 
         public EventHandler CollectionChanged;
 
@@ -37,6 +41,8 @@ public enum CollectionType
         private static HashSet<string> _changingFolders = new HashSet<string>();
         private BloomWebSocketServer _webSocketServer;
 
+        private CollectionSettings _collectionSettings;
+
         public static event EventHandler CollectionCreated;
 
         //for moq only
@@ -53,13 +59,15 @@ public BookCollection(
             CollectionType collectionType,
             BookSelection bookSelection,
             TeamCollectionManager tcm = null,
+            CollectionSettings collectionSettings = null,
             BloomWebSocketServer webSocketServer = null
         )
         {
             _path = path;
             _bookSelection = bookSelection;
             _tcManager = tcm;
             _webSocketServer = webSocketServer;
+            _collectionSettings = collectionSettings;
 
             Type = collectionType;
 
@@ -412,7 +420,45 @@ private void AddBookInfo(string folderPath)
                     )
                         ? _bookSelection.CurrentSelection.BookInfo
                         : new BookInfo(folderPath, editable, sc);
-
+                if (bookInfo.FileNameLocked)
+                {
+                    // The user has explicitly chosen a name to use for the book, distinct from its titles.
+                    bookInfo.ThumbnailLabel = Path.GetFileName(folderPath);
+                }
+                else
+                {
+                    bookInfo.ThumbnailLabel = bookInfo.Title;
+                }
+                if (
+                    bookInfo.IsInEditableCollection
+                    && !bookInfo.FileNameLocked
+                    && String.IsNullOrEmpty(bookInfo.Title)
+                )
+                {
+                    if (
+                        folderPath == _bookSelection.CurrentSelection?.FolderPath
+                        && _bookSelection.CurrentSelection.BookInfo.SaveContext == sc
+                    )
+                    {
+                        bookInfo.ThumbnailLabel = _bookSelection
+                            .CurrentSelection
+                            .TitleBestForUserDisplay;
+                    }
+                    else
+                    {
+                        var htmlPath = BookStorage.FindBookHtmlInFolder(folderPath);
+                        if (!String.IsNullOrEmpty(htmlPath) && RobustFile.Exists(htmlPath))
+                        {
+                            var dom = HtmlDom.CreateFromHtmlFile(htmlPath);
+                            var bookData = new BookData(dom, _collectionSettings, null);
+                            bookInfo.ThumbnailLabel = Book.Book.GetBestTitleForDisplay(
+                                bookData.GetMultiTextVariableOrEmpty("bookTitle"),
+                                bookData.GetBasicBookLanguageCodes().ToList(),
+                                bookInfo.IsInEditableCollection
+                            );
+                        }
+                    }
+                }
                 _bookInfos.Add(bookInfo);
             }
             catch (Exception e)

src/BloomExe/CollectionTab/CollectionModel.cs

@@ -360,7 +360,8 @@ private IEnumerable<BookCollection> GetBookCollectionsOnce()
             {
                 editableCollection = _bookCollectionFactory(
                     _pathToCollection,
-                    BookCollection.CollectionType.TheOneEditableCollection
+                    BookCollection.CollectionType.TheOneEditableCollection,
+                    _collectionSettings
                 );
                 if (_bookCollectionHolder != null)
                     _bookCollectionHolder.TheOneEditableCollection = editableCollection;

src/BloomExe/CollectionTab/CollectionTabView.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.Drawing;
 using System.IO;
@@ -13,6 +14,7 @@
 using Bloom.web;
 using Bloom.Workspace;
 using L10NSharp;
+using Newtonsoft.Json;
 using SIL.Reporting;
 
 namespace Bloom.CollectionTab
@@ -132,8 +134,36 @@ public BookInfo GetBookInfoByFolderPath(string path)
 
         private void UpdateForBookChanges(Book.Book book)
         {
+            if (book.BookData.GetVariableOrNull("bookTitle", book.Language1Tag) == null)
+            {
+                book.BookInfo.Title = "";
+                if (book.BookInfo.AllTitles != null)
+                {
+                    var titleDict = JsonConvert.DeserializeObject<Dictionary<string, string>>(
+                        book.BookInfo.AllTitles
+                    );
+                    if (titleDict.ContainsKey(book.Language1Tag))
+                    {
+                        titleDict.Remove(book.Language1Tag);
+                        book.BookInfo.AllTitles = JsonConvert.SerializeObject(titleDict);
+                    }
+                }
+                book.BookInfo.ThumbnailLabel = book.TitleBestForUserDisplay;
+                book.BookInfo.Save();
+            }
             _model.UpdateThumbnailAsync(book);
-            _model.UpdateLabelOfBookInEditableCollection(book);
+            // Delay the label update slightly to give the collection book pane
+            // time to settle down and be ready for it.  Do it a few times to
+            // make sure it gets through.
+            _ = Task.Run(async () =>
+            {
+                await Task.Delay(200);
+                _model.UpdateLabelOfBookInEditableCollection(book);
+                await Task.Delay(300);
+                _model.UpdateLabelOfBookInEditableCollection(book);
+                await Task.Delay(400);
+                _model.UpdateLabelOfBookInEditableCollection(book);
+            });
             // This message causes the preview to update.
             _webSocketServer.SendEvent("bookContent", "reload");
             _bookChangesPending = false;

src/BloomExe/web/controllers/CollectionApi.cs

@@ -618,6 +618,13 @@ public void HandleBooksRequest(ApiRequest request)
                             ignoreFolderName: true
                         );
                     }
+                    else if (
+                        String.IsNullOrEmpty(info.Title)
+                        && !String.IsNullOrEmpty(info.ThumbnailLabel)
+                    )
+                    {
+                        title = info.ThumbnailLabel;
+                    }
                     return new
                     {
                         id = info.Id,

src/BloomTests/TestDoubles/CollectionTab/FakeCollectionModel.cs

@@ -55,7 +55,8 @@ protected static SourceCollectionsList GetDefaultSourceCollectionsList()
 
         public static BookCollection BookCollectionFactory(
             string path,
-            BookCollection.CollectionType collectionType
+            BookCollection.CollectionType collectionType,
+            CollectionSettings settings = null
         )
         {
             return new BookCollection(path, collectionType, null);