commit f01781a4bdc450169611f4d48d2d0f52833e6ceb equwal <truex@equwal.com> 2026-09-21 04:04:10 -0700 sbm add-on for Firefox and Chrome The popup searches the sbm bookmarks as you type, with the fuzzy match of fzf. Enter opens the first match; other text opens as an address or a web search, as in bm. "Add this page" adds the current page. In the address bar, "bm" and words give suggestions. The bookmarks are an sbm file in storage.local. After a sign-in, the background syncs the file with an sbm-sync server: at start, when the popup opens, after an add and every 30 minutes. One manifest works in both browsers. Firefox asks for consent to send data at sign-in. The file format and the search have property tests (fast-check).
.gitattributes | 2 + .github/FUNDING.yml | 1 + .gitignore | 2 + LICENSE | 662 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 54 +++++ background.js | 154 ++++++++++++ icons/128.png | Bin 0 -> 1450 bytes icons/16.png | Bin 0 -> 281 bytes icons/32.png | Bin 0 -> 436 bytes icons/48.png | Bin 0 -> 570 bytes icons/make-icons.ps1 | 37 +++ lib/fuzzy.js | 57 +++++ lib/tsv.js | 93 ++++++++ manifest.json | 76 ++++++ options.html | 44 ++++ options.js | 100 ++++++++ package-lock.json | 54 +++++ package.json | 14 ++ popup.html | 30 +++ popup.js | 129 ++++++++++ style.css | 22 ++ test/fuzzy.test.js | 58 +++++ test/tsv.test.js | 76 ++++++ web-ext-config.mjs | 13 + 24 files changed, 1678 insertions(+)
diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..d0d6371 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +* text=auto eol=lf +*.png binary diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..d303709 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +ko_fi: truex diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..70a1f6a --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules/ +web-ext-artifacts/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..fe6b903 --- /dev/null +++ b/LICENSE @@ -0,0 +1,662 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <https://www.gnu.org/licenses/>. + +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 +<https://www.gnu.org/licenses/>. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..8561830 --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +# sbm for Firefox and Chrome + +Your [sbm](https://github.com/equwal/sbm) bookmarks in the browser. + +- **Search as you type** in the popup (Alt+Shift+B), with the fuzzy match of + fzf. Enter opens the first match. Text that is no bookmark opens as an + address, or as a web search, as in bm. +- **Address bar:** type `bm`, a space, then words. +- **Add this page** with a description and tags. +- **Sync** with bm on your computers, the + [sbm app for Android](https://github.com/equwal/sbm-android) and your other + browsers, through an [sbm-sync](https://github.com/equwal/sbm-sync) server. + +Without an account, the bookmarks stay in the browser. With an account, the +add-on syncs when it starts, when you open the popup, after you add a +bookmark, and every 30 minutes. + +The bookmarks are an sbm file: one bookmark per line, +`URL<tab>description<tab>tags`. + +## Sync + +The add-on uses https://sbm.subread.space unless you give another server in +the options. Create an account there: it is free for 30 days, then $3 a month +or $30 a year. Or [run your own server](https://github.com/equwal/sbm-sync): +it is free software. + +## Permissions + +- `storage`: keep the bookmarks and the sign-in token. +- `activeTab`: read the address and the title of the page when you click + "Add this page". +- `alarms`: sync every 30 minutes. +- Access to sbm.subread.space, or to the server that you choose: sync. + +Firefox also asks you, at sign-in, to let the add-on send your bookmarks, +your email address and your password to the server. The +[privacy policy](https://sbm.subread.space/privacy) tells what the server +keeps. + +## Develop + +The add-on needs no build: load this directory as an unpacked extension +(Chrome: chrome://extensions, developer mode; Firefox: about:debugging). + + npm install + npm test # property tests of the file format and the search + npm run lint # the checks of addons.mozilla.org + npm run build # the zip for the stores, in web-ext-artifacts/ + +## License + +AGPL-3.0. If sbm is useful to you, you can support it on +[Ko-fi](https://ko-fi.com/truex). diff --git a/background.js b/background.js new file mode 100644 index 0000000..26a6eaf --- /dev/null +++ b/background.js @@ -0,0 +1,154 @@ +// The background of the add-on. It owns the bookmark file, which it keeps in +// storage.local as the text of an sbm file, and it syncs that file with an +// sbm-sync server (https://github.com/equwal/sbm-sync). The popup and the +// options page ask it through messages, so all changes happen here, one at a +// time. +"use strict"; + +// Chrome runs this file as a service worker; Firefox loads the libraries +// through the manifest. +if (typeof importScripts === "function") importScripts("lib/tsv.js", "lib/fuzzy.js"); + +const api = globalThis.browser ?? globalThis.chrome; +const DEFAULT_SERVER = "https://sbm.subread.space"; +const SYNC_MINUTES = 30; + +// One change at a time: each job starts when the one before it ends. +let queue = Promise.resolve(); +function serial(job) { + const run = queue.then(job); + queue = run.catch(() => {}); + return run; +} + +async function state() { + const s = await api.storage.local.get(["text", "version", "server", "token", "email", "synced", "error"]); + return { text: "", version: "", server: DEFAULT_SERVER, ...s }; +} + +/** + * Send the file with the name of the version that the server gave last + * time. The server merges, and the merged file comes back. + */ +async function syncNow() { + const s = await state(); + if (!s.token) return s; + let r; + try { + r = await fetch(s.server + "/api/sync?base=" + encodeURIComponent(s.version), { + method: "POST", + headers: { Authorization: "Bearer " + s.token, "Content-Type": "text/plain; charset=utf-8" }, + body: s.text, + }); + } catch (e) { + await api.storage.local.set({ error: "Cannot reach " + new URL(s.server).host + "." }); + return state(); + } + const body = await r.text(); + if (r.status === 401) { + await api.storage.local.remove(["token", "version"]); + await api.storage.local.set({ error: "Sign in again: see the options." }); + } else if (!r.ok) { + await api.storage.local.set({ error: body.trim() || "The server answered " + r.status + "." }); + } else { + const version = r.headers.get("Sbm-Version"); + if (!version) throw new Error("The server gave no version."); + await api.storage.local.set({ text: body, version, synced: Date.now(), error: "" }); + } + return state(); +} + +async function signIn(server, email, password) { + server = server.trim().replace(/\/+$/, ""); + if (!server.includes("://")) server = "https://" + server; + const r = await fetch(server + "/api/login", { + method: "POST", + headers: { "Content-Type": "application/x-www-form-urlencoded" }, + body: new URLSearchParams({ email: email.trim(), password }), + }); + const body = await r.text(); + if (r.status === 401) throw new Error("Wrong email or password."); + if (!r.ok) throw new Error(body.trim() || "The server answered " + r.status + "."); + // A new account starts from no version: the first sync is a union. + await api.storage.local.set({ server, email: email.trim(), token: body.trim(), version: "", error: "" }); + return syncNow(); +} + +async function signOut() { + const s = await state(); + await api.storage.local.remove(["token", "version", "synced", "error"]); + if (s.token) { + fetch(s.server + "/api/logout", { method: "POST", headers: { Authorization: "Bearer " + s.token } }) + .catch(() => {}); // the token stays valid on the server; nothing else is lost + } + return state(); +} + +/** Add a bookmark at the end of the file. With the same page there already, return that bookmark. */ +async function add(b) { + const s = await state(); + const existing = Tsv.find(Tsv.parse(s.text), b.url); + if (existing) return { existing }; + await api.storage.local.set({ text: s.text + Tsv.appendix(s.text, Tsv.format(b)) }); + if (s.token) await syncNow(); + return { added: true }; +} + +api.runtime.onMessage.addListener((msg, sender, reply) => { + const jobs = { + sync: () => syncNow(), + signIn: () => signIn(msg.server, msg.email, msg.password), + signOut: () => signOut(), + add: () => add(msg.bookmark), + }; + const job = jobs[msg.type]; + if (!job) return false; + serial(job).then( + (value) => reply({ value }), + (e) => reply({ error: e.message }), + ); + return true; // reply comes later +}); + +// ---- the address bar: type "bm", a space, then words ---- + +function escapeXml(s) { + return s.replace(/[&<>"']/g, (c) => ({ "&": "&", "<": "<", ">": ">", '"': """, "'": "'" })[c]); +} + +async function matches(text) { + const all = Tsv.parse((await state()).text).reverse(); // newest first + return Fuzzy.filter(all, text, (b) => b.desc + " " + b.tags.join(" ") + " " + b.url); +} + +api.omnibox.setDefaultSuggestion({ description: "Search your sbm bookmarks" }); + +api.omnibox.onInputChanged.addListener(async (text, suggest) => { + // Chrome shows the description as XML; Firefox shows it as text. + const xml = typeof browser === "undefined"; + suggest((await matches(text)).slice(0, 6).map((b) => { + const d = (b.desc || b.url) + " - " + b.url; + return { content: b.url, description: xml ? escapeXml(d) : d }; + })); +}); + +api.omnibox.onInputEntered.addListener(async (text, disposition) => { + // A picked suggestion gives its URL; typed text opens the best match, or + // else an address or a web search, as in bm. + const best = (await matches(text))[0]; + const known = Tsv.find(Tsv.parse((await state()).text), text); + const url = known ? known.url : best ? best.url : Tsv.target(text); + if (disposition === "currentTab") api.tabs.update({ url }); + else api.tabs.create({ url, active: disposition === "newForegroundTab" }); +}); + +// ---- sync on start and every half hour ---- + +api.runtime.onStartup.addListener(() => serial(syncNow)); +api.runtime.onInstalled.addListener(() => { + api.alarms.create("sync", { periodInMinutes: SYNC_MINUTES }); + serial(syncNow); +}); +api.alarms.onAlarm.addListener((a) => { + if (a.name === "sync") serial(syncNow); +}); diff --git a/icons/128.png b/icons/128.png new file mode 100644 index 0000000..54c19cb Binary files /dev/null and b/icons/128.png differ diff --git a/icons/16.png b/icons/16.png new file mode 100644 index 0000000..a8a5d3e Binary files /dev/null and b/icons/16.png differ diff --git a/icons/32.png b/icons/32.png new file mode 100644 index 0000000..fcb5244 Binary files /dev/null and b/icons/32.png differ diff --git a/icons/48.png b/icons/48.png new file mode 100644 index 0000000..c67a801 Binary files /dev/null and b/icons/48.png differ diff --git a/icons/make-icons.ps1 b/icons/make-icons.ps1 new file mode 100644 index 0000000..abe6133 --- /dev/null +++ b/icons/make-icons.ps1 @@ -0,0 +1,37 @@ +# Draws the sbm icon (a white ribbon on #005577) as PNG files. +# Usage: powershell -File make-icons.ps1 -Out <dir> -Sizes 16,32,48,128 +param([string]$Out, [string]$Sizes) +Add-Type -AssemblyName System.Drawing + +foreach ($size in ($Sizes -split "," | ForEach-Object { [int]$_ })) { + $bmp = New-Object System.Drawing.Bitmap $size, $size + $g = [System.Drawing.Graphics]::FromImage($bmp) + $g.SmoothingMode = [System.Drawing.Drawing2D.SmoothingMode]::AntiAlias + $g.Clear([System.Drawing.Color]::Transparent) + + # A square with round corners. + $r = [single]($size * 0.18) + $d = 2 * $r + $e = [single]($size - 1) + $path = New-Object System.Drawing.Drawing2D.GraphicsPath + $path.AddArc(0, 0, $d, $d, 180, 90) + $path.AddArc($e - $d, 0, $d, $d, 270, 90) + $path.AddArc($e - $d, $e - $d, $d, $d, 0, 90) + $path.AddArc(0, $e - $d, $d, $d, 90, 90) + $path.CloseFigure() + $blue = New-Object System.Drawing.SolidBrush ([System.Drawing.Color]::FromArgb(255, 0, 0x55, 0x77)) + $g.FillPath($blue, $path) + + # The ribbon of the Android icon: M40,30 L68,30 L68,80 L54,69 L40,80 Z, + # centred, 62 percent of the icon high. + $s = $size * 0.62 / 50 + $c = $size / 2 + $pts = @(@(-14, -25), @(14, -25), @(14, 25), @(0, 14), @(-14, 25)) | ForEach-Object { + New-Object System.Drawing.PointF ([single]($c + $_[0] * $s)), ([single]($c + $_[1] * $s)) + } + $g.FillPolygon([System.Drawing.Brushes]::White, [System.Drawing.PointF[]]$pts) + + $bmp.Save((Join-Path $Out "$size.png"), [System.Drawing.Imaging.ImageFormat]::Png) + $g.Dispose() + $bmp.Dispose() +} diff --git a/lib/fuzzy.js b/lib/fuzzy.js new file mode 100644 index 0000000..4ce25f8 --- /dev/null +++ b/lib/fuzzy.js @@ -0,0 +1,57 @@ +// Search as in fzf. Each word of the query must occur in the text, with its +// letters in order but not always together. Case does not matter. +"use strict"; + +const Fuzzy = (() => { + const letterOrDigit = /[\p{L}\p{N}]/u; + + function startsWord(hay, i) { + return i === 0 || !letterOrDigit.test(hay[i - 1]); + } + + function scoreWord(word, hay) { + // The whole word in one place scores highest, most at the start of a word. + const at = hay.indexOf(word); + if (at >= 0) return 100 + word.length + (startsWord(hay, at) ? 20 : 0); + let score = 0; + let previous = -2; + let from = 0; + for (const c of word) { + const i = hay.indexOf(c, from); + if (i < 0) return null; + score += 1; + if (i === previous + 1) score += 5; + if (startsWord(hay, i)) score += 3; + previous = i; + from = i + c.length; + } + return score; + } + + return { + /** The score of query in text, or null when a word does not occur. Higher is better. */ + score(query, text) { + const hay = text.toLowerCase(); + let total = 0; + for (const word of query.toLowerCase().split(/[ \t]/)) { + if (word === "") continue; + const s = scoreWord(word, hay); + if (s === null) return null; + total += s; + } + return total; + }, + + /** The items that match query, best first. Items with the same score keep their order. */ + filter(items, query, text) { + if (query.trim() === "") return items; + return items + .map((item, i) => ({ item, i, s: Fuzzy.score(query, text(item)) })) + .filter((x) => x.s !== null) + .sort((a, b) => b.s - a.s || a.i - b.i) + .map((x) => x.item); + }, + }; +})(); + +if (typeof module !== "undefined") module.exports = Fuzzy; diff --git a/lib/tsv.js b/lib/tsv.js new file mode 100644 index 0000000..2567d6b --- /dev/null +++ b/lib/tsv.js @@ -0,0 +1,93 @@ +// The bookmark file of sbm, as bm reads and writes it: one bookmark per line, +// +// URL<tab>description<tab>tag tag tag +// +// Blank lines and lines that start with # are not bookmarks. This file has no +// browser code, so the tests run in node. +"use strict"; + +const Tsv = (() => { + const scheme = /^[A-Za-z][A-Za-z0-9+.-]*:\/\//; + + function parseLine(line) { + const fields = line.split("\t"); + if (fields.length === 1) { + // A line of the old format: "URL description | tags". bm-migrate + // converts it. Until then the first word is the URL. + const words = line.trim().split(/\s+/); + return { url: words[0], desc: words.slice(1).join(" "), tags: [] }; + } + const url = fields[0].trim(); + if (url === "") return null; + const tags = (fields[2] || "").split(" ").filter((t) => t !== ""); + return { url, desc: fields[1], tags }; + } + + return { + /** The bookmarks in the text of a file. */ + parse(text) { + const out = []; + for (const raw of text.split("\n")) { + const line = raw.endsWith("\r") ? raw.slice(0, -1) : raw; + if (line.trim() === "" || line.startsWith("#")) continue; + const b = parseLine(line); + if (b) out.push(b); + } + return out; + }, + + /** Text for one field: tabs and line breaks become spaces. */ + clean(text) { + return text.replace(/[\t\r\n]/g, " "); + }, + + /** The line of a bookmark, without the newline. */ + format(b) { + const tags = b.tags.flatMap((t) => t.split(/\s+/)).filter((t) => t !== ""); + return b.url.replace(/\s/g, "") + "\t" + Tsv.clean(b.desc) + "\t" + tags.join(" "); + }, + + /** + * The same page for bm: two URLs match when they differ only in the + * scheme, a leading www., trailing slashes or the case of the host. + */ + norm(url) { + const u = url.replace(scheme, ""); + const slash = u.indexOf("/"); + const host = (slash >= 0 ? u.slice(0, slash) : u).toLowerCase().replace(/^www\./, ""); + const rest = slash >= 0 ? u.slice(slash).replace(/\/+$/, "") : ""; + return host + rest; + }, + + /** The bookmark for the same page as url, or undefined. */ + find(bookmarks, url) { + const n = Tsv.norm(url); + return bookmarks.find((b) => Tsv.norm(b.url) === n); + }, + + /** The text to add to a file that holds text, so that line is a line of its own. */ + appendix(text, line) { + return text === "" || text.endsWith("\n") ? line + "\n" : "\n" + line + "\n"; + }, + + /** The host of a URL, for display. */ + host(url) { + return url.replace(scheme, "").split(/[/?#]/)[0]; + }, + + /** + * Where text that is no bookmark goes, as in bm: one word with "://" or + * a dot is an address. Other text is a web search. + */ + target(text) { + const t = text.trim(); + if (!t.includes(" ")) { + if (t.includes("://")) return t; + if (t.includes(".")) return "https://" + t; + } + return "https://duckduckgo.com/?q=" + encodeURIComponent(t).replace(/%20/g, "+"); + }, + }; +})(); + +if (typeof module !== "undefined") module.exports = Tsv; diff --git a/manifest.json b/manifest.json new file mode 100644 index 0000000..8f5ff4e --- /dev/null +++ b/manifest.json @@ -0,0 +1,76 @@ +{ + "manifest_version": 3, + "name": "sbm bookmarks", + "short_name": "sbm", + "version": "0.1.0", + "description": "Your sbm bookmarks in the browser: search as you type, add the page, sync with bm and the sbm app.", + "homepage_url": "https://github.com/equwal/sbm-extension", + "icons": { + "16": "icons/16.png", + "32": "icons/32.png", + "48": "icons/48.png", + "128": "icons/128.png" + }, + "action": { + "default_title": "sbm bookmarks", + "default_popup": "popup.html", + "default_icon": { + "16": "icons/16.png", + "32": "icons/32.png" + } + }, + "commands": { + "_execute_action": { + "suggested_key": { + "default": "Alt+Shift+B" + }, + "description": "Open sbm" + } + }, + "omnibox": { + "keyword": "bm" + }, + "options_ui": { + "page": "options.html", + "open_in_tab": true + }, + "background": { + "service_worker": "background.js", + "scripts": [ + "lib/tsv.js", + "lib/fuzzy.js", + "background.js" + ] + }, + "permissions": [ + "storage", + "activeTab", + "alarms" + ], + "host_permissions": [ + "https://sbm.subread.space/*" + ], + "optional_host_permissions": [ + "https://*/*", + "http://*/*" + ], + "browser_specific_settings": { + "gecko": { + "id": "sbm@equwal.com", + "strict_min_version": "140.0", + "data_collection_permissions": { + "required": [ + "none" + ], + "optional": [ + "bookmarksInfo", + "personallyIdentifyingInfo", + "authenticationInfo" + ] + } + }, + "gecko_android": { + "strict_min_version": "142.0" + } + } +} diff --git a/options.html b/options.html new file mode 100644 index 0000000..3f61bce --- /dev/null +++ b/options.html @@ -0,0 +1,44 @@ +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<link rel="stylesheet" href="style.css"> +<title>sbm options</title> +</head> +<body class="options"> +<h1>sbm</h1> +<p>sbm keeps your bookmarks as an sbm bookmark file in this browser. Sign in +to sync the file with bm on your computers, the sbm app for Android and your +other browsers.</p> + +<section id="signed-out"> + <h2>Sign in to sync</h2> + <form id="sign-in"> + <label>Sync server <input id="server" type="url" required></label> + <label>Email <input id="email" type="email" required autocomplete="email"></label> + <label>Password <input id="password" type="password" required autocomplete="current-password"></label> + <button>Sign in</button> + </form> + <p class="note">No account? <a id="signup" href="https://sbm.subread.space/signup" target="_blank" rel="noopener">Create one</a> + on the website of the server. The add-on sends your bookmarks only to this server, and only after you sign in.</p> +</section> + +<section id="signed-in" hidden> + <h2>Sync</h2> + <p id="who"></p> + <button id="sync" type="button">Sync now</button> + <button id="sign-out" type="button">Sign out</button> + <p class="note"><a id="account" href="https://sbm.subread.space/account" target="_blank" rel="noopener">Your account</a></p> +</section> + +<p id="message" role="status"></p> + +<footer> + <a href="https://github.com/equwal/sbm-extension" target="_blank" rel="noopener">Source code</a> · + <a href="https://sbm.subread.space/privacy" target="_blank" rel="noopener">Privacy</a> · + <a href="https://ko-fi.com/truex" target="_blank" rel="noopener">Support sbm on Ko-fi</a> +</footer> +<script src="lib/tsv.js"></script> +<script src="options.js"></script> +</body> +</html> diff --git a/options.js b/options.js new file mode 100644 index 0000000..b378e68 --- /dev/null +++ b/options.js @@ -0,0 +1,100 @@ +// The options page: sign in to a sync server, sync now, sign out. +"use strict"; + +const api = globalThis.browser ?? globalThis.chrome; +const $ = (id) => document.getElementById(id); +const DEFAULT_SERVER = "https://sbm.subread.space"; + +// The data that the add-on sends to the server after a sign-in. Firefox 140 +// and later ask the user for it; other browsers have no such question. +const DATA = ["bookmarksInfo", "personallyIdentifyingInfo", "authenticationInfo"]; +let askData = false; +api.permissions.getAll().then((p) => { + askData = !!p.data_collection; +}); + +function send(msg) { + return api.runtime.sendMessage(msg).then((r) => { + if (r && r.error) throw new Error(r.error); + return r && r.value; + }); +} + +function say(text) { + $("message").textContent = text; +} + +function origin(server) { + const s = server.trim().replace(/\/+$/, ""); + return new URL(s.includes("://") ? s : "https://" + s).origin; +} + +async function show() { + const s = await api.storage.local.get(["server", "email", "token", "synced", "error", "text"]); + const server = s.server || DEFAULT_SERVER; + $("signed-out").hidden = !!s.token; + $("signed-in").hidden = !s.token; + if (!$("server").value) $("server").value = server; + if (!$("email").value) $("email").value = s.email || ""; + $("signup").href = origin($("server").value || server) + "/signup"; + $("account").href = server + "/account"; + const n = Tsv.parse(s.text || "").length; + $("who").textContent = "Signed in to " + server + " as " + s.email + ". " + n + " bookmarks" + + (s.synced ? ", synced " + new Date(s.synced).toLocaleString() : "") + "."; + if (s.error) say("Sync: " + s.error); +} + +$("server").addEventListener("input", () => { + try { + $("signup").href = origin($("server").value) + "/signup"; + } catch (e) { + // not an address yet + } +}); + +$("sign-in").addEventListener("submit", async (e) => { + e.preventDefault(); + let want; + try { + want = { origins: [origin($("server").value) + "/*"] }; + } catch (err) { + say("The sync server is not an address."); + return; + } + if (askData) want.data_collection = DATA; + // The browser asks the user. The request must come before any await: only + // then does the browser see it as part of the click. + const granted = api.permissions.request(want); + say("Signing in…"); + try { + if (!(await granted)) { + say("Without that permission the add-on cannot sync."); + return; + } + await send({ type: "signIn", server: $("server").value, email: $("email").value, password: $("password").value }); + $("password").value = ""; + say(""); + } catch (err) { + say(err.message); + } + show(); +}); + +$("sync").addEventListener("click", async () => { + say("Syncing…"); + try { + await send({ type: "sync" }); + say(""); + } catch (err) { + say(err.message); + } + show(); +}); + +$("sign-out").addEventListener("click", async () => { + await send({ type: "signOut" }); + say("Signed out. Your bookmarks stay in this browser."); + show(); +}); + +show(); diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..7f3268b --- /dev/null +++ b/package-lock.json @@ -0,0 +1,54 @@ +{ + "name": "sbm-extension", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "sbm-extension", + "license": "AGPL-3.0-only", + "devDependencies": { + "fast-check": "^4.3.0" + } + }, + "node_modules/fast-check": { + "version": "4.10.2", + "resolved": "https://registry.npmjs.org/fast-check/-/fast-check-4.10.2.tgz", + "integrity": "sha512-iK2f+YrcmoeGqk6fA0ea2bptcu/itMIm4NfEozq6N25+aG6h7s5HZbB/k1aV7b5w5sFLMCbbtRUsTVR+BgC3xw==", + "dev": true, + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/dubzzz" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fast-check" + } + ], + "license": "MIT", + "dependencies": { + "pure-rand": "^8.0.0" + }, + "engines": { + "node": ">=12.17.0" + } + }, + "node_modules/pure-rand": { + "version": "8.4.2", + "resolved": "https://registry.npmjs.org/pure-rand/-/pure-rand-8.4.2.tgz", + "integrity": "sha512-vvuOGgcuPJAirlHvuQw1TrOiw7ptaIXXmIbNuiNOY6lNGJJH49PQ1Kj4nd783nPdQhQdicgOjVI2yI/9BD6/Ng==", + "dev": true, + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/dubzzz" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fast-check" + } + ], + "license": "MIT" + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..ff5b4a1 --- /dev/null +++ b/package.json @@ -0,0 +1,14 @@ +{ + "name": "sbm-extension", + "private": true, + "description": "Tests and packaging for the sbm add-on. The add-on itself needs no build.", + "license": "AGPL-3.0-only", + "scripts": { + "test": "node --test test/*.test.js", + "lint": "npx --yes web-ext lint --self-hosted=false", + "build": "npx --yes web-ext build" + }, + "devDependencies": { + "fast-check": "^4.3.0" + } +} diff --git a/popup.html b/popup.html new file mode 100644 index 0000000..1c570a7 --- /dev/null +++ b/popup.html @@ -0,0 +1,30 @@ +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<link rel="stylesheet" href="style.css"> +<title>sbm</title> +</head> +<body class="popup"> +<input id="search" type="search" placeholder="Search, or type an address" autocomplete="off" autofocus> +<ul id="list"></ul> +<p id="empty" hidden></p> + +<form id="add" hidden> + <label>URL <input id="url" required></label> + <label>Description <input id="desc"></label> + <label>Tags, with spaces between them <input id="tags" autocomplete="off"></label> + <p id="known" class="note"></p> + <button id="save">Save</button> <button id="cancel" type="button">Cancel</button> +</form> + +<footer> + <button id="add-page" type="button">Add this page</button> + <span id="status" class="note"></span> + <nav><a href="#" id="options">Options</a> · <a href="https://ko-fi.com/truex" target="_blank" rel="noopener">Support sbm on Ko-fi</a></nav> +</footer> +<script src="lib/tsv.js"></script> +<script src="lib/fuzzy.js"></script> +<script src="popup.js"></script> +</body> +</html> diff --git a/popup.js b/popup.js new file mode 100644 index 0000000..5e27ac5 --- /dev/null +++ b/popup.js @@ -0,0 +1,129 @@ +// The popup: search as you type, Enter or a click opens, "Add this page" adds. +"use strict"; + +const api = globalThis.browser ?? globalThis.chrome; +const $ = (id) => document.getElementById(id); +const MAX_ROWS = 50; +let all = []; // newest first, as bm adds at the end +let shown = []; + +function send(msg) { + return api.runtime.sendMessage(msg).then((r) => { + if (r && r.error) throw new Error(r.error); + return r && r.value; + }); +} + +function ago(ms) { + const min = Math.round((Date.now() - ms) / 60000); + if (min < 1) return "just now"; + if (min < 60) return min + " min ago"; + return Math.round(min / 60) + " h ago"; +} + +function showStatus(s) { + const n = all.length + (all.length === 1 ? " bookmark" : " bookmarks"); + let text = n + " in this browser. Sign in to sync in the options."; + if (s.error) text = n + ". Sync: " + s.error; + else if (s.token) text = n + (s.synced ? ", synced " + ago(s.synced) : "") + "."; + $("status").textContent = text; +} + +function render() { + shown = Fuzzy.filter(all, $("search").value, (b) => b.desc + " " + b.tags.join(" ") + " " + b.url); + const list = $("list"); + list.replaceChildren(); + for (const b of shown.slice(0, MAX_ROWS)) { + const li = document.createElement("li"); + const a = document.createElement("a"); + a.href = b.url; + a.textContent = b.desc || b.url; + const small = document.createElement("small"); + small.textContent = [Tsv.host(b.url), b.tags.join(" ")].filter((x) => x).join(" · "); + a.append(document.createElement("br"), small); + a.addEventListener("click", (e) => { + e.preventDefault(); + open(b.url, e.ctrlKey || e.metaKey || e.button === 1); + }); + li.append(a); + list.append(li); + } + const empty = $("empty"); + empty.hidden = shown.length > 0; + empty.textContent = all.length === 0 ? "No bookmarks yet. Sign in to sync in the options, or add this page." + : "No bookmark matches. Press Enter to search the web."; +} + +async function load() { + const s = await api.storage.local.get(["text", "token", "synced", "error"]); + all = Tsv.parse(s.text || "").reverse(); + render(); + showStatus(s); + return s; +} + +/** Open in this tab, or in a new tab with Ctrl. */ +function open(url, newTab) { + if (newTab) api.tabs.create({ url }); + else api.tabs.update({ url }); + window.close(); +} + +$("search").addEventListener("input", render); +$("search").addEventListener("keydown", (e) => { + if (e.key !== "Enter") return; + const text = $("search").value; + if (shown.length > 0) open(shown[0].url, e.ctrlKey || e.metaKey); + else if (text.trim() !== "") open(Tsv.target(text), e.ctrlKey || e.metaKey); +}); + +$("options").addEventListener("click", (e) => { + e.preventDefault(); + api.runtime.openOptionsPage(); + window.close(); +}); + +$("add-page").addEventListener("click", async () => { + const [tab] = await api.tabs.query({ active: true, currentWindow: true }); + $("url").value = tab && tab.url ? tab.url : ""; + $("desc").value = tab && tab.title ? tab.title : ""; + $("tags").value = ""; + const known = [...new Set(all.flatMap((b) => b.tags))].sort(); + $("known").textContent = known.length ? "Tags in your file: " + known.join(" ") : ""; + $("add").hidden = false; + $("add-page").hidden = true; + $("tags").focus(); +}); + +$("cancel").addEventListener("click", () => { + $("add").hidden = true; + $("add-page").hidden = false; +}); + +$("add").addEventListener("submit", async (e) => { + e.preventDefault(); + const bookmark = { + url: $("url").value.replace(/\s/g, ""), + desc: Tsv.clean($("desc").value).trim(), + tags: $("tags").value.split(/\s+/).filter((t) => t !== ""), + }; + try { + const r = await send({ type: "add", bookmark }); + $("status").textContent = r.existing ? "Already a bookmark: " + (r.existing.desc || r.existing.url) : "Bookmark added."; + $("add").hidden = true; + $("add-page").hidden = false; + await load(); + if (r.existing) $("status").textContent = "Already a bookmark: " + (r.existing.desc || r.existing.url); + } catch (err) { + $("status").textContent = "Cannot add: " + err.message; + } +}); + +api.storage.onChanged.addListener((changes, area) => { + if (area === "local" && (changes.text || changes.synced || changes.error)) load(); +}); + +load().then((s) => { + // Sync when the popup opens, unless a sync ran in the last minute. + if (s.token && (!s.synced || Date.now() - s.synced > 60000)) send({ type: "sync" }).catch(() => {}); +}); diff --git a/style.css b/style.css new file mode 100644 index 0000000..8c02051 --- /dev/null +++ b/style.css @@ -0,0 +1,22 @@ +:root { color-scheme: light dark; --accent: #005577; --muted: #555; --line: #ddd; } +@media (prefers-color-scheme: dark) { :root { --accent: #4fb3d9; --muted: #aaa; --line: #444; } } + +body { font: 14px/1.4 system-ui, sans-serif; margin: 0; } +a { color: var(--accent); } +.note { color: var(--muted); } +input { font: inherit; box-sizing: border-box; width: 100%; padding: 6px; margin: 2px 0 8px; } +button { font: inherit; padding: 4px 12px; } +label { display: block; } + +.popup { width: 380px; padding: 8px; } +.popup #list { list-style: none; margin: 0; padding: 0; max-height: 380px; overflow-y: auto; } +.popup #list a { display: block; padding: 6px 4px; border-bottom: 1px solid var(--line); text-decoration: none; color: inherit; } +.popup #list a:hover, .popup #list a:focus { background: color-mix(in srgb, var(--accent) 15%, transparent); } +.popup #list small { color: var(--muted); } +.popup footer { margin-top: 8px; display: flex; flex-direction: column; gap: 4px; } +.popup nav { font-size: 12px; } + +.options { max-width: 36em; margin: 2em auto; padding: 0 1em; font-size: 15px; } +.options h1 { color: var(--accent); } +.options section { margin: 1.5em 0; } +.options footer { margin-top: 3em; font-size: 13px; color: var(--muted); } diff --git a/test/fuzzy.test.js b/test/fuzzy.test.js new file mode 100644 index 0000000..714ac28 --- /dev/null +++ b/test/fuzzy.test.js @@ -0,0 +1,58 @@ +"use strict"; +const test = require("node:test"); +const assert = require("node:assert/strict"); +const fc = require("fast-check"); +const Fuzzy = require("../lib/fuzzy.js"); + +const text = fc.stringMatching(/^[a-z ]{0,30}$/); + +test("every subsequence of a text matches it", () => { + fc.assert(fc.property(text, fc.array(fc.boolean(), { maxLength: 30 }), (t, keep) => { + const word = [...t.replace(/ /g, "")].filter((_, i) => keep[i]).join(""); + assert.notEqual(Fuzzy.score(word, t), null); + }), { numRuns: 1000 }); +}); + +test("a letter that the text lacks gives no match", () => { + fc.assert(fc.property(text, (t) => { + const missing = [..."abcdefghijklmnopqrstuvwxyz"].find((c) => !t.includes(c)); + if (missing) assert.equal(Fuzzy.score(missing, t), null); + }), { numRuns: 1000 }); +}); + +test("every word of the query must match", () => { + fc.assert(fc.property(text, text, (a, b) => { + const both = Fuzzy.score(a + " " + b, "x"); + if (Fuzzy.score(a, "x") === null || Fuzzy.score(b, "x") === null) assert.equal(both, null); + }), { numRuns: 1000 }); +}); + +test("case does not matter", () => { + fc.assert(fc.property(text, text, (q, t) => { + assert.equal(Fuzzy.score(q.toUpperCase(), t), Fuzzy.score(q, t.toUpperCase())); + }), { numRuns: 1000 }); +}); + +test("filter keeps exactly the items that match", () => { + fc.assert(fc.property(fc.array(text, { maxLength: 20 }), text, (items, q) => { + const got = Fuzzy.filter(items, q, (x) => x); + const want = q.trim() === "" ? items : items.filter((x) => Fuzzy.score(q, x) !== null); + assert.deepEqual([...got].sort(), [...want].sort()); + }), { numRuns: 1000 }); +}); + +test("a blank query keeps the order", () => { + assert.deepEqual(Fuzzy.filter(["b", "a"], " ", (x) => x), ["b", "a"]); +}); + +test("a whole word ranks above scattered letters", () => { + assert.deepEqual(Fuzzy.filter(["d w m x", "dwm"], "dwm", (x) => x), ["dwm", "d w m x"]); +}); + +test("the start of a word ranks above the inside of a word", () => { + assert.deepEqual(Fuzzy.filter(["xwiki", "wiki x"], "wiki", (x) => x), ["wiki x", "xwiki"]); +}); + +test("Japanese text matches", () => { + assert.notEqual(Fuzzy.score("辞書", "Jisho: 日本語の辞書"), null); +}); diff --git a/test/tsv.test.js b/test/tsv.test.js new file mode 100644 index 0000000..4028283 --- /dev/null +++ b/test/tsv.test.js @@ -0,0 +1,76 @@ +"use strict"; +const test = require("node:test"); +const assert = require("node:assert/strict"); +const fc = require("fast-check"); +const Tsv = require("../lib/tsv.js"); + +const url = fc.stringMatching(/^[!-~]{1,40}$/).filter((u) => !u.startsWith("#")); +const desc = fc.string({ maxLength: 40 }).filter((d) => !/[\t\r\n]/.test(d)); +const tag = fc.stringMatching(/^[a-z0-9-]{1,10}$/); +const bookmark = fc.record({ url, desc, tags: fc.array(tag, { maxLength: 5 }) }); + +test("a formatted bookmark parses back to itself", () => { + fc.assert(fc.property(bookmark, (b) => { + // fc.record gives objects without a prototype; parse gives plain objects. + assert.deepEqual(Tsv.parse(Tsv.format(b) + "\n"), [{ ...b }]); + }), { numRuns: 1000 }); +}); + +test("a file of bookmarks parses back to its bookmarks, with LF or CRLF", () => { + fc.assert(fc.property(fc.array(bookmark, { maxLength: 20 }), fc.boolean(), (bs, crlf) => { + const end = crlf ? "\r\n" : "\n"; + const text = bs.map((b) => Tsv.format(b) + end).join(""); + assert.deepEqual(Tsv.parse(text), bs.map((b) => ({ ...b }))); + }), { numRuns: 1000 }); +}); + +test("norm ignores the scheme, www., trailing slashes and the case of the host", () => { + const host = fc.stringMatching(/^[a-z0-9]{1,10}\.(org|com)$/); + const path = fc.stringMatching(/^(\/[A-Za-z0-9]{1,8}){0,3}$/); + fc.assert(fc.property(host, path, fc.constantFrom("http://", "https://", ""), fc.boolean(), fc.nat(3), + (h, p, s, www, slashes) => { + const other = s + (www ? "WWW." : "") + h.toUpperCase() + p + "/".repeat(slashes); + assert.equal(Tsv.norm(other), Tsv.norm("https://" + h + p)); + }), { numRuns: 1000 }); +}); + +test("the case of the path counts", () => { + assert.notEqual(Tsv.norm("https://example.org/A"), Tsv.norm("https://example.org/a")); +}); + +test("comments, blank lines and old lines", () => { + const text = "# notes\n\nhttps://a.example\tA\tcode sec\nhttps://b.example B site | tag\n"; + assert.deepEqual(Tsv.parse(text), [ + { url: "https://a.example", desc: "A", tags: ["code", "sec"] }, + { url: "https://b.example", desc: "B site | tag", tags: [] }, + ]); +}); + +test("format cleans the fields", () => { + const b = { url: " https://a.example/x ", desc: "one\ttwo\nthree", tags: ["a b", "c"] }; + assert.equal(Tsv.format(b), "https://a.example/x\tone two three\ta b c"); +}); + +test("find gives the same page, as bm finds it", () => { + const known = Tsv.parse("https://www.example.com/a/\tA\t\n"); + assert.equal(Tsv.find(known, "http://example.com/a"), known[0]); + assert.equal(Tsv.find(known, "https://example.com/b"), undefined); +}); + +test("appendix puts the line on a line of its own", () => { + assert.equal(Tsv.appendix("", "x"), "x\n"); + assert.equal(Tsv.appendix("a\n", "x"), "x\n"); + assert.equal(Tsv.appendix("a", "x"), "\nx\n"); +}); + +test("target: an address, or a web search, as in bm", () => { + assert.equal(Tsv.target("suckless.org/dwm"), "https://suckless.org/dwm"); + assert.equal(Tsv.target("gopher://x.org"), "gopher://x.org"); + assert.equal(Tsv.target("posix sh printf"), "https://duckduckgo.com/?q=posix+sh+printf"); + assert.equal(Tsv.target("a&b"), "https://duckduckgo.com/?q=a%26b"); +}); + +test("host", () => { + assert.equal(Tsv.host("https://jisho.org/word/x?y#z"), "jisho.org"); + assert.equal(Tsv.host("example.org?q=1"), "example.org"); +}); diff --git a/web-ext-config.mjs b/web-ext-config.mjs new file mode 100644 index 0000000..e7b0ad2 --- /dev/null +++ b/web-ext-config.mjs @@ -0,0 +1,13 @@ +// Settings for web-ext (lint, build): the store package holds the add-on +// only, not its tests and tools. +export default { + ignoreFiles: [ + "test", + "icons/make-icons.ps1", + "package.json", + "package-lock.json", + "store", + "web-ext-config.mjs", + ], + build: { overwriteDest: true }, +};