commit d3c82fdff8298c30a2cbd48aed646dab36014599 Author: Felitendo Date: Sun Aug 16 19:48:54 2026 +0200 middleclick-autoscroll 1.0.0 Middle-click autoscroll for every Chromium-based application on the system: Electron and CEF applications, Chromium-based browsers, Flatpaks, Spotify and Steam, plus anything installed later. The flag goes into an Arch wrapper's -flags.conf where one exists, and into a shadowing desktop entry where it does not. Steam gets its web helper script patched and -noverifyfiles on its launcher, because it restores its own files otherwise. Every change is recorded so it can be taken back exactly. diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..dfe0770 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto detect text files and perform LF normalization +* text=auto diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..874ad4a --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +# build artifacts +po/*.mo +doc/*.1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is 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. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + 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. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + 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 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. Use with the GNU Affero General Public License. + + 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 Affero 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 special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 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 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 General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + 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 GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..403c54b --- /dev/null +++ b/Makefile @@ -0,0 +1,114 @@ +# middleclick-autoscroll - build and install +# +# Everything here is plain shell; "building" only means compiling the gettext +# catalogs and rendering the man page. Both targets degrade to a no-op when +# msgfmt/scdoc are missing, so the tree stays usable for development without +# the build dependencies installed. + +# Overridable so a packager can pass the version it is actually building +# (`make VERSION=$pkgver`). The literal below is the fallback for builds +# straight from a checkout, and is what a release tag has to carry. +VERSION ?= 1.0.0 + +PREFIX ?= /usr +DESTDIR ?= +BINDIR ?= $(PREFIX)/bin +DATADIR ?= $(PREFIX)/share +LIBDIR ?= $(DATADIR)/middleclick-autoscroll/lib +LOCALEDIR ?= $(DATADIR)/locale +MANDIR ?= $(DATADIR)/man +USERUNITDIR ?= $(PREFIX)/lib/systemd/user + +LINGUAS := de +MOFILES := $(patsubst %,po/%.mo,$(LINGUAS)) +MANPAGE := doc/middleclick-autoscroll.1 + +LIBS := $(wildcard src/lib/*.sh) + +MSGFMT := $(shell command -v msgfmt 2>/dev/null) +SCDOC := $(shell command -v scdoc 2>/dev/null) + +.PHONY: all build install uninstall check clean + +all: build + +build: $(MOFILES) $(MANPAGE) + +po/%.mo: po/%.po +ifdef MSGFMT + $(MSGFMT) --check --output-file=$@ $< +else + @echo "msgfmt not found - skipping $@" +endif + +$(MANPAGE): doc/middleclick-autoscroll.1.scd +ifdef SCDOC + $(SCDOC) < $< > $@ +else + @echo "scdoc not found - skipping $@" +endif + +# Syntax-check every shell file, and run shellcheck when it is available. +check: + @set -e; for f in src/middleclick-autoscroll $(LIBS); do \ + bash -n "$$f" && echo "ok $$f"; \ + done + @if command -v shellcheck >/dev/null 2>&1; then \ + shellcheck -x -e SC1090,SC1091 src/middleclick-autoscroll $(LIBS); \ + echo "ok shellcheck"; \ + else \ + echo "shellcheck not found - skipped"; \ + fi + @if command -v desktop-file-validate >/dev/null 2>&1; then \ + echo "ok desktop-file-validate (nothing to check)"; \ + fi + +install: build + # executable + install -Dm755 src/middleclick-autoscroll \ + "$(DESTDIR)$(BINDIR)/middleclick-autoscroll" + + # shell libraries + install -d "$(DESTDIR)$(LIBDIR)" + install -Dm644 -t "$(DESTDIR)$(LIBDIR)" $(LIBS) + + # the version and the resolved paths are baked in at install time + sed -i -e 's|@VERSION@|$(VERSION)|g' \ + -e 's|@LIBDIR@|$(LIBDIR)|g' \ + -e 's|@LOCALEDIR@|$(LOCALEDIR)|g' \ + "$(DESTDIR)$(BINDIR)/middleclick-autoscroll" \ + "$(DESTDIR)$(LIBDIR)"/*.sh + + # user units: the watcher, and the one-shot it starts + install -Dm644 res/systemd/middleclick-autoscroll.service \ + "$(DESTDIR)$(USERUNITDIR)/middleclick-autoscroll.service" + install -Dm644 res/systemd/middleclick-autoscroll.path \ + "$(DESTDIR)$(USERUNITDIR)/middleclick-autoscroll.path" + sed -i -e 's|@BINDIR@|$(BINDIR)|g' \ + "$(DESTDIR)$(USERUNITDIR)/middleclick-autoscroll.service" + + # translations + @for l in $(LINGUAS); do \ + if [ -f "po/$$l.mo" ]; then \ + install -Dm644 "po/$$l.mo" \ + "$(DESTDIR)$(LOCALEDIR)/$$l/LC_MESSAGES/middleclick-autoscroll.mo"; \ + fi; \ + done + + # documentation + @if [ -f $(MANPAGE) ]; then \ + install -Dm644 $(MANPAGE) "$(DESTDIR)$(MANDIR)/man1/middleclick-autoscroll.1"; \ + fi + install -Dm644 README.md \ + "$(DESTDIR)$(DATADIR)/doc/middleclick-autoscroll/README.md" + +uninstall: + rm -f "$(DESTDIR)$(BINDIR)/middleclick-autoscroll" + rm -rf "$(DESTDIR)$(DATADIR)/middleclick-autoscroll" + rm -f "$(DESTDIR)$(USERUNITDIR)/middleclick-autoscroll.service" + rm -f "$(DESTDIR)$(USERUNITDIR)/middleclick-autoscroll.path" + rm -f "$(DESTDIR)$(MANDIR)/man1/middleclick-autoscroll.1" + rm -rf "$(DESTDIR)$(DATADIR)/doc/middleclick-autoscroll" + +clean: + rm -f po/*.mo $(MANPAGE) diff --git a/README.md b/README.md new file mode 100644 index 0000000..4b4b48d --- /dev/null +++ b/README.md @@ -0,0 +1,191 @@ +# middleclick-autoscroll + +Middle-click autoscroll — hold the middle mouse button, move the pointer, the +page scrolls — for every Chromium-based application on the system. Discord, +Vesktop, Equibop, VS Code, Obsidian, Signal, Spotify, Steam, Chromium-based +browsers, and whatever gets installed next week. + +```bash +paru -S middleclick-autoscroll +middleclick-autoscroll enable +``` + +That is the whole setup. Nothing else has to be configured, and no file has to +be edited. + +## Why this needs a program at all + +Blink — the engine inside Chromium, Electron and CEF — has had Windows-style +autoscroll for years. On Linux it is switched off, because middle click is +already taken by primary-selection paste. One command line argument turns it +back on: + +``` +--enable-blink-features=MiddleClickAutoscroll +``` + +Getting that argument into one application is a five-minute job. Getting it into +all of them, in a way that survives the next package upgrade, is not: + +- Some applications read a flag file, some don't. +- Some ship their own copy of Electron, some use the system one. +- Flatpaks see none of the host's configuration. +- An application that starts itself at login uses a different entry than the one + in the menu, and Discord launched at login used to behave differently from + Discord launched by hand. +- Steam takes no arguments for its interface at all, and puts back any file you + change. +- Every upgrade can undo the lot. + +## The interface + +`middleclick-autoscroll` on its own: + +``` + Middle-Click Autoscroll + + Autoscroll ON + + Applications covered 14 of 15 + Not identified 1 - see the applications list + Steam ON + New applications ON + Last applied 3 minutes ago + + Applications pick this up the next time they are started. + + [1] Turn autoscroll on or off + [2] Apply now + [3] Applications + [4] Settings + [q] Quit +``` + +**[3] Applications** lists everything that was found, how each one is handled, +and lets a single application be switched off — or an unrecognised one switched +on — with the space bar: + +``` + Applications + + ▸ Vesktop on (flag file) + Discord on (flag file) + Code - OSS on (flag file) + Obsidian on (flag file) + Signal on (flag file) + Spotify on (launcher) + Steam on (Steam) + Cursor cannot tell +``` + +**[4] Settings** has the categories — Electron and CEF applications, browsers, +Flatpaks, autostart entries, Steam, Spotify, whether to watch for new +applications, and a field for extra Chromium arguments if you want any. + +There is a configuration file behind all of this. You are never asked to open +it. + +## Where the argument actually goes + +Two routes, picked per application. + +| | | +|---|---| +| **Flag file** | Arch's Electron and Chromium wrappers read extra arguments from `~/.config/-flags.conf`. This is the good one: it is the supported way to pass arguments, it survives package upgrades untouched, and it applies to a launch from a terminal as much as one from the menu. | +| **Desktop entry** | For applications that ship their own binary with no wrapper, and for Flatpaks, a copy of the entry with the argument appended goes into `~/.local/share/applications`, where it shadows the system one. | + +Entries that already live in `~/.local/share/applications` — AppImages, web app +shortcuts — are edited in place and the original is kept. So are the entries in +`~/.config/autostart`, so an application that starts itself at login gets the +same treatment as one started from the menu. + +An `--enable-blink-features` that is already there is **extended**, never +repeated. Chromium keeps only the last occurrence of that option, so a second +one would silently switch off whatever the first one enabled. + +## Steam + +Steam's interface is CEF and supports the feature perfectly well, but Steam +builds the command line for its web helper itself and offers no way to add to +it. The only place an argument fits is the script that starts the helper, inside +Steam's own installation: + +``` +~/.local/share/Steam/ubuntu12_64/steamwebhelper_sniper_wrap.sh +``` + +Steam checksums that script at every start and restores it when it differs, so +its launcher entry also gets `-noverifyfiles`. **The trade-off is real**: with +verification off, Steam no longer repairs a damaged installation by itself. That +is why Steam is a switch of its own rather than part of the general handling — +turn it off in the settings and Steam is left completely alone. + +The script comes back on every client update. The watcher notices and puts the +patch back. + +Starting Steam from a terminal without `-noverifyfiles` undoes it for that one +session; the next start from the menu has it again. + +## Applications installed later + +A systemd user path unit watches every directory a launcher can appear in — +`/usr/share/applications`, the Flatpak exports, `~/.local/share/applications`, +`~/.config/autostart` — plus Steam's helper script. Anything new is handled +within a second of being installed, whether it came from pacman, the AUR, +Flatpak or an AppImage manager. There is no hook to install per package manager. + +## What it will not guess + +An AppImage keeps its payload in a compressed filesystem, so there is no way to +tell from the outside whether Chromium is in there. Those show up as **cannot +tell** and are left alone until you switch them on from the applications screen. + +Detection is deliberately conservative everywhere else too. A wrong "yes" would +append an unknown argument to something that is not Chromium, and plenty of +programs treat an unrecognised argument as a file name to open. + +## Undoing it + +```bash +middleclick-autoscroll disable +``` + +Every change is recorded in a ledger as it is made, and `disable` replays it +backwards: generated entries are deleted, edited files are restored from their +backups, flag files that only ever contained our line are removed, and a flag +file that was merged into loses exactly the one feature that was added to it. +Files that were not touched by this program are not touched by it now either. + +Run this before uninstalling the package. + +## Commands + +| | | +|---|---| +| `middleclick-autoscroll` | the menu above | +| `… enable` | turn it on, apply, start watching | +| `… disable` | turn it off and put everything back | +| `… apply` | apply to anything new (this is what the watcher calls) | +| `… status` | what is covered | +| `… list` | every application that was found and how it is handled | + +See `man middleclick-autoscroll` for the details. + +## Requirements + +Arch or an Arch derivative (CachyOS, EndeavourOS, Manjaro), bash, systemd for +the watcher. Nothing outside your home directory is ever written to, and running +it as root is refused. + +## Building from source + +```bash +make +sudo make install +``` + +`make check` runs `bash -n` and, if installed, `shellcheck` over every script. + +## License + +GPL-3.0-or-later. diff --git a/doc/middleclick-autoscroll.1.scd b/doc/middleclick-autoscroll.1.scd new file mode 100644 index 0000000..618c3dd --- /dev/null +++ b/doc/middleclick-autoscroll.1.scd @@ -0,0 +1,142 @@ +middleclick-autoscroll(1) + +# NAME + +middleclick-autoscroll - middle-click autoscroll for Chromium-based applications + +# SYNOPSIS + +*middleclick-autoscroll* [_command_] + +# DESCRIPTION + +Blink, the engine inside Chromium, Electron and CEF, implements Windows-style +autoscroll: hold the middle mouse button and the page scrolls with the pointer. +On Linux it is switched off, because middle click is taken by primary-selection +paste. It can be turned back on with *--enable-blink-features=MiddleClickAutoscroll* +on the command line. + +*middleclick-autoscroll* finds every Chromium-based application on the system +and puts that argument somewhere the application will actually read it, then +keeps doing so for anything installed later. + +Run without a command it shows an interactive menu. Everything it can be told +is reachable from there; the configuration file behind it does not need to be +edited by hand. + +Nothing outside the user's home directory is written to, and running it as root +is refused. + +# COMMANDS + +*enable* + Turn autoscroll on, apply it to everything installed, and start watching + for new applications. + +*disable* + Turn it off and put every file that was changed back the way it was. + +*apply* + Apply to anything that has appeared since the last run. This is what the + watcher calls; running it by hand is only needed when the watcher is off. + +*status* + How many applications are covered, whether Steam is patched, and when the + last run was. + +*list* + Every Chromium-based application that was found, and how each one is + handled. + +*-h*, *--help* + Show a summary of the commands. + +*-V*, *--version* + Show the version. + +# HOW THE ARGUMENT GETS IN + +Two ways, chosen per application. + +*Flag file* + Arch's Electron and Chromium wrappers read extra arguments from + _$XDG_CONFIG_HOME/-flags.conf_. This is the preferred route: it is + the supported way to pass arguments, it survives package upgrades, and it + applies to a launch from a terminal as much as one from the menu. An + *--enable-blink-features* line that is already in the file is extended + rather than duplicated - Chromium keeps only the last occurrence of that + option, so a second one would switch the first one off. + +*Desktop entry* + For applications that ship their own binary with no wrapper, and for + Flatpaks, a copy of the desktop entry with the argument appended is written + to _~/.local/share/applications_, where it shadows the system one. Entries + that already live there - AppImages, web app shortcuts - are edited in + place, with the original kept. Every generated entry is marked with + *X-MCA-Generated*; an entry that is not marked is somebody else's and is + left alone. + +Programs that start themselves at login write their own entry into +_~/.config/autostart_ pointing straight at their binary, bypassing the menu +entry entirely. Those are patched in place as well. + +# STEAM + +Steam's interface is CEF and supports the feature, but Steam builds the command +line for its web helper itself. The only way in is the script that starts the +helper, inside Steam's own installation: + + ~/.local/share/Steam/ubuntu12_64/steamwebhelper_sniper_wrap.sh + +Steam checksums that script at every start and restores it when it differs, so +its launcher entry also gets *-noverifyfiles*. The trade-off is that Steam no +longer repairs a damaged installation on its own; that is why Steam is a switch +of its own in the settings. + +Starting Steam from a terminal without *-noverifyfiles* undoes the patch for +that session. The watcher notices and puts it back, so the next start has it +again. + +# SPOTIFY + +The official client is CEF rather than Electron. Installed through +*spotify-launcher*, it is started by a program that builds its own command line +and has a configuration file with a slot for extra arguments; that slot is +where the flag goes. Installed as a plain package, it is an ordinary desktop +entry and needs nothing special. + +# WHAT CANNOT BE DETECTED + +An AppImage keeps its payload in a compressed filesystem, so there is no way to +tell from the outside whether it contains Chromium. Those are listed as *cannot +tell* and left alone until they are switched on from the applications screen. + +# FILES + +_~/.config/middleclick-autoscroll/config_ + Written by the program. Every option in it is reachable from the menu. + +_~/.local/state/middleclick-autoscroll/ledger_ + One line per change, so *disable* can undo exactly what was done and + nothing else. + +_~/.local/state/middleclick-autoscroll/backup/_ + Copies of the files that are edited in place rather than shadowed. + +_~/.cache/middleclick-autoscroll/detect_ + Which programs were found to be Chromium, keyed by size and modification + time. Safe to delete. + +# ENVIRONMENT + +*NO_COLOR* + Disables colour. + +# SEE ALSO + +*systemctl*(1), *flatpak*(1) + +# AUTHORS + +Felitendo. Source and issue tracker at +https://github.com/Felitendo/middleclick-autoscroll diff --git a/po/de.po b/po/de.po new file mode 100644 index 0000000..a6c1228 --- /dev/null +++ b/po/de.po @@ -0,0 +1,226 @@ +# Translation template for middleclick-autoscroll. +# Copyright (C) 2026 Felitendo +# This file is distributed under the same license as middleclick-autoscroll. +# +msgid "" +msgstr "" +"Project-Id-Version: middleclick-autoscroll 1.0.0\n" +"Report-Msgid-Bugs-To: https://github.com/Felitendo/middleclick-autoscroll/issues\n" +"POT-Creation-Date: 2026-08-16 00:00+0200\n" +"PO-Revision-Date: 2026-08-16 00:00+0200\n" +"Last-Translator: Felitendo\n" +"Language-Team: German\n" +"Language: de\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#. Status labels +msgid "ON" +msgstr "AN" + +msgid "OFF" +msgstr "AUS" + +msgid "on" +msgstr "an" + +msgid "off" +msgstr "aus" + +msgid "(none)" +msgstr "(keine)" + +msgid "flag file" +msgstr "Flag-Datei" + +msgid "launcher" +msgstr "Startereintrag" + +msgid "cannot tell" +msgstr "nicht erkennbar" + +msgid "not patched yet" +msgstr "noch nicht gepatcht" + + +#. Status block +msgid "Autoscroll" +msgstr "Autoscroll" + +msgid "Applications covered" +msgstr "Abgedeckte Anwendungen" + +msgid "%d of %d" +msgstr "%d von %d" + +msgid "Not identified" +msgstr "Nicht erkannt" + +msgid "%d - see the applications list" +msgstr "%d – siehe Anwendungsliste" + +msgid "Steam" +msgstr "Steam" + +msgid "New applications" +msgstr "Neue Anwendungen" + +msgid "Last applied" +msgstr "Zuletzt angewendet" + +msgid "Applications pick this up the next time they are started." +msgstr "Anwendungen übernehmen das beim nächsten Start." + + +#. Menu +msgid "Turn autoscroll on or off" +msgstr "Autoscroll ein- oder ausschalten" + +msgid "Apply now" +msgstr "Jetzt anwenden" + +msgid "Applications" +msgstr "Anwendungen" + +msgid "Settings" +msgstr "Einstellungen" + +msgid "Quit" +msgstr "Beenden" + +msgid "Press any key to continue..." +msgstr "Beliebige Taste drücken …" + + +#. Settings +msgid "Electron and CEF applications" +msgstr "Electron- und CEF-Anwendungen" + +msgid "Chromium-based browsers" +msgstr "Chromium-basierte Browser" + +msgid "Flatpak applications" +msgstr "Flatpak-Anwendungen" + +msgid "Programs that start themselves at login" +msgstr "Programme, die sich beim Anmelden selbst starten" + +msgid "Spotify" +msgstr "Spotify" + +msgid "Apply to newly installed applications" +msgstr "Auf neu installierte Anwendungen anwenden" + +msgid "Additional Chromium arguments" +msgstr "Zusätzliche Chromium-Argumente" + +msgid "Up/Down select - Space or Right changes - q goes back" +msgstr "Hoch/Runter wählt – Leertaste oder Rechts ändert – q geht zurück" + +msgid "Arguments separated by spaces, empty for none:" +msgstr "Argumente mit Leerzeichen getrennt, leer für keine:" + +msgid "Could not save the setting." +msgstr "Einstellung konnte nicht gespeichert werden." + + +#. Applications screen +msgid "Looking at the installed applications..." +msgstr "Installierte Anwendungen werden durchgesehen …" + +msgid "No Chromium-based applications found." +msgstr "Keine Chromium-basierten Anwendungen gefunden." + +msgid "Anything not identified is left alone until it is turned on here." +msgstr "Nicht erkannte Anwendungen bleiben unangetastet, bis sie hier eingeschaltet werden." + +msgid "Autoscroll is off - this is what would be covered." +msgstr "Autoscroll ist aus – das hier wäre abgedeckt." + +msgid "Up/Down select - Space turns one on or off - q goes back" +msgstr "Hoch/Runter wählt – Leertaste schaltet einzeln ein oder aus – q geht zurück" + + +#. Results +msgid "Autoscroll is on for %d applications." +msgstr "Autoscroll ist für %d Anwendungen an." + +msgid "Applications that are already running pick this up when they are restarted." +msgstr "Bereits laufende Anwendungen übernehmen das nach einem Neustart." + +msgid "Steam's launcher now skips its file check, which is what keeps the change from being undone at every start." +msgstr "Steams Startereintrag überspringt jetzt die Dateiprüfung – nur so bleibt die Änderung bei jedem Start erhalten." + +msgid "Could not start the watcher for newly installed applications." +msgstr "Die Überwachung neu installierter Anwendungen konnte nicht gestartet werden." + +msgid "No systemd user session - newly installed applications will not be picked up on their own." +msgstr "Keine systemd-Benutzersitzung – neu installierte Anwendungen werden nicht von selbst erfasst." + +msgid "Autoscroll is off and everything that was changed has been put back." +msgstr "Autoscroll ist aus, alle Änderungen wurden zurückgenommen." + +msgid "Autoscroll is off. Turn it on first." +msgstr "Autoscroll ist aus. Erst einschalten." + +msgid "Applied to %d applications." +msgstr "Auf %d Anwendungen angewendet." + +msgid "Already applied to %d applications." +msgstr "Bereits auf %d Anwendungen angewendet." + +msgid "Steam starts its interface in a way this version does not recognise; leaving it alone." +msgstr "Steam startet seine Oberfläche auf eine Art, die diese Version nicht kennt; Steam bleibt unangetastet." + + +#. Help +msgid "Usage: middleclick-autoscroll [command]" +msgstr "Aufruf: middleclick-autoscroll [Befehl]" + +msgid "Commands:" +msgstr "Befehle:" + +msgid "Turn autoscroll on" +msgstr "Autoscroll einschalten" + +msgid "Turn it off and put everything back" +msgstr "Ausschalten und alles zurücknehmen" + +msgid "Apply to anything installed since the last run" +msgstr "Auf alles anwenden, was seit dem letzten Lauf dazugekommen ist" + +msgid "Show what is covered" +msgstr "Anzeigen, was abgedeckt ist" + +msgid "List every application that was found" +msgstr "Alle gefundenen Anwendungen auflisten" + +msgid "Show this help" +msgstr "Diese Hilfe anzeigen" + +msgid "Show the version" +msgstr "Version anzeigen" + +msgid "Without a command an interactive menu is shown." +msgstr "Ohne Befehl wird ein interaktives Menü angezeigt." + +msgid "Unknown command: %s" +msgstr "Unbekannter Befehl: %s" + + +#. Time +msgid "never" +msgstr "nie" + +msgid "just now" +msgstr "gerade eben" + +msgid "%d minutes ago" +msgstr "vor %d Minuten" + +msgid "%d hours ago" +msgstr "vor %d Stunden" + +msgid "%d days ago" +msgstr "vor %d Tagen" diff --git a/po/middleclick-autoscroll.pot b/po/middleclick-autoscroll.pot new file mode 100644 index 0000000..bcb94d5 --- /dev/null +++ b/po/middleclick-autoscroll.pot @@ -0,0 +1,226 @@ +# Translation template for middleclick-autoscroll. +# Copyright (C) 2026 Felitendo +# This file is distributed under the same license as middleclick-autoscroll. +# +msgid "" +msgstr "" +"Project-Id-Version: middleclick-autoscroll 1.0.0\n" +"Report-Msgid-Bugs-To: https://github.com/Felitendo/middleclick-autoscroll/issues\n" +"POT-Creation-Date: 2026-08-16 00:00+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#. Status labels +msgid "ON" +msgstr "" + +msgid "OFF" +msgstr "" + +msgid "on" +msgstr "" + +msgid "off" +msgstr "" + +msgid "(none)" +msgstr "" + +msgid "flag file" +msgstr "" + +msgid "launcher" +msgstr "" + +msgid "cannot tell" +msgstr "" + +msgid "not patched yet" +msgstr "" + + +#. Status block +msgid "Autoscroll" +msgstr "" + +msgid "Applications covered" +msgstr "" + +msgid "%d of %d" +msgstr "" + +msgid "Not identified" +msgstr "" + +msgid "%d - see the applications list" +msgstr "" + +msgid "Steam" +msgstr "" + +msgid "New applications" +msgstr "" + +msgid "Last applied" +msgstr "" + +msgid "Applications pick this up the next time they are started." +msgstr "" + + +#. Menu +msgid "Turn autoscroll on or off" +msgstr "" + +msgid "Apply now" +msgstr "" + +msgid "Applications" +msgstr "" + +msgid "Settings" +msgstr "" + +msgid "Quit" +msgstr "" + +msgid "Press any key to continue..." +msgstr "" + + +#. Settings +msgid "Electron and CEF applications" +msgstr "" + +msgid "Chromium-based browsers" +msgstr "" + +msgid "Flatpak applications" +msgstr "" + +msgid "Programs that start themselves at login" +msgstr "" + +msgid "Spotify" +msgstr "" + +msgid "Apply to newly installed applications" +msgstr "" + +msgid "Additional Chromium arguments" +msgstr "" + +msgid "Up/Down select - Space or Right changes - q goes back" +msgstr "" + +msgid "Arguments separated by spaces, empty for none:" +msgstr "" + +msgid "Could not save the setting." +msgstr "" + + +#. Applications screen +msgid "Looking at the installed applications..." +msgstr "" + +msgid "No Chromium-based applications found." +msgstr "" + +msgid "Anything not identified is left alone until it is turned on here." +msgstr "" + +msgid "Autoscroll is off - this is what would be covered." +msgstr "" + +msgid "Up/Down select - Space turns one on or off - q goes back" +msgstr "" + + +#. Results +msgid "Autoscroll is on for %d applications." +msgstr "" + +msgid "Applications that are already running pick this up when they are restarted." +msgstr "" + +msgid "Steam's launcher now skips its file check, which is what keeps the change from being undone at every start." +msgstr "" + +msgid "Could not start the watcher for newly installed applications." +msgstr "" + +msgid "No systemd user session - newly installed applications will not be picked up on their own." +msgstr "" + +msgid "Autoscroll is off and everything that was changed has been put back." +msgstr "" + +msgid "Autoscroll is off. Turn it on first." +msgstr "" + +msgid "Applied to %d applications." +msgstr "" + +msgid "Already applied to %d applications." +msgstr "" + +msgid "Steam starts its interface in a way this version does not recognise; leaving it alone." +msgstr "" + + +#. Help +msgid "Usage: middleclick-autoscroll [command]" +msgstr "" + +msgid "Commands:" +msgstr "" + +msgid "Turn autoscroll on" +msgstr "" + +msgid "Turn it off and put everything back" +msgstr "" + +msgid "Apply to anything installed since the last run" +msgstr "" + +msgid "Show what is covered" +msgstr "" + +msgid "List every application that was found" +msgstr "" + +msgid "Show this help" +msgstr "" + +msgid "Show the version" +msgstr "" + +msgid "Without a command an interactive menu is shown." +msgstr "" + +msgid "Unknown command: %s" +msgstr "" + + +#. Time +msgid "never" +msgstr "" + +msgid "just now" +msgstr "" + +msgid "%d minutes ago" +msgstr "" + +msgid "%d hours ago" +msgstr "" + +msgid "%d days ago" +msgstr "" diff --git a/res/systemd/middleclick-autoscroll.path b/res/systemd/middleclick-autoscroll.path new file mode 100644 index 0000000..d23f833 --- /dev/null +++ b/res/systemd/middleclick-autoscroll.path @@ -0,0 +1,25 @@ +[Unit] +Description=Watch for newly installed Chromium-based applications +Documentation=man:middleclick-autoscroll(1) + +[Path] +# Every way an application can turn up: a package, a Flatpak, something +# installed by hand. Watching where the launchers land means there is no hook +# to write per package manager - pacman, flatpak and an AppImage manager all +# end up here. +PathModified=/usr/share/applications +PathModified=/usr/local/share/applications +PathModified=%h/.local/share/applications +PathModified=%h/.config/autostart +PathModified=/var/lib/flatpak/exports/share/applications +PathModified=%h/.local/share/flatpak/exports/share/applications + +# Steam replaces the script that starts its interface on every client update, +# which takes the patch with it. +PathChanged=%h/.local/share/Steam/ubuntu12_64/steamwebhelper_sniper_wrap.sh +PathChanged=%h/.var/app/com.valvesoftware.Steam/.local/share/Steam/ubuntu12_64/steamwebhelper_sniper_wrap.sh + +Unit=middleclick-autoscroll.service + +[Install] +WantedBy=default.target diff --git a/res/systemd/middleclick-autoscroll.service b/res/systemd/middleclick-autoscroll.service new file mode 100644 index 0000000..8d9c6e1 --- /dev/null +++ b/res/systemd/middleclick-autoscroll.service @@ -0,0 +1,16 @@ +[Unit] +Description=Apply middle-click autoscroll to Chromium-based applications +Documentation=man:middleclick-autoscroll(1) + +[Service] +Type=oneshot +ExecStart=@BINDIR@/middleclick-autoscroll apply --quiet +# Scanning binaries for their engine is the slow part, and it is cached; a run +# that takes longer than this has found something pathological and should not +# be left running at every login. +TimeoutStartSec=180 +Nice=10 +IOSchedulingClass=idle + +[Install] +WantedBy=default.target diff --git a/src/lib/apply.sh b/src/lib/apply.sh new file mode 100644 index 0000000..5542595 --- /dev/null +++ b/src/lib/apply.sh @@ -0,0 +1,211 @@ +# shellcheck shell=bash +# +# Deciding what happens to each application, and doing it. +# +# The routing lives in mca_route and is used twice: once by mca_apply to patch +# and once by the applications screen to show what would happen. Keeping it in +# one function is what makes that screen trustworthy - it is not a description +# of the behaviour, it is the behaviour. + +MCA_CHANGES=0 +MCA_TOUCHED=() +MCA_ROUTES=() + +# mca_route +# What happens to one application, left in MCA_ROUTE: +# flags - the launcher reads a flag file; write it there +# desktop - no flag file; shadow or edit the desktop entry +# steam - Steam's own two-part treatment +# unknown - cannot tell what engine this is (an AppImage), so nothing is done +# off - detected, but switched off +# +# Assigns rather than prints so the memo inside mca_has_flags_file survives: +# from inside a command substitution it would be filled in a subshell and +# thrown away, which is the whole point of having it. +MCA_ROUTE='' + +mca_route() { + local kind="$1" id="$2" prog="$3" + + if [[ $kind == steam ]]; then + if mca_config_list_has Skip "$id" || [[ $CFG_STEAM != yes ]]; then + MCA_ROUTE=off + else + MCA_ROUTE=steam + fi + return + fi + + if ! mca_kind_wanted "$kind" "$id"; then + [[ $kind == unknown ]] && MCA_ROUTE=unknown || MCA_ROUTE=off + return + fi + + # A Flatpak has its own copy of everything and none of the host's wrappers, + # so the desktop entry is the only way in. + if [[ $kind == flatpak ]]; then + MCA_ROUTE=desktop + return + fi + + if mca_has_flags_file "$prog"; then + MCA_ROUTE=flags + else + MCA_ROUTE=desktop + fi +} + +# mca_apply +# Brings everything into line with the current settings. Safe to run as often +# as it likes to be - it writes only what differs, which is what keeps the +# watcher from chasing its own changes. +mca_apply() { + local i id file prog kind route steam_done=0 + + MCA_CHANGES=0 + MCA_TOUCHED=() + MCA_ROUTES=() + MCA_N_ON=0; MCA_N_OFF=0; MCA_N_UNKNOWN=0 + + mca_config_load + mca_scan + + for i in "${!MCA_IDS[@]}"; do + id="${MCA_IDS[i]}" + file="${MCA_FILES[i]}" + prog="${MCA_PROGS[i]}" + kind="${MCA_KINDS[i]}" + + mca_route "$kind" "$id" "$prog" + route="$MCA_ROUTE" + MCA_ROUTES[i]="$route" + + case "$route" in + unknown) MCA_N_UNKNOWN=$(( MCA_N_UNKNOWN + 1 )) ;; + off) MCA_N_OFF=$(( MCA_N_OFF + 1 )) ;; + *) MCA_N_ON=$(( MCA_N_ON + 1 )) ;; + esac + + case "$route" in + flags) + mca_flags_apply "$prog" || mca_desktop_apply "$id" "$file" + ;; + desktop) + mca_desktop_apply "$id" "$file" + ;; + steam) + mca_steam_desktop_apply "$id" "$file" + if (( ! steam_done )); then + mca_steam_apply + steam_done=1 + fi + ;; + esac + done + + # Steam is worth patching even when its desktop entry is missing - a user + # who starts it from a script or a game launcher still gets the interface. + if [[ $CFG_STEAM == yes ]] && (( ! steam_done )) && mca_steam_installed; then + mca_steam_apply + fi + + [[ $CFG_AUTOSTART == yes ]] && mca_autostart_apply + [[ $CFG_SPOTIFY == yes ]] && mca_spotify_apply + + if (( MCA_CHANGES )) && mca_have update-desktop-database; then + update-desktop-database "$MCA_APPDIR" 2>/dev/null || true + fi + + mca_state_write last_apply "$(date +%s)" + mca_state_write covered "${#MCA_TOUCHED[@]}" + return 0 +} + +# mca_revert +# Undoes every recorded change and forgets them. +mca_revert() { + MCA_CHANGES=0 + mca_revert_all + + if (( MCA_CHANGES )) && mca_have update-desktop-database; then + update-desktop-database "$MCA_APPDIR" 2>/dev/null || true + fi + + mca_state_write covered 0 + return 0 +} + +# --------------------------------------------------------------------------- +# The watcher +# --------------------------------------------------------------------------- +# A systemd user path unit watching every directory a desktop entry can appear +# in. That covers a package installed with pacman, a Flatpak, an AppImage +# registered by hand and a Steam client update, without a hook per package +# manager. + +MCA_UNIT_PATH="middleclick-autoscroll.path" +MCA_UNIT_SERVICE="middleclick-autoscroll.service" + +mca_watch_available() { + mca_have systemctl && [[ -n ${XDG_RUNTIME_DIR:-} || -S "/run/user/$(id -u)/bus" ]] +} + +mca_watch_enabled() { + mca_watch_available || return 1 + systemctl --user is-enabled --quiet "$MCA_UNIT_PATH" 2>/dev/null +} + +mca_watch_enable() { + mca_watch_available || return 1 + systemctl --user enable --now "$MCA_UNIT_PATH" > /dev/null 2>&1 || return 1 + systemctl --user enable "$MCA_UNIT_SERVICE" > /dev/null 2>&1 || true + return 0 +} + +mca_watch_disable() { + mca_watch_available || return 0 + systemctl --user disable --now "$MCA_UNIT_PATH" > /dev/null 2>&1 || true + systemctl --user disable "$MCA_UNIT_SERVICE" > /dev/null 2>&1 || true + return 0 +} + +# --------------------------------------------------------------------------- +# Reporting +# --------------------------------------------------------------------------- + +# mca_count_routes +# Fills MCA_N_ON / MCA_N_OFF / MCA_N_UNKNOWN from a scan, without writing +# anything. Used by the status block and the menu header. +MCA_N_ON=0 +MCA_N_OFF=0 +MCA_N_UNKNOWN=0 + +mca_count_routes() { + local i route + + MCA_N_ON=0; MCA_N_OFF=0; MCA_N_UNKNOWN=0 + MCA_ROUTES=() + + for i in "${!MCA_IDS[@]}"; do + mca_route "${MCA_KINDS[i]}" "${MCA_IDS[i]}" "${MCA_PROGS[i]}" + route="$MCA_ROUTE" + MCA_ROUTES[i]="$route" + case "$route" in + unknown) MCA_N_UNKNOWN=$(( MCA_N_UNKNOWN + 1 )) ;; + off) MCA_N_OFF=$(( MCA_N_OFF + 1 )) ;; + *) MCA_N_ON=$(( MCA_N_ON + 1 )) ;; + esac + done +} + +# mca_route_label +mca_route_label() { + case "$1" in + flags) mca_msg "flag file" ;; + desktop) mca_msg "launcher" ;; + steam) mca_msg "Steam" ;; + unknown) mca_msg "cannot tell" ;; + *) mca_msg "off" ;; + esac + printf '\n' +} diff --git a/src/lib/common.sh b/src/lib/common.sh new file mode 100644 index 0000000..292cc78 --- /dev/null +++ b/src/lib/common.sh @@ -0,0 +1,293 @@ +# shellcheck shell=bash +# +# Paths, translations, output helpers and the change ledger. +# +# Everything here runs unprivileged. This tool only ever writes inside the +# user's own home - flag files, desktop entries, Steam's own scripts - so there +# is no system state to guard and nothing that needs root. + +MCA_VERSION="@VERSION@" +MCA_NAME="middleclick-autoscroll" +MCA_PRETTY="Middle-Click Autoscroll" + +# The whole point of the package. Blink implements Windows-style autoscroll +# behind a runtime flag that Chromium does not turn on for Linux, because +# middle click is taken by primary-selection paste there. +MCA_FLAG="--enable-blink-features=MiddleClickAutoscroll" + +# The Blink feature name on its own, for merging into an --enable-blink-features +# list that an app (or the user) already carries. +MCA_FEATURE="MiddleClickAutoscroll" + +MCA_LIBDIR="${MCA_LIBDIR:-@LIBDIR@}" +MCA_LOCALEDIR="${MCA_LOCALEDIR:-@LOCALEDIR@}" + +MCA_XDG_CONFIG="${XDG_CONFIG_HOME:-$HOME/.config}" +MCA_XDG_DATA="${XDG_DATA_HOME:-$HOME/.local/share}" +MCA_XDG_STATE="${XDG_STATE_HOME:-$HOME/.local/state}" +MCA_XDG_CACHE="${XDG_CACHE_HOME:-$HOME/.cache}" + +MCA_CONFDIR="${MCA_CONFDIR:-${MCA_XDG_CONFIG}/${MCA_NAME}}" +MCA_CONFIG="${MCA_CONFIG:-${MCA_CONFDIR}/config}" +MCA_STATEDIR="${MCA_STATEDIR:-${MCA_XDG_STATE}/${MCA_NAME}}" +MCA_CACHEDIR="${MCA_CACHEDIR:-${MCA_XDG_CACHE}/${MCA_NAME}}" + +# Where generated desktop entries go. A file here shadows the one with the same +# name in /usr/share/applications, which is how an application gets extra +# command line arguments without touching anything pacman owns. +MCA_APPDIR="${MCA_XDG_DATA}/applications" + +# Copies of every file that is edited in place rather than shadowed. +MCA_BACKUPDIR="${MCA_STATEDIR}/backup" + +# One line per change, so `revert` can undo exactly what was done and nothing +# else. See mca_ledger_add. +MCA_LEDGER="${MCA_STATEDIR}/ledger" + +# --------------------------------------------------------------------------- +# Translations +# --------------------------------------------------------------------------- + +export TEXTDOMAIN="middleclick-autoscroll" +export TEXTDOMAINDIR="${MCA_LOCALEDIR}" + +mca_ui_locale() { + local l="${MCA_UI_LOCALE:-}" + + if [[ -z $l ]]; then + l="${LC_ALL:-}" + [[ -z $l ]] && l="${LC_MESSAGES:-}" + [[ -z $l ]] && l="${LANG:-}" + fi + + if [[ -z $l && -r /etc/locale.conf ]]; then + l="$(sed -n 's/^LANG=//p' /etc/locale.conf | tr -d '"' | head -n1)" + fi + + printf '%s\n' "${l:-C}" +} + +# Every gettext lookup is a fork and the settings screen redraws a screenful of +# labels per keypress, so results are memoized. +declare -A MCA_MSG_CACHE=() + +MCA_MSG_RESULT='' + +# mca_msg_into +# Plain lookup with the result in MCA_MSG_RESULT and no printf formatting, for +# callers that would otherwise pay a fork per label per frame. +mca_msg_into() { + local locale="$1" msgid="$2" cachekey + cachekey="${locale}"$'\x1f'"${msgid}" + + if [[ -n ${MCA_MSG_CACHE[$cachekey]+set} ]]; then + MCA_MSG_RESULT="${MCA_MSG_CACHE[$cachekey]}" + return 0 + fi + + MCA_MSG_RESULT="$(LC_ALL="$locale" LANGUAGE="${locale%%.*}" gettext -- "$msgid" 2>/dev/null)" + [[ -n $MCA_MSG_RESULT ]] || MCA_MSG_RESULT="$msgid" + MCA_MSG_CACHE[$cachekey]="$MCA_MSG_RESULT" + return 0 +} + +# mca_msg_in [printf args...] +mca_msg_in() { + local locale="$1" msgid="$2" translated cachekey + shift 2 + + cachekey="${locale}"$'\x1f'"${msgid}" + if [[ -n ${MCA_MSG_CACHE[$cachekey]+set} ]]; then + translated="${MCA_MSG_CACHE[$cachekey]}" + else + translated="$(LC_ALL="$locale" LANGUAGE="${locale%%.*}" gettext -- "$msgid" 2>/dev/null)" + [[ -n $translated ]] || translated="$msgid" + MCA_MSG_CACHE[$cachekey]="$translated" + fi + + # With no arguments the message is plain text, not a format string. Feeding + # it to printf anyway would turn a literal percent sign in a translation + # into an invalid conversion. + if (( $# == 0 )); then + printf '%s' "$translated" + return + fi + + # shellcheck disable=SC2059 # the format string is the translated message + printf -- "$translated" "$@" +} + +# mca_msg [printf args...] +mca_msg() { mca_msg_in "$(mca_ui_locale)" "$@"; } + +# --------------------------------------------------------------------------- +# Output +# --------------------------------------------------------------------------- + +# Decided once, while stdout is still whatever the process was started with: +# testing -t 1 at the point of use is wrong for anything called through $(...), +# which sees a pipe and would conclude nobody is watching. +MCA_INTERACTIVE='' +[[ -t 1 ]] && MCA_INTERACTIVE=1 + +if [[ -n $MCA_INTERACTIVE && -z ${NO_COLOR:-} ]]; then + MCA_C_RESET=$'\033[0m' + MCA_C_BOLD=$'\033[1m' + MCA_C_DIM=$'\033[2m' + MCA_C_BLUE=$'\033[38;2;23;147;209m' + MCA_C_GREEN=$'\033[32m' + MCA_C_YELLOW=$'\033[33m' + MCA_C_RED=$'\033[31m' +else + MCA_C_RESET='' MCA_C_BOLD='' MCA_C_DIM='' MCA_C_BLUE='' + MCA_C_GREEN='' MCA_C_YELLOW='' MCA_C_RED='' +fi + +# Set by mca_bad and mca_note. The menu redraws straight after an action, which +# would wipe the screen; this marks that something was printed the user still +# has to read. A plain success needs no acknowledgement - the status block at +# the top of the menu already shows the new state. +MCA_UI_NEEDS_ACK='' + +# --quiet silences progress chatter; errors still go to stderr. Used by the +# systemd unit, which has no terminal and logs to the journal anyway. +MCA_QUIET='' + +mca_say() { [[ -n $MCA_QUIET ]] || printf '%s\n' "$*"; } +mca_head() { printf '\n%s%s%s\n\n' "$MCA_C_BOLD$MCA_C_BLUE" "$*" "$MCA_C_RESET"; } +mca_ok() { [[ -n $MCA_QUIET ]] || printf '%s✔%s %s\n' "$MCA_C_GREEN" "$MCA_C_RESET" "$*"; } +mca_bad() { MCA_UI_NEEDS_ACK=1; printf '%s✘%s %s\n' "$MCA_C_RED" "$MCA_C_RESET" "$*" >&2; } +mca_note() { MCA_UI_NEEDS_ACK=1; [[ -n $MCA_QUIET ]] || printf '%s•%s %s\n' "$MCA_C_DIM" "$MCA_C_RESET" "$*"; } +mca_debug() { [[ -n ${MCA_DEBUG:-} ]] && printf 'debug: %s\n' "$*" >&2; return 0; } + +mca_have() { command -v "$1" > /dev/null 2>&1; } + +# Human-readable "x minutes ago" for a unix timestamp. Empty input yields the +# translated "never". +mca_time_ago() { + local ts="$1" now delta + + [[ $ts =~ ^[0-9]+$ ]] || { mca_msg "never"; printf '\n'; return; } + + now="$(date +%s)" + delta=$(( now - ts )) + (( delta < 0 )) && delta=0 + + if (( delta < 60 )); then mca_msg "just now" + elif (( delta < 3600 )); then mca_msg "%d minutes ago" "$(( delta / 60 ))" + elif (( delta < 86400 )); then mca_msg "%d hours ago" "$(( delta / 3600 ))" + else mca_msg "%d days ago" "$(( delta / 86400 ))" + fi + printf '\n' +} + +# --------------------------------------------------------------------------- +# State +# --------------------------------------------------------------------------- + +mca_state_read() { + local key="$1" default="${2:-}" + if [[ -r "$MCA_STATEDIR/$key" ]]; then + cat "$MCA_STATEDIR/$key" + else + printf '%s\n' "$default" + fi +} + +mca_state_write() { + local key="$1" + shift + mkdir -p "$MCA_STATEDIR" 2>/dev/null || return 1 + printf '%s\n' "$*" > "$MCA_STATEDIR/$key" +} + +# --------------------------------------------------------------------------- +# The change ledger +# --------------------------------------------------------------------------- +# Reverting by pattern - "delete every desktop entry that mentions the flag" - +# would also delete entries the user wrote by hand. So every change is recorded +# instead, and `revert` replays the ledger backwards. +# +# Format, tab separated: +# +# +# shadow +# inplace +# flags created | appended | merged +# +# `inplace` and `flags` differ in how they are undone: a backup is restored +# wholesale, a flag file only loses the one line that was added to it. + +mca_ledger_add() { + local kind="$1" path="$2" detail="${3:-}" + mkdir -p "$MCA_STATEDIR" 2>/dev/null || return 1 + + # Never record the same path twice: applying repeatedly is normal (the path + # unit fires on every desktop file that appears) and the ledger has to stay + # a set, not a log. + mca_ledger_forget "$path" + printf '%s\t%s\t%s\n' "$kind" "$path" "$detail" >> "$MCA_LEDGER" +} + +mca_ledger_forget() { + local path="$1" tmp + [[ -f $MCA_LEDGER ]] || return 0 + + tmp="$(mktemp "${MCA_LEDGER}.XXXXXX")" || return 1 + awk -F'\t' -v p="$path" '$2 != p' "$MCA_LEDGER" > "$tmp" 2>/dev/null \ + && mv -f "$tmp" "$MCA_LEDGER" || rm -f "$tmp" + return 0 +} + +# mca_ledger_has +mca_ledger_has() { + [[ -f $MCA_LEDGER ]] || return 1 + awk -F'\t' -v p="$1" '$2 == p { found = 1 } END { exit !found }' "$MCA_LEDGER" +} + +# mca_ledger_detail +mca_ledger_detail() { + [[ -f $MCA_LEDGER ]] || return 1 + awk -F'\t' -v p="$1" '$2 == p { print $3; exit }' "$MCA_LEDGER" +} + +mca_ledger_count() { + [[ -f $MCA_LEDGER ]] || { printf '0\n'; return; } + grep -c . "$MCA_LEDGER" 2>/dev/null || printf '0\n' +} + +# mca_backup +# Copies a file aside before it is edited in place, and prints the name the +# copy was stored under. Existing backups are never overwritten: the first copy +# is the pristine one, and a second apply must not replace it with an already +# patched version. +mca_backup() { + local file="$1" name + name="$(printf '%s' "$file" | sed 's|/|%|g')" + + mkdir -p "$MCA_BACKUPDIR" 2>/dev/null || return 1 + if [[ ! -e "$MCA_BACKUPDIR/$name" ]]; then + cp -p -- "$file" "$MCA_BACKUPDIR/$name" 2>/dev/null || return 1 + fi + printf '%s\n' "$name" +} + +# mca_write_if_changed +# Writing a file that is already correct would touch its mtime, and the systemd +# path unit watches these directories: an unconditional write would retrigger +# the service, which would write again, forever. +mca_write_if_changed() { + local path="$1" content="$2" current='' + + [[ -r $path ]] && current="$(< "$path")" + + # $(< file) drops trailing newlines and callers pass content that ends in + # one, so both sides are trimmed before comparing. Getting this wrong makes + # every file look changed on every run, which is exactly the feedback loop + # this function exists to prevent. + [[ "${current%"${current##*[!$'\n']}"}" == "${content%"${content##*[!$'\n']}"}" ]] && return 1 + + mkdir -p "$(dirname "$path")" 2>/dev/null || return 2 + printf '%s' "$content" > "$path" || return 2 + return 0 +} diff --git a/src/lib/config.sh b/src/lib/config.sh new file mode 100644 index 0000000..19e2182 --- /dev/null +++ b/src/lib/config.sh @@ -0,0 +1,162 @@ +# shellcheck shell=bash +# +# Reading and writing ~/.config/middleclick-autoscroll/config. +# +# The file exists so the tool has somewhere to remember what it was told; it is +# not meant to be edited. Every option it holds is reachable from the interface, +# which is why there is no commented template shipped anywhere and no reference +# to the path in the interface itself. +# +# It is parsed rather than sourced. One "Key=Value" per line, '#' comments. + +MCA_CONFIG_CACHE='' +MCA_CONFIG_CACHED=0 + +_mca_config_slurp() { + (( MCA_CONFIG_CACHED )) && return 0 + MCA_CONFIG_CACHE='' + [[ -r $MCA_CONFIG ]] && MCA_CONFIG_CACHE="$(< "$MCA_CONFIG")" + MCA_CONFIG_CACHED=1 + return 0 +} + +# _mca_config_lookup [default] +# Result in MCA_CONFIG_VALUE. Assigning rather than printing matters on the +# settings screen, which reads every key on every frame: a command substitution +# there is a fork, and forks are the whole cost of a redraw. +MCA_CONFIG_VALUE='' + +_mca_config_lookup() { + local key="$1" default="${2:-}" val='' line + + MCA_CONFIG_VALUE="$default" + [[ -r $MCA_CONFIG ]] || return 0 + _mca_config_slurp + + while IFS= read -r line; do + [[ $line == *"$key"* ]] || continue + [[ $line =~ ^[[:space:]]*"$key"[[:space:]]*=(.*)$ ]] || continue + val="${BASH_REMATCH[1]}" + done <<< "$MCA_CONFIG_CACHE" + + val="${val%%#*}" + val="${val#"${val%%[![:space:]]*}"}" + val="${val%"${val##*[![:space:]]}"}" + val="${val%\"}" + val="${val#\"}" + + [[ -n $val ]] && MCA_CONFIG_VALUE="$val" + return 0 +} + +# mca_config_get [default] +mca_config_get() { + _mca_config_lookup "$@" + printf '%s\n' "$MCA_CONFIG_VALUE" +} + +# mca_config_bool +mca_config_bool() { + local val + val="$(mca_config_get "$1" "$2")" + case "${val,,}" in + yes|y|true|1|on|enabled) return 0 ;; + *) return 1 ;; + esac +} + +# mca_config_set +mca_config_set() { + local key="$1" value="$2" tmp + + if [[ ! -e $MCA_CONFIG ]]; then + mkdir -p "$(dirname "$MCA_CONFIG")" || return 1 + { + printf '# %s\n' "$MCA_PRETTY" + printf '#\n' + printf '# Written by `%s`. Nothing here needs editing by hand -\n' "$MCA_NAME" + printf '# every option is reachable from `%s` itself.\n' "$MCA_NAME" + } > "$MCA_CONFIG" || return 1 + fi + [[ -w $MCA_CONFIG ]] || return 1 + + tmp="$(mktemp "${MCA_CONFIG}.XXXXXX")" || return 1 + chmod --reference="$MCA_CONFIG" "$tmp" 2>/dev/null || chmod 0644 "$tmp" + + if grep -qE "^[[:space:]]*#?[[:space:]]*${key}[[:space:]]*=" "$MCA_CONFIG"; then + awk -v key="$key" -v value="$value" ' + !done && $0 ~ "^[[:space:]]*#?[[:space:]]*" key "[[:space:]]*=" { + print key "=" value; done = 1; next + } + # drop any further occurrences so the file cannot grow duplicates + $0 ~ "^[[:space:]]*" key "[[:space:]]*=" { next } + { print } + ' "$MCA_CONFIG" > "$tmp" || { rm -f "$tmp"; return 1; } + else + cat "$MCA_CONFIG" > "$tmp" || { rm -f "$tmp"; return 1; } + printf '%s=%s\n' "$key" "$value" >> "$tmp" + fi + + mv -f "$tmp" "$MCA_CONFIG" + MCA_CONFIG_CACHED=0 +} + +# mca_config_list_has +# The per-application overrides are stored as space separated lists. +mca_config_list_has() { + local list item="$2" entry + list="$(mca_config_get "$1" '')" + for entry in $list; do + [[ $entry == "$item" ]] && return 0 + done + return 1 +} + +# mca_config_list_add / mca_config_list_del +mca_config_list_add() { + local key="$1" item="$2" list + mca_config_list_has "$key" "$item" && return 0 + list="$(mca_config_get "$key" '')" + mca_config_set "$key" "${list:+$list }$item" +} + +mca_config_list_del() { + local key="$1" item="$2" list entry out='' + list="$(mca_config_get "$key" '')" + for entry in $list; do + [[ $entry == "$item" ]] && continue + out="${out:+$out }$entry" + done + mca_config_set "$key" "$out" +} + +# --------------------------------------------------------------------------- +# Resolved settings +# --------------------------------------------------------------------------- + +mca_config_load() { + CFG_ENABLED=no; mca_config_bool Enabled no && CFG_ENABLED=yes + CFG_APPS=no; mca_config_bool PatchApps yes && CFG_APPS=yes + CFG_BROWSERS=no; mca_config_bool PatchBrowsers yes && CFG_BROWSERS=yes + CFG_FLATPAK=no; mca_config_bool PatchFlatpak yes && CFG_FLATPAK=yes + CFG_AUTOSTART=no; mca_config_bool PatchAutostart yes && CFG_AUTOSTART=yes + CFG_STEAM=no; mca_config_bool PatchSteam yes && CFG_STEAM=yes + CFG_SPOTIFY=no; mca_config_bool PatchSpotify yes && CFG_SPOTIFY=yes + CFG_WATCH=no; mca_config_bool WatchNewApps yes && CFG_WATCH=yes + + CFG_EXTRA_FLAGS="$(mca_config_get ExtraFlags '')" + + # Applications the user turned on or off by hand on the applications + # screen, by desktop file id. Include wins over detection, Skip wins over + # everything. + CFG_INCLUDE="$(mca_config_get Include '')" + CFG_SKIP="$(mca_config_get Skip '')" +} + +# The full argument string that gets injected. Kept in one place so the flag +# file writer and the desktop entry writer cannot drift apart. +mca_flags() { + printf '%s' "$MCA_FLAG" + [[ -n ${CFG_EXTRA_FLAGS:-} ]] && printf ' %s' "$CFG_EXTRA_FLAGS" + printf '\n' +} diff --git a/src/lib/detect.sh b/src/lib/detect.sh new file mode 100644 index 0000000..5fd5d58 --- /dev/null +++ b/src/lib/detect.sh @@ -0,0 +1,571 @@ +# shellcheck shell=bash +# +# Finding the applications and deciding which of them are Chromium underneath. +# +# The detection is deliberately conservative. A wrong "yes" appends an unknown +# argument to something that is not Chromium, and plenty of programs treat an +# unrecognised argument as a file name to open - so every rule here is a +# positive one, and anything that cannot be identified is reported as unknown +# rather than guessed at. + +# Files that only ever sit next to a Chromium or Electron binary. Any single one +# is conclusive; together they cover both bundled Electron (app.asar, the +# swiftshader libraries) and plain CEF (libcef). +# +# Deliberately not in here: libEGL.so and libffmpeg.so. Chromium ships both, but +# so does the system - /usr/lib/libEGL.so exists on any machine with Mesa - and +# a marker that can be somebody else's file is not a marker. +MCA_MARKERS=( + chrome_crashpad_handler chrome-sandbox chrome_100_percent.pak + icudtl.dat v8_context_snapshot.bin snapshot_blob.bin resources.pak + libvk_swiftshader.so LICENSES.chromium.html libcef.so +) + +# Shared directories, where a marker belongs to the system rather than to the +# program that happens to live there. An application ships its payload in a +# directory of its own; nothing unpacks Chromium straight into /usr/lib. +MCA_SYSTEM_DIRS=( + / /bin /lib /lib32 /lib64 /sbin /usr /usr/bin /usr/lib /usr/lib32 + /usr/lib64 /usr/libexec /usr/sbin /usr/local /usr/local/bin + /usr/local/lib /opt +) + +# Strings in a launcher script that mean it starts a Chromium or Electron +# process, for the wrappers whose command line is assembled out of variables and +# cannot be followed from the outside. +# +# Only strings that no other kind of program has a reason to contain. The word +# "chromium" on its own is not one of them: /usr/bin/xdg-open lists every +# browser it knows how to start, and that is not a browser. +# +# The flag file convention is an Arch packaging habit and says nothing about the +# engine either, so it is not in here. +MCA_SCRIPT_HINTS='ELECTRON_|app\.asar|chrome-sandbox|libcef|enable-blink-features|ozone-platform-hint' + +# --------------------------------------------------------------------------- +# Desktop entries +# --------------------------------------------------------------------------- + +# The directories a desktop entry can come from, most specific first - which is +# also XDG lookup order, so the first file found for an id is the one that is +# actually used. +mca_desktop_dirs() { + local dirs="${XDG_DATA_DIRS:-/usr/local/share:/usr/share}" d + printf '%s\n' "$MCA_APPDIR" + while IFS= read -r -d: d; do + [[ -n $d ]] && printf '%s/applications\n' "${d%/}" + done <<< "${dirs}:" +} + +# mca_desktop_get +# A single value from the [Desktop Entry] group. Desktop Action groups repeat +# the same keys, and reading past the first group would pick up the wrong one. +mca_desktop_get() { + local file="$1" key="$2" + awk -v key="$key" ' + /^[[:space:]]*\[/ { inentry = ($0 ~ /^[[:space:]]*\[Desktop Entry\][[:space:]]*$/); next } + inentry && index($0, key "=") == 1 { print substr($0, length(key) + 2); exit } + ' "$file" 2>/dev/null +} + +# _mca_desktop_read +# Every key the scan needs, in one pass and without a single fork. There are a +# couple of hundred desktop entries on an ordinary system, and doing this with +# one awk per key per file is the difference between a menu that redraws and a +# menu that pauses. +DE_TYPE='' DE_HIDDEN='' DE_EXEC='' DE_NAME='' DE_CATEGORIES='' DE_MIME='' DE_OURS='' + +_mca_desktop_read() { + local file="$1" line ingroup=0 + + DE_TYPE=''; DE_HIDDEN=''; DE_EXEC=''; DE_NAME='' + DE_CATEGORIES=''; DE_MIME=''; DE_OURS='' + + while IFS= read -r line || [[ -n $line ]]; do + case "$line" in + '[Desktop Entry]'*) ingroup=1; continue ;; + '['*) ingroup=0; continue ;; + esac + (( ingroup )) || continue + + # Locale variants are Name[de]= and never match these patterns, which + # is what we want: the untranslated key is the identifying one. + case "$line" in + Exec=*) [[ -n $DE_EXEC ]] || DE_EXEC="${line#Exec=}" ;; + Name=*) [[ -n $DE_NAME ]] || DE_NAME="${line#Name=}" ;; + Type=*) DE_TYPE="${line#Type=}" ;; + Hidden=*) DE_HIDDEN="${line#Hidden=}" ;; + Categories=*) DE_CATEGORIES="${line#Categories=}" ;; + MimeType=*) DE_MIME="${line#MimeType=}" ;; + X-MCA-Generated=*) DE_OURS=1 ;; + esac + done < "$file" +} + +# mca_exec_program +# The program a desktop entry actually starts: the first token that is not an +# environment prefix, resolved to an absolute path. The result is left in +# MCA_PROG rather than printed - the scan calls this for every desktop entry on +# the system, and a command substitution each time is a fork each time. +# +# Fails for entries this tool has no safe way to rewrite: anything routed +# through a shell, where the real program is inside a quoted string. +MCA_PROG='' + +mca_exec_program() { + local line="$1" tok prog='' + local -a tokens + + MCA_PROG='' + + # Field codes are placeholders, not arguments, and quotes only ever wrap + # whole tokens here; splitting on whitespace is enough to find token one. + read -r -a tokens <<< "$line" + + for tok in "${tokens[@]}"; do + tok="${tok%\"}"; tok="${tok#\"}" + tok="${tok%\'}"; tok="${tok#\'}" + [[ -z $tok ]] && continue + [[ $tok == *=* && $tok != /* ]] && continue # VAR=value prefix + [[ $tok == env ]] && continue + prog="$tok" + break + done + + [[ -n $prog ]] || return 1 + + case "${prog##*/}" in + sh|bash|dash|zsh|fish) return 1 ;; + esac + + # PATH is searched here rather than with `command -v`, which is a builtin + # but would have to be read back through a command substitution, and that + # is a fork per desktop entry. + if [[ $prog != /* ]]; then + local d found='' + local -a pathdirs + IFS=: read -r -a pathdirs <<< "$PATH" + for d in "${pathdirs[@]}"; do + [[ -n $d ]] || continue + if [[ -x "$d/$prog" && ! -d "$d/$prog" ]]; then found="$d/$prog"; break; fi + done + [[ -n $found ]] || return 1 + prog="$found" + fi + + MCA_PROG="$prog" +} + +# mca_exec_flatpak_id +# The application id out of a `flatpak run ...` command line, in MCA_PROG. +mca_exec_flatpak_id() { + local line="$1" tok seen_run=0 + local -a tokens + read -r -a tokens <<< "$line" + + MCA_PROG='' + for tok in "${tokens[@]}"; do + if (( ! seen_run )); then + [[ $tok == run ]] && seen_run=1 + continue + fi + [[ $tok == -* || $tok == @@* || $tok == %* ]] && continue + [[ $tok == *.*.* ]] || continue + MCA_PROG="$tok" + return 0 + done + return 1 +} + +# --------------------------------------------------------------------------- +# Is this Chromium? +# --------------------------------------------------------------------------- + +# Answers are cached against size and mtime, because the systemd path unit can +# fire several times in a row while a package installs and each miss costs a +# scan of a 200 MB binary. +# +# The file is read once into memory rather than searched per lookup: a scan +# asks about every program on the system, and an awk per question is most of +# the time the scan takes. +declare -A MCA_DETECT_MEMO=() +declare -A MCA_DETECT_CACHE=() +MCA_CACHE_LOADED=0 +MCA_CACHE_DIRTY=0 + +# Size and mtime for every program the scan is about to ask about, collected in +# one call. Checking a cache entry is still stale needs a stat, and one stat per +# program on the system was most of what a warm scan spent its time on. +declare -A MCA_STAT=() + +_mca_stat_batch() { + local name st + (( $# )) || return 0 + while IFS=$'\t' read -r name st; do + [[ -n $name ]] && MCA_STAT["$name"]="$st" + done < <(stat -Lc '%n %s:%Y' -- "$@" 2>/dev/null) + return 0 +} + +_mca_cache_load() { + local path stamp verdict + + (( MCA_CACHE_LOADED )) && return 0 + MCA_CACHE_LOADED=1 + + [[ -r "$MCA_CACHEDIR/detect" ]] || return 0 + while IFS=$'\t' read -r path stamp verdict; do + [[ -n $path && -n $stamp ]] || continue + MCA_DETECT_CACHE["$path"]="$stamp"$'\t'"$verdict" + done < "$MCA_CACHEDIR/detect" + return 0 +} + +# Written back once, at exit, instead of after every miss. +mca_cache_flush() { + local path entry tmp + + (( MCA_CACHE_DIRTY )) || return 0 + mkdir -p "$MCA_CACHEDIR" 2>/dev/null || return 0 + + tmp="$(mktemp "$MCA_CACHEDIR/detect.XXXXXX")" || return 0 + for path in "${!MCA_DETECT_CACHE[@]}"; do + entry="${MCA_DETECT_CACHE[$path]}" + printf '%s\t%s\n' "$path" "$entry" >> "$tmp" + done + mv -f "$tmp" "$MCA_CACHEDIR/detect" 2>/dev/null || rm -f "$tmp" + MCA_CACHE_DIRTY=0 + return 0 +} + +# _mca_has_markers +_mca_has_markers() { + local dir="$1" m s + + [[ -d $dir ]] || return 1 + dir="${dir%/}" + for s in "${MCA_SYSTEM_DIRS[@]}"; do + [[ $dir == "$s" ]] && return 1 + done + + for m in "${MCA_MARKERS[@]}"; do + [[ -e "$dir/$m" ]] && return 0 + done + [[ -e "$dir/resources/app.asar" || -e "$dir/app.asar" ]] && return 0 + return 1 +} + +# _mca_script_target