diff --git a/README.md b/README.md index 0f2f4d8..9a620df 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,53 @@ # DwebTransports -General transport library for Decentralized Web handles multiple underlying transports +General transport library for Decentralized Web handles multiple underlying transports. + +## Background +This library is part of a general project at the Internet Archive (archive.org) +to support the decentralized web. + +###Goals +* to allow a single API that can be used for most basic interactions with +decentralized transports. +* to support multiple URLs, on different transports, so that the (current) underlying unreliability + is hidden. + +### Node Installation +* Clone this repo. +* Until this is in npm, add the line +`"dweb-transports": "git+https://git@github.com/mitra42/dweb-transports.git",` +to your package.json file in the dependencies section. +* (TODO Note location above will change to an internetarchive repo) +* `npm install dweb-transports` will install the dependencies including IPFS & WebTorrent + +`const DwebTransports = require(dweb-transport)` will add all Transports to a Javascript file. +* TODO writeup how to require only some of the transports. +* Then see usage API below + +### Installation and usage in the Browser +* TODO installation of dev dependencies +* Install npm & node +* Clone this repo and cd to it. +* `npm bundle` will create dist/dweb_transports_bundle.js +* Add `` to your `` +* TODO need to split out necessary from htmlutils so p_connect exposed + +Then code like this should work. + +``` +async function main() { + try { + // Connect to a set of transports, that the user can override + // p_connect will look for "?transport=HTTP" etc to override defaults + await p_connect({defaulttransport: ["HTTP", "IPFS"]}); + // Code you want to happen after connection goes here + + // Fetch some data from a service, specifiying two places to get it + foo = await DwebTransports.p_fetch(["http://bar.com/foo.json", "ipfs:/ipfs/Q1abc"], verbose); + } catch(err) { + alert(err.message); + } +} +var searchparams = new URL(window.location.href).searchParams; +// Allow specifying ?verbose=true in URL to get debugging +var verbose = searchparams.get("verbose") || false; +``` \ No newline at end of file diff --git a/Transport.js b/Transport.js index b5cec1e..a3ca32d 100644 --- a/Transport.js +++ b/Transport.js @@ -11,6 +11,10 @@ class Transport { /* Doesnt do anything, its all done by SuperClasses, Superclass should merge with default options, call super + + Fields: + statuselement: If set is an HTML Element that should be adjusted to indicate status. + name: Short name of element e.g. HTTP IPFS WEBTORRENT */ } @@ -38,7 +42,7 @@ class Transport { return t.p_setup2(verbose); // And connect } - togglePaused() { + togglePaused(cb) { //TODO-API switch (this.status) { case Transport.STATUS_CONNECTED: this.status = Transport.STATUS_PAUSED; @@ -47,6 +51,7 @@ class Transport { this.status = Transport.STATUS_CONNECTED; // Superclass might change to STATUS_STARTING if needs to stop/restart break; } + if (cb) cb(this); } supports(url, func) { diff --git a/TransportHTTP.js b/TransportHTTP.js index 8d33d79..72fca1b 100644 --- a/TransportHTTP.js +++ b/TransportHTTP.js @@ -62,7 +62,11 @@ class TransportHTTP extends Transport { throw err; } } - async p_setup1(verbose) { + async p_setup1(verbose, cb) { + this.status = Transport.STATUS_STARTING; + if (cb) cb(this); + await this.p_status(verbose); + if (cb) cb(this); return this; } diff --git a/TransportIPFS.js b/TransportIPFS.js index b782f5d..524b951 100644 --- a/TransportIPFS.js +++ b/TransportIPFS.js @@ -110,16 +110,18 @@ class TransportIPFS extends Transport { return t; } - async p_setup1(verbose) { + async p_setup1(verbose, cb) { //TODO-API try { if (verbose) console.log("IPFS starting and connecting"); this.status = Transport.STATUS_STARTING; // Should display, but probably not refreshed in most case + if (cb) cb(this); await this.p_ipfsstart(verbose); // Throws Error("websocket error") and possibly others. - this.status = (await this.ipfs.isOnline()) ? Transport.STATUS_CONNECTED : Transport.STATUS_FAILED; + this.status = await this.p_status(verbose); } catch(err) { console.error("IPFS failed to connect",err); this.status = Transport.STATUS_FAILED; } + if (cb) cb(this); return this; } diff --git a/TransportWEBTORRENT.js b/TransportWEBTORRENT.js index 5419347..a306df8 100644 --- a/TransportWEBTORRENT.js +++ b/TransportWEBTORRENT.js @@ -66,14 +66,17 @@ class TransportWEBTORRENT extends Transport { return t; } - async p_setup1(verbose) { + async p_setup1(verbose, cb) { try { this.status = Transport.STATUS_STARTING; + if (cb) cb(this); await this.p_webtorrentstart(verbose); + await this.p_status(verbose); } catch(err) { console.error("WebTorrent failed to connect",err); this.status = Transport.STATUS_FAILED; } + if (cb) cb(this); return this; } @@ -88,7 +91,6 @@ class TransportWEBTORRENT extends Transport { } else { this.status = Transport.STATUS_FAILED; } - return this.status; } diff --git a/TransportYJS.js b/TransportYJS.js index 1cf9ec8..390e768 100644 --- a/TransportYJS.js +++ b/TransportYJS.js @@ -110,7 +110,7 @@ class TransportYJS extends Transport { return t; } - async p_setup2(verbose) { + async p_setup2(verbose, cb) { /* This sets up for Y connections, which are opened each time a resource is listed, added to, or listmonitored. p_setup2 is defined because IPFS will have started during the p_setup1 phase. @@ -118,12 +118,15 @@ class TransportYJS extends Transport { */ try { this.status = Transport.STATUS_STARTING; // Should display, but probably not refreshed in most case + if (cb) cb(this); this.options.yarray.connector.ipfs = Transports.ipfs(verbose).ipfs; // Find an IPFS to use (IPFS's should be starting in p_setup1) this.yarrays = {}; + await this.p_status(verbose); } catch(err) { console.error("YJS failed to start",err); this.status = Transport.STATUS_FAILED; } + if (cb) cb(this); return this; } diff --git a/Transports.js b/Transports.js index 5c59a23..085daf7 100644 --- a/Transports.js +++ b/Transports.js @@ -432,17 +432,17 @@ class Transports { // Setup Transports - setup0 is called once, and should return quickly, p_setup1 and p_setup2 are asynchronous and p_setup2 relies on p_setup1 having resolved. - static setup0(transports, options, verbose) { + static setup0(tabbrevs, options, verbose, cb) { /* Setup Transports for a range of classes - transports is abbreviation HTTP, IPFS, LOCAL or list of them e.g. "HTTP,IPFS" + tabbrevs is abbreviation HTTP, IPFS, LOCAL or list of them e.g. "HTTP,IPFS" Handles "LOCAL" specially, turning into a HTTP to a local server (for debugging) returns array of transport instances */ // "IPFS" or "IPFS,LOCAL,HTTP" let localoptions = {http: {urlbase: "http://localhost:4244"}}; - return transports.map((tabbrev) => { + return tabbrevs.map((tabbrev) => { let transportclass; if (tabbrev === "LOCAL") { transportclass = this._transportclasses["HTTP"]; @@ -458,15 +458,15 @@ class Transports { } }).filter(f => !!f); // Trim out any undefined } - static async p_setup1(verbose) { + static async p_setup1(verbose, cb) { /* Second stage of setup, connect if possible */ // Does all setup1a before setup1b since 1b can rely on ones with 1a, e.g. YJS relies on IPFS - await Promise.all(this._transports.map((t) => t.p_setup1(verbose))); + await Promise.all(this._transports.map((t) => t.p_setup1(verbose, cb))) } - static async p_setup2(verbose) { + static async p_setup2(verbose, cb) { /* Second stage of setup, connect if possible */ // Does all setup1a before setup1b since 1b can rely on ones with 1a, e.g. YJS relies on IPFS - await Promise.all(this._transports.map((t) => t.p_setup2(verbose))); + await Promise.all(this._transports.map((t) => t.p_setup2(verbose, cb))) } static async test(verbose) { if (verbose) {console.log("Transports.test")} diff --git a/dist/LICENSE b/dist/LICENSE deleted file mode 100644 index dbbe355..0000000 --- a/dist/LICENSE +++ /dev/null @@ -1,661 +0,0 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero 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 Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. diff --git a/dist/README.md b/dist/README.md deleted file mode 100644 index 0f2f4d8..0000000 --- a/dist/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# DwebTransports -General transport library for Decentralized Web handles multiple underlying transports diff --git a/example_block.html b/example_block.html new file mode 100644 index 0000000..7a53985 --- /dev/null +++ b/example_block.html @@ -0,0 +1,121 @@ + + + + + + DWEB Transports example page + + + + + + + + + + + + + +
+
+
+ +
+

Dweb - Transports Example - unstructured data store and retrieval

+

Create something here, and when its saved its urls will appear below

+
+ +
+ +

Enter a link here and it will be retrieved.

+
+ + +
+ +
retrieved data will go here
+
+

Explanation

+ +
    +
  • As you open the page it tries to connect to the transports, which by default are HTTP and IPFS.
    • +
  • These should change to Yellow as they try, and then Green when connected.
    • +
  • If it goes Red, it means it failed to connect - e.g. to get an "info" response from HTTP, or to conenct to IPFS.
    • +
  • You can edit text, which is happening entirely locally on your machine.
    • +
  • When you hit Save, its stored on the connected transports
    • +
  • A link to this is put in the Retrieval box
    • +
  • You can click on the Retrieve button and it will be retrieved and displayed for editing.
    • +
  • You can also paste that link into a different browser.
    • +
+ + + + + diff --git a/example_styles.css b/example_styles.css new file mode 100644 index 0000000..8ed257d --- /dev/null +++ b/example_styles.css @@ -0,0 +1,92 @@ +/* Styles used for all the examples */ + +/* Styles used for tables of properties, especially by (now obsolete) objbrowser.js*/ +.props { padding-left: 0; } /*Move back directly under type name*/ +.prop {display:table-row; border: 1px dotted grey; } /*ignoring border*/ +.propname {display:table-cell; font-weight:bold;background-color:#cccccc;border: 1px dotted grey; padding-left:0.3em; padding-right:0.3em} /*width:15em */ +.examplesacademic .propname {background-color:#f0f0f0; border: 0; } +.propval {display:table-cell; background-color:#dddddd;border: 1px dotted grey; padding-left: 0.3em; padding-right: 0.3em;} /*width:15em;*/ +.propval span {white-space: pre;} /*Dont want white-space in e.g. img*/ +.proplinks {padding-left: 0.5em;} /*List of sub-objects inside propval*/ +.propobj {border-color: black; border-top: 2px solid; padding-bottom:0.3em; padding-top:0.3em; } +.classname {font-weight: bold;} /* Used for class name in objbrowser */ +.propurls {display: table; padding: 0px;} /* Ignore ul padding default which is large */ +.propurl {display: table-row} /* propurl inside propurls */ +/* + Styles for appearing/disappearing parts based on hover or active + hoveronly appear only when they are active, hoverclue only when not active + the :active :hover :focus are to ensure it works on mobile devices as well +*/ +.container form.hoveronly, .container div.hoveronly, .container span.hoveronly,.container i.hoveronly{display: none} +.container:active span.hoveronly,.container:active span.hoveronly,.container:hover span.hoveronly{display: inline} +.container:active i.hoveronly,.container:focus i.hoveronly,.container:hover i.hoveronly{display: inline-block} +.container:active form.hoveronly,.container:focus form.hoveronly,.container:hover form.hoveronly{display: block} +.container:active div.hoveronly,.container:focus div.hoveronly,.container:hover div.hoveronly{display: block} +.container span.hoverclue{display: inline}/* Text in headline to disappear when main part open*/ +.container:active .hoverclue,.container:focus .hoverclue,.container:hover .hoverclue{display: none} + +/* + Some specific styles used by difference examples + */ +.floatright {margin: 0 0 3px 10px; float: right; clear: right; text-align: right} /* Grouped in top right corner */ +.examplesarchive .floatright { position: fixed; z-index: 999999; top: 100px; right: 10px; font-size: 50% } +.examplesarchive .floatright ul {display: grid; grid-template-columns: repeat(auto-fit, minmax(7em, 1fr)); grid-auto-flow: dense;} +.floatleft {margin: 0 0 3px 10px; clear: left; float: left; text-align: left} /* Grouped in top left corner */ +.floatright li {margin: 0 0 3px 10px; } +.floatright ul {margin: 0 0 3px 10px; } +.examplesarchive .floatright ul { width: 150px;} /* Wide enogh for two indicators */ +.examplesarchive .floatright li { padding-top: 1px; margin: 0 0 3px 3px;} /* Wide enogh for two indicators */ +.vertical_li {display: table-row; padding-top: 3px; padding-right: 0; margin: 0 0 3px 3px;} +.said {display: block; border-bottom: 1px black solid;} /* Each item added to list in example_list */ +.button { border: 1px black solid; background-color:#dddddd; padding-bottom:0.1em; display:inline;} /* Buttons */ +.displayedblock {border: 1px #e0e0e0 solid; background-color:#f0f0f0; box-shadow: 1px 1px 2px #cccccc; padding-top:0.1em; padding-bottom: 0.1em; margin-top: 10px; margin-bottom: 5px; display:inline-block;} +.displayedblockheader {background-color:#e0e0e0; padding-top:0.1em; padding-bottom: 0.1em; margin-top: 3px; margin-bottom: 3px;} +.dialogform .propval {white-space: pre; display:block; background-color:#dddddd;border: 1px dotted grey; padding-left: 0.3em; padding-top: 0.3em; padding-bottom: 0.1em; margin-top: 0.5em; margin-left: 0.5em; margin-right: 0.5em; margin-bottom: 0.5em; } +.dialogform .button { border: 1px black solid; background-color:#dddddd; padding-bottom: 0.1em; padding-right: 0.3em; padding-left: 0.3em; margin-top: 0.5em; margin-left: 0.5em; margin-right: 0.5em; margin-bottom: 0.5em;} +.iconopener {width:20px;} +.inline_li {display:inline-grid; padding-left: 1em; padding-right: 1em;} /*A single login in a list of KeyChains or Keys */ +.inline_ul {display:inline; -webkit-padding-start: 0;} /*A List of KeyChains or Keys*/ +.keylist_icon {height: 12px; margin-left: 12px; margin-right: 3px;} +.inline {display:inline;} +.hidden {display:none} +.overdiv {position: absolute; top: 1em; left: 1em; z-index:10; background-color: #f0f0ff; border: 1px #e0e0e0 solid; padding: 5px; } /* Dialogue box over other*/ +.template {display: none} +.tooltip { position: relative; display: inline-block; } /*border-bottom: 1px dotted black; */ +.tooltip .tooltiptext { visibility: hidden; z-index: 1; opacity: 0; transition: opacity 1s; + width: 250px; background-color: #555; color: #fff; text-align: center; border-radius: 6px; padding: 5px 0; + position: absolute; bottom: 125%; left: 50%; margin-left: -125px; } +.tooltip .tooltiptext::after { content: ""; position: absolute; top: 100%; left: 50%; + margin-left: -5px; border-width: 5px; border-style: solid; border-color: #555 transparent transparent transparent; } +.tooltip:hover .tooltiptext { visibility: visible; opacity: 1; } +.propval .tooltiptext {white-space: normal} + +/* + Academic playing around without effecting others + */ +.examplesacademic .fileslist { text-align: center;} +.academic_demo_img {display:table-cell; margin-right:10px;} +.academic_demo_link {display: table-cell;} +.academic_demo_a {display:table-row; text-align: left;} +.academic_demo_meta {background-color:#f0f0f0; border: 0; vertical-align: middle; display:block; text-align:left; margin-bottom:10px; } +.academic_demo_file {margin-bottom: 20px;} +.examplesacademic #searchresults [name=title] {font-weight: bold;} +.examplesacademic #metadataresults [name=doi_org_metadata_title] {font-weight: bold;} +.examplesacademic #searchresults li {text-align: left; margin-bottom: 10px;} +.examplesacademic #searchresults span {display: inline-block;}/*Try and keep each part together*/ + +.exampleskeys .inline_ul {display: grid; grid-template-columns: repeat(auto-fit, minmax(7em, 1fr)); grid-auto-flow: dense;} + +.examples #vl_target {display: block;} +.examples #loginform {position: absolute; top: 0.5em; right: 1em; z-index:5; background-color: #f0f0ff; border: 1px #e0e0e0 solid; padding: 5px; } +.examples #registrationform {position: absolute; top: 1em; right: 1.5em; z-index:10; background-color: #f0f0ff; border: 1px #e0e0e0 solid; padding: 5px; }/* z > loginform*/ +.examples #keychain {position: absolute; top: 0.5em; right: 1em; z-index:5; background-color: #f0f0ff; border: 1px #e0e0e0 solid; padding: 5px; width: 450px;} +.examples #keynew_form {position: absolute; top: 1em; right: 1.5em; z-index:7; background-color: #f0f0ff; border: 1px #e0e0e0 solid; padding: 5px; width: 450px;}/*z > keychain*/ +.examples #locknew_form {position: absolute; top: 1em; right: 1.5em; z-index:7; background-color: #f0f0ff; border: 1px #e0e0e0 solid; padding: 5px; width: 450px;}/*z > keychain*/ +.examples #lock_div {position: absolute; top: 0.5em; right: 1em; z-index:7; background-color: #f0f0ff; border: 1px #e0e0e0 solid; padding: 5px; width: 450px;}/*z > keychain*/ +.examples #tokennew_form {position: absolute; top: 0.5em; right: 1em; z-index:10; background-color: #f0f0ff; border: 1px #e0e0e0 solid; padding: 5px; width: 450px; text-align:left;}/*z > lock_div*/ + +.transportstatus0 {color: lawngreen} +.transportstatus1 {color: red} +.transportstatus2 {color: yellow} +.transportstatus3 {color: black} +.transportstatus4 {color: purple} diff --git a/htmlutils.js b/htmlutils.js new file mode 100644 index 0000000..b43c433 --- /dev/null +++ b/htmlutils.js @@ -0,0 +1,292 @@ +/* + This file is a set of utility functions used in the manipulation of HTML pages + There is nothing specific to Dweb at all here, feel free to copy and modify. + */ + + +function urlsFrom(url) { + /* Convert to urls, + url: Array of urls, or string representing url or representing array of urls + return: Array of strings representing url + */ + if (typeof(url) === "string") { + if (url[0] === '[') + url = JSON.parse(url); + else if (url.includes(',')) + url = url.split(','); + else + url = [ url ]; + } + if (!Array.isArray(url)) throw new Error(`Unparsable url: ${url}`); + return url; +} + +function elementFrom(el) { + /* Make sure we have an element, if passed a string then find the element with that id. + el: Element or string being the id of an element. + returns: element. + */ + return (typeof(el) === "string") ? document.getElementById(el) : el; +} +async function p_resolveobj(url) { + /* + Asynchronously find an object + url: An object, or a url representing an object, or an array of urls. + returns: Object + throws: Error if can't resolve object + */ + try { + if (typeof url === 'string') + url = [ url ]; + if (Array.isArray(url)) + url = await Dweb.SmartDict.p_fetch(url, verbose); + return url; + } catch(err) { + console.log("p_resolveobj: Cannot resolve",url); + throw err; + } +} + +function form2dict(frm) { + /* Convert a form into a dictionary + its mindblowing that Javascript even at EC6 doesnt have this ! + */ + let res = {}; + /* Find the element if we are given a string */ + /* Note this is not the usual getElementById since forms have their own array */ + let el_form = (typeof frm === "string") ? document.forms.namedItem(frm) : frm; + for (let el of el_form.elements) { + if (el.type !== "submit") { + res[el.name] = el.value; + } + } + return res; +} + +function togglevis(el, displayvis) { + /* + Toggle the visibility of an item + el element, its id, or an array of elements + displayvis is one of "inline" "block" "inlineblock" + */ + if (Array.isArray(el)) { + el.map((e) => togglevis(e, displayvis)) + } else { + el = elementFrom(el); + el.style.display = (el.style && el.style.display === "none" ? displayvis : "none"); + } +} + +function setstatus(msg) { + // Display the message in a Status DIV (usually top right corner, but could be anywhere example wants it) + document.getElementById("status").innerHTML=msg; +} + +function deletechildren(el, keeptemplate) { + /* + Remove all children from a node + :param el: An HTML element, or a string with id of an HTML element + */ + if (typeof keeptemplate === "undefined") keeptemplate=true; + el = (typeof(el) === "string") ? document.getElementById(el) : el; + // Carefull - this deletes from the end, because template if it exists will be firstChild + while (el.lastChild && !(keeptemplate && el.lastChild.classList && el.lastChild.classList.contains("template"))) { + // Note that deletechildren is also used on Span's to remove the children before replacing with text. + el.removeChild(el.lastChild); + } + return el; // For chaining +} + +function replacetext(el, text) { + /* Replace the text of el with text, removing all other children + :param el: An HTML element, or a string with id of an HTML element + */ + el = elementFrom(el); + //console.log("replacetext",text,el.constructor.name) // Uncomment to get class name of different things want to edit + if (el instanceof HTMLImageElement) { + el.src = text; + } else { + deletechildren(el); + return el.appendChild(document.createTextNode(text)) + } +} + +function replacetexts(el, ...dict) { + /* + Replace the text of all inner nodes of el from the dict + Note this intentionally doesnt allow html as the values of the dict since probably from a network call and could be faked as "bad" html + + Rules apply to el or any children. + Adds an inner text node with oo.yyy + Replaces with ooo.aaa.bbb + Replaces with ooo.aaa.bbb + Has y replecated withe each of ooo.aaa[] + Has value replaced with ooo.ccc (typically used for