kiwix/kiwix-js-pwa
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-js-pwa.git synced 2025-08-11 15:28:34 -04:00
Code Issues Packages Projects Releases Wiki Activity
kiwix-js-pwa/www/js/app.js
Jaifroid 06e743c47a Prevent critical bug which fails to unhide article in jQuery mode on slow systems 
Former-commit-id: f5b0b6e2caad7b8a66b2a4b3353a19a765d2ebf9 [formerly c0b61e2bdcfd765cbb34d2121adb6e17babad5ba [formerly 2ca97f551075051ed091771b7351355e206385d1]]
Former-commit-id: d8c899bc580af5fd1a860aab2cb690137b992afb
Former-commit-id: 8431d8902c0356a0799cf5ba932b388a3e63cb83
2021-06-13 18:06:19 +01:00

4516 lines
267 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/**
* app.js : User Interface implementation
* This file handles the interaction between the application and the user
*
* Copyright 2013-2014 Mossroy and contributors
* License GPL v3:
*
* This file is part of Kiwix.
*
* Kiwix is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Kiwix is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Kiwix (file LICENSE-GPLv3.txt). If not, see <http://www.gnu.org/licenses/>
*/
'use strict';
// This uses require.js to structure javascript:
// http://requirejs.org/docs/api.html#define
define(['jquery', 'zimArchiveLoader', 'uiUtil', 'util', 'cache', 'images', 'settingsStore', 'q', 'transformStyles', 'kiwixServe'],
function ($, zimArchiveLoader, uiUtil, util, cache, images, settingsStore, Q, transformStyles, kiwixServe) {
/**
* The delay (in milliseconds) between two "keepalive" messages
* sent to the ServiceWorker (so that it is not stopped by
* the browser, and keeps the MessageChannel to communicate
* with the application)
* @type Integer
*/
var DELAY_BETWEEN_KEEPALIVE_SERVICEWORKER = 30000;
// Define global state:
/**
* @type ZIMArchive
*/
appstate.selectedArchive = null;
// An object to hold the current search and its state (allows cancellation of search across modules)
appstate['search'] = {
'prefix': '', // A field to hold the original search string
'status': '', // The status of the search: ''|'init'|'interim'|'cancelled'|'complete'
'type': '' // The type of the search: 'basic'|'full' (set automatically in search algorithm)
};
// A parameter to determine the Settings Store API in use (we need to nullify before testing
// because params.storeType is also set in a preliminary way in init.js)
params['storeType'] = null;
params['storeType'] = settingsStore.getBestAvailableStorageAPI();
// Test caching capability
cache.test(function(){});
// Unique identifier of the article expected to be displayed
var expectedArticleURLToBeDisplayed = "";
/**
* Resize the IFrame height, so that it fills the whole available height in the window
*/
function resizeIFrame() {
var scrollbox = document.getElementById('scrollbox');
var header = document.getElementById('top');
var iframe = document.getElementById('articleContent');
var navbarHeight = document.getElementById('navbar').getBoundingClientRect().height;
// Reset any hidden headers and footers and iframe shift
header.style.zIndex = 1;
header.style.transform = 'translateY(0)';
document.getElementById('footer').style.transform = 'translateY(0)';
iframe.style.transform = 'translateY(-1px)';
//iframe.style.height = window.innerHeight - navbarHeight + "px";
iframe.style.height = window.innerHeight + 'px';
//Re-enable top-level scrolling
scrollbox.style.height = window.innerHeight - navbarHeight + 'px';
if (iframe.style.display !== "none" && document.getElementById("prefix") !== document.activeElement) {
scrollbox.style.height = 0;
}
var ToCList = document.getElementById('ToCList');
if (typeof ToCList !== "undefined") {
ToCList.style.maxHeight = ~~(window.innerHeight * 0.75) + 'px';
ToCList.style.marginLeft = ~~(window.innerWidth / 2) - ~~(window.innerWidth * 0.16) + 'px';
}
if (window.outerWidth <= 470) {
document.getElementById('dropup').classList.remove('col-xs-4');
document.getElementById('dropup').classList.add('col-xs-3');
//var colXS2 = document.querySelectorAll('.col-xs-2');
//if (colXS2.length && window.outerWidth <= 360) {
// for (var i = 0; i < colXS2.length; i++) {
// colXS2[i].classList.remove('col-xs-2');
// colXS2[i].classList.add('col-xs-1');
// }
if (window.outerWidth <= 360) {
//document.getElementById('btnHomeBottom').classList.remove('col-xs-2');
//document.getElementById('btnHomeBottom').classList.add('col-xs-1');
document.getElementById('btnTop').classList.remove('col-xs-2');
document.getElementById('btnTop').classList.add('col-xs-1');
//} else if (window.outerWidth > 360 && !colXS2.length) {
} else {
//document.getElementById('btnHomeBottom').classList.remove('col-xs-1');
//document.getElementById('btnHomeBottom').classList.add('col-xs-2');
document.getElementById('btnTop').classList.remove('col-xs-1');
document.getElementById('btnTop').classList.add('col-xs-2');
}
} else {
document.getElementById('dropup').classList.remove('col-xs-3');
document.getElementById('dropup').classList.add('col-xs-4');
}
checkToolbar();
}
$(document).ready(resizeIFrame);
$(window).resize(function () {
resizeIFrame();
// We need to load any images exposed by the resize
var scrollFunc = document.getElementById('articleContent').contentWindow;
scrollFunc = scrollFunc ? scrollFunc.onscroll : null;
if (scrollFunc) scrollFunc();
});
// Define behavior of HTML elements
if (params.navButtonsPos === 'top') {
// User has requested navigation buttons should be at top, so we need to swap them
var btnBack = document.getElementById('btnBack');
var btnBackAlt = document.getElementById('btnBackAlt');
btnBack.id = 'btnBackAlt';
btnBackAlt.id = 'btnBack';
btnBackAlt.style.display = 'inline';
btnBack.style.display = 'none';
var btnForward = document.getElementById('btnForward');
var btnForwardAlt = document.getElementById('btnForwardAlt');
btnForward.id = 'btnForwardAlt';
btnForwardAlt.id = 'btnForward';
btnForwardAlt.style.display = 'inline';
btnForward.style.display = 'none';
var btnRandom = document.getElementById('btnRandomArticle');
var btnRandomAlt = document.getElementById('btnRandomArticleAlt');
btnRandom.id = 'btnRandomArticleAlt';
btnRandomAlt.id = 'btnRandomArticle';
btnRandom.style.display = 'none';
btnRandomAlt.style.display = 'inline';
}
var searchArticlesFocused = false;
document.getElementById('searchArticles').addEventListener('click', function () {
var prefix = document.getElementById('prefix').value;
// Do not initiate the same search if it is already in progress
if (appstate.search.prefix === prefix && !/^(cancelled|complete)$/.test(appstate.search.status)) return;
$("#welcomeText").hide();
$('.alert').hide();
$("#searchingArticles").show();
pushBrowserHistoryState(null, prefix);
// Initiate the search
searchDirEntriesFromPrefix(prefix);
clearFindInArticle();
//Re-enable top-level scrolling
document.getElementById('scrollbox').style.height = window.innerHeight - document.getElementById('top').getBoundingClientRect().height + 'px';
if ($('#navbarToggle').is(":visible") && $('#liHomeNav').is(':visible')) {
$('#navbarToggle').click();
}
// This flag is set to true in the mousedown event below
searchArticlesFocused = false;
});
document.getElementById('formArticleSearch').addEventListener('submit', function () {
document.getElementById('searchArticles').click();
});
// Handle keyboard events in the prefix (article search) field
var keyPressHandled = false;
$('#prefix').on('keydown', function (e) {
// If user presses Escape...
// IE11 returns "Esc" and the other browsers "Escape"; regex below matches both
if (/^Esc/.test(e.key)) {
// Hide the article list
e.preventDefault();
e.stopPropagation();
$('#articleListWithHeader').hide();
$('#articleContent').focus();
$("#myModal").modal('hide'); // This is in case the modal box is showing with an index search
keyPressHandled = true;
}
// Arrow-key selection code adapted from https://stackoverflow.com/a/14747926/9727685
// IE11 produces "Down" instead of "ArrowDown" and "Up" instead of "ArrowUp"
if (/^((Arrow)?Down|(Arrow)?Up|Enter)$/.test(e.key)) {
// User pressed Down arrow or Up arrow or Enter
e.preventDefault();
e.stopPropagation();
// This is needed to prevent processing in the keyup event : https://stackoverflow.com/questions/9951274
keyPressHandled = true;
var activeElement = document.querySelector("#articleList .hover") || document.querySelector("#articleList a");
if (!activeElement) return;
// If user presses Enter, read the dirEntry
if (/Enter/.test(e.key)) {
if (activeElement.classList.contains('hover')) {
var dirEntryId = activeElement.getAttribute('dirEntryId');
findDirEntryFromDirEntryIdAndLaunchArticleRead(dirEntryId);
return;
}
}
// If user presses ArrowDown...
// (NB selection is limited to five possibilities by regex above)
if (/Down/.test(e.key)) {
if (activeElement.classList.contains('hover')) {
activeElement.classList.remove('hover');
activeElement = activeElement.nextElementSibling || activeElement;
var nextElement = activeElement.nextElementSibling || activeElement;
if (!uiUtil.isElementInView(nextElement, true)) nextElement.scrollIntoView(false);
}
}
// If user presses ArrowUp...
if (/Up/.test(e.key)) {
activeElement.classList.remove('hover');
activeElement = activeElement.previousElementSibling || activeElement;
var previousElement = activeElement.previousElementSibling || activeElement;
if (!uiUtil.isElementInView(previousElement, true)) previousElement.scrollIntoView();
if (previousElement === activeElement) {
document.getElementById('articleListWithHeader').scrollIntoView();
document.getElementById('top').scrollIntoView();
}
}
activeElement.classList.add('hover');
}
});
// Search for titles as user types characters
$('#prefix').on('keyup', function (e) {
if (appstate.selectedArchive !== null && appstate.selectedArchive.isReady()) {
// Prevent processing by keyup event if we already handled the keypress in keydown event
if (keyPressHandled)
keyPressHandled = false;
else
onKeyUpPrefix(e);
}
});
// Restore the search results if user goes back into prefix field
$('#prefix').on('focus', function (e) {
var prefixVal = $('#prefix').val();
if (/^\s/.test(prefixVal)) {
// If user had previously had the archive index open, clear it
document.getElementById('prefix').value = '';
} else if (prefixVal !== '') {
$('#articleListWithHeader').show();
}
document.getElementById('scrollbox').style.position = 'absolute';
document.getElementById('scrollbox').style.height = window.innerHeight - document.getElementById('top').getBoundingClientRect().height + 'px';
});
// Hide the search results if user moves out of prefix field
document.getElementById('prefix').addEventListener('blur', function () {
if (!searchArticlesFocused) {
appstate.search.state = 'cancelled';
}
// We need to wait one tick for the activeElement to receive focus
setTimeout(function () {
if (!(/^articleList/.test(document.activeElement.id) || /^list-group/.test(document.activeElement.className))) {
document.getElementById('scrollbox').style.height = 0;
document.getElementById('articleListWithHeader').style.display = 'none';
}
}, 1);
});
//Add keyboard shortcuts
window.addEventListener('keyup', function (e) {
var e = e || window.event;
//Alt-F for search in article, also patches Ctrl-F for apps that do not have access to browser search
if ((e.ctrlKey || e.altKey) && e.which == 70) {
document.getElementById('findText').click();
}
});
window.addEventListener('keydown', function (e) {
//Ctrl-P to patch printing support, so iframe gets printed
if (e.ctrlKey && e.which == 80) {
e.stopPropagation();
e.preventDefault();
printIntercept();
}
}, true);
//Set up listeners for print dialogues
$("#printModal").off('hide.bs.modal');
$("#printModal").on('hide.bs.modal', function () {
//Restore temporarily changed values
params.cssSource = settingsStore.getItem('cssSource') || "auto";
params.cssTheme = settingsStore.getItem('cssTheme') || "light";
//params.contentInjectionMode = settingsStore.getItem('contentInjectionMode');
if (document.activeElement.id != "confirm-print-continue") { //User cancelled
if (params.printInterception) {
printCleanup();
return;
}
//We don't need a radical cleanup because there was no printIntercept
removePageMaxWidth();
setTab();
switchCSSTheme();
return;
}
uiUtil.printCustomElements();
document.getElementById("alert-content").innerHTML = "<b>Document will now reload to restore the DOM after printing...</b>";
$("#alertModal").off('hide.bs.modal');
$("#alertModal").on('hide.bs.modal', function () {
printCleanup();
});
$("#alertModal").modal({
backdrop: "static",
keyboard: true
});
//innerDocument.execCommand("print", false, null);
// if (typeof window.nw !== 'undefined' || typeof window.fs === 'undefined') {
window.frames[0].frameElement.contentWindow.print();
// } else {
// // We are in an Electron app and need to use export to browser to print
// params.preloadingAllImages = false;
// // Add a window.print() script to the html
// document.getElementById('articleContent').contentDocument.head.innerHTML +=
// '\n<script type="text/javascript">window.onload=function() {\n' +
// ' alert("After you press OK, you will be asked to choose a printer.\\n" +\n' +
// ' "If you want to test the formatting, we suggest you print to\\n" +\n' +
// ' "PDF or XPS. You could then open the PDF and select specific pages.");\n' +
// ' window.print();\n' +
// '};<\/script>';
// //html = html.replace(/(<\/head>\s*)/i, '<script type="text/javascript">window.onload=window.print();<\/script>\n$1');
// uiUtil.extractHTML();
// }
});
document.getElementById('printDesktopCheck').addEventListener('click', function (e) {
//Reload article if user wants to print a different style
params.cssSource = e.target.checked ? "desktop" : "mobile";
params.printIntercept = true;
params.printInterception = false;
var btnContinue = document.getElementById('confirm-print-continue');
var btnCancel = document.getElementById('confirm-print-cancel');
btnCancel.disabled = true;
btnContinue.disabled = true;
btnContinue.innerHTML = "Please wait";
goToArticle(params.lastPageVisit.replace(/@kiwixKey@.+/, ""));
});
document.getElementById('printImageCheck').addEventListener('click', function (e) {
//Reload article if user wants to print images
if (e.target.checked && !params.allowHTMLExtraction) {
params.printIntercept = true;
params.printInterception = false;
params.allowHTMLExtraction = true;
var btnContinue = document.getElementById('confirm-print-continue');
var btnCancel = document.getElementById('confirm-print-cancel');
btnCancel.disabled = true;
btnContinue.disabled = true;
btnContinue.innerHTML = "Please wait";
goToArticle(params.lastPageVisit.replace(/@kiwixKey@.+/, ""));
}
});
function printCleanup() {
params.printIntercept = false;
params.printInterception = false;
// Immediately restore temporarily changed values
params.allowHTMLExtraction = settingsStore.getItem('allowHTMLExtraction') == "true";
//params.contentInjectionMode = settingsStore.getItem('contentInjectionMode');
//goToArticle(decodeURIComponent(params.lastPageVisit.replace(/@kiwixKey@.+/, "")));
if (history.state !== null) {
var thisURL = decodeURIComponent(history.state.title);
goToArticle(thisURL);
}
setTimeout(function () { //Restore temporarily changed value after page has reloaded
params.rememberLastPage = settingsStore.getItem('rememberLastPage') === 'true';
if (!params.rememberLastPage) {
settingsStore.setItem('lastPageVisit', '', Infinity);
params.lastPageHTML = '';
// DEV: replace this with cache.clear when you have repaired that method
cache.setArticle(params.lastPageVisit.replace(/.+@kiwixKey@/, ''), params.lastPageVisit.replace(/@kiwixKey@.+/, ''), '', function(){});
}
}, 5000);
}
//End of listeners for print dialogues
function printIntercept() {
params.printInterception = params.printIntercept;
params.printIntercept = false;
document.getElementById('btnAbout').classList.add('active');
var btnContinue = document.getElementById('confirm-print-continue');
var btnCancel = document.getElementById('confirm-print-cancel');
btnCancel.disabled = false;
btnContinue.disabled = false;
btnContinue.innerHTML = "Continue";
var printModalContent = document.getElementById('print-modal-content');
openAllSections(true);
printModalContent.classList.remove('dark');
var determinedTheme = params.cssUITheme;
determinedTheme = determinedTheme == 'auto' ? cssUIThemeGetOrSet('auto', true) : determinedTheme;
if (determinedTheme != "light") {
printModalContent.classList.add('dark');
}
//If document is in wrong style, or images are one-time BLOBs, reload it
//var innerDoc = window.frames[0].frameElement.contentDocument;
var innerDoc = document.getElementById('articleContent').contentDocument;
var printDesktopCheck = document.getElementById("printDesktopCheck").checked;
var printImageCheck = document.getElementById("printImageCheck").checked;
var styleIsDesktop = !/href\s*=\s*["'][^"']*?(?:minerva|mobile)/i.test(innerDoc.head.innerHTML);
//if (styleIsDesktop != printDesktopCheck || printImageCheck && !params.allowHTMLExtraction || params.contentInjectionMode == 'serviceworker') {
if (styleIsDesktop != printDesktopCheck || printImageCheck && !params.allowHTMLExtraction) {
//We need to reload the document because it doesn't match the requested style or images are one-time BLOBs
params.cssSource = printDesktopCheck ? "desktop" : "mobile";
params.rememberLastPage = true; //Re-enable caching to speed up reloading of page
//params.contentInjectionMode = 'jquery'; //Much easier to count images in jquery mode
params.allowHTMLExtraction = true;
params.printIntercept = true;
params.printInterception = false;
btnCancel.disabled = true;
btnContinue.disabled = true;
btnContinue.innerHTML = "Please wait";
$("#printModal").modal({
backdrop: "static",
keyboard: true
});
goToArticle(params.lastPageVisit.replace(/@kiwixKey@.+/, ""));
return;
}
//Pre-load all images in case user wants to print them
if (params.imageDisplay) {
document.getElementById("printImageCheck").disabled = false;
if (printImageCheck) {
btnCancel.disabled = true;
btnContinue.disabled = true;
btnContinue.innerHTML = "Loading images...";
//Callback for when all images are loaded
params.printImagesLoaded = function () {
// Images have finished loading, so enable buttons
btnCancel.disabled = false;
btnContinue.disabled = false;
btnContinue.innerHTML = "Continue";
};
if (params.contentInjectionMode == 'jquery') {
images.prepareImagesJQuery(articleWindow, true);
} else {
images.prepareImagesServiceWorker(true);
}
}
} else {
document.getElementById("printImageCheck").checked = false;
document.getElementById("printImageCheck").disabled = true;
}
//Remove max page-width restriction
if (params.removePageMaxWidth !== true) {
var tempPageMaxWidth = params.removePageMaxWidth;
params.removePageMaxWidth = true;
removePageMaxWidth();
params.removePageMaxWidth = tempPageMaxWidth;
}
//Put doc into light mode
params.cssTheme = 'light';
switchCSSTheme();
$("#printModal").modal({
backdrop: "static",
keyboard: true
});
}
//Establish some variables with global scope
var firstRun = false;
var localSearch = {};
function clearFindInArticle() {
if (document.getElementById('row2').style.display == "none") return;
if (typeof localSearch !== "undefined" && localSearch.remove) {
localSearch.remove();
}
document.getElementById('findInArticle').value = "";
document.getElementById('matches').innerHTML = "Full: 0";
document.getElementById('partial').innerHTML = "Partial: 0";
document.getElementById('row2').style.display = "none";
document.getElementById('findText').classList.remove("active");
}
document.getElementById('findText').addEventListener('click', function () {
var searchDiv = document.getElementById('row2');
if (searchDiv.style.display != "none") {
setTab();
// Return params.hideToolbars to its original state
params.hideToolbars = settingsStore.getItem('hideToolbars');
params.hideToolbars = params.hideToolbars === 'true' ? true : params.hideToolbars === 'false' ? false : params.hideToolbars;
checkToolbar();
return;
}
var findInArticle = null;
var innerDocument = window.frames[0].frameElement.contentDocument;
innerDocument = innerDocument ? innerDocument.body : null;
if (!innerDocument || innerDocument.innerHTML.length < 10) return;
setTab('findText');
findInArticle = document.getElementById('findInArticle');
searchDiv.style.display = "block";
// Show the toolbar
params.hideToolbars = false;
checkToolbar();
findInArticle.focus();
localSearch = new util.Hilitor(innerDocument);
//TODO: MatchType should be language specific
var timer = null;
findInArticle.addEventListener('keyup', function (e) {
//If user pressed Alt-F or Ctrl-F, exit
if ((e.altKey || e.ctrlKey) && e.which == 70) return;
var val = this.value;
//If user pressed enter / return key
if (val && e.which == 13) {
localSearch.scrollFrom = localSearch.scrollToFullMatch(val, localSearch.scrollFrom);
return;
}
//If value hasn't changed, exit
if (val == localSearch.lastScrollValue) return;
findInArticleKeyup(val);
});
var findInArticleKeyup = function (val) {
// Use a timeout, so that very quick typing does not cause a lot of overhead
if (window.timeoutFIAKeyup) {
window.clearTimeout(window.timeoutFIAKeyup);
}
window.timeoutFIAKeyup = window.setTimeout(function () {
findInArticleInitiate(val);
}, 500);
};
var findInArticleInitiate = function (val) {
//Ensure nothing happens if only one or two ASCII values have been entered (search is not specific enough)
//if no value has been entered (clears highlighting if user deletes all values in search field)
if (!/^\s*[A-Za-z\s]{1,2}$/.test(val)) {
localSearch.scrollFrom = 0;
localSearch.lastScrollValue = val;
localSearch.setMatchType('open');
//Change matchType to 'left' if we are dealing with an ASCII language and a space has been typed
if (/\s/.test(val) && /(?:^|[\s\b])[A-Za-z]+(?:[\b\s]|$)/.test(val)) localSearch.setMatchType('left');
localSearch.apply(val);
if (val.length) {
var fullTotal = localSearch.countFullMatches(val);
var partialTotal = localSearch.countPartialMatches();
fullTotal = fullTotal > partialTotal ? partialTotal : fullTotal;
document.getElementById('matches').innerHTML = '<a id="scrollLink" href="#">Full: ' + fullTotal + '</a>';
document.getElementById('partial').innerHTML = "Partial: " + partialTotal;
document.getElementById('scrollLink').addEventListener('click', function () {
localSearch.scrollFrom = localSearch.scrollToFullMatch(val, localSearch.scrollFrom);
});
//Auto-scroll: TODO - consider making this an option
localSearch.scrollFrom = localSearch.scrollToFullMatch(val, localSearch.scrollFrom);
} else {
document.getElementById('matches').innerHTML = "Full: 0";
document.getElementById('partial').innerHTML = "Partial: 0";
}
}
};
});
document.getElementById('btnRandomArticle').addEventListener('click', function () {
// In jQuery mode, only load random content in iframe (not tab or window)
appstate.target = 'iframe';
setTab('btnRandomArticle');
//Re-enable top-level scrolling
goToRandomArticle();
});
document.getElementById('btnRescanDeviceStorage').addEventListener("click", function () {
var returnDivs = document.getElementsByClassName("returntoArticle");
for (var i = 0; i < returnDivs.length; i++) {
returnDivs[i].innerHTML = "";
}
params.rescan = true;
//Reload any ZIM files in local storage (whcih the usar can't otherwise select with the filepicker)
loadPackagedArchive();
if (storages.length) {
searchForArchivesInStorage();
} else {
displayFileSelect();
}
});
// Bottom bar :
// @TODO Since bottom bar now hidden in Settings and About the returntoArticle code cannot be accessed;
// consider adding it to top home button instead
document.getElementById('btnBack').addEventListener('click', function () {
if (document.getElementById('articleContent').style.display == "none") {
document.getElementById('returntoArticle').click();
return;
}
clearFindInArticle();
history.back();
return;
});
document.getElementById('btnForward').addEventListener('click', function () {
clearFindInArticle();
history.forward();
});
document.getElementById('articleContent').contentDocument.body.style.fontSize = params.relativeFontSize + "%";
document.getElementById('btnZoomin').addEventListener('click', function () {
params.relativeFontSize += 5;
var doc = document.getElementById('articleContent').contentDocument;
doc.body.style.fontSize = /-\/static\/main\.css/.test(doc.head.innerHTML) ? params.relativeFontSize * 1.5 + "%" : params.relativeFontSize + "%";
document.getElementById('lblZoom').innerHTML = params.relativeFontSize + "%";
document.getElementById('lblZoom').style = "position:absolute;right: " + window.innerWidth / 5 + "px;bottom:50px;z-index:50;";
setTimeout(function () {
document.getElementById('lblZoom').innerHTML = "";
}, 1000);
settingsStore.setItem('relativeFontSize', params.relativeFontSize, Infinity);
document.getElementById('articleContent').contentWindow.focus();
});
document.getElementById('btnZoomout').addEventListener('click', function () {
params.relativeFontSize -= 5;
var doc = document.getElementById('articleContent').contentDocument;
doc.body.style.fontSize = /-\/static\/main\.css/.test(doc.head.innerHTML) ? params.relativeFontSize * 1.5 + "%" : params.relativeFontSize + "%";
document.getElementById('lblZoom').innerHTML = params.relativeFontSize + "%";
document.getElementById('lblZoom').style = "position:absolute;right: " + window.innerWidth / 4 + "px;bottom:50px;z-index:50;";
setTimeout(function () {
document.getElementById('lblZoom').innerHTML = "";
}, 1000);
settingsStore.setItem('relativeFontSize', params.relativeFontSize, Infinity);
document.getElementById('articleContent').contentWindow.focus();
});
setRelativeUIFontSize(params.relativeUIFontSize);
document.getElementById('relativeUIFontSizeSlider').addEventListener('change', function () {
setRelativeUIFontSize(this.value);
});
function setRelativeUIFontSize(value) {
value = ~~value;
document.getElementById('spinnerVal').innerHTML = value + "%";
document.getElementById('search-article').style.fontSize = value + "%";
document.getElementById('relativeUIFontSizeSlider').value = value;
var forms = document.querySelectorAll('.form-control');
for (var i = 0; i < forms.length; i++) {
forms[i].style.fontSize = ~~(value * 14 / 100) + "px";
}
var buttons = document.getElementsByClassName('btn');
for (var i = 0; i < buttons.length; i++) {
buttons[i].style.fontSize = buttons[i].id == "reloadPackagedArchive" ? ~~(value * 10 / 100) + "px" : ~~(value * 14 / 100) + "px";
}
var heads = document.querySelectorAll("h1, h2, h3, h4");
for (var i = 0; i < heads.length; i++) {
var multiplier = 1;
var head = heads[i].tagName;
multiplier = head == "H4" ? 1.4 : head == "H3" ? 1.9 : head == "H2" ? 2.3 : head == "H1" ? 2.8 : multiplier;
heads[i].style.fontSize = ~~(value * 0.14 * multiplier) + "px";
}
document.getElementById('displaySettingsDiv').scrollIntoView();
//document.getElementById('prefix').style.height = ~~(value * 14 / 100) * 1.4285 + 14 + "px";
if (value != params.relativeUIFontSize) {
params.relativeUIFontSize = value;
settingsStore.setItem('relativeUIFontSize', value, Infinity);
}
}
document.getElementById('btnHomeBottom').addEventListener('click', function () {
document.getElementById('btnHome').click();
});
document.getElementById('btnTop').addEventListener('click', function () {
var header = document.getElementById('top');
var iframe = document.getElementById('articleContent');
// If the toolbar is hidden, show it instead of jumping to top
if (!/\(0p?x?\)/.test(header.style.transform)) {
header.style.transform = 'translateY(0)';
} else {
if (!params.hideToolbars) iframe.style.transform = 'translateY(-1px)';
iframe.contentWindow.scrollTo({
top: '0',
behavior: 'smooth'
});
document.getElementById('search-article').scrollTop = 0;
}
iframe.contentWindow.focus();
});
// Top menu :
document.getElementById('btnHome').addEventListener('click', function () {
// In jQuery mode, only load landing page in iframe (not tab or window)
appstate.target = 'iframe';setTab('btnHome');
document.getElementById('search-article').scrollTop = 0;
$('#articleContent').contents().empty();
$('#searchingArticles').hide();
$('#welcomeText').show();
if (appstate.selectedArchive !== null && appstate.selectedArchive.isReady()) {
$('#welcomeText').hide();
goToMainArticle();
}
});
function setTab(activeBtn) {
// Highlight the selected section in the navbar
$('#liHomeNav').attr("class", "active");
$('#liConfigureNav').attr("class", "");
$('#liAboutNav').attr("class", "");
if ($('#navbarToggle').is(":visible") && $('#liHomeNav').is(':visible')) {
$('#navbarToggle').click();
}
setActiveBtn(activeBtn);
var btnAbout = document.getElementById('btnAbout');
if (!activeBtn || activeBtn == "btnHome" || activeBtn == "findText") {
btnAbout.innerHTML = '<span class="glyphicon glyphicon-print"></span>';
btnAbout.title = 'Ctrl-P: Print';
} else {
btnAbout.innerHTML = '<span class="glyphicon glyphicon-info-sign"></span>';
btnAbout.title = 'About';
}
clearFindInArticle();
//Re-enable bottom toolbar display
document.getElementById('footer').style.display = "block";
//Re-enable top-level scrolling
document.getElementById('top').style.position = "relative";
//Use the "light" navbar if the content is "light" (otherwise it looks shite....)
var determinedTheme = cssUIThemeGetOrSet(params.cssUITheme);
var determinedWikiTheme = params.cssTheme == 'auto' ? determinedTheme : params.cssTheme == 'inverted' ? 'dark' : params.cssTheme;
if (determinedWikiTheme != determinedTheme) {
if (determinedWikiTheme == "light" && (!activeBtn || activeBtn == "btnHome" || activeBtn == "findText") ||
determinedWikiTheme == "dark" && activeBtn && activeBtn != "btnHome" && activeBtn != "findText") {
cssUIThemeGetOrSet("light");
} else {
cssUIThemeGetOrSet("dark");
}
} else {
cssUIThemeGetOrSet(determinedTheme);
}
if (typeof Windows !== 'undefined' || typeof window.showOpenFilePicker !== 'undefined') {
document.getElementById('openLocalFiles').style.display = params.rescan ? "block" : "none";
}
document.getElementById('libraryArea').style.borderColor = '';
document.getElementById('libraryArea').style.borderStyle = '';
var currentArchive = document.getElementById('currentArchive');
if (params.packagedFile && params.storedFile && params.storedFile !== params.packagedFile) {
currentArchive.innerHTML = "Currently loaded archive: <b>" + params.storedFile.replace(/\.zim$/i, "") + "</b>";
currentArchive.style.display = "block";
document.getElementById('downloadLinksText').style.display = "none";
document.getElementById('moreInfo').style.display = "none";
}
if (params.storedFile && params.storedFile == params.packagedFile) {
document.getElementById('downloadLinksText').style.display = "block";
currentArchive.style.display = "none";
}
// Populate version info
var versionSpans = document.getElementsByClassName('version');
for (var i = 0; i < versionSpans.length; i++) {
versionSpans[i].innerHTML = i ? params.version : params.version.replace(/\s+.*$/, "");
}
if (params.fileVersion && /UWP|Electron/.test(params.appType)) {
var packagedInfoParas = document.getElementsByClassName('packagedInfo');
var fileVersionDivs = document.getElementsByClassName('fileVersion');
for (i = 0; i < fileVersionDivs.length; i++) {
packagedInfoParas[i].style.display = 'block';
fileVersionDivs[i].innerHTML = i ? params.fileVersion.replace(/\s+.+$/, '') : params.fileVersion;
}
}
var update = document.getElementById('update');
if (update) document.getElementById('logUpdate').innerHTML = update.innerHTML.match(/<ul[^>]*>[\s\S]+/i);
var features = document.getElementById('features');
if (features) document.getElementById('logFeatures').innerHTML = features.innerHTML;
// Show the selected content in the page
$('#about').hide();
$('#configuration').hide();
$('#formArticleSearch').show();
if (!activeBtn || activeBtn == 'btnHome') {
// document.getElementById('search-article').scrollTop = 0;
document.getElementById('scrollbox').style.height = 0;
document.getElementById('search-article').style.overflowY = 'hidden';
setTimeout(function() {
if (appstate.target === 'iframe') {
if (articleContainer) articleContainer.style.display = 'block';
if (articleWindow) articleWindow.focus();
}
}, 50);
}
$("#articleList").empty();
$('#articleListHeaderMessage').empty();
$('#articleListWithHeader').hide();
$("#prefix").val("");
$("#searchingArticles").hide();
$("#welcomeText").hide();
if (params.beforeinstallpromptFired) {
var divInstall1 = document.getElementById('divInstall1');
if (activeBtn !== 'btnConfigure' && !params.installLater && (params.pagesLoaded === 3 || params.pagesLoaded === 9)) {
divInstall1.style.display = 'block';
setTimeout(function() {
// If installLater is now true, then the user clicked the Later button and the timeout in init.js will hide the display
if (!params.installLater) {
divInstall1.style.display = 'none';
resizeIFrame();
}
}, 9000);
} else {
divInstall1.style.display = 'none';
}
}
// Check for upgrade of PWA
if (!params.upgradeNeeded && /PWA/.test(params.appType) && activeBtn === 'btnConfigure') {
caches.keys().then(function (keyList) {
if (keyList.length < 2) document.getElementById('alertBoxPersistent').innerHTML = '';
keyList.forEach(function(key) {
if (key === 'kiwix-precache-' + params.version) return;
// If we get here, then there is a cache key that does not match our version, i.e. a PWA-in-waiting
params.upgradeNeeded = true;
document.getElementById('alertBoxPersistent').innerHTML =
'<div id="upgradeAlert" class="alert alert-info alert-dismissible">\n' +
' <a href="#" class="close" data-dismiss="alert" aria-label="close">&times;</a>\n' +
' <span id="persistentMessage"></span>\n' +
'</div>\n';
var loadOrInstall = params.PWAInstalled ? 'install' : 'load';
document.getElementById('persistentMessage').innerHTML = 'Version ' + key.replace(/kiwix-precache-/, '') + ' is ready to '
+ loadOrInstall + '! (Re-launch app to ' + loadOrInstall + '.)';
});
});
} else if (params.upgradeNeeded) {
var upgradeAlert = document.getElementById('upgradeAlert');
if (upgradeAlert) upgradeAlert.style.display = 'block';
}
setTimeout(resizeIFrame, 100);
}
function setActiveBtn(activeBtn) {
document.getElementById('btnHome').classList.remove("active");
document.getElementById('btnRandomArticle').classList.remove("active");
document.getElementById('btnConfigure').classList.remove("active");
document.getElementById('btnAbout').classList.remove("active");
if (activeBtn) {
var activeID = document.getElementById(activeBtn);
if (activeID) activeID.classList.add("active");
}
}
document.getElementById('btnConfigure').addEventListener('click', function () {
var searchDiv = document.getElementById('configuration');
if (searchDiv.style.display !== 'none') {
setTab();
if (params.themeChanged) {
params.themeChanged = false;
var archiveName = appstate.selectedArchive ? appstate.selectedArchive._file._files[0].name : null;
if (archiveName && ~params.lastPageVisit.indexOf(archiveName)) {
goToArticle(params.lastPageVisit.replace(/@kiwixKey@.+$/, ''));
}
//if (history.state !== null) {
// var thisURL = decodeURIComponent(history.state.title);
// goToArticle(thisURL);
//}
}
return;
}
$('.alert').hide();
setTab('btnConfigure');
// Highlight the selected section in the navbar
$('#liHomeNav').attr("class", "");
$('#liConfigureNav').attr("class", "active");
$('#liAboutNav').attr("class", "");
if ($('#navbarToggle').is(":visible") && $('#liHomeNav').is(':visible')) {
$('#navbarToggle').click();
}
//Hide footer toolbar
document.getElementById('footer').style.display = "none";
// Show the selected content in the page
$('#configuration').show();
$('#articleContent').hide();
$('#downloadLinks').hide();
$('#serverResponse').hide();
$('#myModal').hide();
refreshAPIStatus();
//Re-enable top-level scrolling
document.getElementById('scrollbox').style.height = window.innerHeight - document.getElementById('top').getBoundingClientRect().height + 'px';
document.getElementById('search-article').style.overflowY = "auto";
if (document.getElementById('openLocalFiles').style.display == "none") {
document.getElementById('rescanStorage').style.display = "block";
}
//If user hadn't previously picked a folder or a file, resort to the local storage folder (UWP functionality)
if (params.localStorage && !params.pickedFolder && !params.pickedFile) {
params.pickedFolder = params.localStorage;
}
if (typeof Windows === 'undefined' && typeof window.showOpenFilePicker === 'undefined') {
//If not UWP, display legacy File Select
document.getElementById('archiveFile').style.display = "none";
document.getElementById('archiveFiles').style.display = "none";
document.getElementById('UWPInstructions').style.display = "none";
document.getElementById('archivesFound').style.display = "none";
document.getElementById('instructions').style.display = "block";
document.getElementById('archiveFilesLegacy').style.display = "inline";
document.getElementById('archiveFilesLegacy').addEventListener('change', setLocalArchiveFromFileSelect);
}
document.getElementById('chooseArchiveFromLocalStorage').style.display = "block";
// If user had previously picked a file using Native FS, offer to re-open
if (typeof window.showOpenFilePicker !== 'undefined' && !(params.pickedFile || params.pickedFolder)) {
getNativeFSHandle();
}
});
function getNativeFSHandle(callback) {
cache.idxDB('pickedFSHandle', function(val) {
if (val) {
var handle = val;
return cache.verifyPermission(handle, false).then(function(accessible) {
if (accessible) {
if (callback) {
callback(handle);
return;
}
if (handle.kind === 'file') {
return processNativeFileHandle(handle);
} else if (handle.kind === 'directory') {
return processNativeDirHandle(handle);
}
} else {
if (callback) {
callback(handle);
} else {
searchForArchivesInPreferencesOrStorage();
}
}
});
} else {
if (callback) {
callback(null);
} else {
searchForArchivesInPreferencesOrStorage();
}
}
});
}
document.getElementById('btnAbout').addEventListener('click', function () {
var btnAboutElement = document.getElementById('btnAbout');
if (/glyphicon-print/.test(btnAboutElement.innerHTML)) {
printIntercept();
return;
}
//Check if we're 'unclicking' the button
var searchDiv = document.getElementById('about');
if (searchDiv.style.display != 'none') {
setTab();
return;
}
// Highlight the selected section in the navbar
$('#liHomeNav').attr("class", "");
$('#liConfigureNav').attr("class", "");
$('#liAboutNav').attr("class", "active");
if ($('#navbarToggle').is(":visible") && $('#liHomeNav').is(':visible')) {
$('#navbarToggle').click();
}
setTab('btnAbout');
//Hide footer toolbar
document.getElementById('footer').style.display = "none";
// Show the selected content in the page
$('#about').show();
$('#articleContent').hide();
$('.alert').hide();
//Re-enable top-level scrolling
document.getElementById('scrollbox').style.height = window.innerHeight - document.getElementById('top').getBoundingClientRect().height + 'px';
document.getElementById('search-article').style.overflowY = "auto";
});
var selectFired = false;
document.getElementById('archiveList').addEventListener('keydown', function(e) {
if (/^Enter$/.test(e.key)) {
selectArchive(e);
}
});
document.getElementById('archiveList').addEventListener('mousedown', selectArchive);
function selectArchive(list) {
if (selectFired) return;
// If nothing was selected, user will have to click again
if (!list.target.value) return;
selectFired = true;
var selected = list.target.value;
// Void any previous picked file to prevent it launching
if (params.pickedFile && params.pickedFile.name !== selected) {
params.pickedFile = '';
}
if (params.pickedFile.readMode !== 'electron' && typeof window.showOpenFilePicker !== 'undefined') {
getNativeFSHandle(function(handle) {
if (!handle) {
console.error('No handle was retrieved');
uiUtil.systemAlert('We could not get a handle to the previously picked file or folder!\n' +
'This is probably because the contents of the folder have changed. Please try picking it again.');
document.getElementById('openLocalFiles').style.display = 'block';
return;
}
if (handle.kind === 'directory') {
params.pickedFolder = handle;
setLocalArchiveFromArchiveList(selected);
} else if (handle.kind === 'file') {
handle.getFile().then(function(file) {
params.pickedFile = file;
params.pickedFile.handle = handle;
setLocalArchiveFromArchiveList(selected);
}).catch(function(err) {
console.error('Unable to read previously picked file!', err);
uiUtil.systemAlert('We could not retrieve the previously picked file or folder!\nPlease try picking it again.');
document.getElementById('openLocalFiles').style.display = 'block';
});
}
});
} else {
setLocalArchiveFromArchiveList(selected);
}
setTimeout(function () {
document.getElementById('openLocalFiles').style.display = 'none';
document.getElementById('moreInfo').style.display = 'none';
selectFired = false;
}, 0);
}
document.getElementById('archiveFile').addEventListener('click', function () {
if (typeof Windows !== 'undefined' && typeof Windows.Storage !== 'undefined') {
//UWP FilePicker
pickFileUWP();
} else if (typeof window.showOpenFilePicker !== 'undefined') {
// Native File System API file picker
pickFileNativeFS();
//@TODO enable and provide classic filepicker
}
});
document.getElementById('archiveFiles').addEventListener('click', function () {
if (typeof Windows !== 'undefined' && typeof Windows.Storage !== 'undefined') {
//UWP FolderPicker
pickFolderUWP();
} else if (typeof window.showOpenFilePicker !== 'undefined') {
// Native File System API folder picker
pickFolderNativeFS();
}
});
document.getElementById('downloadTrigger').addEventListener('click', function () {
kiwixServe.requestXhttpData(params.kiwixDownloadLink);
});
$('input:radio[name=contentInjectionMode]').on('change', function (e) {
var returnDivs = document.getElementsByClassName("returntoArticle");
for (var i = 0; i < returnDivs.length; i++) {
returnDivs[i].innerHTML = "";
}
// Do the necessary to enable or disable the Service Worker
setContentInjectionMode(this.value);
// If we're in a PWA UWP app, warn the user that this does not disable the PWA
if (this.value === 'jquery' && /^http/i.test(window.location.protocol) && /UWP\|PWA/.test(params.appType) &&
settingsStore.getItem('allowInternetAccess') === 'true') {
uiUtil.systemAlert(
'Please note that switching content injection mode does not revert to local code.\n' +
'If you wish to exit the PWA, you will need to turn off "Allow Internet access?" above.'
);
}
params.themeChanged = true; // This will reload the page
});
$('input:checkbox[name=allowInternetAccess]').on('change', function (e) {
document.getElementById('serverResponse').style.display = "none";
params.allowInternetAccess = this.checked;
if (!this.checked) {
document.getElementById('downloadLinks').style.display = "none";
if (/^http/i.test(window.location.protocol)) {
var message;
if (!/PWA/.test(params.appType)) {
message = 'You are accessing Kiwix JS from a remote server, and it is not possible to disable Internet access fully without exiting the app.\n' +
'Please visit https://github.com/kiwix/kiwix-js-windows/releases/ to find an app version that will run offline.';
uiUtil.systemAlert(message);
this.checked = true;
params.allowInternetAccess = true;
return;
} else if (!/UWP/.test(params.appType)) {
uiUtil.systemAlert("This PWA can run offline, but to be absolutely sure that it won't contact the server to update itself, you should shut " +
'off the Internet connection on your computer. By design, the PWA spec allows an offline app to check whether the Service Worker ' +
'code has changed, and this app cannot override that completely.');
} else {
message = 'This will switch to using locally packaged code only. Configuration settings may be lost.\n\n' +
'WARNING: App will re-load in jQuery mode!';
var launchLocal = function () {
settingsStore.setItem('allowInternetAccess', false, Infinity);
var uriParams = '?allowInternetAccess=false&contentInjectionMode=jquery';
uriParams += '&listOfArchives=' + encodeURIComponent(settingsStore.getItem('listOfArchives'));
uriParams += '&lastSelectedArchive=' + encodeURIComponent(params.storedFile);
uriParams += '&lastPageVisit=' + encodeURIComponent(params.lastPageVisit);
window.location.href = 'ms-appx-web:///www/index.html' + uriParams;
throw 'Beam me down, Scotty!';
};
uiUtil.systemAlert(message, 'Warning!', 'Reload app', launchLocal, 'Cancel', function () {
this.checked = true;
params.allowInternetAccess = true;
document.getElementById('btnConfigure').click();
});
}
}
settingsStore.setItem('allowInternetAccess', false, Infinity);
}
});
$('input:checkbox[name=cssCacheMode]').on('change', function (e) {
params.cssCache = this.checked ? true : false;
settingsStore.setItem('cssCache', params.cssCache, Infinity);
params.themeChanged = true;
});
document.getElementById('navButtonsPosCheck').addEventListener('change', function(e) {
params.navButtonsPos = e.target.checked ? 'top' : 'bottom';
settingsStore.setItem('navButtonsPos', params.navButtonsPos, Infinity);
uiUtil.systemAlert('This setting will be applied on next app launch');
});
$('input:checkbox[name=imageDisplayMode]').on('change', function (e) {
params.imageDisplay = this.checked ? true : false;
params.imageDisplayMode = this.checked ? 'progressive' : 'manual';
params.themeChanged = params.imageDisplay; //Only reload page if user asked for all images to be displayed
settingsStore.setItem('imageDisplay', params.imageDisplay, Infinity);
});
$('input:checkbox[name=hideActiveContentWarning]').on('change', function (e) {
params.hideActiveContentWarning = this.checked ? true : false;
settingsStore.setItem('hideActiveContentWarning', params.hideActiveContentWarning, Infinity);
});
document.getElementById('tabOpenerCheck').addEventListener('click', function () {
params.windowOpener = this.checked ? 'tab' : false;
if (params.windowOpener && /UWP\|PWA/.test(params.appType) && params.contentInjectionMode === 'jquery') {
uiUtil.systemAlert('In this UWP app, opening a new browsable window only works in Service Worker mode.\n' +
'Your system appears to support SW mode, so please try switching to it in Expert Settings below.\n' +
'If your system does not support SW mode, then use the more basic "breakout link" feature below.');
}
if (params.windowOpener && params.allowHTMLExtraction) {
uiUtil.systemAlert('Enabling this option disables the more basic breakout link option below');
document.getElementById('allowHTMLExtractionCheck').click();
}
if (params.windowOpener && /UWP$/.test(params.appType)) {
uiUtil.systemAlert('This option is not currently supported in UWP apps that cannot use Service Worker mode.\n' +
'Please switch to the more basic "breakout link" feature below instead.');
params.windowOpener = false;
} else {
settingsStore.setItem('windowOpener', params.windowOpener, Infinity);
}
setWindowOpenerUI();
params.themeChanged = true;
});
document.getElementById('winOpenerCheck').addEventListener('click', function () {
var tabCheck = document.getElementById('tabOpenerCheck');
params.windowOpener = this.checked ? 'window' : tabCheck.checked ? 'tab' : false;
settingsStore.setItem('windowOpener', params.windowOpener, Infinity);
setWindowOpenerUI();
});
function setWindowOpenerUI() {
var woHelp = document.getElementById('winOpenerHelp');
var newWin = document.getElementById('openInNewWindow');
var tabCheck = document.getElementById('tabOpenerCheck');
var winCheck = document.getElementById('winOpenerCheck');
if (params.windowOpener === 'window') {
newWin.style.display = 'block';
woHelp.style.display = 'block';
tabCheck.checked = true;
winCheck.checked = true;
woHelp.innerHTML = 'If blocked, allow popups permanently for this app and try again. May not work in mobile contexts.';
} else if (params.windowOpener === 'tab') {
tabCheck.checked = true;
winCheck.checked = false;
newWin.style.display = 'block';
woHelp.style.display = 'block';
woHelp.innerHTML = 'In some cases a window may open regardless of this setting. May not work in mobile contexts.';
} else { // The options are turned off
tabCheck.checked = false;
winCheck.checked = false;
woHelp.style.display = 'none';
newWin.style.display = 'none';
}
// if (params.contentInjectionMode === 'serviceworker') {
// woHelp.innerHTML = 'These settings have no effect in ServiceWorker mode because opening new tabs or windows ' +
// 'is handled natively with right-click or ctrl-click. Turn settings off to hide this message.';
// } // NB this is not true for the kiwix-js-windows app
}
document.getElementById('allowHTMLExtractionCheck').addEventListener('change', function (e) {
params.allowHTMLExtraction = e.target.checked;
if (params.windowOpener && params.allowHTMLExtraction) {
uiUtil.systemAlert('Enabling this option disables the more advanced tab/window opening option above');
params.windowOpener = false;
settingsStore.setItem('windowOpener', params.windowOpener, Infinity);
setWindowOpenerUI();
}
settingsStore.setItem('allowHTMLExtraction', params.allowHTMLExtraction, Infinity);
params.themeChanged = true;
});
$('input:text[name=alphaChar]').on('change', function (e) {
params.alphaChar = this.value.length == 1 ? this.value : params.alphaChar;
this.value = params.alphaChar;
settingsStore.setItem('alphaChar', params.alphaChar, Infinity);
});
$('input:text[name=omegaChar]').on('change', function (e) {
params.omegaChar = this.value.length == 1 ? this.value : params.omegaChar;
this.value = params.omegaChar;
settingsStore.setItem('omegaChar', params.omegaChar, Infinity);
});
$('input:text[name=maxResults]').on('change', function (e) {
params.maxResults = this.value > 5 ? this.value : 5;
params.maxResults = params.maxResults < 50 ? params.maxResults : 50;
this.value = params.maxResults;
settingsStore.setItem('maxResults', params.maxResults, Infinity);
});
document.getElementById('hideToolbarsCheck').addEventListener('click', function () {
// This code implements a tri-state checkbox
// DEV: You cannot use jQuery to add the click event listener above: it doesn't work properly!
if (this.readOnly) this.checked = this.readOnly = false;
else if (!this.checked) this.readOnly = this.indeterminate = true;
// How to reverse the order of the checkbox
// if (this.readOnly) { this.checked = true; this.readOnly = false; }
// else if (this.checked) this.readOnly = this.indeterminate = true;
params.hideToolbars = this.indeterminate ? "top" : this.checked;
document.getElementById('hideToolbarsState').innerHTML = params.hideToolbars == "top" ? "top only" : params.hideToolbars ? "both" : "never";
settingsStore.setItem('hideToolbars', params.hideToolbars, Infinity);
checkToolbar();
});
document.getElementById('modesLink').addEventListener('click', function () {
document.getElementById('btnAbout').click();
});
var iframe = document.getElementById('articleContent');
var header = document.getElementById('top');
var footer = document.getElementById('footer');
var prefix = document.getElementById('prefix');
var findInArticle = document.getElementById('findInArticle');
var navbarDim;
var footerDim;
var oldScrollY;
var newScrollY;
var throttle = 0;
var scrollFunction = function () {
if (throttle) return;
throttle = 1;
newScrollY = iframe.contentWindow.pageYOffset;
// Hide the toolbars if user has scrolled and search elements are not selected
if (newScrollY - oldScrollY > 0 && document.activeElement !== prefix
&& document.activeElement !== findInArticle) {
// If the header and/or footer have not already been hidden
if (/\(0p?x?\)/.test(header.style.transform)) {
throttle = 2;
setTimeout(function() {
if (newScrollY > navbarDim.height) {
header.style.transform = 'translateY(-' + (navbarDim.height - 2) + 'px)';
if (params.hideToolbars === true) // Only hide footer if requested
footer.style.transform = 'translateY(' + (footerDim.height - 2) + 'px)';
}
throttle = 0;
}, 200);
}
} else if (newScrollY - oldScrollY < 0) {
header.style.zIndex = 1;
header.style.transform = 'translateY(0)';
footer.style.transform = 'translateY(0)';
}
oldScrollY = newScrollY;
throttle = throttle < 2 ? 0 : throttle;
};
function checkToolbar() {
oldScrollY = iframe.contentWindow.pageYOffset;
navbarDim = document.getElementById('navbar').getBoundingClientRect();
footerDim = footer.getBoundingClientRect();
var doc = iframe.contentDocument ? iframe.contentDocument.documentElement : null;
header.style.transition = "transform 500ms";
iframe.style.transition = "transform 500ms";
if (doc) doc.style.transition = "transform 500ms";
footer.style.transition = "transform 500ms";
iframe.style.zIndex = 0;
iframe.contentDocument.removeEventListener('scroll', scrollFunction);
if (params.hideToolbars) {
// Shift the iframe up and the document down, and increase height of iframe
iframe.style.height = window.innerHeight + navbarDim +
(params.hideToolbars === true ? footerDim.height : 0) + 'px';
iframe.style.transform = 'translateY(-' + navbarDim.height + 'px)';
if (doc) {
doc.style.transform = 'translateY(' + navbarDim.height + 'px)';
iframe.contentDocument.addEventListener('scroll', scrollFunction);
}
scrollFunction();
} else {
// Ensure toolbar is restored
setTimeout(function () {
header.style.zIndex = 1;
header.style.transform = 'translateY(0)';
footer.style.transform = 'translateY(0)';
// DEV: Moving the iframe up by 1 pixel bizarrely solves the bug with the toolbar disappearing benath the iframe
iframe.style.transform = 'translateY(-1px)';
if (doc) doc.style.transform = 'translateY(0)';
iframe.style.height = window.innerHeight + 'px';
}, 500);
}
}
// Set up hook into Windows ViewManagement uiSettings if needed
var uiSettings = null;
initializeUISettings();
function initializeUISettings() {
var checkAuto = params.cssUITheme == 'auto' || params.cssTheme == 'auto';
// Support for UWP
if (checkAuto && typeof Windows !== 'undefined' && Windows.UI && Windows.UI.ViewManagement) {
uiSettings = new Windows.UI.ViewManagement.UISettings();
uiSettings.oncolorvalueschanged = function () {
if (params.cssUITheme == 'auto') cssUIThemeGetOrSet('auto');
if (params.cssTheme == 'auto') switchCSSTheme();
};
}
// Support for other contexts (Firefox, Chromium, Electron, NWJS)
if (checkAuto && window.matchMedia('(prefers-color-scheme)').media !== 'not all') {
uiSettings = window.matchMedia('(prefers-color-scheme:dark)');
uiSettings.onchange = function () {
if (params.cssUITheme == 'auto') cssUIThemeGetOrSet('auto');
if (params.cssTheme == 'auto') switchCSSTheme();
};
}
}
// Code below is needed on startup to show or hide the inverted dark theme checkbox;
// similar code also runs in switchCSSTheme(), but that is not evoked on startup
if (params.cssTheme == 'auto') document.getElementById('darkInvert').style.display = cssUIThemeGetOrSet('auto', true) == 'light' ? 'none' : 'inline';
document.getElementById('cssUIDarkThemeCheck').addEventListener('click', function () {
//This code implements a tri-state checkbox
if (this.readOnly) this.checked = this.readOnly = false;
else if (!this.checked) this.readOnly = this.indeterminate = true;
//Code below shows how to invert the order
//if (this.readOnly) { this.checked = true; this.readOnly = false; }
//else if (this.checked) this.readOnly = this.indeterminate = true;
params.cssUITheme = this.indeterminate ? "auto" : this.checked ? 'dark' : 'light';
if (!uiSettings) initializeUISettings();
settingsStore.setItem('cssUITheme', params.cssUITheme, Infinity);
document.getElementById('cssUIDarkThemeState').innerHTML = params.cssUITheme;
cssUIThemeGetOrSet(params.cssUITheme);
//Make subsequent check valid if params.cssTheme is "invert" rather than "dark"
if (params.cssUITheme != params.cssTheme) $('#cssWikiDarkThemeCheck').click();
});
document.getElementById('cssWikiDarkThemeCheck').addEventListener('click', function () {
if (this.readOnly) this.checked = this.readOnly = false;
else if (!this.checked) this.readOnly = this.indeterminate = true;
params.cssTheme = this.indeterminate ? "auto" : this.checked ? 'dark' : 'light';
if (!uiSettings) initializeUISettings();
var determinedValue = params.cssTheme;
if (params.cssTheme == "auto") determinedValue = cssUIThemeGetOrSet('auto', true);
if (determinedValue == "light") document.getElementById('footer').classList.remove("darkfooter");
if (params.cssTheme == "light") document.getElementById('cssWikiDarkThemeInvertCheck').checked = false;
if (determinedValue == "dark") document.getElementById('footer').classList.add("darkfooter");
document.getElementById('darkInvert').style.display = determinedValue == 'light' ? 'none' : 'inline';
params.cssTheme = document.getElementById('cssWikiDarkThemeInvertCheck').checked && determinedValue == 'dark' ? 'invert' : params.cssTheme;
document.getElementById('cssWikiDarkThemeState').innerHTML = params.cssTheme;
settingsStore.setItem('cssTheme', params.cssTheme, Infinity);
switchCSSTheme();
});
$('input:checkbox[name=cssWikiDarkThemeInvert]').on('change', function (e) {
if (this.checked) {
params.cssTheme = 'invert';
} else {
var darkThemeCheckbox = document.getElementById('cssWikiDarkThemeCheck');
params.cssTheme = darkThemeCheckbox.indeterminate ? 'auto' : darkThemeCheckbox.checked ? 'dark' : 'light';
}
settingsStore.setItem('cssTheme', params.cssTheme, Infinity);
switchCSSTheme();
});
function cssUIThemeGetOrSet(value, getOnly) {
if (value === 'auto') {
value = 'light'; // Default that most people expect
if (uiSettings) {
// We need to check the system theme
if (uiSettings.getColorValue) {
// Value 0 below is the 'background' constant in array Windows.UI.ViewManagement.UIColorType
var colour = uiSettings.getColorValue(0);
value = (colour.b + colour.g + colour.r) <= 382 ? 'dark' : 'light';
} else {
// Generic support for modern browser contexts
value = uiSettings.matches ? 'dark' : 'light';
}
}
}
if (getOnly) return value;
var elements;
if (value == 'dark') {
document.getElementsByTagName('body')[0].classList.add("dark");
document.getElementById('archiveFilesLegacy').classList.add("dark");
document.getElementById('footer').classList.add("darkfooter");
document.getElementById('archiveFilesLegacy').classList.remove("btn");
document.getElementById('findInArticle').classList.add("dark");
document.getElementById('prefix').classList.add("dark");
elements = document.querySelectorAll(".settings");
for (var i = 0; i < elements.length; i++) {
elements[i].style.border = "1px solid darkgray";
}
document.getElementById('kiwixIcon').src = /wikivoyage/i.test(params.storedFile) ? "img/icons/wikivoyage-white-32.png" : /medicine/i.test(params.storedFile) ? "img/icons/wikimed-lightblue-32.png" : "img/icons/kiwix-32.png";
if (/wikivoyage/i.test(params.storedFile)) document.getElementById('kiwixIconAbout').src = "img/icons/wikivoyage-90-white.png";
}
if (value == 'light') {
document.getElementsByTagName('body')[0].classList.remove("dark");
document.getElementById('search-article').classList.remove("dark");
document.getElementById('footer').classList.remove("darkfooter");
document.getElementById('archiveFilesLegacy').classList.remove("dark");
document.getElementById('archiveFilesLegacy').classList.add("btn");
document.getElementById('findInArticle').classList.remove("dark");
document.getElementById('prefix').classList.remove("dark");
elements = document.querySelectorAll(".settings");
for (var i = 0; i < elements.length; i++) {
elements[i].style.border = "1px solid black";
}
document.getElementById('kiwixIcon').src = /wikivoyage/i.test(params.storedFile) ? "img/icons/wikivoyage-black-32.png" : /medicine/i.test(params.storedFile) ? "img/icons/wikimed-blue-32.png" : "img/icons/kiwix-blue-32.png";
if (/wikivoyage/i.test(params.packagedFile)) document.getElementById('kiwixIconAbout').src = "img/icons/wikivoyage-90.png";
}
return value;
}
function switchCSSTheme() {
var doc = window.frames[0].frameElement.contentDocument;
var treePath = params.lastPageVisit.replace(/[^/]+\/(?:[^/]+$)?/g, "../");
//If something went wrong, use the page reload method
if (!treePath) {
params.themeChanged = true;
return;
}
var styleSheets = doc.getElementsByTagName("link");
//Remove any dark theme, as we don't know whether user switched from light to dark or from inverted to dark, etc.
for (var i = styleSheets.length - 1; i > -1; i--) {
if (~styleSheets[i].href.search(/\/style-dark/)) {
styleSheets[i].disabled = true;
styleSheets[i].parentNode.removeChild(styleSheets[i]);
}
}
var determinedWikiTheme = params.cssTheme == 'auto' ? cssUIThemeGetOrSet('auto', true) : params.cssTheme;
var breakoutLink = doc.getElementById('breakoutLink');
// Construct an absolute reference becuase Service Worker needs this
var prefix = (window.location.protocol + '//' + window.location.host + window.location.pathname).replace(/\/[^/]*$/, '');
if (determinedWikiTheme != "light") {
var link = doc.createElement("link");
link.setAttribute("rel", "stylesheet");
link.setAttribute("type", "text/css");
link.setAttribute("href", prefix + (determinedWikiTheme == "dark" ? '/-/s/style-dark.css' : '/-/s/style-dark-invert.css'));
doc.head.appendChild(link);
if (breakoutLink) breakoutLink.src = prefix + '/img/icons/new_window_lb.svg';
} else {
if (breakoutLink) breakoutLink.src = prefix + '/img/icons/new_window.svg';
}
document.getElementById('darkInvert').style.display = determinedWikiTheme == 'light' ? 'none' : 'inline';
}
$('input:checkbox[name=rememberLastPage]').on('change', function (e) {
if (params.rememberLastPage && this.checked) document.getElementById('rememberLastPageCheck').checked = true;
params.rememberLastPage = this.checked ? true : false;
settingsStore.setItem('rememberLastPage', params.rememberLastPage, Infinity);
if (!params.rememberLastPage) {
settingsStore.setItem('lastPageVisit', "", Infinity);
// DEV: replace this with cache.clear when you have repaired that method
cache.setArticle(params.lastPageVisit.replace(/.+@kiwixKey@/, ''), params.lastPageVisit.replace(/@kiwixKey@.+/, ''), '', function(){});
params.lastPageHTML = "";
}
});
$('input:radio[name=cssInjectionMode]').on('click', function (e) {
params.cssSource = this.value;
settingsStore.setItem('cssSource', params.cssSource, Infinity);
params.themeChanged = true;
});
document.getElementById('removePageMaxWidthCheck').addEventListener('click', function () {
//This code implements a tri-state checkbox
if (this.readOnly) this.checked = this.readOnly = false;
else if (!this.checked) this.readOnly = this.indeterminate = true;
params.removePageMaxWidth = this.indeterminate ? "auto" : this.checked;
document.getElementById('pageMaxWidthState').innerHTML = (params.removePageMaxWidth == "auto" ? "auto" : params.removePageMaxWidth ? "always" : "never");
settingsStore.setItem('removePageMaxWidth', params.removePageMaxWidth, Infinity);
removePageMaxWidth();
});
/**
* Removes the WikiMedia max-page-width restrictions either by operating on an HTML string, or by using
* DOM methods on the articleWindow. If the parameters are empty, DOM methods are used.
*
* @param {String} html An optional HTML string on which to operate
* @param {Function} callback A function to call with the transformed string
* @returns {String} A string containing the transformed HTML
*/
function removePageMaxWidth(html) {
var zimType;
var cssSource;
if (!html) {
var doc = articleWindow.document;
if (!doc || !doc.head) return;
zimType = /<link\b[^>]+(?:minerva|mobile)/i.test(doc.head.innerHTML) ? "mobile" : "desktop";
cssSource = params.cssSource === "auto" ? zimType : params.cssSource;
var idArray = ["content", "bodyContent"];
for (var i = 0; i < idArray.length; i++) {
var contentElement = doc.getElementById(idArray[i]);
if (!contentElement) continue;
var docStyle = contentElement.style;
if (!docStyle) continue;
if (contentElement.className === "mw-body") {
docStyle.padding = "1em";
docStyle.border = "1px solid #a7d7f9";
}
if (params.removePageMaxWidth === "auto") {
docStyle.maxWidth = cssSource === "desktop" ? "100%" : window.innerWidth > 1024 ? "90%" : "55.8em";
docStyle.cssText = docStyle.cssText.replace(/(max-width[^;]+)/i, "$1 !important");
docStyle.border = "0";
} else {
docStyle.maxWidth = params.removePageMaxWidth ? "100%" : "55.8em";
docStyle.cssText = docStyle.cssText.replace(/(max-width[^;]+)/i, "$1 !important");
if (params.removePageMaxWidth || zimType == "mobile") docStyle.border = "0";
}
docStyle.margin = "0 auto";
}
if (doc.body && doc.body.classList.contains('article-list-home')) {
doc.body.style.padding = '2em';
}
} else {
// We shall transform the raw HTML
zimType = /<link\b[^>]+(?:minerva|mobile)/i.test(html) ? "mobile" : "desktop";
cssSource = params.cssSource === "auto" ? zimType : params.cssSource;
html = html.replace(/(id=["'](?:content|bodyContent)["'](?=[^>]*?mw-)[^>]*)/ig,
'$1 style="padding:1em; border:0; max-width:' +
(cssSource === 'desktop' || params.removePageMaxWidth === true ? '100%' : window.innerWidth > 1024 ? '90%' : '55.8em') +
' !important; margin: 0 auto;"');
html = html.replace(/(<body\b[^>]+?article-list-home[^>]+)/i, '$1 style="padding:2em;"');
return html;
}
}
document.getElementById('openAllSectionsCheck').addEventListener('click', function (e) {
params.openAllSections = this.checked;
settingsStore.setItem('openAllSections', params.openAllSections, Infinity);
if (params.contentInjectionMode === 'serviceworker') {
// We have to reload the article to respect user's choice
goToArticle(params.lastPageVisit.replace(/@[^@].+$/, ''));
return;
}
openAllSections();
});
$('input:radio[name=useMathJax]').on('click', function (e) {
params.useMathJax = /true/i.test(this.value);
settingsStore.setItem('useMathJax', params.useMathJax, Infinity);
params.themeChanged = true;
});
document.getElementById('otherLangs').addEventListener('click', function () {
if (!params.showFileSelectors) document.getElementById('displayFileSelectorsCheck').click();
var library = document.getElementById('libraryArea');
library.style.borderColor = 'red';
library.style.borderStyle = 'solid';
document.getElementById('downloadTrigger').addEventListener('mousedown', function () {
library.style.borderColor = '';
library.style.borderStyle = '';
});
});
$('input:checkbox[name=displayFileSelectors]').on('change', function (e) {
params.showFileSelectors = this.checked ? true : false;
document.getElementById('rescanStorage').style.display = "block";
document.getElementById('openLocalFiles').style.display = "none";
document.getElementById('hideFileSelectors').style.display = params.showFileSelectors ? "block" : "none";
document.getElementById('downloadLinksText').style.display = params.showFileSelectors ? "none" : "inline";
document.getElementById('moreInfo').style.display = params.showFileSelectors ? "none" : "inline";
if (params.packagedFile && params.storedFile && params.storedFile != params.packagedFile) {
var currentArchive = document.getElementById('currentArchive');
currentArchive.innerHTML = "Currently loaded archive: <b>" + params.storedFile.replace(/\.zim$/i, "") + "</b>";
currentArchive.style.display = params.showFileSelectors ? "none" : "block";
document.getElementById('downloadLinksText').style.display = params.showFileSelectors ? "none" : "block";
}
settingsStore.setItem('showFileSelectors', params.showFileSelectors, Infinity);
if (params.showFileSelectors) document.getElementById('configuration').scrollIntoView();
});
$(document).ready(function (e) {
// Set initial behaviour (see also init.js)
cssUIThemeGetOrSet(params.cssUITheme);
//@TODO - this is initialization code, and should be in init.js (withoug jQuery)
$('input:radio[name=cssInjectionMode]').filter('[value="' + params.cssSource + '"]').prop('checked', true);
//DEV this hides file selectors if it is a packaged file -- add your own packaged file test to regex below
if (params.packagedFile && !/wikipedia.en.100|ray.charles/i.test(params.fileVersion)) {
document.getElementById('packagedAppFileSelectors').style.display = "block";
document.getElementById('hideFileSelectors').style.display = "none";
//document.getElementById('downloadLinksText').style.display = "none";
if (params.showFileSelectors) {
document.getElementById('hideFileSelectors').style.display = "block";
document.getElementById('downloadLinksText').style.display = "inline";
}
}
//Code below triggers display of modal info box if app is run for the first time, or it has been upgraded to new version
if (settingsStore.getItem('version') !== params.version) {
firstRun = true;
// If we have an update and the last selected archive is the packaged file, it is best not to preserve last read article
// var packagedFileStub = params.packagedFile.replace(/_[\d-]+\.zim\w?\w?$/, '');
// if (~params.storedFile.indexOf(packagedFileStub)) {
// params.lastPageVisit = '';
// params.storedFile = params.packagedFile;
// } // THIS IS NOW DONE IN init.js
// Update the installed version
if (settingsStore.getItem('PWAInstalled')) {
params.PWAInstalled = params.version;
settingsStore.setItem('PWAInstalled', params.PWAInstalled);
}
// One-time cleanup of idxDB files to delete deprecated databases if possible
cache.idxDB('deleteNonCurrent', function (result) {
if (result === false) console.log('Unable to delete old idxDB databases (this is normal in non-Chromium browsers');
else console.log('Deleted ' + result + ' deprecated database(s).');
});
// On some platforms, bootstrap's jQuery functions have not been injected yet, so we have to run in a timeout
setTimeout(function () {
$('#myModal').modal({
backdrop: "static"
});
settingsStore.setItem('version', params.version, Infinity);
}, 1000);
}
});
/**
* Displays or refreshes the API status shown to the user
*/
function refreshAPIStatus() {
var apiStatusPanel = document.getElementById('apiStatusDiv');
apiStatusPanel.classList.remove('panel-success', 'panel-warning');
var apiPanelClass = 'panel-success';
if (isMessageChannelAvailable()) {
$('#messageChannelStatus').html("MessageChannel API available");
$('#messageChannelStatus').removeClass("apiAvailable apiUnavailable")
.addClass("apiAvailable");
} else {
apiPanelClass = 'panel-warning';
$('#messageChannelStatus').html("MessageChannel API unavailable");
$('#messageChannelStatus').removeClass("apiAvailable apiUnavailable")
.addClass("apiUnavailable");
}
if (isServiceWorkerAvailable()) {
if (isServiceWorkerReady()) {
$('#serviceWorkerStatus').html("ServiceWorker API available, and registered");
$('#serviceWorkerStatus').removeClass("apiAvailable apiUnavailable")
.addClass("apiAvailable");
} else {
apiPanelClass = 'panel-warning';
$('#serviceWorkerStatus').html("ServiceWorker API available, but not registered");
$('#serviceWorkerStatus').removeClass("apiAvailable apiUnavailable")
.addClass("apiUnavailable");
}
} else {
apiPanelClass = 'panel-warning';
$('#serviceWorkerStatus').html("ServiceWorker API unavailable");
$('#serviceWorkerStatus').removeClass("apiAvailable apiUnavailable")
.addClass("apiUnavailable");
}
apiStatusPanel.classList.add(apiPanelClass);
}
var keepAliveServiceWorkerHandle;
var serviceWorkerRegistration = null;
/**
* Send an 'init' message to the ServiceWorker with a new MessageChannel
* to initialize it, or to keep it alive.
* This MessageChannel allows a 2-way communication between the ServiceWorker
* and the application
*/
function initOrKeepAliveServiceWorker() {
if (params.contentInjectionMode === 'serviceworker') {
// Create a new messageChannel
var tmpMessageChannel = new MessageChannel();
tmpMessageChannel.port1.onmessage = handleMessageChannelMessage;
// Send the init message to the ServiceWorker, with this MessageChannel as a parameter
if (navigator.serviceWorker.controller) {
navigator.serviceWorker.controller.postMessage({
'action': 'init'
}, [tmpMessageChannel.port2]);
} else {
console.error('The Service Worker is active but is not controlling the current page! We have to reload.');
window.location.reload();
return;
}
messageChannel = tmpMessageChannel;
// Schedule to do it again regularly to keep the 2-way communication alive.
// See https://github.com/kiwix/kiwix-js/issues/145 to understand why
clearTimeout(keepAliveServiceWorkerHandle);
keepAliveServiceWorkerHandle = setTimeout(initOrKeepAliveServiceWorker, DELAY_BETWEEN_KEEPALIVE_SERVICEWORKER, false);
}
}
/**
* Sets the given injection mode.
* This involves registering (or re-enabling) the Service Worker if necessary
* It also refreshes the API status for the user afterwards.
*
* @param {String} value The chosen content injection mode : 'jquery' or 'serviceworker'
*/
function setContentInjectionMode(value) {
params.contentInjectionMode = value;
if (value === 'jquery') {
// Because the "outer" Service Worker still runs in a PWA app, we don't actually disable the SW in this context, but it will no longer
// be intercepting requests
if ('serviceWorker' in navigator) {
serviceWorkerRegistration = null;
}
refreshAPIStatus();
} else if (value === 'serviceworker') {
if (!isServiceWorkerAvailable()) {
uiUtil.systemAlert("The ServiceWorker API is not available on your device. Falling back to JQuery mode");
setContentInjectionMode('jquery');
return;
}
if (!isMessageChannelAvailable()) {
uiUtil.systemAlert("The MessageChannel API is not available on your device. Falling back to JQuery mode");
setContentInjectionMode('jquery');
return;
}
if (!isServiceWorkerReady()) {
$('#serviceWorkerStatus').html("ServiceWorker API available : trying to register it...");
if (navigator.serviceWorker.controller) {
console.log("Active service worker found, no need to register");
serviceWorkerRegistration = true;
refreshAPIStatus();
// Remove any jQuery hooks from a previous jQuery session
$('#articleContent').contents().remove();
// Create the MessageChannel and send 'init'
initOrKeepAliveServiceWorker();
} else {
navigator.serviceWorker.register('../pwabuilder-sw.js').then(function (reg) {
// The ServiceWorker is registered
console.log('Service worker is registered with a scope of ' + reg.scope);
serviceWorkerRegistration = reg;
refreshAPIStatus();
// We need to wait for the ServiceWorker to be activated
// before sending the first init message
var serviceWorker = reg.installing || reg.waiting || reg.active;
serviceWorker.addEventListener('statechange', function (statechangeevent) {
if (statechangeevent.target.state === 'activated') {
// Remove any jQuery hooks from a previous jQuery session
$('#articleContent').contents().remove();
// Create the MessageChannel
// and send the 'init' message to the ServiceWorker
initOrKeepAliveServiceWorker();
setWindowOpenerUI();
}
});
if (serviceWorker.state === 'activated') {
// Even if the ServiceWorker is already activated,
// We need to re-create the MessageChannel
// and send the 'init' message to the ServiceWorker
// in case it has been stopped and lost its context
initOrKeepAliveServiceWorker();
}
}).catch(function (err) {
console.error('error while registering serviceWorker', err);
refreshAPIStatus();
var message = "The ServiceWorker could not be properly registered. Switching back to jQuery mode. Error message : " + err;
var protocol = window.location.protocol;
if (protocol === 'moz-extension:') {
message += "\n\nYou seem to be using kiwix-js through a Firefox extension : ServiceWorkers are disabled by Mozilla in extensions.";
message += "\nPlease vote for https://bugzilla.mozilla.org/show_bug.cgi?id=1344561 so that some future Firefox versions support it";
} else if (protocol === 'file:') {
message += "\n\nYou seem to be opening kiwix-js with the file:// protocol. You should open it through a web server : either through a local one (http://localhost/...) or through a remote one (but you need SSL : https://webserver/...)";
} else if (protocol === 'ms-appx-web:') {
message = 'This UWP app uses locally packaged code by default. ' +
'To enable the Service Worker we need to switch to PWA mode, ' +
'which requires one-time access to our secure server to cache the PWA code.\n\n' +
'The app will be able to run offline in PWA mode, but will auto-update ' +
'periodically when online as per the Service Worker spec.\n\n' +
'You can switch back any time by toggling "Allow Internet access?" off.\n\n' +
'WARNING: This will attempt to access the following server: \n' + params.PWAServer;
var launchPWA = function () {
settingsStore.setItem('contentInjectionMode', 'serviceworker', Infinity);
// This is needed so that we get passthrough on subsequent launches
settingsStore.setItem('allowInternetAccess', true, Infinity);
var uriParams = '?allowInternetAccess=true';
// We are using allowInternetAccess as a passthrough, so we don't force a switch to SW mode on the server
// except on first launch of SW mode
uriParams += params.allowInternetAccess ? '' : '&contentInjectionMode=serviceworker';
uriParams += '&listOfArchives=' + encodeURIComponent(settingsStore.getItem('listOfArchives'));
uriParams += '&lastSelectedArchive=' + encodeURIComponent(params.storedFile);
uriParams += '&lastPageVisit=' + encodeURIComponent(params.lastPageVisit);
uriParams += params.packagedFile ? '&packagedFile=' + encodeURIComponent(params.packagedFile) : '';
uriParams += params.fileVersion ? '&fileVersion=' + encodeURIComponent(params.fileVersion) : '';
// Signal failure of PWA until it has successfully launched (in init.js it will be changed to 'success')
params.localUWPSettings.PWA_launch = 'fail';
window.location.href = params.PWAServer + 'www/index.html' + uriParams;
throw 'Beam me up, Scotty!';
};
var checkPWAIsOnline = function () {
uiUtil.checkServerIsAccessible(params.PWAServer + 'www/img/icons/kiwix-32.png', launchPWA, function () {
uiUtil.systemAlert('The server is not currently accessible! ' +
'\n\n(Kiwix needs one-time access to the server to cache the PWA).' +
'\nPlease try again when you have a stable Internet connection.', 'Error!');
});
};
if (settingsStore.getItem('allowInternetAccess') === 'true' && params.localUWPSettings.PWA_launch !== 'fail') {
if (params.localUWPSettings.PWA_launch === 'success') launchPWA();
else checkPWAIsOnline();
return;
} else {
if (params.localUWPSettings.PWA_launch === 'fail') {
message = 'The PWA MAY have failed to launch on the last attempt ' +
'(but this is usually a transitory error you can ignore).' +
'\n\nIn case it genuinely failed, try again by selecting Access server:';
}
uiUtil.systemAlert(message, 'Warning!', 'Access server', checkPWAIsOnline, 'Cancel', function () {
var allowAccessCheck = document.getElementById('allowInternetAccessCheck');
if (allowAccessCheck.checked) allowAccessCheck.click();
});
}
} else {
uiUtil.systemAlert(message, 'Information');
}
setContentInjectionMode("jquery");
return;
});
}
} else {
// We need to set this variable earlier else the ServiceWorker does not get reactivated
params.contentInjectionMode = value;
initOrKeepAliveServiceWorker();
}
}
$('input:radio[name=contentInjectionMode]').prop('checked', false);
$('input:radio[name=contentInjectionMode]').filter('[value="' + value + '"]').prop('checked', true);
params.contentInjectionMode = value;
// Save the value in a cookie, so that to be able to keep it after a reload/restart
settingsStore.setItem('contentInjectionMode', value, Infinity);
setWindowOpenerUI();
}
// At launch, we try to set the last content injection mode (stored in Settings Store)
var contentInjectionMode = settingsStore.getItem('contentInjectionMode');
if (contentInjectionMode) {
setContentInjectionMode(contentInjectionMode);
} else {
setContentInjectionMode('jquery');
}
/**
* Tells if the ServiceWorker API is available
* https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorker
* @returns {Boolean}
*/
function isServiceWorkerAvailable() {
return 'serviceWorker' in navigator;
}
/**
* Tells if the MessageChannel API is available
* https://developer.mozilla.org/en-US/docs/Web/API/MessageChannel
* @returns {Boolean}
*/
function isMessageChannelAvailable() {
try {
var dummyMessageChannel = new MessageChannel();
if (dummyMessageChannel) return true;
} catch (e) {
return false;
}
return false;
}
/**
* Tells if the ServiceWorker is registered, and ready to capture HTTP requests
* and inject content in articles.
* @returns {Boolean}
*/
function isServiceWorkerReady() {
// Return true if the serviceWorkerRegistration is not null and not undefined
return serviceWorkerRegistration;
}
/**
*
* @type Array.<StorageFirefoxOS>
*/
var storages = [];
function searchForArchivesInPreferencesOrStorage() {
// First see if the list of archives is stored in the cookie
var listOfArchivesFromCookie = settingsStore.getItem("listOfArchives");
if (listOfArchivesFromCookie !== null && listOfArchivesFromCookie !== undefined && listOfArchivesFromCookie !== "") {
var directories = listOfArchivesFromCookie.split('|');
populateDropDownListOfArchives(directories);
} else {
if (storages.length || params.localStorage) {
searchForArchivesInStorage();
} else {
displayFileSelect();
if (document.getElementById('archiveFiles').files && document.getElementById('archiveFiles').files.length > 0) {
// Archive files are already selected,
setLocalArchiveFromFileSelect();
} else {
var btnConfigure = document.getElementById('btnConfigure');
if (!btnConfigure.classList.contains('active')) btnConfigure.click();
}
}
}
}
function searchForArchivesInStorage() {
// If DeviceStorage is available, we look for archives in it
document.getElementById('btnConfigure').click();
$('#scanningForArchives').show();
if (params.localStorage && typeof Windows !== 'undefined' && typeof Windows.Storage !== 'undefined') {
scanUWPFolderforArchives(params.localStorage);
} else {
zimArchiveLoader.scanForArchives(storages, populateDropDownListOfArchives);
}
}
// @STORAGE AUTOLOAD STARTS HERE
if ($.isFunction(navigator.getDeviceStorages)) {
// The method getDeviceStorages is available (FxOS>=1.1)
storages = $.map(navigator.getDeviceStorages("sdcard"), function (s) {
return new abstractFilesystemAccess.StorageFirefoxOS(s);
});
}
if (storages !== null && storages.length > 0 ||
typeof Windows !== 'undefined' && typeof Windows.Storage !== 'undefined' ||
typeof window.fs !== 'undefined' || typeof window.showOpenFilePicker !== 'undefined') {
// Make a fake first access to device storage, in order to ask the user for confirmation if necessary.
// This way, it is only done once at this moment, instead of being done several times in callbacks
// After that, we can start looking for archives
//storages[0].get("fake-file-to-read").then(searchForArchivesInPreferencesOrStorage,
if (!params.pickedFile && typeof window.fs !== 'undefined') {
// Below we compare the prefix of the files, i.e. the generic filename without date, so we can smoothly deal with upgrades
if (params.packagedFile && params.storedFile.replace(/_[\d-]+\.zim\w?\w?$/i, '') === params.packagedFile.replace(/_[\d-]+\.zim\w?\w?$/i, '')) {
// We're in Electron / NWJS and we need to load the packaged app, so we are forced to use the .fs code
params.pickedFile = params.packagedFile;
} else if (typeof window.showOpenFilePicker === 'undefined') {
// We're in an older Eolectron / NWJS app, so we need to use the .fs code anyway
params.pickedFile = params.storedFile;
}
}
if (!params.pickedFile) {
if (params.storedFile && typeof window.showOpenFilePicker !== 'undefined') {
document.getElementById('btnConfigure').click();
} else {
searchForArchivesInPreferencesOrStorage();
}
} else if (typeof Windows !== 'undefined' && typeof Windows.Storage !== 'undefined') {
processPickedFileUWP(params.pickedFile);
} else {
// We're in an Electron or NWJS app with a packaged file that we need to read from the node File System
console.log("Loading packaged ZIM or last selected archive for Electron...");
// If we're in an AppImage package and the storedFilePath points to the packaged archive, then the storedFilePath will be invalid,
// because a new path is established each time the image's filesystem is mounted. So we reset to default.
if (params.storedFile === params.packagedFile) {
var archiveFilePath = params.archivePath + '/' + params.packagedFile;
if (~params.storedFilePath.indexOf(archiveFilePath)) {
params.storedFilePath = archiveFilePath;
}
}
// Create a fake File object (this avoids extensive patching of later code)
createFakeFileObjectElectron(params.storedFile, params.storedFilePath, function (fakeFile) {
if (fakeFile.size) {
params.pickedFile = fakeFile;
if (typeof window.showOpenFilePicker !== 'undefined') {
populateDropDownListOfArchives([params.pickedFile.name]);
} else {
setLocalArchiveFromFileList([params.pickedFile]);
}
} else {
// Attempts to load the file seem to have failed: maybe it has moved or been deleted
// Let's see if we can open the packaged ZIM instead (if this isn't the packaged ZIM)
settingsStore.removeItem('lastSelectedArchive');
settingsStore.removeItem('lastSelectedArchivePath');
if (params.packagedFile && params.storedFile !== params.packagedFile) {
createFakeFileObjectElectron(params.packagedFile, params.archivePath + '/' + params.packagedFile, function (fakeFile) {
if (fakeFile.size) {
params.pickedFile = fakeFile;
setLocalArchiveFromFileList([params.pickedFile]);
} else {
// This shouldn't happen!
params.showFileSelectors = true;
document.getElementById('hideFileSelectors').style.display = 'inline';
document.getElementById('btnConfigure').click();
setTimeout(function () {
uiUtil.systemAlert('The packaged file cannot be loaded!\nPlease check that it is in the "' + params.archivePath + '" folder\nor pick a new ZIM file.');
}, 10);
}
});
} else {
params.showFileSelectors = true;
document.getElementById('hideFileSelectors').style.display = 'inline';
document.getElementById('btnConfigure').click();
setTimeout(function () {
uiUtil.systemAlert('The previously picked file cannot be found!\nPlease pick a new ZIM file.');
}, 10);
}
}
document.getElementById('hideFileSelectors').style.display = params.showFileSelectors ? 'inline' : 'none';
});
}
} else {
// If DeviceStorage is not available, we display the file select components
displayFileSelect();
if (document.getElementById('archiveFiles').files && document.getElementById('archiveFiles').files.length > 0) {
// Archive files are already selected,
setLocalArchiveFromFileSelect();
} else {
document.getElementById('btnConfigure').click();
}
}
// Display the article when the user goes back in the browser history
var historyPop = function(event) {
if (event.state) {
var title = event.state.title;
var titleSearch = event.state.titleSearch;
appstate.target = event.target.kiwixType;
// Select the correct window to which to write the popped history in case the user
// siwtches to a tab and navigates history without first clicking on a link
if (appstate.target === 'window') articleWindow = event.target;
$('#prefix').val("");
$("#welcomeText").hide();
$('#searchingArticles').hide();
$('#configuration').hide();
$('#articleListWithHeader').hide();
$('#articleContent').contents().empty();
if (title && !("" === title)) {
goToArticle(title);
}
else if (titleSearch && titleSearch !== '') {
$('#prefix').val(titleSearch);
if (titleSearch !== appstate.search.prefix) {
searchDirEntriesFromPrefix(titleSearch);
} else {
$('#prefix').focus();
}
}
}
};
window.onpopstate = historyPop;
/**
* Populate the drop-down list of archives with the given list
* @param {Array.<String>} archiveDirectories
*/
function populateDropDownListOfArchives(archiveDirectories) {
$('#scanningForArchives').hide();
$('#chooseArchiveFromLocalStorage').show();
document.getElementById('rescanStorage').style.display = params.rescan ? "none" : "block";
document.getElementById('openLocalFiles').style.display = params.rescan ? "block" : "none";
var comboArchiveList = document.getElementById('archiveList');
comboArchiveList.options.length = 0;
for (var i = 0; i < archiveDirectories.length; i++) {
var archiveDirectory = archiveDirectories[i];
if (archiveDirectory === "/") {
uiUtil.systemAlert("It looks like you have put some archive files at the root of your sdcard (or internal storage). Please move them in a subdirectory");
} else {
comboArchiveList.options[i] = new Option(archiveDirectory, archiveDirectory);
}
}
// Store the list of archives in a cookie, to avoid rescanning at each start
settingsStore.setItem("listOfArchives", archiveDirectories.join('|'), Infinity);
comboArchiveList.size = comboArchiveList.length;
//Kiwix-Js-Windows #23 - remove dropdown caret if only one archive
if (comboArchiveList.length > 1) comboArchiveList.removeAttribute("multiple");
if (comboArchiveList.length == 1) comboArchiveList.setAttribute("multiple", "1");
if (comboArchiveList.options.length > 0) {
var plural = comboArchiveList.length > 1 ? "s" : "";
document.getElementById('archiveNumber').innerHTML = '<b>' + comboArchiveList.length + '</b> Archive' + plural + ' found in selected location (tap "Select storage" to change)';
// If we're doing a rescan, then don't attempt to jump to the last selected archive, but leave selectors open
var lastSelectedArchive = params.rescan ? '' : params.storedFile;
if (lastSelectedArchive !== null && lastSelectedArchive !== undefined && lastSelectedArchive !== "") {
// || comboArchiveList.options.length == 1
// Either we have previously chosen a file, or there is only one file
// Attempt to select the corresponding item in the list, if it exists
var success = false;
if ($("#archiveList option[value='" + lastSelectedArchive + "']").length > 0) {
$("#archiveList").val(lastSelectedArchive);
success = true;
settingsStore.setItem("lastSelectedArchive", lastSelectedArchive, Infinity);
}
// Set the localArchive as the last selected (if none has been selected previously, wait for user input)
if (success) {
setLocalArchiveFromArchiveList();
} else {
// We can't find lastSelectedArchive in the archive list
// Let's first check if this is a Store UWP/PWA that has a different archive package from that last selected
// (or from that indicated in init.js)
if (typeof Windows !== 'undefined' && typeof Windows.Storage !== 'undefined' &&
params.packagedFile && settingsStore.getItem('lastSelectedArchive') !== params.packagedFile) {
// We didn't pick this file previously, so select first one in list
params.storedFile = archiveDirectories[0];
params.fileVersion = ~params.fileVersion.indexOf(params.storedFile.replace(/\.zim\w?\w?$/i, '')) ? params.fileVersion : params.storedFile;
setLocalArchiveFromArchiveList(params.storedFile);
} else {
// It's genuinely no longer available, so let's ask the user to pick it
var message = '<p>We could not find the archive <b>' + lastSelectedArchive + '</b>!</p><p>Please select its location...</p>';
if (typeof Windows !== 'undefined' && typeof Windows.Storage !== 'undefined')
message += '<p><i>Note:</i> If you drag-drop an archive into this UWP app, then it will have to be dragged again each time you launch the app. Try double-clicking on the archive instead, or select it using the controls on this page.</p>';
if (document.getElementById('configuration').style.display == 'none')
document.getElementById('btnConfigure').click();
document.getElementById('alert-content').innerHTML = message;
$('#alertModal').off('hide.bs.modal');
$('#alertModal').on('hide.bs.modal', function () {
displayFileSelect();
});
$('#alertModal').modal({
backdrop: 'static',
keyboard: true
});
}
}
}
} else {
uiUtil.systemAlert("Welcome to Kiwix! This application needs at least a ZIM file in your SD-card (or internal storage). Please download one and put it on the device (see About section). Also check that your device is not connected to a computer through USB device storage (which often locks the SD-card content)");
$("#btnAbout").click();
var isAndroid = navigator.userAgent.indexOf("Android") !== -1;
if (isAndroid) {
alert("You seem to be using an Android device. Be aware that there is a bug on Firefox, that prevents finding Wikipedia archives in a SD-card (at least on some devices. See about section). Please put the archive in the internal storage if the application can't find it.");
}
}
}
/**
* Sets the localArchive from the selected archive in the drop-down list
*/
function setLocalArchiveFromArchiveList(archiveDirectory) {
params.rescan = false;
archiveDirectory = archiveDirectory || $('#archiveList').val();
if (archiveDirectory && archiveDirectory.length > 0) {
// Now, try to find which DeviceStorage has been selected by the user
// It is the prefix of the archive directory
var regexpStorageName = /^\/([^\/]+)\//;
var regexpResults = regexpStorageName.exec(archiveDirectory);
var selectedStorage = null;
if (regexpResults && regexpResults.length > 0) {
var selectedStorageName = regexpResults[1];
for (var i = 0; i < storages.length; i++) {
var storage = storages[i];
if (selectedStorageName === storage.storageName) {
// We found the selected storage
selectedStorage = storage;
}
}
if (selectedStorage === null) {
uiUtil.systemAlert("Unable to find which device storage corresponds to directory " + archiveDirectory);
}
} else {
// This happens when the archiveDirectory is not prefixed by the name of the storage
// (in the Simulator, or with FxOs 1.0, or probably on devices that only have one device storage)
// In this case, we use the first storage of the list (there should be only one)
if (storages.length === 1) {
selectedStorage = storages[0];
} else { //IT'S NOT FREAKIN FFOS!!!!!!!!!!
//Patched for UWP support:
if (!params.pickedFile && params.pickedFolder && typeof MSApp !== 'undefined') {
var query = params.pickedFolder.createFileQuery();
query.getFilesAsync().done(function (files) {
var file;
var fileset = [];
if (files) {
for (var i = 0; i < files.length; i++) {
if (files[i].name == archiveDirectory) {
file = files[i];
break;
}
}
if (file) {
if (/\.zim\w\w$/i.test(file.name)) {
var genericFileName = file.name.replace(/(\.zim)\w\w$/i, '$1');
var testFileName = new RegExp(genericFileName + '\\w\\w$');
for (i = 0; i < files.length; i++) {
if (testFileName.test(files[i].name)) {
//This converts a UWP storage file object into a standard JavaScript web file object
fileset.push(MSApp.createFileFromStorageFile(files[i]));
}
}
} else {
//This converts a UWP storage file object into a standard JavaScript web file object
fileset.push(MSApp.createFileFromStorageFile(file));
}
}
}
if (fileset.length) {
setLocalArchiveFromFileList(fileset);
} else {
console.error("The picked file could not be found in the selected folder!\n" + params.pickedFile);
var archiveList = [];
for (i = 0; i < files.length; i++) {
if (/\.zima?a?$/i.test(files[i].name)) {
archiveList.push(files[i].name);
}
}
populateDropDownListOfArchives(archiveList);
document.getElementById('btnConfigure').click();
}
});
return;
} else if (!params.pickedFile && params.pickedFolder && typeof window.showOpenFilePicker !== 'undefined') {
// Native FS support
cache.verifyPermission(params.pickedFolder).then(function(permission) {
if (!permission) {
console.log('User denied permission to access the folder');
return;
} else if (params.pickedFolder.kind === 'directory') {
return processNativeDirHandle(params.pickedFolder, function(fileHandles) {
var fileHandle;
var fileset = [];
if (fileHandles) {
for (var i = 0; i < fileHandles.length; i++) {
if (fileHandles[i].name == archiveDirectory) {
fileHandle = fileHandles[i];
break;
}
}
if (fileHandle) {
if (/\.zim\w\w$/i.test(fileHandle.name)) {
var genericFileName = fileHandle.name.replace(/(\.zim)\w\w$/i, '$1');
var testFileName = new RegExp(genericFileName + '\\w\\w$');
for (i = 0; i < fileHandles.length; i++) {
if (testFileName.test(fileHandles[i].name)) {
//This gets a JS File object from a file handle
fileset.push(fileHandles[i].getFile().then(function(file) {
return file;
}));
}
}
} else {
fileset.push(fileHandle.getFile().then(function(file) {
return file;
}));
}
if (fileset.length) {
Q.all(fileset).then(function (resolvedFiles) {
setLocalArchiveFromFileList(resolvedFiles);
});
} else {
console.error("There was an error reading the picked file(s)!");
}
} else {
console.error("The picked file could not be found in the selected folder!");
var archiveList = [];
for (i = 0; i < fileHandles.length; i++) {
if (/\.zima?a?$/i.test(fileHandles[i].name)) {
archiveList.push(fileHandles[i].name);
}
}
populateDropDownListOfArchives(archiveList);
document.getElementById('btnConfigure').click();
}
} else {
console.log('There was an error obtaining the file handle(s).');
}
});
}
});
return;
} else { //Check if user previously picked a specific file rather than a folder
if (params.pickedFile && typeof MSApp !== 'undefined') {
try {
selectedStorage = MSApp.createFileFromStorageFile(params.pickedFile);
setLocalArchiveFromFileList([selectedStorage]);
return;
} catch (err) {
// Probably user has moved or deleted the previously selected file
uiUtil.systemAlert("The previously picked archive can no longer be found!");
console.error("Picked archive not found: " + err);
}
} else if (params.pickedFile && typeof window.showOpenFilePicker !== 'undefined') {
// Native FS API for single file
setLocalArchiveFromFileList([params.pickedFile]);
return;
}
}
//There was no picked file or folder, so we'll try setting the default localStorage
//if (!params.pickedFolder) {
//This gets called, for example, if the picked folder or picked file are in FutureAccessList but now are
//no longer accessible. There will be a (handled) error in cosole log, and params.pickedFolder and params.pickedFile will be blank
params.rescan = true;
if (params.localStorage) {
scanUWPFolderforArchives(params.localStorage);
} else {
var btnConfigure = document.getElementById('btnConfigure');
if (!btnConfigure.classList.contains('active')) btnConfigure.click();
}
return;
//}
}
}
// Reset the cssDirEntryCache and cssBlobCache. Must be done when archive changes.
if (cssBlobCache)
cssBlobCache = new Map();
//if (cssDirEntryCache)
// cssDirEntryCache = new Map();
appstate.selectedArchive = zimArchiveLoader.loadArchiveFromDeviceStorage(selectedStorage, archiveDirectory, function (archive) {
settingsStore.setItem("lastSelectedArchive", archiveDirectory, Infinity);
// Ensure that the new ZIM output is initially sent to the iframe (e.g. if the last article was loaded in a window)
// (this only affects jQuery mode)
appstate.target = 'iframe';
// The archive is set : go back to home page to start searching
if (params.rescan) {
document.getElementById('btnConfigure').click();
params.rescan = false;
} else {
$('#openLocalFiles').hide();
document.getElementById('moreInfo').style.display = 'none';
document.getElementById('btnHome').click();
}
});
}
}
// Define globalDropZone (universal drop area) and configDropZone (highlighting area on Config page)
var globalDropZone = document.getElementById('search-article');
var configDropZone = document.getElementById('configuration');
// Set the main drop zone
globalDropZone.addEventListener('dragover', handleGlobalDragover);
globalDropZone.addEventListener('drop', handleFileDrop);
configDropZone.addEventListener('dragleave', function (e) {
configDropZone.style.border = '';
});
/**
* Displays the zone to select files from the archive
*/
function displayFileSelect() {
document.getElementById('openLocalFiles').style.display = 'block';
// This handles use of the file picker
document.getElementById('archiveFiles').addEventListener('change', setLocalArchiveFromFileSelect);
}
function handleGlobalDragover(e) {
e.preventDefault();
e.dataTransfer.dropEffect = 'link';
if (configDropZone.style.display === 'none') document.getElementById('btnConfigure').click();
configDropZone.style.border = '3px dotted red';
}
function handleIframeDragover(e) {
e.preventDefault();
e.dataTransfer.dropEffect = 'link';
document.getElementById('btnConfigure').click();
}
function handleIframeDrop(e) {
e.stopPropagation();
e.preventDefault();
return;
}
function handleFileDrop(packet) {
packet.stopPropagation();
packet.preventDefault();
configDropZone.style.border = '';
var items = packet.dataTransfer.items;
if (items && items[0].kind === 'file' && typeof items[0].getAsFileSystemHandle !== 'undefined') {
items[0].getAsFileSystemHandle().then(function (handle) {
if (handle.kind === 'file') {
processNativeFileHandle(handle);
} else if (handle.kind === 'directory') {
processNativeDirHandle(handle);
}
});
} else {
var files = packet.dataTransfer.files;
document.getElementById('openLocalFiles').style.display = 'none';
document.getElementById('moreInfo').style.display = 'none';
params.rescan = false;
setLocalArchiveFromFileList(files);
// This clears the display of any previously picked archive in the file selector
document.getElementById('archiveFilesLegacy').value = '';
}
}
function pickFileUWP() { //Support UWP FilePicker [kiwix-js-windows #3]
// Create the picker object and set options
var filePicker = new Windows.Storage.Pickers.FileOpenPicker;
filePicker.suggestedStartLocation = Windows.Storage.Pickers.PickerLocationId.downloads;
// Filter folder contents
filePicker.fileTypeFilter.replaceAll([".zim"]);
filePicker.pickSingleFileAsync().then(processPickedFileUWP);
}
function pickFileNativeFS() {
return window.showOpenFilePicker({multiple: false}).then(function(fileHandle) {
return processNativeFileHandle(fileHandle[0]);
});
}
function pickFolderNativeFS() {
window.showDirectoryPicker().then(function (dirHandle) {
// Do not attempt to jump to file (we have to let user choose)
params.rescan = true;
return processNativeDirHandle(dirHandle);
}).catch(function(err) {
console.error('Error reading directory', err);
});
}
function processNativeFileHandle(fileHandle) {
var handle = fileHandle;
// Serialize fileHandle to indexedDB
cache.idxDB('pickedFSHandle', fileHandle, function (val) {
console.log('IndexedDB responded with ' + val);
});
settingsStore.setItem('lastSelectedArchive', fileHandle.name, Infinity);
params.storedFile = fileHandle.name;
params.pickedFolder = null;
return fileHandle.getFile().then(function(file) {
file.handle = handle;
params.pickedFile = file;
params.rescan = false;
populateDropDownListOfArchives([file.name]);
});
}
function processPickedFileUWP(file) {
if (file) {
if (params.falFolderToken && /\.zim\w\w$/i.test(file.name)) {
// This is a split file in a picked folder, so we need to process differently
params.pickedFile = '';
setLocalArchiveFromArchiveList([file]);
return;
}
// Cache file so the contents can be accessed at a later time
Windows.Storage.AccessCache.StorageApplicationPermissions.futureAccessList.addOrReplace(params.falFileToken, file);
params.pickedFile = file;
if (params.pickedFolder) Windows.Storage.AccessCache.StorageApplicationPermissions.futureAccessList.remove(params.falFolderToken);
params.pickedFolder = "";
settingsStore.setItem("lastSelectedArchive", file.name, Infinity);
params.storedFile = file.name;
// Since we've explicitly picked a file, we should jump to it
params.rescan = false;
populateDropDownListOfArchives([file.name]);
} else {
// The picker was dismissed with no selected file
console.log("User closed folder picker without picking a file");
}
}
function pickFolderUWP() { //Support UWP FilePicker [kiwix-js-windows #3]
var folderPicker = new Windows.Storage.Pickers.FolderPicker;
folderPicker.suggestedStartLocation = Windows.Storage.Pickers.PickerLocationId.downloads;
folderPicker.fileTypeFilter.replaceAll([".zim", ".dat", ".idx", ".txt", ".zimaa"]);
folderPicker.pickSingleFolderAsync().done(function (folder) {
if (folder) {
scanUWPFolderforArchives(folder);
}
});
}
function processNativeDirHandle(dirHandle, callback) {
// Serialize fileHandle to indexedDB
cache.idxDB('pickedFSHandle', dirHandle, function (val) {
console.log('IndexedDB responded with ' + val);
});
params.pickedFolder = dirHandle;
params.pickedFile = '';
// We have to wrap async function because IE11 compiler throws error if unwrapped
eval(
"var processHandle = async function(handle, callback) {" +
"var archiveList = [];" +
"for await (const [name, entry] of handle) {" +
" if (/\\.zim(\\w\\w)?$/.test(entry.name)) {" +
"if (callback) archiveList.push(entry);" +
"else archiveList.push(entry.name);" +
" }" +
"}" +
"if (archiveList.length) {" +
"if (callback) { callback(archiveList); return; }" +
"document.getElementById('noZIMFound').style.display = 'none';" +
" populateDropDownListOfArchives(archiveList);" +
"} else {" +
"if (callback) { callback(null); return; }" +
"}" +
"};" +
"processHandle(dirHandle, callback);"
);
var archiveDisplay = document.getElementById('chooseArchiveFromLocalStorage');
archiveDisplay.style.display = 'block';
}
function scanUWPFolderforArchives(folder) {
if (folder) {
// Application now has read/write access to all contents in the picked folder (including sub-folder contents)
// Cache folder so the contents can be accessed at a later time
Windows.Storage.AccessCache.StorageApplicationPermissions.futureAccessList.addOrReplace(params.falFolderToken, folder);
params.pickedFolder = folder;
// Query the folder.
var query = folder.createFileQuery();
query.getFilesAsync().done(function (files) {
// Display file list
var archiveDisplay = document.getElementById('chooseArchiveFromLocalStorage');
if (files) {
var archiveList = [];
files.forEach(function (file) {
if (file.fileType == ".zim" || file.fileType == ".zimaa") {
archiveList.push(file.name);
}
});
if (archiveList.length) {
document.getElementById('noZIMFound').style.display = "none";
populateDropDownListOfArchives(archiveList);
return;
}
}
archiveDisplay.style.display = 'block';
document.getElementById('noZIMFound').style.display = 'block';
document.getElementById('archiveList').options.length = 0;
document.getElementById('archiveList').size = 0;
document.getElementById('archiveNumber').innerHTML = '<b>0</b> Archives found in local storage (tap "Select storage" to select an archive location)';
params.pickedFolder = "";
Windows.Storage.AccessCache.StorageApplicationPermissions.futureAccessList.remove(params.falFolderToken);
return;
});
} else {
// The picker was dismissed with no selected file
console.log("User closed folder picker without picking a file");
}
}
function setLocalArchiveFromFileList(files) {
// Check for usable file types
for (var i = files.length; i--;) {
// DEV: you can support other file types by adding (e.g.) '|dat|idx' after 'zim\w{0,2}'
if (!/\.(?:zim\w{0,2})$/i.test(files[i].name)) {
uiUtil.systemAlert("One or more files does not appear to be a ZIM file!");
return;
}
// Allow reading with electron if we have the path info
if (typeof window.fs !== 'undefined' && files[i].path) {
files[i].readMode = 'electron';
console.log("File path is: " + files[i].path);
}
}
// Check that user hasn't picked just part of split ZIM
if (files.length == 1 && /\.zim\w\w/i.test(files[0].name)) {
document.getElementById('alert-content').innerHTML = '<p>You have picked only part of a split archive!</p><p>Please select its folder in Config, or drag and drop <b>all</b> of its parts into Config.</p>';
$('#alertModal').off('hide.bs.modal');
$('#alertModal').on('hide.bs.modal', function () {
if (document.getElementById('configuration').style.display == 'none')
document.getElementById('btnConfigure').click();
displayFileSelect();
});
$('#alertModal').modal({
backdrop: 'static',
keyboard: true
});
}
// If the file name is already in the archive list, try to select it in the list
var listOfArchives = document.getElementById('archiveList');
if (listOfArchives) listOfArchives.value = files[0].name;
// Reset the cssDirEntryCache and cssBlobCache. Must be done when archive changes.
if (cssBlobCache)
cssBlobCache = new Map();
//if (cssDirEntryCache)
// cssDirEntryCache = new Map();
appstate.selectedArchive = zimArchiveLoader.loadArchiveFromFiles(files, function (archive) {
// Ensure that the new ZIM output is initially sent to the iframe (e.g. if the last article was loaded in a window)
// (this only affects jQuery mode)
appstate.target = 'iframe';
// The archive is set : go back to home page to start searching
params.storedFile = archive._file._files[0].name;
settingsStore.setItem("lastSelectedArchive", params.storedFile, Infinity);
settingsStore.setItem("lastSelectedArchivePath", archive._file._files[0].path ? archive._file._files[0].path : '', Infinity);
var reloadLink = document.getElementById("reloadPackagedArchive");
if (reloadLink) {
if (params.packagedFile != params.storedFile) {
reloadLink.style.display = "inline";
reloadLink.removeEventListener("click", loadPackagedArchive);
reloadLink.addEventListener("click", loadPackagedArchive);
document.getElementById("moreInfo").style.display = "none";
} else {
reloadLink.style.display = "none";
document.getElementById('currentArchive').style.display = "none";
document.getElementById("moreInfo").style.display = "inline";
}
}
//This ensures the correct icon is set for the newly loaded archive
cssUIThemeGetOrSet(params.cssUITheme);
if (params.rescan) {
document.getElementById('btnConfigure').click();
setTimeout(function() {
document.getElementById('btnConfigure').click();
params.rescan = false;
}, 100);
} else {
$('#openLocalFiles').hide();
document.getElementById('moreInfo').style.display = 'none';
if (params.rememberLastPage && ~params.lastPageVisit.indexOf(params.storedFile)) {
var lastPage = params.lastPageVisit.replace(/@kiwixKey@.+/, "");
goToArticle(lastPage);
} else {
// The archive has changed, so we must blank the last page in case the Home page of the new archive
// has the same title as the previous archive (possible if it is, for example, "index")
params.lastPageVisit = '';
params.lastPageHTML = '';
document.getElementById('btnHome').click();
}
}
});
}
function loadPackagedArchive() {
// Reload any ZIM files in local storage (whcih the user can't otherwise select with the filepicker)
// Reset params.packagedFile to its original value, in case we manipulated it previously
params.packagedFile = params.originalPackagedFile;
params.pickedFile = '';
if (params.localStorage) {
params.pickedFolder = params.localStorage;
params.storedFile = params.packagedFile || '';
scanUWPFolderforArchives(params.localStorage);
if (!params.rescan) setLocalArchiveFromArchiveList(params.storedFile);
} else if (typeof window.fs !== 'undefined') {
// We're in an Electron packaged app
settingsStore.removeItem('lastSelectedArchive');
settingsStore.removeItem('lastSelectedArchivePath');
params.lastPageVisit = '';
if (params.packagedFile && params.storedFile !== params.packagedFile) {
createFakeFileObjectElectron(params.packagedFile, params.archivePath + '/' + params.packagedFile, function (fakeFile) {
if (fakeFile.size) {
params.pickedFile = fakeFile;
params.storedFile = params.packagedFile;
if (typeof window.showOpenFilePicker !== 'undefined') {
populateDropDownListOfArchives([params.pickedFile.name]);
} else {
setLocalArchiveFromFileList([params.pickedFile]);
}
} else {
// This shouldn't happen!
params.showFileSelectors = true;
document.getElementById('hideFileSelectors').style.display = 'inline';
document.getElementById('btnConfigure').click();
setTimeout(function () {
uiUtil.systemAlert('The packaged file cannot be loaded!\nPlease check that it is in the "' + params.archivePath + '" folder\nor pick a new ZIM file.');
}, 10);
}
});
}
}
}
/**
* Sets the localArchive from the File selects populated by user
*/
function setLocalArchiveFromFileSelect() {
setLocalArchiveFromFileList(document.getElementById('archiveFilesLegacy').files);
params.rescan = false;
}
/**
* Creates a fake file object from the given filename and filepath. This can only be used if the app is running
* in the Electron framework.
*
* @param {String} filename The name of the file to be represented
* @param {String} filepath The path of the file to be represented
* @param {Function} callback The function to call back with the constructed file
*/
function createFakeFileObjectElectron(filename, filepath, callback) {
var file = {};
// For Electron, we need to set an absolute filepath in case the file was launched from a shortcut (and if it's not already absolute)
if (filepath === params.archivePath + '/' + filename && /^file:/i.test(window.location.protocol)) {
filepath = window.location.protocol + window.location.pathname.replace(/www\/[^/]+$/, '') + filepath;
}
if (/^file:/i.test(filepath)) filepath = new URL(filepath);
file.name = filename;
file.path = filepath;
file.readMode = 'electron';
// Get file size
fs.stat(file.path, function (err, stats) {
if (err) {
file.size = null;
console.error('File cannot be found!', err);
} else {
file.size = stats.size;
console.log("Stored file size is: " + file.size);
}
callback(file);
});
}
/**
* Reads a remote archive with given URL, and returns the response in a Promise.
* This function is used by setRemoteArchives below, for UI tests
*
* @param {String} url The URL of the archive to read
* @returns {Promise<Blob>} A promise for the requested file (blob)
*/
function readRemoteArchive(url) {
// DEV: This deferred can't be standardized to a Promise/A+ pattern (using Q) because
// IE11 is unable to scope the callbacks inside the Promise correctly. See [kiwix.js #589]
var deferred = Q.defer();
var request = new XMLHttpRequest();
request.open("GET", url);
request.responseType = "blob";
request.onreadystatechange = function () {
if (request.readyState === XMLHttpRequest.DONE) {
if (request.status >= 200 && request.status < 300 || request.status === 0) {
// Hack to make this look similar to a file
request.response.name = url;
deferred.resolve(request.response);
} else {
deferred.reject("HTTP status " + request.status + " when reading " + url);
}
}
};
request.onabort = request.onerror = deferred.reject;
request.send();
return deferred.promise;
}
/**
* This is used in the testing interface to inject remote archives
* @returns {Promise<Array>} A Promise for an array of archives
*/
window.setRemoteArchives = function () {
var readRequests = [];
Array.prototype.slice.call(arguments).forEach(function (arg) {
readRequests.push(readRemoteArchive(arg));
});
return Q.all(readRequests).then(function (arrayOfArchives) {
setLocalArchiveFromFileList(arrayOfArchives);
}).catch(function (e) {
console.error('Unable to load remote archive(s)', e);
});
};
/**
* Handle key input in the prefix input zone
* @param {Event} evt The event data to handle
*/
function onKeyUpPrefix(evt) {
// Use a timeout, so that very quick typing does not cause a lot of overhead
// It is also necessary for the words suggestions to work inside Firefox OS
if (window.timeoutKeyUpPrefix) {
window.clearTimeout(window.timeoutKeyUpPrefix);
}
window.timeoutKeyUpPrefix = window.setTimeout(function () {
var prefix = $("#prefix").val();
if (prefix && prefix.length > 0 && prefix !== appstate.search.prefix) {
document.getElementById('searchArticles').click();
}
}, 1000);
}
function listenForNavigationKeys() {
var listener = function (e) {
var hit = false;
if (/^(Arrow)?Left$/.test(e.key) && (e.ctrlKey||e.altKey)) {
// Ctrl/Alt-Left was pressed
e.preventDefault();
if (hit) return;
hit = true;
articleWindow.history.back();
} else if (/^(Arrow)?Right$/.test(e.key) && (e.ctrlKey||e.altKey)) {
// Ctrl/Alt-Right was pressed
e.preventDefault();
if (hit) return;
hit = true;
articleWindow.history.forward();
}
};
articleWindow.removeEventListener('keydown', listener);
articleWindow.addEventListener('keydown', listener);
}
function listenForSearchKeys() {
//Listen to iframe key presses for in-page search
document.getElementById('articleContent').contentWindow.addEventListener('keyup', function (e) {
//Alt-F for search in article, also patches Ctrl-F for apps that do not have access to browser search
if ((e.ctrlKey || e.altKey) && e.which == 70) {
document.getElementById('findText').click();
}
});
document.getElementById('articleContent').contentWindow.addEventListener('keydown', function (e) {
//Ctrl-P to patch printing support, so iframe gets printed
if (e.ctrlKey && e.which == 80) {
e.stopPropagation();
e.preventDefault();
printIntercept();
}
}, true);
}
/**
* Search the index for DirEntries with title that start with the given prefix (implemented
* with a binary search inside the index file)
* @param {String} prefix The string that must appear at the start of any title searched for
*/
function searchDirEntriesFromPrefix(prefix) {
if (appstate.selectedArchive !== null && appstate.selectedArchive.isReady()) {
// Cancel the old search (zimArchive search object will receive this change)
appstate.search.status = 'cancelled';
// Initiate a new search object and point appstate.search to it (the zimAcrhive search object will continue to point to the old object)
appstate.search = {'prefix': prefix, 'status': 'init', 'type': ''};
$('#activeContent').hide();
if (!prefix || /^\s/.test(prefix)) {
var sel = prefix ? prefix.replace(/^\s(.*)/, '$1') : '';
if (sel.length) {
sel = sel.replace(/^(.)(.*)/, function (p0, p1, p2) {
return p1.toUpperCase() + p2;
});
}
showZIMIndex(null, sel);
} else {
appstate.selectedArchive.findDirEntriesWithPrefix(appstate.search, params.maxResults, populateListOfArticles);
}
} else {
$('#searchingArticles').hide();
// We have to remove the focus from the search field,
// so that the keyboard does not stay above the message
$('#searchArticles').focus();
uiUtil.systemAlert("Archive not set : please select an archive");
document.getElementById('btnConfigure').click();
}
}
/**
* Extracts and displays in htmlArticle the first params.maxResults articles beginning with start
* @param {String} start Optional index number to begin the list with
* @param {String} prefix Optional search prefix from which to start an alphabetical search
*/
function showZIMIndex(start, prefix) {
// If we're searching by title index number (other than 0 or null), we should ignore any prefix
if (isNaN(start)) {
prefix = prefix || '';
} else {
prefix = start > 0 ? '' : prefix;
}
var search = {'prefix': prefix, 'state': ''}; // Dummy search object because expected by callee
if (appstate.selectedArchive !== null && appstate.selectedArchive.isReady()) {
appstate.selectedArchive.findDirEntriesWithPrefixCaseSensitive(prefix, params.maxResults, search, function (dirEntryArray, nextStart) {
var docBody = document.getElementById('largeModal');
var newHtml = "";
for (var i = 0; i < dirEntryArray.length; i++) {
var dirEntry = dirEntryArray[i];
newHtml += "\n<a class='list-group-item' href='#' dirEntryId='" + dirEntry.toStringId().replace(/'/g, "&apos;") +
"'>" + (dirEntry.getTitleOrUrl()) + "</a>";
}
start = start ? start : 0;
var back = start ? '<a href="#" data-start="' + (start - params.maxResults) +
'" class="continueAnchor">&lt;&lt; Previous ' + params.maxResults + '</a>' : '';
var next = dirEntryArray.length === params.maxResults ? '<a href="#" data-start="' + nextStart +
'" class="continueAnchor">Next ' + params.maxResults + ' &gt;&gt;</a>' : '';
var backNext = back ? next ? back + ' | ' + next : back : next;
backNext = '<div style="float:right;">' + backNext + '</div>\n';
var alphaSelector = [];
// Set up the alphabetic selector
var lower = params.alphaChar.charCodeAt();
var upper = params.omegaChar.charCodeAt();
if (upper <= lower) {
alphaSelector.push('<a href="#" class="alphaSelector" data-sel="A">PLEASE SELECT VALID START AND END ALPHABET CHARACTERS IN CONFIGURATION</a>');
} else {
for (i = lower; i <= upper; i++) {
var char = String.fromCharCode(i);
alphaSelector.push('<a href="#" class="alphaSelector" data-sel="' + char + '">' + char + '</a>');
}
}
// Add selectors for diacritics, etc. for Roman alphabet
if (params.alphaChar === 'A' && params.omegaChar == 'Z') {
alphaSelector.push('<a href="#" class="alphaSelector" data-sel="¡">¡¿ÀÑ</a>');
alphaSelector.unshift('<a href="#" class="alphaSelector" data-sel="!">!#123</a>');
// Add way of selecting a non-Roman alphabet
var switchAlphaButton = document.getElementById('extraModalFooterContent');
// Don't re-add button and event listeners if they already exist
if (!/button/.test(switchAlphaButton.innerHTML)) {
switchAlphaButton.innerHTML = '<button class="btn btn-primary" style="float:left;" type="button">Switch to non-Roman alphabet</button>';
switchAlphaButton.addEventListener('click', function () {
var alphaLabel = document.getElementById('alphaCharTxt').parentNode;
alphaLabel.style.borderColor = 'red';
alphaLabel.style.borderStyle = 'solid';
alphaLabel.addEventListener('mousedown', function () {
this.style.borderColor = '';
this.style.borderStyle = '';
});
$('#myModal').modal('hide');
document.getElementById('btnConfigure').click();
window.location.href = "#displaySettingsDiv";
});
}
}
// Add diacritics for Greek alphabet
if (params.alphaChar === 'Α' && params.omegaChar == 'Ω') {
alphaSelector.push('<a href="#" class="alphaSelector" data-sel="Ϊ">ΪΫά</a>');
alphaSelector.unshift('<a href="#" class="alphaSelector" data-sel="΄">ΆΈΉ</a>');
}
var alphaString = '<div style="text-align:center">[ ' + alphaSelector.join(' | \n') + ' ]</div>\n';
var closeButton = '<button class="close" aria-hidden="true" type="button" data-dismiss="modal">&nbsp;&times;&nbsp;</button>';
docBody.innerHTML = closeButton + '<br />\n<div style="font-size:120%;"><br />\n' + alphaString + '<br />' + backNext + '</div>\n' +
'<h2>ZIM Archive Index</h2>\n' +
'<div id="zimIndex" class="list-group">' + newHtml + '\n</div>\n' +
'<div style="font-size:120%">\n' + backNext + '<br /><br />' + alphaString + '</div>\n';
var indexEntries = docBody.querySelectorAll('.list-group-item');
Array.prototype.slice.call(indexEntries).forEach(function (index) {
index.addEventListener('click', function (event) {
event.preventDefault();
handleTitleClick(event);
$("#myModal").modal('hide');
});
});
var continueAnchors = docBody.querySelectorAll('.continueAnchor');
$(continueAnchors).on('click', function (e) {
document.getElementById('prefix').value = '';
var start = ~~this.dataset.start;
showZIMIndex(start);
return false;
});
alphaSelector = docBody.querySelectorAll('.alphaSelector');
$(alphaSelector).on('click', function (e) {
var char = this.dataset.sel;
document.getElementById('prefix').value = ' ' + char;
showZIMIndex(null, char);
return false;
});
$('#searchingArticles').hide();
$('#articleListWithHeader').hide();
var modalTheme = document.getElementById('modalTheme');
modalTheme.classList.remove('dark');
var determinedTheme = params.cssUITheme == 'auto' ? cssUIThemeGetOrSet('auto', true) : params.cssUITheme;
if (determinedTheme === 'dark') modalTheme.classList.add('dark');
$('#myModal').modal({
backdrop: "static"
});
}, start);
}
}
/**
* Display the list of articles with the given array of DirEntry
* @param {Array} dirEntryArray The array of dirEntries returned from the binary search
* @param {Object} reportingSearchStatus The status of the reporting search
*/
function populateListOfArticles(dirEntryArray, reportingSearchStatus) {
// Do not allow cancelled searches to report
if (reportingSearchStatus === 'cancelled') return;
var stillSearching = appstate.search.status === 'interim';
var articleListHeaderMessageDiv = $('#articleListHeaderMessage');
var nbDirEntry = dirEntryArray ? dirEntryArray.length : 0;
var message;
if (stillSearching) {
message = 'Searching [' + appstate.search.type + ']... found: ' + nbDirEntry;
} else if (nbDirEntry >= params.maxResults) {
message = 'First ' + params.maxResults + ' articles found (refine your search).';
} else {
message = 'Finished. ' + (nbDirEntry ? nbDirEntry : 'No') + ' articles found' + (
appstate.search.type === 'basic' ? ': try fewer words for full search.' : '.'
);
}
articleListHeaderMessageDiv.html(message);
var articleListDiv = document.getElementById('articleList');
var articleListDivHtml = '';
var listLength = dirEntryArray.length < params.maxResults ? dirEntryArray.length : params.maxResults;
for (var i = 0; i < listLength; i++) {
var dirEntry = dirEntryArray[i];
var dirEntryStringId = uiUtil.htmlEscapeChars(dirEntry.toStringId());
articleListDivHtml += '<a href="#" dirEntryId="' + dirEntryStringId +
'" class="list-group-item">' + dirEntry.getTitleOrUrl() + '</a>';
}
articleListDiv.innerHTML = articleListDivHtml;
// We have to use mousedown below instead of click as otherwise the prefix blur event fires first
// and prevents this event from firing; note that touch also triggers mousedown
$('#articleList a').on('mousedown', function (e) {
// Cancel search immediately
appstate.search.status = 'cancelled';
handleTitleClick(e);
document.getElementById('scrollbox').style.height = 0;
document.getElementById('articleListWithHeader').style.display = 'none';
return false;
});
if (!stillSearching) $('#searchingArticles').hide();
$('#articleListWithHeader').show();
}
/**
* Handles the click on the title of an article in search results
* @param {Event} event
* @returns {Boolean}
*/
function handleTitleClick(event) {
var dirEntryId = event.currentTarget.getAttribute("dirEntryId");
findDirEntryFromDirEntryIdAndLaunchArticleRead(dirEntryId);
return false;
}
/**
* Creates an instance of DirEntry from given dirEntryId (including resolving redirects),
* and call the function to read the corresponding article
* @param {String} dirEntryId
*/
function findDirEntryFromDirEntryIdAndLaunchArticleRead(dirEntryId) {
if (appstate.selectedArchive.isReady()) {
var dirEntry = appstate.selectedArchive.parseDirEntryId(dirEntryId);
// Remove focus from search field to hide keyboard and to allow navigation keys to be used
document.getElementById('articleContent').contentWindow.focus();
// Ensure selected search item is displayed in the iframe, not a new window or tab
appstate.target = 'iframe';
$("#searchingArticles").show();
if (dirEntry.isRedirect()) {
appstate.selectedArchive.resolveRedirect(dirEntry, readArticle);
} else {
params.isLandingPage = false;
readArticle(dirEntry);
}
} else {
uiUtil.systemAlert('Data files not set');
}
}
/**
* Check whether the given URL from given dirEntry equals the expectedArticleURLToBeDisplayed
* @param {DirEntry} dirEntry The directory entry of the article to read
* @returns {Boolean} Returns false if the current article does not match the expected article
*/
function isDirEntryExpectedToBeDisplayed(dirEntry) {
var curArticleURL = dirEntry.namespace + "/" + dirEntry.url;
if (expectedArticleURLToBeDisplayed !== curArticleURL) {
console.debug("url of current article :" + curArticleURL + ", does not match the expected url :" +
expectedArticleURLToBeDisplayed);
return false;
}
return true;
}
/**
* Read the article corresponding to the given dirEntry
* @param {DirEntry} dirEntry The directory entry of the article to read
*/
function readArticle(dirEntry) {
// Reset search prefix to allow users to search the same string again if they want to
appstate.search.prefix = '';
// Only update for expectedArticleURLToBeDisplayed.
expectedArticleURLToBeDisplayed = dirEntry.namespace + "/" + dirEntry.url;
params.pagesLoaded++;
if (dirEntry.isRedirect()) {
appstate.selectedArchive.resolveRedirect(dirEntry, readArticle);
} else {
//TESTING//
console.log("Initiating HTML load...");
//Set startup cookie to guard against boot loop
//Cookie will signal failure until article is fully loaded
//document.cookie = 'lastPageLoad=failed;expires=Fri, 31 Dec 9999 23:59:59 GMT';
settingsStore.setItem('lastPageLoad', 'failed', Infinity);
//Void the localSearch variable to prevent invalid DOM references remainining [kiwix-js-windows #56]
localSearch = {};
//Load cached start page if it exists and we have loaded the packaged file
var htmlContent = 0;
var zimName = appstate.selectedArchive._file._files[0].name.replace(/\.[^.]+$/, '').replace(/_\d+-\d+$/, '');
if (params.isLandingPage && params.cachedStartPages[zimName]) {
htmlContent = -1;
var encURL = encodeURIComponent(encodeURIComponent(params.cachedStartPages[zimName]).replace(/%2F/g, '/')).replace(/%2F/g, '/');
uiUtil.XHR(encURL, 'text', function (responseTxt, status) {
htmlContent = /<html[^>]*>/.test(responseTxt) ? responseTxt : 0;
if (htmlContent) {
console.log('Article retrieved from storage cache...');
// Alter the dirEntry url and title parameters in case we are overriding the start page
dirEntry.url = params.cachedStartPages[zimName].replace(/[AC]\//, '');
var title = htmlContent.match(/<title[^>]*>((?:[^<]|<(?!\/title))+)/);
dirEntry.title = title ? title[1] : dirEntry.title;
displayArticleContentInContainer(dirEntry, htmlContent);
} else {
document.getElementById('searchingArticles').style.display = 'block';
appstate.selectedArchive.readUtf8File(dirEntry, displayArticleContentInContainer);
}
});
}
//Load lastPageVisit if it is the currently requested page
if (!htmlContent) {
var lastPage = '';
// NB code below must be able to run async, hence it is a function
var goToRetrievedContent = function(html) {
if (/<html[^>]*>/.test(html)) {
console.log("Fast article retrieval from localStorage: " + lastPage);
setTimeout(function () {
displayArticleContentInContainer(dirEntry, html);
}, 10);
} else {
//if (params.contentInjectionMode === 'jquery') {
// In jQuery mode, we read the article content in the backend and manually insert it in the iframe
appstate.selectedArchive.readUtf8File(dirEntry, displayArticleContentInContainer);
// This is needed so that the html is cached in displayArticleInForm
params.lastPageVisit = '';
params.lastPageHTML = '';
//}
}
};
if (params.rememberLastPage && params.lastPageVisit) lastPage = params.lastPageVisit.replace(/@kiwixKey@.+/, "");
if (params.rememberLastPage && dirEntry.namespace + '/' + dirEntry.url === lastPage) {
if (!params.lastPageHTML) {
cache.getArticle(params.lastPageVisit.replace(/.*@kiwixKey@/, ''), lastPage, function (html) {
params.lastPageHTML = html;
htmlContent = params.lastPageHTML || htmlContent;
goToRetrievedContent(htmlContent);
});
} else {
htmlContent = params.lastPageHTML;
goToRetrievedContent(htmlContent);
}
} else {
goToRetrievedContent(htmlContent);
}
}
}
}
var loaded = false;
var articleLoadedSW = function (dirEntry) {
if (loaded) return;
loaded = true;
articleDocument = articleWindow.document.documentElement;
var doc = articleWindow.document;
var docBody = doc.body;
if (docBody) {
// Deflect drag-and-drop of ZIM file on the iframe to Config
if (appstate.target === 'iframe') {
docBody.addEventListener('dragover', handleIframeDragover);
docBody.addEventListener('drop', handleIframeDrop);
setupTableOfContents();
listenForSearchKeys();
}
//Set relative font size + Stackexchange-family multiplier
var zimType = /-\/s\/style\.css/i.test(doc.head.innerHTML) ? "desktop" : "mobile";
zimType = /-\/static\/main\.css/i.test(doc.head.innerHTML) ? "desktop-stx" : zimType; //Support stackexchange
zimType = /minerva|mobile[^"']*\.css/i.test(doc.head.innerHTML) ? "mobile" : zimType;
docBody.style.fontSize = ~zimType.indexOf("stx") ? params.relativeFontSize * 1.5 + "%" : params.relativeFontSize + "%";
checkToolbar();
//Set page width according to user preference
removePageMaxWidth();
openAllSections();
setupHeadings();
listenForNavigationKeys();
// We need to keep tabs on the opened tabs or windows if the user wants right-click functionality
if (params.windowOpener) parseAnchorsJQuery(dirEntry);
if (/manual|progressive/.test(params.imageDisplayMode)) images.prepareImagesServiceWorker(articleWindow);
if (params.allowHTMLExtraction && appstate.target === 'iframe') {
var determinedTheme = params.cssTheme == 'auto' ? cssUIThemeGetOrSet('auto') : params.cssTheme;
uiUtil.insertBreakoutLink(determinedTheme);
}
// The content is ready : we can hide the spinner
setTab();
setTimeout(function() {
articleDocument.bgcolor = '';
docBody.hidden = false;
}, 200);
settingsStore.removeItem('lastPageLoad');
$("#searchingArticles").hide();
// If we reloaded the page to print the desktop style, we need to return to the printIntercept dialogue
if (params.printIntercept) printIntercept();
} else {
loaded = false;
}
// Show spinner when the article unloads
articleContainer.onunload = function () {
if (articleWindow.kiwixType === 'iframe') {
$("#searchingArticles").show();
}
};
};
var messageChannel;
var maxPageWidthProcessed;
/**
* Function that handles a message of the messageChannel.
* It tries to read the content in the backend, and sends it back to the ServiceWorker
*
* @param {Event} event The event object of the message channel
*/
function handleMessageChannelMessage(event) {
if (event.data.error) {
console.error("Error in MessageChannel", event.data.error);
reject(event.data.error);
} else {
// We received a message from the ServiceWorker
if (event.data.action === "askForContent") {
// The ServiceWorker asks for some content
var title = event.data.title;
var messagePort = event.ports[0];
var readFile = function (dirEntry) {
if (dirEntry === null) {
console.error("Title " + title + " not found in archive.");
messagePort.postMessage({
'action': 'giveContent',
'title': title,
'content': ''
});
} else if (dirEntry.isRedirect()) {
appstate.selectedArchive.resolveRedirect(dirEntry, function (resolvedDirEntry) {
var redirectURL = resolvedDirEntry.namespace + "/" + resolvedDirEntry.url;
// Ask the ServiceWork to send an HTTP redirect to the browser.
// We could send the final content directly, but it is necessary to let the browser know in which directory it ends up.
// Else, if the redirect URL is in a different directory than the original URL,
// the relative links in the HTML content would fail. See #312
messagePort.postMessage({
'action': 'sendRedirect',
'title': title,
'redirectUrl': redirectURL
});
});
} else {
var mimetype = dirEntry.getMimetype();
var imageDisplayMode = params.imageDisplayMode;
// UWP apps with windows need to allow all images in all throughput
if (/UWP/.test(params.appType) && (appstate.target === 'window' || appstate.messageChannelWaiting) &&
params.imageDisplay) { imageDisplayMode = 'all'; }
// We need to do the same for Gutenberg and PHET ZIMs
if (/gutenberg|phet/i.test(appstate.selectedArchive._file._files[0].name)) {
imageDisplayMode = 'all';
}
if (/\bhtml\b/i.test(mimetype)) {
// Intercept files of type html and apply transformations
var message = {
'action': 'giveContent',
'title': title,
'mimetype': mimetype,
'imageDisplay': imageDisplayMode
};
var timer;
var thisMessage = message;
var thisMessagePort = messagePort;
var postTransformedHTML = function() {
clearTimeout(timer);
if (params.transformedHTML && /<html[^>]*>/.test(params.transformedHTML)) {
// // Because UWP app window can only be controlled from the Service Worker, we have to allow all images
// // to be called from any external windows
// if (/UWP/.test(params.appType) && (appstate.target === 'window' || appstate.messageChannelWaiting) &&
// params.imageDisplay) { imageDisplayMode = 'all'; }
// // We need to do the same for Gutenberg and PHET ZIMs
// if (/gutenberg|phet/i.test(appstate.selectedArchive._file._files[0].name)) {
// imageDisplayMode = 'all';
// }
appstate.messageChannelWaiting = false;
// Let's send the content to the ServiceWorker
thisMessage.content = params.transformedHTML;
thisMessage.imageDisplay = imageDisplayMode;
params.transformedHTML = '';
maxPageWidthProcessed = false;
loaded = false;
var thisDirEntry = dirEntry;
// If loading the iframe, we can hide the frame (for UWP apps: for others, the doc should already be
// hidden). Note that testing appstate.target is probably redundant for UWP because it will always
// be iframe even if an external window is loaded... (but we probably need to do so for other cases)
if (appstate.target === 'iframe') articleContainer.style.display = 'none';
articleContainer.onload = function() {
articleLoadedSW(thisDirEntry);
};
// New windows do not respect the onload event because they've been pre-populated,
// so we have to simulate this event (note potential for race condition if timeout is too short)
// NB The UWP app cannot control the opened window, so it can only be controlled by the Service Worker
if (/UWP/.test(params.appType)) {
setTimeout(function () {
articleContainer.style.display = 'block';
}, 800);
setTimeout(function () {
$("#searchingArticles").hide();
}, 2000);
} else {
setTimeout(function () {
if (!loaded) articleLoadedSW(thisDirEntry);
}, 400);
}
thisMessagePort.postMessage(thisMessage);
} else {
setTimeout(postTransformedHTML, 500);
}
};
if (!params.transformedHTML) {
// It's an unstransformed html file, so we need to do some content transforms and wait for the HTML to be available
if (!~params.lastPageVisit.indexOf(dirEntry.url)) params.lastPageVisit = '';
// Tell the read routine that the request comes from a messageChannel
appstate.messageChannelWaiting = true;
readArticle(dirEntry);
timer = setTimeout(postTransformedHTML, 300);
} else {
postTransformedHTML();
}
return;
}
// Let's read the content in the ZIM file
appstate.selectedArchive.readBinaryFile(dirEntry, function (fileDirEntry, content) {
console.log('SW read binary file for: ' + dirEntry.url);
var mimetype = fileDirEntry.getMimetype();
// Let's send the content to the ServiceWorker
var message = {
'action': 'giveContent',
'title': title,
'mimetype': mimetype,
'imageDisplay': imageDisplayMode,
'content': content.buffer
};
// if (/\bjavascript$/i.test(mimetype)) {
// // Soome scripts need the doucment to be visible, but we must remove max page width first
// // if user has requested this, or we get ugly page redraws
// if (!maxPageWidthProcessed) removePageMaxWidth();
// document.getElementById('articleContent').style.display = 'block';
// }
messagePort.postMessage(message, [content.buffer]);
});
}
};
appstate.selectedArchive.getDirEntryByPath(title).then(readFile).catch(function (err) {
console.error('Failed to read ' + title, err);
messagePort.postMessage({
'action': 'giveContent',
'title': title,
'content': new Uint8Array
});
});
} else {
console.error("Invalid message received", event.data);
}
}
}
// Compile some regular expressions needed to modify links
// Pattern to find the path in a url
var regexpPath = /^(.*\/)[^\/]+$/;
// Pattern to find a ZIM URL (with its namespace) - see https://wiki.openzim.org/wiki/ZIM_file_format#Namespaces
var regexpZIMUrlWithNamespace = /^[./]*([-ABCIJMUVWX]\/.+)$/;
// Regex below finds images, scripts, stylesheets (not tracks) with ZIM-type metadata and image namespaces [kiwix-js #378].
// It first searches for <img, <script, <link, etc., then scans forward to find, on a word boundary, either src=["'] or href=["']
// (ignoring any extra whitespace), and it then tests the path of the URL with a non-capturing negative lookahead that excludes
// URLs that begin 'http' (i.e. non-relative URLs). It then captures the whole of the URL up until either the opening delimiter
// (" or ', which is capture group \3) or a querystring or hash character (? or #). When the regex is used below, it will be further
// processed to calculate the ZIM URL from the relative path. This regex can cope with legitimate single quote marks (') in the URL.
var regexpTagsWithZimUrl = /(<(?:img|script|link)\b[^>]*?\s)(?:src|href)(\s*=\s*(["']))(?!http|app:)(.+?)(?=\3|\?|#)/ig;
// Regex below tests the html of an article for active content [kiwix-js #466]
// It inspects every <script> block in the html and matches in the following cases: 1) the script loads a UI application called app.js;
// 2) the script block has inline content that does not contain "importScript()", "toggleOpenSection" or an "articleId" assignment
// (these strings are used widely in our fully supported wikimedia ZIMs, so they are excluded); 3) the script block is not of type "math"
// (these are MathJax markup scripts used extensively in Stackexchange ZIMs). Note that the regex will match ReactJS <script type="text/html">
// markup, which is common in unsupported packaged UIs, e.g. PhET ZIMs.
var regexpActiveContent = /<script\b(?:(?![^>]+src\b)|(?=[^>]+src\b=["'][^"']+?app\.js))(?!>[^<]+(?:importScript\(\)|toggleOpenSection|articleId\s?=\s?['"]))(?![^>]+type\s*=\s*["'](?:math\/|[^"']*?math))/i;
// DEV: The regex below matches ZIM links (anchor hrefs) that should have the html5 "donwnload" attribute added to
// the link. This is currently the case for epub and pdf files in Project Gutenberg ZIMs -- add any further types you need
// to support to this regex. The "zip" has been added here as an example of how to support further filetypes
var regexpDownloadLinks = /^.*?\.epub($|\?)|^.*?\.pdf($|\?)|^.*?\.zip($|\?)/i;
// This matches the data-kiwixurl of all <link> tags containing rel="stylesheet" in raw HTML unless commented out
var regexpSheetHref = /(<link\s+(?=[^>]*rel\s*=\s*["']stylesheet)[^>]*(?:href|data-kiwixurl)\s*=\s*["'])([^"']+)(["'][^>]*>)(?!\s*--\s*>)/ig;
params.containsMathTexRaw = false;
params.containsMathTex = false;
params.containsMathSVG = false;
var treePath;
// Stores a url to direntry mapping and is refered to/updated anytime there is a css lookup
// When archive changes these caches should be reset.
// Currently happens only in setLocalArchiveFromFileList and setLocalArchiveFromArchiveList.
//var cssDirEntryCache = new Map(); //This one is never hit!
var cssBlobCache = new Map();
// Placeholders for the article container, the article window and the article DOM
var articleContainer = document.getElementById('articleContent');
var articleWindow, articleDocument;
/**
* Display the the given HTML article in the web page,
* and convert links to javascript calls
* NB : in some error cases, the given title can be null, and the htmlArticle contains the error message
* @param {DirEntry} dirEntry The Directory Entry of the article
* @param {String} htmlArticle The decoded HTML of the article
*/
function displayArticleContentInContainer(dirEntry, htmlArticle) {
//if (! isDirEntryExpectedToBeDisplayed(dirEntry)) {
// return;
//}
//TESTING
console.log("** HTML received **");
console.log("Loading stylesheets...");
// Display Bootstrap warning alert if the landing page contains active content
if (!params.hideActiveContentWarning && params.isLandingPage && params.contentInjectionMode === 'jquery') {
if (regexpActiveContent.test(htmlArticle)) uiUtil.displayActiveContentWarning();
}
// App appears to have successfully launched
params.appIsLaunching = false;
params.isLandingPage = false;
// Calculate the current article's ZIM baseUrl to use when processing relative links
var baseUrl = dirEntry.namespace + '/' + dirEntry.url.replace(/[^/]+$/, '');
//Since page has been successfully loaded, store it in the browser history
if (params.contentInjectionMode === 'jquery') pushBrowserHistoryState(dirEntry.namespace + '/' + dirEntry.url);
// Store for fast retrieval
params.lastPageVisit = dirEntry.namespace + '/' + dirEntry.url + '@kiwixKey@' + appstate.selectedArchive._file._files[0].name;
cache.setArticle(appstate.selectedArchive._file._files[0].name, dirEntry.namespace + '/' + dirEntry.url, htmlArticle, function(){});
params.htmlArticle = htmlArticle;
// Replaces ZIM-style URLs of img, script, link and media tags with a data-kiwixurl to prevent 404 errors [kiwix-js #272 #376]
// This replacement also processes the URL relative to the page's ZIM URL so that we can find the ZIM URL of the asset
// with the correct namespace (this works for old-style -,I,J namespaces and for new-style C namespace)
if (params.contentInjectionMode == 'jquery') {
htmlArticle = htmlArticle.replace(regexpTagsWithZimUrl, function(match, blockStart, equals, quote, relAssetUrl) {
var assetZIMUrl = uiUtil.deriveZimUrlFromRelativeUrl(relAssetUrl, baseUrl);
// DEV: Note that deriveZimUrlFromRelativeUrl produces a *decoded* URL (and incidentally would remove any URI component
// if we had captured it). We therefore re-encode the URI with encodeURI (which does not encode forward slashes) instead
// of encodeURIComponent.
return blockStart + 'data-kiwixurl' + equals + encodeURI(assetZIMUrl);
});
}
// Remove any empty media containers on page
htmlArticle = htmlArticle.replace(/(<(audio|video)\b(?:[^<]|<(?!\/\2))+<\/\2>)/ig, function (p0) {
return /(?:src|data-kiwixurl)\s*=\s*["']/.test(p0) ? p0 : '';
});
//Some documents (e.g. Ray Charles Index) can't be scrolled to the very end, as some content remains benath the footer
//so add some whitespace at the end of the document
htmlArticle = htmlArticle.replace(/(<\/body>)/i, "\r\n<p>&nbsp;</p><p>&nbsp;</p><p>&nbsp;</p><p>&nbsp;</p>\r\n$1");
htmlArticle = htmlArticle.replace(/(dditional\s+terms\s+may\s+apply\s+for\s+the\s+media\s+files[^<]+<\/div>\s*)/i, "$1\r\n<h1></h1><p>&nbsp;</p><p>&nbsp;</p><p>&nbsp;</p>\r\n");
//@TODO - remove this when issue fixed: VERY DIRTY PATCH FOR HTML IN PAGE TITLES on Wikivoyage
htmlArticle = htmlArticle.replace(/&lt;a href[^"]+"\/wiki\/([^"]+)[^<]+&gt;([^<]+)&lt;\/a&gt;/ig, "<a href=\"$1.html\">$2</a>");
htmlArticle = htmlArticle.replace(/&lt;(\/?)(i|b|em|strong)&gt;/ig, "<$1$2>");
//@TODO - remove when fixed on mw-offliner: dirty patch for removing extraneous tags in ids
htmlArticle = htmlArticle.replace(/(\bid\s*=\s*"[^\s}]+)\s*\}[^"]*/g, "$1");
//Remove erroneous content frequently on front page
htmlArticle = htmlArticle.replace(/<h1\b[^>]+>[^/]*?User:Popo[^<]+<\/h1>\s*/i, "");
htmlArticle = htmlArticle.replace(/<span\b[^>]+>[^/]*?User:Popo[^<]+<\/span>\s*/i, "");
//Put misplaced hatnote headers inside <h1> block back in correct position @TODO remove this when fixed in mw-offliner
var hatnote;
var hatnotes = [];
do {
hatnote = htmlArticle.match(/<h1\b(?:[^<]|<(?!h2))+?((?:<div\s+[^>]+\b(?:hatnote|homonymie)\b[\s\S]+?<\/div>\s*)+)/i);
if (hatnote) {
htmlArticle = htmlArticle.replace(hatnote[1], '');
hatnotes.push(hatnote[1]);
}
} while (hatnote);
if (hatnotes.length) {
hatnotes.forEach(function (hnt) {
htmlArticle = htmlArticle.replace(/(<\/h1>\s*)/i, "$1" + hnt.replace(/(<div\s+)/i, '$1style="padding-top:10px;" '));
});
}
//Put misplaced disambiguation header back in its correct position @TODO remove this when fixed in mw-offliner
var noexcerpt = htmlArticle.match(/<dl\b(?:[^<]|<(?!\/dl>))+?(?:For other places with the same name|Not to be confused with|mw-redirect[^<]+travel topic|This article is a)(?:[^<]|<(?!\/dl>))+?<\/dl>\s*/i);
if (noexcerpt && noexcerpt.length) {
htmlArticle = htmlArticle.replace(noexcerpt, "");
htmlArticle = htmlArticle.replace(/(<\/h1>\s*)/i, "$1" + noexcerpt);
}
//Remove white background colour (causes flashes in dark mode)
htmlArticle = htmlArticle.replace(/(<body\b[^>]+style=["'][^"']*)background-color\s*:\s*[^;]+;\s*/i, '$1');
htmlArticle = htmlArticle.replace(/(<div\b(?=[^>]+class=\s*["'][^"']*mw-body)[^>]+style=["'][^"']*)background-color\s*:\s*[^;]+;\s*/i, '$1');
//Display IPA pronunciation info erroneously hidden in some ZIMs
htmlArticle = htmlArticle.replace(/(<span\b[^>]+?class\s*=\s*"[^"]+?mcs-ipa[^>]+?display:\s*)none/i, "$1inline");
//Remove any background:url statements in style blocks as they cause the system to attempt to load them
htmlArticle = htmlArticle.replace(/background:url\([^)]+\)[^;}]*/ig, '');
//Remove the details polyfill: it's poor and doesn't recognize Edgium
htmlArticle = htmlArticle.replace(/<script\b[^<]+details[^"']*polyfill\.js[^<]+<\/script>\s*/i, '');
// And make sure all sections are open - this doesn't work, because they are all subsequently closed by JS
// htmlArticle = htmlArticle.replace(/(<details\b(?![^>]+\sopen)[^>]+)>/ig, '$1 open>');
// Remove the script.js that closes top-level sections if user requested this
if (params.openAllSections) htmlArticle = htmlArticle.replace(/<script\b[^>]+-\/(j\/js_modules\/)?script\.js"[^<]*<\/script>/i, "");
if (params.cssCache) {
// Remove landing page scripts that don't work in SW mode
htmlArticle = htmlArticle.replace(/<script\b[^>]+-\/[^>]*((?:images_loaded|masonry)\.min|article_list_home)\.js"[^<]*<\/script>/gi, '');
// Set max-width for infoboxes (now set in -/s/styles.css)
// htmlArticle = htmlArticle.replace(/(<table\s+)(class=["'][^"']*infobox\b)/gi, '$1style="max-width:25%;" $2');
// Remove override sidebar styles recently hard-coded into some Wikipedia ZIMs - reverted due to error with Wikivoyage and now dealt with in styles.css
// htmlArticle = htmlArticle.replace(/<style\s+data-mw-deduplicate[^<]+<\/style>\s*/gi, '');
// Edit sidebar style to make it an infobox
htmlArticle = htmlArticle.replace(/(<table\s+class=["'][^"']*)sidebar\s/gi, '$1infobox ');
}
//Remove empty div that causes layout issues in desktop style
htmlArticle = htmlArticle.replace(/<div\b[^>]*?>\s*<\/div>\s*/, '');
// Deal with incorrectly sized masonry pages
htmlArticle = htmlArticle.replace(/(<body\b[^<]+<div\b[^>]+?id=['"]container['"][^>]*)/i, '$1 style="height:auto;"');
//For all cases, neutralize the toggleOpenSection javascript that causes a crash
//htmlArticle = htmlArticle.replace(/(onclick\s*=\s*["'])toggleOpenSection[^"']*(['"]\s*)/ig, "$1$2");
// Remove and save inline javascript contents only (does not remove scripts with src)
// This is required because most app CSPs forbid inline scripts or require hashes
// DEV: {5,} in regex means script must have at least 5 characters between the script tags to be matched
//var regexpScripts = /<script\b(?![^>]+type\s*=\s*["']text\/html)(?![^>]+src\s*=)[^>]*>([^<]{5,})<\/script>/ig;
//var inlineJavaScripts = [];
//htmlArticle = htmlArticle.replace(regexpScripts, function(match, inlineScript) {
// inlineJavaScripts.push(inlineScript);
// return "";
//});
if (params.contentInjectionMode == 'jquery') {
// Neutralize all inline scripts for now (later use above), excluding math blocks or react templates
htmlArticle = htmlArticle.replace(/<(script\b(?![^>]+type\s*=\s*["'](?:math\/|text\/html|[^"']*?math))(?:[^<]|<(?!\/script>))+<\/script)>/ig, function (p0, p1) {
return '<!-- ' + p1 + ' --!>';
});
//Neutralize onload events, as they cause a crash in ZIMs with proprietary UIs
htmlArticle = htmlArticle.replace(/(<[^>]+?)onload\s*=\s*["'][^"']+["']\s*/ig, '$1');
//Neutralize onclick events
htmlArticle = htmlArticle.replace(/(<[^>]+?)onclick\s*=\s*["'][^"']+["']\s*/ig, '$1');
//Neutralize href="javascript:" links
htmlArticle = htmlArticle.replace(/href\s*=\s*["']javascript:[^"']+["']/gi, 'href=""');
}
//MathJax detection:
params.containsMathTexRaw = params.useMathJax &&
/stackexchange|askubuntu|superuser|stackoverflow|mathoverflow|serverfault|stackapps|proofwiki/i.test(params.storedFile) ?
/[^\\](\$\$?)((?:\\\$|(?!\1)[\s\S])+)\1/.test(htmlArticle) : false;
//if (params.containsMathTexRaw) {
// //Replace undefined \size controlscript with \normalsize (found on proofwiki)
// htmlArticle = htmlArticle.replace(/(\\)size\b/g, '$1normalsize');
//}
//Replace all TeX SVGs with MathJax scripts
if (params.useMathJax) {
// Deal with any newer MathML blocks
htmlArticle = htmlArticle.replace(/(<math\b[^>]+alttext=(["']))((?:[^"']|[\s\S](?!\2))+?)(\2(?:[^<]|<(?!\/math))+(?:[^<]|<(?!img))+)<img\b[^>]+?class=["'][^"']*?mwe-math-fallback-image[^>]+>/ig,
function (_p0, p1, _p2, math, p4) {
// Remove any rogue ampersands in MathJax due to double escaping (by Wikipedia)
math = math.replace(/&amp;/g, '&');
// Change any mbox commands to fbox (because KaTeX doesn't support mbox)
math = math.replace(/mbox{/g, 'fbox{');
return p1 + math + p4 + '<script type="math/tex">' + math + '</script>';
});
// Older math blocks
htmlArticle = htmlArticle.replace(/<img\s+(?=[^>]+?math-fallback-image)[^>]*?alt\s*=\s*(['"])((?:[^"']|(?!\1)[\s\S])+)[^>]+>/ig,
function (p0, p1, math) {
// Remove any rogue ampersands in MathJax due to double escaping (by Wikipedia)
math = math.replace(/&amp;/g, '&');
// Change any mbox commands to fbox (because KaTeX doesn't support mbox)
math = math.replace(/mbox{/g, 'fbox{');
return '<script type="math/tex">' + math + '</script>';
});
}
params.containsMathTex = params.useMathJax ? /<script\s+type\s*=\s*['"]\s*math\/tex\s*['"]/i.test(htmlArticle) : false;
params.containsMathSVG = params.useMathJax ? /<img\s+(?=[^>]+?math-fallback-image)[^>]*?alt\s*=\s*['"][^'"]+[^>]+>/i.test(htmlArticle) : false;
//Adapt German Wikivoyage POI data format
var regexpGeoLocationDE = /<span\s+class\s?=\s?"[^"]+?listing-coordinates[\s\S]+?latitude">([^<]+)[\s\S]+?longitude">([^<]+)<[\s\S]+?(<span[^>]+listing-name[^>]+>([^<]+)<\/span>)/ig;
htmlArticle = htmlArticle.replace(regexpGeoLocationDE, function (match, latitude, longitude, href, id) {
return '<a href="bingmaps:?collection=point.' + latitude + '_' + longitude + '_' + encodeURIComponent(id.replace(/_/g, " ")) +
'">\r\n<img alt="Map marker" title="Diesen Ort auf einer Karte zeigen" src="app:///www/img/icons/map_marker-18px.png" style="position:relative !important;top:-5px !important;margin-top:5px !important" />\r\n</a>' + href;
});
//Adapt English Wikivoyage POI data format
var regexpGeoLocationEN = /(href\s?=\s?")geo:([^,]+),([^"]+)("[^>]+?(?:data-zoom[^"]+"([^"]+))?[^>]+>)[^<]+(<\/a>[\s\S]+?<span\b(?=[^>]+listing-name)[\s\S]+?id\s?=\s?")([^"]+)/ig;
htmlArticle = htmlArticle.replace(regexpGeoLocationEN, function (match, p1, latitude, longitude, p4, p5, p6, id) {
return p1 + "bingmaps:?collection=point." + latitude + "_" + longitude + "_" +
encodeURIComponent(id.replace(/_/g, " ")).replace(/\.(\w\w)/g, "%$1") +
(p5 ? "\&lvl=" + p5 : "") + p4.replace(/style\s?="\s?background:[^"]+"\s?/i, "") + '<img alt="Map marker" title="Show this place on a map" src="app:///www/img/icons/map_marker-18px.png" style="position:relative !important;top:-5px !important;" />' + p6 + id;
});
//Clean up remaining geo: links
htmlArticle = htmlArticle.replace(/href\s*=\s*"\s*geo:([\d.-]+),([\d.-]+)/ig, 'href="bingmaps:?collection=point.$1_$2_' + encodeURIComponent(dirEntry.getTitleOrUrl()));
// Process any app:// links (these are always from the app payload) to match the current protocol
htmlArticle = htmlArticle.replace(/(['"])app:\/\//g, function (p0, p1) {
var appRootDir = window.location.href.replace(/\/www\/.*$/i, '');
return p1 + appRootDir;
});
//Setup endnote backlinks if the ZIM doesn't have any
htmlArticle = htmlArticle.replace(/<li\b[^>]+id=["']cite[-_]note[-_]([^"']+)[^>]+>(?![^/]+?[↑^])/ig, function (match, id) {
var fnSearchRegxp = new RegExp('id=["' + "'](cite[-_]ref[-_]" + id.replace(/[-_()+]/g, "[-_()]+") + '[^"' + "']*)", 'i');
var fnReturnMatch = htmlArticle.match(fnSearchRegxp);
var fnReturnID = fnReturnMatch ? fnReturnMatch[1] : "";
return match + '\r\n<a href=\"#' + fnReturnID + '">^&nbsp;</a>';
});
//Preload stylesheets [kiwix-js #149]
//Set up blobArray of promises
var prefix = (window.location.protocol + '//' + window.location.host + window.location.pathname).replace(/\/[^/]*$/, '');
var cssArray = htmlArticle.match(regexpSheetHref);
var blobArray = [];
var cssSource = params.cssSource;
var cssCache = params.cssCache;
var zimType = "";
if (cssArray) {
getBLOB(cssArray);
} else {
// Apply dark or light content theme if necessary
var determinedTheme = params.cssTheme == 'auto' ? cssUIThemeGetOrSet('auto', true) : params.cssTheme;
var contentThemeStyle = (determinedTheme == "dark") ? '<link href="' + prefix + '/-/s/style-dark.css" rel="stylesheet" type="text/css">\r\n' :
params.cssTheme == "invert" ? '<link href="' + prefix + '/-/s/style-dark-invert.css" rel="stylesheet" type="text/css">\r\n' : "";
htmlArticle = htmlArticle.replace(/\s*(<\/head>)/i, contentThemeStyle + '$1');
injectHTML();
}
//Extract CSS URLs from given array of links
function getBLOB(arr) {
var testCSS = arr.join();
zimType = /-\/s\/style\.css/i.test(testCSS) ? "desktop" : zimType;
zimType = /-\/static\/main\.css/i.test(testCSS) ? "desktop-stx" : zimType; //Support stackexchange
zimType = /gutenberg\.css/i.test(testCSS) ? "desktop-gtb" : zimType; //Support Gutenberg
zimType = /minerva|mobile/i.test(testCSS) ? "mobile" : zimType;
cssSource = cssSource == "auto" ? zimType : cssSource; //Default to in-built zimType if user has selected automatic detection of styles
if (/minerva|inserted.style/i.test(testCSS) && (cssCache || zimType != cssSource)) {
//Substitute ridiculously long style name TODO: move this code to transformStyles
for (var i = arr.length; i--;) { //TODO: move to transfromStyles
arr[i] = /minerva/i.test(arr[i]) ? '<link ' + (params.contentInjectionMode == 'jquery' ? 'data-kiwixurl' : 'href') +
'="-/s/style-mobile.css" rel="stylesheet" type="text/css">' : arr[i];
// Delete stylesheet if will be inserted via minerva anyway (avoid linking it twice)
if (/inserted.style/i.test(arr[i]) && /minerva/i.test(testCSS)) {
arr.splice(i, 1);
}
}
}
for (var i = 0; i < arr.length; i++) {
var zimLink = arr[i].match(/(?:href|data-kiwixurl)\s*=\s*['"]([^'"]+)/i);
zimLink = zimLink ? decodeURIComponent(zimLink[1]) : '';
//Remove path DON'T DO THIS! SW mode fails if you do...
//zimLink = zimLink.replace(/^[.\/]*([\S\s]+)$/, '$1');
/* zl = zimLink; zim = zimType; cc = cssCache; cs = cssSource; i */
var filteredLink = transformStyles.filterCSS(zimLink, zimType, cssCache, cssSource, i);
if (filteredLink.rtnFunction == "injectCSS") {
blobArray[i] = filteredLink.zl;
injectCSS();
} else {
resolveCSS(filteredLink.zl, i);
}
}
}
function resolveCSS(title, index) {
if (cssBlobCache && cssBlobCache.has(title)) {
console.log("*** cssBlobCache hit ***");
blobArray.push([title, cssBlobCache.get(title)]);
injectCSS();
} else {
appstate.selectedArchive.getDirEntryByPath(title)
.then(function (dirEntry) {
uiUtil.poll("Resolving CSS [" + title.replace(/[^/]+\//g, '').substring(0, 18) + "]...");
return appstate.selectedArchive.readBinaryFile(dirEntry,
function (fileDirEntry, content) {
//DEV: Uncomment line below and break on next to capture cssContent for local filesystem cache
//var cssContent = util.uintToString(content);
var cssBlob = new Blob([content], {
type: 'text/css'
});
var newURL = [fileDirEntry.namespace + "/" + fileDirEntry.url, URL.createObjectURL(cssBlob)];
blobArray.push(newURL);
if (cssBlobCache)
cssBlobCache.set(newURL[0], newURL[1]);
injectCSS(); //DO NOT move this: it must run within .then function to pass correct values
});
}).catch(function (e) {
console.error("could not find DirEntry for CSS : " + title, e);
//@TODO Change this to push an array of [title, title] afters simplified code in injectCSS()
blobArray.push(title);
injectCSS();
});
}
}
function injectCSS() {
// We have to count the blobArray elements because some may have been spliced out
// See https://stackoverflow.com/questions/28811911/find-array-length-in-javascript
var blobArrayLength = blobArray.filter(function () {
return true;
}).length;
if (blobArrayLength >= cssArray.length) { //If all promised values have been obtained
var resultsArray = [];
var testBlob;
for (var i in cssArray) { //Put them back in the correct order
var match = 0;
for (var j in blobArray) { //Iterate the blobArray to find the matching entry
//console.log("blobArray[j]: " + blobArray[j] + "\r\nblobArray[j][0]: " + blobArray[j][0]);
testBlob = blobArray[j][0].length == 1 ? blobArray[j] : blobArray[j][0]; //What a kludge! TODO: fix this ugly mixing of arrays and strings
if (~cssArray[i].indexOf(testBlob)) {
match = 1;
break;
}
}
testBlob = match && /blob:/i.test(blobArray[j][1]) ? blobArray[j][1] : blobArray[i]; //Whoa!!! Steady on!
resultsArray[i] = cssArray[i].replace(/(?:data-kiwixurl|href)\s*=\s*["']([^"']+)/i, 'href="' +
testBlob + '" data-kiwixhref="$1'); //Store the original URL for later use
//DEV note: do not attempt to add onload="URL.revokeObjectURL...)": see [kiwix.js #284]
//DEBUG:
//console.log("BLOB CSS #" + i + ": " + resultsArray[i] + "\nshould correspond to: " + testBlob);
}
cssArray = resultsArray;
htmlArticle = htmlArticle.replace(regexpSheetHref, ""); //Void existing stylesheets
var cssArray$ = "\r\n" + cssArray.join("\r\n") + "\r\n";
if (~cssSource.indexOf("mobile")) { //If user has selected mobile display mode...
var mobileCSS = transformStyles.toMobileCSS(htmlArticle, zimType, cssCache, cssSource, cssArray$);
htmlArticle = mobileCSS.html;
cssArray$ = mobileCSS.css;
}
if (~cssSource.indexOf("desktop")) { //If user has selected desktop display mode...
var desktopCSS = transformStyles.toDesktopCSS(htmlArticle, zimType, cssCache, cssSource, cssArray$);
htmlArticle = desktopCSS.html;
cssArray$ = desktopCSS.css;
}
//Remove any voided styles
cssArray$ = cssArray$.replace(/<link\shref="#"[^>]+>\s*/g, '');
//Add dark mode CSS if required
var determinedTheme = params.cssTheme == 'auto' ? cssUIThemeGetOrSet('auto', true) : params.cssTheme;
cssArray$ += (determinedTheme == "dark") ? '<link href="' + prefix + '/-/s/style-dark.css" rel="stylesheet" type="text/css">\r\n' :
params.cssTheme == "invert" ? '<link href="' + prefix + '/-/s/style-dark-invert.css" rel="stylesheet" type="text/css">\r\n' : "";
//Ensure all headings are open
//htmlArticle = htmlArticle.replace(/class\s*=\s*["']\s*client-js\s*["']\s*/i, "");
htmlArticle = htmlArticle.replace(/\s*(<\/head>)/i, cssArray$ + "$1");
console.log("All CSS resolved");
injectHTML(); //Pass the revised HTML to the image and JS subroutine...
} else {
uiUtil.poll("Waiting for CSS # " + (cssArray.length - blobArrayLength) + " out of " + cssArray.length + "...");
}
}
//End of preload stylesheets code
function injectHTML() {
//Inject htmlArticle into iframe
uiUtil.clear(); //Void progress messages
// Extract any css classes from the html tag (they will be stripped when injected in iframe with .innerHTML)
if (params.contentInjectionMode === 'jquery') var htmlCSS = htmlArticle.match(/<html[^>]*class\s*=\s*["']\s*([^"']+)/i);
htmlCSS = htmlCSS ? htmlCSS[1] : '';
// Hide any alert box that was activated in uiUtil.displayFileDownloadAlert function
$('#downloadAlert').hide();
// Code below will run after we have written the new article to the articleContainer
var articleLoaded = function() {
// Set a global error handler for articleWindow
articleWindow.onerror = function (msg, url, line, col, error) {
console.error('Error caught in ZIM contents [' + url + ':' + line + ']:\n' + msg, error);
return true;
};
if (appstate.target === 'iframe' && !articleContainer.contentDocument && window.location.protocol === 'file:') {
uiUtil.systemAlert("<p>You seem to be opening kiwix-js with the file:// protocol, which blocks access to the app's iframe. "
+ "We have tried to open your article in a separate window. You may be able to use it with limited functionality.</p>"
+ "<p>The easiest way to run this app fully is to download and run it as a browser extension (from the vendor store). "
+ "Alternatively, you can open it through a web server: either use a local one (http://localhost/...) "
+ "or a remote one. For example, you can try your ZIM out right now with our online version of the app: "
+ "<a href='https://kiwix.github.io/kiwix-js/'>https://kiwix.github.io/kiwix-js/</a>.</p>"
+ "<p>Another option is to force your browser to accept file access (a potential security breach): "
+ "on Chrome, you can start it with the <code>--allow-file-access-from-files</code> command-line argument; on Firefox, "
+ "you can set <code>privacy.file_unique_origin</code> to <code>false</code> in about:config.</p>");
articleContainer = window.open('', dirEntry.title, 'toolbar=0,location=0,menubar=0,width=800,height=600,resizable=1,scrollbars=1');
params.windowOpener = 'window';
appstate.target = 'window';
articleContainer.kiwixType = appstate.target;
articleWindow = articleContainer;
}
// Ensure the window target is permanently stored as a property of the articleWindow (since appstate.target can change)
articleWindow.kiwixType = appstate.target;
// Scroll the old container to the top
articleWindow.scrollTo(0,0);
articleDocument = articleWindow.document.documentElement;
// Hide the document before injecting to avoid display flash before stylesheets are loaded; also improves performance
// during loading of assets in most browsers, but UWP mnobile (at least) cannot build the DOM if hidden
if ('serviceWorker' in navigator) articleDocument.hidden = true;
// ** Write article html to the new article container **
articleDocument.innerHTML = htmlArticle;
var docBody = articleDocument.querySelector('body');
if (articleWindow.kiwixType === 'iframe') {
// Add any missing classes stripped from the <html> tag
if (htmlCSS) docBody.classList.add(htmlCSS);
// Deflect drag-and-drop of ZIM file on the iframe to Config
docBody.addEventListener('dragover', handleIframeDragover);
docBody.addEventListener('drop', handleIframeDrop);
listenForSearchKeys();
setupTableOfContents();
var makeLink = uiUtil.makeReturnLink(dirEntry.getTitleOrUrl());
var linkListener = eval(makeLink);
//Prevent multiple listeners being attached on each browse
var returnDivs = document.getElementsByClassName("returntoArticle");
for (var i = 0; i < returnDivs.length; i++) {
returnDivs[i].removeEventListener('click', linkListener);
returnDivs[i].addEventListener('click', linkListener);
}
}
//Set relative font size + Stackexchange-family multiplier
docBody.style.fontSize = ~zimType.indexOf("stx") ? params.relativeFontSize * 1.5 + "%" : params.relativeFontSize + "%";
//Set page width according to user preference
removePageMaxWidth();
setupHeadings();
listenForNavigationKeys();
// Process endnote references (so they open the reference block if closed)
var refs = docBody.getElementsByClassName("mw-reflink-text");
if (refs) {
for (var l = 0; l < refs.length; l++) {
var reference = refs[l].parentElement;
if (reference) {
reference.addEventListener("click", function (obj) {
var refID = obj.target.hash || obj.target.parentNode.hash;
if (!refID) return;
refID = refID.replace(/#/, "");
var refLocation = articleDocument.getElementById(refID);
// In some ZIMs the id is in the parent node or in the parent of the parent
var returnID = obj.target.id || obj.target.parentNode.id || obj.target.parentNode.parentNode.id;
// Add backlink to refLocation if missing
if (returnID && !~refLocation.innerHTML.indexOf('#' + returnID)) {
var returnLink = document.createElement('a');
returnLink.href = '#' + returnID;
returnLink.innerHTML = '↑';
refLocation.insertBefore(returnLink, refLocation.firstChild);
}
var refNext = util.getClosestBack(refLocation, function (el) {
return /^(H2|DETAILS)$/.test(el.tagName);
});
if (refNext) {
if (/DETAILS/.test(refNext.tagName)) {
refNext.open = true;
return;
}
refNext.classList.add("open-block");
//refNext.innerHTML = refNext.innerHTML.replace(/<br\s*\/?>$/i, "");
refNext = refNext.nextElementSibling;
while (refNext && refNext.classList.contains("collapsible-block")) {
refNext.classList.add("open-block");
refNext = refNext.nextElementSibling;
}
}
});
}
}
}
openAllSections();
parseAnchorsJQuery(dirEntry);
images.prepareImagesJQuery(articleWindow);
//loadJavascript(); //Disabled for now, since it does nothing - also, would have to load before images, ideally through controlled css loads above
insertMediaBlobsJQuery();
var determinedTheme = params.cssTheme === 'auto' ? cssUIThemeGetOrSet('auto') : params.cssTheme;
if (params.allowHTMLExtraction && appstate.target === 'iframe') {
uiUtil.insertBreakoutLink(determinedTheme);
}
// Document has loaded except for images, so we can now change the startup cookie (and delete) [see init.js]
// document.cookie = 'lastPageLoad=success;expires=Thu, 21 Sep 1979 00:00:01 UTC';
settingsStore.removeItem('lastPageLoad');
// If we reloaded the page to print the desktop style, we need to return to the printIntercept dialogue
if (params.printIntercept) printIntercept();
// Make sure the article area is displayed
setTab();
checkToolbar();
setTimeout(function() {
articleDocument.bgcolor = "";
articleDocument.hidden = false;
articleWindow.document.body.hidden = false;
}, 0);
};
// For articles loaded in the iframe, we need to set the articleWindow (but if the user is opening a new tab/window,
// then the articleWindow has already been set in the click event of the ZIM link)
if (appstate.target === 'iframe') {
// Tell jQuery we're removing the iframe document: clears jQuery cache and prevents memory leaks [kiwix-js #361]
$('#articleContent').contents().remove();
articleContainer = document.getElementById('articleContent');
articleWindow = articleContainer.contentWindow;
}
// Hide the document to avoid display flash before stylesheets are loaded; also improves performance during loading of
// assets in most browsers
// DEV: We cannot do `articleWindow.document.documentElement.hidden = true;` because documentElement gets overwritten
// during the document.write() process; and since the latter is synchronous, we get slow display rewrites before it is
// effective if we do it after document.close().
// Note that UWP apps cannot communicate to a newly opened window except via postmessage, but Service Worker can still
// control the Window. Additionally, Edge Legacy cannot build the DOM for a completely hidden document, hence we catch
// these browser types with 'MSBlobBuilder' (and also IE11).
if (!(/UWP/.test(params.appType) && (appstate.target === 'window' || appstate.messageChannelWaiting))) {
htmlArticle = htmlArticle.replace(/(<html\b[^>]*)>/i, '$1 bgcolor="' +
(cssUIThemeGetOrSet(params.cssTheme, true) !== 'light' ? 'grey' : 'whitesmoke') + '">');
if (!('MSBlobBuilder' in window)) htmlArticle = htmlArticle.replace(/(<body\b[^>]*)/i, '$1 hidden');
}
if (params.contentInjectionMode === 'serviceworker') {
// Add doctype if missing so that scripts run in standards mode
// (quirks mode prevents katex from running, and is incompatible with jQuery)
params.transformedHTML = !/^\s*(?:<!DOCTYPE|<\?xml)\s+/i.test(htmlArticle) ? '<!DOCTYPE html>\n' + htmlArticle : htmlArticle;
// Remove page max width restriction if required
if (params.removePageMaxWidth) params.transformedHTML = removePageMaxWidth(params.transformedHTML);
// We will need the encoded URL on article load so that we can set the iframe's src correctly,
// but we must not encode the '/' character or else relative links may fail [kiwix-js #498]
var encodedUrl = dirEntry.url.replace(/[^/]+/g, function (matchedSubstring) {
return encodeURIComponent(matchedSubstring);
});
// If the request was not initiated by an existing controlled window, we instantiate the request here
if (!appstate.messageChannelWaiting) {
// We put the ZIM filename as a prefix in the URL, so that browser caches are separate for each ZIM file
articleWindow.location.href = "../" + appstate.selectedArchive._file._files[0].name + "/" + dirEntry.namespace + "/" + encodedUrl;
}
return;
}
// Calculate the current article's encoded ZIM baseUrl to use when processing relative links
baseUrl = (dirEntry.namespace + '/' + dirEntry.url.replace(/[^/]+$/, ''))
// URI-encode anything that is not a '/'
.replace(/[^/]+/g, function(m) {
return encodeURIComponent(m);
});
// Write article html to the article container
// articleWindow.document.open('text/html', 'replace');
// articleWindow.document.write(htmlArticle);
// articleWindow.document.close();
if (appstate.target === 'iframe') {
// Store the frame article's target in the top-level window, so that when we retrieve the window with
// history manipulation, we'll know where to place the iframe contentWindow
window.kiwixType = appstate.target;
articleContainer.onload = articleLoaded;
articleContainer.src = 'article.html';
} else {
// Attempt to establish an independent history record for windows (jQuery / window-tab mode)
articleWindow.onpopstate = historyPop;
// The articleWindow has already been set in the click event of the ZIM link and the dummy article was loaded there
// (to avoid popup blockers). Firefox loads windows asynchronously, so we need to wait for onclick load to be fully
// cleared, or else Firefox overwrites the window immediately after we load the html content into it.
setTimeout(articleLoaded, 400);
}
} // End of injectHtml
function insertMediaBlobsJQuery() {
var trackBlob;
var media = articleDocument.querySelectorAll('video, audio, source');
Array.prototype.slice.call(media).forEach(function (mediaSource) {
var source = mediaSource.getAttribute('src');
source = source ? uiUtil.deriveZimUrlFromRelativeUrl(source, baseUrl) : null;
if (!source || !regexpZIMUrlWithNamespace.test(source)) {
if (source) console.error('No usable media source was found for: ' + source);
return;
}
var mediaElement = /audio|video/i.test(mediaSource.tagName) ? mediaSource : mediaSource.parentElement;
// Create custom subtitle / cc load menu if it doesn't already exist
if (!articleWindow.document.getElementById('kiwixCCMenu')) buildCustomCCMenu(articleWindow.document, mediaElement, function (ccBlob) {
trackBlob = ccBlob;
});
// Load media file
appstate.selectedArchive.getDirEntryByPath(decodeURIComponent(source)).then(function (dirEntry) {
return appstate.selectedArchive.readBinaryFile(dirEntry, function (fileDirEntry, mediaArray) {
var mimeType = mediaSource.type ? mediaSource.type : dirEntry.getMimetype();
var blob = new Blob([mediaArray], {
type: mimeType
});
mediaSource.src = URL.createObjectURL(blob);
// In Firefox and Chromium it is necessary to re-register the inserted media source
// but do not reload for text tracks (closed captions / subtitles)
if (/track/i.test(mediaSource.tagName)) return;
mediaElement.load();
// Add a download link in case media source not supported
if (articleWindow.kiwixType === 'iframe') {
var iframe = document.getElementById('articleContent').contentDocument;
document.getElementById('alertBoxFooter').innerHTML =
'<div id="downloadAlert" class="alert alert-info alert-dismissible">\n' +
' <a href="#" class="close" data-dismiss="alert" aria-label="close">&times;</a>\n' +
' <span id="alertMessage"></span>\n' +
'</div>\n';
var alertMessage = document.getElementById('alertMessage');
var filename = iframe.title + '_' + dirEntry.url.replace(/^.*\/([^\/]+)$/, '$1');
// Make filename safe
filename = filename.replace(/[\/\\:*?"<>|]/g, '_');
alertMessage.innerHTML = '<a href="#" class="alert-link" id="downloadMedia">Download this file</a> (and any selected subtitles) to play with another app';
document.getElementById('downloadMedia').addEventListener('click', function () {
var downloadFiles = [];
downloadFiles.push({
'blob': blob,
'filename': filename,
'src': mediaSource.src
});
// Add any selected subtitle file to the download package
var selTextTrack = iframe.getElementById('kiwixSelCC');
if (selTextTrack) {
var selTextExt = selTextTrack.dataset.kiwixurl.replace(/^.*\.([^.]+)$/, '$1');
// Subtitle files should have same name as video + .es.vtt (for example)
downloadFiles.push({
'blob': trackBlob,
'filename': filename.replace(/^(.*)\.[^.]+$/, '$1.' + selTextTrack.srclang + '.' + selTextExt),
'src': selTextTrack.src
});
}
for (var j = downloadFiles.length; j--;) {
if (typeof Windows !== 'undefined' && typeof Windows.Storage !== 'undefined') {
uiUtil.downloadBlobUWP(downloadFiles[j].blob, downloadFiles[j].filename, alertMessage);
} else {
var mimeType = downloadFiles[j].blob.type ? downloadFiles[j].blob.type : 'application/octet-stream';
var a = document.createElement('a');
a.href = downloadFiles[j].src;
a.target = '_blank';
a.type = mimeType;
a.download = downloadFiles[j].filename;
alertMessage.appendChild(a); // NB we have to add the anchor to the document for Firefox to be able to click it
try {
a.click();
} catch (err) {
// If the click fails, use an alternative download method
if (window.navigator && window.navigator.msSaveBlob) {
// This works for IE11
window.navigator.msSaveBlob(downloadFiles[j].blob, downloadFiles[j].filename);
}
}
}
}
articleContainer.addEventListener('unload', function (e) {
alertMessage.remove();
});
});
}
});
});
});
// For TED ZIMs, the initial video div height is set incorectly, so we correct it
var videoWrapper = articleWindow.document.getElementById('video-wrapper');
if (videoWrapper) videoWrapper.style.height = 'auto';
}
/**
* Create a custom dropdown menu item beneath the given mediaElement (audio or video block) to allow the user to
* select the language of text tracks (subtitles/CC) to extract from the ZIM (this is necessary because there is
* no universal onchange event that fires for subtitle changes in the html5 video widget when the URL is invalid)
*
* @param {Document} doc The document in which the new menu will be placed (usually window.document or iframe)
* @param {Element} mediaElement The media element (usually audio or video block) which contains the text tracks
* @param {Function} callback The function to call wtih the blob
*/
function buildCustomCCMenu(doc, mediaElement, callback) {
var optionList = [];
var langs = '';
var src = '';
var currentTracks = mediaElement.getElementsByTagName('track');
// Extract track data from current media element
for (var i = currentTracks.length; i--;) {
langs = currentTracks[i].label + ' [' + currentTracks[i].srclang + ']';
src = currentTracks[i].getAttribute('src');
src = src ? uiUtil.deriveZimUrlFromRelativeUrl(src, baseUrl) : null;
if (src && regexpZIMUrlWithNamespace.test(src)) {
optionList.unshift('<option value="' + currentTracks[i].srclang + '" data-kiwixsrc="' +
src + '" data-kiwixkind="' + currentTracks[i].kind + '">' + langs + '</option>');
}
currentTracks[i].parentNode.removeChild(currentTracks[i]);
}
optionList.unshift('<option value="" data-kiwixsrc="">None</option>');
var newKiwixCCMenu = '<select id="kiwixCCMenuLangList">\n' + optionList.join('\n') + '\n</select>';
// Create the new container and menu
var d = doc.createElement('DIV');
d.id = 'kiwixCCMenu';
d.setAttribute('style', 'margin-top: 1em; text-align: left; position: relative;');
d.innerHTML = 'Please select subtitle language: ' + newKiwixCCMenu;
mediaElement.parentElement.insertBefore(d, mediaElement.nextSibling);
// Add event listener to extract the text track from the ZIM and insert it into the media element when the user selects it
newKiwixCCMenu = doc.getElementById('kiwixCCMenu').addEventListener('change', function (v) {
var existingCC = doc.getElementById('kiwixSelCC');
if (existingCC) existingCC.parentNode.removeChild(existingCC);
var sel = v.target.options[v.target.selectedIndex];
if (!sel.value) return; // User selected "none"
appstate.selectedArchive.getDirEntryByPath(sel.dataset.kiwixsrc).then(function (dirEntry) {
return appstate.selectedArchive.readBinaryFile(dirEntry, function (fileDirEntry, trackContents) {
var blob = new Blob([trackContents], {
type: 'text/vtt'
});
var t = doc.createElement('track');
t.id = 'kiwixSelCC';
t.kind = sel.dataset.kiwixkind;
t.label = sel.innerHTML;
t.srclang = sel.value;
t.default = true;
t.src = URL.createObjectURL(blob);
t.dataset.kiwixurl = sel.dataset.kiwixsrc;
mediaElement.appendChild(t);
callback(blob);
});
});
});
}
} //End of displayArticleInForm()
function parseAnchorsJQuery(dirEntry) {
var currentProtocol = articleWindow.location.protocol;
currentProtocol === 'about:' ? currentProtocol = ':' : currentProtocol;
var currentHost = articleWindow.location.host;
// Calculate the current article's encoded ZIM baseUrl to use when processing relative links
var baseUrl = (dirEntry.namespace + '/' + dirEntry.url.replace(/[^/]+$/, ''))
// URI-encode anything that is not a '/'
.replace(/[^/]+/g, function(m) {
return encodeURIComponent(m);
});
// Percent-encode dirEntry.url and add regex escape character \ to the RegExp special characters - see https://www.regular-expressions.info/characters.html;
// NB dirEntry.url can also contain path separator / in some ZIMs (Stackexchange). } and ] do not need to be escaped as they have no meaning on their own.
var escapedUrl = encodeURIComponent(dirEntry.url).replace(/([\\$^.|?*+/()[{])/g, '\\$1');
// Pattern to match a local anchor in an href even if prefixed by escaped url; will also match # on its own
var regexpLocalAnchorHref = new RegExp('^(?:#|' + escapedUrl + '#)([^#]*$)');
Array.prototype.slice.call(articleDocument.querySelectorAll('a, area')).forEach(function (anchor) {
// Attempts to access any properties of 'this' with malformed URLs causes app crash in Edge/UWP [kiwix-js #430]
try {
var testHref = anchor.href;
} catch (err) {
console.error('Malformed href caused error:' + err.message);
return;
}
var href = anchor.getAttribute('href');
if (href === null || href === undefined) return;
if (href.length === 0) {
// It's a link with an empty href, pointing to the current page: do nothing.
} else if (regexpLocalAnchorHref.test(href)) {
// It's a local anchor link : remove escapedUrl if any (see above)
anchor.setAttribute('href', href.replace(/^[^#]*/, ''));
} else if (anchor.protocol !== currentProtocol ||
anchor.host !== currentHost) {
// It's an external URL : we should open it in a new tab
anchor.target = '_blank';
} else {
// It's a link to an article or file in the ZIM
addListenersToLink(anchor, href, baseUrl);
}
});
// Add event listeners to the main heading so user can open current document in new tab or window by clicking on it
if (articleWindow.document.body) {
var h1 = articleWindow.document.body.querySelector('h1');
if (h1) addListenersToLink(h1, encodeURIComponent(dirEntry.url.replace(/[^/]+\//g, '')), baseUrl);
}
}
/**
* Add event listeners to a hyperlinked element to extract the linked article or file from the ZIM instead
* of following links
* @param {Node} a The anchor or other linked element to which event listeners will be attached
* @param {String} href The href of the linked element
* @param {String} baseUrl The baseUrl against which relative links will be calculated
*/
function addListenersToLink(a, href, baseUrl) {
var uriComponent = uiUtil.removeUrlParameters(href);
var loadingContainer = false;
var contentType;
var downloadAttrValue;
// Some file types need to be downloaded rather than displayed (e.g. *.epub)
// The HTML download attribute can be Boolean or a string representing the specified filename for saving the file
// For Boolean values, getAttribute can return any of the following: download="" download="download" download="true"
// So we need to test hasAttribute first: see https://developer.mozilla.org/en-US/docs/Web/API/Element/getAttribute
// However, we cannot rely on the download attribute having been set, so we also need to test for known download file types
var isDownloadableLink = a.hasAttribute('download') || regexpDownloadLinks.test(href);
if (isDownloadableLink) {
downloadAttrValue = a.getAttribute('download');
// Normalize the value to a true Boolean or a filename string or true if there is no download attribute
downloadAttrValue = /^(download|true|\s*)$/i.test(downloadAttrValue) || downloadAttrValue || true;
contentType = a.getAttribute('type');
}
// DEV: We need to use the '#' location trick here for cross-browser compatibility with opening a new tab/window
a.setAttribute('href', '#');
// Store the current values, as they may be changed if user switches to another tab before returning to this one
var kiwixTarget = appstate.target;
var thisWindow = articleWindow;
var thisContainer = articleContainer;
var reset = function () {
// By delaying unblocking of the touch event, we prevent multiple touch events launching the same window
a.touched = false;
a.newcontainer = false;
loadingContainer = false;
};
var onDetectedClick = function (e) {
// Restore original values for this window/tab
appstate.target = kiwixTarget;
articleWindow = thisWindow;
articleContainer = thisContainer;
if (a.tagName === 'H1') {
// We have registered a click on the header
if (!a.newcontainer) return; // A new tab wasn't requested, so ignore
// If we're not clicking within the scope of an H1, H2, etc., ignore the click
// if (!uiUtil.getClosestMatchForTagname(e.target, /H\d/)) {
// setTimeout(reset, 1400);
// return;
// }
}
if (params.windowOpener) {
// This processes Ctrl-click, Command-click, the long-press event, and middle-click
if (a.newcontainer) {
// We open the new window immediately so that it is a direct result of user action (click)
// and we'll populate it later - this avoids most popup blockers
loadingContainer = true;
articleContainer = window.open('article.html', params.windowOpener === 'tab' ? '_blank' : a.title,
params.windowOpener === 'window' ? 'toolbar=0,location=0,menubar=0,width=800,height=600,resizable=1,scrollbars=1' : null);
appstate.target = 'window';
articleContainer.kiwixType = appstate.target;
articleWindow = articleContainer;
}
}
e.preventDefault();
e.stopPropagation();
var zimUrl = uiUtil.deriveZimUrlFromRelativeUrl(uriComponent, baseUrl);
goToArticle(zimUrl, downloadAttrValue, contentType);
setTimeout(reset, 1400);
};
a.addEventListener('touchstart', function (e) {
if (!params.windowOpener || a.touched) return;
e.stopPropagation();
// e.preventDefault();
a.touched = true;
loadingContainer = true;
var event = e;
// The link will be clicked if the user long-presses for more than 800ms (if the option is enabled)
setTimeout(function () {
if (!a.touched || a.newcontainer) return;
e.preventDefault();
a.newcontainer = true;
onDetectedClick(event);
}, 800);
}, { passive:false });
a.addEventListener('touchend', function () {
a.touched = false;
a.newcontainer = false;
loadingContainer = false;
});
// This detects right-click in all browsers (only if the option is enabled)
a.addEventListener('contextmenu', function (e) {
console.log('contextmenu');
if (!params.windowOpener) return;
e.preventDefault();
e.stopPropagation();
if (a.touched || a.newcontainer) return; // Prevent double activation
a.newcontainer = true;
onDetectedClick(e);
});
// This traps the middle-click event before tha auxclick event fires
a.addEventListener('mousedown', function (e) {
console.log('mosuedown');
if (!params.windowOpener) return;
e.preventDefault();
e.stopPropagation();
if (a.touched || a.newcontainer) return; // Prevent double activations
if (e.ctrlKey || e.metaKey || e.which === 2 || e.button === 4) {
a.newcontainer = true;
onDetectedClick(e);
} else {
console.log('suppressed mousedown');
}
});
// This detects the middle-click event that opens a new tab in recent Firefox and Chrome
// See https://developer.mozilla.org/en-US/docs/Web/API/Element/auxclick_event
a.addEventListener('auxclick', function (e) {
console.log('auxclick');
if (!params.windowOpener) return;
e.preventDefault();
e.stopPropagation();
});
// The main click routine (called by other events above as well)
a.addEventListener('click', function (e) {
console.log('Click event', e);
// Prevent opening multiple windows
if (loadingContainer || a.touched || a.newcontainer) {
e.preventDefault();
e.stopPropagation();
} else {
onDetectedClick(e);
}
});
}
function setupTableOfContents() {
//var iframe = window.frames[0].frameElement;
var iframe = document.getElementById('articleContent');
var innerDoc = iframe.contentDocument;
var tableOfContents = new uiUtil.toc(innerDoc);
var headings = tableOfContents.getHeadingObjects();
document.getElementById('dropup').style.fontSize = ~~(params.relativeUIFontSize * 0.14) + "px";
var dropup = "";
headings.forEach(function (heading) {
if (/^h1$/i.test(heading.tagName))
dropup += '<li style="font-size:' + params.relativeFontSize + '%;"><a href="#" data-heading-id="' + heading.id + '">' + heading.textContent + '</a></li>';
else if (/^h2$/i.test(heading.tagName))
dropup += '<li style="font-size:' + ~~(params.relativeFontSize * 0.9) + '%;"><a href="#" data-heading-id="' + heading.id + '">' + heading.textContent + '</a></li>';
else if (/^h3$/i.test(heading.tagName))
dropup += '<li style="font-size:' + ~~(params.relativeFontSize * 0.75) + '%;"><a href="#" data-heading-id="' + heading.id + '">' + heading.textContent + '</a></li>';
//Skip smaller headings (if there are any) to avoid making list too long
});
var ToCList = document.getElementById('ToCList');
ToCList.style.maxHeight = ~~(window.innerHeight * 0.75) + 'px';
ToCList.style.marginLeft = ~~(window.innerWidth / 2) - ~~(window.innerWidth * 0.16) + 'px';
ToCList.innerHTML = dropup;
Array.prototype.slice.call(ToCList.getElementsByTagName('a')).forEach(function (listElement) {
listElement.addEventListener('click', function () {
var sectionEle = innerDoc.getElementById(this.dataset.headingId);
var i;
var csec = util.closest(sectionEle, 'details, section');
csec = csec && /DETAILS|SECTION/.test(csec.parentElement.tagName) ? csec.parentElement : csec;
openAllSections(true, csec);
// if (csec) {
// if (/DETAILS/i.test(csec.parentElement.tagName)) csec = csec.parentElement;
// csec.open = true;
// var closedEles = csec.querySelectorAll('details:not([open])');
// for (i = closedEles.length; i--;) {
// closedEles[i].open = true;
// }
// }
// csec = closest(sectionEle, '[style*=display]');
// if (csec && csec.style.display === 'none') {
// var hiddenEles = csec.parentElement.querySelectorAll('[style*=display]');
// for (i = hiddenEles.length; i--;) {
// if (hiddenEles[i].style.display === 'none') hiddenEles[i].style.display = '';
// }
// }
// Scroll to element
sectionEle.scrollIntoView();
// Scrolling up then down ensures that the toolbars show according to user settings
iframe.contentWindow.scrollBy(0, -5);
setTimeout(function () {
iframe.contentWindow.scrollBy(0, 5);
iframe.contentWindow.focus();
}, 250);
});
});
}
/**
* Sets the state of collapsible sections for the iframe document, or for the given node
* @param {Boolean} override An optional value that overrides params.openAllSections (true to open, false to close)
* @param {Node} node An optional node within which elements will be opened or closed (this will normally be a details element)
*/
// Sets state of collapsible sections
function openAllSections(override, node) {
var open = override === false ? false : override || params.openAllSections;
var container = node || document.getElementById('articleContent');
var blocks = container.querySelectorAll('details, section:not([data-mw-section-id="0"]), .collapsible-block, .collapsible-heading');
if (node) processSection(open, node);
for (var x = blocks.length; x--;) {
processSection(open, blocks[x]);
}
}
function processSection(open, node) {
if (/DETAILS|SECTION/.test(node.tagName)) {
if (open) node.setAttribute('open', '');
else node.removeAttribute('open');
if (typeof HTMLDetailsElement === 'undefined' || node.tagName === 'SECTION') {
var children = node.children;
for (var y = children.length; y--;) {
if (/SUMMARY|H\d/.test(children[y].tagName)) continue;
if (open) {
if (/DETAILS|SECTION/.test(children[y].tagName)) children[y].setAttribute('open', '');
children[y].style.removeProperty('display');
} else {
if (/DETAILS|SECTION/.test(children[y].tagName)) children[y].removeAttribute('open');
children[y].style.display = 'none';
}
}
}
} else {
if (open) node.classList.add('open-block');
else node.classList.remove('open-block');
}
}
// Attach listeners to headers to open-close following sections
function setupHeadings() {
var headings = document.getElementById('articleContent').querySelectorAll('h2, h3, h4, h5');
for (var i = headings.length; i--;) {
// Prevent heading from being selected when user clicks on it
headings[i].style.userSelect = 'none';
headings[i].style.msUserSelect = 'none';
headings[i].addEventListener('click', function(e) {
// Override the built-in simplistic polyfill
e.preventDefault();
var that = e.currentTarget;
var detailsEl = util.closest(that, 'details, section');
if (detailsEl) {
var toggle = !detailsEl.hasAttribute('open');
openAllSections(toggle, detailsEl);
}
});
}
}
params.preloadAllImages = function () {
if (params.preloadingAllImages !== true) {
$('#searchingArticles').show();
params.preloadingAllImages = true;
if (params.imageDisplay) params.contentInjectionMode === 'jquery' ?
images.prepareImagesJQuery(articleWindow, true) : images.prepareImagesServiceWorker(articleWindow, true);
return;
}
// All images should now be loaded, or else user did not request loading images
uiUtil.extractHTML();
$('#searchingArticles').hide();
};
// Load Javascript content
function loadJavaScriptJQuery() {
$('#articleContent').contents().find('script[data-kiwixurl]').each(function () {
var script = $(this);
var scriptUrl = script.attr("data-kiwixurl");
// TODO check that the type of the script is text/javascript or application/javascript
var title = uiUtil.removeUrlParameters(decodeURIComponent(scriptUrl));
appstate.selectedArchive.getDirEntryByPath(title).then(function (dirEntry) {
if (dirEntry === null) {
console.log("Error: js file not found: " + title);
} else {
appstate.selectedArchive.readBinaryFile(dirEntry, function (fileDirEntry, content) {
// TODO : JavaScript support not yet functional [kiwix-js #152]
uiUtil.feedNodeWithBlob(script, 'src', content, 'text/javascript', params.allowHTMLExtraction);
});
}
}).catch(function (e) {
console.error("could not find DirEntry for javascript : " + title, e);
});
});
}
/**
* Changes the URL of the browser page, so that the user might go back to it
*
* @param {String} title The title of the article to store (if storing an article)
* @param {String} titleSearch The title of the search (if storing a search)
*/
function pushBrowserHistoryState(title, titleSearch) {
// DEV: Note that appstate.target will always be 'iframe' for title searches, so we do not need to account for that
var targetWin = appstate.target === 'iframe' ? window : articleWindow;
var stateObj = {};
var urlParameters;
var stateLabel;
if (title && !("" === title)) {
// Prevents creating a double history for the same page (wrapped to prevent exception in IE and Edge Legacy for tabs)
try { if (targetWin.history.state && targetWin.history.state.title === title) return; }
catch (err) { console.error('Unable to access History for this window', err); return; }
stateObj.title = title;
urlParameters = "?title=" + title;
stateLabel = "Wikipedia Article : " + title;
}
else if (titleSearch && !("" === titleSearch)) {
stateObj.titleSearch = titleSearch;
urlParameters = "?titleSearch=" + titleSearch;
stateLabel = "Wikipedia search : " + titleSearch;
}
else return;
// Edge Legacy and IE cannot push history state to another window/tab and produce an exception;
// independent navigation history is therefore disabled for these browsers
try {
targetWin.history.pushState(stateObj, stateLabel, urlParameters);
} catch (error) {
history.pushState(stateObj, stateLabel, urlParameters);
}
}
/**
* Extracts the content of the given article pathname, or a downloadable file, from the ZIM
*
* @param {String} path The pathname (namespace + filename) to the article or file to be extracted
* @param {Boolean|String} download A Bolean value that will trigger download of title, or the filename that should
* be used to save the file in local FS (in HTML5 spec, a string value for the download attribute is optional)
* @param {String} contentType The mimetype of the downloadable file, if known
*/
function goToArticle(path, download, contentType) {
//This removes any search highlighting
clearFindInArticle();
document.getElementById('searchingArticles').style.display = 'block';
var zimName = appstate.selectedArchive._file._files[0].name.replace(/\.[^.]+$/, '').replace('_\d+_\d+$', '');
if (~path.indexOf(params.cachedStartPages[zimName])) {
goToMainArticle();
return;
}
appstate.selectedArchive.getDirEntryByPath(path).then(function (dirEntry) {
if (dirEntry === null || dirEntry === undefined) {
document.getElementById('searchingArticles').style.display = 'none';
console.error("Article with title " + path + " not found in the archive");
goToMainArticle();
} else if (download) {
appstate.selectedArchive.readBinaryFile(dirEntry, function (fileDirEntry, content) {
var mimetype = contentType || fileDirEntry.getMimetype();
uiUtil.displayFileDownloadAlert(path, download, mimetype, content);
document.getElementById('searchingArticles').style.display = 'none';
});
} else {
params.isLandingPage = false;
$('.alert').hide();
readArticle(dirEntry);
}
}).catch(function (e) {
console.error("Error reading article with title " + path, e);
if (params.appIsLaunching) goToMainArticle();
// Line below prevents bootloop
params.appIsLaunching = false;
});
}
function goToRandomArticle() {
document.getElementById('searchingArticles').style.display = 'block';
if (appstate.selectedArchive === null) {
return;
} //Prevents exception if user hasn't selected an archive
appstate.selectedArchive.getRandomDirEntry(function (dirEntry) {
if (dirEntry === null || dirEntry === undefined) {
document.getElementById('searchingArticles').style.display = 'none';
uiUtil.systemAlert("Error finding random article.");
} else {
// We fall back to the old A namespace to support old ZIM files without a text/html MIME type for articles
// DEV: If articlePtrPos is defined in zimFile, then we are using a v1 article-only title listing. By definition,
// all dirEntries in an article-only listing must be articles.
if (appstate.selectedArchive._file.articlePtrPos || dirEntry.getMimetype() === 'text/html' || dirEntry.namespace === 'A') {
params.isLandingPage = false;
$('#activeContent').hide();
$('#searchingArticles').show();
readArticle(dirEntry);
} else {
// If the random title search did not end up on an article,
// we try again, until we find one
goToRandomArticle();
}
}
});
}
function goToMainArticle() {
document.getElementById('searchingArticles').style.display = 'block';
appstate.selectedArchive.getMainPageDirEntry(function (dirEntry) {
if (dirEntry === null || dirEntry === undefined) {
console.error("Error finding main article.");
document.getElementById('searchingArticles').style.display = 'none';
$("#welcomeText").show();
} else {
// DEV: see comment above under goToRandomArticle()
if (dirEntry.redirect || dirEntry.getMimetype() === 'text/html' || dirEntry.namespace === 'A') {
params.isLandingPage = true;
readArticle(dirEntry);
} else {
console.error("The main page of this archive does not seem to be an article");
$("#searchingArticles").hide();
$("#welcomeText").show();
}
}
});
}
});
Reference in New Issue View Git Blame Copy Permalink