diff --git a/www/index.html b/www/index.html index 4e057cf7..d282f275 100644 --- a/www/index.html +++ b/www/index.html @@ -1,245 +1,245 @@ - - - - - - Evopedia - - - - - - - - - - - -
-
- - - -
-
-
- - - - -
- or Find articles around me (work in progress)
- Longitude/Latitude/MaxDistance: -
- or Go to a random article
- -
-
-
-
- - - - -
- You can search the content of your Wikipedia archive by typing in the above search field. -
It will propose articles starting with what you typed -
Or you can search for articles located around you (geolocation needed on your device) -
- - -
-
-
-
- -
 
-
-
- -
- - - - - - + + + + + + Evopedia + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+ or Find articles around me (work in progress)
+ Latitude/Longitude/MaxDistance: +
+ or Go to a random article
+ +
+
+
+
+ + + + +
+ You can search the content of your Wikipedia archive by typing in the above search field. +
It will propose articles starting with what you typed +
Or you can search for articles located around you (geolocation needed on your device) +
+ + +
+
+
+
+ +
 
+
+
+ +
+ + + + + + diff --git a/www/js/app.js b/www/js/app.js index 89f52765..5b332ea1 100644 --- a/www/js/app.js +++ b/www/js/app.js @@ -1,616 +1,628 @@ -/** - * 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 Evopedia. - * - * Evopedia 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. - * - * Evopedia 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 Evopedia (file LICENSE-GPLv3.txt). If not, see - */ - -// This uses require.js to structure javascript: -// http://requirejs.org/docs/api.html#define - -define(function(require) { - - var $ = require('jquery'); - - // Evopedia javascript dependencies - var evopediaTitle = require('title'); - var evopediaArchive = require('archive'); - var util = require('util'); - var cookies = require('cookies'); - var geometry = require('geometry'); - var osabstraction = require('osabstraction'); - - // Maximum number of titles to display in a search - var MAX_SEARCH_RESULT_SIZE = 50; - - // Maximum distance (in degrees) where to search for articles around me - // In fact, we use a square around the user, not a circle - // This square has a length of twice the value of this constant - // One degree is ~111 km at the equator - var MAX_DISTANCE_ARTICLES_NEARBY = 0.1; - - var localArchive = null; - - // Define behavior of HTML elements - $('#searchTitles').on('click', function(e) { - searchTitlesFromPrefix($('#prefix').val()); - $("#welcomeText").hide(); - $("#readingArticle").hide(); - if ($('#navbarToggle').is(":visible") && $('#liHomeNav').is(':visible')) { - $('#navbarToggle').click(); - } - }); - $('#formTitleSearch').on('submit', function(e) { - document.getElementById("searchTitles").click(); - return false; - }); - $('#prefix').on('keyup', function(e) { - if (localArchive !== null && localArchive.titleFile !== null) { - onKeyUpPrefix(e); - } - }); - $("#btnArticlesNearby").on("click", function(e) { - searchTitlesNearby(); - $("#welcomeText").hide(); - $("#readingArticle").hide(); - if ($('#navbarToggle').is(":visible") && $('#liHomeNav').is(':visible')) { - $('#navbarToggle').click(); - } - }); - $("#btnRandomArticle").on("click", function(e) { - goToRandomArticle(); - $("#welcomeText").hide(); - $('#titleList').hide(); - $("#readingArticle").hide(); - if ($('#navbarToggle').is(":visible") && $('#liHomeNav').is(':visible')) { - $('#navbarToggle').click(); - } - }); - // Bottom bar : - $('#btnBack').on('click', function(e) { - history.back(); - return false; - }); - $('#btnForward').on('click', function(e) { - history.forward(); - return false; - }); - $('#btnHomeBottom').on('click', function(e) { - $('#btnHome').click(); - return false; - }); - // Top menu : - $('#btnHome').on('click', function(e) { - // 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(); - } - // Show the selected content in the page - $('#about').hide(); - $('#configuration').hide(); - $('#formTitleSearch').show(); - $("#welcomeText").show(); - $('#titleList').show(); - $('#articleContent').show(); - // Give the focus to the search field, and clean up the page contents - $("#prefix").val(""); - $('#prefix').focus(); - $("#titleList").html(""); - $("#readingArticle").hide(); - $("#articleContent").html(""); - return false; - }); - $('#btnConfigure').on('click', function(e) { - // 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(); - } - // Show the selected content in the page - $('#about').hide(); - $('#configuration').show(); - $('#formTitleSearch').hide(); - $("#welcomeText").hide(); - $('#titleList').hide(); - $("#readingArticle").hide(); - $('#articleContent').hide(); - return false; - }); - $('#btnAbout').on('click', function(e) { - // 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(); - } - // Show the selected content in the page - $('#about').show(); - $('#configuration').hide(); - $('#formTitleSearch').hide(); - $("#welcomeText").hide(); - $('#titleList').hide(); - $("#readingArticle").hide(); - $('#articleContent').hide(); - return false; - }); - - // Detect if DeviceStorage is available - var storages = []; - function searchForArchives() { - // If DeviceStorage is available, we look for archives in it - $("#btnConfigure").click(); - $('#scanningForArchives').show(); - evopediaArchive.LocalArchive.scanForArchives(storages, populateDropDownListOfArchives); - } - - if ($.isFunction(navigator.getDeviceStorage)) { - if ($.isFunction(navigator.getDeviceStorages)) { - // The method getDeviceStorages is available (FxOS>=1.1) - // We have to scan all the DeviceStorages, because getDeviceStorage - // only returns the default Device Storage. - // See https://bugzilla.mozilla.org/show_bug.cgi?id=885753 - storages = $.map(navigator.getDeviceStorages("sdcard"), function(s) { - return new osabstraction.StorageFirefoxOS(s); - }); - } - else { - // The method getDeviceStorages is not available (FxOS 1.0) - // The fallback is to use getDeviceStorage - storages[0] = new osabstraction.StorageFirefoxOS( - navigator.getDeviceStorage("sdcard")); - } - } else if ($.isFunction(window.requestFileSystem)) { // cordova - window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, function(fs) { - storages[0] = new osabstraction.StoragePhoneGap(fs); - searchForArchives(); - }); - } - - if (storages !== null && storages.length > 0) { - searchForArchives(); - } - 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 { - $("#btnConfigure").click(); - } - } - - - // Display the article when the user goes back in the browser history - window.onpopstate = function(event) { - if (event.state) { - var titleName = event.state.titleName; - goToArticle(titleName); - } - }; - - /** - * Populate the drop-down list of titles with the given list - * @param {type} archiveDirectories - */ - function populateDropDownListOfArchives(archiveDirectories) { - $('#scanningForArchives').hide(); - $('#chooseArchiveFromLocalStorage').show(); - var comboArchiveList = document.getElementById('archiveList'); - comboArchiveList.options.length = 0; - for (var i = 0; i < archiveDirectories.length; i++) { - var archiveDirectory = archiveDirectories[i]; - if (archiveDirectory === "/") { - alert("It looks like you have put some archive files at the root of your sdcard. Please move them in a subdirectory"); - } - else { - comboArchiveList.options[i] = new Option(archiveDirectory, archiveDirectory); - } - } - $('#archiveList').on('change', setLocalArchiveFromArchiveList); - if (comboArchiveList.options.length > 0) { - var lastSelectedArchive = cookies.getItem("lastSelectedArchive"); - if (lastSelectedArchive !== null && lastSelectedArchive !== undefined && lastSelectedArchive !== "") { - // Attempt to select the corresponding item in the list, if it exists - if ($("#archiveList option[value='"+lastSelectedArchive+"']").length > 0) { - $("#archiveList").val(lastSelectedArchive); - } - } - // Set the localArchive as the last selected (or the first one if it has never been selected) - setLocalArchiveFromArchiveList(); - } - else { - alert("Welcome to Evopedia! This application needs a wikipedia archive in your SD-card. Please download one and put it on the SD-card (see About section). Also check that your device is not connected to a computer through USB device storage (which locks the SD-card content)"); - $("#btnAbout").click(); - } - } - - /** - * Sets the localArchive from the selected archive in the drop-down list - */ - function setLocalArchiveFromArchiveList() { - var archiveDirectory = $('#archiveList').val(); - localArchive = new evopediaArchive.LocalArchive(); - localArchive.initializeFromDeviceStorage(storages, archiveDirectory); - cookies.setItem("lastSelectedArchive",archiveDirectory,Infinity); - // The archive is set : go back to home page to start searching - $("#btnHome").click(); - } - - /** - * Displays the zone to select files from the archive - */ - function displayFileSelect() { - $('#openLocalFiles').show(); - $('#archiveFiles').on('change', setLocalArchiveFromFileSelect); - } - - /** - * Sets the localArchive from the File selects populated by user - */ - function setLocalArchiveFromFileSelect() { - localArchive = new evopediaArchive.LocalArchive(); - localArchive.initializeFromArchiveFiles(document.getElementById('archiveFiles').files); - // The archive is set : go back to home page to start searching - $("#btnHome").click(); - } - - /** - * Handle key input in the prefix input zone - * @param {type} evt - */ - 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) { - $('#searchTitles').click(); - } - } - ,500); - } - - - /** - * Search the index for titles that start with the given prefix (implemented - * with a binary search inside the index file) - * @param {type} prefix - */ - function searchTitlesFromPrefix(prefix) { - $('#searchingForTitles').show(); - $('#configuration').hide(); - $('#articleContent').empty(); - if (localArchive !== null && localArchive.titleFile !== null) { - localArchive.findTitlesWithPrefix(prefix.trim(), MAX_SEARCH_RESULT_SIZE, populateListOfTitles); - } else { - $('#searchingForTitles').hide(); - // We have to remove the focus from the search field, - // so that the keyboard does not stay above the message - $("#searchTitles").focus(); - alert("Archive not set : please select an archive"); - $("#btnConfigure").click(); - } - } - - - /** - * Display the list of titles with the given array of titles - * @param {type} titleArray - */ - function populateListOfTitles(titleArray) { - var titleListDiv = $('#titleList'); - var titleListDivHtml = ""; - for (var i = 0; i < titleArray.length; i++) { - var title = titleArray[i]; - titleListDivHtml += "" + title.getReadableName() + ""; - } - titleListDiv.html(titleListDivHtml); - $("#titleList a").on("click",handleTitleClick); - $('#searchingForTitles').hide(); - } - - - /** - * Checks if the small archive is in use - * If it is, display a warning message about the hyperlinks not working - */ - function checkSmallArchive() { - if (localArchive.language === "small" && !cookies.hasItem("warnedSmallArchive")) { - // The user selected the "small" archive, which is quite incomplete - // So let's display a warning to the user - - // If the focus is on the search field, we have to move it, - // else the keyboard hides the message - if ($("#prefix").is(":focus")) { - $("searchTitles").focus(); - } - alert("You selected the 'small' archive. This archive is OK for testing, but be aware that very few hyperlinks in the articles will work because it's only a very small subset of the English dump."); - // We will not display this warning again for one day - cookies.setItem("warnedSmallArchive",true,86400); - } - } - - - /** - * Handles the click on a title - * @param {type} event - * @returns {undefined} - */ - function handleTitleClick(event) { - // If we use the small archive, a warning should be displayed to the user - checkSmallArchive(); - - var titleId = event.target.getAttribute("titleId"); - $("#titleList").empty(); - findTitleFromTitleIdAndLaunchArticleRead(titleId); - var title = evopediaTitle.Title.parseTitleId(localArchive, titleId); - pushBrowserHistoryState(title.name); - $("#prefix").val(""); - return false; - } - - - /** - * Creates an instance of title from given titleId (including resolving redirects), - * and call the function to read the corresponding article - * @param {type} titleId - */ - function findTitleFromTitleIdAndLaunchArticleRead(titleId) { - if (localArchive.dataFiles && localArchive.dataFiles.length > 0) { - var title = evopediaTitle.Title.parseTitleId(localArchive, titleId); - $("#articleName").html(title.name); - $("#readingArticle").show(); - $("#articleContent").html(""); - if (title.fileNr === 255) { - localArchive.resolveRedirect(title, readArticle); - } - else { - readArticle(title); - } - } - else { - alert("Data files not set"); - } - } - - /** - * Read the article corresponding to the given title - * @param {type} title - */ - function readArticle(title) { - if (title.fileNr === 255) { - localArchive.resolveRedirect(title, readArticle); - } - else { - localArchive.readArticle(title, displayArticleInForm); - } - } - - /** - * Display the the given HTML article in the web page, - * and convert links to javascript calls - * @param {type} title - * @param {type} htmlArticle - */ - function displayArticleInForm(title, htmlArticle) { - $("#readingArticle").hide(); - - // Display the article inside the web page. - $('#articleContent').html(htmlArticle); - - // Compile the regular expressions needed to modify links - var regexOtherLanguage = /^\.?\/?\.\.\/([^\/]+)\/(.*)/; - var regexImageLink = /^.?\/?[^:]+:(.*)/; - - // Convert links into javascript calls - $('#articleContent').find('a').each(function() { - // Store current link's url - var url = $(this).attr("href"); - if (url === null || url === undefined) { - return; - } - var lowerCaseUrl = url.toLowerCase(); - var cssClass = $(this).attr("class"); - - if (cssClass === "new") { - // It's a link to a missing article : display a message - $(this).on('click', function(e) { - alert("Missing article in Wikipedia"); - return false; - }); - } - else if (url.slice(0, 1) === "#") { - // It's an anchor link : do nothing - } - else if (url.substring(0, 4) === "http") { - // It's an external link : open in a new tab - $(this).attr("target", "_blank"); - } - else if (url.match(regexOtherLanguage)) { - // It's a link to another language : change the URL to the online version of wikipedia - // The regular expression extracts $1 as the language, and $2 as the title name - var onlineWikipediaUrl = url.replace(regexOtherLanguage, "https://$1.wikipedia.org/wiki/$2"); - $(this).attr("href", onlineWikipediaUrl); - // Open in a new tab - $(this).attr("target", "_blank"); - } - else if (url.match(regexImageLink) - && (util.endsWith(lowerCaseUrl, ".png") - || util.endsWith(lowerCaseUrl, ".svg") - || util.endsWith(lowerCaseUrl, ".jpg") - || util.endsWith(lowerCaseUrl, ".jpeg"))) { - // It's a link to a file of wikipedia : change the URL to the online version and open in a new tab - var onlineWikipediaUrl = url.replace(regexImageLink, "https://"+localArchive.language+".wikipedia.org/wiki/File:$1"); - $(this).attr("href", onlineWikipediaUrl); - $(this).attr("target", "_blank"); - } - else { - // It's a link to another article : add an onclick event to go to this article - // instead of following the link - if (url.length>=2 && url.substring(0, 2) === "./") { - url = url.substring(2); - } - $(this).on('click', function(e) { - var titleName = decodeURIComponent(url); - pushBrowserHistoryState(titleName); - goToArticle(titleName); - return false; - }); - } - }); - - // Load math images - $('#articleContent').find('img').each(function() { - var image = $(this); - var m = image.attr("src").match(/^\/math.*\/([0-9a-f]{32})\.png$/); - if (m) { - localArchive.loadMathImage(m[1], function(data) { - image.attr("src", 'data:image/png;base64,' + data); - }); - } - }); - } - - /** - * Changes the URL of the browser page - * @param {type} titleName - */ - function pushBrowserHistoryState(titleName) { - if (titleName) { - var stateObj = {titleName: titleName}; - window.history.pushState(stateObj, "Wikipedia Article : " + titleName, "?title=" + titleName); - } - } - - - /** - * Replace article content with the one of the given title - * @param {type} titleName - * @returns {undefined} - */ - function goToArticle(titleName) { - localArchive.getTitleByName(titleName, function(title) { - if (title === null || title === undefined) { - $("#readingArticle").hide(); - alert("Article with title " + titleName + " not found in the archive"); - } - else { - $("#articleName").html(titleName); - $("#readingArticle").show(); - $("#articleContent").html(""); - readArticle(title); - } - }); - } - - /** - * Looks for titles located around where the device is geolocated - */ - function searchTitlesNearby() { - $('#searchingForTitles').show(); - $('#configuration').hide(); - $('#articleContent').empty(); - if (localArchive !== null && localArchive.titleFile !== null) { - var longitude = $('#longitude').val(); - var latitude = $('#latitude').val(); - var maxDistance = $('#maxDistance').val(); - if (!maxDistance) { - maxDistance = MAX_DISTANCE_ARTICLES_NEARBY; - } - if (!longitude || !latitude) { - // If the user did not give any latitude/longitude, we try to use geolocation - if (navigator.geolocation) { - var geo_options = { - enableHighAccuracy: false, - maximumAge: 1800000, // 30 minutes - timeout: 10000 // 10 seconds - }; - - function geo_success(pos) { - var crd = pos.coords; - - alert("Found your location : latitude=" + crd.latitude + ", longitude=" + crd.longitude); - - var rectangle = new geometry.rect( - crd.longitude - maxDistance, - crd.latitude - maxDistance, - maxDistance * 2, - maxDistance * 2); - - localArchive.getTitlesInCoords(rectangle, MAX_SEARCH_RESULT_SIZE, populateListOfTitles); - }; - - function geo_error(err) { - alert("Unable to geolocate your device : " + err.code + " : " + err.message); - }; - - navigator.geolocation.getCurrentPosition(geo_success, geo_error, geo_options); - } - else { - alert("Geolocation is not supported (or disabled) on your device, or on your browser"); - } - } - else { - // The user gave a latitude/longitude : let's use it to find articles around that location - var rectangle = new geometry.rect( - longitude - maxDistance, - latitude - maxDistance, - maxDistance * 2, - maxDistance * 2); - - localArchive.getTitlesInCoords(rectangle, MAX_SEARCH_RESULT_SIZE, populateListOfTitles); - } - - } else { - $('#searchingForTitles').hide(); - // We have to remove the focus from the search field, - // so that the keyboard does not stay above the message - $("#searchTitles").focus(); - alert("Archive not set : please select an archive"); - $("#btnConfigure").click(); - } - } - - function goToRandomArticle() { - localArchive.getRandomTitle(function(title) { - if (title === null || title === undefined) { - alert("Error finding random article."); - } - else { - $("#articleName").html(title.name); - $("#readingArticle").show(); - $("#articleContent").html(""); - readArticle(title); - } - }); - } - -}); +/** + * 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 Evopedia. + * + * Evopedia 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. + * + * Evopedia 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 Evopedia (file LICENSE-GPLv3.txt). If not, see + */ + +// This uses require.js to structure javascript: +// http://requirejs.org/docs/api.html#define + +define(function(require) { + + var $ = require('jquery'); + + // Evopedia javascript dependencies + var evopediaTitle = require('title'); + var evopediaArchive = require('archive'); + var util = require('util'); + var cookies = require('cookies'); + var geometry = require('geometry'); + var osabstraction = require('osabstraction'); + + // Maximum number of titles to display in a search + var MAX_SEARCH_RESULT_SIZE = 50; + + // Maximum distance (in degrees) where to search for articles around me + // In fact, we use a square around the user, not a circle + // This square has a length of twice the value of this constant + // One degree is ~111 km at the equator + var MAX_DISTANCE_ARTICLES_NEARBY = 0.05; + + var localArchive = null; + + // Define behavior of HTML elements + $('#searchTitles').on('click', function(e) { + searchTitlesFromPrefix($('#prefix').val()); + $("#welcomeText").hide(); + $("#readingArticle").hide(); + if ($('#navbarToggle').is(":visible") && $('#liHomeNav').is(':visible')) { + $('#navbarToggle').click(); + } + }); + $('#formTitleSearch').on('submit', function(e) { + document.getElementById("searchTitles").click(); + return false; + }); + $('#prefix').on('keyup', function(e) { + if (localArchive !== null && localArchive.titleFile !== null) { + onKeyUpPrefix(e); + } + }); + $("#btnArticlesNearby").on("click", function(e) { + searchTitlesNearby(); + $("#welcomeText").hide(); + $("#readingArticle").hide(); + if ($('#navbarToggle').is(":visible") && $('#liHomeNav').is(':visible')) { + $('#navbarToggle').click(); + } + }); + $("#btnRandomArticle").on("click", function(e) { + goToRandomArticle(); + $("#welcomeText").hide(); + $('#titleList').hide(); + $("#readingArticle").hide(); + if ($('#navbarToggle').is(":visible") && $('#liHomeNav').is(':visible')) { + $('#navbarToggle').click(); + } + }); + // Bottom bar : + $('#btnBack').on('click', function(e) { + history.back(); + return false; + }); + $('#btnForward').on('click', function(e) { + history.forward(); + return false; + }); + $('#btnHomeBottom').on('click', function(e) { + $('#btnHome').click(); + return false; + }); + // Top menu : + $('#btnHome').on('click', function(e) { + // 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(); + } + // Show the selected content in the page + $('#about').hide(); + $('#configuration').hide(); + $('#formTitleSearch').show(); + $("#welcomeText").show(); + $('#titleList').show(); + $('#articleContent').show(); + // Give the focus to the search field, and clean up the page contents + $("#prefix").val(""); + $('#prefix').focus(); + $("#titleList").html(""); + $("#readingArticle").hide(); + $("#articleContent").html(""); + return false; + }); + $('#btnConfigure').on('click', function(e) { + // 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(); + } + // Show the selected content in the page + $('#about').hide(); + $('#configuration').show(); + $('#formTitleSearch').hide(); + $("#welcomeText").hide(); + $('#titleList').hide(); + $("#readingArticle").hide(); + $('#articleContent').hide(); + return false; + }); + $('#btnAbout').on('click', function(e) { + // 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(); + } + // Show the selected content in the page + $('#about').show(); + $('#configuration').hide(); + $('#formTitleSearch').hide(); + $("#welcomeText").hide(); + $('#titleList').hide(); + $("#readingArticle").hide(); + $('#articleContent').hide(); + return false; + }); + + // Detect if DeviceStorage is available + var storages = []; + function searchForArchives() { + // If DeviceStorage is available, we look for archives in it + $("#btnConfigure").click(); + $('#scanningForArchives').show(); + evopediaArchive.LocalArchive.scanForArchives(storages, populateDropDownListOfArchives); + } + + if ($.isFunction(navigator.getDeviceStorage)) { + if ($.isFunction(navigator.getDeviceStorages)) { + // The method getDeviceStorages is available (FxOS>=1.1) + // We have to scan all the DeviceStorages, because getDeviceStorage + // only returns the default Device Storage. + // See https://bugzilla.mozilla.org/show_bug.cgi?id=885753 + storages = $.map(navigator.getDeviceStorages("sdcard"), function(s) { + return new osabstraction.StorageFirefoxOS(s); + }); + } + else { + // The method getDeviceStorages is not available (FxOS 1.0) + // The fallback is to use getDeviceStorage + storages[0] = new osabstraction.StorageFirefoxOS( + navigator.getDeviceStorage("sdcard")); + } + } else if ($.isFunction(window.requestFileSystem)) { // cordova + window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, function(fs) { + storages[0] = new osabstraction.StoragePhoneGap(fs); + searchForArchives(); + }); + } + + if (storages !== null && storages.length > 0) { + searchForArchives(); + } + 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 { + $("#btnConfigure").click(); + } + } + + + // Display the article when the user goes back in the browser history + window.onpopstate = function(event) { + if (event.state) { + var titleName = event.state.titleName; + goToArticle(titleName); + } + }; + + /** + * Populate the drop-down list of titles with the given list + * @param {type} archiveDirectories + */ + function populateDropDownListOfArchives(archiveDirectories) { + $('#scanningForArchives').hide(); + $('#chooseArchiveFromLocalStorage').show(); + var comboArchiveList = document.getElementById('archiveList'); + comboArchiveList.options.length = 0; + for (var i = 0; i < archiveDirectories.length; i++) { + var archiveDirectory = archiveDirectories[i]; + if (archiveDirectory === "/") { + alert("It looks like you have put some archive files at the root of your sdcard. Please move them in a subdirectory"); + } + else { + comboArchiveList.options[i] = new Option(archiveDirectory, archiveDirectory); + } + } + $('#archiveList').on('change', setLocalArchiveFromArchiveList); + if (comboArchiveList.options.length > 0) { + var lastSelectedArchive = cookies.getItem("lastSelectedArchive"); + if (lastSelectedArchive !== null && lastSelectedArchive !== undefined && lastSelectedArchive !== "") { + // Attempt to select the corresponding item in the list, if it exists + if ($("#archiveList option[value='"+lastSelectedArchive+"']").length > 0) { + $("#archiveList").val(lastSelectedArchive); + } + } + // Set the localArchive as the last selected (or the first one if it has never been selected) + setLocalArchiveFromArchiveList(); + } + else { + alert("Welcome to Evopedia! This application needs a wikipedia archive in your SD-card. Please download one and put it on the SD-card (see About section). Also check that your device is not connected to a computer through USB device storage (which locks the SD-card content)"); + $("#btnAbout").click(); + } + } + + /** + * Sets the localArchive from the selected archive in the drop-down list + */ + function setLocalArchiveFromArchiveList() { + var archiveDirectory = $('#archiveList').val(); + localArchive = new evopediaArchive.LocalArchive(); + localArchive.initializeFromDeviceStorage(storages, archiveDirectory); + cookies.setItem("lastSelectedArchive",archiveDirectory,Infinity); + // The archive is set : go back to home page to start searching + $("#btnHome").click(); + } + + /** + * Displays the zone to select files from the archive + */ + function displayFileSelect() { + $('#openLocalFiles').show(); + $('#archiveFiles').on('change', setLocalArchiveFromFileSelect); + } + + /** + * Sets the localArchive from the File selects populated by user + */ + function setLocalArchiveFromFileSelect() { + localArchive = new evopediaArchive.LocalArchive(); + localArchive.initializeFromArchiveFiles(document.getElementById('archiveFiles').files); + // The archive is set : go back to home page to start searching + $("#btnHome").click(); + } + + /** + * Handle key input in the prefix input zone + * @param {type} evt + */ + 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) { + $('#searchTitles').click(); + } + } + ,500); + } + + + /** + * Search the index for titles that start with the given prefix (implemented + * with a binary search inside the index file) + * @param {type} prefix + */ + function searchTitlesFromPrefix(prefix) { + $('#searchingForTitles').show(); + $('#configuration').hide(); + $('#articleContent').empty(); + if (localArchive !== null && localArchive.titleFile !== null) { + localArchive.findTitlesWithPrefix(prefix.trim(), MAX_SEARCH_RESULT_SIZE, populateListOfTitles); + } else { + $('#searchingForTitles').hide(); + // We have to remove the focus from the search field, + // so that the keyboard does not stay above the message + $("#searchTitles").focus(); + alert("Archive not set : please select an archive"); + $("#btnConfigure").click(); + } + } + + + /** + * Display the list of titles with the given array of titles + * @param {type} titleArray + * @param maxTitles + */ + function populateListOfTitles(titleArray, maxTitles) { + var titleListDiv = $('#titleList'); + var nbTitles = 0; + if (titleArray) { + nbTitles = titleArray.length; + } + var titleListDivHtml; + if (nbTitles >= maxTitles) { + titleListDivHtml = "More than " + maxTitles + " titles found (only " + maxTitles + " displayed) :
"; + } + else { + titleListDivHtml = nbTitles + " titles found :
"; + } + for (var i = 0; i < titleArray.length; i++) { + var title = titleArray[i]; + titleListDivHtml += "" + title.getReadableName() + ""; + } + titleListDiv.html(titleListDivHtml); + $("#titleList a").on("click",handleTitleClick); + $('#searchingForTitles').hide(); + } + + + /** + * Checks if the small archive is in use + * If it is, display a warning message about the hyperlinks not working + */ + function checkSmallArchive() { + if (localArchive.language === "small" && !cookies.hasItem("warnedSmallArchive")) { + // The user selected the "small" archive, which is quite incomplete + // So let's display a warning to the user + + // If the focus is on the search field, we have to move it, + // else the keyboard hides the message + if ($("#prefix").is(":focus")) { + $("searchTitles").focus(); + } + alert("You selected the 'small' archive. This archive is OK for testing, but be aware that very few hyperlinks in the articles will work because it's only a very small subset of the English dump."); + // We will not display this warning again for one day + cookies.setItem("warnedSmallArchive",true,86400); + } + } + + + /** + * Handles the click on a title + * @param {type} event + * @returns {undefined} + */ + function handleTitleClick(event) { + // If we use the small archive, a warning should be displayed to the user + checkSmallArchive(); + + var titleId = event.target.getAttribute("titleId"); + $("#titleList").empty(); + findTitleFromTitleIdAndLaunchArticleRead(titleId); + var title = evopediaTitle.Title.parseTitleId(localArchive, titleId); + pushBrowserHistoryState(title.name); + $("#prefix").val(""); + return false; + } + + + /** + * Creates an instance of title from given titleId (including resolving redirects), + * and call the function to read the corresponding article + * @param {type} titleId + */ + function findTitleFromTitleIdAndLaunchArticleRead(titleId) { + if (localArchive.dataFiles && localArchive.dataFiles.length > 0) { + var title = evopediaTitle.Title.parseTitleId(localArchive, titleId); + $("#articleName").html(title.name); + $("#readingArticle").show(); + $("#articleContent").html(""); + if (title.fileNr === 255) { + localArchive.resolveRedirect(title, readArticle); + } + else { + readArticle(title); + } + } + else { + alert("Data files not set"); + } + } + + /** + * Read the article corresponding to the given title + * @param {type} title + */ + function readArticle(title) { + if (title.fileNr === 255) { + localArchive.resolveRedirect(title, readArticle); + } + else { + localArchive.readArticle(title, displayArticleInForm); + } + } + + /** + * Display the the given HTML article in the web page, + * and convert links to javascript calls + * @param {type} title + * @param {type} htmlArticle + */ + function displayArticleInForm(title, htmlArticle) { + $("#readingArticle").hide(); + + // Display the article inside the web page. + $('#articleContent').html(htmlArticle); + + // Compile the regular expressions needed to modify links + var regexOtherLanguage = /^\.?\/?\.\.\/([^\/]+)\/(.*)/; + var regexImageLink = /^.?\/?[^:]+:(.*)/; + + // Convert links into javascript calls + $('#articleContent').find('a').each(function() { + // Store current link's url + var url = $(this).attr("href"); + if (url === null || url === undefined) { + return; + } + var lowerCaseUrl = url.toLowerCase(); + var cssClass = $(this).attr("class"); + + if (cssClass === "new") { + // It's a link to a missing article : display a message + $(this).on('click', function(e) { + alert("Missing article in Wikipedia"); + return false; + }); + } + else if (url.slice(0, 1) === "#") { + // It's an anchor link : do nothing + } + else if (url.substring(0, 4) === "http") { + // It's an external link : open in a new tab + $(this).attr("target", "_blank"); + } + else if (url.match(regexOtherLanguage)) { + // It's a link to another language : change the URL to the online version of wikipedia + // The regular expression extracts $1 as the language, and $2 as the title name + var onlineWikipediaUrl = url.replace(regexOtherLanguage, "https://$1.wikipedia.org/wiki/$2"); + $(this).attr("href", onlineWikipediaUrl); + // Open in a new tab + $(this).attr("target", "_blank"); + } + else if (url.match(regexImageLink) + && (util.endsWith(lowerCaseUrl, ".png") + || util.endsWith(lowerCaseUrl, ".svg") + || util.endsWith(lowerCaseUrl, ".jpg") + || util.endsWith(lowerCaseUrl, ".jpeg"))) { + // It's a link to a file of wikipedia : change the URL to the online version and open in a new tab + var onlineWikipediaUrl = url.replace(regexImageLink, "https://"+localArchive.language+".wikipedia.org/wiki/File:$1"); + $(this).attr("href", onlineWikipediaUrl); + $(this).attr("target", "_blank"); + } + else { + // It's a link to another article : add an onclick event to go to this article + // instead of following the link + if (url.length>=2 && url.substring(0, 2) === "./") { + url = url.substring(2); + } + $(this).on('click', function(e) { + var titleName = decodeURIComponent(url); + pushBrowserHistoryState(titleName); + goToArticle(titleName); + return false; + }); + } + }); + + // Load math images + $('#articleContent').find('img').each(function() { + var image = $(this); + var m = image.attr("src").match(/^\/math.*\/([0-9a-f]{32})\.png$/); + if (m) { + localArchive.loadMathImage(m[1], function(data) { + image.attr("src", 'data:image/png;base64,' + data); + }); + } + }); + } + + /** + * Changes the URL of the browser page + * @param {type} titleName + */ + function pushBrowserHistoryState(titleName) { + if (titleName) { + var stateObj = {titleName: titleName}; + window.history.pushState(stateObj, "Wikipedia Article : " + titleName, "?title=" + titleName); + } + } + + + /** + * Replace article content with the one of the given title + * @param {type} titleName + * @returns {undefined} + */ + function goToArticle(titleName) { + localArchive.getTitleByName(titleName, function(title) { + if (title === null || title === undefined) { + $("#readingArticle").hide(); + alert("Article with title " + titleName + " not found in the archive"); + } + else { + $("#articleName").html(titleName); + $("#readingArticle").show(); + $("#articleContent").html(""); + readArticle(title); + } + }); + } + + /** + * Looks for titles located around where the device is geolocated + */ + function searchTitlesNearby() { + $('#searchingForTitles').show(); + $('#configuration').hide(); + $('#articleContent').empty(); + if (localArchive !== null && localArchive.titleFile !== null) { + var longitude = $('#longitude').val(); + var latitude = $('#latitude').val(); + var maxDistance = $('#maxDistance').val(); + if (!maxDistance) { + maxDistance = MAX_DISTANCE_ARTICLES_NEARBY; + } + if (!longitude || !latitude) { + // If the user did not give any latitude/longitude, we try to use geolocation + if (navigator.geolocation) { + var geo_options = { + enableHighAccuracy: false, + maximumAge: 1800000, // 30 minutes + timeout: 10000 // 10 seconds + }; + + function geo_success(pos) { + var crd = pos.coords; + + alert("Found your location : latitude=" + crd.latitude + ", longitude=" + crd.longitude); + + var rectangle = new geometry.rect( + crd.longitude - maxDistance, + crd.latitude - maxDistance, + maxDistance * 2, + maxDistance * 2); + + localArchive.getTitlesInCoords(rectangle, MAX_SEARCH_RESULT_SIZE, populateListOfTitles); + }; + + function geo_error(err) { + alert("Unable to geolocate your device : " + err.code + " : " + err.message); + $('#searchingForTitles').hide(); + }; + + navigator.geolocation.getCurrentPosition(geo_success, geo_error, geo_options); + } + else { + alert("Geolocation is not supported (or disabled) on your device, or on your browser"); + } + } + else { + // The user gave a latitude/longitude : let's use it to find articles around that location + var rectangle = new geometry.rect( + latitude - maxDistance, + longitude - maxDistance, + maxDistance * 2, + maxDistance * 2); + + localArchive.getTitlesInCoords(rectangle, MAX_SEARCH_RESULT_SIZE, populateListOfTitles); + } + + } else { + $('#searchingForTitles').hide(); + // We have to remove the focus from the search field, + // so that the keyboard does not stay above the message + $("#searchTitles").focus(); + alert("Archive not set : please select an archive"); + $("#btnConfigure").click(); + } + } + + function goToRandomArticle() { + localArchive.getRandomTitle(function(title) { + if (title === null || title === undefined) { + alert("Error finding random article."); + } + else { + $("#articleName").html(title.name); + $("#readingArticle").show(); + $("#articleContent").html(""); + readArticle(title); + } + }); + } + +}); diff --git a/www/js/lib/archive.js b/www/js/lib/archive.js index f5f0f0a7..85d1f8c9 100644 --- a/www/js/lib/archive.js +++ b/www/js/lib/archive.js @@ -1,946 +1,945 @@ -/** - * archive.js : Class for a local Evopedia archive, with the algorithms to read it - * This file handles finding a title in an archive, reading an article in an archive etc - * - * Copyright 2013-2014 Mossroy and contributors - * License GPL v3: - * - * This file is part of Evopedia. - * - * Evopedia 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. - * - * Evopedia 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 Evopedia (file LICENSE-GPLv3.txt). If not, see - */ -define(function(require) { - - // Module dependencies - var normalize_string = require('normalize_string'); - var util = require('util'); - var geometry = require('geometry'); - var jQuery = require('jquery'); - var titleIterators = require('titleIterators'); - - // Declare the webworker that can uncompress with bzip2 algorithm - var webworkerBzip2; - try { - // When using the application normally - webworkerBzip2 = new Worker("js/lib/webworker_bzip2.js"); - } - catch(e) { - // When using unit tests - webworkerBzip2 = new Worker("www/js/lib/webworker_bzip2.js"); - } - - // Size of chunks read in the dump files : 128 KB - var CHUNK_SIZE = 131072; - // A rectangle representing all the earth globe - var GLOBE_RECTANGLE = new geometry.rect(-91, -181, 182, 362); - - /** - * LocalArchive class : defines a wikipedia dump on the filesystem - */ - function LocalArchive() { - this.dataFiles = new Array(); - this.coordinateFiles = new Array(); - this.titleFile = null; - this.mathIndexFile = null; - this.mathDataFile = null; - this.date = null; - this.language = null; - this.titleSearchFile = null; - this.normalizedTitles = true; - }; - - - /** - * Read the title Files in the given directory, and assign them to the - * current LocalArchive - * - * @param storage - * @param directory - */ - LocalArchive.prototype.readTitleFilesFromStorage = function(storage, directory) { - var currentLocalArchiveInstance = this; - storage.get(directory + 'titles.idx').then(function(file) { - currentLocalArchiveInstance.titleFile = file; - }, function(error) { - alert("Error reading title file in directory " + directory + " : " + error); - }); - storage.get(directory + 'titles_search.idx').then(function(file) { - currentLocalArchiveInstance.titleSearchFile = file; - }, function(error) { - // Do nothing : this file is not mandatory in an archive - }); - }; - - /** - * Read the data Files in the given directory (starting at given index), and - * assign them to the current LocalArchive - * - * @param storage - * @param directory - * @param index - */ - LocalArchive.prototype.readDataFilesFromStorage = function(storage, directory, index) { - var currentLocalArchiveInstance = this; - - var prefixedFileNumber = ""; - if (index < 10) { - prefixedFileNumber = "0" + index; - } else { - prefixedFileNumber = index; - } - storage.get(directory + 'wikipedia_' + prefixedFileNumber + '.dat') - .then(function(file) { - currentLocalArchiveInstance.dataFiles[index] = file; - currentLocalArchiveInstance.readDataFilesFromStorage(storage, directory, - index + 1); - }, function(error) { - // TODO there must be a better way to detect a FileNotFound - if (error != "NotFoundError") { - alert("Error reading data file " + index + " in directory " - + directory + " : " + error); - } - }); - }; - - /** - * Read the coordinate Files in the given directory (starting at given index), and - * assign them to the current LocalArchive - * - * @param storage - * @param directory - * @param index - */ - LocalArchive.prototype.readCoordinateFilesFromStorage = function(storage, directory, index) { - var currentLocalArchiveInstance = this; - - var prefixedFileNumber = ""; - if (index < 10) { - prefixedFileNumber = "0" + index; - } else { - prefixedFileNumber = index; - } - storage.get(directory + 'coordinates_' + prefixedFileNumber - + '.idx').then(function(file) { - currentLocalArchiveInstance.coordinateFiles[index] = file; - currentLocalArchiveInstance.readCoordinateFilesFromStorage(storage, directory, - index + 1); - }, function(error) { - // TODO there must be a better way to detect a FileNotFound - if (error != "NotFoundError") { - alert("Error reading coordinates file " + index + " in directory " - + directory + " : " + error); - } - }); - }; - - /** - * Read the metadata.txt file in the given directory, and store its content - * in the current instance - * - * @param storage - * @param directory - */ - LocalArchive.prototype.readMetadataFileFromStorage = function(storage, directory) { - var currentLocalArchiveInstance = this; - - storage.get(directory + 'metadata.txt').then(function(file) { - var metadataFile = file; - currentLocalArchiveInstance.readMetadataFile(metadataFile); - }, function(error) { - alert("Error reading metadata.txt file in directory " - + directory + " : " + error); - }); - }; - - /** - * Read the metadata file, in order to populate its values in the current - * instance - * @param {File} file metadata.txt file - */ - LocalArchive.prototype.readMetadataFile = function(file) { - var currentLocalArchiveInstance = this; - var reader = new FileReader(); - reader.onload = function(e) { - var metadata = e.target.result; - currentLocalArchiveInstance.language = /\nlanguage ?\= ?([^ \n]+)/.exec(metadata)[1]; - currentLocalArchiveInstance.date = /\ndate ?\= ?([^ \n]+)/.exec(metadata)[1]; - var normalizedTitlesRegex = /\nnormalized_titles ?\= ?([^ \n]+)/; - if (normalizedTitlesRegex.exec(metadata)) { - var normalizedTitlesInt = normalizedTitlesRegex.exec(metadata)[1]; - if (normalizedTitlesInt === "0") { - currentLocalArchiveInstance.normalizedTitles = false; - } - else { - currentLocalArchiveInstance.normalizedTitles = true; - } - } - else { - currentLocalArchiveInstance.normalizedTitles = true; - } - }; - reader.readAsText(file); - }; - - /** - * Initialize the localArchive from given archive files - * @param {type} archiveFiles - */ - LocalArchive.prototype.initializeFromArchiveFiles = function(archiveFiles) { - var dataFileRegex = /^wikipedia_(\d\d).dat$/; - var coordinateFileRegex = /^coordinates_(\d\d).idx$/; - this.dataFiles = new Array(); - this.coordinateFiles = new Array(); - for (var i=0; i 0) { - var intFileNr = 1 * coordinateFileNr[1]; - this.coordinateFiles[intFileNr - 1] = file; - } - else { - var dataFileNr = dataFileRegex.exec(file.name); - if (dataFileNr && dataFileNr.length > 0) { - var intFileNr = 1 * dataFileNr[1]; - this.dataFiles[intFileNr] = file; - } - } - } - } - } - - }; - - /** - * Initialize the localArchive from given directory, using DeviceStorage - * @param {type} storages List of DeviceStorages available - * @param {type} archiveDirectory - */ - LocalArchive.prototype.initializeFromDeviceStorage = function(storages, archiveDirectory) { - // First, we have to find which DeviceStorage has been selected by the user - // It is the prefix of the archive directory - var storageNameRegex = /^\/([^\/]+)\//; - var regexResults = storageNameRegex.exec(archiveDirectory); - var selectedStorage = null; - if (regexResults && regexResults.length>0) { - var selectedStorageName = regexResults[1]; - for (var i=0; i= titleCount) { - return titles; - } - return iterator.advance().then(function(title) { - if (title === null) - return titles; - titles.push(title); - return addNext(); - }); - } - return addNext(); - }).then(callbackFunction, errorHandler); - }; - - /** - * Look for a title by its name, and call the callbackFunction with this Title - * If the title is not found, the callbackFunction is called with parameter null - * @param titleName - * @param callbackFunction - */ - LocalArchive.prototype.getTitleByName = function(titleName, callbackFunction) { - var that = this; - var normalize = this.getNormalizeFunction(); - var normalizedTitleName = normalize(titleName); - - titleIterators.findPrefixOffset(this.titleFile, titleName, normalize).then(function(offset) { - var iterator = new titleIterators.SequentialTitleIterator(that, offset); - function check(title) { - if (title == null || normalize(title.name) !== normalizedTitleName) { - return null; - } else if (title.name === titleName) { - return title; - } else { - return iterator.advance().then(check); - } - } - return iterator.advance().then(check); - }).then(callbackFunction, errorHandler); - }; - - /** - * Get a random title, and call the callbackFunction with this Title - * @param callbackFunction - */ - LocalArchive.prototype.getRandomTitle = function(callbackFunction) { - var that = this; - var offset = Math.floor(Math.random() * this.titleFile.size); - jQuery.when().then(function() { - return util.readFileSlice(that.titleFile, offset, - offset + titleIterators.MAX_TITLE_LENGTH).then(function(byteArray) { - // Let's find the next newLine - var newLineIndex = 0; - while (newLineIndex < byteArray.length && byteArray[newLineIndex] !== 10) { - newLineIndex++; - } - var iterator = new titleIterators.SequentialTitleIterator(that, offset + newLineIndex + 1); - return iterator.advance(); - }); - }).then(callbackFunction, errorHandler); - }; - - /** - * Find titles that start with the given prefix, and call the callbackFunction with this list of Titles - * @param prefix - * @param maxSize Maximum number of titles to read - * @param callbackFunction - */ - LocalArchive.prototype.findTitlesWithPrefix = function(prefix, maxSize, callbackFunction) { - var that = this; - var titles = []; - var normalize = this.getNormalizeFunction(); - prefix = normalize(prefix); - - titleIterators.findPrefixOffset(this.titleFile, prefix, normalize).then(function(offset) { - var iterator = new titleIterators.SequentialTitleIterator(that, offset); - function addNext() { - if (titles.length >= maxSize) { - return titles; - } - return iterator.advance().then(function(title) { - if (title == null) - return titles; - // check whether this title really starts with the prefix - var name = normalize(title.name); - if (name.length < prefix.length || name.substring(0, prefix.length) != prefix) - return titles; - titles.push(title); - return addNext(); - }); - } - return addNext(); - }).then(callbackFunction, errorHandler); - }; - - - /** - * Read an article from the title instance, and call the - * callbackFunction with the article HTML String - * - * @param title - * @param callbackFunction - */ - LocalArchive.prototype.readArticle = function(title, callbackFunction) { - var dataFile = null; - - var prefixedFileNumber = ""; - if (title.fileNr < 10) { - prefixedFileNumber = "0" + title.fileNr; - } else { - prefixedFileNumber = title.fileNr; - } - var expectedFileName = "wikipedia_" + prefixedFileNumber + ".dat"; - - // Find the good dump file - for (var i = 0; i < this.dataFiles.length; i++) { - var fileName = this.dataFiles[i].name; - // Check if the fileName ends with the expected file name (in case - // of DeviceStorage usage, the fileName is prefixed by the - // directory) - if (fileName.match(expectedFileName + "$") == expectedFileName) { - dataFile = this.dataFiles[i]; - } - } - if (!dataFile) { - // TODO can probably be replaced by some error handler at window level - alert("Oops : some files seem to be missing in your archive. Please report this problem to us by email (see About section), with the names of the archive and article, and the following info : " - + "File number " + title.fileNr + " not found"); - throw new Error("File number " + title.fileNr + " not found"); - } else { - var reader = new FileReader(); - // Read the article in the dataFile, starting with a chunk of CHUNK_SIZE - this.readArticleChunk(title, dataFile, reader, CHUNK_SIZE, callbackFunction); - } - - }; - - /** - * Read a chunk of the dataFile (of the given length) to try to read the - * given article. - * If the bzip2 algorithm works and articleLength of the article is reached, - * call the callbackFunction with the article HTML String. - * Else, recursively call this function with readLength + CHUNK_SIZE - * - * @param title - * @param dataFile - * @param reader - * @param readLength - * @param callbackFunction - */ - LocalArchive.prototype.readArticleChunk = function(title, dataFile, reader, - readLength, callbackFunction) { - var currentLocalArchiveInstance = this; - reader.onerror = errorHandler; - reader.onabort = function(e) { - alert('Data file read cancelled'); - }; - reader.onload = function(e) { - try { - var compressedArticles = e.target.result; - webworkerBzip2.onerror = function(event){ - // TODO can probably be replaced by some error handler at window level - alert("An unexpected error occured during bzip2 decompression. Please report it to us by email or through Github (see About section), with the names of the archive and article, and the following info : message=" - + event.message + " filename=" + event.filename + " line number=" + event.lineno ); - throw new Error("Error during bzip2 decompression : " + event.message + " (" + event.filename + ":" + event.lineno + ")"); - }; - webworkerBzip2.onmessage = function(event){ - switch (event.data.cmd){ - case "result": - var htmlArticles = event.data.msg; - // Start reading at offset, and keep length characters - var htmlArticle = htmlArticles.substring(title.blockOffset, - title.blockOffset + title.articleLength); - if (htmlArticle.length >= title.articleLength) { - // Keep only length characters - htmlArticle = htmlArticle.substring(0, title.articleLength); - // Decode UTF-8 encoding - htmlArticle = decodeURIComponent(escape(htmlArticle)); - callbackFunction(title, htmlArticle); - } else { - // TODO : throw exception if we reach the end of the file - currentLocalArchiveInstance.readArticleChunk(title, dataFile, reader, readLength + CHUNK_SIZE, - callbackFunction); - } - break; - case "recurse": - currentLocalArchiveInstance.readArticleChunk(title, dataFile, reader, readLength + CHUNK_SIZE, callbackFunction); - break; - case "debug": - console.log(event.data.msg); - break; - case "error": - // TODO can probably be replaced by some error handler at window level - alert("An unexpected error occured during bzip2 decompression. Please report it to us by email or through Github (see About section), with the names of the archive and article, and the following info : message=" - + event.data.msg ); - throw new Error("Error during bzip2 decompression : " + event.data.msg); - break; - } - }; - webworkerBzip2.postMessage({cmd : 'uncompress', msg : - new Uint8Array(compressedArticles)}); - - } - catch (e) { - callbackFunction("Error : " + e); - } - }; - var blob = dataFile.slice(title.blockStart, title.blockStart - + readLength); - - // Read in the image file as a binary string. - reader.readAsArrayBuffer(blob); - }; - - /** - * Load the math image specified by the hex string and call the - * callbackFunction with a base64 encoding of its data. - * - * @param hexString - * @param callbackFunction - */ - LocalArchive.prototype.loadMathImage = function(hexString, callbackFunction) { - var entrySize = 16 + 4 + 4; - var lo = 0; - var hi = this.mathIndexFile.size / entrySize; - - var mathDataFile = this.mathDataFile; - - this.findMathDataPosition(hexString, lo, hi, function(pos, length) { - var reader = new FileReader(); - reader.onerror = errorHandler; - reader.onabort = function(e) { - alert('Math image file read cancelled'); - }; - var blob = mathDataFile.slice(pos, pos + length); - reader.onload = function(e) { - var byteArray = new Uint8Array(e.target.result); - callbackFunction(util.uint8ArrayToBase64(byteArray)); - }; - reader.readAsArrayBuffer(blob); - }); - }; - - - /** - * Recursive algorithm to find the position of the Math image in the data file - * @param {type} hexString - * @param {type} lo - * @param {type} hi - * @param {type} callbackFunction - */ - LocalArchive.prototype.findMathDataPosition = function(hexString, lo, hi, callbackFunction) { - var entrySize = 16 + 4 + 4; - if (lo >= hi) { - /* TODO error - not found */ - return; - } - var reader = new FileReader(); - reader.onerror = errorHandler; - reader.onabort = function(e) { - alert('Math image file read cancelled'); - }; - var mid = Math.floor((lo + hi) / 2); - var blob = this.mathIndexFile.slice(mid * entrySize, (mid + 1) * entrySize); - var currentLocalArchiveInstance = this; - reader.onload = function(e) { - var byteArray = new Uint8Array(e.target.result); - var hash = util.uint8ArrayToHex(byteArray.subarray(0, 16)); - if (hash == hexString) { - var pos = util.readIntegerFrom4Bytes(byteArray, 16); - var length = util.readIntegerFrom4Bytes(byteArray, 16 + 4); - callbackFunction(pos, length); - return; - } else if (hexString < hash) { - hi = mid; - } else { - lo = mid + 1; - } - - currentLocalArchiveInstance.findMathDataPosition(hexString, lo, hi, callbackFunction); - }; - // Read the file as a binary string - reader.readAsArrayBuffer(blob); - }; - - - /** - * Resolve the redirect of the given title instance, and call the callbackFunction with the redirected Title instance - * @param title - * @param callbackFunction - */ - LocalArchive.prototype.resolveRedirect = function(title, callbackFunction) { - var reader = new FileReader(); - reader.onerror = errorHandler; - reader.onabort = function(e) { - alert('Title file read cancelled'); - }; - reader.onload = function(e) { - var binaryTitleFile = e.target.result; - var byteArray = new Uint8Array(binaryTitleFile); - - if (byteArray.length === 0) { - // TODO can probably be replaced by some error handler at window level - alert("Oops : there seems to be something wrong in your archive. Please report it to us by email or through Github (see About section), with the names of the archive and article and the following info : " - + "Unable to find redirected article for title " + title.name + " : offset " + title.blockStart + " not found in title file"); - throw new Error("Unable to find redirected article for title " + title.name + " : offset " + title.blockStart + " not found in title file"); - } - - var redirectedTitle = title; - redirectedTitle.fileNr = 1 * byteArray[2]; - redirectedTitle.blockStart = util.readIntegerFrom4Bytes(byteArray, 3); - redirectedTitle.blockOffset = util.readIntegerFrom4Bytes(byteArray, 7); - redirectedTitle.articleLength = util.readIntegerFrom4Bytes(byteArray, 11); - - callbackFunction(redirectedTitle); - }; - // Read only the 16 necessary bytes, starting at title.blockStart - var blob = this.titleFile.slice(title.blockStart, title.blockStart + 16); - // Read in the file as a binary string - reader.readAsArrayBuffer(blob); - }; - - // This is a global counter that helps find out when the search for articles nearby is over - var callbackCounterForTitlesInCoordsSearch = 0; - - /** - * Finds titles that are located inside the given rectangle - * This is the main function, that has to be called from the application - * - * @param {type} rect Rectangle where to look for titles - * @param {type} maxTitles Maximum number of titles to find - * @param callbackFunction Function to call with the list of titles found - */ - LocalArchive.prototype.getTitlesInCoords = function(rect, maxTitles, callbackFunction) { - if (callbackCounterForTitlesInCoordsSearch > 0) { - alert("The last nearby search did not seem to end well : please try again"); - callbackCounterForTitlesInCoordsSearch = 0; - return; - } - var normalizedRectangle = rect.normalized(); - var titlePositionsFound = new Array(); - for (var i = 0; i < this.coordinateFiles.length; i++) { - callbackCounterForTitlesInCoordsSearch++; - LocalArchive.getTitlesInCoordsInt(this, i, 0, normalizedRectangle, GLOBE_RECTANGLE, maxTitles, titlePositionsFound, callbackFunction, LocalArchive.callbackGetTitlesInCoordsInt); - } - }; - - /** - * Callback function called by getTitlesInCoordsInt (or by itself), in order - * to loop through every coordinate file, and search titles nearby in each - * of them. - * When all the coordinate files are searched, or when enough titles are - * found, another function is called to convert the title positions found - * into Title instances (asynchronously) - * - * @param {type} localArchive - * @param {type} titlePositionsFound - * @param {type} i : index of the coordinate file - * @param {type} maxTitles - * @param {type} normalizedRectangle - * @param {type} callbackFunction - */ - LocalArchive.callbackGetTitlesInCoordsInt = function(localArchive, titlePositionsFound, maxTitles, callbackFunction) { - // Search is over : now let's convert the title positions into Title instances - if (titlePositionsFound && titlePositionsFound.length > 0) { - LocalArchive.readTitlesFromTitleCoordsInTitleFile(localArchive, titlePositionsFound, 0, new Array(), callbackFunction); - } - else { - callbackFunction(titlePositionsFound); - } - - }; - - /** - * This function reads a list of title positions, and converts it into a list or Title instances. - * It handles index i, then recursively calls itself for index i+1 - * When all the list is processed, the callbackFunction is called with the Title list - * - * @param {type} localArchive - * @param {type} titlePositionsFound - * @param {type} i - * @param {type} titlesFound - * @param {type} callbackFunction - */ - LocalArchive.readTitlesFromTitleCoordsInTitleFile = function (localArchive, titlePositionsFound, i, titlesFound, callbackFunction) { - var titleOffset = titlePositionsFound[i]; - localArchive.getTitlesStartingAtOffset(titleOffset, 1, function(titleList) { - if (titleList && titleList.length === 1) { - titlesFound.push(titleList[0]); - i++; - if (i + */ +define(function(require) { + + // Module dependencies + var normalize_string = require('normalize_string'); + var util = require('util'); + var geometry = require('geometry'); + var jQuery = require('jquery'); + var titleIterators = require('titleIterators'); + + // Declare the webworker that can uncompress with bzip2 algorithm + var webworkerBzip2; + try { + // When using the application normally + webworkerBzip2 = new Worker("js/lib/webworker_bzip2.js"); + } + catch(e) { + // When using unit tests + webworkerBzip2 = new Worker("www/js/lib/webworker_bzip2.js"); + } + + // Size of chunks read in the dump files : 128 KB + var CHUNK_SIZE = 131072; + // A rectangle representing all the earth globe + var GLOBE_RECTANGLE = new geometry.rect(-91, -181, 182, 362); + + /** + * LocalArchive class : defines a wikipedia dump on the filesystem + */ + function LocalArchive() { + this.dataFiles = new Array(); + this.coordinateFiles = new Array(); + this.titleFile = null; + this.mathIndexFile = null; + this.mathDataFile = null; + this.date = null; + this.language = null; + this.titleSearchFile = null; + this.normalizedTitles = true; + }; + + + /** + * Read the title Files in the given directory, and assign them to the + * current LocalArchive + * + * @param storage + * @param directory + */ + LocalArchive.prototype.readTitleFilesFromStorage = function(storage, directory) { + var currentLocalArchiveInstance = this; + storage.get(directory + 'titles.idx').then(function(file) { + currentLocalArchiveInstance.titleFile = file; + }, function(error) { + alert("Error reading title file in directory " + directory + " : " + error); + }); + storage.get(directory + 'titles_search.idx').then(function(file) { + currentLocalArchiveInstance.titleSearchFile = file; + }, function(error) { + // Do nothing : this file is not mandatory in an archive + }); + }; + + /** + * Read the data Files in the given directory (starting at given index), and + * assign them to the current LocalArchive + * + * @param storage + * @param directory + * @param index + */ + LocalArchive.prototype.readDataFilesFromStorage = function(storage, directory, index) { + var currentLocalArchiveInstance = this; + + var prefixedFileNumber = ""; + if (index < 10) { + prefixedFileNumber = "0" + index; + } else { + prefixedFileNumber = index; + } + storage.get(directory + 'wikipedia_' + prefixedFileNumber + '.dat') + .then(function(file) { + currentLocalArchiveInstance.dataFiles[index] = file; + currentLocalArchiveInstance.readDataFilesFromStorage(storage, directory, + index + 1); + }, function(error) { + // TODO there must be a better way to detect a FileNotFound + if (error != "NotFoundError") { + alert("Error reading data file " + index + " in directory " + + directory + " : " + error); + } + }); + }; + + /** + * Read the coordinate Files in the given directory (starting at given index), and + * assign them to the current LocalArchive + * + * @param storage + * @param directory + * @param index + */ + LocalArchive.prototype.readCoordinateFilesFromStorage = function(storage, directory, index) { + var currentLocalArchiveInstance = this; + + var prefixedFileNumber = ""; + if (index < 10) { + prefixedFileNumber = "0" + index; + } else { + prefixedFileNumber = index; + } + storage.get(directory + 'coordinates_' + prefixedFileNumber + + '.idx').then(function(file) { + currentLocalArchiveInstance.coordinateFiles[index] = file; + currentLocalArchiveInstance.readCoordinateFilesFromStorage(storage, directory, + index + 1); + }, function(error) { + // TODO there must be a better way to detect a FileNotFound + if (error != "NotFoundError") { + alert("Error reading coordinates file " + index + " in directory " + + directory + " : " + error); + } + }); + }; + + /** + * Read the metadata.txt file in the given directory, and store its content + * in the current instance + * + * @param storage + * @param directory + */ + LocalArchive.prototype.readMetadataFileFromStorage = function(storage, directory) { + var currentLocalArchiveInstance = this; + + storage.get(directory + 'metadata.txt').then(function(file) { + var metadataFile = file; + currentLocalArchiveInstance.readMetadataFile(metadataFile); + }, function(error) { + alert("Error reading metadata.txt file in directory " + + directory + " : " + error); + }); + }; + + /** + * Read the metadata file, in order to populate its values in the current + * instance + * @param {File} file metadata.txt file + */ + LocalArchive.prototype.readMetadataFile = function(file) { + var currentLocalArchiveInstance = this; + var reader = new FileReader(); + reader.onload = function(e) { + var metadata = e.target.result; + currentLocalArchiveInstance.language = /\nlanguage ?\= ?([^ \n]+)/.exec(metadata)[1]; + currentLocalArchiveInstance.date = /\ndate ?\= ?([^ \n]+)/.exec(metadata)[1]; + var normalizedTitlesRegex = /\nnormalized_titles ?\= ?([^ \n]+)/; + if (normalizedTitlesRegex.exec(metadata)) { + var normalizedTitlesInt = normalizedTitlesRegex.exec(metadata)[1]; + if (normalizedTitlesInt === "0") { + currentLocalArchiveInstance.normalizedTitles = false; + } + else { + currentLocalArchiveInstance.normalizedTitles = true; + } + } + else { + currentLocalArchiveInstance.normalizedTitles = true; + } + }; + reader.readAsText(file); + }; + + /** + * Initialize the localArchive from given archive files + * @param {type} archiveFiles + */ + LocalArchive.prototype.initializeFromArchiveFiles = function(archiveFiles) { + var dataFileRegex = /^wikipedia_(\d\d).dat$/; + var coordinateFileRegex = /^coordinates_(\d\d).idx$/; + this.dataFiles = new Array(); + this.coordinateFiles = new Array(); + for (var i=0; i 0) { + var intFileNr = 1 * coordinateFileNr[1]; + this.coordinateFiles[intFileNr - 1] = file; + } + else { + var dataFileNr = dataFileRegex.exec(file.name); + if (dataFileNr && dataFileNr.length > 0) { + var intFileNr = 1 * dataFileNr[1]; + this.dataFiles[intFileNr] = file; + } + } + } + } + } + + }; + + /** + * Initialize the localArchive from given directory, using DeviceStorage + * @param {type} storages List of DeviceStorages available + * @param {type} archiveDirectory + */ + LocalArchive.prototype.initializeFromDeviceStorage = function(storages, archiveDirectory) { + // First, we have to find which DeviceStorage has been selected by the user + // It is the prefix of the archive directory + var storageNameRegex = /^\/([^\/]+)\//; + var regexResults = storageNameRegex.exec(archiveDirectory); + var selectedStorage = null; + if (regexResults && regexResults.length>0) { + var selectedStorageName = regexResults[1]; + for (var i=0; i= titleCount) { + return titles; + } + return iterator.advance().then(function(title) { + if (title === null) + return titles; + titles.push(title); + return addNext(); + }); + } + return addNext(); + }).then(callbackFunction, errorHandler); + }; + + /** + * Look for a title by its name, and call the callbackFunction with this Title + * If the title is not found, the callbackFunction is called with parameter null + * @param titleName + * @param callbackFunction + */ + LocalArchive.prototype.getTitleByName = function(titleName, callbackFunction) { + var that = this; + var normalize = this.getNormalizeFunction(); + var normalizedTitleName = normalize(titleName); + + titleIterators.findPrefixOffset(this.titleFile, titleName, normalize).then(function(offset) { + var iterator = new titleIterators.SequentialTitleIterator(that, offset); + function check(title) { + if (title === null || normalize(title.name) !== normalizedTitleName) { + return null; + } else if (title.name === titleName) { + return title; + } else { + return iterator.advance().then(check); + } + } + return iterator.advance().then(check); + }).then(callbackFunction, errorHandler); + }; + + /** + * Get a random title, and call the callbackFunction with this Title + * @param callbackFunction + */ + LocalArchive.prototype.getRandomTitle = function(callbackFunction) { + var that = this; + var offset = Math.floor(Math.random() * this.titleFile.size); + jQuery.when().then(function() { + return util.readFileSlice(that.titleFile, offset, + offset + titleIterators.MAX_TITLE_LENGTH).then(function(byteArray) { + // Let's find the next newLine + var newLineIndex = 0; + while (newLineIndex < byteArray.length && byteArray[newLineIndex] !== 10) { + newLineIndex++; + } + var iterator = new titleIterators.SequentialTitleIterator(that, offset + newLineIndex + 1); + return iterator.advance(); + }); + }).then(callbackFunction, errorHandler); + }; + + /** + * Find titles that start with the given prefix, and call the callbackFunction with this list of Titles + * @param prefix + * @param maxSize Maximum number of titles to read + * @param callbackFunction + */ + LocalArchive.prototype.findTitlesWithPrefix = function(prefix, maxSize, callbackFunction) { + var that = this; + var titles = []; + var normalize = this.getNormalizeFunction(); + prefix = normalize(prefix); + + titleIterators.findPrefixOffset(this.titleFile, prefix, normalize).then(function(offset) { + var iterator = new titleIterators.SequentialTitleIterator(that, offset); + function addNext() { + if (titles.length >= maxSize) { + return jQuery.Deferred().resolve(titles, maxSize); + } + return iterator.advance().then(function(title) { + if (title === null) + return jQuery.Deferred().resolve(titles, maxSize); + // check whether this title really starts with the prefix + var name = normalize(title.name); + if (name.length < prefix.length || name.substring(0, prefix.length) !== prefix) + return jQuery.Deferred().resolve(titles, maxSize); + titles.push(title); + return addNext(); + }); + } + return addNext(); + }).then(callbackFunction, errorHandler); + }; + + + /** + * Read an article from the title instance, and call the + * callbackFunction with the article HTML String + * + * @param title + * @param callbackFunction + */ + LocalArchive.prototype.readArticle = function(title, callbackFunction) { + var dataFile = null; + + var prefixedFileNumber = ""; + if (title.fileNr < 10) { + prefixedFileNumber = "0" + title.fileNr; + } else { + prefixedFileNumber = title.fileNr; + } + var expectedFileName = "wikipedia_" + prefixedFileNumber + ".dat"; + + // Find the good dump file + for (var i = 0; i < this.dataFiles.length; i++) { + var fileName = this.dataFiles[i].name; + // Check if the fileName ends with the expected file name (in case + // of DeviceStorage usage, the fileName is prefixed by the + // directory) + if (fileName.match(expectedFileName + "$") == expectedFileName) { + dataFile = this.dataFiles[i]; + } + } + if (!dataFile) { + // TODO can probably be replaced by some error handler at window level + alert("Oops : some files seem to be missing in your archive. Please report this problem to us by email (see About section), with the names of the archive and article, and the following info : " + + "File number " + title.fileNr + " not found"); + throw new Error("File number " + title.fileNr + " not found"); + } else { + var reader = new FileReader(); + // Read the article in the dataFile, starting with a chunk of CHUNK_SIZE + this.readArticleChunk(title, dataFile, reader, CHUNK_SIZE, callbackFunction); + } + + }; + + /** + * Read a chunk of the dataFile (of the given length) to try to read the + * given article. + * If the bzip2 algorithm works and articleLength of the article is reached, + * call the callbackFunction with the article HTML String. + * Else, recursively call this function with readLength + CHUNK_SIZE + * + * @param title + * @param dataFile + * @param reader + * @param readLength + * @param callbackFunction + */ + LocalArchive.prototype.readArticleChunk = function(title, dataFile, reader, + readLength, callbackFunction) { + var currentLocalArchiveInstance = this; + reader.onerror = errorHandler; + reader.onabort = function(e) { + alert('Data file read cancelled'); + }; + reader.onload = function(e) { + try { + var compressedArticles = e.target.result; + webworkerBzip2.onerror = function(event){ + // TODO can probably be replaced by some error handler at window level + alert("An unexpected error occured during bzip2 decompression. Please report it to us by email or through Github (see About section), with the names of the archive and article, and the following info : message=" + + event.message + " filename=" + event.filename + " line number=" + event.lineno ); + throw new Error("Error during bzip2 decompression : " + event.message + " (" + event.filename + ":" + event.lineno + ")"); + }; + webworkerBzip2.onmessage = function(event){ + switch (event.data.cmd){ + case "result": + var htmlArticles = event.data.msg; + // Start reading at offset, and keep length characters + var htmlArticle = htmlArticles.substring(title.blockOffset, + title.blockOffset + title.articleLength); + if (htmlArticle.length >= title.articleLength) { + // Keep only length characters + htmlArticle = htmlArticle.substring(0, title.articleLength); + // Decode UTF-8 encoding + htmlArticle = decodeURIComponent(escape(htmlArticle)); + callbackFunction(title, htmlArticle); + } else { + // TODO : throw exception if we reach the end of the file + currentLocalArchiveInstance.readArticleChunk(title, dataFile, reader, readLength + CHUNK_SIZE, + callbackFunction); + } + break; + case "recurse": + currentLocalArchiveInstance.readArticleChunk(title, dataFile, reader, readLength + CHUNK_SIZE, callbackFunction); + break; + case "debug": + console.log(event.data.msg); + break; + case "error": + // TODO can probably be replaced by some error handler at window level + alert("An unexpected error occured during bzip2 decompression. Please report it to us by email or through Github (see About section), with the names of the archive and article, and the following info : message=" + + event.data.msg ); + throw new Error("Error during bzip2 decompression : " + event.data.msg); + break; + } + }; + webworkerBzip2.postMessage({cmd : 'uncompress', msg : + new Uint8Array(compressedArticles)}); + + } + catch (e) { + callbackFunction("Error : " + e); + } + }; + var blob = dataFile.slice(title.blockStart, title.blockStart + + readLength); + + // Read in the image file as a binary string. + reader.readAsArrayBuffer(blob); + }; + + /** + * Load the math image specified by the hex string and call the + * callbackFunction with a base64 encoding of its data. + * + * @param hexString + * @param callbackFunction + */ + LocalArchive.prototype.loadMathImage = function(hexString, callbackFunction) { + var entrySize = 16 + 4 + 4; + var lo = 0; + var hi = this.mathIndexFile.size / entrySize; + + var mathDataFile = this.mathDataFile; + + this.findMathDataPosition(hexString, lo, hi, function(pos, length) { + var reader = new FileReader(); + reader.onerror = errorHandler; + reader.onabort = function(e) { + alert('Math image file read cancelled'); + }; + var blob = mathDataFile.slice(pos, pos + length); + reader.onload = function(e) { + var byteArray = new Uint8Array(e.target.result); + callbackFunction(util.uint8ArrayToBase64(byteArray)); + }; + reader.readAsArrayBuffer(blob); + }); + }; + + + /** + * Recursive algorithm to find the position of the Math image in the data file + * @param {type} hexString + * @param {type} lo + * @param {type} hi + * @param {type} callbackFunction + */ + LocalArchive.prototype.findMathDataPosition = function(hexString, lo, hi, callbackFunction) { + var entrySize = 16 + 4 + 4; + if (lo >= hi) { + /* TODO error - not found */ + return; + } + var reader = new FileReader(); + reader.onerror = errorHandler; + reader.onabort = function(e) { + alert('Math image file read cancelled'); + }; + var mid = Math.floor((lo + hi) / 2); + var blob = this.mathIndexFile.slice(mid * entrySize, (mid + 1) * entrySize); + var currentLocalArchiveInstance = this; + reader.onload = function(e) { + var byteArray = new Uint8Array(e.target.result); + var hash = util.uint8ArrayToHex(byteArray.subarray(0, 16)); + if (hash == hexString) { + var pos = util.readIntegerFrom4Bytes(byteArray, 16); + var length = util.readIntegerFrom4Bytes(byteArray, 16 + 4); + callbackFunction(pos, length); + return; + } else if (hexString < hash) { + hi = mid; + } else { + lo = mid + 1; + } + + currentLocalArchiveInstance.findMathDataPosition(hexString, lo, hi, callbackFunction); + }; + // Read the file as a binary string + reader.readAsArrayBuffer(blob); + }; + + + /** + * Resolve the redirect of the given title instance, and call the callbackFunction with the redirected Title instance + * @param title + * @param callbackFunction + */ + LocalArchive.prototype.resolveRedirect = function(title, callbackFunction) { + var reader = new FileReader(); + reader.onerror = errorHandler; + reader.onabort = function(e) { + alert('Title file read cancelled'); + }; + reader.onload = function(e) { + var binaryTitleFile = e.target.result; + var byteArray = new Uint8Array(binaryTitleFile); + + if (byteArray.length === 0) { + // TODO can probably be replaced by some error handler at window level + alert("Oops : there seems to be something wrong in your archive. Please report it to us by email or through Github (see About section), with the names of the archive and article and the following info : " + + "Unable to find redirected article for title " + title.name + " : offset " + title.blockStart + " not found in title file"); + throw new Error("Unable to find redirected article for title " + title.name + " : offset " + title.blockStart + " not found in title file"); + } + + var redirectedTitle = title; + redirectedTitle.fileNr = 1 * byteArray[2]; + redirectedTitle.blockStart = util.readIntegerFrom4Bytes(byteArray, 3); + redirectedTitle.blockOffset = util.readIntegerFrom4Bytes(byteArray, 7); + redirectedTitle.articleLength = util.readIntegerFrom4Bytes(byteArray, 11); + + callbackFunction(redirectedTitle); + }; + // Read only the 16 necessary bytes, starting at title.blockStart + var blob = this.titleFile.slice(title.blockStart, title.blockStart + 16); + // Read in the file as a binary string + reader.readAsArrayBuffer(blob); + }; + + // This is a global counter that helps find out when the search for articles nearby is over + var callbackCounterForTitlesInCoordsSearch = 0; + + /** + * Finds titles that are located inside the given rectangle + * This is the main function, that has to be called from the application + * + * @param {type} rect Rectangle where to look for titles + * @param {type} maxTitles Maximum number of titles to find + * @param callbackFunction Function to call with the list of titles found + */ + LocalArchive.prototype.getTitlesInCoords = function(rect, maxTitles, callbackFunction) { + if (callbackCounterForTitlesInCoordsSearch > 0) { + alert("The last nearby search did not seem to end well : please try again"); + callbackCounterForTitlesInCoordsSearch = 0; + return; + } + var normalizedRectangle = rect.normalized(); + var titlePositionsFound = new Array(); + for (var i = 0; i < this.coordinateFiles.length; i++) { + callbackCounterForTitlesInCoordsSearch++; + LocalArchive.getTitlesInCoordsInt(this, i, 0, normalizedRectangle, GLOBE_RECTANGLE, maxTitles, titlePositionsFound, callbackFunction, LocalArchive.callbackGetTitlesInCoordsInt); + } + }; + + /** + * Callback function called by getTitlesInCoordsInt (or by itself), in order + * to loop through every coordinate file, and search titles nearby in each + * of them. + * When all the coordinate files are searched, or when enough titles are + * found, another function is called to convert the title positions found + * into Title instances (asynchronously) + * + * @param {type} localArchive + * @param {type} titlePositionsFound + * @param {type} maxTitles + * @param {type} callbackFunction + */ + LocalArchive.callbackGetTitlesInCoordsInt = function(localArchive, titlePositionsFound, maxTitles, callbackFunction) { + // Search is over : now let's convert the title positions into Title instances + if (titlePositionsFound && titlePositionsFound.length > 0) { + LocalArchive.readTitlesFromTitleCoordsInTitleFile(localArchive, titlePositionsFound, 0, new Array(), maxTitles, callbackFunction); + } + else { + callbackFunction(titlePositionsFound, maxTitles); + } + + }; + + /** + * This function reads a list of title positions, and converts it into a list or Title instances. + * It handles index i, then recursively calls itself for index i+1 + * When all the list is processed, the callbackFunction is called with the Title list + * + * @param {type} localArchive + * @param {type} titlePositionsFound + * @param {type} i + * @param {type} titlesFound + * @param maxTitles + * @param {type} callbackFunction + */ + LocalArchive.readTitlesFromTitleCoordsInTitleFile = function (localArchive, titlePositionsFound, i, titlesFound, maxTitles, callbackFunction) { + var titleOffset = titlePositionsFound[i]; + localArchive.getTitlesStartingAtOffset(titleOffset, 1, function(titleList) { + if (titleList && titleList.length === 1) { + titlesFound.push(titleList[0]); + i++; + if (i