describe("Zotero.Fulltext", function () { var win, pdfToolsVersion; before(function* () { // Hidden browser, which requires a browser window, needed for charset detection // (until we figure out a better way) win = yield loadBrowserWindow(); pdfToolsVersion = Zotero.isWin ? '3.02a' : '3.04'; }); after(function () { if (win) { win.close(); } }); describe("Indexing", function () { before(function* () { yield Zotero.Fulltext.downloadPDFTool('info', pdfToolsVersion); yield Zotero.Fulltext.downloadPDFTool('converter', pdfToolsVersion); }); beforeEach(function () { Zotero.Prefs.clear('fulltext.textMaxLength'); Zotero.Prefs.clear('fulltext.pdfMaxPages'); }); after(function () { Zotero.Prefs.clear('fulltext.textMaxLength'); Zotero.Prefs.clear('fulltext.pdfMaxPages'); }); describe("#indexItems()", function () { it("should index a text file by default", function* () { var item = yield importFileAttachment('test.txt'); assert.equal( (yield Zotero.Fulltext.getIndexedState(item)), Zotero.Fulltext.INDEX_STATE_INDEXED ); }) it("should skip indexing of a text file if fulltext.textMaxLength is 0", function* () { Zotero.Prefs.set('fulltext.textMaxLength', 0); var item = yield importFileAttachment('test.txt'); assert.equal( (yield Zotero.Fulltext.getIndexedState(item)), Zotero.Fulltext.INDEX_STATE_UNINDEXED ); }) it("should index a PDF by default", function* () { var item = yield importFileAttachment('test.pdf'); assert.equal( (yield Zotero.Fulltext.getIndexedState(item)), Zotero.Fulltext.INDEX_STATE_INDEXED ); }) it("should skip indexing of a PDF if fulltext.textMaxLength is 0", function* () { Zotero.Prefs.set('fulltext.textMaxLength', 0); var item = yield importFileAttachment('test.pdf'); assert.equal( (yield Zotero.Fulltext.getIndexedState(item)), Zotero.Fulltext.INDEX_STATE_UNINDEXED ); }) it("should skip indexing of a PDF if fulltext.pdfMaxPages is 0", function* () { Zotero.Prefs.set('fulltext.pdfMaxPages', 0); var item = yield importFileAttachment('test.pdf'); assert.equal( (yield Zotero.Fulltext.getIndexedState(item)), Zotero.Fulltext.INDEX_STATE_UNINDEXED ); }) }); describe("#indexPDF()", function () { it("should create cache files for linked attachments in storage directory", function* () { var filename = 'test.pdf'; var file = OS.Path.join(getTestDataDirectory().path, filename); var tempDir = yield getTempDirectory(); var linkedFile = OS.Path.join(tempDir, filename); yield OS.File.copy(file, linkedFile); var item = yield Zotero.Attachments.linkFromFile({ file: linkedFile }); var storageDir = Zotero.Attachments.getStorageDirectory(item).path; assert.isTrue(yield OS.File.exists(storageDir)); assert.isTrue(yield OS.File.exists(OS.Path.join(storageDir, '.zotero-ft-info'))); assert.isTrue(yield OS.File.exists(OS.Path.join(storageDir, '.zotero-ft-cache'))); assert.isFalse(yield OS.File.exists(OS.Path.join(storageDir, filename))); }); }); }); describe("#downloadPDFTool()", function () { it("should install the PDF tools", function* () { yield Zotero.Fulltext.uninstallPDFTools(); assert.isFalse(Zotero.Fulltext.pdfInfoIsRegistered()); var dataDir = Zotero.DataDirectory.dir; var execFileName = Zotero.Fulltext.pdfInfoFileName; var execPath = OS.Path.join(dataDir, execFileName); var versionFileName = execFileName + '.version'; var versionPath = OS.Path.join(dataDir, versionFileName); var scriptExt = Zotero.isWin ? 'vbs' : 'sh'; var scriptPath = OS.Path.join(dataDir, 'pdfinfo.' + scriptExt); var scriptContents = yield Zotero.File.getContentsFromURLAsync( 'resource://zotero/redirect.' + scriptExt ); var cacheExecPath = OS.Path.join( getTestDataDirectory().path, "pdf", pdfToolsVersion, execFileName ); // Delete existing files try { yield OS.File.remove(execPath); } catch (e) {} try { yield OS.File.remove(versionPath); } catch (e) {} try { yield OS.File.remove(scriptPath); } catch (e) {} yield Zotero.Fulltext.downloadPDFTool('info', pdfToolsVersion); assert.ok(Zotero.Fulltext.pdfInfoIsRegistered()); assert.equal( (yield Zotero.Utilities.Internal.md5Async(cacheExecPath, false)), (yield Zotero.Utilities.Internal.md5Async(execPath, false)) ); if (!Zotero.isWin) { assert.equal((yield OS.File.stat(execPath)).unixMode, 0o755); } assert.equal( (yield Zotero.File.getContentsAsync(versionPath)), pdfToolsVersion ); //Temp: disabled on Windows if (!Zotero.isWin) { assert.equal( (yield Zotero.File.getContentsAsync(scriptPath)), scriptContents ); assert.equal((yield OS.File.stat(scriptPath)).unixMode, 0o755); } yield uninstallPDFTools(); assert.isFalse(Zotero.Fulltext.pdfInfoIsRegistered()); }) }) describe("#getUnsyncedContent()", function () { before(function* () { yield installPDFTools(); }) after(function* () { yield uninstallPDFTools(); }) it("should get content that hasn't been uploaded", function* () { var toSync = []; var group = yield getGroup(); var add = Zotero.Promise.coroutine(function* (options = {}) { let item = yield createDataObject('item', { libraryID: options.libraryID }); let attachment = new Zotero.Item('attachment'); if (options.libraryID) { attachment.libraryID = options.libraryID; } attachment.parentItemID = item.id; attachment.attachmentLinkMode = 'imported_file'; attachment.attachmentContentType = 'text/plain'; attachment.attachmentCharset = 'utf-8'; attachment.attachmentFilename = 'test.txt'; if (options.synced) { attachment.synced = true; } yield attachment.saveTx(); yield Zotero.Attachments.createDirectoryForItem(attachment); let path = attachment.getFilePath(); let content = new Array(10).fill("").map(x => Zotero.Utilities.randomString()).join(" "); yield Zotero.File.putContentsAsync(path, content); if (!options.skip) { toSync.push({ item: attachment, content, indexedChars: content.length, indexedPages: 0 }); } }); yield add({ synced: true }); yield add({ synced: true }); // Unsynced attachment shouldn't uploaded yield add({ skip: true }); // Attachment in another library shouldn't be uploaded yield add({ libraryID: group.libraryID, synced: true, skip: true }); // PDF attachment var pdfAttachment = yield importFileAttachment('test.pdf'); pdfAttachment.synced = true; yield pdfAttachment.saveTx(); toSync.push({ item: pdfAttachment, content: "Zotero [zoh-TAIR-oh] is a free, easy-to-use tool to help you collect, " + "organize, cite, and share your research sources.\n\n", indexedChars: 0, indexedPages: 1 }); yield Zotero.Fulltext.indexItems(toSync.map(x => x.item.id)); var data = yield Zotero.FullText.getUnsyncedContent(Zotero.Libraries.userLibraryID); assert.lengthOf(data, 3); let contents = toSync.map(x => x.content); for (let d of data) { let pos = contents.indexOf(d.content); assert.isAbove(pos, -1); assert.equal(d.indexedChars, toSync[pos].indexedChars); assert.equal(d.indexedPages, toSync[pos].indexedPages); } }) }) describe("#setItemContent()", function () { it("should store data in .zotero-ft-unprocessed file", function* () { var item = yield importFileAttachment('test.pdf'); var processorCacheFile = Zotero.Fulltext.getItemProcessorCacheFile(item).path; var itemCacheFile = Zotero.Fulltext.getItemCacheFile(item).path; yield Zotero.File.putContentsAsync(itemCacheFile, "Test"); yield Zotero.Fulltext.setItemContent( item.libraryID, item.key, { content: "Test", indexedChars: 4, totalChars: 4 }, 5 ); assert.equal((yield Zotero.Fulltext.getItemVersion(item.id)), 0); assert.equal( yield Zotero.DB. valueQueryAsync("SELECT synced FROM fulltextItems WHERE itemID=?", item.id), 2 // to process ); assert.isTrue(yield OS.File.exists(processorCacheFile)); }); it("should update the version if the local version is 0 but the text matches", function* () { var item = yield importFileAttachment('test.pdf'); yield Zotero.DB.queryAsync( "REPLACE INTO fulltextItems (itemID, version, synced) VALUES (?, 0, ?)", [item.id, 0] // to process ); var processorCacheFile = Zotero.Fulltext.getItemProcessorCacheFile(item).path; var itemCacheFile = Zotero.Fulltext.getItemCacheFile(item).path; yield Zotero.File.putContentsAsync(itemCacheFile, "Test"); yield Zotero.Fulltext.setItemContent( item.libraryID, item.key, { content: "Test", indexedChars: 4, totalChars: 4 }, 5 ); assert.equal((yield Zotero.Fulltext.getItemVersion(item.id)), 5); assert.equal( yield Zotero.DB. valueQueryAsync("SELECT synced FROM fulltextItems WHERE itemID=?", item.id), 1 // in sync ); assert.isFalse(yield OS.File.exists(processorCacheFile)); }); }); })