diff --git a/.github/workflows/build_and_publish.yml b/.github/workflows/build_and_publish.yml index 0c113be..17f4e7a 100644 --- a/.github/workflows/build_and_publish.yml +++ b/.github/workflows/build_and_publish.yml @@ -7,7 +7,7 @@ env: CARGO_TERM_COLOR: always jobs: - build: + build-linux-appimage-rpm: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -18,10 +18,32 @@ jobs: - name: Upload Artifact uses: actions/upload-artifact@v4 with: - name: executables-linux + name: executables-linux-appimage-rpm if-no-files-found: error path: | target/appimage/*.AppImage + target/generate-rpm/*.rpm + build-linux-deb: + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v4 + - name: Fix tag reference (workaround for https://github.com/actions/checkout/issues/290) + run: git fetch --update-head-ok -f origin ${{ github.ref }}:${{ github.ref }} + - name: Install system dependencies + run: | + sudo apt-get install -y pkg-config libgtk-4-dev libadwaita-1-dev libsasl2-dev libgtksourceview-5-dev openssl + cargo install cargo-deb + - name: Build + run: | + cargo deb --deb-version $(git describe) + - name: Upload Artifact + uses: actions/upload-artifact@v4 + with: + name: executables-linux-deb + if-no-files-found: error + path: | + target/debian/*.deb + build-windows: runs-on: ubuntu-latest steps: @@ -31,7 +53,7 @@ jobs: - name: Build (Windows) run: docker compose -f docker-compose.windows.yml up - name: Make Windows Installer - run: ./create_windows_installer.sh + run: ./build-scripts/create_windows_installer.sh - name: Zip Portable Windows Artifact run: zip -r windows-portable.zip package - name: Upload Artifact @@ -39,13 +61,13 @@ jobs: with: name: executables-windows path: | - *.zip + windows-portable.zip *.exe publish: permissions: contents: write - needs: [build, build-windows] + needs: [build-linux-appimage-rpm, build-linux-deb, build-windows] runs-on: ubuntu-latest if: startsWith(github.ref, 'refs/tags/') steps: @@ -58,11 +80,13 @@ jobs: if: startsWith(github.ref, 'refs/tags/') with: prerelease: false - draft: true + draft: true generate_release_notes: true append_body: true files: | **/*.AppImage **/*.zip **/*.exe + **/*.deb + **/*.rpm - run: ls -R . diff --git a/.gitignore b/.gitignore index b595094..ef39867 100644 --- a/.gitignore +++ b/.gitignore @@ -43,4 +43,5 @@ krust-setup.exe libs/ package.zip *.log -LICENSE-win.md +LICENSE +*.bak diff --git a/.licensure.yml b/.licensure.yml new file mode 100644 index 0000000..afc989f --- /dev/null +++ b/.licensure.yml @@ -0,0 +1,63 @@ +# Regexes which if matched by a file path will always be excluded from +# getting a license header +excludes: + - \.gitignore + - .*lock + - \.github/.* + - \.vscode/.* + - \.cargo/.* + - \.git/.* + - \.rpm/.* + - \.licensure\.yml + - \.editorconfig + - README.* + - LICENSE.* + - COPYING + - gtksourceview-5 + - package + - target + - libs + - docker-*.yml + - data + - setup.iss + - .*\.(md|rst|txt|iss|desktop|svg|toml) +change_in_place: true + +licenses: + - files: any + ident: GPL-3.0 + unwrap_text: false + authors: + - name: Miguel A. Baldi Hörlle + email: miguel.horlle@gmail.com + template: | + Copyright (c) [year], [name of author]. All rights reserved. Use of + this source code is governed by the [ident] license that can be + found in the COPYING file. + +# Define type of comment characters to apply based on file extensions. +comments: + # The extensions (or singular extension) field defines which file + # extensions to apply the commenter to. + - extensions: + - rs + commenter: + type: line + comment_char: "//" + trailing_lines: 1 + - extensions: + - css + - cpp + - c + - less + commenter: + type: block + start_block_char: "/*\n" + end_block_char: "*/" + per_line_char: "*" + trailing_lines: 1 + - extension: any + commenter: + type: line + comment_char: "#" + trailing_lines: 1 diff --git a/.rpm/krust.spec b/.rpm/krust.spec new file mode 100644 index 0000000..c486e03 --- /dev/null +++ b/.rpm/krust.spec @@ -0,0 +1,49 @@ +%define __spec_install_post %{nil} +%define __os_install_post %{_dbpath}/brp-compress +%define debug_package %{nil} + +Name: krust +Summary: Kafka desktop client +Version: @@VERSION@@ +Release: @@RELEASE@@%{?dist} +License: GPL-3.0-or-later +Group: Development/Tools +Source0: %{name}-%{version}.tar.gz + +BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root + +Requires: gtksourceview5 +Requires: libadwaita +Requires: cyrus-sasl-devel +Requires: openssl-devel + +%description +%{summary} + +%prep +%setup -q + +%install +rm -rf %{buildroot} +mkdir -p %{buildroot} +cp -a * %{buildroot} +mkdir -p %{buildroot}/usr/share/applications +mkdir -p %{buildroot}/usr/share/pixmaps +cp -a ../../../../../data/images/io.miguelbaldi.KRust* %{buildroot}/usr/share/pixmaps/ +cp -a ../../../../../data/images/krust.png %{buildroot}/usr/share/pixmaps/ +cp -a ../../../../../data/images/krust.svg %{buildroot}/usr/share/pixmaps/ +cp -a ../../../../../*.desktop %{buildroot}/usr/share/applications/ + +%clean +rm -rf %{buildroot} + +%files +%defattr(-,root,root,-) +%{_bindir}/* +%{_datadir}/applications/%{name}.desktop +%{_datadir}/pixmaps/%{name}.svg +%{_datadir}/pixmaps/%{name}.png +%{_datadir}/pixmaps/io.miguelbaldi.KRust.png +%{_datadir}/pixmaps/io.miguelbaldi.KRust.svg +%{_datadir}/pixmaps/io.miguelbaldi.KRust-symbolic.svg +%{_datadir}/pixmaps/io.miguelbaldi.KRust-symbolic.png diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/COPYING @@ -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/Cargo.lock b/Cargo.lock index 0afa03c..f7245e1 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -923,7 +923,7 @@ dependencies = [ [[package]] name = "krust" -version = "0.0.1" +version = "0.0.0" dependencies = [ "anyhow", "chrono", diff --git a/Cargo.toml b/Cargo.toml index abcdaa8..99f4b8d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,13 +1,15 @@ [package] name = "krust" -rust-version = "1.77" -version = "0.0.1" +rust-version = "1.78" +publish = false +version = "0.0.0" edition = "2021" resolver = "2" authors = ["Miguel A. Baldi Hörlle "] description = "Kafka desktop client" repository = "https://github.com/miguelbaldi/krust" -license-file = "LICENSE.md" +license-file = "COPYING" +license = "GPL-3.0-or-later" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html @@ -63,3 +65,83 @@ auto_link_exclude_list = [ "libstdc++.so*", "libm.so*", ] + +[package.metadata.rpm] +package = "krust" + +[package.metadata.rpm.cargo] +buildflags = ["--release"] + +[package.metadata.rpm.targets] +krust = { path = "/usr/bin/krust" } + +[package.metadata.generate-rpm] + +assets = [ + { source = "target/release/krust", dest = "/usr/bin/krust", mode = "755" }, + { source = "krust.desktop", dest = "/usr/share/applications/krust.desktop", mode = "644" }, + { source = "data/images/krust.png", dest = "/usr/share/pixmaps/", mode = "644" }, + { source = "data/images/krust.svg", dest = "/usr/share/pixmaps/", mode = "644" }, + { source = "data/images/io.miguelbaldi.KRust.png", dest = "/usr/share/pixmaps/", mode = "644" }, + { source = "data/images/io.miguelbaldi.KRust.svg", dest = "/usr/share/icons/hicolor/scalable/apps/", mode = "644" }, + { source = "data/images/io.miguelbaldi.KRust-symbolic.png", dest = "/usr/share/icons/hicolor/symbolic/apps/", mode = "644" }, + { source = "data/images/io.miguelbaldi.KRust-symbolic.svg", dest = "/usr/share/icons/hicolor/symbolic/apps/", mode = "644" }, +] + +[package.metadata.generate-rpm.requires] +gtksourceview5 = "*" +libadwaita = "*" +cyrus-sasl-devel = "*" +openssl-devel = "*" + +[package.metadata.deb] +maintainer = "Miguel A. Baldi Hörlle " +copyright = "2024, Miguel A. Baldi Hörlle " +license-file = ["COPYING"] +extended-description = """\ +A simple Apache Kafka GUI client \ +useful for developers as well adminstrators.""" +depends = "$auto" +section = "Utility;Development;IDE;" +assets = [ + [ + "target/release/krust", + "usr/bin/", + "755", + ], + [ + "krust.desktop", + "usr/share/applications/", + "644", + ], + [ + "data/images/krust.png", + "usr/share/pixmaps/", + "644", + ], + [ + "data/images/krust.svg", + "usr/share/pixmaps/", + "644", + ], + [ + "data/images/io.miguelbaldi.KRust.png", + "usr/share/pixmaps/", + "644", + ], + [ + "data/images/io.miguelbaldi.KRust.svg", + "usr/share/icons/hicolor/scalable/apps/", + "644", + ], + [ + "data/images/io.miguelbaldi.KRust-symbolic.png", + "usr/share/icons/hicolor/symbolic/apps/", + "644", + ], + [ + "data/images/io.miguelbaldi.KRust-symbolic.svg", + "usr/share/icons/hicolor/symbolic/apps/", + "644", + ], +] diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index e7141ce..0000000 --- a/LICENSE.md +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2024 Miguel A. Baldi Hörlle - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f7e926c --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +# KRust + +`KRust` is a simple Apache Kafka GUI client useful for developers as well adminstrators, +built using GTK and [Relm4]. + + +The topics messages are visualized using tabs, which enables quick +navigation throughout multiple topics. + +`KRust` is in the early stages of development. Manipulating important topics with it +risks data loss. + +## Platform support + +Development is currently focused on Linux, but bug reports for other platforms +are welcome. + +The application is known to run successfully on Microsoft Windows 10/11. Other platforms are +untested, but if you can get the system dependencies to build, `KRust` should work. + +## Hacking + +`KRust` is a Rust project that utilizes [GTK 4][install-gtk], +[GtkSourceView][install-gtksourceview], and [libadwaita][install-libadwaita]. + +1. First, [install Rust and Cargo][install-rust]. + +2. Install system dependencies. + + #### Arch Linux + + ```sh + $ pacman -Syu gtk4 libadwaita gtksourceview5 libsasl openssl + ``` + + #### Fedora + + ``` + $ dnf install -y gtk4 libadwaita-devel cyrus-sasl-devel openssl-devel + ``` + + #### Ubuntu + + ```sh + $ apt install libsasl2-2 libgtksourceview-5-0 libadwaita-1-0 libssl3t64 + ``` + +3. Build and run the application. + + ```sh + $ cargo run + ``` + +## License + +`KRust` is licensed under the GPLv3 license (see [COPYING](COPYING) or [GPLv3](https://www.gnu.org/licenses/gpl-3.0.txt)). + +[install-rust]: https://rustup.rs/ +[install-gtk]: https://www.gtk.org/docs/installations/ +[install-gtksourceview]: https://wiki.gnome.org/Projects/GtkSourceView +[install-libadwaita]: https://gnome.pages.gitlab.gnome.org/libadwaita/ +[Relm4]: https://aaronerhardt.github.io/relm4-book/book/ diff --git a/build-scripts/create_windows_installer.sh b/build-scripts/create_windows_installer.sh new file mode 100755 index 0000000..811cb16 --- /dev/null +++ b/build-scripts/create_windows_installer.sh @@ -0,0 +1,17 @@ +# Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +# this source code is governed by the GPL-3.0 license that can be +# found in the COPYING file. + +docker rm setup +docker container create --name setup amake/innosetup setup.iss +docker cp ./package setup:/work/ +docker cp data/images/krust.ico setup:/work/krust.ico +export MY_VERSION=$(git describe) +sed -i "s/MY_VERSION/$MY_VERSION/g" setup.iss +docker cp setup.iss setup:/work/ +iconv -f utf8 -t iso8859-1 COPYING > LICENSE +docker cp LICENSE setup:/work/LICENSE +docker start -i -a setup +docker cp setup:/work/Output/. . +docker rm setup +zip -r package.zip package diff --git a/build-scripts/linux-rpm-prepare-and-build.sh b/build-scripts/linux-rpm-prepare-and-build.sh new file mode 100755 index 0000000..0d80877 --- /dev/null +++ b/build-scripts/linux-rpm-prepare-and-build.sh @@ -0,0 +1,14 @@ +#!/bin/bash +# Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +# this source code is governed by the GPL-3.0 license that can be +# found in the COPYING file. + +set -euo pipefail + +#dnf install -y strace rpm-build + +# cargo install cargo-rpm && cargo rpm build +cargo install cargo-generate-rpm +cargo build --release +cargo generate-rpm --set-metadata="version = '$(git describe)'" +cargo appimage diff --git a/win-prepare-and-build.sh b/build-scripts/win-prepare-and-build.sh similarity index 92% rename from win-prepare-and-build.sh rename to build-scripts/win-prepare-and-build.sh index b2764ca..1c784ba 100755 --- a/win-prepare-and-build.sh +++ b/build-scripts/win-prepare-and-build.sh @@ -1,4 +1,8 @@ #!/bin/bash +# Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +# this source code is governed by the GPL-3.0 license that can be +# found in the COPYING file. + set -euo pipefail dnf -y install mingw64-openssl-static mingw64-gcc-c++ zstd cyrus-sasl-devel perl @@ -44,4 +48,5 @@ export CHRONO_TZ_TIMEZONE_FILTER="(GMT|UTC|Brazil/.*)" git config --global --add safe.directory /mnt git config --global --list git describe +. ~/.cargo/env && rustup target add x86_64-pc-windows-gnu build && package diff --git a/build.rs b/build.rs index 2328699..4c2b062 100644 --- a/build.rs +++ b/build.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use anyhow::Result; use std::{env, path::Path, process::Command}; use vergen::EmitBuilder; @@ -56,17 +60,13 @@ pub fn compile_resources>(source_dirs: &[P], gresource: &str, tar } } -fn main() -> Result<()>{ +fn main() -> Result<()> { compile_resources( &["data"], "data/resources.gresource.xml", "resources.gresource", ); - compile_resources( - &["data"], - "data/icons.gresource.xml", - "icons.gresource", - ); + compile_resources(&["data"], "data/icons.gresource.xml", "icons.gresource"); EmitBuilder::builder() .all_build() @@ -74,5 +74,10 @@ fn main() -> Result<()>{ .all_sysinfo() .fail_on_error() .emit()?; + let version: String = std::env::var("VERGEN_GIT_DESCRIBE") + .unwrap_or("0.0.1-dev".to_string()) + .clone(); + println!("cargo:rustc-env=CARGO_PKG_VERSION={}", version); + println!("cargo:rerun-if-env-changed=VERGEN_GIT_DESCRIBE"); Ok(()) } diff --git a/create_windows_installer.sh b/create_windows_installer.sh deleted file mode 100755 index 6e36b80..0000000 --- a/create_windows_installer.sh +++ /dev/null @@ -1,11 +0,0 @@ -docker rm setup -docker container create --name setup amake/innosetup setup.iss -docker cp ./package setup:/work/ -docker cp data/images/krust.ico setup:/work/krust.ico -docker cp setup.iss setup:/work/ -iconv -f utf8 -t iso8859-1 LICENSE.md > LICENSE-win.md -docker cp LICENSE-win.md setup:/work/LICENSE.md -docker start -i -a setup -docker cp setup:/work/Output/. . -docker rm setup -zip -r package.zip package diff --git a/data/images/io.miguelbaldi.KRust-symbolic.png b/data/images/io.miguelbaldi.KRust-symbolic.png new file mode 100644 index 0000000..16bc408 Binary files /dev/null and b/data/images/io.miguelbaldi.KRust-symbolic.png differ diff --git a/data/images/io.miguelbaldi.KRust.png b/data/images/io.miguelbaldi.KRust.png new file mode 100644 index 0000000..8bbc408 Binary files /dev/null and b/data/images/io.miguelbaldi.KRust.png differ diff --git a/data/images/krust.png b/data/images/krust.png new file mode 100644 index 0000000..97925dc Binary files /dev/null and b/data/images/krust.png differ diff --git a/data/images/krust.svg b/data/images/krust.svg new file mode 100644 index 0000000..8e43fb0 --- /dev/null +++ b/data/images/krust.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/docker-compose.kafka.yml b/docker-compose.kafka.yml index 16a67c7..b1d6813 100644 --- a/docker-compose.kafka.yml +++ b/docker-compose.kafka.yml @@ -1,3 +1,7 @@ +# Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +# this source code is governed by the GPL-3.0 license that can be +# found in the COPYING file. + services: zookeeper: image: confluentinc/cp-zookeeper:7.4.4 diff --git a/docker-compose.windows.yml b/docker-compose.windows.yml index 3a24a8c..41f27fb 100644 --- a/docker-compose.windows.yml +++ b/docker-compose.windows.yml @@ -1,3 +1,7 @@ +# Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +# this source code is governed by the GPL-3.0 license that can be +# found in the COPYING file. + services: krust-cross-win: # image id: c191618ca6ff @@ -5,5 +9,5 @@ services: #image: gtk4-cross-rust-4.14.3-1.5.0 volumes: - .:/mnt:z - command: bash -c "./win-prepare-and-build.sh" + command: bash -c "./build-scripts/win-prepare-and-build.sh" diff --git a/docker-compose.yml b/docker-compose.yml index 2864173..760e86e 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,8 +1,12 @@ +# Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +# this source code is governed by the GPL-3.0 license that can be +# found in the COPYING file. + version: "3" services: gtk4-rs: image: ghcr.io/miguelbaldi/relm4-docker:latest-appimage volumes: - .:/mnt:z - command: sh -c "cargo appimage" + command: bash -c "./build-scripts/linux-rpm-prepare-and-build.sh" diff --git a/krust.desktop b/krust.desktop new file mode 100644 index 0000000..3896863 --- /dev/null +++ b/krust.desktop @@ -0,0 +1,11 @@ +[Desktop Entry] +Type=Application +Name=KRust +StartupWMClass=io.miguelbaldi.KRust +Name[pt_BR]=KRust +Comment=KRust Kafka Client +Comment[pt_BR]=KRust cliente de Kafka +Icon=io.miguelbaldi.KRust +Exec=krust +Categories=Utility;Development;IDE; +Terminal=false diff --git a/rust-toolchain.toml b/rust-toolchain.toml new file mode 100644 index 0000000..744175d --- /dev/null +++ b/rust-toolchain.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "1.78" diff --git a/setup.iss b/setup.iss index 0d5855e..8a5860f 100644 --- a/setup.iss +++ b/setup.iss @@ -2,7 +2,7 @@ ; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES! #define MyAppName "KRust" -#define MyAppVersion "0.0.1" +#define MyAppVersion "MY_VERSION" #define MyAppPublisher "Miguel A. Baldi Hörlle" #define MyAppURL "https://github.com/miguelbaldi/krust" #define MyAppExeName "krust.exe" @@ -22,7 +22,7 @@ AppUpdatesURL={#MyAppURL} DefaultDirName={autopf}\{#MyAppName} DefaultGroupName={#MyAppName} AllowNoIcons=yes -LicenseFile=LICENSE.md +LicenseFile=LICENSE ; Remove the following line to run in administrative install mode (install for all users.) PrivilegesRequired=lowest OutputBaseFilename=krust-setup @@ -49,4 +49,3 @@ Name: "{autodesktop}\{#MyAppName}"; Filename: "{app}\{#MyAppExeName}"; IconFilen [Run] Filename: "{app}\{#MyAppExeName}"; Description: "{cm:LaunchProgram,{#StringChange(MyAppName, '&', '&&')}}"; Flags: nowait postinstall skipifsilent - diff --git a/src/backend/kafka.rs b/src/backend/kafka.rs index 507665b..bdcd3b1 100644 --- a/src/backend/kafka.rs +++ b/src/backend/kafka.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use futures::future; use rdkafka::admin::{AdminClient, AdminOptions, NewTopic, TopicReplication}; use rdkafka::client::{ClientContext, DefaultClientContext}; diff --git a/src/backend/mod.rs b/src/backend/mod.rs index f40c8b6..e4219e7 100644 --- a/src/backend/mod.rs +++ b/src/backend/mod.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + pub(crate) mod repository; pub(crate) mod kafka; pub(crate) mod worker; diff --git a/src/backend/repository.rs b/src/backend/repository.rs index 5757073..074ce75 100644 --- a/src/backend/repository.rs +++ b/src/backend/repository.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use std::fmt; use std::path::PathBuf; use std::string::ToString; diff --git a/src/backend/settings.rs b/src/backend/settings.rs index bc26a55..e6aa7ae 100644 --- a/src/backend/settings.rs +++ b/src/backend/settings.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use serde::{Deserialize, Serialize}; use std::fs::File; use std::path::PathBuf; diff --git a/src/backend/worker.rs b/src/backend/worker.rs index 4bb5040..3ee16b8 100644 --- a/src/backend/worker.rs +++ b/src/backend/worker.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use chrono::Utc; use tokio::select; use tracing::*; diff --git a/src/component/app.rs b/src/component/app.rs index 0efcc37..afe97d1 100644 --- a/src/component/app.rs +++ b/src/component/app.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + //! Application entrypoint. use std::{collections::HashMap, time::Duration}; diff --git a/src/component/cache_manager_dialog.rs b/src/component/cache_manager_dialog.rs index b551136..23a3576 100644 --- a/src/component/cache_manager_dialog.rs +++ b/src/component/cache_manager_dialog.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use adw::prelude::*; use fs_extra::dir::get_size; use gtk::{glib::SignalHandlerId, ColumnViewColumn}; diff --git a/src/component/connection_list.rs b/src/component/connection_list.rs index 1c05687..dc96421 100644 --- a/src/component/connection_list.rs +++ b/src/component/connection_list.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use adw::{prelude::*, AlertDialog}; use relm4::{ factory::{DynamicIndex, FactoryComponent}, diff --git a/src/component/connection_page.rs b/src/component/connection_page.rs index fa316ce..83956dd 100644 --- a/src/component/connection_page.rs +++ b/src/component/connection_page.rs @@ -1,4 +1,8 @@ #![allow(deprecated)] +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use std::borrow::Borrow; use adw::prelude::*; diff --git a/src/component/messages/lists.rs b/src/component/messages/lists.rs index 06c9fdc..8e2c895 100644 --- a/src/component/messages/lists.rs +++ b/src/component/messages/lists.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use crate::backend::repository::{KrustHeader, KrustMessage}; use chrono::prelude::*; use chrono_tz::America; diff --git a/src/component/messages/message_viewer.rs b/src/component/messages/message_viewer.rs index 5671a97..e31bd0c 100644 --- a/src/component/messages/message_viewer.rs +++ b/src/component/messages/message_viewer.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use gtk::prelude::*; use relm4::{typed_view::column::TypedColumnView, *}; use sourceview::prelude::*; diff --git a/src/component/messages/messages_cache_settings_dialog.rs b/src/component/messages/messages_cache_settings_dialog.rs index 1e90dd3..dde3cfd 100644 --- a/src/component/messages/messages_cache_settings_dialog.rs +++ b/src/component/messages/messages_cache_settings_dialog.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use core::f64; use std::str::FromStr; diff --git a/src/component/messages/messages_page.rs b/src/component/messages/messages_page.rs index 4f0acc9..fed0967 100644 --- a/src/component/messages/messages_page.rs +++ b/src/component/messages/messages_page.rs @@ -1,4 +1,8 @@ #![allow(deprecated)] +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + // See: https://gitlab.gnome.org/GNOME/gtk/-/issues/5644 use crate::{ diff --git a/src/component/messages/messages_send_dialog.rs b/src/component/messages/messages_send_dialog.rs index a5cbad7..4101c34 100644 --- a/src/component/messages/messages_send_dialog.rs +++ b/src/component/messages/messages_send_dialog.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use std::cell::RefCell; use adw::prelude::*; diff --git a/src/component/messages/messages_tab.rs b/src/component/messages/messages_tab.rs index 293de5d..72e711b 100644 --- a/src/component/messages/messages_tab.rs +++ b/src/component/messages/messages_tab.rs @@ -1,4 +1,8 @@ #![allow(deprecated)] +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use std::borrow::Borrow; use std::str::FromStr; diff --git a/src/component/messages/mod.rs b/src/component/messages/mod.rs index b1e1eba..a542ae4 100644 --- a/src/component/messages/mod.rs +++ b/src/component/messages/mod.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + mod lists; pub(crate) mod message_viewer; pub(crate) mod messages_cache_settings_dialog; diff --git a/src/component/mod.rs b/src/component/mod.rs index 7b17f39..0e38503 100644 --- a/src/component/mod.rs +++ b/src/component/mod.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + //! Relm4 components. use crate::backend::repository::KrustConnection; diff --git a/src/component/settings_dialog.rs b/src/component/settings_dialog.rs index aa0ceb2..7aa7a64 100644 --- a/src/component/settings_dialog.rs +++ b/src/component/settings_dialog.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use std::path::PathBuf; use adw::prelude::*; diff --git a/src/component/status_bar.rs b/src/component/status_bar.rs index 0154fa0..bc1c579 100644 --- a/src/component/status_bar.rs +++ b/src/component/status_bar.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + //! Alert dialog for displaying arbitrary errors. //! //! Inspired by [`relm4_components::alert`], but allows sending the dialog text as part of the diff --git a/src/component/task_manager.rs b/src/component/task_manager.rs index a7d011e..c97becb 100644 --- a/src/component/task_manager.rs +++ b/src/component/task_manager.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use std::borrow::Borrow; use std::cell::RefCell; use std::time::Duration; diff --git a/src/component/topics/create_dialog.rs b/src/component/topics/create_dialog.rs index 2ffd5a7..4e1bc27 100644 --- a/src/component/topics/create_dialog.rs +++ b/src/component/topics/create_dialog.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use crate::backend::{ kafka::{CreateTopicRequest, KafkaBackend}, repository::KrustConnection, diff --git a/src/component/topics/mod.rs b/src/component/topics/mod.rs index fe009a2..aacdee4 100644 --- a/src/component/topics/mod.rs +++ b/src/component/topics/mod.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + pub(crate) mod create_dialog; pub(crate) mod topics_page; pub(crate) mod topics_tab; diff --git a/src/component/topics/topics_page.rs b/src/component/topics/topics_page.rs index 3e6ba51..478ea3e 100644 --- a/src/component/topics/topics_page.rs +++ b/src/component/topics/topics_page.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use crate::{ backend::repository::{KrustConnection, KrustTopic}, component::{ diff --git a/src/component/topics/topics_tab.rs b/src/component/topics/topics_tab.rs index d642a48..4eb6d1f 100644 --- a/src/component/topics/topics_tab.rs +++ b/src/component/topics/topics_tab.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use std::{cell::RefCell, cmp::Ordering, collections::HashMap}; use crate::backend::repository::KrustTopicCache; diff --git a/src/config.rs b/src/config.rs index e1938a2..9a692b4 100644 --- a/src/config.rs +++ b/src/config.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use directories::ProjectDirs; use rdkafka::error::KafkaError; use ron::de::SpannedError; diff --git a/src/lib.rs b/src/lib.rs index 46b6c3d..5e819f0 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,8 +1,8 @@ -//! Small, general purpose file manager built using GTK. -//! -//! Generally, each top-level module corresponds to a different Relm4 component. - #![warn(clippy::dbg_macro)] +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + #![warn(clippy::print_stderr)] #![warn(clippy::print_stdout)] #![warn(clippy::todo)] diff --git a/src/main.rs b/src/main.rs index e9e15a6..21f3a6b 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,4 +1,8 @@ #![windows_subsystem = "windows"] +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use std::env; use gtk::gdk; diff --git a/src/modals/about.rs b/src/modals/about.rs index 59115ba..aeb5b04 100644 --- a/src/modals/about.rs +++ b/src/modals/about.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use fs_extra::dir::get_size; use gtk::prelude::GtkWindowExt; use humansize::{format_size, DECIMAL}; @@ -22,7 +26,7 @@ impl SimpleComponent for AboutDialog { //.application_icon("/org/miguelbaldi/krust/logo.png") .application_icon(APP_ID) // Insert your license of choice here - .license_type(gtk::License::MitX11) + .license_type(gtk::License::Gpl30) // Insert your website here .website("https://github.com/miguelbaldi/krust") // Insert your Issues page diff --git a/src/modals/mod.rs b/src/modals/mod.rs index f22c255..f9c9cdc 100644 --- a/src/modals/mod.rs +++ b/src/modals/mod.rs @@ -1,2 +1,6 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + pub(crate) mod about; pub(crate) mod utils; diff --git a/src/modals/utils.rs b/src/modals/utils.rs index 8c35e16..a70e561 100644 --- a/src/modals/utils.rs +++ b/src/modals/utils.rs @@ -1,3 +1,7 @@ +// Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +// this source code is governed by the GPL-3.0 license that can be +// found in the COPYING file. + use adw::prelude::*; pub(crate) fn show_error_alert(parent: &impl IsA, message: String) { diff --git a/src/styles.less b/src/styles.less index 3656bb0..64cc12e 100644 --- a/src/styles.less +++ b/src/styles.less @@ -1,4 +1,9 @@ /* +* Copyright (c) 2024, Miguel A. Baldi Hörlle . All rights reserved. Use of +* this source code is governed by the GPL-3.0 license that can be +* found in the COPYING file. +*/ +/* Logo/Theme colors: Red Orange 4: #FF3F34 Pickled Bluewood 2: #314459