From debbc3fbda7e795068898c0ee6527a5b59f69e60 Mon Sep 17 00:00:00 2001
From: Matt Lyons <matt_lyons@sil.org>
Date: Thu, 7 Nov 2024 14:23:10 -0600
Subject: [PATCH] Prepare the resource viewer to be able to open resource
 projects (#1271)

---
 c-sharp/ParanextDataProvider.csproj           |  11 +-
 c-sharp/ParatextUtils/ParatextGlobals.cs      |   3 +
 .../PlatformScrTextCollection.cs              |  66 +++++++++
 .../DblResourcePasswordProvider.cs            |  39 ++++++
 c-sharp/Projects/LocalParatextProjects.cs     |  11 +-
 .../Projects/ParatextProjectDataProvider.cs   |   7 +
 c-sharp/Users/ParatextRegistrationService.cs  |  11 ++
 .../Users/RegistrationRequiredException.cs    |  22 +++
 cspell.json                                   |   7 +-
 .../contributions/localizedStrings.json       |   1 +
 .../src/types/paratext-registration.d.ts      |   6 +
 package-lock.json                             | 127 +++++++++---------
 12 files changed, 238 insertions(+), 73 deletions(-)
 create mode 100644 c-sharp/ParatextUtils/PlatformScrTextCollection.cs
 create mode 100644 c-sharp/Projects/DigitalBibleLibrary/DblResourcePasswordProvider.cs
 create mode 100644 c-sharp/Users/RegistrationRequiredException.cs

diff --git a/c-sharp/ParanextDataProvider.csproj b/c-sharp/ParanextDataProvider.csproj
index 117f4a4510..b18087bf86 100644
--- a/c-sharp/ParanextDataProvider.csproj
+++ b/c-sharp/ParanextDataProvider.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
@@ -19,6 +19,7 @@
     <PackageProjectUrl>https://github.com/paranext</PackageProjectUrl>
     <RepositoryUrl>https://github.com/paranext/paranext-core</RepositoryUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <UserSecretsId>1860f020-31dd-4eb4-81c4-323eb0cb3e48</UserSecretsId>
     <!-- Uncomment the following lines to help with debugging into .NET core
     <DebugType>portable</DebugType>
     <EmbedUntrackedSources>true</EmbedUntrackedSources>
@@ -27,16 +28,18 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="ParatextData" Version="9.5.0.6" />
+    <PackageReference Include="icu.net" Version="2.10.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration" Version="8.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" Version="8.0.1" />
+    <PackageReference Include="Microsoft.ICU.ICU4C.Runtime" Version="72.1.0.1" Condition="$([MSBuild]::IsOsPlatform('Windows'))" />
     <PackageReference Include="ParatextChecks" Version="9.5.0.6" />
+    <PackageReference Include="ParatextData" Version="9.5.0.6" />
     <PackageReference Include="SIL.Core" Version="14.2.0-beta0009" />
     <PackageReference Include="SIL.Scripture" Version="14.2.0-beta0009" />
     <PackageReference Include="SIL.WritingSystems" Version="14.2.0-beta0009" />
     <PackageReference Include="StreamJsonRpc" Version="2.19.27" />
     <PackageReference Include="System.Net.WebSockets" Version="4.3.0" />
     <PackageReference Include="System.Text.Encoding.CodePages" Version="8.0.0" />
-    <PackageReference Include="icu.net" Version="2.10.0" />
-    <PackageReference Include="Microsoft.ICU.ICU4C.Runtime" Version="72.1.0.1" Condition="$([MSBuild]::IsOsPlatform('Windows'))" />
   </ItemGroup>
 
   <!--
diff --git a/c-sharp/ParatextUtils/ParatextGlobals.cs b/c-sharp/ParatextUtils/ParatextGlobals.cs
index 030e25f01b..92609d3bb7 100644
--- a/c-sharp/ParatextUtils/ParatextGlobals.cs
+++ b/c-sharp/ParatextUtils/ParatextGlobals.cs
@@ -24,6 +24,9 @@ public static void Initialize(string dataFolderPath)
                 if (s_initialized)
                     return;
 
+                // Override a few key functions for ScrTextCollection static methods to work
+                ScrTextCollection.Implementation = new PlatformScrTextCollection();
+
                 // Required for the Paratext.Data.Encodings.StringEncoders static constructor
                 Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
 
diff --git a/c-sharp/ParatextUtils/PlatformScrTextCollection.cs b/c-sharp/ParatextUtils/PlatformScrTextCollection.cs
new file mode 100644
index 0000000000..486ea22dd5
--- /dev/null
+++ b/c-sharp/ParatextUtils/PlatformScrTextCollection.cs
@@ -0,0 +1,66 @@
+using Paranext.DataProvider.Projects.DigitalBibleLibrary;
+using Paratext.Data;
+using Paratext.Data.Users;
+using SIL.WritingSystems;
+
+namespace Paranext.DataProvider.ParatextUtils;
+
+/// <summary>
+/// Adapted from ParatextScrTextCollection
+/// </summary>
+public class PlatformScrTextCollection : ScrTextCollection
+{
+    // keep track of languages that weren't found in SLDR so we don't call over and over for the same bad code
+    private static readonly HashSet<string> s_sldrLookupFailed = [];
+
+    protected override ScrText CreateResourceProject(ProjectName name)
+    {
+        return new ResourceScrText(
+            name,
+            RegistrationInfo.DefaultUser,
+            new DblResourcePasswordProvider()
+        );
+    }
+
+    protected override ScrText CreateXmlResourceProject(ProjectName name)
+    {
+        return new XmlResourceScrText(
+            name,
+            RegistrationInfo.DefaultUser,
+            new DblResourcePasswordProvider()
+        );
+    }
+
+    protected override UnsupportedReason MigrateProjectIfNeeded(ScrText scrText)
+    {
+        return scrText.NeedsMigration
+            ? UnsupportedReason.CannotUpgrade
+            : UnsupportedReason.Supported;
+    }
+
+    protected override WritingSystemDefinition CreateWsDef(string languageId, bool allowSldr)
+    {
+        // only check SLDR if allowed for this call and all internet access is enabled - SLDR isn't set up to use proxy
+        WritingSystemDefinition? wsDef = null;
+        if (
+            allowSldr
+            && InternetAccess.Status == InternetUse.Enabled
+            && !s_sldrLookupFailed.Contains(languageId)
+        )
+        {
+            try
+            {
+                var sldrFactory = new SldrWritingSystemFactory();
+                sldrFactory.Create(languageId, out wsDef);
+            }
+            catch (Exception e)
+            {
+                // ignore any SLDR errors - there have been problems with entries on the server failing to parse.
+                // also the id being provided may not be valid
+                Console.WriteLine("Getting {0} from SLDR failed: {1}", languageId, e);
+                s_sldrLookupFailed.Add(languageId);
+            }
+        }
+        return wsDef!;
+    }
+}
diff --git a/c-sharp/Projects/DigitalBibleLibrary/DblResourcePasswordProvider.cs b/c-sharp/Projects/DigitalBibleLibrary/DblResourcePasswordProvider.cs
new file mode 100644
index 0000000000..c5844e00e6
--- /dev/null
+++ b/c-sharp/Projects/DigitalBibleLibrary/DblResourcePasswordProvider.cs
@@ -0,0 +1,39 @@
+using Microsoft.Extensions.Configuration;
+using Paranext.DataProvider.Users;
+using Paratext.Data.ProjectFileAccess;
+using Paratext.Data.Users;
+using PtxUtils;
+
+namespace Paranext.DataProvider.Projects.DigitalBibleLibrary;
+
+/// <summary>
+/// Adapted from ParatextZippedResourcePasswordProvider
+/// </summary>
+internal class DblResourcePasswordProvider : IZippedResourcePasswordProvider
+{
+    private string? _cachedValue;
+
+    public string GetPassword()
+    {
+        if (!RegistrationInfo.DefaultUser.IsValid)
+        {
+            // Throwing an exception here is invisible to users because ParatextData swallows it
+            // Log the message instead in case it is helpful for someone troubleshooting
+            Console.WriteLine(RegistrationRequiredException.ExceptionMessage);
+            return "This is not the correct password";
+        }
+
+        IConfigurationRoot config = new ConfigurationBuilder()
+            .AddUserSecrets<DblResourcePasswordProvider>()
+            .Build();
+
+        // Run the following from the command line to set a config value (quotes are important):
+        //     dotnet user-secrets set "<secret name>" "<secret value>"
+        // DO NOT share the secret values, including checking in code, texts, emails, DMs, etc.
+        _cachedValue ??= StringUtils.DecryptStringFromBase64(
+            config["DblResourceBase64-DO-NOT-SHARE"] ?? "",
+            config["DblResourceHash-DO-NOT-SHARE"] ?? ""
+        );
+        return _cachedValue;
+    }
+}
diff --git a/c-sharp/Projects/LocalParatextProjects.cs b/c-sharp/Projects/LocalParatextProjects.cs
index 90dedb841e..a1e326999f 100644
--- a/c-sharp/Projects/LocalParatextProjects.cs
+++ b/c-sharp/Projects/LocalParatextProjects.cs
@@ -1,5 +1,6 @@
 using System.Xml;
 using Paranext.DataProvider.ParatextUtils;
+using Paranext.DataProvider.Users;
 using Paratext.Data;
 using Paratext.Data.Users;
 
@@ -116,7 +117,10 @@ public virtual void Initialize(bool shouldIncludePT9ProjectsOnWindows)
 
     public IEnumerable<ProjectDetails> GetAllProjectDetails()
     {
-        return GetScrTexts().Select(scrText => scrText.GetProjectDetails());
+        var allScrTexts = GetScrTexts();
+        if (!RegistrationInfo.DefaultUser.IsValid)
+            allScrTexts = allScrTexts.Where((scrText) => !scrText.IsResourceProject);
+        return allScrTexts.Select(scrText => scrText.GetProjectDetails());
     }
 
     public ProjectDetails GetProjectDetails(string projectId)
@@ -126,7 +130,10 @@ public ProjectDetails GetProjectDetails(string projectId)
 
     public static ScrText GetParatextProject(string projectId)
     {
-        return ScrTextCollection.GetById(HexId.FromStr(projectId));
+        var retVal = ScrTextCollection.GetById(HexId.FromStr(projectId));
+        if (retVal.IsResourceProject && !RegistrationInfo.DefaultUser.IsValid)
+            throw new RegistrationRequiredException();
+        return retVal;
     }
 
     public static List<string> GetParatextProjectInterfaces()
diff --git a/c-sharp/Projects/ParatextProjectDataProvider.cs b/c-sharp/Projects/ParatextProjectDataProvider.cs
index 3369d092ab..f72364995c 100644
--- a/c-sharp/Projects/ParatextProjectDataProvider.cs
+++ b/c-sharp/Projects/ParatextProjectDataProvider.cs
@@ -292,6 +292,11 @@ private void RegisterSettingsValidators()
         if (paratextSettingName == ProjectSettingsNames.PT_NAME)
             return scrText.Name;
 
+        // Some resource projects are marked as editable in their settings, but we want to treat
+        // them as read-only projects
+        if (scrText.IsResourceProject && paratextSettingName == ProjectSettingsNames.PT_IS_EDITABLE)
+            return false;
+
         if (
             scrText.Settings.ParametersDictionary.TryGetValue(
                 paratextSettingName,
@@ -324,6 +329,8 @@ out string? settingValue
     public bool SetProjectSetting(string settingName, object? value)
     {
         var scrText = LocalParatextProjects.GetParatextProject(ProjectDetails.Metadata.Id);
+        if (scrText.IsResourceProject)
+            throw new Exception("Cannot change settings on resources");
 
         // If there is no Paratext setting for the name given, we'll create one lower down
         object? currentValue = null;
diff --git a/c-sharp/Users/ParatextRegistrationService.cs b/c-sharp/Users/ParatextRegistrationService.cs
index 67df242123..9b7fa0bb28 100644
--- a/c-sharp/Users/ParatextRegistrationService.cs
+++ b/c-sharp/Users/ParatextRegistrationService.cs
@@ -41,6 +41,17 @@ await PapiClient.RegisterRequestHandlerAsync(
             "command:paratextRegistration.setParatextRegistrationData",
             SetParatextRegistrationData
         );
+        await PapiClient.RegisterRequestHandlerAsync(
+            "command:paratextRegistration.doesUserHaveValidRegistration",
+            () => RegistrationInfo.DefaultUser.IsValid
+        );
+
+        // Lookup localized strings where they may be needed by callers without access to PapiClient
+        RegistrationRequiredException.ExceptionMessage = LocalizationService.GetLocalizedString(
+            PapiClient,
+            "%paratextRegistration_exception_register_before_accessing_dbl_resources%",
+            RegistrationRequiredException.ExceptionMessage
+        );
     }
 
     #endregion
diff --git a/c-sharp/Users/RegistrationRequiredException.cs b/c-sharp/Users/RegistrationRequiredException.cs
new file mode 100644
index 0000000000..679257f572
--- /dev/null
+++ b/c-sharp/Users/RegistrationRequiredException.cs
@@ -0,0 +1,22 @@
+namespace Paranext.DataProvider.Users;
+
+/// <summary>
+/// Exception to inform callers that a valid Paratext registration is required before DBL resources can be opened
+/// </summary>
+public class RegistrationRequiredException : Exception
+{
+    /// <summary>
+    /// Exception to inform callers that a valid Paratext registration is required before DBL resources can be opened
+    /// </summary>
+    public RegistrationRequiredException()
+        : base(ExceptionMessage) { }
+
+    /// <summary>
+    /// Exception to inform callers that a valid Paratext registration is required before DBL resources can be opened
+    /// </summary>
+    public RegistrationRequiredException(string? customMessage = null)
+        : base(customMessage ?? ExceptionMessage) { }
+
+    public static string ExceptionMessage { get; set; } =
+        "You must provide a valid Paratext registration before opening resources from the Digital Bible Library.";
+}
diff --git a/cspell.json b/cspell.json
index 37e57fde77..02641c07ed 100644
--- a/cspell.json
+++ b/cspell.json
@@ -33,7 +33,7 @@
     "appdata",
     "asyncs",
     "autodocs",
-    "BBBCCCVVV",
+    "bbbcccvvv",
     "biblionexus",
     "camelcase",
     "consts",
@@ -51,7 +51,7 @@
     "iusfm",
     "iusj",
     "iusx",
-    "JSONRPCID",
+    "jsonrpcid",
     "localizable",
     "localstorage",
     "maximizable",
@@ -74,6 +74,7 @@
     "reserialized",
     "shadcn",
     "sillsdev",
+    "sldr",
     "sonner",
     "steenwyk",
     "stringifiable",
@@ -94,7 +95,7 @@
     "verseref",
     "versification",
     "vref",
-    "VSTHRD"
+    "vsthrd"
   ],
   "ignoreWords": [],
   "import": []
diff --git a/extensions/src/paratext-registration/contributions/localizedStrings.json b/extensions/src/paratext-registration/contributions/localizedStrings.json
index abc35d9967..2d860f513f 100644
--- a/extensions/src/paratext-registration/contributions/localizedStrings.json
+++ b/extensions/src/paratext-registration/contributions/localizedStrings.json
@@ -21,6 +21,7 @@
       "%paratextRegistration_warning_invalid_registration%": "This registration code is not correct for this user.",
       "%paratextRegistration_webView_title%": "Paratext Registration Information",
       "%paratextRegistration_webView_tooltip%": "Enter your Paratext Registration Information into this form.",
+      "%paratextRegistration_exception_register_before_accessing_dbl_resources%": "You must provide a valid Paratext registration before opening resources from the Digital Bible Library.",
       "%settings_paratextRegistration_registration_internet_group_label%": "Paratext Registration and Internet Settings",
       "%settings_paratextRegistration_registration_internet_group_description%": "Settings related to the user's Paratext Registry connection and some internet access controls",
       "%settings_paratextRegistration_shouldShowOnStartup_label%": "Show Paratext Registration Web View on Startup",
diff --git a/extensions/src/paratext-registration/src/types/paratext-registration.d.ts b/extensions/src/paratext-registration/src/types/paratext-registration.d.ts
index 00eb9f013f..eb81053e56 100644
--- a/extensions/src/paratext-registration/src/types/paratext-registration.d.ts
+++ b/extensions/src/paratext-registration/src/types/paratext-registration.d.ts
@@ -45,6 +45,12 @@ declare module 'papi-shared-types' {
     'paratextRegistration.setParatextRegistrationData': (
       newRegistrationData: RegistrationData,
     ) => Promise<void>;
+    /**
+     * Gets the validity status of the user's Paratext registration
+     *
+     * @returns True if the user has a valid Paratext registration, false otherwise
+     */
+    'command:paratextRegistration.doesUserHaveValidRegistration': () => Promise<boolean>;
   }
 
   export interface SettingTypes {
diff --git a/package-lock.json b/package-lock.json
index 37abf346af..d9f5c11219 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -612,7 +612,6 @@
       }
     },
     "extensions/src/paratext-registration": {
-      "name": "paranext-extension-template",
       "version": "0.0.1",
       "license": "MIT",
       "dependencies": {
@@ -25173,14 +25172,14 @@
         "tslib": "^2.0.3"
       }
     },
-    "node_modules/paranext-extension-template": {
-      "resolved": "extensions/src/paratext-registration",
-      "link": true
-    },
     "node_modules/paranext-extensions": {
       "resolved": "extensions",
       "link": true
     },
+    "node_modules/paratext-registration": {
+      "resolved": "extensions/src/paratext-registration",
+      "link": true
+    },
     "node_modules/parent-module": {
       "version": "1.0.1",
       "license": "MIT",
@@ -48962,65 +48961,6 @@
         "tslib": "^2.0.3"
       }
     },
-    "paranext-extension-template": {
-      "version": "file:extensions/src/paratext-registration",
-      "requires": {
-        "@sillsdev/scripture": "^2.0.2",
-        "@swc/core": "^1.7.35",
-        "@tailwindcss/typography": "^0.5.15",
-        "@types/node": "^20.16.11",
-        "@types/react": "^18.3.11",
-        "@types/react-dom": "^18.3.1",
-        "@types/webpack": "^5.28.5",
-        "@typescript-eslint/eslint-plugin": "^6.21.0",
-        "@typescript-eslint/parser": "^6.21.0",
-        "autoprefixer": "^10.4.20",
-        "concurrently": "^9.0.1",
-        "copy-webpack-plugin": "^12.0.2",
-        "cross-env": "^7.0.3",
-        "css-loader": "^6.11.0",
-        "escape-string-regexp": "^5.0.0",
-        "eslint": "^8.57.1",
-        "eslint-config-airbnb-base": "^15.0.0",
-        "eslint-config-erb": "^4.1.0",
-        "eslint-import-resolver-typescript": "^3.6.3",
-        "eslint-plugin-compat": "^4.2.0",
-        "eslint-plugin-import": "^2.31.0",
-        "eslint-plugin-jest": "^27.9.0",
-        "eslint-plugin-jsx-a11y": "^6.10.0",
-        "eslint-plugin-no-null": "^1.0.2",
-        "eslint-plugin-no-type-assertion": "^1.3.0",
-        "eslint-plugin-promise": "^6.6.0",
-        "eslint-plugin-react": "^7.37.1",
-        "eslint-plugin-react-hooks": "^4.6.2",
-        "glob": "^10.4.5",
-        "lucide-react": "^0.452.0",
-        "papi-dts": "file:../../../lib/papi-dts",
-        "platform-bible-react": "file:../../../lib/platform-bible-react",
-        "platform-bible-utils": "file:../../../lib/platform-bible-utils",
-        "postcss": "^8.4.47",
-        "postcss-loader": "^8.1.1",
-        "prettier": "^3.3.3",
-        "prettier-plugin-jsdoc": "^1.3.0",
-        "sass": "^1.79.5",
-        "sass-loader": "^16.0.2",
-        "stylelint": "^16.10.0",
-        "stylelint-config-recommended": "^14.0.1",
-        "stylelint-config-sass-guidelines": "^12.1.0",
-        "stylelint-config-tailwindcss": "^0.0.7",
-        "swc-loader": "^0.2.6",
-        "tailwindcss": "^3.4.13",
-        "tailwindcss-animate": "^1.0.7",
-        "ts-node": "^10.9.2",
-        "tsconfig-paths": "^4.2.0",
-        "tsconfig-paths-webpack-plugin": "^4.1.0",
-        "typescript": "^5.4.5",
-        "webpack": "^5.95.0",
-        "webpack-cli": "^5.1.4",
-        "webpack-merge": "^6.0.1",
-        "zip-build": "^1.8.0"
-      }
-    },
     "paranext-extensions": {
       "version": "file:extensions",
       "requires": {
@@ -49127,6 +49067,65 @@
         }
       }
     },
+    "paratext-registration": {
+      "version": "file:extensions/src/paratext-registration",
+      "requires": {
+        "@sillsdev/scripture": "^2.0.2",
+        "@swc/core": "^1.7.35",
+        "@tailwindcss/typography": "^0.5.15",
+        "@types/node": "^20.16.11",
+        "@types/react": "^18.3.11",
+        "@types/react-dom": "^18.3.1",
+        "@types/webpack": "^5.28.5",
+        "@typescript-eslint/eslint-plugin": "^6.21.0",
+        "@typescript-eslint/parser": "^6.21.0",
+        "autoprefixer": "^10.4.20",
+        "concurrently": "^9.0.1",
+        "copy-webpack-plugin": "^12.0.2",
+        "cross-env": "^7.0.3",
+        "css-loader": "^6.11.0",
+        "escape-string-regexp": "^5.0.0",
+        "eslint": "^8.57.1",
+        "eslint-config-airbnb-base": "^15.0.0",
+        "eslint-config-erb": "^4.1.0",
+        "eslint-import-resolver-typescript": "^3.6.3",
+        "eslint-plugin-compat": "^4.2.0",
+        "eslint-plugin-import": "^2.31.0",
+        "eslint-plugin-jest": "^27.9.0",
+        "eslint-plugin-jsx-a11y": "^6.10.0",
+        "eslint-plugin-no-null": "^1.0.2",
+        "eslint-plugin-no-type-assertion": "^1.3.0",
+        "eslint-plugin-promise": "^6.6.0",
+        "eslint-plugin-react": "^7.37.1",
+        "eslint-plugin-react-hooks": "^4.6.2",
+        "glob": "^10.4.5",
+        "lucide-react": "^0.452.0",
+        "papi-dts": "file:../../../lib/papi-dts",
+        "platform-bible-react": "file:../../../lib/platform-bible-react",
+        "platform-bible-utils": "file:../../../lib/platform-bible-utils",
+        "postcss": "^8.4.47",
+        "postcss-loader": "^8.1.1",
+        "prettier": "^3.3.3",
+        "prettier-plugin-jsdoc": "^1.3.0",
+        "sass": "^1.79.5",
+        "sass-loader": "^16.0.2",
+        "stylelint": "^16.10.0",
+        "stylelint-config-recommended": "^14.0.1",
+        "stylelint-config-sass-guidelines": "^12.1.0",
+        "stylelint-config-tailwindcss": "^0.0.7",
+        "swc-loader": "^0.2.6",
+        "tailwindcss": "^3.4.13",
+        "tailwindcss-animate": "^1.0.7",
+        "ts-node": "^10.9.2",
+        "tsconfig-paths": "^4.2.0",
+        "tsconfig-paths-webpack-plugin": "^4.1.0",
+        "typescript": "^5.4.5",
+        "webpack": "^5.95.0",
+        "webpack-cli": "^5.1.4",
+        "webpack-merge": "^6.0.1",
+        "zip-build": "^1.8.0"
+      }
+    },
     "parent-module": {
       "version": "1.0.1",
       "requires": {