commit 2c98a3aebb7d9061d7a5d139134aa2cccdb98fb7 Author: husky Date: Fri Mar 7 15:39:45 2025 -0800 public release of asklyphe-common diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3a8cabc --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/target +.idea diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..fb6e69e --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,343 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 3 + +[[package]] +name = "android-tzdata" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e999941b234f3131b00bc13c22d06e8c5ff726d1b6318ac7eb276997bbb4fef0" + +[[package]] +name = "android_system_properties" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "819e7219dbd41043ac279b19830f2efc897156490d7fd6ea916720117ee66311" +dependencies = [ + "libc", +] + +[[package]] +name = "asklyphe-common" +version = "0.1.0" +dependencies = [ + "chrono", +] + +[[package]] +name = "autocfg" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa" + +[[package]] +name = "bumpalo" +version = "3.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f30e7476521f6f8af1a1c4c0b8cc94f0bee37d91763d0ca2665f299b6cd8aec" + +[[package]] +name = "cc" +version = "1.0.83" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1174fb0b6ec23863f8b971027804a42614e347eafb0a95bf0b12cdae21fc4d0" +dependencies = [ + "libc", +] + +[[package]] +name = "cfg-if" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" + +[[package]] +name = "chrono" +version = "0.4.31" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f2c685bad3eb3d45a01354cedb7d5faa66194d1d58ba6e267a8de788f79db38" +dependencies = [ + "android-tzdata", + "iana-time-zone", + "js-sys", + "num-traits", + "wasm-bindgen", + "windows-targets 0.48.5", +] + +[[package]] +name = "core-foundation-sys" +version = "0.8.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "06ea2b9bc92be3c2baa9334a323ebca2d6f074ff852cd1d7b11064035cd3868f" + +[[package]] +name = "iana-time-zone" +version = "0.1.59" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6a67363e2aa4443928ce15e57ebae94fd8949958fd1223c4cfc0cd473ad7539" +dependencies = [ + "android_system_properties", + "core-foundation-sys", + "iana-time-zone-haiku", + "js-sys", + "wasm-bindgen", + "windows-core", +] + +[[package]] +name = "iana-time-zone-haiku" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f31827a206f56af32e590ba56d5d2d085f558508192593743f16b2306495269f" +dependencies = [ + "cc", +] + +[[package]] +name = "js-sys" +version = "0.3.67" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a1d36f1235bc969acba30b7f5990b864423a6068a10f7c90ae8f0112e3a59d1" +dependencies = [ + "wasm-bindgen", +] + +[[package]] +name = "libc" +version = "0.2.152" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "13e3bf6590cbc649f4d1a3eefc9d5d6eb746f5200ffb04e5e142700b8faa56e7" + +[[package]] +name = "log" +version = "0.4.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b5e6163cb8c49088c2c36f57875e58ccd8c87c7427f7fbd50ea6710b2f3f2e8f" + +[[package]] +name = "num-traits" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "39e3200413f237f41ab11ad6d161bc7239c84dcb631773ccd7de3dfe4b5c267c" +dependencies = [ + "autocfg", +] + +[[package]] +name = "once_cell" +version = "1.19.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3fdb12b2476b595f9358c5161aa467c2438859caa136dec86c26fdd2efe17b92" + +[[package]] +name = "proc-macro2" +version = "1.0.76" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "95fc56cda0b5c3325f5fbbd7ff9fda9e02bb00bb3dac51252d2f1bfa1cb8cc8c" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quote" +version = "1.0.35" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "291ec9ab5efd934aaf503a6466c5d5251535d108ee747472c3977cc5acc868ef" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "syn" +version = "2.0.48" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0f3531638e407dfc0814761abb7c00a5b54992b849452a0646b7f65c9f770f3f" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "unicode-ident" +version = "1.0.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b" + +[[package]] +name = "wasm-bindgen" +version = "0.2.90" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1223296a201415c7fad14792dbefaace9bd52b62d33453ade1c5b5f07555406" +dependencies = [ + "cfg-if", + "wasm-bindgen-macro", +] + +[[package]] +name = "wasm-bindgen-backend" +version = "0.2.90" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fcdc935b63408d58a32f8cc9738a0bffd8f05cc7c002086c6ef20b7312ad9dcd" +dependencies = [ + "bumpalo", + "log", + "once_cell", + "proc-macro2", + "quote", + "syn", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-macro" +version = "0.2.90" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3e4c238561b2d428924c49815533a8b9121c664599558a5d9ec51f8a1740a999" +dependencies = [ + "quote", + "wasm-bindgen-macro-support", +] + +[[package]] +name = "wasm-bindgen-macro-support" +version = "0.2.90" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bae1abb6806dc1ad9e560ed242107c0f6c84335f1749dd4e8ddb012ebd5e25a7" +dependencies = [ + "proc-macro2", + "quote", + "syn", + "wasm-bindgen-backend", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-shared" +version = "0.2.90" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4d91413b1c31d7539ba5ef2451af3f0b833a005eb27a631cec32bc0635a8602b" + +[[package]] +name = "windows-core" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "33ab640c8d7e35bf8ba19b884ba838ceb4fba93a4e8c65a9059d08afcfc683d9" +dependencies = [ + "windows-targets 0.52.0", +] + +[[package]] +name = "windows-targets" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c" +dependencies = [ + "windows_aarch64_gnullvm 0.48.5", + "windows_aarch64_msvc 0.48.5", + "windows_i686_gnu 0.48.5", + "windows_i686_msvc 0.48.5", + "windows_x86_64_gnu 0.48.5", + "windows_x86_64_gnullvm 0.48.5", + "windows_x86_64_msvc 0.48.5", +] + +[[package]] +name = "windows-targets" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a18201040b24831fbb9e4eb208f8892e1f50a37feb53cc7ff887feb8f50e7cd" +dependencies = [ + "windows_aarch64_gnullvm 0.52.0", + "windows_aarch64_msvc 0.52.0", + "windows_i686_gnu 0.52.0", + "windows_i686_msvc 0.52.0", + "windows_x86_64_gnu 0.52.0", + "windows_x86_64_gnullvm 0.52.0", + "windows_x86_64_msvc 0.52.0", +] + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8" + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb7764e35d4db8a7921e09562a0304bf2f93e0a51bfccee0bd0bb0b666b015ea" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bbaa0368d4f1d2aaefc55b6fcfee13f41544ddf36801e793edbbfd7d7df075ef" + +[[package]] +name = "windows_i686_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e" + +[[package]] +name = "windows_i686_gnu" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a28637cb1fa3560a16915793afb20081aba2c92ee8af57b4d5f28e4b3e7df313" + +[[package]] +name = "windows_i686_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406" + +[[package]] +name = "windows_i686_msvc" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ffe5e8e31046ce6230cc7215707b816e339ff4d4d67c65dffa206fd0f7aa7b9a" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3d6fa32db2bc4a2f5abeacf2b69f7992cd09dca97498da74a151a3132c26befd" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1a657e1e9d3f514745a572a6846d3c7aa7dbe1658c056ed9c3344c4109a6949e" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dff9641d1cd4be8d1a070daf9e3773c5f67e78b4d9d42263020c057706765c04" diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..b85d0b1 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "asklyphe-common" +version = "0.1.0" +edition = "2021" +license = "AGPL-3" +license-file = "LICENSE" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +tokio = { version = "1.0", features = ["full"] } +chrono = "0.4.31" +serde = { version = "1.0", features = ["derive"] } +foundationdb = { version = "0.8.0", features = ["embedded-fdb-include"] } +log = "0.4.20" +rmp-serde = "1.1.2" +futures = "0.3.30" +async-nats = "0.38.0" +ulid = "1.1.0" +rand = "0.8.5" \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5b06359 --- /dev/null +++ b/LICENSE @@ -0,0 +1,181 @@ +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. + diff --git a/src/db/mod.rs b/src/db/mod.rs new file mode 100644 index 0000000..7b05d7a --- /dev/null +++ b/src/db/mod.rs @@ -0,0 +1,995 @@ +/* + * asklyphe-common db/mod.rs + * - foundationdb functions for accessing crawled websites + * + * Copyright (C) 2025 Real Microsoft, LLC + * + * 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, version 3. + * + * 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 . +*/ + +use std::collections::hash_map::DefaultHasher; +use std::hash::{Hash, Hasher}; +use chrono::{TimeZone}; +use foundationdb::{Database, RangeOption}; +use foundationdb::options::StreamingMode; +use foundationdb::tuple::{pack, Subspace, unpack}; +use log::{error, warn}; +use rand::Rng; +use crate::db::tables::{DEHOMOGENISE_TABLE, HASH_TABLE, HOST_TABLE, LINK_TABLE, LINKWORD_TABLE, METAWORD_TABLE, WEBSITE_TABLE, WORD_TABLE, INFO_TABLE, REVLINK_TABLE, WEBSITE_TABLE_HOST, WEBSITE_TABLE_DAMPING, WEBSITE_TABLE_LASTPARSEBEGIN, WEBSITE_TABLE_LASTPARSEFINISH, WEBSITE_TABLE_LASTPARSEFINISHTRUE, WEBSITE_TABLE_CACHEDPAGERANK, WEBSITE_TABLE_LASTPAGERANKCACHE, WEBSITE_TABLE_ROBOTSFLAG, INFO_TABLE_TITLE, INFO_TABLE_DESC, INFO_TABLE_FAVICON, METAWURL_TABLE, WURL_TABLE, WEBSITE_TABLE_WORDCOUNT, DERANK_TABLE}; + + +pub mod tables; + +pub type STRHASH = i64; + +pub fn hash(val: &str) -> STRHASH { + let mut hasher = DefaultHasher::new(); + val.hash(&mut hasher); + unsafe { std::mem::transmute(hasher.finish()) } +} + +pub struct DerankEntry { + pub urlmatch: String, + pub and: Option, + pub unless: Option, + pub amount: f64, + pub comment: String, +} + +pub async fn remove_deranked_website(db: &Database, id: i64) { + let trx = db.create_trx(); + if let Err(e) = trx { + eprintln!("DATABASE ERROR remove_deranked_website {e}"); + } else { + let trx = trx.unwrap(); + // info -> url + let subspace = Subspace::from(id); + + trx.clear(&subspace.pack(&id)); + + if let Err(e) = trx.commit().await { + eprintln!("DATABASE ERROR remove_deranked_website {e}"); + } + } +} + +pub async fn add_deranked_website(db: &Database, entry: DerankEntry) -> Option { + let trx = db.create_trx(); + if let Err(e) = trx { + eprintln!("DATABASE ERROR add_deranked_website {e}"); + None + } else { + let trx = trx.unwrap(); + let id: i64 = { + let mut r = rand::thread_rng(); + r.gen() + }; + // info -> url + let subspace = Subspace::from(DERANK_TABLE); + + trx.set(&subspace.pack(&id), &pack(&( + entry.urlmatch, entry.unless.clone().unwrap_or_default(), entry.and.clone().unwrap_or_default(), + entry.unless.is_some(), entry.and.is_some(), entry.amount, entry.comment + ))); + + if let Err(e) = trx.commit().await { + eprintln!("DATABASE ERROR add_deranked_website {e}"); + } + + Some(id) + } +} + +pub async fn get_deranked_websites(db: &Database) -> Vec<(i64, DerankEntry)> { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR get_deranked_websites {e}"); + vec![] + } else { + let trx = trx.unwrap(); + // derank -> * + let subspace = Subspace::from(DERANK_TABLE); + let mut range = RangeOption::from(&subspace); + range.mode = StreamingMode::WantAll; + + let kv = trx.get_range(&range, 1024, true).await; + + if let Err(e) = kv { + error!("DATABASE ERROR page_links_entering {e}"); + vec![] + } else { + let kv = kv.unwrap(); + + let mut hashes = vec![]; + + for kv in kv.into_iter() { + let (_, id) = unpack::<(String, i64)>(kv.key()).expect("INVALID K TYPE get_deranked_websites"); + let (urlmatch, unless, and, use_unless, use_and, amount, comment) + = unpack::< + (String, String, String, bool, bool, f64, String) + >(kv.value()).expect("INVALID V TYPE get_deranked_websites"); + + hashes.push((id, DerankEntry { + urlmatch, + and: if use_and { Some(and) } else { None }, + unless: if use_unless { Some(unless) } else { None }, + amount, + comment, + })); + } + + hashes + } + } +} + +pub async fn info_title(db: &Database, url: STRHASH) -> Option { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR page_pagerank {e}"); + None + } else { + let trx = trx.unwrap(); + // info -> url -> title + let subspace = Subspace::from((INFO_TABLE, url)); + let v = trx.get(&subspace.pack(&(INFO_TABLE_TITLE)), true).await; + + if let Ok(v) = v { + v.map(|v| unpack::<(String,)>(&v).expect("INVALID K TYPE page_pagerank").0) + } else { + None + } + } +} + +pub async fn info_description(db: &Database, url: STRHASH) -> Option { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR page_pagerank {e}"); + None + } else { + let trx = trx.unwrap(); + // info -> url -> title + let subspace = Subspace::from((INFO_TABLE, url)); + let v = trx.get(&subspace.pack(&(INFO_TABLE_DESC)), true).await; + + if let Ok(v) = v { + v.map(|v| unpack::<(String,)>(&v).expect("INVALID K TYPE page_pagerank").0) + } else { + None + } + } +} + +pub async fn set_page_word_count(db: &Database, url: STRHASH, wc: u64) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR set_page_word_count {e}"); + } else { + let trx = trx.unwrap(); + trx.set(&pack(&(WEBSITE_TABLE, url, WEBSITE_TABLE_WORDCOUNT)), &pack(&(wc))); + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR set_page_word_count {e}"); + } + } +} + +pub async fn page_word_count(db: &Database, url: STRHASH) -> u64 { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR page_word_count {e}"); + 0 + } else { + let trx = trx.unwrap(); + + let wc = trx.get(&pack(&(WEBSITE_TABLE, url, WEBSITE_TABLE_WORDCOUNT)), true).await; + if let Ok(Some(wc)) = wc { + let val = unpack::(&wc).unwrap(); + if val > 0 { + return val; + } + } else if let Err(e) = wc { + warn!("DATABASE ERROR page_word_count {e}"); + } + warn!("recalculating page word count..."); + // link -> from -> * + let subspace = Subspace::from((WURL_TABLE, url)); + let mut range = RangeOption::from(&subspace); + range.mode = StreamingMode::WantAll; + + let kv = trx.get_range(&range, 1024, true).await; + + + if let Err(e) = kv { + error!("DATABASE ERROR page_word_count {e}"); + 0 + } else { + let kv = kv.unwrap(); + let mut counter = 0; + for kv in kv.into_iter() { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR page_word_count {e}"); + } else { + let trx = trx.unwrap(); + if let Ok(word) = unpack::(kv.value()) { + let subspace = Subspace::from((WORD_TABLE, word)); + let kv = trx.get(&subspace.pack(&url), true).await; + if let Err(e) = kv { + error!("DATABASE ERROR page_word_count {e}"); + } else { + let kv = kv.unwrap(); + if kv.is_none() { + warn!("WURL HAS NO CORRESPONDING WORD"); + } else { + let kv = kv.unwrap(); + counter += u64::from_be_bytes(kv.split_at(std::mem::size_of::()).0.try_into().unwrap()); + } + } + } + } + } + + let add_wc_trx = db.create_trx(); + if let Err(e) = add_wc_trx { + error!("couldn't add precalced wordcount to db: {e}"); + } else { + let add_wc_trx = add_wc_trx.unwrap(); + add_wc_trx.set(&pack(&(WEBSITE_TABLE, url, WEBSITE_TABLE_WORDCOUNT)), &pack(&(counter))); + if let Err(e) = add_wc_trx.commit().await { + warn!("couldn't add precalced wordcount to db: {e}"); + } + } + counter + } + } +} + +pub async fn page_links_entering(db: &Database, url: STRHASH) -> Vec { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR page_links_entering {e}"); + vec![] + } else { + let trx = trx.unwrap(); + // revlink -> to -> * + let subspace = Subspace::from((REVLINK_TABLE, url)); + let mut range = RangeOption::from(&subspace); + range.mode = StreamingMode::WantAll; + + let kv = trx.get_range(&range, 1024, true).await; + + if let Err(e) = kv { + error!("DATABASE ERROR page_links_entering {e}"); + vec![] + } else { + let kv = kv.unwrap(); + + let mut hashes = vec![]; + + for kv in kv.into_iter() { + let (_, _, from) = unpack::<(String, i64, i64)>(kv.key()).expect("INVALID K TYPE page_links_entering"); + + hashes.push(from); + } + + hashes + } + } +} + +pub async fn page_pagerank(db: &Database, url: STRHASH) -> Option { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR page_pagerank {e}"); + None + } else { + let trx = trx.unwrap(); + // website -> url + let subspace = Subspace::from((WEBSITE_TABLE, url)); + let v = trx.get(&subspace.pack(&(WEBSITE_TABLE_CACHEDPAGERANK)), true).await; + + if let Ok(v) = v { + v.map(|v| unpack::<(f64, )>(&v).expect("INVALID K TYPE page_pagerank").0) + } else { + None + } + } +} + +pub async fn page_damping(db: &Database, url: STRHASH) -> Option { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR page_damping {e}"); + None + } else { + let trx = trx.unwrap(); + // website -> url + let subspace = Subspace::from((WEBSITE_TABLE, url)); + let v = trx.get(&subspace.pack(&(WEBSITE_TABLE_DAMPING)), true).await; + + if let Ok(v) = v { + v.map(|v| unpack::<(f64, )>(&v).expect("INVALID K TYPE page_damping").0) + } else { + None + } + } +} + +pub async fn page_links_exiting_count(db: &Database, url: STRHASH) -> u64 { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR page_links_exiting_count {e}"); + 0 + } else { + let trx = trx.unwrap(); + // link -> from -> * + let subspace = Subspace::from((LINK_TABLE, url)); + let mut range = RangeOption::from(&subspace); + range.mode = StreamingMode::WantAll; + + let kv = trx.get_range(&range, 1024, true).await; + + + if let Err(e) = kv { + error!("DATABASE ERROR page_links_exiting_count {e}"); + 0 + } else { + let kv = kv.unwrap(); + + kv.len() as u64 + } + } +} + +// todo: precalc statements +// url, occurs +pub async fn word_occurs(db: &Database, word: STRHASH) -> Vec<(STRHASH, Vec)> { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR word_occurs {e}"); + vec![] + } else { + let trx = trx.unwrap(); + // word -> word -> * + let subspace = Subspace::from((WORD_TABLE, word)); + let mut range = RangeOption::from(&subspace); + range.mode = StreamingMode::WantAll; + + let kv = trx.get_range(&range, 1024, true).await; + + if let Err(e) = kv { + error!("DATABASE ERROR word_occurs {e}"); + vec![] + } else { + let kv = kv.unwrap(); + + let mut results = vec![]; + + for kv in kv.into_iter() { + let (_, _, url) = unpack::<(String, STRHASH, STRHASH)>(kv.key()).expect("INVALID K TYPE word_occurs"); + + results.push((url, kv.value().to_vec())); + } + + results + } + } +} + +// todo: precalc statements +// url, property, occurs +pub async fn metaword_occurs(db: &Database, property: STRHASH, word: STRHASH) -> Vec<(STRHASH, Vec)> { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR metaword_occurs {e}"); + vec![] + } else { + let trx = trx.unwrap(); + // metaword -> word -> prop -> * + let subspace = Subspace::from((METAWORD_TABLE, word, property)); + let mut range = RangeOption::from(&subspace); + range.mode = StreamingMode::WantAll; + + let kv = trx.get_range(&range, 1024, true).await; + + if let Err(e) = kv { + error!("DATABASE ERROR metaword_occurs {e}"); + vec![] + } else { + let kv = kv.unwrap(); + + let mut results = vec![]; + + for kv in kv.into_iter() { + let (_, _, _, url) = unpack::<(String, STRHASH, STRHASH, STRHASH)>(kv.key()).expect("INVALID K TYPE metaword_occurs"); + + results.push((url, kv.value().to_vec())); + } + + results + } + } +} + +// todo: precalc statements +// url, occurs +pub async fn linkword_occurs(db: &Database, word: STRHASH) -> Vec<(STRHASH, Vec)> { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR linkword_occurs {e}"); + vec![] + } else { + let trx = trx.unwrap(); + // metaword -> word -> prop -> * + let subspace = Subspace::from((LINKWORD_TABLE, word)); + let mut range = RangeOption::from(&subspace); + range.mode = StreamingMode::WantAll; + + let kv = trx.get_range(&range, 1024, true).await; + + if let Err(e) = kv { + error!("DATABASE ERROR linkword_occurs {e}"); + vec![] + } else { + let kv = kv.unwrap(); + + let mut results = vec![]; + + for kv in kv.into_iter() { + let (_, _, _, url) = unpack::<(String, STRHASH, STRHASH, STRHASH)>(kv.key()).expect("INVALID K TYPE linkword_occurs"); + + results.push((url, kv.value().to_vec())); + } + + results + } + } +} + +pub async fn foa_strhash(db: &Database, value: &str) -> STRHASH { + let trx = db.create_trx(); + if let Err(e) = trx { + panic!("FATAL DATABASE ERROR foa_strhash {e}"); + } else { + let trx = trx.unwrap(); + // hash -> value + let subspace = Subspace::from((HASH_TABLE, )); + + let hash = hash(value); + + trx.set(&subspace.pack(&hash), &pack(&(value.to_string(), ))); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR foa_strhash (HASH MAY NOT HAVE BEEN INSERTED! {e}"); + } + + hash + } +} + +pub async fn fof_strhash(db: &Database, value: &str) -> Option { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR fof_strhash {e}"); + None + } else { + let trx = trx.unwrap(); + // hash -> value + let subspace = Subspace::from((HASH_TABLE, )); + + let hash = hash(value); + + let v = trx.get(&subspace.pack(&hash), true).await; + + if let Err(e) = v { + error!("DATABASE ERROR fof_strhash {e}"); + None + } else { + let v = v.unwrap(); + v.map(|_| hash) + } + } +} + +pub async fn unhash(db: &Database, value: STRHASH) -> String { + let trx = db.create_trx(); + if let Err(e) = trx { + panic!("FATAL DATABASE ERROR unhash {e}"); + } else { + let trx = trx.unwrap(); + // hash -> value + let subspace = Subspace::from((HASH_TABLE, )); + + let v = trx.get(&subspace.pack(&value), true).await; + + if let Err(e) = v { + panic!("FATAL DATABASE ERROR unhash {e}"); + } else { + let v = v.unwrap(); + if v.is_none() { + panic!("UNHASH CALLED ON NON-EXISTANT HASH {value}") + } + unpack::(&v.unwrap()).expect("INVALID K TYPE unhash") + } + } +} + +pub async fn host_in_database(db: &Database, url: STRHASH) -> bool { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR host_in_database {e}"); + false + } else { + let trx = trx.unwrap(); + // host -> url + let subspace = Subspace::from(HOST_TABLE); + + let v = trx.get(&subspace.pack(&url), true).await; + + + if let Err(e) = v { + error!("DATABASE ERROR host_in_database {e}"); + false + } else { + v.unwrap().is_some() + } + } +} + +pub async fn create_host(db: &Database, url: STRHASH) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR create_host {e}"); + } else { + let trx = trx.unwrap(); + // host -> url + let subspace = Subspace::from(HOST_TABLE); + + trx.set(&subspace.pack(&url), &pack(&(0i64))); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR create_host {e}"); + } + } +} + +pub async fn create_empty_document(db: &Database, url: STRHASH, host_url: STRHASH, damping: f32, parse_begin: Option) { + if !document_in_database(db, url).await { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR create_empty_document {e}"); + } else { + let trx = trx.unwrap(); + // website -> url + let subspace = Subspace::from((WEBSITE_TABLE, url)); + + trx.set(&subspace.pack(&WEBSITE_TABLE_HOST), &pack(&host_url)); + trx.set(&subspace.pack(&WEBSITE_TABLE_DAMPING), &pack(&(damping as f64))); + trx.set(&subspace.pack(&WEBSITE_TABLE_LASTPARSEBEGIN), &pack(&parse_begin.unwrap_or(0i64))); + trx.set(&subspace.pack(&WEBSITE_TABLE_LASTPARSEFINISH), &pack(&0i64)); + trx.set(&subspace.pack(&WEBSITE_TABLE_LASTPARSEFINISHTRUE), &pack(&0i64)); + trx.set(&subspace.pack(&WEBSITE_TABLE_CACHEDPAGERANK), &pack(&0f64)); + trx.set(&subspace.pack(&WEBSITE_TABLE_LASTPAGERANKCACHE), &pack(&0i64)); + trx.set(&subspace.pack(&WEBSITE_TABLE_ROBOTSFLAG), &pack(&false)); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR create_empty_document {e}"); + } + } + } else {} +} + +pub async fn link_in_database(db: &Database, url: STRHASH, dest: STRHASH) -> bool { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR link_in_database {e}"); + false + } else { + let trx = trx.unwrap(); + // link -> from (url) -> to (dest) + let subspace = Subspace::from((LINK_TABLE, url)); + + let v = trx.get(&subspace.pack(&dest), true).await; + + if let Err(e) = v { + error!("DATABASE ERROR link_in_database {e}"); + false + } else { + v.unwrap().is_some() + } + } +} + +// creates an empty link between two websites, does nothing if it already exists +pub async fn create_empty_link(db: &Database, url: STRHASH, host: STRHASH, dest_url: STRHASH) { + if !document_in_database(db.clone(), dest_url).await { + create_empty_document(db.clone(), dest_url, host, 0.85, None).await; + } + if !link_in_database(db, url, dest_url).await { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR create_empty_link {e}"); + } else { + let trx = trx.unwrap(); + // link -> from -> to && revlink -> to -> from + let subspace = Subspace::from((LINK_TABLE, url)); + let revsubspace = Subspace::from((REVLINK_TABLE, dest_url)); + + trx.set(&subspace.pack(&dest_url), &[0u8]); + trx.set(&revsubspace.pack(&url), &[0u8]); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR create_empty_link {e}"); + } + } + } +} + +pub async fn link_set_flags(db: &Database, url: STRHASH, dest_url: STRHASH, flags: u8) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR link_set_flags {e}"); + } else { + let trx = trx.unwrap(); + // link -> from -> to && revlink -> to -> from + let subspace = Subspace::from((LINK_TABLE, url)); + let revsubspace = Subspace::from((REVLINK_TABLE, dest_url)); + + trx.set(&subspace.pack(&dest_url), &[flags]); + trx.set(&revsubspace.pack(&url), &[flags]); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR link_set_flags {e}"); + } + } +} + +pub async fn document_in_database(db: &Database, url: STRHASH) -> bool { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR document_in_database {e}"); + false + } else { + let trx = trx.unwrap(); + // website -> url + let subspace = Subspace::from((WEBSITE_TABLE, url)); + + let v = trx.get(&subspace.pack(&WEBSITE_TABLE_HOST), true).await; + + + if let Err(e) = v { + error!("DATABASE ERROR document_in_database {e}"); + false + } else { + v.unwrap().is_some() + } + } +} + +pub async fn info_in_database(db: &Database, url: STRHASH) -> bool { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR info_in_database {e}"); + false + } else { + let trx = trx.unwrap(); + // info -> url + let subspace = Subspace::from(INFO_TABLE); + + let v = trx.get(&subspace.pack(&url), true).await; + + + if let Err(e) = v { + error!("DATABASE ERROR info_in_database {e}"); + false + } else { + v.unwrap().is_some() + } + } +} + +pub async fn set_info(db: &Database, url: STRHASH, title: String, description: String, favicon: i64) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR set_info {e}"); + } else { + let trx = trx.unwrap(); + // info -> url + let subspace = Subspace::from((INFO_TABLE, url)); + + trx.set(&subspace.pack(&INFO_TABLE_TITLE), &pack(&title)); + trx.set(&subspace.pack(&INFO_TABLE_DESC), &pack(&(description))); + trx.set(&subspace.pack(&INFO_TABLE_FAVICON), &pack(&favicon)); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR set_info {e}"); + } + } +} + +pub async fn document_last_parse_begin(db: &Database, url: STRHASH) -> Option> { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR document_last_parse_begin {e}"); + None + } else { + let trx = trx.unwrap(); + // website -> url -> lastparsebegin + let subspace = Subspace::from((WEBSITE_TABLE, url)); + + let v = trx.get(&subspace.pack(&WEBSITE_TABLE_LASTPARSEBEGIN), true).await; + + + if let Err(e) = v { + error!("DATABASE ERROR document_last_parse_begin {e}"); + None + } else { + v.unwrap().map(|v| chrono::Utc.timestamp_opt(unpack::(&v).expect("INVALID K TYPE document_last_parse_begin"), 0).unwrap()) + } + } +} + +pub async fn document_last_parse_finish(db: &Database, url: STRHASH) -> Option> { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR document_last_parse_finish {e}"); + None + } else { + let trx = trx.unwrap(); + // website -> url -> lastparsefinish + let subspace = Subspace::from((WEBSITE_TABLE, url)); + + let v = trx.get(&subspace.pack(&WEBSITE_TABLE_LASTPARSEFINISH), true).await; + + + if let Err(e) = v { + error!("DATABASE ERROR document_last_parse_finish {e}"); + None + } else { + v.unwrap().map(|v| chrono::Utc.timestamp_opt(unpack::(&v).expect("INVALID K TYPE document_last_parse_finish"), 0).unwrap()) + } + } +} + +pub async fn document_set_damping(db: &Database, url: STRHASH, damping: f32) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR document_set_damping {e}"); + } else { + let trx = trx.unwrap(); + // website -> url + let subspace = Subspace::from((WEBSITE_TABLE, url)); + + trx.set(&subspace.pack(&WEBSITE_TABLE_DAMPING), &pack(&(damping as f64))); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR document_set_damping {e}"); + } + } +} + +pub async fn document_set_pagerank(db: &Database, url: STRHASH, pagerank: f64, now: i64) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR document_set_pagerank {e}"); + } else { + let trx = trx.unwrap(); + // website -> url + let subspace = Subspace::from((WEBSITE_TABLE, url)); + + trx.set(&subspace.pack(&WEBSITE_TABLE_CACHEDPAGERANK), &pack(&(pagerank))); + trx.set(&subspace.pack(&WEBSITE_TABLE_LASTPAGERANKCACHE), &pack(&(now))); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR document_set_dampingdocument_set_pagerank {e}"); + } + } +} + +pub async fn document_set_last_parse_begin(db: &Database, url: STRHASH, now: i64) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR document_set_last_parse_begin {e}"); + } else { + let trx = trx.unwrap(); + // website -> url + let subspace = Subspace::from((WEBSITE_TABLE, url)); + + trx.set(&subspace.pack(&WEBSITE_TABLE_LASTPARSEBEGIN), &pack(&now)); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR document_set_last_parse_begin {e}"); + } + } +} + +pub async fn document_set_last_parse_finish(db: &Database, url: STRHASH, now: i64, true_now: i64) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR document_set_last_parse_finish {e}"); + } else { + let trx = trx.unwrap(); + // website -> url + let subspace = Subspace::from((WEBSITE_TABLE, url)); + + trx.set(&subspace.pack(&WEBSITE_TABLE_LASTPARSEFINISH), &pack(&now)); + trx.set(&subspace.pack(&WEBSITE_TABLE_LASTPARSEFINISHTRUE), &pack(&true_now)); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR document_set_last_parse_finish {e}"); + } + } +} + +pub async fn document_set_robots_flag(db: &Database, url: STRHASH, value: bool) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR document_set_robots_flag {e}"); + } else { + let trx = trx.unwrap(); + // website -> url + let subspace = Subspace::from((WEBSITE_TABLE, url)); + + trx.set(&subspace.pack(&WEBSITE_TABLE_ROBOTSFLAG), &pack(&value)); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR document_set_robots_flag {e}"); + } + } +} + +pub async fn document_set_metaword(db: &Database, url: STRHASH, word_name: STRHASH, property: STRHASH, occurances: &[u8]) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR document_set_metaword {e}"); + } else { + let trx = trx.unwrap(); + // metaword -> word -> prop -> url + // metawurl -> url -> prop -> word + let subspace = Subspace::from((METAWORD_TABLE, word_name, property)); + let revsubspace = Subspace::from((METAWURL_TABLE, url, property)); + + trx.set(&subspace.pack(&url), occurances); + trx.set(&revsubspace.pack(&word_name), &pack(&word_name)); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR document_set_metaword {e}"); + } + } +} + +pub async fn document_set_word(db: &Database, url: STRHASH, word_name: STRHASH, occurances: &[u8]) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR document_set_word {e}"); + } else { + let trx = trx.unwrap(); + // word -> word -> url + let subspace = Subspace::from((WORD_TABLE, word_name)); + let revsubspace = Subspace::from((WURL_TABLE, url)); + + trx.set(&subspace.pack(&url), occurances); + trx.set(&revsubspace.pack(&word_name), &pack(&word_name)); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR document_set_word {e}"); + } + } +} + +pub async fn link_set_linkword(db: &Database, url: STRHASH, dest: STRHASH, word_name: STRHASH, occurances: &[u8]) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR link_set_linkword {e}"); + } else { + let trx = trx.unwrap(); + // linkword -> word -> from -> to + let subspace = Subspace::from((LINKWORD_TABLE, word_name, url)); + let revsubspace = Subspace::from((LINKWORD_TABLE, url, dest)); + + trx.set(&subspace.pack(&dest), occurances); + trx.set(&revsubspace.pack(&word_name), &pack(&word_name)); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR link_set_linkword {e}"); + } + } +} + +pub async fn document_host(db: &Database, url: STRHASH) -> Option { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR document_host {e}"); + None + } else { + let trx = trx.unwrap(); + // website -> url -> host + let subspace = Subspace::from((WEBSITE_TABLE, url)); + + let v = trx.get(&subspace.pack(&WEBSITE_TABLE_HOST), true).await; + + + if let Err(e) = v { + error!("DATABASE ERROR document_host {e}"); + None + } else { + v.unwrap().map(|v| unpack::(&v).expect("INVALID K TYPE document_last_parse_finish")) + } + } +} + +pub async fn host_last_fetch(db: &Database, url: STRHASH) -> Option> { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR host_last_fetch {e}"); + None + } else { + let trx = trx.unwrap(); + // host -> url + let subspace = Subspace::from(HOST_TABLE); + + let v = trx.get(&subspace.pack(&url), true).await; + + + if let Err(e) = v { + error!("DATABASE ERROR host_last_fetch {e}"); + None + } else { + v.unwrap().map(|v| chrono::Utc.timestamp_opt(unpack::(&v).expect("INVALID K TYPE host_last_fetch"), 0).unwrap()) + } + } +} + +pub async fn host_set_last_fetch(db: &Database, url: STRHASH, now: chrono::DateTime) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR host_set_last_fetch {e}"); + } else { + let trx = trx.unwrap(); + // host -> url + let subspace = Subspace::from(HOST_TABLE); + + trx.set(&subspace.pack(&url), &pack(&now.timestamp())); + + if let Err(e) = trx.commit().await { + error!("DATABASE ERROR host_set_last_fetch {e}"); + } + } +} + +pub async fn prevented_by_dehomogeniser(db: &Database, url: &str) -> (bool, String, String) { + let trx = db.create_trx(); + if let Err(e) = trx { + error!("DATABASE ERROR prevented_by_dehomogeniser {e}"); + (false, "".to_string(), "".to_string()) + } else { + let trx = trx.unwrap(); + // revlink -> to -> * + let subspace = Subspace::from(DEHOMOGENISE_TABLE); + let range = RangeOption::from(&subspace); + + let kv = trx.get_range(&range, 1024, true).await; + + if let Err(e) = kv { + error!("DATABASE ERROR prevented_by_dehomogeniser {e}"); + (false, "".to_string(), "".to_string()) + } else { + let kv = kv.unwrap(); + + for kv in kv.into_iter() { + let (block, unless) = unpack::<(String, String)>(kv.value()).expect("INVALID V TYPE prevented_by_dehomogeniser"); + + if url.contains(&block) && (unless.is_empty() || !url.contains(&unless)) { + return (true, block.to_string(), unless.to_string()); + } + } + + (false, "".to_string(), "".to_string()) + } + } +} \ No newline at end of file diff --git a/src/db/tables.rs b/src/db/tables.rs new file mode 100644 index 0000000..bdd3695 --- /dev/null +++ b/src/db/tables.rs @@ -0,0 +1,80 @@ +/* + * asklyphe-common db/tables.rs + * - foundationdb key name parts + * + * Copyright (C) 2025 Real Microsoft, LLC + * + * 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, version 3. + * + * 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 . +*/ + +use log::info; + +/// str = STRHASH +/// text = u64 len + chars + +/// (derank_) +/// (match text, unless text, and text, use_unless bool, use_and bool, value f64, comment text) +pub const DERANK_TABLE: &str = "derank"; + +/// (info_) +/// (url STRHASH, title text, description text, favicon hash) +pub const INFO_TABLE: &str = "info"; +pub const INFO_TABLE_TITLE: &str = "title"; +pub const INFO_TABLE_DESC: &str = "desc"; +pub const INFO_TABLE_FAVICON: &str = "favicon"; +/// (hash_) +/// (value text) +pub const HASH_TABLE: &str = "hash"; +/// (dehomo_) +/// (block text, unless text) +pub const DEHOMOGENISE_TABLE: &str = "dehomogenise"; +/// (website_) +/// (host text, flags u8, +/// damping f64, lastparsebegin i64, +/// lastparsefinish i64, lastparsefinishtrue i64, +/// cachedpagerank f64, lastpagerankcache i64, +/// robotsflag bool) +pub const WEBSITE_TABLE: &str = "website"; +pub const WEBSITE_TABLE_HOST: &str = "host"; +pub const WEBSITE_TABLE_DAMPING: &str = "damping"; +pub const WEBSITE_TABLE_LASTPARSEBEGIN: &str = "lastparsebegin"; +pub const WEBSITE_TABLE_LASTPARSEFINISH: &str = "lastparsefinish"; +pub const WEBSITE_TABLE_LASTPARSEFINISHTRUE: &str = "lastparsefinishtrue"; +pub const WEBSITE_TABLE_CACHEDPAGERANK: &str = "cachedpagerank"; +pub const WEBSITE_TABLE_LASTPAGERANKCACHE: &str = "lastpagerankcache"; +pub const WEBSITE_TABLE_ROBOTSFLAG: &str = "robotsflag"; +pub const WEBSITE_TABLE_WORDCOUNT: &str = "wordcount"; +/// (host_) +/// (lastcrawl i64) +pub const HOST_TABLE: &str = "hosts"; +/// (word__) +/// see vorebot words encoded format +/// -- +/// (wurl__) +/// (word i64, maybe expand in future) +pub const WORD_TABLE: &str = "word"; +pub const WURL_TABLE: &str = "word"; +/// (metaword___) +/// see vorebot metawords encoded format +/// -- +/// (metawurl___) +/// (mword i64, maybe expand in future) +pub const METAWORD_TABLE: &str = "metaword"; +pub const METAWURL_TABLE: &str = "metawurl"; +/// (link__) +/// (flags u8) +/// -- +/// (revlink__) +/// (flags u8) +pub const LINK_TABLE: &str = "link"; +pub const REVLINK_TABLE: &str = "revlink"; +/// (linkword___) +/// see vorebot linkword encoded format +/// -- +/// (linkwurl___) +/// (word i64, maybe expand in future) +pub const LINKWORD_TABLE: &str = "linkword"; \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..1684fad --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,32 @@ +/* + * asklyphe-common lib.rs + * - main library file for asklyphe-common + * + * Copyright (C) 2025 Real Microsoft, LLC + * + * 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, version 3. + * + * 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 . +*/ + +pub mod nats; +pub mod db; + +pub use foundationdb; + +pub fn add(left: usize, right: usize) -> usize { + left + right +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn it_works() { + let result = add(2, 2); + assert_eq!(result, 4); + } +} diff --git a/src/nats/authservice/admin.rs b/src/nats/authservice/admin.rs new file mode 100644 index 0000000..a6b2aa3 --- /dev/null +++ b/src/nats/authservice/admin.rs @@ -0,0 +1,160 @@ +/* + * asklyphe-common nats/authservice/admin.rs + * - nats structs for admin-only queries + * + * Copyright (C) 2025 Real Microsoft, LLC + * + * 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, version 3. + * + * 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 . +*/ + +use serde::{Deserialize, Serialize}; +use crate::nats::authservice::UserPrivateToken; + +/// # StatsRequest +/// sent from frontend -> authsrvc, requires token with admin privs, returns data for display +/// on the admin stats summary page +/// expecting an AuthServiceResponse::StatsResponse back +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct StatsRequest { + pub token: UserPrivateToken, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct Stats { + pub last_ten_users: Vec, + pub user_count: usize, + pub admin_count: usize, + pub active_verification_requests: usize, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum StatsResponse { + Success(Stats), + InternalServerError(String), + Logout, + AccessDenied, +} + +/// # AdminInviteCodeGenerateRequest +/// sent from frontend -> authsrvc, requires token with admin privs +/// adds a valid invite code to the database +/// expecting an AuthServiceResponse::AdminInviteCodeGenerateResponse back +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct AdminInviteCodeGenerateRequest { + pub token: UserPrivateToken, + pub invite_code: String, + pub comment: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum AdminInviteCodeGenerateResponse { + Success, + CodeAlreadyExists, + InternalServerError(String), + Logout, + AccessDenied, +} + +/// # AdminListInviteCodesRequest +/// sent from frontend -> authsrvc, requires token with admin privs +/// lists invite codes that match the criteria +/// expecting an AuthServiceResponse::AdminListInviteCodesResponse back +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct AdminListInviteCodesRequest { + pub token: UserPrivateToken, + /// if true, will return invite codes that have been used instead of ones that are not yet used + pub show_used: bool, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct InviteCodeSerialized { + pub code: String, + pub comment: String, + pub creator: String, + pub root_creator: String, + pub created_at: String, + pub used_at: Option, + pub used_by: Option, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum AdminListInviteCodesResponse { + Success(Vec), + InternalServerError(String), + Logout, + AccessDenied, +} + +/// # AdminCreateAnnouncementRequest +/// sent from frontend -> authsrvc, requires token with admin privs +/// creates an announcement, and optionally sends emails to those who want to receive them +/// expecting an AuthServiceResponse::AdminCreateAnnouncementRequest +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct AdminCreateAnnouncementRequest { + pub token: UserPrivateToken, + pub title: String, + pub slug: String, + pub short_text: String, + pub full_markdown_text: String, + pub send_emails: bool, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum AdminCreateAnnouncementResponse { + Success, + SlugTaken, + InternalServerError(String), + Logout, + AccessDenied, +} + +/// # AdminUpdateAnnouncementRequest +/// sent from frontend -> authsrvc, requires token with admin privs +/// updates the contents of an announcement +/// expecting an AuthServiceResponse::AdminUpdateAnnouncementRequest +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct AdminUpdateAnnouncementRequest { + pub token: UserPrivateToken, + pub slug: String, + pub new_title: String, + pub new_short_text: String, + pub new_full_markdown_text: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum AdminUpdateAnnouncementResponse { + Success, + OriginalNotFound, + InternalServerError(String), + Logout, + AccessDenied, +} + +/// # AdminListAllUsersRequest +/// sent from frontend -> authsrvc, requires token with admin privs +/// returns a list of all users with accounts +/// expecting an AuthServiceResponse::AdminListAllUsersResponse +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct AdminListAllUsersRequest { + pub token: UserPrivateToken, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct UserSerialized { + pub username: String, + pub email: String, + pub verified: bool, + pub admin: bool, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum AdminListAllUsersResponse { + Success(Vec), + InternalServerError(String), + Logout, + AccessDenied, +} \ No newline at end of file diff --git a/src/nats/authservice/announcements.rs b/src/nats/authservice/announcements.rs new file mode 100644 index 0000000..d6e16c7 --- /dev/null +++ b/src/nats/authservice/announcements.rs @@ -0,0 +1,77 @@ +/* + * asklyphe-common nats/authservice/announcements.rs + * - nats structs for reading announcements + * + * Copyright (C) 2025 Real Microsoft, LLC + * + * 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, version 3. + * + * 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 . +*/ + +// announcements are also sometimes referred to as "notes" + +use serde::{Deserialize, Serialize}; + +/// # LatestAnnouncementRequest +/// sent from frontend -> authsrvc, returns the latest announcement in its short form +/// expecting an AuthServiceResponse::LatestAnnouncementResponse back +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct LatestAnnouncementRequest {} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct AnnouncementShortForm { + pub title: String, + pub short_text: String, + pub date: i64, // unix utc + pub slug: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum LatestAnnouncementResponse { + Some(AnnouncementShortForm), + None, + InternalServerError(String), +} + +/// # AnnouncementListRequest +/// sent from frontend -> authsrvc, +/// returns a list of all announcements in order of newest first to oldest last +/// expecting an AuthServiceResponse::AnnouncementListResponse back +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct AnnouncementListRequest { + pub limit: Option, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum AnnouncementListResponse { + Success(Vec), + InternalServerError(String), +} + +/// # AnnouncementFullRequest +/// sent from frontend -> authsrvc, returns the full contents of an announcement +/// expecting an AuthServiceResponse::AnnouncementFullResponse back +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct AnnouncementFullRequest { + pub slug: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct AnnouncementFull { + pub title: String, + pub created_on: i64, + pub updated_on: Option, + pub slug: String, + pub creator: String, // username + pub markdown_text: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum AnnouncementFullResponse { + Some(AnnouncementFull), + NotFound, + InternalServerError(String), +} \ No newline at end of file diff --git a/src/nats/authservice/mod.rs b/src/nats/authservice/mod.rs new file mode 100644 index 0000000..bf654bf --- /dev/null +++ b/src/nats/authservice/mod.rs @@ -0,0 +1,363 @@ +/* + * asklyphe-common nats/authservice/mod.rs + * - module file + general structs for the asklyphe authentication service + * + * Copyright (C) 2025 Real Microsoft, LLC + * + * 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, version 3. + * + * 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 . +*/ + +pub mod profile; +pub mod admin; +pub mod announcements; + +use std::fmt::{Display, Formatter, Write}; +use serde::{Deserialize, Serialize}; +use crate::nats::authservice::admin::{AdminCreateAnnouncementRequest, AdminCreateAnnouncementResponse, AdminInviteCodeGenerateRequest, AdminInviteCodeGenerateResponse, AdminListAllUsersRequest, AdminListAllUsersResponse, AdminListInviteCodesRequest, AdminListInviteCodesResponse, AdminUpdateAnnouncementRequest, AdminUpdateAnnouncementResponse, StatsRequest, StatsResponse}; +use crate::nats::authservice::announcements::{AnnouncementFullRequest, AnnouncementFullResponse, AnnouncementListRequest, AnnouncementListResponse, LatestAnnouncementRequest, LatestAnnouncementResponse}; +use crate::nats::authservice::profile::{ThemeChangeRequest, ThemeChangeResponse, UserInfoRequest, UserInfoResponse}; + +pub const AUTH_SERVICE: &str = "authsrvc"; +pub const AUTH_REPLY_SERVICE: &str = "authsrvcreply"; + +/// used internally to identify a session +pub type UserPrivateToken = String; + +/// used as a semi-secure way to let the user identify individual sessions +pub type UserDisplayToken = String; +/// internal identifier for accounts, should be unique no matter what as this is what we will pass +/// to trusted services to query account info +pub type AccountId = String; +/// internal identifier for an email verification request, given to an account upon creation or email change +/// should be kept private as it will be in the query string of the url that will automatically verify +/// the new email +pub type EmailVerificationId = String; + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct AuthServiceQuery { + pub request: AuthServiceRequest, + /// if using comms::query_service, you don't need to set this + pub replyto: String, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum AuthServiceRequest { + RegisterRequest(RegisterRequest), + VerifyEmailRequest(VerifyEmailRequest), + LoginRequest(LoginRequest), + AuthRequest(AuthRequest), + LogoutRequest(LogoutRequest), + UserInfoRequest(UserInfoRequest), + EmailChangeRequest(EmailChangeRequest), + CancelEmailChangeRequest(CancelEmailChangeRequest), + ThemeChangeRequest(ThemeChangeRequest), + StatsRequest(StatsRequest), + AdminInviteCodeGenerateRequest(AdminInviteCodeGenerateRequest), + LatestAnnouncementRequest(LatestAnnouncementRequest), + AnnouncementListRequest(AnnouncementListRequest), + AnnouncementFullRequest(AnnouncementFullRequest), + AdminCreateAnnouncementRequest(AdminCreateAnnouncementRequest), + AdminUpdateAnnouncementRequest(AdminUpdateAnnouncementRequest), + AdminListInviteCodesRequest(AdminListInviteCodesRequest), + AdminListAllUsersRequest(AdminListAllUsersRequest), +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum AuthServiceResponse { + InvalidRequest, + OtherError(String), + RegisterResponse(RegisterResponse), + VerifyEmailResponse(VerifyEmailResponse), + LoginResponse(LoginResponse), + AuthResponse(AuthResponse), + LogoutResponse(LogoutResponse), + UserInfoResponse(UserInfoResponse), + EmailChangeResponse(EmailChangeResponse), + CancelEmailChangeResponse(CancelEmailChangeResponse), + ThemeChangeResponse(ThemeChangeResponse), + StatsResponse(StatsResponse), + AdminInviteCodeGenerateResponse(AdminInviteCodeGenerateResponse), + LatestAnnouncementResponse(LatestAnnouncementResponse), + AnnouncementListResponse(AnnouncementListResponse), + AnnouncementFullResponse(AnnouncementFullResponse), + AdminCreateAnnouncementResponse(AdminCreateAnnouncementResponse), + AdminUpdateAnnouncementResponse(AdminUpdateAnnouncementResponse), + AdminListInviteCodesResponse(AdminListInviteCodesResponse), + AdminListAllUsersResponse(AdminListAllUsersResponse), +} + +// fixme: this should really be done with a macro +impl Display for AuthServiceResponse { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + AuthServiceResponse::InvalidRequest => { + f.write_str("invalid request") + } + AuthServiceResponse::OtherError(_) => { + f.write_str("other error") + } + AuthServiceResponse::RegisterResponse(_) => { + f.write_str("register response") + } + AuthServiceResponse::VerifyEmailResponse(_) => { + f.write_str("verify email response") + } + AuthServiceResponse::LoginResponse(_) => { + f.write_str("login response") + } + AuthServiceResponse::AuthResponse(_) => { + f.write_str("auth response") + } + AuthServiceResponse::LogoutResponse(_) => { + f.write_str("logout response") + } + AuthServiceResponse::UserInfoResponse(_) => { + f.write_str("user info response") + } + AuthServiceResponse::EmailChangeResponse(_) => { + f.write_str("email change response") + } + AuthServiceResponse::CancelEmailChangeResponse(_) => { + f.write_str("cancel email change response") + } + AuthServiceResponse::ThemeChangeResponse(_) => { + f.write_str("theme change resposne") + } + AuthServiceResponse::StatsResponse(_) => { + f.write_str("stats response") + } + AuthServiceResponse::AdminInviteCodeGenerateResponse(_) => { + f.write_str("admin invite code generate response") + } + AuthServiceResponse::LatestAnnouncementResponse(_) => { + f.write_str("latest announcement response") + } + AuthServiceResponse::AnnouncementListResponse(_) => { + f.write_str("announcement list response") + } + AuthServiceResponse::AnnouncementFullResponse(_) => { + f.write_str("announcement full response") + } + AuthServiceResponse::AdminCreateAnnouncementResponse(_) => { + f.write_str("admin create announcement response") + } + AuthServiceResponse::AdminUpdateAnnouncementResponse(_) => { + f.write_str("admin update announcement response") + } + AuthServiceResponse::AdminListInviteCodesResponse(_) => { + f.write_str("admin list invite codes response") + } + AuthServiceResponse::AdminListAllUsersResponse(_) => { + f.write_str("admin list all users response") + } + } + } +} + +/// # RegisterRequest +/// sent from frontend -> authsrvc to attempt to register a user account +/// expecting a AuthServiceResponse::RegisterResponse back +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct RegisterRequest { + /// username may be eventually used in settings where users will interact; preventing email addresses being shared + pub username: String, + pub email: String, + /// value is NOT hashed over nats! make sure that tls is enabled! + pub password: String, + /// during private beta, only accept requests with a valid invite code; + /// afterwards, an empty invite code will indicate a free trial + pub invite_code: String, +} + +/// # RegisterResponse +/// sent from authsrvc -> frontend once the RegisterRequest was completed +/// success should give user a message to check their email for verification +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum RegisterResponse { + Success, + Failure(RegisterError), +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum RegisterError { + /// probably best to not display the actual error to the user, for security reasons + InternalServer(String), + Password(PasswordError), + Email(EmailError), + Username(UsernameError), + BadInviteCode, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum PasswordError { + /// weird / non-ascii characters in password + InvalidCharacters, + /// password too short + TooShort, + /// commonly used + TooCommon, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum EmailError { + /// doesn't match email format + InvalidEmail, + /// email already in use + EmailTaken, + /// email blacklisted (e.g. if email server is commonly used for spam) + EmailBlacklisted, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum UsernameError { + /// contains invalid characters (i.e. not a-z, 0-9, -, _, ~, maybe some others?) + /// usernames should be case insensitive + InvalidCharacters, + /// usernames should probably be at minimum 3 chars? idk i'm just coming up with a random value + TooShort, + /// no duplicate usernames + Taken, + /// try to avoid people using slurs as usernames + Inappropriate, +} + +/// # VerifyEmailRequest +/// sent from frontend -> authsrvc to attempt to verify an email +/// expecting a AuthServiceResponse::VerifyEmailResponse back +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct VerifyEmailRequest { + pub username: String, + pub token: EmailVerificationId, +} + +/// # VerifyEmailResponse +/// sent from authsrvc -> frontend once the VerifyEmailRequest completes +/// if successful, it's assumed that a user can now log in to their account without issue +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum VerifyEmailResponse { + Success, + InvalidToken, + ExpiredToken, + InternalServerError(String), +} + +/// # LoginRequest +/// sent from frontend -> authsrvc to attempt to login to a user account +/// expecting a AuthServiceResponse::LoginResponse back +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct LoginRequest { + pub email: String, + /// value is NOT hashed over nats! make sure that tls is enabled! + pub password: String, +} + +/// # LoginResponse +/// sent from authsrvc -> frontend once the LoginRequest was completed +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum LoginResponse { + Success(TokenAssignment), + Failure(LoginError), +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum LoginError { + /// probably best to not display the actual error to the user, for security reasons + InternalServer(String), + /// to avoid bruteforce attempts on accounts, don't say what part of the given email/pass + /// combo was invalid + InvalidAccount, + /// best to include a message on the frontend indicating that the user check their email for more info + SuspendedAccount, + /// don't let people login unless they've verified their email + AccountNotVerified, +} + +/// # AuthRequest +/// sent from any service -> authsrvc to check credentials on an internal request +/// expecting a AuthServiceResponse::AuthResponse back +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct AuthRequest { + pub token: UserPrivateToken, +} + +/// # AuthResponse +/// sent from authsrvc -> requesting service once the AuthRequest was completed +/// errors should ideally be forwarded to the user if necessary +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum AuthResponse { + Success(AccountId), + Failure(AuthError), +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum AuthError { + /// probably best to not display the actual error to the user, for security reasons + InternalServer(String), + /// if the token is expired + TokenExpired, + /// if the account was suspended between now and the last valid request + AccountSuspended, + /// if the token just doesn't exist + TokenInvalid, +} + +/// # TokenAssignment +/// generic struct used in usersrvc -> frontend messages when the user needs to have their session assigned +/// (such as after logging in) +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct TokenAssignment { + pub token: UserPrivateToken, + /// unix utc timestamp of death date + pub ttl: i64, +} + +/// # LogoutRequest +/// sent from frontend -> authsrvc to delete a session +/// expecting a AuthServiceResponse::LogoutResponse back +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct LogoutRequest { + pub token: UserPrivateToken, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum LogoutResponse { + Success, + InternalServerError(String), + /// not that important what happened with the token, the frontend is already discarding it regardless + BadTokenError, +} + +/// # EmailChangeRequest +/// sent from frontend -> authsrvc to start the process of changing a user's associated email address +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct EmailChangeRequest { + pub token: UserPrivateToken, + pub new_email: String, +} + +/// # EmailChangeResponse +/// authsrvc -> frontend, response to EmailChangeRequest +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum EmailChangeResponse { + /// verification email has been sent + Success, + /// user token invalid, log out + InvalidToken, + /// new email was not valid + InvalidEmail, + /// internal error + InternalError, +} + +/// # CancelEmailChangeRequest +/// frontend -> authsrvc, cancel an in-progress email change +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct CancelEmailChangeRequest { + pub token: UserPrivateToken, +} + +/// # CancelEmailChangeResponse +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum CancelEmailChangeResponse { + Success, + /// user token invalid, log out + InvalidToken, + /// internal error + InternalError, +} \ No newline at end of file diff --git a/src/nats/authservice/profile.rs b/src/nats/authservice/profile.rs new file mode 100644 index 0000000..e9db754 --- /dev/null +++ b/src/nats/authservice/profile.rs @@ -0,0 +1,58 @@ +/* + * asklyphe-common nats/authservice/profile.rs + * - nats structs for user profile queries + * + * Copyright (C) 2025 Real Microsoft, LLC + * + * 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, version 3. + * + * 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 . +*/ + +use serde::{Deserialize, Serialize}; +use crate::nats::authservice::UserPrivateToken; + +/// # UserInfoRequest +/// sent from frontend -> authsrvc to receive info for display on the frontend +/// expecting a AuthServiceResponse::UserInfoResponse back +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct UserInfoRequest { + pub token: UserPrivateToken, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct UserInfo { + pub username: String, + pub email: String, + pub new_email: Option, + pub theme: String, + pub administrator: bool, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum UserInfoResponse { + Success(UserInfo), + InternalServerError(String), + TokenExpired, + TokenInvalid, + AccountSuspended, +} + +/// # ThemeChangeRequest +/// sent from frontend -> authsrvc to set the user's preferred theme +/// do note that the backend will not check if the theme is valid, this must be done on the frontend +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct ThemeChangeRequest { + pub token: UserPrivateToken, + pub theme: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum ThemeChangeResponse { + Success, + /// sent if the token is invalid, and the account should be logged out + Logout, + InternalServerError, +} diff --git a/src/nats/bingservice.rs b/src/nats/bingservice.rs new file mode 100644 index 0000000..a3f3594 --- /dev/null +++ b/src/nats/bingservice.rs @@ -0,0 +1,63 @@ +/* + * asklyphe-common nats/bingservice.rs + * - nats structs for external search engines + * + * Copyright (C) 2025 Real Microsoft, LLC + * + * 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, version 3. + * + * 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 . +*/ + +use serde::{Deserialize, Serialize}; + +pub const BING_SERVICE: &str = "bingservice"; +pub const BING_REPLY_SERVICE: &str = "bingservicereply"; +pub const GOOGLE_SERVICE: &str = "googleservice"; +pub const GOOGLE_REPLY_SERVICE: &str = "googleservicereply"; + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct BingServiceQuery { + pub request: BingServiceRequest, + /// if using comms::query_service, you don't need to set this + pub replyto: String, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum BingServiceRequest { + SearchRequest(BingSearchRequest), + ImageRequest(BingImageRequest), +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum BingServiceResponse { + InvalidRequest, + OtherError(String), + SearchResponse(SearchResponse), + ImageResponse(Vec), +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct BingSearchRequest { + pub query: String, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct BingSearchResult { + pub url: String, + pub title: Option, + pub description: Option, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct SearchResponse { + pub results: Vec, + pub blocked: Vec<(String, String)>, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct BingImageRequest { + pub query: String, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct BingImageResult { + pub url: String, +} diff --git a/src/nats/comms.rs b/src/nats/comms.rs new file mode 100644 index 0000000..bf41a95 --- /dev/null +++ b/src/nats/comms.rs @@ -0,0 +1,427 @@ +/* + * asklyphe-common nats/comms.rs + * - communication functions for nats + * + * Copyright (C) 2025 Real Microsoft, LLC + * + * 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, version 3. + * + * 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 . +*/ + +use crate::nats::authservice::{AUTH_REPLY_SERVICE, AUTH_SERVICE}; +use crate::nats::bingservice::{BingServiceResponse, BING_REPLY_SERVICE, BING_SERVICE, GOOGLE_REPLY_SERVICE, GOOGLE_SERVICE}; +use crate::nats::searchservice::{SearchSrvcResponse, SEARCH_REPLY_SERVICE, SEARCH_SERVICE}; +use crate::nats::{authservice, bingservice, searchservice}; +use async_nats::jetstream; +use async_nats::jetstream::consumer::PullConsumer; +use async_nats::jetstream::stream::RetentionPolicy; +use futures::StreamExt; +use log::{debug, error, warn}; +use serde::{Deserialize, Serialize}; +use std::cmp::Ordering; +use std::collections::BTreeMap; +use std::future::Future; +use std::hash::{DefaultHasher, Hash, Hasher}; +use std::sync::Arc; +use std::time::Duration; +use tokio::sync::RwLock; +use ulid::Ulid; + +#[derive(Serialize, Deserialize, Clone)] +pub enum Query { + SearchService(searchservice::SearchSrvcQuery), + BingService(bingservice::BingServiceQuery), + GoogleService(bingservice::BingServiceQuery), + AuthService(authservice::AuthServiceQuery), +} + +impl PartialEq for Query { + fn eq(&self, other: &Self) -> bool { + let a = rmp_serde::to_vec(self).unwrap(); + let b = rmp_serde::to_vec(other).unwrap(); + a == b + } +} + +impl Eq for Query {} +impl PartialOrd for Query { + fn partial_cmp(&self, other: &Self) -> Option { + let a = rmp_serde::to_vec(self).unwrap(); + let b = rmp_serde::to_vec(other).unwrap(); + let mut hash = DefaultHasher::new(); + a.hash(&mut hash); + let a = hash.finish(); + let mut hash = DefaultHasher::new(); + b.hash(&mut hash); + let b = hash.finish(); + a.partial_cmp(&b) + } +} + +impl Ord for Query { + fn cmp(&self, other: &Self) -> Ordering { + let a = rmp_serde::to_vec(self).unwrap(); + let b = rmp_serde::to_vec(other).unwrap(); + let mut hash = DefaultHasher::new(); + a.hash(&mut hash); + let a = hash.finish(); + let mut hash = DefaultHasher::new(); + b.hash(&mut hash); + let b = hash.finish(); + a.cmp(&b) + } +} + +pub enum Service { + SearchService, + BingService, + GoogleService, // mirror of bingservice but with different name + AuthService, +} + +#[derive(Clone)] +pub enum ServiceResponse { + SearchService(searchservice::SearchSrvcResponse), + BingService(bingservice::BingServiceResponse), + AuthService(authservice::AuthServiceResponse), +} + +#[derive(Copy, Clone, Debug)] +pub enum ServiceError { + /// may indicate that the given nats server is down + NatsSubscriptionFailure, + /// may indicate that the given nats server is out of memory, or overloaded + NatsPublishFailure, + /// could mean multiple things, but treat this as nats being down + NatsRecvMessageFailure, + /// usually this one happens if we try to get a service that doesn't exist, but i haven't + /// experienced it lately in production + NatsGetServiceError, + /// never experienced in production, unsure when/if this could occur + SerialiseError, + /// indicates something wrong with a service / backend, check logs + DeserialiseError, +} + +pub fn ulid() -> String { + Ulid::new().to_string() +} + +static SERVICE_CACHE: RwLock> = RwLock::const_new(BTreeMap::new()); +pub const CACHE_PERIOD_MINUTES: u64 = 120; + +// todo: add timeouts +/// use_cache will enable deterministic caching, where when given the same input, the same output *should* happen +/// only use for search queries and such, not anything authentication related +pub async fn query_service( + mut query: Query, + nats: &jetstream::Context, + use_cache: bool, +) -> Result { + { + if use_cache { + let cache = SERVICE_CACHE.read().await; + let mut query = query.clone(); + match &mut query { + Query::SearchService(s) => s.replyto = "".to_string(), + Query::BingService(s) => s.replyto = "".to_string(), + Query::GoogleService(s) => s.replyto = "".to_string(), + Query::AuthService(s) => s.replyto = "".to_string(), + } + if let Some(r) = cache.get(&query).cloned() { + debug!("cache hit"); + return Ok(r); + } else { + debug!("cache miss"); + } + } + } + + let ulid = ulid(); + let service = match &query { + Query::SearchService(_) => SEARCH_SERVICE, + Query::AuthService(_) => AUTH_SERVICE, + Query::BingService(_) => BING_SERVICE, + Query::GoogleService(_) => GOOGLE_SERVICE, + }; + let replyservice = match &query { + Query::SearchService(_) => SEARCH_REPLY_SERVICE, + Query::AuthService(_) => AUTH_REPLY_SERVICE, + Query::BingService(_) => BING_REPLY_SERVICE, + Query::GoogleService(_) => GOOGLE_REPLY_SERVICE, + }; + + let stream = nats + .get_or_create_stream(jetstream::stream::Config { + name: replyservice.to_string(), + subjects: vec![format!("{}.*", replyservice)], + retention: RetentionPolicy::Limits, + max_messages_per_subject: 1, + max_age: Duration::from_secs(60), + ..Default::default() + }) + .await + .map_err(|_| ServiceError::NatsGetServiceError)?; + + let consumer_name = format!("{}-{}", replyservice, ulid); + + // todo: kinda dumb way to do things, maybe change? + let reply_to = format!("{replyservice}.{}", ulid); + match &mut query { + Query::SearchService(q) => q.replyto = reply_to.clone(), + Query::AuthService(q) => q.replyto = reply_to.clone(), + Query::BingService(q) => q.replyto = reply_to.clone(), + Query::GoogleService(q) => q.replyto = reply_to.clone(), + } + + let consumer: PullConsumer = stream + .get_or_create_consumer( + &consumer_name, + jetstream::consumer::pull::Config { + filter_subject: reply_to.clone(), + inactive_threshold: Duration::from_secs(65), // todo: choose a less arbitrary value? + durable_name: None, + ..Default::default() + }, + ) + .await + .map_err(|_| ServiceError::NatsSubscriptionFailure)?; + + // todo! log these errors if they ever occur + let buf = match &query { + Query::SearchService(q) => { + rmp_serde::encode::to_vec(q).map_err(|_| ServiceError::SerialiseError)? + } + Query::AuthService(q) => { + rmp_serde::encode::to_vec(q).map_err(|_| ServiceError::SerialiseError)? + } + Query::BingService(q) => { + rmp_serde::encode::to_vec(q).map_err(|_| ServiceError::SerialiseError)? + } + Query::GoogleService(q) => { + rmp_serde::encode::to_vec(q).map_err(|_| ServiceError::SerialiseError)? + } + }; + + if let Err(e) = nats.publish(service, buf.into()).await { + error!("error occurred while trying to publish to nats!! {e}"); + return Err(ServiceError::NatsPublishFailure); + } + + // todo: log these errors? + let mut messages = consumer + .messages() + .await + .map_err(|_| ServiceError::NatsSubscriptionFailure)?; + + if let Some(Ok(message)) = messages.next().await { + if let Err(e) = message.ack().await { + warn!("failure while acking message! {e}"); + } + + let result = match &query { + Query::SearchService(_) => ServiceResponse::SearchService( + rmp_serde::from_slice::( + message.payload.as_ref(), + ) + .map_err(|_| ServiceError::DeserialiseError)?, + ), + Query::AuthService(_) => ServiceResponse::AuthService( + rmp_serde::from_slice::(message.payload.as_ref()) + .map_err(|_| ServiceError::DeserialiseError)?, + ), + Query::BingService(_) => ServiceResponse::BingService( + rmp_serde::from_slice::(message.payload.as_ref()) + .map_err(|_| ServiceError::DeserialiseError)?, + ), + Query::GoogleService(_) => ServiceResponse::BingService( + rmp_serde::from_slice::(message.payload.as_ref()) + .map_err(|_| ServiceError::DeserialiseError)?, + ), + }; + + if use_cache { + // only write cache if this isn't an error + let mut error = false; + match &result { + ServiceResponse::SearchService(s) => match s { + SearchSrvcResponse::InvalidRequest => { error = true; } + SearchSrvcResponse::OtherError(_) => { error = true; } + _ => {} + } + ServiceResponse::BingService(s) => match s { + BingServiceResponse::InvalidRequest => { error = true; } + BingServiceResponse::OtherError(_) => { error = true; } + _ => {} + } + ServiceResponse::AuthService(_) => { error = true; } // fallback to make sure we absolutely don't cache authservice stuff + } + if !error { + let mut cache = SERVICE_CACHE.write().await; + let mut query = query.clone(); + match &mut query { + Query::SearchService(s) => s.replyto = "".to_string(), + Query::BingService(s) => s.replyto = "".to_string(), + Query::GoogleService(s) => s.replyto = "".to_string(), + Query::AuthService(s) => s.replyto = "".to_string(), + } + cache.insert(query.clone(), result.clone()); + let query_clone = query.clone(); + tokio::spawn(async move { + tokio::time::sleep(Duration::from_secs(60 * CACHE_PERIOD_MINUTES)).await; + let mut cache = SERVICE_CACHE.write().await; + cache.remove(&query_clone); + }); + } + } + + Ok(result) + } else { + error!("couldn't receive message from service {} !!!!", service); + Err(ServiceError::NatsRecvMessageFailure) + } +} + +pub async fn subscribe_service< + F: Fn(Query) -> Fut + Sync + Send + 'static, + Fut: Send + Future, +>( + service: Service, + nats: &jetstream::Context, + process: Arc, +) -> Result<(), ServiceError> { + let service_name = match &service { + Service::SearchService => SEARCH_SERVICE, + Service::AuthService => AUTH_SERVICE, + Service::BingService => BING_SERVICE, + Service::GoogleService => GOOGLE_SERVICE, + }; + + let consumer: PullConsumer = nats + .get_or_create_stream(jetstream::stream::Config { + name: service_name.to_string(), + subjects: vec![service_name.to_string()], + retention: RetentionPolicy::WorkQueue, + ..Default::default() + }) + .await + .map_err(|_| ServiceError::NatsGetServiceError)? + .get_or_create_consumer( + &format!("{}er", service_name), + jetstream::consumer::pull::Config { + durable_name: Some(format!("{}er", service_name)), + filter_subject: service_name.to_string(), + ..Default::default() + }, + ) + .await + .map_err(|_| ServiceError::NatsGetServiceError)?; + + let mut messages = consumer + .messages() + .await + .map_err(|_| ServiceError::NatsSubscriptionFailure)?; + + while let Some(message) = messages.next().await { + if let Err(e) = message { + warn!("error when recv js message! {e}"); + continue; + } + let message = message.unwrap(); + + if let Err(e) = message.ack().await { + warn!("failure while acking message! {e}"); + } + + let message = match &service { + Service::SearchService => { + let res = rmp_serde::from_slice::( + message.payload.as_ref(), + ); + if let Err(e) = res { + warn!("invalid message sent via js!!! {e}"); + continue; + } + Query::SearchService(res.unwrap()) + } + Service::AuthService => { + let res = rmp_serde::from_slice::( + message.payload.as_ref(), + ); + if let Err(e) = res { + warn!("invalid message sent via js!!! {e}"); + continue; + } + Query::AuthService(res.unwrap()) + } + Service::BingService => { + let res = rmp_serde::from_slice::( + message.payload.as_ref(), + ); + if let Err(e) = res { + warn!("invalid message sent via js!!! {e}"); + continue; + } + Query::BingService(res.unwrap()) + } + Service::GoogleService => { + let res = rmp_serde::from_slice::( + message.payload.as_ref(), + ); + if let Err(e) = res { + warn!("invalid message sent via js!!! {e}"); + continue; + } + Query::GoogleService(res.unwrap()) + } + }; + + let replyto = match &message { + Query::SearchService(m) => m.replyto.clone(), + Query::AuthService(m) => m.replyto.clone(), + Query::BingService(m) => m.replyto.clone(), + Query::GoogleService(m) => m.replyto.clone(), + }; + + let nats = nats.clone(); + let process = process.clone(); + tokio::spawn(async move { + let response = process(message).await; + let buf = match &response { + ServiceResponse::SearchService(r) => { + let res = rmp_serde::encode::to_vec(r); + if let Err(e) = res { + warn!("unable to serialise response!!! {e}"); + return; + } + res.unwrap() + } + ServiceResponse::AuthService(r) => { + let res = rmp_serde::encode::to_vec(r); + if let Err(e) = res { + warn!("unable to serialise response!!! {e}"); + return; + } + res.unwrap() + } + ServiceResponse::BingService(r) => { + let res = rmp_serde::encode::to_vec(r); + if let Err(e) = res { + warn!("unable to serialise response!!! {e}"); + return; + } + res.unwrap() + } + }; + + if let Err(e) = nats.publish(replyto, buf.into()).await { + error!("error occurred while trying to publish to nats!! {e}"); + } + }); + } + + Ok(()) +} diff --git a/src/nats/injest.rs b/src/nats/injest.rs new file mode 100644 index 0000000..0abccbd --- /dev/null +++ b/src/nats/injest.rs @@ -0,0 +1,87 @@ +/* + * asklyphe-common nats/injest.rs + * - nats structs for crawler injest service + * + * Copyright (C) 2025 Real Microsoft, LLC + * + * 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, version 3. + * + * 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 . +*/ + +use log::error; +use serde::{Deserialize, Serialize}; +pub const INJEST_SERVICE: &str = "injest"; + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum InjestRequest { + WebsiteCreateRequest(WebsiteCreateRequest), + WebsiteLastParseFinish(WebsiteLastParseFinish), + WebsiteRobotsFlag(WebsiteRobotsFlag), + SetMetawords(SetMetawords), + SetWords(SetWords), + SetLinks(SetLinks), + SetInfo(SetInfo), +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct WebsiteCreateRequest { + pub url: String, + pub last_parse_begin: i64, + pub damping: f64, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct SetInfo { + pub url: String, + pub title: String, + pub description: String, + pub favicon_hash: i64, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct WebsiteLastParseFinish { + pub url: String, + pub last_parse_finish: i64, + pub last_parse_finish_true: i64, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct WebsiteRobotsFlag { + pub url: String, + pub robots: bool, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct Metaword { + pub word: String, + pub property: String, + pub encoded: Vec, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct SetMetawords { + pub url: String, + pub metawords: Vec, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct Word { + pub word: String, + pub encoded: Vec, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct SetWords { + pub url: String, + pub words: Vec, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct Link { + pub from: String, + pub to: String, + pub flags: u8, + pub words: Vec<(String, Vec)> +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct SetLinks { + pub links: Vec, +} \ No newline at end of file diff --git a/src/nats/mod.rs b/src/nats/mod.rs new file mode 100644 index 0000000..806ce3f --- /dev/null +++ b/src/nats/mod.rs @@ -0,0 +1,19 @@ +/* + * asklyphe-common nats/mod.rs + * - module file for nats-related structs and functions + * + * Copyright (C) 2025 Real Microsoft, LLC + * + * 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, version 3. + * + * 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 . +*/ + +pub mod searchservice; +pub mod vorebot; +pub mod injest; +pub mod authservice; +pub mod comms; +pub mod bingservice; \ No newline at end of file diff --git a/src/nats/searchservice.rs b/src/nats/searchservice.rs new file mode 100644 index 0000000..4564e68 --- /dev/null +++ b/src/nats/searchservice.rs @@ -0,0 +1,62 @@ +/* + * asklyphe-common nats/searchservice.rs + * - nats structs for the asklyphe engine + * + * Copyright (C) 2025 Real Microsoft, LLC + * + * 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, version 3. + * + * 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 . +*/ + +use serde::{Deserialize, Serialize}; + +pub const SEARCH_SERVICE: &str = "searchbot"; +pub const SEARCH_REPLY_SERVICE: &str = "searchbotreply"; + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct SearchSrvcQuery { + pub request: SearchSrvcRequest, + /// if using comms::query_service, you don't need to set this + pub replyto: String, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum SearchSrvcRequest { + SearchRequest(SearchRequest), + SiteCountRequest, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub enum SearchSrvcResponse { + InvalidRequest, + OtherError(String), + SearchResponse(SearchResponse), + SiteCountResponse(SiteCountResponse), +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct SiteCountResponse { + pub count: u64, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct SearchRequest { + pub query: String, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct SearchResult { + pub url: String, + pub relevance: f64, + pub title: Option, + pub description: Option, +} +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct SearchResponse { + pub results: Vec, + pub blocked: Vec<(String, String)>, + pub pagerank_time_seconds: f64, + pub total_query_seconds: f64, + pub max_relevance: f64, + pub exact_phrase_found: bool, +} \ No newline at end of file diff --git a/src/nats/vorebot.rs b/src/nats/vorebot.rs new file mode 100644 index 0000000..4c0e0f6 --- /dev/null +++ b/src/nats/vorebot.rs @@ -0,0 +1,24 @@ +/* + * asklyphe-common nats/vorebot.rs + * - nats structs for the asklyphe crawler "vorebot" + * + * Copyright (C) 2025 Real Microsoft, LLC + * + * 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, version 3. + * + * 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 . +*/ + +use serde::{Deserialize, Serialize}; + +pub const VOREBOT_SERVICE: &str = "websiteparse"; +pub const VOREBOT_NEWHOSTNAME_SERVICE: &str = "websiteparse_highpriority"; +pub const VOREBOT_SUGGESTED_SERVICE: &str = "websiteparse_highestpriority"; + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct WebParseRequest { + pub url: String, + pub damping_factor: f32, +} \ No newline at end of file