retold-remote 0.0.23 → 0.0.26

package/source/cli/commands/RetoldRemote-Command-Serve.js

@@ -29,6 +29,9 @@ class RetoldRemoteCommandServe extends libCommandLineCommand
 		this.options.CommandOptions.push(
 			{ Name: '-u, --ultravisor [url]', Description: 'Connect to Ultravisor mesh. URL defaults to http://localhost:54321 if omitted.', Default: '' });
 
+		this.options.CommandOptions.push(
+			{ Name: '--stack', Description: 'Run the full stack: spawn Ultravisor as a child process and connect to it. Uses XDG-style data paths under ~/.local/share and ~/.cache.', Default: false });
+
 		this.options.CommandOptions.push(
 			{ Name: '-l, --logfile [path]', Description: 'Write logs to a file (auto-generates timestamped name if path omitted).', Default: '' });
 
@@ -78,14 +81,26 @@ class RetoldRemoteCommandServe extends libCommandLineCommand
 		}
 
 		let tmpSelf = this;
-		let tmpSetupServer = require('../RetoldRemote-Server-Setup.js');
-
 		let tmpHashedFilenames = !(this.CommandOptions.noHash);
+		let tmpStackMode = !!this.CommandOptions.stack;
+
+		// Resolve XDG-style stack paths once (used by --stack mode)
+		let libStackLauncher = require('../RetoldRemote-Stack-Launcher.js');
+		let tmpStackPaths = libStackLauncher.resolveStackPaths();
+
+		// Cache root: explicit > stack default > package default
+		let tmpCacheRoot = null;
+		if (this.CommandOptions.cachePath)
+		{
+			tmpCacheRoot = libPath.resolve(this.CommandOptions.cachePath);
+		}
+		else if (tmpStackMode)
+		{
+			tmpCacheRoot = tmpStackPaths.RetoldCache;
+		}
 
-		let tmpCacheRoot = this.CommandOptions.cachePath
-			? libPath.resolve(this.CommandOptions.cachePath)
-			: null;
 		let tmpCacheServer = this.CommandOptions.cacheServer || null;
+
 		// -u with no URL → true (Commander behavior for [optional]), default to localhost
 		let tmpUltravisorOpt = this.CommandOptions.ultravisor;
 		let tmpUltravisorURL = null;
@@ -98,65 +113,125 @@ class RetoldRemoteCommandServe extends libCommandLineCommand
 			tmpUltravisorURL = tmpUltravisorOpt;
 		}
 
-		tmpSetupServer(
-			{
-				ContentPath: tmpContentPath,
-				DistPath: tmpDistPath,
-				Port: tmpPort,
-				HashedFilenames: tmpHashedFilenames,
-				CacheRoot: tmpCacheRoot,
-				CacheServer: tmpCacheServer,
-				UltravisorURL: tmpUltravisorURL
-			},
-			function (pError, pServerInfo)
-			{
-				if (pError)
-				{
-					tmpSelf.log.error(`Failed to start server: ${pError.message}`);
-					return fCallback(pError);
-				}
-
-				tmpSelf.log.info('');
-				tmpSelf.log.info('==========================================================');
-				tmpSelf.log.info(`  Retold Remote running on http://localhost:${pServerInfo.Port}`);
-				tmpSelf.log.info('==========================================================');
-				tmpSelf.log.info(`  Content: ${tmpContentPath}`);
-				tmpSelf.log.info(`  Assets:  ${tmpDistPath}`);
-				tmpSelf.log.info(`  Browse:  http://localhost:${pServerInfo.Port}/`);
-				if (pServerInfo.UltravisorBeacon && pServerInfo.UltravisorBeacon.isEnabled())
-				{
-					tmpSelf.log.info(`  Beacon:  registered with Ultravisor at ${tmpUltravisorURL}`);
-				}
-				else if (tmpUltravisorURL)
+		// In stack mode, automatically set the ultravisor URL
+		if (tmpStackMode && !tmpUltravisorURL)
+		{
+			tmpUltravisorURL = 'http://localhost:54321';
+		}
+
+		// Hold the stack info so we can clean up on exit
+		let tmpStackInfo = null;
+
+		// Bind the actual server startup so we can call it after (optionally) launching ultravisor
+		let _startRetoldRemote = () =>
+		{
+			let tmpSetupServer = require('../RetoldRemote-Server-Setup.js');
+
+			tmpSetupServer(
 				{
-					tmpSelf.log.info(`  Beacon:  not connected (Ultravisor may be unreachable)`);
-				}
-				tmpSelf.log.info('==========================================================');
-				tmpSelf.log.info('');
-				tmpSelf.log.info('  Press Ctrl+C to stop.');
-				tmpSelf.log.info('');
-
-				// Graceful shutdown: disconnect beacon before exit
-				process.on('SIGINT', () =>
+					ContentPath: tmpContentPath,
+					DistPath: tmpDistPath,
+					Port: tmpPort,
+					HashedFilenames: tmpHashedFilenames,
+					CacheRoot: tmpCacheRoot,
+					CacheServer: tmpCacheServer,
+					UltravisorURL: tmpUltravisorURL
+				},
+				function (pError, pServerInfo)
 				{
+					if (pError)
+					{
+						tmpSelf.log.error(`Failed to start server: ${pError.message}`);
+						if (tmpStackInfo)
+						{
+							libStackLauncher.stop(tmpStackInfo, () => {});
+						}
+						return fCallback(pError);
+					}
+
 					tmpSelf.log.info('');
-					tmpSelf.log.info('Shutting down...');
+					tmpSelf.log.info('==========================================================');
+					tmpSelf.log.info(`  Retold Remote running on http://localhost:${pServerInfo.Port}`);
+					tmpSelf.log.info('==========================================================');
+					tmpSelf.log.info(`  Content: ${tmpContentPath}`);
+					tmpSelf.log.info(`  Cache:   ${tmpCacheRoot || '(default)'}`);
+					tmpSelf.log.info(`  Browse:  http://localhost:${pServerInfo.Port}/`);
 					if (pServerInfo.UltravisorBeacon && pServerInfo.UltravisorBeacon.isEnabled())
 					{
-						pServerInfo.UltravisorBeacon.disconnectBeacon(() =>
-						{
-							process.exit(0);
-						});
+						tmpSelf.log.info(`  Beacon:  registered with Ultravisor at ${tmpUltravisorURL}`);
+					}
+					else if (tmpUltravisorURL)
+					{
+						tmpSelf.log.info(`  Beacon:  not connected (Ultravisor may be unreachable)`);
 					}
-					else
+					if (tmpStackMode)
 					{
-						process.exit(0);
+						tmpSelf.log.info(`  Stack:   ultravisor + retold-remote (orator-conversion embedded)`);
 					}
+					tmpSelf.log.info('==========================================================');
+					tmpSelf.log.info('');
+					tmpSelf.log.info('  Press Ctrl+C to stop.');
+					tmpSelf.log.info('');
+
+					// Graceful shutdown: disconnect beacon and stop child processes before exit
+					let _shutdown = () =>
+					{
+						tmpSelf.log.info('');
+						tmpSelf.log.info('Shutting down...');
+
+						let _finish = () =>
+						{
+							if (tmpStackInfo)
+							{
+								libStackLauncher.stop(tmpStackInfo, () => process.exit(0));
+							}
+							else
+							{
+								process.exit(0);
+							}
+						};
+
+						if (pServerInfo.UltravisorBeacon && pServerInfo.UltravisorBeacon.isEnabled())
+						{
+							pServerInfo.UltravisorBeacon.disconnectBeacon(_finish);
+						}
+						else
+						{
+							_finish();
+						}
+					};
+
+					process.on('SIGINT', _shutdown);
+					process.on('SIGTERM', _shutdown);
+
+					// Intentionally do NOT call fCallback() here.
+					// The server should keep running.
 				});
+		};
 
-				// Intentionally do NOT call fCallback() here.
-				// The server should keep running.
-			});
+		// In stack mode, launch ultravisor first, then start retold-remote
+		if (tmpStackMode)
+		{
+			libStackLauncher.start(
+				{
+					Logger: tmpSelf.log,
+					UltravisorPort: 54321
+				},
+				(pStackError, pStackInfo) =>
+				{
+					if (pStackError)
+					{
+						tmpSelf.log.error(`Stack launch failed: ${pStackError.message}`);
+						return fCallback(pStackError);
+					}
+					tmpStackInfo = pStackInfo;
+					_startRetoldRemote();
+				});
+		}
+		else
+		{
+			_startRetoldRemote();
+		}
 	}
 }
 

package/source/providers/CollectionManager-AddItems.js

@@ -47,6 +47,30 @@ module.exports =
 			return this.addAudioSnippetToCollection(tmpTargetGUID);
 		}
 
+		// If the image explorer is active with a selection, add as subimage
+		if (tmpRemote.ActiveMode === 'image-explorer')
+		{
+			let tmpIEX = this.pict.views['RetoldRemote-ImageExplorer'];
+			if (tmpIEX)
+			{
+				let tmpActiveSelection = tmpIEX.getActiveSelection();
+				if (tmpActiveSelection)
+				{
+					return this.addSubimageToCollection(tmpTargetGUID, tmpActiveSelection, tmpIEX._currentPath);
+				}
+			}
+		}
+
+		// If viewing a document (PDF/EPUB) with a pending region, add as document-region
+		if (tmpRemote.ActiveMode === 'viewer' && tmpRemote.CurrentViewerMediaType === 'document')
+		{
+			let tmpMediaViewer = this.pict.views['RetoldRemote-MediaViewer'];
+			if (tmpMediaViewer && tmpMediaViewer._pendingDocumentRegion)
+			{
+				return this.addDocumentRegionToCollection(tmpTargetGUID, tmpMediaViewer._pendingDocumentRegion, tmpRemote.CurrentViewerFile);
+			}
+		}
+
 		let tmpCurrentItem = this._resolveCurrentItem();
 
 		if (!tmpCurrentItem || !tmpCurrentItem.Path)
@@ -329,6 +353,148 @@ module.exports =
 		return true;
 	},
 
+	/**
+	 * Add a subimage region (crop) to a collection.
+	 *
+	 * @param {string} pGUID      - Collection GUID
+	 * @param {object} pRegion    - { X, Y, Width, Height, Label?, ID? } in image pixels
+	 * @param {string} [pFilePath] - Explicit file path (defaults to current viewer file)
+	 * @returns {boolean} true if the add was initiated
+	 */
+	addSubimageToCollection: function addSubimageToCollection(pGUID, pRegion, pFilePath)
+	{
+		let tmpRemote = this._getRemote();
+		let tmpTargetGUID = pGUID || tmpRemote.LastUsedCollectionGUID;
+		if (!tmpTargetGUID || !pRegion)
+		{
+			return false;
+		}
+
+		let tmpFilePath = pFilePath || tmpRemote.CurrentViewerFile;
+		if (!tmpFilePath)
+		{
+			return false;
+		}
+
+		let tmpFileName = tmpFilePath.replace(/^.*\//, '');
+		let tmpLabel = pRegion.Label
+			? pRegion.Label
+			: tmpFileName + ': ' + pRegion.Width + '\u00d7' + pRegion.Height + ' at ' + pRegion.X + ',' + pRegion.Y;
+
+		let tmpItem =
+		{
+			Type: 'image-crop',
+			Path: tmpFilePath,
+			CropRegion:
+			{
+				X: pRegion.X,
+				Y: pRegion.Y,
+				Width: pRegion.Width,
+				Height: pRegion.Height
+			},
+			Label: tmpLabel,
+			Note: ''
+		};
+
+		// If we have a hash for this file, include it
+		let tmpProvider = this.pict.providers['RetoldRemote-Provider'];
+		if (tmpProvider)
+		{
+			let tmpHash = tmpProvider.getHashForPath(tmpFilePath);
+			if (tmpHash)
+			{
+				tmpItem.Hash = tmpHash;
+			}
+		}
+
+		this.addItemsToCollection(tmpTargetGUID, [tmpItem]);
+		return true;
+	},
+
+	/**
+	 * Add a document region (text selection or visual area) to a collection.
+	 *
+	 * @param {string} pGUID      - Collection GUID
+	 * @param {object} pRegion    - Region object with Type, Label, and type-specific fields
+	 * @param {string} [pFilePath] - Explicit file path (defaults to current viewer file)
+	 * @returns {boolean} true if the add was initiated
+	 */
+	addDocumentRegionToCollection: function addDocumentRegionToCollection(pGUID, pRegion, pFilePath)
+	{
+		let tmpRemote = this._getRemote();
+		let tmpTargetGUID = pGUID || tmpRemote.LastUsedCollectionGUID;
+		if (!tmpTargetGUID || !pRegion)
+		{
+			return false;
+		}
+
+		let tmpFilePath = pFilePath || tmpRemote.CurrentViewerFile;
+		if (!tmpFilePath)
+		{
+			return false;
+		}
+
+		let tmpFileName = tmpFilePath.replace(/^.*\//, '');
+		let tmpIsText = (pRegion.Type === 'text-selection');
+
+		// Build label
+		let tmpLabel = pRegion.Label || '';
+		if (!tmpLabel)
+		{
+			if (tmpIsText && pRegion.SelectedText)
+			{
+				tmpLabel = pRegion.SelectedText.substring(0, 50);
+				if (pRegion.SelectedText.length > 50) tmpLabel += '\u2026';
+			}
+			else
+			{
+				tmpLabel = tmpFileName;
+			}
+			if (pRegion.PageNumber)
+			{
+				tmpLabel = 'p.' + pRegion.PageNumber + ': ' + tmpLabel;
+			}
+		}
+
+		let tmpItem =
+		{
+			Type: 'document-region',
+			Path: tmpFilePath,
+			Label: tmpLabel,
+			Note: '',
+			DocumentRegionType: pRegion.Type || 'visual-region',
+			PageNumber: pRegion.PageNumber || null,
+			CFI: pRegion.CFI || null,
+			SelectedText: pRegion.SelectedText || null
+		};
+
+		// Include crop region for visual selections
+		if (!tmpIsText && pRegion.X !== undefined)
+		{
+			tmpItem.CropRegion =
+			{
+				X: pRegion.X,
+				Y: pRegion.Y,
+				Width: pRegion.Width,
+				Height: pRegion.Height
+			};
+		}
+
+		// File hash
+		let tmpProvider = this.pict.providers['RetoldRemote-Provider'];
+		if (tmpProvider)
+		{
+			let tmpHash = tmpProvider.getHashForPath(tmpFilePath);
+			if (tmpHash)
+			{
+				tmpItem.Hash = tmpHash;
+			}
+		}
+
+		this.addItemsToCollection(tmpTargetGUID, [tmpItem]);
+		return true;
+	},
+
 	/**
 	 * Format a timestamp in seconds to a human-readable string.
 	 *

package/source/providers/Pict-Provider-GalleryNavigation.js

@@ -556,6 +556,15 @@ class GalleryNavigationProvider extends libPictProvider
 		tmpRemote.CurrentViewerFile = '';
 		tmpRemote.CurrentViewerMediaType = '';
 
+		// Notify the layout so any active sidebar tab (Info, Regions, etc.)
+		// transitions to its empty state instead of retaining stale content
+		// from the file the user just closed.
+		let tmpLayout = this.pict.views['ContentEditor-Layout'];
+		if (tmpLayout && typeof tmpLayout.notifyCurrentFileChanged === 'function')
+		{
+			tmpLayout.notifyCurrentFileChanged('');
+		}
+
 		// Exit collection browsing mode
 		tmpRemote.BrowsingCollection = false;
 		tmpRemote.BrowsingCollectionIndex = -1;
@@ -630,6 +639,52 @@ class GalleryNavigationProvider extends libPictProvider
 				tmpAEX.showExplorer(pItem.Path, pItem.AudioStart, pItem.AudioEnd);
 			}
 		}
+		else if (pItem.Type === 'document-region')
+		{
+			// Navigate to the document, then to the specific location
+			let tmpApp = this.pict.PictApplication;
+			if (tmpApp && tmpApp.navigateToFile)
+			{
+				tmpApp.navigateToFile(pItem.Path);
+
+				// After the viewer loads, navigate to the specific page/CFI
+				let tmpSelf = this;
+				setTimeout(() =>
+				{
+					let tmpMediaViewer = tmpSelf.pict.views['RetoldRemote-MediaViewer'];
+					if (tmpMediaViewer)
+					{
+						if (pItem.CFI && tmpMediaViewer._activeRendition)
+						{
+							tmpMediaViewer._activeRendition.display(pItem.CFI);
+						}
+						else if (pItem.PageNumber && typeof tmpMediaViewer._renderPdfPage === 'function')
+						{
+							tmpMediaViewer._renderPdfPage(pItem.PageNumber);
+						}
+					}
+				}, 1000);
+			}
+		}
+		else if (pItem.Type === 'image-crop' && pItem.CropRegion)
+		{
+			let tmpIEX = this.pict.views['RetoldRemote-ImageExplorer'];
+			if (tmpIEX)
+			{
+				tmpIEX.showExplorer(pItem.Path);
+				// Zoom to the crop region after the viewer loads
+				let tmpCrop = pItem.CropRegion;
+				setTimeout(() =>
+				{
+					if (tmpIEX._osdViewer && tmpIEX._dziData)
+					{
+						let tmpImageRect = new OpenSeadragon.Rect(tmpCrop.X, tmpCrop.Y, tmpCrop.Width, tmpCrop.Height);
+						let tmpViewportRect = tmpIEX._osdViewer.viewport.imageToViewportRectangle(tmpImageRect);
+						tmpIEX._osdViewer.viewport.fitBounds(tmpViewportRect);
+					}
+				}, 800);
+			}
+		}
 		else if (pItem.Type === 'video-frame' && pItem.FrameCacheKey && pItem.FrameFilename)
 		{
 			// Show the cached frame image directly in the viewer