Haketilo

	result_object[`error_${prop}`] = "" + e;

	  await haketilodb.track.mapping(ch => changed("mappings", ch));

#EXPORT version_string

/*

 * This function overloads on the number of arguments. If one argument is

 * passed, it is an item definition (it need not be complete, only identifier,

 * version and, if applicable, revision properties are relevant). If two or

 * three arguments are given, they are in order: item identifier, item version

 * and item revision.

 * Returned is a string identifying this version of item.

 */

function item_id_string(...args) {

    let def = args[0]

    if (args.length > 1)

	def = {identifier: args[0], version: args[1], revision: args[2]};

    return !Array.isArray(def.version) ? def.identifier :

	`${def.identifier}-${version_string(def.version, def.revision)}`;

}

#EXPORT item_id_string

    ["resource",  {keyPath: "identifier"}],

    ["mapping",   {keyPath: "identifier"}],

 * item_store_names should be an array with either string "mapping", string

 * "resource" or both. files should be an object with values being contents of

    const item_store_names = ["resource", "mapping"];

    broadcast.prepare(context.sender, `idb_changes_${item.type}`,

    await _remove_item(item.type, item.identifier, context, false);

    await idb_put(context.transaction, item.type, item);

const remove_resource = (id, ctx) => remove_item("resource", id, ctx);

const remove_mapping = (id, ctx) => remove_item("mapping",  id, ctx);

 * `store_name` should be either "resource", "mapping", "settings", "blocking"

 * or "repos".

const trackable = ["resource", "mapping", "settings", "blocking", "repos"];

/* uint8_to_hex is a separate function used in cryptographic functions. */

const uint8_to_hex =

      array => [...array].map(b => ("0" + b.toString(16)).slice(-2)).join("");

 * Asynchronously compute hex string representation of a sha256 digest of a

 * UTF-8 string.

async function sha256_async(string) {

    const input_ab = new TextEncoder("utf-8").encode(string);

    const digest_ab = await crypto.subtle.digest("SHA-256", input_ab);

    return uint8_to_hex(new Uint8Array(digest_ab));

#EXPORT sha256_async

/*

 * Generate a unique value that can be computed synchronously and is impossible

 * to guess for a malicious website.

 */

    const random_data = new Uint8Array(length);

    crypto.getRandomValues(random_data);

    return uint8_to_hex(random_data);

.text_center {

    text-align: center;

}

.text_right {

    text-align: right;

}

 * Wrapper the requested callback into one that only executes it if dialog is

 * not shown.

function when_hidden(ctx, cb)

    function wrapped_cb(...args) {

	if (!ctx.shown)

	    return cb(...args);

    }

    return wrapped_cb;

#EXPORT when_hidden

#IF !INSTALL_LOADED

#DEFINE INSTALL_LOADED

<!--

    SPDX-License-Identifier: GPL-3.0-or-later OR CC-BY-SA-4.0

    Install mappings/resources in Haketilo.

    This file is part of Haketilo.

    Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>

    File is dual-licensed. You can choose either GPLv3+, CC BY-SA or both.

    This program 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.

    This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.

    I, Wojtek Kosior, thereby promise not to sue for violation of this file's

    licenses. Although I request that you do not make use of this code in a

    proprietary program, I am not going to enforce this in court.

  -->

<!--

    This is not a standalone page. This file is meant to be imported into other

    HTML code.

  -->

#INCLUDE html/dialog.html

#INCLUDE html/item_preview.html

#LOADCSS html/reset.css

#LOADCSS html/base.css

<style>

  .install_entry_li {

      display: flex;

      align-items: center;

      margin: 0;

      padding: 0.2em;

  }

  .install_entry_li:nth-child(2n) {

      background-color:#dadada;

  }

  .install_item_info {

      display: grid;

      grid-template-columns: auto;

      flex: 1 1 auto;

      min-width: 0;

  }

  .install_item_info > span {

      white-space: nowrap;

      overflow: hidden;

      text-overflow: ellipsis;

  }

  .install_item_more_info {

      font-size: 80%;

      font-style: italic;

  }

  .install_bottom_buttons {

      margin: 1em auto;

      text-align: center;

  }

</style>

<template>

  <div id="install_view" data-template="main_div">

    <div data-template="install_preview">

      <ul data-template="to_install_list"></ul>

      <div class="install_bottom_buttons">

	<button data-template="install_but">Install</button>

	<button data-template="cancel_but">Cancel</button>

      </div>

    </div>

    <div data-template="dialog_container">

      <!-- dialog shall be dynamically inserted here -->

    </div>

    <div data-template="mapping_preview_container">

      <!-- item preview shall be dynamically inserted here -->

      <div class="install_bottom_buttons">

	<button data-template="mapping_back_but">Back</button>

      </div>

    </div>

    <div data-template="resource_preview_container">

      <div class="install_bottom_buttons">

	<button data-template="resource_back_but">Back</button>

      </div>

    </div>

  </div>

  <li id="install_list_entry" data-template="main_li"

      class="install_entry_li">

    <div class="install_item_info">

      <span data-template="item_name"></span>

      <span data-template="item_id" class="install_item_more_info"></span>

      <span data-template="update_info"

	    class="install_item_more_info hide">

	(update from <span data-template="old_ver"></span>)

      </span>

    </div>

    <span class="text_right">

      <button data-template="details_but">Details</button>

    </span>

  </li>

</template>

#ENDIF

/**

 * This file is part of Haketilo.

 *

 * Function: Install mappings/resources in Haketilo.

 *

 * Copyright (C) 2022 Wojtek Kosior

 *

 * This program 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.

 *

 * This program 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.

 *

 * As additional permission under GNU GPL version 3 section 7, you

 * may distribute forms of that code without the copy of the GNU

 * GPL normally required by section 4, provided you include this

 * license notice and, in case of non-source distribution, a URL

 * through which recipients can access the Corresponding Source.

 * If you modify file(s) with this exception, you may extend this

 * exception to your version of the file(s), but you are not

 * obligated to do so. If you do not wish to do so, delete this

 * exception statement from your version.

 *

 * As a special exception to the GPL, any HTML file which merely

 * makes function calls to this code, and for that purpose

 * includes it by reference shall be deemed a separate work for

 * copyright law purposes. If you modify this code, you may extend

 * this exception to your version of the code, but you are not

 * obligated to do so. If you do not wish to do so, delete this

 * exception statement from your version.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program.  If not, see <https://www.gnu.org/licenses/>.

 *

 * I, Wojtek Kosior, thereby promise not to sue for violation of this file's

 * license. Although I request that you do not make use of this code in a

 * proprietary program, I am not going to enforce this in court.

 */

#IMPORT common/indexeddb.js AS haketilodb

#IMPORT html/dialog.js

#IMPORT html/item_preview.js AS ip

#FROM common/browser.js   IMPORT browser

#FROM html/DOM_helpers.js IMPORT clone_template

#FROM common/entities.js  IMPORT item_id_string, version_string, get_files

#FROM common/misc.js      IMPORT sha256_async AS sha256

const coll = new Intl.Collator();

/*

 * Comparator used to sort items in the order we want them to appear in

 * install dialog: first mappings alphabetically, then resources alphabetically.

 */

function compare_items(def1, def2) {

    if (def1.type !== def2.type)

	return def1.type === "mapping" ? -1 : 1;

    const name_comparison = coll.compare(def1.long_name, def2.long_name);

    return name_comparison === 0 ?

	coll.compare(def1.identifier, def2.identifier) : name_comparison;

}

function ItemEntry(install_view, item) {

    Object.assign(this, clone_template("install_list_entry"));

    this.item_def = item.def;

    this.item_name.innerText = item.def.long_name;

    this.item_id.innerText = item_id_string(item.def);

    if (item.db_def) {

	this.old_ver.innerText =

	    version_string(item.db_def.version, item.db_def.revision);

	this.update_info.classList.remove("hide");

    }

    let preview_cb = () => install_view.preview_item(item.def);

    preview_cb = dialog.when_hidden(install_view.dialog_ctx, preview_cb);

    this.details_but.addEventListener("click", preview_cb);

}

const container_ids = [

    "install_preview",

    "dialog_container",

    "mapping_preview_container",

    "resource_preview_container"

];

/*

 * Work object is used to communicate between asynchronously executing

 * functions when computing dependencies tree of an item and when fetching

 * files for installation.

 */

async function init_work() {

    const work = {

	waiting: 0,

	is_ok: true,

	db: (await haketilodb.get()),

	result: []

    };

    work.err = function (error, user_message) {

	if (error)

    	    console.error(error);

	work.is_ok = false;

	work.reject_cb(user_message);

    }

    return [work,

	    new Promise((...cbs) => [work.resolve_cb, work.reject_cb] = cbs)];

}

function InstallView(tab_id, on_view_show, on_view_hide) {

    Object.assign(this, clone_template("install_view"));

    this.shown = false;

    const show_container = name => {

	for (const cid of container_ids) {

	    if (cid !== name)

		this[cid].classList.add("hide");

	}

	this[name].classList.remove("hide");

    }

    this.dialog_ctx = dialog.make(() => show_container("dialog_container"),

				  () => show_container("install_preview"));

    this.dialog_container.prepend(this.dialog_ctx.main_div);

    /* Make a link to view a file from the repository. */

    const make_file_link = (preview_ctx, file_ref) => {

	const a = document.createElement("a");

	a.href = `${this.repo_url}file/${file_ref.hash_key}`;

	a.innerText = file_ref.file;

	return a;

    }

    this.previews_ctx = {};

    this.preview_item = item_def => {

	if (!this.shown)

	    return;

	const fun = ip[`${item_def.type}_preview`];

	const preview_ctx = fun(item_def, this.previews_ctx[item_def.type],

				make_file_link);

	this.previews_ctx[item_def.type] = preview_ctx;

	const container_name = `${item_def.type}_preview_container`;

	show_container(container_name);

	this[container_name].prepend(preview_ctx.main_div);

    }

    const back_cb = dialog.when_hidden(this.dialog_ctx,

				       () => show_container("install_preview"));

    for (const type of ["resource", "mapping"])

	this[`${type}_back_but`].addEventListener("click", back_cb);

    const process_item = async (work, item_type, id, ver) => {

	if (!work.is_ok || work.processed_by_type[item_type].has(id))

	    return;

	work.processed_by_type[item_type].add(id);

	work.waiting++;

	const url = ver ?

	      `${this.repo_url}${item_type}/${id}/${ver.join(".")}.json` :

	      `${this.repo_url}${item_type}/${id}.json`;

	const response =

	      await browser.tabs.sendMessage(tab_id, ["repo_query", url]);

	if (!work.is_ok)

	    return;

	if ("error" in response) {

	    return work.err(response.error,

			    "Failure to communicate with repository :(");

	}

	if (!response.ok) {

	    return work.err(null,

			    `Repository sent HTTP code ${response.status} :(`);

	}

	if ("error_json" in response) {

	    return work.err(response.error_json,

			    "Repository's response is not valid JSON :(");

	}

	if (response.json.api_schema_version > [1]) {

	    let api_ver = "";

	    try {

		api_ver =

		    ` (${version_string(response.json.api_schema_version)})`;

	    } catch(e) {

		console.warn(e);

	    }

	    const captype = item_type[0].toUpperCase() + item_type.substring(1);

	    const msg = `${captype} ${item_id_string(id, ver)} was served using unsupported Hydrilla API version${api_ver}. You might need to update Haketilo.`;

	    return work.err(null, msg);

	}

	/* TODO: JSON schema validation should be added here. */

	delete response.json.api_schema_version;

	delete response.json.api_schema_revision;

	const files = response.json.source_copyright

	      .concat(item_type === "resource" ? response.json.scripts : []);

	for (const file of files) {

	    file.hash_key = `sha256-${file.sha256}`;

	    delete file.sha256;

	}

	if (item_type === "mapping") {

	    for (const res_ref of Object.values(response.json.payloads))

		process_item(work, "resource", res_ref.identifier);

	} else {

	    for (const res_id of (response.json.dependencies || []))

		process_item(work, "resource", res_id);

	}

	/*

	 * At this point we already have JSON definition of the item and we

	 * triggered processing of its dependencies. We now have to verify if

	 * the same or newer version of the item is already present in the

	 * database and if so - omit this item.

	 */

	const transaction = work.db.transaction(item_type);

	try {

	    var db_def = await haketilodb.idb_get(transaction, item_type, id);

	    if (!work.is_ok)

		return;

	} catch(e) {

	    const msg = "Error accessing Haketilo's internal database :(";

	    return work.err(e, msg);

	}

	if (!db_def || db_def.version < response.json.version)

	    work.result.push({def: response.json, db_def});

	if (--work.waiting === 0)

	    work.resolve_cb(work.result);

    }

    async function compute_deps(item_type, item_id, item_ver) {

	const [work, work_prom] = await init_work();

	work.processed_by_type = {"mapping" : new Set(), "resource": new Set()};

	process_item(work, item_type, item_id, item_ver);

	const items = await work_prom;

	items.sort((i1, i2) => compare_items(i1.def, i2.def));

	return items;

    }

    this.show = async (repo_url, item_type, item_id, item_ver) => {

	if (this.shown)

	    return;

	this.shown = true;

	this.repo_url = repo_url;

	dialog.loader(this.dialog_ctx, "Fetching data from repository...");

	try {

	    on_view_show();

	} catch(e) {

	    console.error(e);

	}

	try {

	    var items = await compute_deps(item_type, item_id, item_ver);

	} catch(e) {

	    var dialog_prom = dialog.error(this.dialog_ctx, e);

	}

	if (!dialog_prom && items.length === 0) {

	    const msg = "Nothing to do - packages already installed.";

	    var dialog_prom = dialog.info(this.dialog_ctx, msg);

	}

	if (dialog_prom) {

	    dialog.close(this.dialog_ctx);

	    await dialog_prom;

	    hide();

	    return;

	}

	this.item_entries = items.map(i => new ItemEntry(this, i));

	this.to_install_list.append(...this.item_entries.map(ie => ie.main_li));

	dialog.close(this.dialog_ctx);

    }

    const process_file = async (work, hash_key) => {

	if (!work.is_ok)

	    return;

	work.waiting++;

	try {

	    var file_uses = await haketilodb.idb_get(work.file_uses_transaction,

						     "file_uses", hash_key);

	    if (!work.is_ok)

		return;

	} catch(e) {

	    const msg = "Error accessing Haketilo's internal database :(";

	    return work.err(e, msg);

	}

	if (!file_uses) {

	    const url = `${this.repo_url}file/${hash_key}`;

	    try {

		var response = await fetch(url);

		if (!work.is_ok)

		    return;

	    } catch(e) {

		const msg = "Failure to communicate with repository :(";

		return work.err(e, msg);

	    }

	    if (!response.ok) {

		const msg = `Repository sent HTTP code ${response.status} :(`;

		return work.err(null, msg);

	    }

	    try {

		var text = await response.text();

		if (!work.is_ok)

		    return;

	    } catch(e) {

		const msg = "Repository's response is not valid text :(";

		return work.err(e, msg);

	    }

	    const digest = await sha256(text);

	    if (!work.is_ok)

		return;

	    if (`sha256-${digest}` !== hash_key) {

		const msg = `${url} served a file with different SHA256 cryptographic sum :(`;

		return work.err(null, msg);

	    }

	    work.result.push([hash_key, text]);

	}

	if (--work.waiting === 0)

	    work.resolve_cb(work.result);

    }

    const get_missing_files = async item_defs => {

	const [work, work_prom] = await init_work();

	work.file_uses_transaction = work.db.transaction("file_uses");

	const processed_files = new Set();

	for (const item_def of item_defs) {

	    for (const file of get_files(item_def)) {

		if (!processed_files.has(file.hash_key)) {

		    processed_files.add(file.hash_key);

		    process_file(work, file.hash_key);

		}

	    }

	}

	return processed_files.size > 0 ? work_prom : [];

    }

    const perform_install = async () => {

	if (!this.show || !this.item_entries)

	    return;

	dialog.loader(this.dialog_ctx, "Installing...");

	const item_defs = this.item_entries.map(ie => ie.item_def);

	try {

	    var files = (await get_missing_files(item_defs))

		.reduce((ac, [hk, txt]) => Object.assign(ac, {[hk]: txt}), {});

	} catch(e) {

	    var dialog_prom = dialog.error(this.dialog_ctx, e);

	}

	if (files !== undefined) {

	    const data = {files};

	    const names = [["mappings", "mapping"], ["resources", "resource"]];

	    for (const [set_name, type] of names) {

		const set = {};

		for (const def of item_defs.filter(def => def.type === type))

		    set[def.identifier] = {[version_string(def.version)]: def};

		data[set_name] = set;

	    }

	    try {

		await haketilodb.save_items(data);

	    } catch(e) {

		console.error(e);

		const msg = "Error writing to Haketilo's internal database :(";

		var dialog_prom = dialog.error(this.dialog_ctx, msg);

	    }

	}

	if (!dialog_prom) {

	    const msg = "Successfully installed!";

	    var dialog_prom = dialog.info(this.dialog_ctx, msg);

	}

	dialog.close(this.dialog_ctx);

	await dialog_prom;

	hide();

    }

    const hide = () => {

	if (!this.shown)

	    return;

	this.shown = false;

	delete this.item_entries;

	[...this.to_install_list.children].forEach(n => n.remove());

	try {

	    on_view_hide();

	} catch(e) {

	    console.error(e);

	}

    }

    this.when_hidden = cb => {

	const wrapped_cb = (...args) => {

	    if (!this.shown)

		return cb(...args);

	}

	return wrapped_cb;

    }

    const hide_cb = dialog.when_hidden(this.dialog_ctx, hide);

    this.cancel_but.addEventListener("click", hide_cb);

    const install_cb = dialog.when_hidden(this.dialog_ctx, perform_install);

    this.install_but.addEventListener("click", install_cb);

}

	  await haketilodb.start_items_transaction([item_type], {});

      return item_list(resource_preview, haketilodb.track.resource,

      return item_list(mapping_preview, haketilodb.track.mapping,

/* Link click handler used in make_file_link(). */

/*

 * The default function to use to create file preview link. Links it creates can

 * be used to view files from IndexedDB.

 */

function resource_preview(resource, preview_object, dialog_context,

			  make_link_cb=make_file_link)

    const link_maker = file_ref => make_link_cb(preview_object, file_ref);

function mapping_preview(mapping, preview_object, dialog_context,

			 make_link_cb=make_file_link)

    const link_maker = file_ref => make_link_cb(preview_object, file_ref);

    const tx_ctx = await tx_starter(["resource", "mapping"], saving.files);

    for (const type of ["resource", "mapping"]) {

	    (await haketilodb.idb_get(tx_ctx.transaction, type,

	<div id="default_policy_dialog" class="grid_col_both text_center">

	node.addEventListener("click", dialog.when_hidden(list.dialog_ctx, cb));

    const enter_cb = e => (e.key === 'Enter') && enter_hit();

    this.input.addEventListener("keypress",

				dialog.when_hidden(list.dialog_ctx, enter_cb));

    this.new_but.addEventListener("click",

				  dialog.when_hidden(dialog_ctx, add_new));

        {'ok', 'status', 'text', 'error_json'}

        const promise = start_items_transaction(["resource"], arguments[1])

    assert database_contents['mapping'] == []

    assert database_contents['resource'] == [sample_item]

                await start_items_transaction(["resource"], args[1]);

        const promise = start_items_transaction(["mapping"], arguments[1])

    del database_contents['resource'][0]['source_copyright'][0]['extra_prop']

    assert database_contents['resource'] == [make_sample_resource()]

    assert database_contents['mapping']  == [sample_item]

                start_items_transaction(["{item_type}"], {{}})

    assert results[0]['resource'] == []

    assert results[0]['mapping'] == [sample_item]

    assert database_contents['resource'] == [sample_resource]

    assert database_contents['mapping']  == [sample_mapping]

            ('resource_helloapple', sample_resource),

            ('mapping_helloapple', sample_mapping),

            ('resource_helloapple-copy', sample_resource2),

            ('mapping_helloapple-copy', sample_mapping2),

            const store_names = ["resource", "mapping"];

    removed_ids = ['mapping_helloapple-copy', 'resource_helloapple',

# SPDX-License-Identifier: CC0-1.0

"""

Haketilo unit tests - item installation dialog

"""

# This file is part of Haketilo

#

# Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>

#

# This program is free software: you can redistribute it and/or modify

# it under the terms of the CC0 1.0 Universal License as published by

# the Creative Commons Corporation.

#

# This program 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

# CC0 1.0 Universal License for more details.

import pytest

import json

from selenium.webdriver.support.ui import WebDriverWait

from ..extension_crafting import ExtraHTML

from ..script_loader import load_script

from .utils import *

def content_script():

    script = load_script('content/repo_query_cacher.js')

    return f'{script}; {tab_id_asker}; start();'

def background_script():

    script = load_script('background/broadcast_broker.js',

                         '#IMPORT background/CORS_bypass_server.js')

    return f'{script}; {tab_id_responder}; start(); CORS_bypass_server.start();'

def setup_view(driver, execute_in_page):

    tab_id = run_content_script_in_new_window(driver, 'https://gotmyowndoma.in')

    execute_in_page(load_script('html/install.js'))

    container_ids, containers_objects = execute_in_page(

        '''

        const cb_calls = [];

        const install_view = new InstallView(arguments[0],

                                             () => cb_calls.push("show"),

                                             () => cb_calls.push("hide"));

        document.body.append(install_view.main_div);

        const ets = () => install_view.item_entries;

        const shw = slice => [cb_calls.slice(slice || 0), install_view.shown];

        returnval([container_ids, container_ids.map(cid => install_view[cid])]);

        ''',

        tab_id)

    containers = dict(zip(container_ids, containers_objects))

    def assert_container_displayed(container_id):

        for cid, cobj in zip(container_ids, containers_objects):

            assert (cid == container_id) == cobj.is_displayed()

    return containers, assert_container_displayed

install_ext_data = {

    'content_script': content_script,

    'background_script': background_script,

    'extra_html': ExtraHTML('html/install.html', {}),

    'navigate_to': 'html/install.html'

}

@pytest.mark.ext_data(install_ext_data)

@pytest.mark.usefixtures('webextension')

@pytest.mark.parametrize('complex_variant', [False, True])

def test_install_normal_usage(driver, execute_in_page, complex_variant):

    """

    Test of the normal package installation procedure with one mapping and,

    depending on parameter, one or many resources.

    """

    containers, assert_container_displayed = setup_view(driver, execute_in_page)

    assert execute_in_page('returnval(shw());') == [[], False]

    if complex_variant:

        # The resource/mapping others depend on.

        root_id = 'abcd-defg-ghij'

        root_resource_id = f'resource_{root_id}'

        root_mapping_id = f'mapping_{root_id}'

        # Those ids are used to check the alphabetical ordering.

        resource_ids = [f'resource_{letters}' for letters in (

            'a', 'abcd', root_id, 'b', 'c',

            'd', 'defg', 'e', 'f',

            'g', 'ghij', 'h', 'i', 'j'

        )]

        files_count = 9

    else:

        root_resource_id = f'resource_a'

        root_mapping_id = f'mapping_a'

        resource_ids = [root_resource_id]

        files_count = 0

    # Preview the installation of a resource, show resource's details, close

    # the details and cancel installation.

    execute_in_page('returnval(install_view.show(...arguments));',

                    'https://hydril.la/', 'resource', root_resource_id)

    assert execute_in_page('returnval(shw());') == [['show'], True]

    assert f'{root_resource_id}-2021.11.11-1'\

        in containers['install_preview'].text

    assert_container_displayed('install_preview')

    entries = execute_in_page('returnval(ets().map(e => e.main_li.innerText));')

    assert len(entries) == len(resource_ids)

    # Verify alphabetical ordering.

    assert all([id in text for id, text in zip(resource_ids, entries)])

    assert not execute_in_page('returnval(ets()[0].old_ver);').is_displayed()

    execute_in_page('returnval(ets()[0].details_but);').click()

    assert 'resource_a' in containers['resource_preview_container'].text

    assert_container_displayed('resource_preview_container')

    execute_in_page('returnval(install_view.resource_back_but);').click()

    assert_container_displayed('install_preview')

    assert execute_in_page('returnval(shw());') == [['show'], True]

    execute_in_page('returnval(install_view.cancel_but);').click()

    assert execute_in_page('returnval(shw());') == [['show', 'hide'], False]

    # Preview the installation of a mapping and a resource, show mapping's

    # details, close the details and commit the installation.

    execute_in_page('returnval(install_view.show(...arguments));',

                    'https://hydril.la/', 'mapping',

                    root_mapping_id, [2022, 5, 10])

    assert execute_in_page('returnval(shw(2));') == [['show'], True]

    assert_container_displayed('install_preview')

    entries = execute_in_page('returnval(ets().map(e => e.main_li.innerText));')

    assert len(entries) == len(resource_ids) + 1

    assert f'{root_mapping_id}-2022.5.10' in entries[0]

    # Verify alphabetical ordering.

    assert all([id in text for id, text in zip(resource_ids, entries[1:])])

    assert not execute_in_page('returnval(ets()[0].old_ver);').is_displayed()

    execute_in_page('returnval(ets()[0].details_but);').click()

    assert root_mapping_id in containers['mapping_preview_container'].text

    assert_container_displayed('mapping_preview_container')

    execute_in_page('returnval(install_view.mapping_back_but);').click()

    assert_container_displayed('install_preview')

    execute_in_page('returnval(install_view.install_but);').click()

    installed = lambda d: 'ly installed!' in containers['dialog_container'].text

    WebDriverWait(driver, 10000).until(installed)

    assert execute_in_page('returnval(shw(2));') == [['show'], True]

    execute_in_page('returnval(install_view.dialog_ctx.ok_but);').click()

    assert execute_in_page('returnval(shw(2));') == [['show', 'hide'], False]

    # Verify the install

    db_contents = get_db_contents(execute_in_page)

    for item_type, ids in \

        [('mapping', {root_mapping_id}), ('resource', set(resource_ids))]:

        assert set([it['identifier'] for it in db_contents[item_type]]) == ids

    assert all([len(db_contents[store]) == files_count

                for store in ('files', 'file_uses')])

    # Update the installed mapping to a newer version.

    execute_in_page('returnval(install_view.show(...arguments));',

                    'https://hydril.la/', 'mapping', root_mapping_id)

    assert execute_in_page('returnval(shw(4));') == [['show'], True]

    # resources are already in the newest versions, hence they should not appear

    # in the install preview list.

    assert execute_in_page('returnval(ets().length);') == 1

    # Mapping's version update information should be displayed.

    assert execute_in_page('returnval(ets()[0].old_ver);').is_displayed()

    execute_in_page('returnval(install_view.install_but);').click()

    WebDriverWait(driver, 10).until(installed)

    assert execute_in_page('returnval(shw(4));') == [['show'], True]

    execute_in_page('returnval(install_view.dialog_ctx.ok_but);').click()

    assert execute_in_page('returnval(shw(4));') == [['show', 'hide'], False]

    # Verify the newer version install.

    old_db_contents, db_contents = db_contents, get_db_contents(execute_in_page)

    old_db_contents['mapping'][0]['version'][-1] += 1

    assert db_contents['mapping'] == old_db_contents['mapping']

    # All items are up to date - verify dialog is instead shown in this case.

    execute_in_page('install_view.show(...arguments);',

                    'https://hydril.la/', 'mapping', root_mapping_id)

    assert execute_in_page('returnval(shw(6));') == [['show'], True]

    assert_container_displayed('dialog_container')

    assert 'Nothing to do - packages already installed.' \

        in containers['dialog_container'].text

    execute_in_page('returnval(install_view.dialog_ctx.ok_but);').click()

    assert execute_in_page('returnval(shw(6));') == [['show', 'hide'], False]

@pytest.mark.ext_data(install_ext_data)

@pytest.mark.usefixtures('webextension')

@pytest.mark.parametrize('message', [

    'fetching_data',

    'failure_to_communicate_sendmessage',

    'HTTP_code_item',

    'invalid_JSON',

    'newer_API_version',

    'invalid_API_version',

    'indexeddb_error_item',

    'installing',

    'indexeddb_error_file_uses',

    'failure_to_communicate_fetch',

    'HTTP_code_file',

    'not_valid_text',

    'sha256_mismatch',

    'indexeddb_error_write'

])

def test_install_dialogs(driver, execute_in_page, message):

    """

    Test of various error and loading messages used in install view.

    """

    containers, assert_container_displayed = setup_view(driver, execute_in_page)

    def dlg_buts():

        return execute_in_page(

            '''{

            const dlg = install_view.dialog_ctx;

            const ids = ['ask_buts', 'conf_buts'];

            returnval(ids.filter(id => !dlg[id].classList.contains("hide")));

            }''')

    def dialog_txt():

        return execute_in_page(

            'returnval(install_view.dialog_ctx.msg.textContent);'

        )

    def assert_dlg(awaited_buttons, expected_msg, hides_install_view=True,

                   button_to_click='ok_but'):

        WebDriverWait(driver, 10).until(lambda d: dlg_buts() == awaited_buttons)

        assert expected_msg == dialog_txt()

        execute_in_page(

            f'returnval(install_view.dialog_ctx.{button_to_click});'

        ).click()

        if hides_install_view:

            assert execute_in_page('returnval(shw());') == \

                [['show', 'hide'], False]

    if message == 'fetching_data':

        execute_in_page(

            '''

            browser.tabs.sendMessage = () => new Promise(cb => {});

            install_view.show(...arguments);

            ''',

            'https://hydril.la/', 'mapping', 'mapping_a')

        assert dlg_buts() == []

        assert dialog_txt() == 'Fetching data from repository...'

    elif message == 'failure_to_communicate_sendmessage':

        execute_in_page(

            '''

            browser.tabs.sendMessage = () => Promise.resolve({error: "sth"});

            install_view.show(...arguments);

            ''',

            'https://hydril.la/', 'mapping', 'mapping_a')

        assert_dlg(['conf_buts'], 'Failure to communicate with repository :(')

    elif message == 'HTTP_code_item':

        execute_in_page(

            '''

            const response = {ok: false, status: 404};

            browser.tabs.sendMessage = () => Promise.resolve(response);

            install_view.show(...arguments);

            ''',

            'https://hydril.la/', 'mapping', 'mapping_a')

        assert_dlg(['conf_buts'], 'Repository sent HTTP code 404 :(')

    elif message == 'invalid_JSON':

        execute_in_page(

            '''

            const response = {ok: true, status: 200, error_json: "sth"};

            browser.tabs.sendMessage = () => Promise.resolve(response);

            install_view.show(...arguments);

            ''',

            'https://hydril.la/', 'mapping', 'mapping_a')

        assert_dlg(['conf_buts'], "Repository's response is not valid JSON :(")

    elif message == 'newer_API_version':

        execute_in_page(

            '''

            const response = {

                ok: true,

                status: 200,

                json: {api_schema_version: [99, 99]}

            };

            browser.tabs.sendMessage = () => Promise.resolve(response);

            install_view.show(...arguments);

            ''',

            'https://hydril.la/', 'mapping', 'somemapping', [2, 1])

        assert_dlg(['conf_buts'],

                   'Mapping somemapping-2.1 was served using unsupported Hydrilla API version (99.99). You might need to update Haketilo.')

    elif message == 'invalid_API_version':

        execute_in_page(

            '''

            const response = {

                ok: true,

                status: 200,

                /* API version here is not an array as it should be. */

                json: {api_schema_version: 123}

            };

            browser.tabs.sendMessage = () => Promise.resolve(response);

            install_view.show(...arguments);

            ''',

            'https://hydril.la/', 'resource', 'someresource')

        assert_dlg(['conf_buts'],

                   'Resource someresource was served using unsupported Hydrilla API version. You might need to update Haketilo.')

    elif message == 'indexeddb_error_item':

        execute_in_page(

            '''

            haketilodb.idb_get = () => {throw "some error";};

            install_view.show(...arguments);

            ''',

            'https://hydril.la/', 'mapping', 'mapping_a')

        assert_dlg(['conf_buts'],

                   "Error accessing Haketilo's internal database :(")

    elif message == 'installing':

        execute_in_page(

            '''

            haketilodb.save_items = () => new Promise(() => {});

            returnval(install_view.show(...arguments));

            ''',

            'https://hydril.la/', 'mapping', 'mapping_b')

        execute_in_page('returnval(install_view.install_but);').click()

        assert dlg_buts() == []

        assert dialog_txt() == 'Installing...'

    elif message == 'indexeddb_error_file_uses':

        execute_in_page(

            '''

            const old_idb_get = haketilodb.idb_get;

            haketilodb.idb_get = function(transaction, store_name, identifier) {

                if (store_name === "file_uses")

                    throw "some error";

                return old_idb_get(...arguments);

            }

            returnval(install_view.show(...arguments));

            ''',

            'https://hydril.la/', 'mapping', 'mapping_b')

        execute_in_page('returnval(install_view.install_but);').click()

        assert_dlg(['conf_buts'],

                   "Error accessing Haketilo's internal database :(")

    elif message == 'failure_to_communicate_fetch':

        execute_in_page(

            '''

            fetch = () => {throw "some error";};

            returnval(install_view.show(...arguments));

            ''',

            'https://hydril.la/', 'mapping', 'mapping_b')

        execute_in_page('returnval(install_view.install_but);').click()

        assert_dlg(['conf_buts'],

                   'Failure to communicate with repository :(')

    elif message == 'HTTP_code_file':

        execute_in_page(

            '''

            fetch = () => Promise.resolve({ok: false, status: 400});

            returnval(install_view.show(...arguments));

            ''',

            'https://hydril.la/', 'mapping', 'mapping_b')

        execute_in_page('returnval(install_view.install_but);').click()