deeaitch/yourls-ui
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial commit

Browse Source
This commit is contained in:
deeaitch committed 2026-10-01 11:53:34 -04:00
commit 90f6666986
18 files changed
+1740
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

.gitignore
+1
View File
@@ -0,0 +1 @@
*.user
LICENSE
+232
View File
@@ -0,0 +1,232 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Preamble
The GNU 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.
kindle2latex
Copyright (C) 2026 gpl
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 <https://www.gnu.org/licenses/>.
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:
kindle2latex Copyright (C) 2026 gpl
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 <https://www.gnu.org/licenses/>.
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 <https://www.gnu.org/philosophy/why-not-lgpl.html>.
README.md
+252
View File
@@ -0,0 +1,252 @@
# yourls-ui
Small Qt tray utility for shortening URLs using the **YOURLS API**.
The application sits in the system tray and allows quickly shortening the URL currently stored in the clipboard.
It was designed as a lightweight helper for everyday use with a self-hosted YOURLS instance.
---
# Features (v0.1)
- System tray application
- Simple configuration window
- Uses YOURLS API with **signature authentication**
- Reads URL from clipboard
- Generates a short URL
- Copies the short URL back to clipboard
- Shows popup with clickable link
- Error reporting with API response
---
# How it works
1. Application starts
2. If configuration exists → it goes directly to the **system tray**
3. If configuration is missing → **settings window opens**
From the tray menu you can run:
```
Cut URL
```
The application will:
1. Read the current clipboard
2. Check if the content is a valid URL
3. Call the YOURLS API
4. Receive a shortened link
5. Copy the shortened link back to clipboard
6. Show a popup window with the result
If YOURLS returns HTTP 400 with `error:url` and an existing short link for
the same source URL, the application uses that link as a successful result.
On Wayland, `Cut URL` opens a small window when the application is inactive.
Activate it to allow clipboard access; the URL is read automatically once
the clipboard becomes available. You can also click `Read clipboard`, or cancel.
The result window copies the short URL after gaining focus and displays whether
the copy succeeded. Clicking `OK` retries and verifies the copy before closing.
---
# Configuration
The settings window contains:
```
API URL
API signature
```
Example:
```
API URL:
https://example.com/yourls-api.php
Signature:
ABC123
```
⚠️ Important:
The signature field must contain **only the signature value**, not:
```
signature=ABC123
```
Correct:
```
ABC123
```
---
# Tray menu
Right click the tray icon to access the menu:
```
Cut URL
Help
About
Exit
```
Double clicking the tray icon opens the settings window.
---
# Building
Requirements:
```
Qt 6
Qt Widgets
Qt Network
qmake from Qt 6 (qmake6 on this system)
C++17 compiler
```
Build:
```bash
mkdir -p build-qt6
cd build-qt6
qmake6 ../yourls-ui.pro
make
```
The Qt 6 qmake executable may be named `qmake` on other systems; check its
version with `qmake -v` before building.
Or open `yourls-ui.pro` in **Qt Creator**, select a Qt 6 kit and use a new
build directory separate from any existing Qt 5 build.
---
# Debugging clipboard URLs
Build and run a debug executable from a terminal:
```bash
mkdir -p build/Desktop-Debug
cd build/Desktop-Debug
qmake6 ../../yourls-ui.pro CONFIG+=debug CONFIG-=release
make
./yourls-ui 2>clipboard-debug.log
```
Exit any already running instance before starting this executable. Choose
`Cut URL` and inspect `clipboard-debug.log`. Debug builds log the executable
path, Qt platform, clipboard MIME formats, raw text and its UTF-8 hex bytes,
parsed URL, request stage, HTTP status and API status. The API signature and
full request query are not logged. Clipboard diagnostics may contain private
URLs; review the log before sharing it. These diagnostics are compiled out of
release builds using `QT_NO_DEBUG`.
---
# Project structure
```
main.cpp
Application entry point
mainwindow.h / mainwindow.cpp
Main application window
Tray integration
UI logic
mainwindow.ui
Qt Designer UI for settings window
yourlsclient.h / yourlsclient.cpp
YOURLS API client
Handles HTTP requests and responses
```
The YOURLS API communication is encapsulated in `YourlsClient`.
---
# API call
The application performs a request similar to:
```
GET /yourls-api.php
?action=shorturl
&format=json
&signature=<signature>
&url=<url>
```
Example:
```
https://example.com/yourls-api.php?action=shorturl&format=json&signature=ABC123&url=https://example.com
```
---
# Future ideas
Possible improvements for future versions:
### Hotkey support
Global hotkey to trigger URL shortening.
### Clipboard watcher
Automatically detect URLs copied to clipboard.
### Tray notifications
Use system notifications instead of popup dialog.
### Recent history
Store last shortened URLs.
### Custom alias
Allow specifying custom short URL alias.
### Open YOURLS admin
Add tray menu entry for opening YOURLS admin panel.
### Packaging
Provide:
```
AppImage
.deb package
```
---
# Version
```
v0.1
```
Initial working release.
---
# Author
```
deeaitch
```
---
# License
GPL
clipboardresultdialog.h
+62
View File
@@ -0,0 +1,62 @@
#ifndef CLIPBOARDRESULTDIALOG_H
#define CLIPBOARDRESULTDIALOG_H
#include <QClipboard>
#include <QDialog>
#include <QEvent>
#include <QGuiApplication>
#include <QLabel>
#include <QTimer>
#include <QUrl>
#ifndef QT_NO_DEBUG
#include <QDebug>
#endif
// Keep the result window focused while taking ownership of the clipboard.
class ClipboardResultDialog : public QDialog {
public:
ClipboardResultDialog (const QUrl &url, bool requiresFocus, QWidget *parent = nullptr)
: QDialog (parent), m_text (url.toString (QUrl::FullyEncoded)),
m_requiresFocus (requiresFocus), m_status (new QLabel (this)) {
m_status->setText (QStringLiteral ("Activate this window to copy the short URL."));
m_status->setWordWrap (true);
}
QLabel *copyStatusLabel() const { return m_status; }
bool copyShortUrl() {
if (m_requiresFocus && !isActiveWindow())
return false;
auto *clipboard = QGuiApplication::clipboard();
clipboard->setText (m_text, QClipboard::Clipboard);
const bool copied = clipboard->text (QClipboard::Clipboard) == m_text
&& (!QGuiApplication::platformName().startsWith (QStringLiteral ("wayland"))
|| clipboard->ownsClipboard());
m_status->setText (copied ? QStringLiteral ("Short URL copied to clipboard.")
: QStringLiteral ("Could not copy the short URL. Click OK to retry."));
#ifndef QT_NO_DEBUG
qDebug() << "[clipboard] short URL write, active:" << isActiveWindow()
<< "owns clipboard:" << clipboard->ownsClipboard() << "verified:" << copied;
#endif
return copied;
}
protected:
void changeEvent (QEvent *event) override {
QDialog::changeEvent (event);
if (event->type() == QEvent::ActivationChange && isActiveWindow()) {
// Let Qt finish processing the focus event and its Wayland input serial.
QTimer::singleShot (0, this, [this]() {
if (isActiveWindow())
copyShortUrl();
});
}
}
private:
QString m_text;
bool m_requiresFocus;
QLabel *m_status;
};
#endif // CLIPBOARDRESULTDIALOG_H
clipboardurl.h
+73
View File
@@ -0,0 +1,73 @@
#ifndef CLIPBOARDURL_H
#define CLIPBOARDURL_H
#include <QMimeData>
#include <QRegularExpression>
#include <QUrl>
#ifndef QT_NO_DEBUG
#include <QDebug>
#endif
namespace ClipboardUrl {
inline QUrl parseText (const QString &text) {
QString urlText = text.trimmed();
#ifndef QT_NO_DEBUG
qDebug() << "[clipboard] raw text:" << text
<< "UTF-8 hex:" << text.toUtf8().toHex();
#endif
if (urlText.size() >= 2) {
const QChar first = urlText.front();
const QChar last = urlText.back();
if ((first == '\'' && last == '\'') || (first == '"' && last == '"')
|| (first == '<' && last == '>'))
urlText = urlText.mid (1, urlText.size() - 2).trimmed();
}
static const QRegularExpression markdownLink (
QStringLiteral ("\\A\\[[^\\r\\n]*\\]\\((https?://[^\\r\\n]+)\\)\\z"),
QRegularExpression::CaseInsensitiveOption);
const auto match = markdownLink.match (urlText);
if (match.hasMatch())
urlText = match.captured (1);
const QUrl url = QUrl::fromUserInput (urlText);
#ifndef QT_NO_DEBUG
qDebug() << "[clipboard] normalized text:" << urlText
<< "parsed URL:" << url << "valid:" << url.isValid()
<< "scheme:" << url.scheme() << "host:" << url.host()
<< "parse error:" << url.errorString();
#endif
if (!url.isValid() || url.scheme().isEmpty() || url.host().isEmpty())
return QUrl();
return url;
}
inline QUrl fromMimeData (const QMimeData *mimeData) {
if (mimeData == nullptr) {
#ifndef QT_NO_DEBUG
qDebug() << "[clipboard] MIME data unavailable";
#endif
return QUrl();
}
const auto urls = mimeData->urls();
#ifndef QT_NO_DEBUG
qDebug() << "[clipboard] MIME formats:" << mimeData->formats()
<< "URL entries:" << urls;
#endif
if (urls.size() == 1) {
const QUrl url = urls.first();
if (url.isValid() && !url.scheme().isEmpty() && !url.host().isEmpty()) {
#ifndef QT_NO_DEBUG
qDebug() << "[clipboard] using MIME URL:" << url;
#endif
return url;
}
}
return parseText (mimeData->text());
}
} // namespace ClipboardUrl
#endif // CLIPBOARDURL_H
main.cpp
+14
View File
@@ -0,0 +1,14 @@
#include "mainwindow.h"
#include <QApplication>
#include <QCoreApplication>
int main (int argc, char *argv[]) {
QApplication application (argc, argv);
QCoreApplication::setOrganizationName (QStringLiteral ("deeaitch"));
QCoreApplication::setApplicationName (QStringLiteral ("yourls-ui"));
MainWindow window;
window.show();
return application.exec();
}
mainwindow.cpp
+423
View File
@@ -0,0 +1,423 @@
#include "mainwindow.h"
#include "clipboardurl.h"
#include "clipboardresultdialog.h"
#include "ui_mainwindow.h"
#include "yourlsclient.h"
#include <QAction>
#include <QApplication>
#include <QClipboard>
#include <QCloseEvent>
#include <QCoreApplication>
#include <QDialog>
#include <QDialogButtonBox>
#include <QGuiApplication>
#include <QLabel>
#include <QMenu>
#include <QMessageBox>
#include <QPushButton>
#include <QSettings>
#include <QStatusBar>
#include <QStyle>
#include <QTimer>
#include <QVBoxLayout>
namespace {
/**
* @brief Builds a clickable HTML link for dialogs.
* @param url URL to render.
* @return Rich text string.
*/
QString makeLinkHtml (const QUrl &url) {
const QString urlText = url.toDisplayString();
return QStringLiteral ("<a href=\"%1\">%2</a>")
.arg (url.toString (QUrl::FullyEncoded), urlText.toHtmlEscaped());
}
/**
* @brief Returns the organization name used by QSettings.
* @return Organization string.
*/
QString settingsOrganization() {
return QStringLiteral ("deeaitch");
}
/**
* @brief Returns the application name used by QSettings.
* @return Application string.
*/
QString settingsApplication() {
return QStringLiteral ("yourls-ui");
}
} // namespace
/**
* @brief Constructs the main window.
* @param parent Parent widget.
*/
MainWindow::MainWindow (QWidget *parent)
: QMainWindow (parent)
, ui (new Ui::MainWindow)
, m_trayIcon (nullptr)
, m_trayMenu (nullptr)
, m_cutUrlAction (nullptr)
, m_settingsAction (nullptr)
, m_helpAction (nullptr)
, m_aboutAction (nullptr)
, m_exitAction (nullptr)
, m_yourlsClient (new YourlsClient (this)) {
ui->setupUi (this);
#ifndef QT_NO_DEBUG
qDebug() << "[yourls-ui] debug build, executable:" << QCoreApplication::applicationFilePath()
<< "Qt:" << qVersion() << "platform:" << QGuiApplication::platformName();
#endif
setWindowTitle (QStringLiteral ("yourls-ui settings"));
ui->apiKeyLineEdit->setEchoMode (QLineEdit::Password);
statusBar()->showMessage (QStringLiteral ("Configure YOURLS API settings and save."));
setupMenuActions();
setupTray();
setupConnections();
loadSettings();
connect (m_yourlsClient, &YourlsClient::shortenSucceeded, this, &MainWindow::onShortenSucceeded);
connect (m_yourlsClient, &YourlsClient::shortenFailed, this, &MainWindow::onShortenFailed);
if (hasValidSettings()) {
if (m_trayIcon != nullptr)
m_trayIcon->show();
QTimer::singleShot (0, this, &MainWindow::hideToTray);
}
}
/**
* @brief Destroys the main window.
*/
MainWindow::~MainWindow() {
delete ui;
}
/**
* @brief Handles close requests.
* @param event Close event.
*/
void MainWindow::closeEvent (QCloseEvent *event) {
if (hasValidSettings() && m_trayIcon != nullptr && m_trayIcon->isVisible()) {
hideToTray();
event->ignore();
return;
}
QMainWindow::closeEvent (event);
}
/**
* @brief Saves settings from the UI.
*/
void MainWindow::saveSettings() {
const QString apiUrl = ui->urlLineEdit->text().trimmed();
const QString apiKey = ui->apiKeyLineEdit->text().trimmed();
if (apiUrl.isEmpty()) {
QMessageBox::warning (this, QStringLiteral ("Missing API URL"), QStringLiteral ("Please enter the YOURLS API URL."));
return;
}
if (apiKey.isEmpty()) {
QMessageBox::warning (this, QStringLiteral ("Missing API key"), QStringLiteral ("Please enter the YOURLS API signature."));
return;
}
const QUrl parsedApiUrl (apiUrl);
if (!parsedApiUrl.isValid() || parsedApiUrl.scheme().isEmpty() || parsedApiUrl.host().isEmpty()) {
QMessageBox::warning (this,
QStringLiteral ("Invalid API URL"),
QStringLiteral ("The configured API URL does not look valid."));
return;
}
QSettings settings (settingsOrganization(), settingsApplication());
settings.setValue (QStringLiteral ("api/url"), apiUrl);
settings.setValue (QStringLiteral ("api/signature"), apiKey);
settings.sync();
if (m_trayIcon != nullptr)
m_trayIcon->show();
statusBar()->showMessage (QStringLiteral ("Settings saved."), 2000);
hideToTray();
}
/**
* @brief Shows About text.
*/
void MainWindow::showAbout() {
QMessageBox::about (this,
QStringLiteral ("About yourls-ui"),
QStringLiteral ("yourls-ui\n\n"
"Small tray utility for shortening clipboard URLs with a YOURLS API.\n\n"
"Creator: deeaitch\n"
"Created: 2026-03-16"));
}
/**
* @brief Shows Help text.
*/
void MainWindow::showHelp() {
QMessageBox::information (this,
QStringLiteral ("Help"),
QStringLiteral ("1. Open Settings and enter the YOURLS API URL and signature.\n"
"2. Save the settings. The application will stay in the tray.\n"
"3. Copy a full URL to the clipboard.\n"
"4. Right-click the tray icon and choose \"Cut URL\".\n"
"5. The short URL will be copied back to the clipboard and shown in a popup.\n\n"
"If something fails, the program shows detailed error information."));
}
/**
* @brief Shows the settings window.
*/
void MainWindow::showSettingsWindow() {
showNormal();
raise();
activateWindow();
}
/**
* @brief Hides the settings window to tray when possible.
*/
void MainWindow::hideToTray() {
if (!hasValidSettings() || m_trayIcon == nullptr
|| !QSystemTrayIcon::isSystemTrayAvailable() || !m_trayIcon->isVisible()) {
showSettingsWindow();
return;
}
hide();
if (m_trayIcon != nullptr && m_trayIcon->isVisible()) {
m_trayIcon->showMessage (QStringLiteral ("yourls-ui"),
QStringLiteral ("The application is running in the system tray."),
QSystemTrayIcon::Information,
2000);
}
}
/**
* @brief Exits the application.
*/
void MainWindow::exitApplication() {
QApplication::quit();
}
/**
* @brief Handles tray icon activation.
* @param reason Activation reason.
*/
void MainWindow::onTrayIconActivated (QSystemTrayIcon::ActivationReason reason) {
if (reason == QSystemTrayIcon::DoubleClick || reason == QSystemTrayIcon::Trigger)
showSettingsWindow();
}
/**
* @brief Reads a URL from the clipboard and shortens it.
*/
void MainWindow::cutUrlFromClipboard() {
if (!hasValidSettings()) {
QMessageBox::warning (this,
QStringLiteral ("Settings required"),
QStringLiteral ("Please configure the API URL and signature first."));
showSettingsWindow();
return;
}
QUrl longUrl;
if (QGuiApplication::platformName().startsWith (QStringLiteral ("wayland"))
&& !isActiveWindow()) {
// Wayland delivers clipboard offers to clients with keyboard focus.
// A tray menu belongs to the shell and does not focus our application.
QDialog clipboardDialog (this);
clipboardDialog.setWindowTitle (QStringLiteral ("Read clipboard URL"));
auto *layout = new QVBoxLayout (&clipboardDialog);
layout->addWidget (new QLabel (
QStringLiteral ("Activate this window to read the URL from the clipboard."), &clipboardDialog));
auto *buttons = new QDialogButtonBox (QDialogButtonBox::Cancel, &clipboardDialog);
auto *readButton = buttons->addButton (QStringLiteral ("Read clipboard"), QDialogButtonBox::AcceptRole);
layout->addWidget (buttons);
connect (buttons, &QDialogButtonBox::rejected, &clipboardDialog, &QDialog::reject);
const auto readClipboard = [&]() {
longUrl = ClipboardUrl::fromMimeData (QGuiApplication::clipboard()->mimeData());
clipboardDialog.accept();
};
connect (readButton, &QPushButton::clicked, &clipboardDialog, readClipboard);
// Wait for focus and the clipboard offer, without blocking the event loop.
QTimer pollTimer (&clipboardDialog);
int activePolls = 0;
connect (&pollTimer, &QTimer::timeout, &clipboardDialog, [&]() {
if (!clipboardDialog.isActiveWindow())
return;
const auto *mimeData = QGuiApplication::clipboard()->mimeData();
if ((mimeData != nullptr && !mimeData->formats().isEmpty())
|| ++activePolls >= 20)
readClipboard();
});
#ifndef QT_NO_DEBUG
qDebug() << "[clipboard] Wayland: waiting for focused window and clipboard offer";
#endif
pollTimer.start (100);
if (clipboardDialog.exec() != QDialog::Accepted)
return;
pollTimer.stop();
} else {
longUrl = ClipboardUrl::fromMimeData (QGuiApplication::clipboard()->mimeData());
}
#ifndef QT_NO_DEBUG
qDebug() << "[clipboard] final URL:" << longUrl << "valid:" << longUrl.isValid();
#endif
if (!longUrl.isValid()) {
#ifndef QT_NO_DEBUG
qDebug() << "[clipboard] rejected locally; no YOURLS request sent";
#endif
QMessageBox::warning (this,
QStringLiteral ("Invalid clipboard content"),
QStringLiteral ("The clipboard does not contain a valid URL."));
return;
}
YourlsSettings settings;
settings.apiUrl = ui->urlLineEdit->text().trimmed();
settings.signature = ui->apiKeyLineEdit->text().trimmed();
if (m_trayIcon != nullptr) {
m_trayIcon->showMessage (QStringLiteral ("yourls-ui"),
QStringLiteral ("Requesting short URL..."),
QSystemTrayIcon::Information,
1200);
}
m_yourlsClient->shortenUrl (settings, longUrl);
}
/**
* @brief Handles successful shortening.
* @param shortUrl Generated short URL.
*/
void MainWindow::onShortenSucceeded (const QUrl &shortUrl) {
showShortUrlPopup (shortUrl);
}
/**
* @brief Handles shortening failure.
* @param details Detailed error text.
*/
void MainWindow::onShortenFailed (const QString &details) {
QMessageBox::critical (this, QStringLiteral ("Failed to create short URL"), details);
}
/**
* @brief Creates tray icon and tray menu.
*/
void MainWindow::setupTray() {
if (!QSystemTrayIcon::isSystemTrayAvailable()) {
QMessageBox::warning (this,
QStringLiteral ("System tray unavailable"),
QStringLiteral ("No system tray was detected. The application will stay as a normal window."));
return;
}
m_trayIcon = new QSystemTrayIcon (this);
m_trayIcon->setIcon (style()->standardIcon (QStyle::SP_DialogApplyButton));
m_trayMenu = new QMenu (this);
m_trayMenu->addAction (m_cutUrlAction);
m_trayMenu->addSeparator();
m_trayMenu->addAction (m_settingsAction);
m_trayMenu->addAction (m_helpAction);
m_trayMenu->addAction (m_aboutAction);
m_trayMenu->addSeparator();
m_trayMenu->addAction (m_exitAction);
m_trayIcon->setContextMenu (m_trayMenu);
}
/**
* @brief Connects UI signals to slots.
*/
void MainWindow::setupConnections() {
connect (ui->saveBtn, &QPushButton::clicked, this, &MainWindow::saveSettings);
connect (ui->actionHelp, &QAction::triggered, this, &MainWindow::showHelp);
connect (ui->actionAbout, &QAction::triggered, this, &MainWindow::showAbout);
connect (ui->actionExit, &QAction::triggered, this, &MainWindow::exitApplication);
connect (m_cutUrlAction, &QAction::triggered, this, &MainWindow::cutUrlFromClipboard);
connect (m_settingsAction, &QAction::triggered, this, &MainWindow::showSettingsWindow);
connect (m_helpAction, &QAction::triggered, this, &MainWindow::showHelp);
connect (m_aboutAction, &QAction::triggered, this, &MainWindow::showAbout);
connect (m_exitAction, &QAction::triggered, this, &MainWindow::exitApplication);
if (m_trayIcon != nullptr)
connect (m_trayIcon, &QSystemTrayIcon::activated, this, &MainWindow::onTrayIconActivated);
}
/**
* @brief Loads persisted settings into the UI.
*/
void MainWindow::loadSettings() {
QSettings settings (settingsOrganization(), settingsApplication());
ui->urlLineEdit->setText (settings.value (QStringLiteral ("api/url")).toString());
ui->apiKeyLineEdit->setText (settings.value (QStringLiteral ("api/signature")).toString());
}
/**
* @brief Returns true when all required settings are present.
* @return True when the application can work from the tray.
*/
bool MainWindow::hasValidSettings() const {
return !ui->urlLineEdit->text().trimmed().isEmpty()
&& !ui->apiKeyLineEdit->text().trimmed().isEmpty();
}
/**
* @brief Shows a popup with the generated short URL.
* @param shortUrl Generated short URL.
*/
void MainWindow::showShortUrlPopup (const QUrl &shortUrl) {
const bool wayland = QGuiApplication::platformName().startsWith (QStringLiteral ("wayland"));
ClipboardResultDialog dialog (shortUrl, wayland, this);
dialog.setWindowTitle (QStringLiteral ("Short URL created"));
auto *layout = new QVBoxLayout (&dialog);
auto *label = new QLabel (QStringLiteral ("Generated short URL:<br>%1").arg (makeLinkHtml (shortUrl)), &dialog);
label->setTextFormat (Qt::RichText);
label->setTextInteractionFlags (Qt::TextBrowserInteraction);
label->setOpenExternalLinks (true);
layout->addWidget (label);
layout->addWidget (dialog.copyStatusLabel());
auto *buttons = new QDialogButtonBox (QDialogButtonBox::Ok, &dialog);
QObject::connect (buttons, &QDialogButtonBox::accepted, &dialog, [&dialog]() {
// An OK click supplies focus/input even when automatic activation was denied.
if (dialog.copyShortUrl())
dialog.accept();
});
layout->addWidget (buttons);
if (!wayland)
dialog.copyShortUrl();
dialog.exec();
}
/**
* @brief Creates tray/menu actions.
*/
void MainWindow::setupMenuActions() {
m_cutUrlAction = new QAction (QStringLiteral ("Cut URL"), this);
m_settingsAction = new QAction (QStringLiteral ("Settings"), this);
m_helpAction = new QAction (QStringLiteral ("Help"), this);
m_aboutAction = new QAction (QStringLiteral ("About"), this);
m_exitAction = new QAction (QStringLiteral ("Exit"), this);
}
mainwindow.h
+146
View File
@@ -0,0 +1,146 @@
#ifndef MAINWINDOW_H
#define MAINWINDOW_H
#include <QMainWindow>
#include <QSystemTrayIcon>
#include <QUrl>
QT_BEGIN_NAMESPACE
namespace Ui {
class MainWindow;
}
QT_END_NAMESPACE
class QAction;
class QCloseEvent;
class QMenu;
class YourlsClient;
/**
* @brief Main application window used as the settings page.
*
* When valid settings exist the application starts in the tray.
* The tray menu contains the main workflow action, "Cut URL",
* plus Help, About, Settings and Exit.
*/
class MainWindow : public QMainWindow {
Q_OBJECT
public:
/**
* @brief Constructs the main window.
* @param parent Parent widget.
*/
explicit MainWindow (QWidget *parent = nullptr);
/**
* @brief Destroys the main window.
*/
~MainWindow() override;
protected:
/**
* @brief Handles close requests.
* @param event Close event.
*/
void closeEvent (QCloseEvent *event) override;
private slots:
/**
* @brief Saves settings from the UI.
*/
void saveSettings();
/**
* @brief Shows About text.
*/
void showAbout();
/**
* @brief Shows Help text.
*/
void showHelp();
/**
* @brief Shows the settings window.
*/
void showSettingsWindow();
/**
* @brief Hides the settings window to tray when possible.
*/
void hideToTray();
/**
* @brief Exits the application.
*/
void exitApplication();
/**
* @brief Handles tray icon activation.
* @param reason Activation reason.
*/
void onTrayIconActivated (QSystemTrayIcon::ActivationReason reason);
/**
* @brief Reads a URL from the clipboard and shortens it.
*/
void cutUrlFromClipboard();
/**
* @brief Handles successful shortening.
* @param shortUrl Generated short URL.
*/
void onShortenSucceeded (const QUrl &shortUrl);
/**
* @brief Handles shortening failure.
* @param details Detailed error text.
*/
void onShortenFailed (const QString &details);
private:
/**
* @brief Creates tray icon and tray menu.
*/
void setupTray();
/**
* @brief Connects UI signals to slots.
*/
void setupConnections();
/**
* @brief Loads persisted settings into the UI.
*/
void loadSettings();
/**
* @brief Returns true when all required settings are present.
* @return True when the application can work from the tray.
*/
bool hasValidSettings() const;
/**
* @brief Shows a popup with the generated short URL.
* @param shortUrl Generated short URL.
*/
void showShortUrlPopup (const QUrl &shortUrl);
/**
* @brief Creates tray/menu actions.
*/
void setupMenuActions();
Ui::MainWindow *ui;
QSystemTrayIcon *m_trayIcon;
QMenu *m_trayMenu;
QAction *m_cutUrlAction;
QAction *m_settingsAction;
QAction *m_helpAction;
QAction *m_aboutAction;
QAction *m_exitAction;
YourlsClient *m_yourlsClient;
};
#endif // MAINWINDOW_H
mainwindow.ui
+109
View File
@@ -0,0 +1,109 @@
<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
<class>MainWindow</class>
<widget class="QMainWindow" name="MainWindow">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>420</width>
<height>204</height>
</rect>
</property>
<property name="windowTitle">
<string>yourls-ui settings</string>
</property>
<widget class="QWidget" name="centralwidget">
<layout class="QGridLayout" name="gridLayout">
<item row="0" column="0">
<widget class="QLabel" name="apiUrlLoabel">
<property name="text">
<string>API URL</string>
</property>
</widget>
</item>
<item row="0" column="1" colspan="2">
<widget class="QLineEdit" name="urlLineEdit"/>
</item>
<item row="1" column="0">
<widget class="QLabel" name="apiKeyLobal">
<property name="text">
<string>API KEY</string>
</property>
</widget>
</item>
<item row="1" column="1" colspan="2">
<widget class="QLineEdit" name="apiKeyLineEdit"/>
</item>
<item row="2" column="0" colspan="2">
<spacer name="horizontalSpacer">
<property name="orientation">
<enum>Qt::Horizontal</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
<width>258</width>
<height>20</height>
</size>
</property>
</spacer>
</item>
<item row="2" column="2">
<widget class="QPushButton" name="saveBtn">
<property name="text">
<string>Save</string>
</property>
</widget>
</item>
</layout>
</widget>
<widget class="QStatusBar" name="statusbar"/>
<widget class="QMenuBar" name="menubar">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>420</width>
<height>22</height>
</rect>
</property>
<widget class="QMenu" name="menuFile">
<property name="title">
<string>File</string>
</property>
<addaction name="actionHelp"/>
<addaction name="actionAbout"/>
<addaction name="actionExit"/>
</widget>
<addaction name="menuFile"/>
</widget>
<widget class="QToolBar" name="toolBar">
<property name="windowTitle">
<string>toolBar</string>
</property>
<attribute name="toolBarArea">
<enum>TopToolBarArea</enum>
</attribute>
<attribute name="toolBarBreak">
<bool>false</bool>
</attribute>
</widget>
<action name="actionHelp">
<property name="text">
<string>Help</string>
</property>
</action>
<action name="actionAbout">
<property name="text">
<string>About</string>
</property>
</action>
<action name="actionExit">
<property name="text">
<string>Exit</string>
</property>
</action>
</widget>
<resources/>
<connections/>
</ui>
tests/clipboardresultdialog_test.cpp
+40
View File
@@ -0,0 +1,40 @@
#include "../clipboardresultdialog.h"
#include <QTest>
class ClipboardResultDialogTest : public QObject {
Q_OBJECT
private slots:
void inactiveWindowDoesNotOverwriteClipboard() {
auto *clipboard = QGuiApplication::clipboard();
clipboard->setText (QStringLiteral ("original"));
ClipboardResultDialog dialog (QUrl (QStringLiteral ("https://cut.himro.ca/h")), true);
QVERIFY (!dialog.copyShortUrl());
QCOMPARE (clipboard->text(), QStringLiteral ("original"));
}
void focusCopiesAndRetryRestoresShortUrl() {
const QUrl shortUrl (QStringLiteral ("https://cut.himro.ca/h?value=a%26b#section"));
auto *clipboard = QGuiApplication::clipboard();
clipboard->setText (QStringLiteral ("original"));
ClipboardResultDialog dialog (shortUrl, true);
dialog.show();
dialog.activateWindow();
QTRY_VERIFY (dialog.isActiveWindow());
QTRY_COMPARE (clipboard->text(), shortUrl.toString (QUrl::FullyEncoded));
QVERIFY (dialog.copyStatusLabel()->text().contains (QStringLiteral ("copied")));
clipboard->setText (QStringLiteral ("other text"));
QVERIFY (dialog.copyShortUrl());
QCOMPARE (clipboard->text(), shortUrl.toString (QUrl::FullyEncoded));
dialog.accept();
QCOMPARE (clipboard->text(), shortUrl.toString (QUrl::FullyEncoded));
}
void platformsWithoutFocusRequirementCopyImmediately() {
ClipboardResultDialog dialog (QUrl (QStringLiteral ("https://cut.himro.ca/h")), false);
QVERIFY (dialog.copyShortUrl());
QCOMPARE (QGuiApplication::clipboard()->text(), QStringLiteral ("https://cut.himro.ca/h"));
}
};
QTEST_MAIN (ClipboardResultDialogTest)
#include "clipboardresultdialog_test.moc"
tests/clipboardresultdialog_test.pro
+7
View File
@@ -0,0 +1,7 @@
QT = core gui widgets testlib
CONFIG += console c++17 testcase
CONFIG -= app_bundle
TEMPLATE = app
TARGET = clipboardresultdialog_test
SOURCES += clipboardresultdialog_test.cpp
HEADERS += ../clipboardresultdialog.h
tests/clipboardurl_test.cpp
+52
View File
@@ -0,0 +1,52 @@
#include "../clipboardurl.h"
#include <QCoreApplication>
#include <QDebug>
int main (int argc, char **argv) {
QCoreApplication application (argc, argv);
const QUrl expected (QStringLiteral ("https://git.himro.ca/explore/repos"));
int failures = 0;
const auto check = [&failures] (bool condition, const char *description) {
if (!condition) {
qCritical() << description;
++failures;
}
};
for (const auto &text : {
"https://git.himro.ca/explore/repos",
" \nhttps://git.himro.ca/explore/repos\n ",
"'https://git.himro.ca/explore/repos'",
"\"https://git.himro.ca/explore/repos\"",
"<https://git.himro.ca/explore/repos>",
"[https://git.himro.ca/explore/repos](https://git.himro.ca/explore/repos)",
"'[Repositories](https://git.himro.ca/explore/repos)'"}) {
check (ClipboardUrl::parseText (QString::fromUtf8 (text)) == expected, text);
}
check (ClipboardUrl::parseText (QStringLiteral (
"[Other label](https://git.himro.ca/explore/repos?filter=a%26b#section)"))
== QUrl (QStringLiteral ("https://git.himro.ca/explore/repos?filter=a%26b#section")),
"Markdown must use the destination and preserve query and fragment");
check (ClipboardUrl::parseText (QStringLiteral ("[Link](https://example.com/a_(b))"))
== QUrl (QStringLiteral ("https://example.com/a_(b)")),
"Parentheses in URL paths must be preserved");
for (const auto &text : {"", "not a URL", "https://", "[Link](https://)"})
check (!ClipboardUrl::parseText (QString::fromUtf8 (text)).isValid(), text);
QMimeData mimeData;
mimeData.setText (QStringLiteral ("Repositories"));
mimeData.setUrls ({expected});
check (ClipboardUrl::fromMimeData (&mimeData) == expected,
"Browser URL MIME data must take precedence over a link label");
mimeData.clear();
mimeData.setText (expected.toString());
check (ClipboardUrl::fromMimeData (&mimeData) == expected, "Plain text fallback");
mimeData.setUrls ({QUrl (QStringLiteral ("file:///tmp/example"))});
check (ClipboardUrl::fromMimeData (&mimeData) == expected, "Unusable MIME URL fallback");
mimeData.clear();
check (!ClipboardUrl::fromMimeData (&mimeData).isValid(), "Empty clipboard");
check (!ClipboardUrl::fromMimeData (nullptr).isValid(), "Unavailable clipboard");
return failures == 0 ? 0 : 1;
}
tests/clipboardurl_test.pro
+7
View File
@@ -0,0 +1,7 @@
QT = core
CONFIG += console c++17
CONFIG -= app_bundle
TEMPLATE = app
TARGET = clipboardurl_test
SOURCES += clipboardurl_test.cpp
HEADERS += ../clipboardurl.h
tests/yourlsclient_test.cpp
+77
View File
@@ -0,0 +1,77 @@
#include "../yourlsclient.h"
#include <QJsonDocument>
#include <QJsonObject>
#include <QSignalSpy>
#include <QTcpServer>
#include <QTcpSocket>
#include <QTest>
#include <QUrlQuery>
class YourlsClientTest : public QObject {
Q_OBJECT
private slots:
void responses_data() {
QTest::addColumn<int> ("httpStatus");
QTest::addColumn<QString> ("status");
QTest::addColumn<QString> ("code");
QTest::addColumn<QString> ("originalUrl");
QTest::addColumn<QString> ("shortUrl");
QTest::addColumn<bool> ("success");
const QString source = QStringLiteral ("https://git.himro.ca/explore/repos?q=a%26b&next=x+y#section");
const QString shortened = QStringLiteral ("https://cut.himro.ca/h");
QTest::newRow ("created") << 200 << "success" << "" << source << shortened << true;
QTest::newRow ("duplicate") << 400 << "fail" << "error:url" << source << shortened << true;
QTest::newRow ("different-url") << 400 << "fail" << "error:url" << "https://example.com" << shortened << false;
QTest::newRow ("missing-short-url") << 400 << "fail" << "error:url" << source << "" << false;
QTest::newRow ("relative-short-url") << 400 << "fail" << "error:url" << source << "/h" << false;
QTest::newRow ("other-error") << 400 << "fail" << "error:auth" << source << shortened << false;
QTest::newRow ("server-error") << 500 << "fail" << "error:url" << source << shortened << false;
}
void responses() {
QFETCH (int, httpStatus);
QFETCH (QString, status);
QFETCH (QString, code);
QFETCH (QString, originalUrl);
QFETCH (QString, shortUrl);
QFETCH (bool, success);
QTcpServer server;
QVERIFY (server.listen (QHostAddress::LocalHost));
QByteArray requestData;
const QByteArray body = QJsonDocument (QJsonObject {
{"status", status}, {"code", code}, {"shorturl", shortUrl},
{"url", QJsonObject {{"url", originalUrl}}}
}).toJson (QJsonDocument::Compact);
connect (&server, &QTcpServer::newConnection, this, [&]() {
auto *socket = server.nextPendingConnection();
connect (socket, &QTcpSocket::readyRead, &server, [&, socket]() {
requestData += socket->readAll();
if (!requestData.contains ("\r\n\r\n"))
return;
socket->write ("HTTP/1.1 " + QByteArray::number (httpStatus)
+ " Result\r\nContent-Type: application/json\r\nContent-Length: "
+ QByteArray::number (body.size()) + "\r\nConnection: close\r\n\r\n" + body);
socket->disconnectFromHost();
});
});
YourlsClient client;
QSignalSpy succeeded (&client, &YourlsClient::shortenSucceeded);
QSignalSpy failed (&client, &YourlsClient::shortenFailed);
const QUrl source (QStringLiteral ("https://git.himro.ca/explore/repos?q=a%26b&next=x+y#section"));
client.shortenUrl ({QStringLiteral ("http://127.0.0.1:%1/api").arg (server.serverPort()),
QStringLiteral ("test-signature")}, source);
QTRY_COMPARE (succeeded.count() + failed.count(), 1);
QCOMPARE (succeeded.count(), success ? 1 : 0);
if (success)
QCOMPARE (succeeded.first().first().toUrl(), QUrl (shortUrl));
const QByteArray target = requestData.split (' ').value (1);
const QUrlQuery query (QUrl::fromEncoded (target));
// Decode the HTTP query once, as the server does, preserving URL escapes.
const QString encodedValue = query.queryItemValue (QStringLiteral ("url"), QUrl::FullyEncoded);
QCOMPARE (QUrl::fromPercentEncoding (encodedValue.toLatin1()), source.toString (QUrl::FullyEncoded));
}
};
QTEST_GUILESS_MAIN (YourlsClientTest)
#include "yourlsclient_test.moc"
tests/yourlsclient_test.pro
+7
View File
@@ -0,0 +1,7 @@
QT = core network testlib
CONFIG += console c++17 testcase
CONFIG -= app_bundle
TEMPLATE = app
TARGET = yourlsclient_test
SOURCES += yourlsclient_test.cpp ../yourlsclient.cpp
HEADERS += ../yourlsclient.h
yourls-ui.pro
+23
View File
@@ -0,0 +1,23 @@
QT += core gui widgets network
CONFIG += c++17
TARGET = yourls-ui
TEMPLATE = app
SOURCES += \
main.cpp \
mainwindow.cpp \
yourlsclient.cpp
HEADERS += \
clipboardresultdialog.h \
clipboardurl.h \
mainwindow.h \
yourlsclient.h
FORMS += \
mainwindow.ui
qnx: target.path = /tmp/$${TARGET}/bin
else: unix:!android: target.path = /opt/$${TARGET}/bin
!isEmpty(target.path): INSTALLS += target
yourlsclient.cpp
+157
View File
@@ -0,0 +1,157 @@
#include "yourlsclient.h"
#include <QJsonDocument>
#include <QJsonObject>
#include <QNetworkAccessManager>
#include <QNetworkReply>
#include <QNetworkRequest>
#include <QUrlQuery>
#ifndef QT_NO_DEBUG
#include <QDebug>
#endif
/**
* @brief Constructs the client.
* @param parent QObject parent.
*/
YourlsClient::YourlsClient (QObject *parent)
: QObject (parent)
, m_networkAccessManager (new QNetworkAccessManager (this)) {
}
/**
* @brief Requests a short URL from the YOURLS API.
* @param settings API endpoint and signature.
* @param longUrl Source URL to shorten.
*/
void YourlsClient::shortenUrl (const YourlsSettings &settings, const QUrl &longUrl) {
#ifndef QT_NO_DEBUG
qDebug() << "[yourls] source URL:" << longUrl << "valid:" << longUrl.isValid()
<< "scheme:" << longUrl.scheme() << "host:" << longUrl.host();
#endif
if (settings.apiUrl.trimmed().isEmpty()) {
emit shortenFailed (QStringLiteral ("API URL is empty."));
return;
}
if (settings.signature.trimmed().isEmpty()) {
emit shortenFailed (QStringLiteral ("API signature is empty."));
return;
}
if (!longUrl.isValid() || longUrl.scheme().isEmpty() || longUrl.host().isEmpty()) {
emit shortenFailed (QStringLiteral ("Clipboard does not contain a valid URL."));
return;
}
QUrl requestUrl (settings.apiUrl);
if (!requestUrl.isValid()) {
emit shortenFailed (QStringLiteral ("Configured API URL is invalid: %1").arg (settings.apiUrl));
return;
}
QUrlQuery query;
query.addQueryItem (QStringLiteral ("signature"), settings.signature);
query.addQueryItem (QStringLiteral ("action"), QStringLiteral ("shorturl"));
query.addQueryItem (QStringLiteral ("format"), QStringLiteral ("json"));
query.addQueryItem (QStringLiteral ("url"),
QString::fromLatin1 (QUrl::toPercentEncoding (longUrl.toString (QUrl::FullyEncoded))));
requestUrl.setQuery (query);
QNetworkRequest request (requestUrl);
request.setHeader (QNetworkRequest::UserAgentHeader, QStringLiteral ("yourls-ui/1.0"));
#ifndef QT_NO_DEBUG
// Never log the request query: it contains the API signature.
qDebug() << "[yourls] sending GET, endpoint:"
<< requestUrl.adjusted (QUrl::RemoveQuery | QUrl::RemoveFragment | QUrl::RemoveUserInfo)
<< "source URL:" << longUrl;
#endif
QNetworkReply *reply = m_networkAccessManager->get (request);
connect (reply, &QNetworkReply::finished, this, [this, reply, longUrl]() {
const QByteArray body = reply->readAll();
#ifndef QT_NO_DEBUG
qDebug() << "[yourls] response HTTP status:"
<< reply->attribute (QNetworkRequest::HttpStatusCodeAttribute)
<< "network error code:" << reply->error()
<< "response bytes:" << body.size();
#endif
QJsonParseError parseError;
const QJsonDocument jsonDocument = QJsonDocument::fromJson (body, &parseError);
const QJsonObject object = jsonDocument.object();
const QUrl existingShortUrl (object.value (QStringLiteral ("shorturl")).toString());
const QUrl existingLongUrl (object.value (QStringLiteral ("url")).toObject()
.value (QStringLiteral ("url")).toString());
// YOURLS reports duplicate URLs as HTTP 400, but returns the existing link.
if (reply->attribute (QNetworkRequest::HttpStatusCodeAttribute).toInt() == 400
&& object.value (QStringLiteral ("status")).toString() == QStringLiteral ("fail")
&& object.value (QStringLiteral ("code")).toString() == QStringLiteral ("error:url")
&& existingLongUrl == longUrl && existingShortUrl.isValid()
&& (existingShortUrl.scheme() == QStringLiteral ("https")
|| existingShortUrl.scheme() == QStringLiteral ("http"))
&& !existingShortUrl.host().isEmpty()) {
#ifndef QT_NO_DEBUG
qDebug() << "[yourls] reusing existing short URL:" << existingShortUrl;
#endif
reply->deleteLater();
emit shortenSucceeded (existingShortUrl);
return;
}
if (reply->error() != QNetworkReply::NoError) {
const QString details = QStringLiteral ("Network error: %1\nHTTP status: %2\nResponse body:\n%3")
.arg (reply->errorString(),
reply->attribute (QNetworkRequest::HttpStatusCodeAttribute).toString(),
QString::fromUtf8 (body));
reply->deleteLater();
emit shortenFailed (details);
return;
}
#ifndef QT_NO_DEBUG
qDebug() << "[yourls] JSON parse error:" << parseError.errorString()
<< "offset:" << parseError.offset << "is object:" << jsonDocument.isObject();
#endif
if (parseError.error != QJsonParseError::NoError || !jsonDocument.isObject()) {
const QString details = QStringLiteral ("Failed to parse YOURLS response as JSON: %1\nResponse body:\n%2")
.arg (parseError.errorString(), QString::fromUtf8 (body));
reply->deleteLater();
emit shortenFailed (details);
return;
}
const QString status = object.value (QStringLiteral ("status")).toString();
const QString shortUrlText = object.value (QStringLiteral ("shorturl")).toString();
#ifndef QT_NO_DEBUG
qDebug() << "[yourls] API status:" << status
<< "code:" << object.value (QStringLiteral ("code")).toVariant()
<< "short URL:" << shortUrlText;
#endif
if (status.compare (QStringLiteral ("success"), Qt::CaseInsensitive) != 0 || shortUrlText.isEmpty()) {
QStringList details;
details << QStringLiteral ("YOURLS returned an error.");
if (object.contains (QStringLiteral ("message")))
details << QStringLiteral ("Message: %1").arg (object.value (QStringLiteral ("message")).toString());
if (object.contains (QStringLiteral ("code")))
details << QStringLiteral ("Code: %1").arg (object.value (QStringLiteral ("code")).toVariant().toString());
details << QStringLiteral ("Raw response:\n%1").arg (QString::fromUtf8 (body));
reply->deleteLater();
emit shortenFailed (details.join (QStringLiteral ("\n")));
return;
}
const QUrl shortUrl (shortUrlText);
if (!shortUrl.isValid() || shortUrl.host().isEmpty()
|| (shortUrl.scheme() != QStringLiteral ("https") && shortUrl.scheme() != QStringLiteral ("http"))) {
reply->deleteLater();
emit shortenFailed (QStringLiteral ("YOURLS returned an invalid short URL: %1").arg (shortUrlText));
return;
}
reply->deleteLater();
emit shortenSucceeded (shortUrl);
});
}
yourlsclient.h
+58
View File
@@ -0,0 +1,58 @@
#ifndef YOURLSCLIENT_H
#define YOURLSCLIENT_H
#include <QObject>
#include <QUrl>
class QNetworkAccessManager;
/**
* @brief Small value object describing YOURLS API settings.
*/
struct YourlsSettings {
QString apiUrl;
QString signature;
};
/**
* @brief Client responsible for communication with the YOURLS API.
*
* The class builds a signed YOURLS request, sends it over HTTP(S),
* parses the JSON response and returns either a short URL or a detailed
* error string.
*/
class YourlsClient : public QObject {
Q_OBJECT
public:
/**
* @brief Constructs the client.
* @param parent QObject parent.
*/
explicit YourlsClient (QObject *parent = nullptr);
/**
* @brief Requests a short URL from the YOURLS API.
* @param settings API endpoint and signature.
* @param longUrl Source URL to shorten.
*/
void shortenUrl (const YourlsSettings &settings, const QUrl &longUrl);
signals:
/**
* @brief Emitted when the short URL has been created successfully.
* @param shortUrl Generated short URL.
*/
void shortenSucceeded (const QUrl &shortUrl);
/**
* @brief Emitted when the request fails.
* @param details Human-readable error details.
*/
void shortenFailed (const QString &details);
private:
QNetworkAccessManager *m_networkAccessManager;
};
#endif // YOURLSCLIENT_H