Trigger downloading and opening of evicted iCloud Drive files

chrome/content/zotero/xpcom/file.js

@@ -1334,6 +1334,11 @@ Zotero.File = new function(){
 	}
 	
 	
+	this.getEvictedICloudPath = function (path) {
+		return OS.Path.join(OS.Path.dirname(path), '.' + OS.Path.basename(path) + '.icloud');
+	};
+	
+	
 	this.isDropboxDirectory = function(path) {
 		return path.toLowerCase().indexOf('dropbox') != -1;
 	}

chrome/content/zotero/xpcom/zotero.js

@@ -1010,6 +1010,8 @@ Services.scriptloader.loadSubScript("resource://zotero/polyfill.js");
 	 * Launch a file with the given application
 	 */
 	this.launchFileWithApplication = function (filePath, applicationPath) {
+		Zotero.debug(`Launching ${filePath} with ${applicationPath}`);
+		
 		var exec = Zotero.File.pathToFile(applicationPath);
 		if (!exec.exists()) {
 			throw new Error("'" + applicationPath + "' does not exist");

chrome/content/zotero/zoteroPane.js

@@ -4055,7 +4055,7 @@ var ZoteroPane = new function()
 	});
 	
 	
-	this.viewAttachment = Zotero.serial(Zotero.Promise.coroutine(function* (itemIDs, event, noLocateOnMissing, forceExternalViewer) {
+	this.viewAttachment = Zotero.serial(async function (itemIDs, event, noLocateOnMissing, forceExternalViewer) {
 		// If view isn't editable, don't show Locate button, since the updated
 		// path couldn't be sent back up
 		if (!this.collectionsView.editable) {
@@ -4071,9 +4071,26 @@ var ZoteroPane = new function()
 			}
 		}
 		
+		var launchFile = async function (path, contentType) {
+			// Custom PDF handler
+			if (contentType === 'application/pdf') {
+				let pdfHandler  = Zotero.Prefs.get("fileHandler.pdf");
+				if (pdfHandler) {
+					if (await OS.File.exists(pdfHandler)) {
+						Zotero.launchFileWithApplication(path, pdfHandler);
+						return;
+					}
+					else {
+						Zotero.logError(`${pdfHandler} not found -- launching file normally`);
+					}
+				}
+			}
+			Zotero.launchFile(path);
+		};
+		
 		for (let i = 0; i < itemIDs.length; i++) {
 			let itemID = itemIDs[i];
-			var item = yield Zotero.Items.getAsync(itemID);
+			let item = await Zotero.Items.getAsync(itemID);
 			if (!item.isAttachment()) {
 				throw new Error("Item " + itemID + " is not an attachment");
 			}
@@ -4083,80 +4100,100 @@ var ZoteroPane = new function()
 				continue;
 			}
 			
-			var path = yield item.getFilePathAsync();
+			let isLinkedFile = !item.isImportedAttachment();
-			if (path) {
+			let path = item.getFilePath();
-				let file = Zotero.File.pathToFile(path);
+			let fileExists = await OS.File.exists(path);
-				
+			let evictedICloudPath;
-				Zotero.debug("Opening " + path);
+			
-				
+			// If the file is an evicted iCloud Drive file, launch that to trigger a download.
-				if(forceExternalViewer !== undefined) {
+			// As of 10.13.6, launching an .icloud file triggers the download and opens the
-					var externalViewer = forceExternalViewer;
+			// associated program (e.g., Preview) but won't actually open the file, so we wait a bit
-				} else {
+			// for the original file to exist and then continue with regular file opening below.
-					var mimeType = yield Zotero.MIME.getMIMETypeFromFile(file);
+			//
-					
+			// To trigger eviction for testing, use Cirrus from https://eclecticlight.co/downloads/
-					//var mimeType = attachment.attachmentMIMEType;
+			if (!fileExists && Zotero.isMac && isLinkedFile) {
-					// TODO: update DB with new info if changed?
+				// Get the path to the .icloud file
-					
+				let iCloudPath = Zotero.File.getEvictedICloudPath(item.getFilePath());
-					var ext = Zotero.File.getExtension(file);
+				if (await OS.File.exists(iCloudPath)) {
-					var externalViewer = !Zotero.MIME.hasInternalHandler(mimeType, ext)
+					Zotero.debug("Triggering download of iCloud file");
-						|| Zotero.Prefs.get('launchNonNativeFiles');
+					await launchFile(iCloudPath, item.attachmentContentType);
-				}
+					let time = new Date();
-				
+					let maxTime = 5000;
-				if (!externalViewer) {
+					let revealed = false;
-					let url = Services.io.newFileURI(file).spec;
+					while (true) {
-					this.loadURI(url, event);
+						// If too much time has elapsed, just reveal the file in Finder instead
-				}
+						if (new Date() - time > maxTime) {
-				else {
+							Zotero.debug(`File not available after ${maxTime} -- revealing instead`);
-					Zotero.Notifier.trigger('open', 'file', itemID);
+							try {
-					
+								Zotero.File.reveal(iCloudPath);
-					// Custom PDF handler
+								revealed = true;
-					if (item.attachmentContentType === 'application/pdf') {
-						let pdfHandler  = Zotero.Prefs.get("fileHandler.pdf");
-						if (pdfHandler) {
-							if (yield OS.File.exists(pdfHandler)) {
-								Zotero.launchFileWithApplication(file.path, pdfHandler);
-								continue;
 							}
-							else {
+							catch (e) {
-								Zotero.logError(`${pdfHandler} not found -- launching file normally`);
+								Zotero.logError(e);
+								// In case the main file became available
+								try {
+									Zotero.File.reveal(path);
+									revealed = true;
+								}
+								catch (e) {
+									Zotero.logError(e);
+								}
 							}
+							break;
+						}
+						
+						// Wait a bit for the download and check again
+						await Zotero.Promise.delay(250);
+						Zotero.debug("Checking for downloaded file");
+						if (await OS.File.exists(path)) {
+							Zotero.debug("File is ready");
+							fileExists = true;
+							break;
 						}
 					}
 					
-					Zotero.launchFile(file);
+					if (revealed) {
+						continue;
+					}
 				}
 			}
-			else {
+			
-				if (!item.isImportedAttachment()
+			if (fileExists) {
-						|| !Zotero.Sync.Storage.Local.getEnabledForLibrary(item.libraryID)) {
+				Zotero.debug("Opening " + path);
-					this.showAttachmentNotFoundDialog(itemID, noLocateOnMissing);
+				Zotero.Notifier.trigger('open', 'file', item.id);
-					return;
-				}
 				
-				try {
+				launchFile(path, item.attachmentContentType);
-					yield Zotero.Sync.Runner.downloadFile(item);
+				continue;
-				}
-				catch (e) {
-					// TODO: show error somewhere else
-					Zotero.debug(e, 1);
-					ZoteroPane_Local.syncAlert(e);
-					return;
-				}
-				
-				if (!(yield item.getFilePathAsync())) {
-					ZoteroPane_Local.showAttachmentNotFoundDialog(item.id, noLocateOnMissing, true);
-					return;
-				}
-				
-				// check if unchanged?
-				// maybe not necessary, since we'll get an error if there's an error
-				
-				Zotero.Notifier.trigger('redraw', 'item', []);
-				// Retry after download
-				i--;
 			}
+			
+			if (isLinkedFile || !Zotero.Sync.Storage.Local.getEnabledForLibrary(item.libraryID)) {
+				this.showAttachmentNotFoundDialog(itemID, noLocateOnMissing);
+				return;
+			}
+			
+			try {
+				await Zotero.Sync.Runner.downloadFile(item);
+			}
+			catch (e) {
+				// TODO: show error somewhere else
+				Zotero.debug(e, 1);
+				ZoteroPane_Local.syncAlert(e);
+				return;
+			}
+			
+			if (!await item.getFilePathAsync()) {
+				ZoteroPane_Local.showAttachmentNotFoundDialog(item.id, noLocateOnMissing, true);
+				return;
+			}
+			
+			// check if unchanged?
+			// maybe not necessary, since we'll get an error if there's an error
+			
+			Zotero.Notifier.trigger('redraw', 'item', []);
+			// Retry after download
+			i--;
 		}
-	}));
+	});
 	
 	
 	/**