First public release

Author: unalignedcoder

CalibreImport/CalibreImport.cs

@@ -25,6 +25,11 @@ namespace CalibreImport
     [DisplayName("CalibreImport")]
     [COMServerAssociation(AssociationType.AllFiles)] //needed for Directory Opus, apparently.
     [COMServerAssociation(AssociationType.ClassOfExtension, ".epub", ".pdf", ".mobi", ".azw", ".azw3", ".fb2", ".djvu", ".lrf", ".rtf", ".txt", ".doc", ".docx", ".odt", ".htm", ".html", ".cbz", ".cbr", ".pdb", ".snb", ".tcr", ".zip", ".rar")]
+
+    // Welcome to CalibreImport, the main class of this Shell Extension.
+    // This class is responsible for creating the context menu and handling the calibredb.exe import process.
+    // It uses the SharpShell library to create a COM server that integrates with Windows Explorer.
+    // The class is decorated with various attributes to specify its COM visibility and associations with file types.
     public class CalibreImport : SharpContextMenu
     {
         private List<string> _supportedExtensions = new List<string>();
@@ -203,10 +208,11 @@ protected override ContextMenuStrip CreateMenu()
         }
 
         // Define a non-generic delegate type
+        // whatever that means
         public delegate void ReportProgressDelegate(int progress);
 
         // Primary import handler that processes single or multiple files
-        // Manages Calibre process state and handles user interaction during import
+        // Manages Calibre process state, and handles user interaction during import
         private void ExecuteImport(string selectedLibrary = null, ReportProgressDelegate reportProgress = null)
         {
             try
@@ -551,7 +557,7 @@ private void LoadSupportedExtensions()
             };
         }
 
-        // Get list of supported file extensions										
+        // Get the list of supported eBook file extensions										
         private static List<string> GetFileExtensions()
         {
             var extensions = new List<string>();
@@ -610,7 +616,7 @@ private void KillCalibre()
             }
         }
 
-        // Get list of Calibre libraries from gui.json											  
+        // Call on the CalibreLibraryManager class to retrieve the list of Calibre libraries
         private List<CalibreLibrary> GetCalibreLibraries()
         {
             return CalibreLibraryManager.GetLibraries();

CalibreImport/CalibreImport.csproj

@@ -112,7 +112,6 @@
 	C# files being compiled 
 	-->
   <ItemGroup>
-    <Compile Include="AppSettings.cs" />
     <Compile Include="AutomergeOption.cs" />
     <Compile Include="CalibreImport.cs" />
     <Compile Include="CalibreLibraryManager.cs" />
@@ -126,7 +125,6 @@
     </Compile>
     <Compile Include="Locales.cs" />
     <Compile Include="Logger.cs" />
-    <Compile Include="Program.cs" />
     <Compile Include="ProgressForm.cs">
       <SubType>Form</SubType>
     </Compile>

CalibreImport/CalibreLibraryManager.cs

@@ -8,26 +8,24 @@ namespace CalibreImport
 {
     public static class CalibreLibraryManager
     {
-        /// <summary>
-        /// Retrieves the list of Calibre libraries from gui.json.
-        /// </summary>
-        /// <param name="logger">
-        /// Optional logger action to write log messages (e.g., (message, color) => Logger.LogThis(message, color)).
-        /// </param>
-        /// <returns>List of CalibreLibrary objects or null on error.</returns>
+        // This method retrieves the list of Calibre libraries from the "gui.json" file.
+        // It parses it, and extracts the library paths and names.
+        // If anyone knows a more appropriate source for the list of libraries, let me know.
         public static List<CalibreLibrary> GetLibraries()
         {
             try
             {
                 var calibreConfigPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "calibre");
                 var guiFilePath = Path.Combine(calibreConfigPath, "gui.json");
 
+                // Can't do much with this app if the list of libraries can't be found.
                 if (!File.Exists(guiFilePath))
                 {
                     Logger.LogThis($"Calibre gui.json not found at {guiFilePath}. Cannot extract list of Libraries.");
                     return null;
                 }
 
+                // Read the JSON file and parse it
                 var guiJson = JObject.Parse(File.ReadAllText(guiFilePath));
                 var libraries = guiJson["library_usage_stats"]?
                     .ToObject<Dictionary<string, object>>()?.Keys

CalibreImport/CheckPortable.cs

@@ -6,6 +6,9 @@ namespace CalibreImport
 {
     public static class CheckPortable
     {
+        // Check if the application is running in portable mode
+        // It is not really "portable", though, as registry entries are still needed.
+        // It just checks if the config file is in the same directory as the assembly.
         public static bool IsPortable()
         {
             string assemblyName = Assembly.GetExecutingAssembly().GetName().Name;

CalibreImport/CustomSettings.cs

@@ -19,6 +19,7 @@ static CustomSettings()
             string ConfigName = $"{assemblyName}.config";
             string ConfDirectory;
 
+            // Check if the application is running in a portable mode
             if (CheckPortable.IsPortable())
             {
                 ConfDirectory = Path.GetDirectoryName(typeof(CustomSettings).Assembly.Location);
@@ -28,14 +29,15 @@ static CustomSettings()
                 ConfDirectory = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), assemblyName);
             }
 
-            // Ensure the directory exists
+            // Ensure the directory exists, if not create it
             if (!Directory.Exists(ConfDirectory))
             {
                 Directory.CreateDirectory(ConfDirectory);
             }
 
             string configFilePath = Path.Combine(ConfDirectory, ConfigName);
 
+            // Check if the config file exists, if not create a default one
             if (!File.Exists(configFilePath))
             {
                 CreateDefaultConfig(configFilePath);
@@ -49,6 +51,7 @@ static CustomSettings()
 
         public static void Save()
         {
+            // Save the configuration settings
             config.Save(ConfigurationSaveMode.Modified);
             ConfigurationManager.RefreshSection(config.AppSettings.SectionInformation.Name);
         }

CalibreImport/InnoSetup/CalibreImportSetup.iss

@@ -8,7 +8,7 @@
 [Setup]
 ; Application metadata
 AppName={#AppName}
-AppVersion=0.0.7.6
+AppVersion=0.0.7.7
 DefaultDirName={autopf}\{#AppName}
 DefaultGroupName={#AppName}
 UninstallDisplayIcon={app}\{#MainDll}

CalibreImport/Locales.cs

@@ -5,6 +5,10 @@
 public static class Locales
 {
     // ResourceStrings.cs will pick up localization strings from here
+    // This is a dictionary of dictionaries, where the outer dictionary's key is the culture name.
+    // In case you were wondering, we adopted this self-made method over the built-in Resources.resx
+    // method, in order to avoid the need to create a separate file for each language and, more
+    // importantly, to avoid the creation of locale folders for each language within the release build.
     private static readonly Dictionary<string, Dictionary<string, string>> _localizedStrings = new Dictionary<string, Dictionary<string, string>>
     {
         {

CalibreImport/Logger.cs

@@ -6,6 +6,7 @@
 
 namespace CalibreImport
 {
+    // This class provide a simple logging mechanism for the application.
     public static class Logger
     {
         private static readonly string assemblyName;
@@ -54,6 +55,9 @@ static Logger()
             }
         }
 
+        // This method logs messages to the log file.
+        // It can log both verbose and non-verbose messages based on the settings.
+        // The method also enriches the log message with debug information if verbose logging is enabled.
         public static void LogThis(string message, bool isVerbose = false)
         {
             try

CalibreImport/Properties/AssemblyInfo.cs

@@ -28,5 +28,5 @@
 //      Build Number
 //      Revision
 //
-[assembly: AssemblyVersion("0.0.7.6")]
-[assembly: AssemblyFileVersion("0.0.7.6")]
+[assembly: AssemblyVersion("0.0.7.7")]
+[assembly: AssemblyFileVersion("0.0.7.7")]