commit 5072d6216ebac1de4075d44aa0a6bf9a2593a15b equwal <truex@equwal.com> 2026-09-21 02:06:12 -0700 Offer the server conversion, and keep no file past its use - The confirm screen offers "Convert on our server" when the operator has turned it on (SUBPLZ_WEB_CLOUD_ENABLED). The page asks for the credit before the upload, not after it. A start that is refused deletes the upload. - backend/retention.py, once an hour: an upload goes when its job succeeds, or after 24 hours when it did not; results go after 7 days. - /terms.html: terms, privacy, refunds and copyright complaints, with the retention numbers and the contact address read from the server. A payment processor wants these on the site before a shop goes live. - probe_chapters: no output from ffprobe counts as one chapter. On a Windows machine with a non-UTF-8 code page it failed the whole job. - Licence: AGPL-3.0, with the MIT notice of SubPlz in NOTICE.
.env.example | 5 + LICENSE | 662 +++++++++++++++++++++++++++++++++++++++++++++ NOTICE | 38 +++ README.md | 17 ++ backend/api.py | 3 + backend/main.py | 25 +- backend/pricing.py | 2 +- backend/retention.py | 84 ++++++ backend/runner.py | 5 +- backend/settings.py | 7 + frontend/app.js | 81 +++++- frontend/index.html | 17 +- frontend/style.css | 3 + frontend/terms.html | 98 +++++++ tests/test_retention.py | 80 ++++++ tests/test_runner_probe.py | 28 ++ 16 files changed, 1144 insertions(+), 11 deletions(-)
diff --git a/.env.example b/.env.example index 7f9dae1..a492708 100644 --- a/.env.example +++ b/.env.example @@ -55,6 +55,11 @@ SUBPLZ_WEB_BILLING_ENABLED=false # True when fast conversion on this server's hardware is on offer. While it is # false the page sells nothing, whatever BILLING_ENABLED says. SUBPLZ_WEB_CLOUD_ENABLED=false +# Where customers write to. Shown on /terms.html. +SUBPLZ_WEB_CONTACT_EMAIL= +# How long the server keeps a visitor's files (see backend/retention.py). +SUBPLZ_WEB_INPUT_RETENTION_HOURS=24 +SUBPLZ_WEB_ARTIFACT_RETENTION_DAYS=7 # --- accounts & payments --------------------------------------------------- # The origin users reach this on. Sign-in links and Stripe return URLs use it. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..fe6b903 --- /dev/null +++ b/LICENSE @@ -0,0 +1,662 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +<https://www.gnu.org/licenses/>. + diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..75385f5 --- /dev/null +++ b/NOTICE @@ -0,0 +1,38 @@ +SubRead +Copyright (C) 2026 equwal + +This program is free software: you can redistribute it and/or modify it under +the terms of the GNU Affero General Public License, version 3, as published by +the Free Software Foundation. See LICENSE. + +---------------------------------------------------------------------------- +The alignment engine is a port of parts of SubPlz +(https://github.com/kanjieater/SubPlz), which has this licence: + +MIT License + +Copyright (c) 2024 kanjieater + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +---------------------------------------------------------------------------- +The page loads, and does not contain, these libraries (tools/fetch_vendor.py): +ffmpeg.wasm (MIT License) with an FFmpeg core (GPL-2.0-or-later), +Transformers.js (Apache-2.0), ONNX Runtime Web (MIT License), and the Whisper +"tiny" speech model of OpenAI (MIT License). diff --git a/README.md b/README.md index 90f2ed7..cccf988 100644 --- a/README.md +++ b/README.md @@ -337,6 +337,17 @@ A job in the browser costs the server nothing, so it is never counted and never refused. A server job takes its credit at the start. A job that fails or is cancelled gets the credit back. +The page offers the server job on the confirm screen ("Convert on our server"): +the files are uploaded, the job runs on the server, and the result waits in the +list of conversions, so the visitor can close the tab. The page asks for the +credit before the upload, not after it. + +The server does not keep a visitor's files past their use +(`backend/retention.py`, once an hour): uploads go when the job succeeds, or +after 24 hours when it did not; results go after 7 days. `/terms.html` says the +same to the visitor, with the numbers read from the server, and shows +`SUBPLZ_WEB_CONTACT_EMAIL`. + `SUBPLZ_WEB_CLOUD_ENABLED` says that fast conversion is on offer. While it is false the page shows no way to buy credits, whatever `SUBPLZ_WEB_BILLING_ENABLED` says: credits that buy nothing must not be for sale. @@ -434,3 +445,9 @@ restarts at 0% for every chapter. Single files longer than about four hours can exhaust RAM, per upstream. Prefer chaptered `m4b`, or a folder of per-chapter files. + +## Licence + +AGPL-3.0: see `LICENSE`. You may use, change and host this, and you must give +your users the source of what you host. `NOTICE` has the licences of the work +this is built on (SubPlz, whisper.cpp, Whisper). diff --git a/backend/api.py b/backend/api.py index 60b1ee7..553ac1e 100644 --- a/backend/api.py +++ b/backend/api.py @@ -313,6 +313,9 @@ def get_pricing(): "billing_enabled": settings.billing_enabled, "payments_available": settings.payments_configured, "tiers": pricing.TIER_OUTPUTS, + "contact_email": settings.contact_email, + "input_retention_hours": settings.input_retention_hours, + "artifact_retention_days": settings.artifact_retention_days, "plans": pricing.as_dicts(), } diff --git a/backend/main.py b/backend/main.py index bceb993..b6efead 100644 --- a/backend/main.py +++ b/backend/main.py @@ -8,6 +8,8 @@ CORS config and no second server. from __future__ import annotations +import asyncio + import logging import mimetypes import subprocess @@ -89,13 +91,30 @@ async def lifespan(_: FastAPI): "on" if settings.billing_enabled else "off", ) _requeue_interrupted() - with SessionLocal() as s: - from .api import expire_stale_local_jobs - expire_stale_local_jobs(s) + sweeper = asyncio.create_task(_housekeeping()) yield + sweeper.cancel() queue.shutdown() +async def _housekeeping() -> None: + """Once an hour: let go of abandoned browser jobs, and delete files past their time.""" + from . import retention + from .api import expire_stale_local_jobs + + while True: + def once() -> None: + with SessionLocal() as s: + expire_stale_local_jobs(s) + retention.sweep(s) + + try: + await asyncio.to_thread(once) # deleting a book's files is slow; do not hold the site up + except Exception: # noqa: BLE001 - housekeeping must not take the site down + log.exception("housekeeping failed") + await asyncio.sleep(3600) + + app = FastAPI( title="SubPlz Web", summary="Drag an audiobook and an epub in; get split-timed SRT subtitles out.", diff --git a/backend/pricing.py b/backend/pricing.py index 8f1ac90..4e7535d 100644 --- a/backend/pricing.py +++ b/backend/pricing.py @@ -77,7 +77,7 @@ DEFAULT_PLANS: list[Plan] = [ name="One book", credits=1, price_cents=499, - blurb="One book on our GPU: minutes, from any device.", + blurb="One book on our server, from any device.", ), Plan( id="pack5", diff --git a/backend/retention.py b/backend/retention.py new file mode 100644 index 0000000..e2296dc --- /dev/null +++ b/backend/retention.py @@ -0,0 +1,84 @@ +"""What the server keeps, and for how long. + +A server job brings an audiobook and a book onto this machine. They are the +visitor's files, often bought ones, and the disk is small. So nothing stays +longer than it is of use: + + uploaded files deleted when the job succeeds (runner.py). A job that was + never started, failed or was cancelled keeps them for + `input_retention_hours`, so the visitor can fix the language + and try again; then they go too. + results subtitles and videos stay for `artifact_retention_days`, + then they are deleted. The row of the job stays, so the list + still says what was converted. + +Jobs that ran in the visitor's browser have no files here, only the subtitles +the browser sent back; those follow the rule for results. +""" + +from __future__ import annotations + +import logging +import shutil +from datetime import timedelta + +from sqlalchemy.orm import Session + +from .db import Artifact, Job, JobStatus, utcnow +from .runner import Paths +from .settings import settings +from .storage import storage + +log = logging.getLogger("subplz-web.retention") + +_IDLE = [JobStatus.draft, JobStatus.failed, JobStatus.canceled] + + +def sweep(session: Session) -> dict[str, int]: + """Delete what is past its time. Safe to run at any moment, and again.""" + now = utcnow() + done = {"inputs": 0, "drafts": 0, "results": 0} + + old_idle = ( + session.query(Job) + .filter(Job.local == 0, Job.status.in_(_IDLE), + Job.created_at < now - timedelta(hours=settings.input_retention_hours)) + .all() + ) + for job in old_idle: + root = Paths.for_job(job.id).root + if root.exists(): + shutil.rmtree(root, ignore_errors=True) + done["inputs"] += 1 + _delete_stored(job.id) + if job.status == JobStatus.draft: + # Never started: nothing to show for it. + session.delete(job) + done["drafts"] += 1 + + old_results = ( + session.query(Job) + .join(Artifact, Artifact.job_id == Job.id) + .filter(Job.status == JobStatus.succeeded, + Job.finished_at < now - timedelta(days=settings.artifact_retention_days)) + .distinct() + .all() + ) + for job in old_results: + _delete_stored(job.id) + shutil.rmtree(Paths.for_job(job.id).root, ignore_errors=True) + session.query(Artifact).filter(Artifact.job_id == job.id).delete() + job.stage = f"Files deleted after {settings.artifact_retention_days} days" + done["results"] += 1 + + session.commit() + if any(done.values()): + log.info("retention sweep: %s", done) + return done + + +def _delete_stored(job_id: str) -> None: + try: + storage.delete_prefix(job_id) + except Exception as exc: # noqa: BLE001 - the next sweep tries again + log.warning("could not delete stored files of %s: %s", job_id, exc) diff --git a/backend/runner.py b/backend/runner.py index 4bf79e2..58430f6 100644 --- a/backend/runner.py +++ b/backend/runner.py @@ -263,9 +263,10 @@ def probe_chapters(path: Path) -> int: out = subprocess.run( ["ffprobe", "-v", "error", "-show_chapters", "-print_format", "json", str(path)], - capture_output=True, text=True, timeout=120, check=True, + capture_output=True, text=True, encoding="utf-8", errors="replace", + timeout=120, check=True, ) - return max(1, len(json.loads(out.stdout).get("chapters", []))) + return max(1, len(json.loads(out.stdout or "{}").get("chapters", []))) except (subprocess.SubprocessError, ValueError, OSError): return 1 diff --git a/backend/settings.py b/backend/settings.py index 3fd6c78..9ba471c 100644 --- a/backend/settings.py +++ b/backend/settings.py @@ -54,6 +54,10 @@ class Settings(BaseSettings): # Presigned-URL lifetime for s3 downloads. download_url_ttl_seconds: int = 3600 + # How long the server keeps a visitor's files. See retention.py. + input_retention_hours: int = 24 + artifact_retention_days: int = 7 + # SQLite locally; set to a postgresql+psycopg:// URL in production. database_url: str = "" @@ -64,6 +68,9 @@ class Settings(BaseSettings): # is false the site sells nothing, whatever billing_enabled says: credits # that buy nothing must not be for sale. cloud_enabled: bool = False + # Where customers write to: shown on the terms page and in the footer. The + # payment processor wants one on the site before it lets a shop go live. + contact_email: str = "" # Off on localhost so nothing blocks you; flip on for the public release. billing_enabled: bool = False diff --git a/frontend/app.js b/frontend/app.js index 77ad6f8..54bc4cd 100644 --- a/frontend/app.js +++ b/frontend/app.js @@ -9,6 +9,7 @@ const el = { confirm: $('confirm'), cAudio: $('c-audio'), cText: $('c-text'), language: $('language'), detected: $('detected'), splitnote: $('splitnote'), start: $('start'), discard: $('discard'), eta: $('eta'), + cloud: $('cloud'), cloudNote: $('cloud-note'), startCloud: $('start-cloud'), jobsSection: $('jobs-section'), jobs: $('jobs'), quota: $('quota'), freetier: $('freetier'), staged: $('staged'), dzTitle: $('dz-title'), match: $('match'), matchBadge: $('match-badge'), @@ -334,11 +335,87 @@ async function showConfirm() { el.start.textContent = saved?.doneUntil && !saved.complete ? 'Continue' : 'Start'; el.confirm.hidden = false; el.start.disabled = false; + renderCloudOffer(); el.confirm.scrollIntoView({ behavior: 'smooth', block: 'nearest' }); } el.discard.addEventListener('click', () => { clearError(); resetToDrop(); }); +/* ---------------- the cloud: the same job, on the server's hardware ---------------- */ + +function renderCloudOffer() { + const a = account; + el.cloud.hidden = !a?.cloud_available; + if (el.cloud.hidden) return; + const price = !a.billing_enabled ? '' + : a.subscribed ? ' Included in your plan.' + : a.credits > 0 ? ` One credit; you have ${a.credits}.` + : ' One credit.'; + el.cloudNote.textContent = + 'For a phone, an old computer, or a tab you want to close: the files are uploaded, the work is done ' + + 'there, and the result waits for you on this page. The files are deleted after the job.' + price; + el.startCloud.disabled = false; +} + +el.startCloud.addEventListener('click', () => { + if (!draft || running) return; + clearError(); + // Ask for the credit before the upload, not after an hour of it. + if (account.billing_enabled && !account.cloud_allowed) { + openPricing('A conversion on our server takes one credit. In this tab it is free, without limit.'); + return; + } + const { audio, book, cover } = draft; + const language = el.language.value; + el.confirm.hidden = true; + el.uploading.hidden = false; + el.upbar.style.width = '0%'; + el.uptext.textContent = 'Starting…'; + + const form = new FormData(); + for (const f of [...audio, book]) form.append('files', f, f.name); + if (cover && signedIn) form.append('files', cover, cover.name); + + const back = (message) => { el.uploading.hidden = true; el.confirm.hidden = false; showError(message); }; + // XHR and not fetch: it reports upload progress, and these files are big. + const xhr = new XMLHttpRequest(); + xhr.open('POST', '/api/uploads'); + xhr.withCredentials = true; + xhr.upload.onprogress = (e) => { + if (!e.lengthComputable) return; + const pct = Math.round((e.loaded / e.total) * 100); + el.upbar.style.width = `${pct}%`; + el.uptext.textContent = pct < 100 ? `${pct}% — ${fmtBytes(e.loaded)} of ${fmtBytes(e.total)}` : 'Checking the book…'; + }; + xhr.onerror = () => back('The upload failed: the connection to the server was lost.'); + xhr.onload = async () => { + let body = null; + try { body = JSON.parse(xhr.responseText); } catch { /* handled below */ } + if (xhr.status < 200 || xhr.status >= 300 || !body?.job) { + back(typeof body?.detail === 'string' ? body.detail : `The upload failed (${xhr.status}).`); + return; + } + try { + await api(`/api/jobs/${body.job.id}/start`, { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ language }), + }); + } catch (e) { + // The files are on the server but nothing runs: do not leave them there. + api(`/api/jobs/${body.job.id}`, { method: 'DELETE' }).catch(() => {}); + if (e.status === 402) { el.uploading.hidden = true; el.confirm.hidden = false; openPricing(e.message); } + else back(e.message); + return; + } + resetToDrop(); + toast('The server has the book. You can close this tab; the result will be under "Your conversions" on this page.', 12000); + refreshJobs(); + refreshAccount(); + }; + xhr.send(form); +}); + /* ---------------- the job, in this tab ---------------- */ let running = null; // { job, serverId } @@ -708,7 +785,7 @@ el.picker.addEventListener('change', () => { async function openPricing(why) { el.pricingWhy.textContent = why || - 'In this tab a conversion is free, without limit. A credit converts a book on our GPU: minutes and not hours, from any device.'; + 'In this tab a conversion is free, without limit. A credit converts a book on our server: from any device, and you can close the tab.'; el.plans.innerHTML = '<p class="muted">Loading…</p>'; if (!el.pricingDialog.open) el.pricingDialog.showModal(); @@ -763,7 +840,7 @@ async function checkout(planId, btn) { } el.buyBtn.addEventListener('click', () => openPricing( - 'One credit converts one book on our GPU: minutes and not hours, from any device.')); + 'One credit converts one book on our server: from any device, and you can close the tab.')); el.portalBtn.addEventListener('click', async () => { try { diff --git a/frontend/index.html b/frontend/index.html index 2bc903d..da5d65b 100644 --- a/frontend/index.html +++ b/frontend/index.html @@ -139,6 +139,11 @@ <button id="discard" class="ghost">Discard</button> </div> <p class="muted small" id="eta"></p> + + <div id="cloud" class="cloud" hidden> + <p><strong>Or let our server do it.</strong> <span id="cloud-note"></span></p> + <button id="start-cloud" class="ghost">Convert on our server</button> + </div> </section> <!-- step 3: the job, running in this tab --> @@ -170,6 +175,11 @@ speech model <a href="https://github.com/openai/whisper" target="_blank" rel="noopener">Whisper</a>. Every line of text comes from the book you upload, so names and spelling stay right. </p> + <p class="muted small"> + <a href="/terms.html">Terms, privacy and refunds</a> · + <a href="https://github.com/equwal/subplz-web" target="_blank" rel="noopener">Source code</a> · + <a href="https://github.com/equwal/subread-android/releases/latest" target="_blank" rel="noopener">Android app</a> + </p> </footer> <dialog id="signin-dialog" class="modal"> @@ -186,12 +196,13 @@ <dialog id="pricing-dialog" class="modal wide"> <form method="dialog"><button class="modal-x" aria-label="Close">×</button></form> - <h2>Get the YouTube video</h2> + <h2>Credits for our server</h2> <p id="pricing-why" class="muted"></p> <div id="plans" class="plans"></div> <p class="muted small" id="pricing-foot"> - Paid through Stripe; we never see your card. One credit is one book with - every output, and credits never expire. Paying also creates your account, + Paid through Stripe; we never see your card. One credit converts one book + on our server, with every output. Credits never expire, and a job that + fails gives its credit back. In this tab a conversion is always free. Paying also creates your account, under the email you give Stripe. </p> </dialog> diff --git a/frontend/style.css b/frontend/style.css index 101558b..cae96bb 100644 --- a/frontend/style.css +++ b/frontend/style.css @@ -300,6 +300,9 @@ button.compact { padding: 6px 12px; font-size: 13px; } } .tag.free { background: var(--ok-soft); color: var(--ok); } +.cloud { margin-top: 18px; padding-top: 14px; border-top: 1px solid var(--line); font-size: 14px; } +.cloud p { margin: 0 0 10px; } + /* ---------- dialogs ---------- */ dialog.modal { border: 1px solid var(--line); border-radius: var(--radius); diff --git a/frontend/terms.html b/frontend/terms.html new file mode 100644 index 0000000..3dec461 --- /dev/null +++ b/frontend/terms.html @@ -0,0 +1,98 @@ +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<title>Terms, privacy and refunds — SubRead</title> +<link rel="stylesheet" href="/style.css"> +<style> + main.legal { max-width: 720px; margin: 0 auto; padding: 24px 20px 60px; } + main.legal h2 { margin-top: 32px; } + main.legal li { margin: 6px 0; } +</style> +</head> +<body> +<main class="legal"> + <p><a href="/">← SubRead</a></p> + <h1>Terms, privacy and refunds</h1> + <p class="muted">Short, and meant to be read. Contact: <span class="contact">see below</span>.</p> + + <h2>What this is</h2> + <p>SubRead lines an audiobook up with its ebook and gives you timed subtitles, videos and a + read-along book. All of the code is public, and you may run it yourself.</p> + <ul> + <li><strong>In your browser (free):</strong> the work is done on your machine. Your audio and + your book are not uploaded. The server gets the names and sizes of the files and the + finished subtitles, so that this page can list your conversions.</li> + <li><strong>On our server (paid):</strong> you upload the audio and the book, and the server + does the work. One credit converts one book.</li> + </ul> + + <h2>Your files</h2> + <ul> + <li>Use only files that you have the right to use. You keep all rights in them. We claim none.</li> + <li>Files uploaded for a server conversion are deleted when the job succeeds. If a job fails, + is cancelled, or is never started, they are kept for <span class="input-hours">24</span> hours + so that you can try again, and then deleted.</li> + <li>Results (subtitles, videos) are kept for <span class="result-days">7</span> days and then + deleted. Download what you want to keep.</li> + <li>Nobody looks at your files, they are not shared, and they are not used to train anything. + There is no public library of uploads.</li> + </ul> + + <h2>Payments and refunds</h2> + <ul> + <li>Payments are taken by Stripe. We never see your card.</li> + <li>Credits do not expire.</li> + <li>A job that fails or that you cancel gives its credit back by itself.</li> + <li>If a result is not usable (for example the subtitles do not match the book), write to us + within 14 days and we return the credit or the money, as you choose. Try the free + conversion in your browser first: it uses the same method, and it shows whether your + book and your audio match.</li> + <li>Unused credits are refunded on request within 14 days of the purchase.</li> + </ul> + + <h2>Accounts and privacy</h2> + <ul> + <li>Without an account, a cookie keeps your conversions together. It holds a random identifier + and nothing else. There are no advertising or analytics cookies.</li> + <li>An account is an email address. You get one when you pay (Stripe collects the address) or + when you ask for a sign-in link. There are no passwords. We use the address for sign-in + links and for answers to your messages, and for nothing else.</li> + <li>We store: your email address (if you gave one), your credits and purchases, and the list of + your conversions (file names, sizes, language, times). Write to us to have all of it deleted.</li> + <li>The server keeps ordinary web logs (IP address, time, page) for a short time, for security.</li> + </ul> + + <h2>Copyright complaints</h2> + <p>We do not publish or share what users upload, and uploads are deleted as said above. If you + believe that material on this service infringes your copyright, write to the contact address + with: the work, where it is on this service, your contact details, a statement that you act in + good faith for the owner of the right, and your signature. We remove what the notice properly + names, and we close the accounts of repeat infringers.</p> + + <h2>No warranty</h2> + <p>The subtitles are made by a machine that matches a rough transcript to your book. They are + usually good and never perfect. The service is given as it is, without warranty. Our liability + is limited to what you paid in the 12 months before the claim. Nothing here limits rights that + the law of your country gives you as a consumer.</p> + + <h2>Contact</h2> + <p><span class="contact">No contact address is set for this server.</span></p> +</main> +<script type="module"> + const site = await (await fetch('/api/pricing')).json(); + const put = (cls, value) => document.querySelectorAll('.' + cls).forEach((el) => { el.textContent = value; }); + if (site.contact_email) { + document.querySelectorAll('.contact').forEach((el) => { + const a = document.createElement('a'); + a.href = 'mailto:' + site.contact_email; + a.textContent = site.contact_email; + el.replaceChildren(a); + }); + } + put('input-hours', site.input_retention_hours); + put('result-days', site.artifact_retention_days); +</script> +</body> +</html> diff --git a/tests/test_retention.py b/tests/test_retention.py new file mode 100644 index 0000000..2086ce0 --- /dev/null +++ b/tests/test_retention.py @@ -0,0 +1,80 @@ +"""Uploaded books and results do not stay on the server past their time.""" + +from __future__ import annotations + +from datetime import timedelta + +from backend import retention +from backend.db import Artifact, Job, JobStatus, SessionLocal, utcnow +from backend.runner import Paths +from backend.storage import storage + +from .conftest import get_job_row, make_job + + +def age(job_id: str, **delta) -> None: + with SessionLocal() as s: + job = s.get(Job, job_id) + job.created_at = utcnow() - timedelta(**delta) + job.finished_at = utcnow() - timedelta(**delta) + s.commit() + + +def stage_inputs(job_id: str): + paths = Paths.for_job(job_id) + paths.create() + (paths.inp / "book.m4b").write_bytes(b"audio") + return paths + + +def sweep() -> dict: + with SessionLocal() as s: + return retention.sweep(s) + + +def test_a_failed_job_keeps_its_upload_for_a_day_and_no_longer(client): + job_id = make_job(client, JobStatus.failed) + paths = stage_inputs(job_id) + + age(job_id, hours=23) + sweep() + assert (paths.inp / "book.m4b").exists() # still there for another try + + age(job_id, hours=25) + assert sweep()["inputs"] == 1 + assert not paths.root.exists() + assert get_job_row(job_id).status == JobStatus.failed # the list still shows it + + +def test_an_upload_that_was_never_started_goes_away_with_its_job(client): + job_id = make_job(client) # a draft + paths = stage_inputs(job_id) + age(job_id, hours=25) + assert sweep()["drafts"] == 1 + assert not paths.root.exists() and get_job_row(job_id) is None + + +def test_results_are_deleted_after_a_week_and_the_job_says_so(client): + fresh = make_job(client, JobStatus.succeeded, with_files=True) + old = make_job(client, JobStatus.succeeded, with_files=True) + age(fresh, days=6) + age(old, days=8) + + assert sweep()["results"] == 1 + assert client.get(f"/api/jobs/{fresh}/files/srt").status_code == 200 + assert client.get(f"/api/jobs/{old}/files/srt").status_code == 404 + job = client.get(f"/api/jobs/{old}").json() + assert job["artifacts"] == [] and "deleted after 7 days" in job["stage"] + with SessionLocal() as s: + assert s.query(Artifact).filter(Artifact.job_id == old).count() == 0 + assert not storage.exists(f"{old}/book.en.srt") + + assert sweep() == {"inputs": 0, "drafts": 0, "results": 0} # and once is enough + + +def test_running_jobs_are_left_alone(client): + job_id = make_job(client, JobStatus.running) + paths = stage_inputs(job_id) + age(job_id, days=30) + sweep() + assert (paths.inp / "book.m4b").exists() diff --git a/tests/test_runner_probe.py b/tests/test_runner_probe.py new file mode 100644 index 0000000..a9b26c1 --- /dev/null +++ b/tests/test_runner_probe.py @@ -0,0 +1,28 @@ +"""probe_chapters must never fail a job: the chapter count only scales a progress bar.""" + +from __future__ import annotations + +import subprocess +from pathlib import Path + +from backend import runner + + +def test_no_output_from_ffprobe_counts_as_one_chapter(monkeypatch): + # On a Windows machine with a non-UTF-8 code page, the reader thread of + # subprocess fails to decode ffprobe's output and leaves stdout as None. + # json.loads(None) raises TypeError, which failed the whole job: + # "the JSON object must be str, bytes or bytearray, not NoneType". + monkeypatch.setattr( + subprocess, "run", + lambda *a, **k: subprocess.CompletedProcess(a, 0, stdout=None, stderr=None), + ) + assert runner.probe_chapters(Path("book.mp3")) == 1 + + +def test_chapters_are_counted(monkeypatch): + monkeypatch.setattr( + subprocess, "run", + lambda *a, **k: subprocess.CompletedProcess(a, 0, stdout='{"chapters": [{}, {}, {}]}', stderr=""), + ) + assert runner.probe_chapters(Path("book.m4b")) == 3