From eba48b7cec388325b237fd1b5a3c6d2e04deba12 Mon Sep 17 00:00:00 2001 From: Simeon Simeonov Date: Thu, 19 Mar 2020 16:51:23 +0100 Subject: Initial merge i3lock-extended -> i3lock --- CHANGELOG | 188 +-------------- COPYING | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++ I3LOCK_VERSION | 2 +- INSTALL.md | 76 ++++++ LICENSE | 20 ++ Makefile.am | 17 +- README.md | 86 ++----- configure.ac | 4 +- extras.c | 448 ++++++++++++++++++++++++++++++++++ extras.h | 102 ++++++++ i3lock-extended.1 | 298 +++++++++++++++++++++++ i3lock.1 | 173 -------------- i3lock.c | 287 +++++++++++++++++++++- pam/i3lock | 6 - pam/i3lock-extended | 6 + unlock_indicator.c | 81 ++++++- 16 files changed, 2016 insertions(+), 452 deletions(-) create mode 100644 COPYING create mode 100644 INSTALL.md create mode 100644 extras.c create mode 100644 extras.h create mode 100644 i3lock-extended.1 delete mode 100644 i3lock.1 delete mode 100644 pam/i3lock create mode 100644 pam/i3lock-extended diff --git a/CHANGELOG b/CHANGELOG index b9de06a..85615ab 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,187 +1,3 @@ -2019-07-21 i3lock 2.12 +2020-03-19 i3lock-extended 1.2.12 - • remove stray \n from error messages - • capitalize unlock indicator contents - • set WM_CLASS property - • reference modifier as “Super”, not “Win” - • add --raw option to read image as raw bytes - -2018-10-18 i3lock 2.11.1 - - • Fix dist tarball by including I3LOCK_VERSION - -2018-10-10 i3lock 2.11 - - • Switch to autotools - • Display an error when backspace is pressed without any input - • Print an error when a non-PNG file is opened - (i3lock only supports PNG files) (Thanks eplanet) - • Don’t unnecessarily check the xcb_connect return value, - it is known never to be NULL (Thanks SegFault42) - • Fix memory leak when grabbing fails (Thanks karulont) - • Respect Xft.dpi for determining the unlock indicator’s scale factor - • Discard pending password verification attempts - when a new password is entered (Thanks layus) - -2017-11-25 i3lock 2.10 - - • Only use -lpam when not on OpenBSD (Thanks Kaashif) - • locale: treat empty string same as unset (Thanks Ran) - • Fix overwrite of getopt optind (Thanks jakob) - • Immediately hide the unlock indicator after ESC / C-u (Thanks Orestis) - • Measure wall-clock time instead of CPU time for “locking” indicator. - • SetInputFocus to the i3lock window to force-close context menus - • Use RandR for learning about attached monitors - -2017-06-21 i3lock 2.9.1 - - • Fix version number mechanism (for --version) - • Revert the fix for composited notifications, as it causes more issues than - it solves: - https://github.com/i3/i3lock/issues/130 - https://github.com/i3/i3lock/issues/128 - -2017-05-26 i3lock 2.9 - - • i3lock.1: use signal names without SIG prefix - • Removed obsolete inactivity timeout - • Added version files for release tarball. - • Set font face - • Automatically unlock (without having to press ) one attempt which was - entered while authenticating - • Stop leaking the image_path dup - • Displaying locking message when grabbing the pointer/keyboard - • Display error message when locking failed - • Add Enter on C-m - • Change input slices to be exactly pi/3 in size instead of slightly more - • Fix covering of composited notifications using the XComposite extension - • Remove last traces of DPMS - • Use bsd_auth(3) instead of PAM on OpenBSD - • Restore intended behaviour and don't use mlock(2) on OpenBSD. - -2016-06-04 i3lock 2.8 - - • Remove DPMS support in favor of a wrapper script and xset(1). - • Indicate that the --inactivity-timeout option takes an argument. (Thanks - Kenneth Lyons) - • fix pam_securetty: set PAM_TTY to getenv("DISPLAY") - • Eat XKB_KEY_Delete and XKB_KEY_KP_Delete (Thanks bebehei) - • Show unlock indicator if password was entered during PAM verification - • Allow CTRL+J as enter and CTRL+H as backspace (Thanks Karl Tarbe) - • Flush xcb connection after opening fullscreen window (Thanks martin) - • Add support for `xss-lock --transfer-sleep-lock' - -2015-05-20 i3lock 2.7 - - • Die when the X11 connection breaks during runtime (Thanks Eduan) - • Implement logging the number of failed attempts (Thanks koebi) - • Ignore password validation is pam is in wrong state (Thanks Neodyblue) - • Get current user with getpwuid() instead of using $ENV{USER} (Thanks Martin) - • Add support for Compose and dead-keys with libxkbcommon. - Requires libxkbcommon ≥ 0.5.0 (Thanks Daniel) - • Format the source using clang-format. - • Refresh pam credentials on successful authentication (for Kerberos and the - like) (Thanks James) - • List pressed modifiers on failed authentication (Thanks Deiz, Alexandre) - • Only redraw the screen if the unlock indicator is actually used - (Thanks Ingo) - • Make pkg-config configurable for cross-compilation (Thanks Nikolay) - -2014-07-18 i3lock 2.6 - - • NEW DEPENDENCY: use libxkbcommon-x11 instead of libX11 - This helps us get rid of all code that directly uses libX11 - • Use cairo_status_to_string for descriptive errors. - • Add `-e` option to not validate empty password. - • Bugfix: update the initial keyboard modifier state (Thanks lee, Ran) - • Re-raise i3lock when obscured in a separate process - • Turn on the screen on successful authentication - • Delay to turn off the screen after wrong passwd - • Discard half-entered passwd after some inactivity - • Ignore empty passwd after repeated Enter keypress - • Scale the unlock indicator (for retina displays) - -2013-06-09 i3lock 2.5 - - • NEW DEPENDENCY: Use libxkbcommon for input handling - This makes input handling much better for many edge cases. - • Bugfix: fix argument parsing on ARM (s/char/int/) - • Bugfix: free(reply) to avoid memory leak - • Bugfix: Use ev_loop_fork after fork, fixes forking on kqueue based OSes - • Bugfix: Fix centering the indicator in the no-xinerama case - • Only use mlock() on Linux, FreeBSD (for example) requires root - • promote the "could not load image" message from debug to normal - • s/pam_message/pam_response/ (Thanks Tucos) - • remove support for NOLIBCAIRO, cairo-xcb is widespread by now - • Allow XKB_KEY_XF86ScreenSaver as synonym for enter - This keysym is generated on convertible tablets by pressing a hardware - lock/unlock button. - • Allow passwordless PAM conversations (e.g. fingerprint) - • Add ctrl+u password reset - • Set window name to i3lock - -2012-06-02 i3lock 2.4.1 - - • Bugfix: Correctly center unlock indicator after reconfiguring screens - (Thanks xeen) - • Bugfix: Revert shift lock handling (broke uppercase letters) - • Bugfix: Skip shift when getting the modifier mask (Thanks SardemFF7) - -2012-04-01 i3lock 2.4 - - • Bugfix: Fix background color when using cairo (Thanks Pascal) - • Only output text when in debug mode (fixes problems with xautolock) - • fallback when the image cannot be loaded - • Use (void) instead of () for functions without args (Thanks fernandotcl) - -2012-03-15 i3lock 2.3.1 - - • Fix compilation on some systems - -2012-03-15 i3lock 2.3 - - • Implement a visual unlock indicator - • Support ISO_Level5_Shift and Caps Lock - • Lock the password buffer in memory, clear it in RAM after verifying - • Fork after the window is visible, not before - • Bugfix: Copy the color depth from parent (root) window instead of - hardcoding a depth of 24 - -2011-11-06 i3lock 2.2 - - • Don’t re-grab pointer/keyboard on MappingNotify. In some rare situations, - this lead to some keypresses "slipping through" to the last focused window. - • Correctly handle Mode_switch/ISO_Level3_Shift - • Render to a pixmap which is used as background for the window instead of - copying contents on every expose event - • Handle screen resolution changes while screen is locked - • Manpage: document arguments for every option - -2011-05-13 i3lock 2.1 - - • Accept return/backspace when the buffer of 512 bytes is full - • Handle numpad keys correctly - • Handle MappingNotify events - • Correctly check for errors when connecting to X11 - • Add i3lock.pam to not rely on debian’s /etc/pam.d/other anymore - • don’t display debug output - • add NOLIBCAIRO flag to permit compilation without cairo - -2010-09-05 i3lock 2.0 - - • Complete rewrite of i3lock. Now using xcb instead of Xlib. - • When a window obscures i3lock, it pushes itself back to the top again. - • Display version when starting with -v - -2009-08-02 i3lock 1.1 - - • Implement background pictures (-i) and colors (-c) - -2009-05-10 i3lock 1.0 - - • Implement PAM support - • Implement options for forking, beeping, DPMS - -2009-05-01 i3lock 0.9 - - • First release, forked from slock 0.9 + • Initial import and functionality 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/I3LOCK_VERSION b/I3LOCK_VERSION index 19462c2..f8f4f03 100644 --- a/I3LOCK_VERSION +++ b/I3LOCK_VERSION @@ -1 +1 @@ -2.12-non-git +1.12.1 diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..cb2cde9 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,76 @@ +i3lock - improved screen locker +=============================== +[i3lock](https://i3wm.org/i3lock/)> is a simple screen locker like slock. +After starting it, you will see a white screen (you can configure the +color/an image). You can return to your screen by entering your password. + +Many little improvements have been made to i3lock over time: + +- i3lock forks, so you can combine it with an alias to suspend to RAM + (run "i3lock && echo mem > /sys/power/state" to get a locked screen + after waking up your computer from suspend to RAM) + +- You can specify either a background color or a PNG image which will be + displayed while your screen is locked. Note that i3lock is not an image +manipulation software. If you need to resize the image to fill the screen +or similar, use existing tooling to do this before passing it to i3lock. + +- You can specify whether i3lock should bell upon a wrong password. + +- i3lock uses PAM and therefore is compatible with LDAP etc. + On OpenBSD i3lock uses the bsd_auth(3) framework. + +Install +------- + +See [the i3lock home page](https://i3wm.org/i3lock/). + +Requirements +------------ +- pkg-config +- libxcb +- libxcb-util +- libpam-dev +- libcairo-dev +- libxcb-xinerama +- libxcb-randr +- libev +- libx11-dev +- libx11-xcb-dev +- libxkbcommon >= 0.5.0 +- libxkbcommon-x11 >= 0.5.0 +- libxcb-image +- libxcb-xrm + +Running i3lock +------------- +Simply invoke the 'i3lock' command. To get out of it, enter your password and +press enter. + +On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the +authentication helpers, e.g. `/usr/libexec/auth/login_passwd`. + +Building i3lock +--------------- +We recommend you use the provided package from your distribution. Do not build +i3lock unless you have a reason to do so. + +First install the dependencies listed in requirements section, then run these +commands (might need to be adapted to your OS): +``` +autoreconf --force --install + +rm -rf build/ +mkdir -p build && cd build/ + +../configure \ + --prefix=/usr \ + --sysconfdir=/etc \ + --disable-sanitizers + +make +``` + +Upstream +-------- +Please submit pull requests to https://github.com/i3/i3lock diff --git a/LICENSE b/LICENSE index c060226..756d014 100644 --- a/LICENSE +++ b/LICENSE @@ -1,3 +1,23 @@ +i3lock-extended +Copyright (C) 2020 Simeon Simeonov + +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 . + + +This software includes software copyrighted by Michael Stapelberg and +distributed under the following license: + Copyright © 2010-2011, Michael Stapelberg All rights reserved. diff --git a/Makefile.am b/Makefile.am index 5847975..f9323b8 100644 --- a/Makefile.am +++ b/Makefile.am @@ -3,18 +3,18 @@ echo-version: @echo "@I3LOCK_VERSION@" -bin_PROGRAMS = i3lock +bin_PROGRAMS = i3lock-extended -dist_man1_MANS = i3lock.1 +dist_man1_MANS = i3lock-extended.1 pamddir = $(sysconfdir)/pam.d -pamd_files = pam/i3lock +pamd_files = pam/i3lock-extended pamd_DATA = $(pamd_files) AM_CPPFLAGS = \ @AX_EXTEND_SRCDIR_CPPFLAGS@ -i3lock_CFLAGS = \ +i3lock_extended_CFLAGS = \ $(AM_CFLAGS) \ $(XCB_CFLAGS) \ $(XCB_IMAGE_CFLAGS) \ @@ -22,13 +22,14 @@ i3lock_CFLAGS = \ $(XCB_UTIL_XRM_CFLAGS) \ $(XKBCOMMON_CFLAGS) \ $(CAIRO_CFLAGS) \ + -DEXTRAS \ $(CODE_COVERAGE_CFLAGS) -i3lock_CPPFLAGS = \ +i3lock_extended_CPPFLAGS = \ $(AM_CPPFLAGS) \ $(CODE_COVERAGE_CPPFLAGS) -i3lock_LDADD = \ +i3lock_extended_LDADD = \ $(XCB_LIBS) \ $(XCB_IMAGE_LIBS) \ $(XCB_UTIL_LIBS) \ @@ -37,10 +38,12 @@ i3lock_LDADD = \ $(CAIRO_LIBS) \ $(CODE_COVERAGE_LDFLAGS) -i3lock_SOURCES = \ +i3lock_extended_SOURCES = \ cursors.h \ dpi.c \ dpi.h \ + extras.c \ + extras.h \ i3lock.c \ i3lock.h \ randr.c \ diff --git a/README.md b/README.md index cb2cde9..dec2154 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,34 @@ -i3lock - improved screen locker -=============================== -[i3lock](https://i3wm.org/i3lock/)> is a simple screen locker like slock. -After starting it, you will see a white screen (you can configure the -color/an image). You can return to your screen by entering your password. +## i3lock-extended -Many little improvements have been made to i3lock over time: +i3lock-extended is a fork of i3lock (https://github.com/i3/i3lock). +It was started by Simeon Simeonov (https://simeon.simeonov.no) as a small hack, +implementing a LED-clock on top of an existing and robust screensaver. -- i3lock forks, so you can combine it with an alias to suspend to RAM - (run "i3lock && echo mem > /sys/power/state" to get a locked screen - after waking up your computer from suspend to RAM) +i3lock-extended adds some additional functionality and is a free-software +licenced under the GPL3+. Most of the code is copyrighted by Michael Stapelberg +under a different license. See LICENSE for more information\! -- You can specify either a background color or a PNG image which will be - displayed while your screen is locked. Note that i3lock is not an image -manipulation software. If you need to resize the image to fill the screen -or similar, use existing tooling to do this before passing it to i3lock. +The original README.md file from i3lock, containing installation instructions +can be found as INSTALL.md. -- You can specify whether i3lock should bell upon a wrong password. -- i3lock uses PAM and therefore is compatible with LDAP etc. - On OpenBSD i3lock uses the bsd_auth(3) framework. +### Additional features -Install -------- +- LED-clock +- Digital clock +- Elapsed time since activation +- Display-text -See [the i3lock home page](https://i3wm.org/i3lock/). +i3lock-extended includes all of the original code and features of i3lock. -Requirements ------------- -- pkg-config -- libxcb -- libxcb-util -- libpam-dev -- libcairo-dev -- libxcb-xinerama -- libxcb-randr -- libev -- libx11-dev -- libx11-xcb-dev -- libxkbcommon >= 0.5.0 -- libxkbcommon-x11 >= 0.5.0 -- libxcb-image -- libxcb-xrm +Please refer to the manual page for more details and information about the different parameters\! -Running i3lock -------------- -Simply invoke the 'i3lock' command. To get out of it, enter your password and -press enter. -On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the -authentication helpers, e.g. `/usr/libexec/auth/login_passwd`. +### Versioning -Building i3lock ---------------- -We recommend you use the provided package from your distribution. Do not build -i3lock unless you have a reason to do so. +i3lock-extended will merge the changes and fixes coming to i3lock in the +future. -First install the dependencies listed in requirements section, then run these -commands (might need to be adapted to your OS): -``` -autoreconf --force --install - -rm -rf build/ -mkdir -p build && cd build/ - -../configure \ - --prefix=/usr \ - --sysconfdir=/etc \ - --disable-sanitizers - -make -``` - -Upstream --------- -Please submit pull requests to https://github.com/i3/i3lock +In order to create more clarity the version format for i3lock-extended will be: +\.\[a-z +extended revision if used]. diff --git a/configure.ac b/configure.ac index 474f750..5fe3e33 100644 --- a/configure.ac +++ b/configure.ac @@ -2,7 +2,7 @@ # Run autoreconf -fi to generate a configure script from this file. AC_PREREQ([2.69]) -AC_INIT([i3lock], [2.12], [https://github.com/i3/i3lock/issues]) +AC_INIT([i3lock-extended], [1.2.12], [https://simeon.simeonov.no]) # For AX_EXTEND_SRCDIR AX_ENABLE_BUILDDIR AM_INIT_AUTOMAKE([foreign subdir-objects -Wall no-dist-gzip dist-bzip2]) @@ -141,7 +141,7 @@ echo \ "-------------------------------------------------------------------------------- build configured: -AS_HELP_STRING([i3lock version:], [`echo ${I3LOCK_VERSION} | sed 's,\\\\,,g'`]) +AS_HELP_STRING([i3lock-extended version:], [`echo ${I3LOCK_VERSION} | sed 's,\\\\,,g'`]) AS_HELP_STRING([is release version:], [${is_release}]) AS_HELP_STRING([enable debug flags:], [${ax_enable_debug}]) diff --git a/extras.c b/extras.c new file mode 100644 index 0000000..37819f5 --- /dev/null +++ b/extras.c @@ -0,0 +1,448 @@ +/* + * This file is part of i3lock-extended + * Copyright (C) 2020 Simeon Simeonov + + * i3lock-extended 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. + + * i3lock-extended 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 . + */ + +#include +#include +#include +#include + +#include + +#include +#include +#include + +#include "randr.h" +#include "extras.h" + + +extern int failed_attempts; + + +static void i3lock_color_to_array(double *rgb16, const char *color) { + + char strgroups[3][3] = {{color[0], color[1], '\0'}, + {color[2], color[3], '\0'}, + {color[4], color[5], '\0'}}; + *rgb16 = strtol(strgroups[0], NULL, 16) / 255.0; + *(rgb16 + 1) = strtol(strgroups[1], NULL, 16) / 255.0; + *(rgb16 + 2) = strtol(strgroups[2], NULL, 16) / 255.0; + +} + + +static void i3clock_fetch_digital_clock_xy(int *x, + int *y, + const i3lock_digital_clock_t *dc, + const uint32_t *resolution, + int text_length) { + + /* x */ + if (dc->horizontal_alignment == I3LOCK_ALIGN_CENTER) { + *x = resolution[0] / 2 - text_length * dc->text_size / 2; + } else if (dc->horizontal_alignment == I3LOCK_ALIGN_RIGHT) { + *x = resolution[0] - resolution[0] / 10 - text_length * dc->text_size; + } else { + /* left */ + *x = resolution[0] / 10; /* 10% */ + } + + /* y */ + if (dc->vertical_alignment == I3LOCK_ALIGN_MIDDLE) { + *y = resolution[1] / 2 - dc->text_size / 2; + } else if (dc->vertical_alignment == I3LOCK_ALIGN_BOTTOM) { + *y = resolution[1] - resolution[1] / 10 - dc->text_size; + } else { + /* top */ + *y = resolution[1] / 10; /* 10% */ + } + +} + + +static void i3clock_fetch_led_clock_xy(int *x, + int *y, + const i3lock_led_clock_t *lc, + const uint32_t *resolution) { + int clock_length, clock_height; + + /* x */ + clock_length = 6 * resolution[1] / I3LOCK_SCALE_LED_SPACING + \ + 5 * resolution[1] / I3LOCK_SCALE_LED_LENGTH; + if (lc->horizontal_alignment == I3LOCK_ALIGN_CENTER) { + *x = resolution[0] / 2 - clock_length / 2; + } else if (lc->horizontal_alignment == I3LOCK_ALIGN_RIGHT) { + *x = resolution[0] - resolution[0] / 10 - clock_length; + } else { + /* left */ + *x = resolution[0] / 10; /* 10% */ + } + + /* y */ + clock_height = 3 * resolution[1] / I3LOCK_SCALE_LED_SPACING + \ + 2 * resolution[1] / I3LOCK_SCALE_LED_LENGTH; + if (lc->vertical_alignment == I3LOCK_ALIGN_MIDDLE) { + *y = resolution[1] / 2 - clock_height / 2; + } else if (lc->vertical_alignment == I3LOCK_ALIGN_BOTTOM) { + *y = resolution[1] - resolution[1] / 10 - clock_height; + } else { + /* top */ + *y = resolution[1] / 10; /* 10% */ + } + +} + + +static void i3lock_draw_led(cairo_t *cr, + double x, + double y, + double length, + int type, + const i3lock_led_clock_t *lc) { + double border_color[3], face_color[3]; + i3lock_color_to_array(border_color, lc->led_border_color); + if (type) { + /* LED on */ + i3lock_color_to_array(face_color, lc->led_on_color); + } else { + i3lock_color_to_array(face_color, lc->led_off_color); + } + cairo_set_line_width(cr, 2); + cairo_rectangle(cr, x, y, length, length); + cairo_set_source_rgb(cr, face_color[0], face_color[1], face_color[2]); + cairo_fill(cr); + cairo_rectangle(cr, x, y, length, length); + cairo_set_source_rgb(cr, border_color[0], border_color[1], border_color[2]); + cairo_stroke(cr); +} + + +void i3lock_draw_digital_clock(cairo_t *cr, + const i3lock_digital_clock_t *dc, + const uint32_t *resolution, + const struct tm *brokentime) { + double rgb16[3]; + char current_time_str[128]; + int x, y; + strftime(current_time_str, + 128, + dc->template, + brokentime); + i3lock_color_to_array(rgb16, dc->color); + cairo_set_source_rgb(cr, + rgb16[0], + rgb16[1], + rgb16[2]); + cairo_set_font_size(cr, dc->text_size); + if (xr_screens > 0) { + /* xinerama */ + int screen; + uint32_t screen_resolution[2]; + for (screen = 0; screen < xr_screens; ++screen) { + screen_resolution[0] = xr_resolutions[screen].width; + screen_resolution[1] = xr_resolutions[screen].height; + i3clock_fetch_digital_clock_xy(&x, + &y, + dc, + screen_resolution, + strlen(current_time_str)); + cairo_move_to(cr, + x + xr_resolutions[screen].x, + y + xr_resolutions[screen].y); + cairo_show_text(cr, current_time_str); + } + return; + } + + i3clock_fetch_digital_clock_xy(&x, + &y, + dc, + resolution, + strlen(current_time_str)); + /* printf("%dx%d\n", *resolution, *(resolution + 1)); */ + cairo_move_to(cr, x, y); + cairo_show_text(cr, current_time_str); + +} + + +void i3lock_draw_string(cairo_t *cr, + const char *formatted_string, + const i3lock_elapsed_time_t *et, + const uint32_t *resolution) { + double rgb16[3]; + int x, y; + + /* create a dummy i3lock_digital_clock_t structure in order to reuse + i3clock_fetch_digital_clock_xy */ + i3lock_digital_clock_t dc = {et->text_size, + "", + "", + et->horizontal_alignment, + et->vertical_alignment}; + i3lock_color_to_array(rgb16, et->color); + cairo_set_source_rgb(cr, + rgb16[0], + rgb16[1], + rgb16[2]); + cairo_set_font_size(cr, et->text_size); + if (xr_screens > 0) { + /* xinerama */ + int screen; + uint32_t screen_resolution[2]; + for (screen = 0; screen < xr_screens; ++screen) { + screen_resolution[0] = xr_resolutions[screen].width; + screen_resolution[1] = xr_resolutions[screen].height; + i3clock_fetch_digital_clock_xy(&x, + &y, + &dc, + screen_resolution, + strlen(formatted_string)); + cairo_move_to(cr, + x + xr_resolutions[screen].x, + y + xr_resolutions[screen].y); + cairo_show_text(cr, formatted_string); + } + return; + } + + i3clock_fetch_digital_clock_xy(&x, + &y, + &dc, + resolution, + strlen(formatted_string)); + /* printf("%dx%d\n", *resolution, *(resolution + 1)); */ + cairo_move_to(cr, x, y); + cairo_show_text(cr, formatted_string); + +} + + +void i3lock_draw_elapsed_time(cairo_t *cr, + const i3lock_elapsed_time_t *et, + const uint32_t *resolution, + const time_t *now) { + double rgb16[3]; + char elapsed_time_str[128]; + int x, y, seconds, minutes, hours, diff_seconds; + + /* create a dummy i3lock_digital_clock_t structure in ordet to reuse + i3clock_fetch_digital_clock_xy */ + i3lock_digital_clock_t dc = {et->text_size, + "", + "", + et->horizontal_alignment, + et->vertical_alignment}; + + diff_seconds = (int) difftime(*now, et->start_time); + hours = diff_seconds / 3600; + minutes = (diff_seconds - hours * 3600) / 60; + seconds = diff_seconds - hours * 3600 - minutes * 60; + if (hours) { + snprintf(elapsed_time_str, + 128, + "%d:%02d:%02d", + hours, + minutes, + seconds); + } else { + snprintf(elapsed_time_str, 128, "%02d:%02d", minutes, seconds); + } + if (failed_attempts) { + char failed_attempts_str[16]; /* ... that many attempts */ + snprintf(failed_attempts_str, + 16, + " (%d)", + failed_attempts); + strncat(elapsed_time_str, failed_attempts_str, 16); + } + i3lock_color_to_array(rgb16, et->color); + cairo_set_source_rgb(cr, + rgb16[0], + rgb16[1], + rgb16[2]); + cairo_set_font_size(cr, et->text_size); + if (xr_screens > 0) { + /* xinerama */ + int screen; + uint32_t screen_resolution[2]; + for (screen = 0; screen < xr_screens; ++screen) { + screen_resolution[0] = xr_resolutions[screen].width; + screen_resolution[1] = xr_resolutions[screen].height; + i3clock_fetch_digital_clock_xy(&x, + &y, + &dc, + screen_resolution, + strlen(elapsed_time_str)); + cairo_move_to(cr, + x + xr_resolutions[screen].x, + y + xr_resolutions[screen].y); + cairo_show_text(cr, elapsed_time_str); + } + return; + } + + i3clock_fetch_digital_clock_xy(&x, + &y, + &dc, + resolution, + strlen(elapsed_time_str)); + /* printf("%dx%d\n", *resolution, *(resolution + 1)); */ + cairo_move_to(cr, x, y); + cairo_show_text(cr, elapsed_time_str); + +} + + +void i3lock_draw_led_clock(cairo_t *cr, + const i3lock_led_clock_t *lc, + const uint32_t *resolution, + const struct tm *brokentime) { + int side_length, space_length, base_x, base_y; + int base_x_h; /* used to make the code more readable */ + if (xr_screens > 0) { + /* xinerama */ + int screen; + uint32_t screen_resolution[2]; + for (screen = 0; screen < xr_screens; ++screen) { + screen_resolution[0] = xr_resolutions[screen].width; + screen_resolution[1] = xr_resolutions[screen].height; + side_length = xr_resolutions[screen].height / I3LOCK_SCALE_LED_SPACING; + space_length = xr_resolutions[screen].height / I3LOCK_SCALE_LED_LENGTH; + i3clock_fetch_led_clock_xy(&base_x, + &base_y, + lc, + screen_resolution); + base_x += xr_resolutions[screen].x; + base_y += xr_resolutions[screen].y; + base_x_h = base_x + space_length / 2 + side_length / 2; + + /* hours */ + i3lock_draw_led(cr, + base_x_h, + base_y, + side_length, + brokentime->tm_hour & 16, + lc); + i3lock_draw_led(cr, + base_x_h + space_length + side_length, + base_y, + side_length, + brokentime->tm_hour & 8, + lc); + i3lock_draw_led(cr, + base_x_h + 2 * (space_length + side_length), + base_y, + side_length, + brokentime->tm_hour & 4, + lc); + i3lock_draw_led(cr, + base_x_h + 3 * (space_length + side_length), + base_y, + side_length, + brokentime->tm_hour & 2, + lc); + i3lock_draw_led(cr, + base_x_h + 4 * (space_length + side_length), + base_y, + side_length, + brokentime->tm_hour & 1, + lc); + + /* minutes */ + i3lock_draw_led(cr, + base_x, + base_y + side_length + space_length, + side_length, + brokentime->tm_min & 32, + lc); + i3lock_draw_led(cr, + base_x + side_length + space_length, + base_y + side_length + space_length, + side_length, + brokentime->tm_min & 16, + lc); + i3lock_draw_led(cr, + base_x + 2 * (side_length + space_length), + base_y + side_length + space_length, + side_length, + brokentime->tm_min & 8, + lc); + i3lock_draw_led(cr, + base_x + 3 * (side_length + space_length), + base_y + side_length + space_length, + side_length, + brokentime->tm_min & 4, + lc); + i3lock_draw_led(cr, + base_x + 4 * (side_length + space_length), + base_y + side_length + space_length, + side_length, + brokentime->tm_min & 2, + lc); + i3lock_draw_led(cr, + base_x + 5 * (side_length + space_length), + base_y + side_length + space_length, + side_length, + brokentime->tm_min & 1, + lc); + + /* seconds */ + i3lock_draw_led(cr, + base_x, + base_y + 2 * (side_length + space_length), + side_length, + brokentime->tm_sec & 32, + lc); + i3lock_draw_led(cr, + base_x + side_length + space_length, + base_y + 2 * (side_length + space_length), + side_length, + brokentime->tm_sec & 16, + lc); + i3lock_draw_led(cr, + base_x + 2 * (side_length + space_length), + base_y + 2 * (side_length + space_length), + side_length, + brokentime->tm_sec & 8, + lc); + i3lock_draw_led(cr, + base_x + 3 * (side_length + space_length), + base_y + 2 * (side_length + space_length), + side_length, + brokentime->tm_sec & 4, + lc); + i3lock_draw_led(cr, + base_x + 4 * (side_length + space_length), + base_y + 2 * (side_length + space_length), + side_length, + brokentime->tm_sec & 2, + lc); + i3lock_draw_led(cr, + base_x + 5 * (side_length + space_length), + base_y + 2 * (side_length + space_length), + side_length, + brokentime->tm_sec & 1, + lc); + } + return; + } + +} + + diff --git a/extras.h b/extras.h new file mode 100644 index 0000000..d4a353e --- /dev/null +++ b/extras.h @@ -0,0 +1,102 @@ +/* + * This file is part of i3lock-extended + * Copyright (C) 2020 Simeon Simeonov + + * i3lock-extended 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. + + * i3lock-extended 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 . + */ + +#ifndef EXTRAS_H +#define EXTRAS_H + +#include + + +#define I3LOCK_SCALE_LED_LENGTH 60 +#define I3LOCK_SCALE_LED_SPACING 30 + + +typedef enum { + + I3LOCK_ALIGN_LEFT = 0, + I3LOCK_ALIGN_CENTER, + I3LOCK_ALIGN_RIGHT + +} i3lock_horizontal_alignment; + + +typedef enum { + + I3LOCK_ALIGN_TOP = 0, + I3LOCK_ALIGN_MIDDLE, + I3LOCK_ALIGN_BOTTOM + +} i3lock_vertical_alignment; + + +typedef struct i3lock_digital_clock_t_ { + + int text_size; + char color[7]; + char *template; + i3lock_horizontal_alignment horizontal_alignment; + i3lock_vertical_alignment vertical_alignment; + +} i3lock_digital_clock_t; + + +typedef struct i3lock_elapsed_time_t_ { + + int text_size; + char color[7]; + time_t start_time; + i3lock_horizontal_alignment horizontal_alignment; + i3lock_vertical_alignment vertical_alignment; + +} i3lock_elapsed_time_t; + + +typedef struct i3lock_led_clock_t_ { + + char led_on_color[7]; + char led_off_color[7]; + char led_border_color[7]; + i3lock_horizontal_alignment horizontal_alignment; + i3lock_vertical_alignment vertical_alignment; + +} i3lock_led_clock_t; + + +void i3lock_draw_digital_clock(cairo_t *cr, + const i3lock_digital_clock_t *dc, + const uint32_t *resolution, + const struct tm *brokentime); + + +void i3lock_draw_elapsed_time(cairo_t *cr, + const i3lock_elapsed_time_t *et, + const uint32_t *resolution, + const time_t *now); + + +void i3lock_draw_led_clock(cairo_t *cr, + const i3lock_led_clock_t *lc, + const uint32_t *resolution, + const struct tm *brokentime); + + +void i3lock_draw_string(cairo_t *cr, + const char *formatted_string, + const i3lock_elapsed_time_t *et, + const uint32_t *resolution); +#endif diff --git a/i3lock-extended.1 b/i3lock-extended.1 new file mode 100644 index 0000000..b0f51a7 --- /dev/null +++ b/i3lock-extended.1 @@ -0,0 +1,298 @@ +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. + +.TH i3lock\-extended 1 "MARCH 2020" Linux "User Manuals" + +.SH NAME +i3lock\-extended \- improved screen locker + +.SH SYNOPSIS +.B i3lock\-extended +.RB [\|\-B +.IR color \|] +.RB [\|\-b\|] +.RB [\|\-c +.IR color \|] +.RB [\|\-D\|] +.RB [\|\-E\|] +.RB [\|\-e\|] +.RB [\|\-F +.IR color \|] +.RB [\|\-f\|] +.RB [\|\-G +.IR color \|] +.RB [\|\-i +.IR image.png \|] +.RB [\|\-J +.IR text \|] +.RB [\|\-L\|] +.RB [\|\-n\|] +.RB [\|\-O +.IR color \|] +.RB [\|\-p +.IR pointer\|] +.RB [\|\-R +.IR color \|] +.RB [\|\-r +.IR refresh rate \|] +.RB [\|\-S +.IR size \|] +.RB [\|\-T +.IR template \|] +.RB [\|\-t\|] +.RB [\|\-u\|] +.RB [\|\-v\|] +.RB [\|\-W +.IR halign \|] +.RB [\|\-X +.IR halign \|] +.RB [\|\-x +.IR halign \|] +.RB [\|\-Y +.IR valign \|] +.RB [\|\-y +.IR valign \|] +.RB [\|\-Z +.IR valign \|] + +.SH DESCRIPTION +.B i3lock-extended +is a fork of i3lock which is a simple screen locker like slock. +i3lock-extended has all the i3lock features and some additional ones. +Hence this manual will refer to i3lock-extended only when describing these +additional features. After starting it, you will see a white screen +(you can configure the color/an image). You can return to your screen by +entering your password. + +.SH IMPROVEMENTS + +.IP \[bu] 2 +i3lock forks, so you can combine it with an alias to suspend to RAM (run "i3lock && echo mem > /sys/power/state" to get a locked screen after waking up your computer from suspend to RAM) +.IP \[bu] +You can specify either a background color or a PNG image which will be displayed while your screen is locked. +.IP \[bu] +You can specify whether i3lock should bell upon a wrong password. +.IP \[bu] +i3lock uses PAM and therefore is compatible with LDAP, etc. + +.SH EXTENDED FUNCTIONALITY +.B i3lock\-extended +provides the following additional functionality: + +.IP \[bu] 2 +LED-clock +.IP \[bu] +Digital clock +.IP \[bu] +Elapsed time since activation +.IP \[bu] +Display-text + +.SH OPTIONS +.TP +.BI \-B\ rrggbb \fR,\ \fB\-\-led\-border\-color= rrggbb +The border color of the LED clock. +format: rrggbb (i.e. ff0000 is red). Default: 000000 (black). + +.TP +.B \-b, \-\-beep +Enable beeping. Be sure to not do this when you are about to annoy other people, +like when opening your laptop in a boring lecture. + +.TP +.BI \-c\ rrggbb \fR,\ \fB\-\-color= rrggbb +Turn the screen into the given color instead of white. +Color must be given in 3-byte. Default: ffffff (white). + +.TP +.B \-D, \-\-digital\-clock +Display digital clock. + +.TP +.B \-\-debug +Enables debug logging. +Note, that this will log the password used for authentication to stdout. + +.TP +.B \-E, \-\-elapsed\-time +Display the elapsed time since i3lock-extended was activated. + +.TP +.B \-e, \-\-ignore-empty-password +When an empty password is provided by the user, do not validate +it. Without this option, the empty password will be provided to PAM +and, if invalid, the user will have to wait a few seconds before +another try. This can be useful if the XF86ScreenSaver key is used to +put a laptop to sleep and bounce on resume or if you happen to wake up +your computer with the enter key. + +.TP +.BI \-F\ rrggbb \fR,\ \fB\-\-led\-off\-color= rrggbb +The color of the off-LED in the LED-clock. Default: 7f7f7f. + +.TP +.B \-f, \-\-show-failed-attempts +Show the number of failed attempts, if any. + +.TP +.BI \-G\ rrggbb \fR,\ \fB\-\-digital\-clock\-color= rrggbb +The color of the digital-clock (text). Default: 000000 (black). + +.TP +.BI \-i\ path \fR,\ \fB\-\-image= path +Display the given PNG image instead of a blank screen. + +.TP +.BI \-J\ text \fR,\ \fB\-\-display\-text= text +Display text instead of elapsed time, using the same color and alignment. + +.TP +.B \-L, \-\-led\-clock +Display LED-clock. + +.TP +.B \-n, \-\-nofork +Don't fork after starting. + +.TP +.BI \-O\ rrggbb \fR,\ \fB\-\-led\-on\-color= rrggbb +The color of the on-LED in the LED-clock. Default: ffff00 (yellow). + +.TP +.BI \-p\ win|default \fR,\ \fB\-\-pointer= win|default +If you specify "default", +.B i3lock +does not hide your mouse pointer. If you specify "win", +.B i3lock +displays a hardcoded Windows-Pointer (thus enabling you to mess with your +friends by using a screenshot of a Windows desktop as a locking-screen). + +.TP +.BI \-R\ rrggbb \fR,\ \fB\-\-elapsed\-time\-color= rrggbb +The color of the elapsed time (text). Default: 000000 (black). + +.TP +.BI \-r\ rate \fR,\ \fB\-\-refresh\-rate= rate +Rate is the amount of times per second we refresh the screen. Default: 2. + +.TP +.BI \fB\-\-raw= format +Read the image given by \-\-image as a raw image instead of PNG. The argument is the image's format +as x:. The supported pixel formats are: +\'native', 'rgb', 'xrgb', 'rgbx', 'bgr', 'xbgr', and 'bgrx'. +The "native" pixel format expects a pixel as a 32-bit (4-byte) integer in +the machine's native endianness, with the upper 8 bits unused. Red, green and blue are stored in +the remaining bits, in that order. + +.BR Example: +.Vb 6 +\& --raw=1920x1080:rgb +.Ve + +.BR +You can use ImageMagick’s +.IR convert(1) +program to feed raw images into i3lock: + +.BR +.Vb 6 +\& convert wallpaper.jpg RGB:- | i3lock --raw 3840x2160:rgb --image /dev/stdin +.Ve + +This allows you to load a variety of image formats without i3lock having to +support each one explicitly. + +.TP +.BI \-S\ size \fR,\ \fB\-\-text\-size= size +The text size for elapsed time, digital clock and display-text. Default: 28. + +.TP +.BI \-T\ template \fR,\ \fB\-\-digital\-clock\-template= template +The date(time) template for the digital clock. Default: %H:%M:%S. + +.TP +.B \-t, \-\-tiling +If an image is specified (via \-i) it will display the image tiled all over the screen +(if it is a multi-monitor setup, the image is visible on all screens). + +.TP +.B \-u, \-\-no-unlock-indicator +Disable the unlock indicator. i3lock will by default show an unlock indicator +after pressing keys. This will give feedback for every keypress and it will +show you the current PAM state (whether your password is currently being +verified or whether it is wrong). + +.TP +.B \-v, \-\-version +Display the version of your +.B i3lock + +.TP +.BI \-W\ halign \fR,\ \fB\-\-elapsed\-time\-halign= halign +The horizontal alignment for elapsed time and display-text. +Valid halign values: left, center, right. Default: right + +.TP +.BI \-X\ halign \fR,\ \fB\-\-led\-clock\-halign= halign +The horizontal alignment for the LED-clock. Default: center + +.TP +.BI \-x\ halign \fR,\ \fB\-\-digital\-clock\-halign= halign +The horizontal alignment for the digital clock. Default: left + +.TP +.BI \-Y\ valign \fR,\ \fB\-\-led\-clock\-valign= valign +The vertical alignment for the LED-clock. +Valid valign values: top, middle, bottom. Default: bottom + +.TP +.BI \-y\ valign \fR,\ \fB\-\-digital\-clock\-valign= valign +The vertical alignment for the digital clock. Default: top + +.TP +.BI \-Z\ valign \fR,\ \fB\-\-elapsed\-time\-valign= valign +The vertical alignment for elapsed time and display-text. Default: bottom + +.SH DPMS + +The \-d (\-\-dpms) option was removed from i3lock in version 2.8. There were +plenty of use-cases that were not properly addressed, and plenty of bugs +surrounding that feature. While features are not normally removed from i3 and +its tools, we felt the need to make an exception in this case. + +Users who wish to explicitly enable DPMS only when their screen is locked can +use a wrapper script around i3lock like the following: + +.Vb 6 +\& #!/bin/sh +\& revert() { +\& xset dpms 0 0 0 +\& } +\& trap revert HUP INT TERM +\& xset +dpms dpms 5 5 5 +\& i3lock -n +\& revert +.Ve + +The \-I (-\-inactivity-timeout=seconds) was removed because it only makes sense with DPMS. + +.SH SEE ALSO +.IR xautolock(1) +\- use i3lock as your screen saver + +.IR convert(1) +\- feed a wide variety of image formats to i3lock + +.SH AUTHOR +Michael Stapelberg + +Jan-Erik Rediger + +Simeon Simeonov diff --git a/i3lock.1 b/i3lock.1 deleted file mode 100644 index cefd0d8..0000000 --- a/i3lock.1 +++ /dev/null @@ -1,173 +0,0 @@ -.de Vb \" Begin verbatim text -.ft CW -.nf -.ne \\$1 -.. -.de Ve \" End verbatim text -.ft R -.fi -.. - -.TH i3lock 1 "JANUARY 2012" Linux "User Manuals" - -.SH NAME -i3lock \- improved screen locker - -.SH SYNOPSIS -.B i3lock -.RB [\|\-v\|] -.RB [\|\-n\|] -.RB [\|\-b\|] -.RB [\|\-i -.IR image.png \|] -.RB [\|\-c -.IR color \|] -.RB [\|\-t\|] -.RB [\|\-p -.IR pointer\|] -.RB [\|\-u\|] -.RB [\|\-e\|] -.RB [\|\-f\|] - -.SH DESCRIPTION -.B i3lock -is a simple screen locker like slock. After starting it, you will see a white -screen (you can configure the color/an image). You can return to your screen by -entering your password. - -.SH IMPROVEMENTS - -.IP \[bu] 2 -i3lock forks, so you can combine it with an alias to suspend to RAM (run "i3lock && echo mem > /sys/power/state" to get a locked screen after waking up your computer from suspend to RAM) -.IP \[bu] -You can specify either a background color or a PNG image which will be displayed while your screen is locked. -.IP \[bu] -You can specify whether i3lock should bell upon a wrong password. -.IP \[bu] -i3lock uses PAM and therefore is compatible with LDAP, etc. - - -.SH OPTIONS -.TP -.B \-v, \-\-version -Display the version of your -.B i3lock - -.TP -.B \-n, \-\-nofork -Don't fork after starting. - -.TP -.B \-b, \-\-beep -Enable beeping. Be sure to not do this when you are about to annoy other people, -like when opening your laptop in a boring lecture. - -.TP -.B \-u, \-\-no-unlock-indicator -Disable the unlock indicator. i3lock will by default show an unlock indicator -after pressing keys. This will give feedback for every keypress and it will -show you the current PAM state (whether your password is currently being -verified or whether it is wrong). - -.TP -.BI \-i\ path \fR,\ \fB\-\-image= path -Display the given PNG image instead of a blank screen. - -.TP -.BI \fB\-\-raw= format -Read the image given by \-\-image as a raw image instead of PNG. The argument is the image's format -as x:. The supported pixel formats are: -\'native', 'rgb', 'xrgb', 'rgbx', 'bgr', 'xbgr', and 'bgrx'. -The "native" pixel format expects a pixel as a 32-bit (4-byte) integer in -the machine's native endianness, with the upper 8 bits unused. Red, green and blue are stored in -the remaining bits, in that order. - -.BR Example: -.Vb 6 -\& --raw=1920x1080:rgb -.Ve - -.BR -You can use ImageMagick’s -.IR convert(1) -program to feed raw images into i3lock: - -.BR -.Vb 6 -\& convert wallpaper.jpg RGB:- | i3lock --raw 3840x2160:rgb --image /dev/stdin -.Ve - -This allows you to load a variety of image formats without i3lock having to -support each one explicitly. - -.TP -.BI \-c\ rrggbb \fR,\ \fB\-\-color= rrggbb -Turn the screen into the given color instead of white. Color must be given in 3-byte -format: rrggbb (i.e. ff0000 is red). - -.TP -.B \-t, \-\-tiling -If an image is specified (via \-i) it will display the image tiled all over the screen -(if it is a multi-monitor setup, the image is visible on all screens). - -.TP -.BI \-p\ win|default \fR,\ \fB\-\-pointer= win|default -If you specify "default", -.B i3lock -does not hide your mouse pointer. If you specify "win", -.B i3lock -displays a hardcoded Windows-Pointer (thus enabling you to mess with your -friends by using a screenshot of a Windows desktop as a locking-screen). - -.TP -.B \-e, \-\-ignore-empty-password -When an empty password is provided by the user, do not validate -it. Without this option, the empty password will be provided to PAM -and, if invalid, the user will have to wait a few seconds before -another try. This can be useful if the XF86ScreenSaver key is used to -put a laptop to sleep and bounce on resume or if you happen to wake up -your computer with the enter key. - -.TP -.B \-f, \-\-show-failed-attempts -Show the number of failed attempts, if any. - -.TP -.B \-\-debug -Enables debug logging. -Note, that this will log the password used for authentication to stdout. - -.SH DPMS - -The \-d (\-\-dpms) option was removed from i3lock in version 2.8. There were -plenty of use-cases that were not properly addressed, and plenty of bugs -surrounding that feature. While features are not normally removed from i3 and -its tools, we felt the need to make an exception in this case. - -Users who wish to explicitly enable DPMS only when their screen is locked can -use a wrapper script around i3lock like the following: - -.Vb 6 -\& #!/bin/sh -\& revert() { -\& xset dpms 0 0 0 -\& } -\& trap revert HUP INT TERM -\& xset +dpms dpms 5 5 5 -\& i3lock -n -\& revert -.Ve - -The \-I (-\-inactivity-timeout=seconds) was removed because it only makes sense with DPMS. - -.SH SEE ALSO -.IR xautolock(1) -\- use i3lock as your screen saver - -.IR convert(1) -\- feed a wide variety of image formats to i3lock - -.SH AUTHOR -Michael Stapelberg - -Jan-Erik Rediger diff --git a/i3lock.c b/i3lock.c index 134fdda..7f8763a 100644 --- a/i3lock.c +++ b/i3lock.c @@ -1,11 +1,30 @@ /* - * vim:ts=4:sw=4:expandtab + * This file is part of i3lock-extended + * Copyright (C) 2020 Simeon Simeonov + + * i3lock-extended 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. + + * i3lock-extended 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 . + */ + +/* This file includes software copyrighted by Michael Stapelberg and + * distributed under the following license: See LICENSE for more information * * © 2010 Michael Stapelberg * * See LICENSE for licensing information * */ + #include #include @@ -48,6 +67,10 @@ #include "randr.h" #include "dpi.h" +#ifdef EXTRAS +#include "extras.h" +#endif + #define TSTAMP_N_SECS(n) (n * 1.0) #define TSTAMP_N_MINS(n) (60 * TSTAMP_N_SECS(n)) #define START_TIMER(timer_obj, timeout, callback) \ @@ -58,6 +81,31 @@ typedef void (*ev_callback_t)(EV_P_ ev_timer *w, int revents); static void input_done(void); +#ifdef EXTRAS +bool digital_clock = false; +bool led_clock = false; +bool elapsed_time = false; +int refresh_rate = 2; /* 2 frames per second */ +i3lock_digital_clock_t i3lock_digital_clock = {28, + "000000", + "%H:%M:%S", + I3LOCK_ALIGN_LEFT, + I3LOCK_ALIGN_TOP}; + +i3lock_elapsed_time_t i3lock_elapsed_time = {28, + "000000", + 0, + I3LOCK_ALIGN_RIGHT, + I3LOCK_ALIGN_BOTTOM}; + +i3lock_led_clock_t i3lock_led_clock = {"ffff00", + "7f7f7f", + "000000", + I3LOCK_ALIGN_CENTER, + I3LOCK_ALIGN_BOTTOM}; +char *display_text = NULL; +#endif + char color[7] = "ffffff"; uint32_t last_resolution[2]; xcb_window_t win; @@ -305,7 +353,10 @@ static void input_done(void) { return; } #endif - +#ifdef EXTRAS + /* reset the time elapsed counter */ + i3lock_elapsed_time.start_time = time(NULL); +#endif if (debug_mode) fprintf(stderr, "Authentication failure\n"); @@ -1005,6 +1056,15 @@ static void raise_loop(xcb_window_t window) { } } +#ifdef EXTRAS +/* called periodically by the ticking system */ +static void refresh_tick_cb (EV_P_ ev_timer *w, int revents) { + + redraw_screen(); + +} +#endif + int main(int argc, char *argv[]) { struct passwd *pw; char *username; @@ -1023,6 +1083,26 @@ int main(int argc, char *argv[]) { {"beep", no_argument, NULL, 'b'}, {"dpms", no_argument, NULL, 'd'}, {"color", required_argument, NULL, 'c'}, +#ifdef EXTRAS + {"digital-clock", no_argument, NULL, 'D'}, + {"digital-clock-color", required_argument, NULL, 'G'}, + {"digital-clock-template", required_argument, NULL, 'T'}, + {"digital-clock-halign", required_argument, NULL, 'x'}, + {"digital-clock-valign", required_argument, NULL, 'y'}, + {"display-text", no_argument, NULL, 'J'}, + {"elapsed-time", no_argument, NULL, 'E'}, + {"elapsed-time-color", required_argument, NULL, 'R'}, + {"elapsed-time-halign", required_argument, NULL, 'W'}, + {"elapsed-time-valign", required_argument, NULL, 'Z'}, + {"led-clock", no_argument, NULL, 'L'}, + {"led-clock-halign", required_argument, NULL, 'X'}, + {"led-clock-valign", required_argument, NULL, 'Y'}, + {"led-border-color", required_argument, NULL, 'B'}, + {"led-off-color", required_argument, NULL, 'F'}, + {"led-on-color", required_argument, NULL, 'O'}, + {"refresh-rate", required_argument, NULL, 'r'}, + {"text-size", required_argument, NULL, 'S'}, +#endif {"pointer", required_argument, NULL, 'p'}, {"debug", no_argument, NULL, 0}, {"help", no_argument, NULL, 'h'}, @@ -1040,11 +1120,15 @@ int main(int argc, char *argv[]) { if ((username = pw->pw_name) == NULL) errx(EXIT_FAILURE, "pw->pw_name is NULL."); +#ifdef EXTRAS + char *optstring = "hvnbDdELc:B:G:F:J:O:R:r:S:T:W:X:x:Y:y:Z:p:ui:teI:f"; +#else char *optstring = "hvnbdc:p:ui:teI:f"; +#endif while ((o = getopt_long(argc, argv, optstring, longopts, &longoptind)) != -1) { switch (o) { case 'v': - errx(EXIT_SUCCESS, "version " I3LOCK_VERSION " © 2010 Michael Stapelberg"); + errx(EXIT_SUCCESS, "version " I3LOCK_VERSION " © 2010 Michael Stapelberg, 2017-2020 Simeon Simeonov"); case 'n': dont_fork = true; break; @@ -1052,10 +1136,10 @@ int main(int argc, char *argv[]) { beep = true; break; case 'd': - fprintf(stderr, "DPMS support has been removed from i3lock. Please see the manpage i3lock(1).\n"); + fprintf(stderr, "DPMS support has been removed from i3lock. Please see the manpage i3lock-extended(1).\n"); break; case 'I': { - fprintf(stderr, "Inactivity timeout only makes sense with DPMS, which was removed. Please see the manpage i3lock(1).\n"); + fprintf(stderr, "Inactivity timeout only makes sense with DPMS, which was removed. Please see the manpage i3lock-extended(1).\n"); break; } case 'c': { @@ -1070,6 +1154,181 @@ int main(int argc, char *argv[]) { break; } +#ifdef EXTRAS + case 'D': + digital_clock = true; + break; + case 'E': + elapsed_time = true; + i3lock_elapsed_time.start_time = time(NULL); + break; + case 'L': + led_clock = true; + break; + case 'B': { + char *arg = optarg; + + /* Skip # if present */ + if (arg[0] == '#') + arg++; + + if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", i3lock_led_clock.led_border_color) != 1) + errx(EXIT_FAILURE, "led-border-color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n"); + DEBUG("led-border-color: %s\n", i3lock_led_clock.led_border_color); + break; + } + case 'G': { /* digital-clock-color */ + char *arg = optarg; + + /* Skip # if present */ + if (arg[0] == '#') + arg++; + + if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", i3lock_digital_clock.color) != 1) + errx(EXIT_FAILURE, "digital-clock-color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n"); + DEBUG("digital-clock-color: %s\n", i3lock_digital_clock.color); + break; + } + case 'F': { /* led-off-color */ + char *arg = optarg; + + /* Skip # if present */ + if (arg[0] == '#') + arg++; + + if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", i3lock_led_clock.led_off_color) != 1) + errx(EXIT_FAILURE, "led-off-color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n"); + DEBUG("led-off-color: %s\n", i3lock_led_clock.led_off_color); + break; + } + case 'J': { + display_text = strdup(optarg); + if (display_text == NULL) { + errx(EXIT_FAILURE, + "Unable to initialize display_text\n"); + } + DEBUG("display_text: %s\n", display_text); + break; + } + case 'O': { /* led-on-color */ + char *arg = optarg; + + /* Skip # if present */ + if (arg[0] == '#') + arg++; + + if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", i3lock_led_clock.led_on_color) != 1) + errx(EXIT_FAILURE, "led-on-color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n"); + DEBUG("led-on-color: %s\n", i3lock_led_clock.led_on_color); + break; + } + case 'R': { /* elapsed-time-color */ + char *arg = optarg; + + /* Skip # if present */ + if (arg[0] == '#') + arg++; + + if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", i3lock_elapsed_time.color) != 1) + errx(EXIT_FAILURE, "elapsed-time-color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n"); + DEBUG("elapsed-time-color: %s\n", i3lock_elapsed_time.color); + break; + } + case 'r': /* refresh-rate */ + if (atoi(optarg)) /* not nice with 0 */ + refresh_rate = atoi(optarg); + DEBUG("refresh-rate: %d\n", + refresh_rate); + break; + case 'S': /* text-size */ + i3lock_elapsed_time.text_size = i3lock_digital_clock.text_size = atoi(optarg); + DEBUG("text-size: %d\n", + i3lock_digital_clock.text_size); + break; + case 'T': /* digital-clock-template */ + i3lock_digital_clock.template = strdup(optarg); + DEBUG("digital-clock-template: %s\n", + i3lock_digital_clock.template); + break; + case 'W': /* elapsed-time-halign */ + /* the default is right */ + if (strcasecmp(optarg, "left") == 0) { + i3lock_elapsed_time.horizontal_alignment = I3LOCK_ALIGN_LEFT; + DEBUG("elapsed-time-halign: left\n"); + } else if (strcasecmp(optarg, "center") == 0) { + i3lock_elapsed_time.horizontal_alignment = I3LOCK_ALIGN_CENTER; + DEBUG("elapsed-time-halign: center\n"); + } else { + /* value already set */ + DEBUG("elapsed-time-halign: right\n"); + } + break; + case 'X': /* led-clock-halign */ + /* the default is center */ + if (strcasecmp(optarg, "left") == 0) { + i3lock_led_clock.horizontal_alignment = I3LOCK_ALIGN_LEFT; + DEBUG("led-clock-halign: left\n"); + } else if (strcasecmp(optarg, "right") == 0) { + i3lock_led_clock.horizontal_alignment = I3LOCK_ALIGN_RIGHT; + DEBUG("led-clock-halign: right\n"); + } else { + /* value already set */ + DEBUG("led-clock-halign: center\n"); + } + break; + case 'Y': /* led-clock-valign */ + /* the default is bottom */ + if (strcasecmp(optarg, "middle") == 0) { + i3lock_led_clock.vertical_alignment = I3LOCK_ALIGN_MIDDLE; + DEBUG("led-clock-valign: middle\n"); + } else if (strcasecmp(optarg, "top") == 0) { + i3lock_led_clock.vertical_alignment = I3LOCK_ALIGN_TOP; + DEBUG("led-clock-valign: top\n"); + } else { + /* value already set */ + DEBUG("led-clock-valign: bottom\n"); + } + break; + case 'x': /* digital-clock-halign */ + /* the default is left */ + if (strcasecmp(optarg, "center") == 0) { + i3lock_digital_clock.horizontal_alignment = I3LOCK_ALIGN_CENTER; + DEBUG("digital-clock-halign: center\n"); + } else if (strcasecmp(optarg, "right") == 0) { + i3lock_digital_clock.horizontal_alignment = I3LOCK_ALIGN_RIGHT; + DEBUG("digital-clock-halign: right\n"); + } else { + /* value already set */ + DEBUG("digital-clock-halign: left\n"); + } + break; + case 'y': /* digital-clock-valign */ + /* the default is top */ + if (strcasecmp(optarg, "middle") == 0) { + i3lock_digital_clock.vertical_alignment = I3LOCK_ALIGN_MIDDLE; + DEBUG("digital-clock-valign: middle\n"); + } else if (strcasecmp(optarg, "bottom") == 0) { + i3lock_digital_clock.vertical_alignment = I3LOCK_ALIGN_BOTTOM; + DEBUG("digital-clock-valign: bottom\n"); + } else { + /* value already set */ + DEBUG("digital-clock-valign: top\n"); + } + break; + case 'Z': /* elapsed-time-valign */ + /* the default is bottom */ + if (strcasecmp(optarg, "middle") == 0) { + i3lock_elapsed_time.vertical_alignment = I3LOCK_ALIGN_MIDDLE; + DEBUG("elapsed-time-valign: middle\n"); + } else if (strcasecmp(optarg, "top") == 0) { + i3lock_elapsed_time.vertical_alignment = I3LOCK_ALIGN_TOP; + DEBUG("elapsed-time-valign: top\n"); + } else { + /* value already set */ + DEBUG("elapsed-time-valign: bottom\n"); + } + break; +#endif case 'u': unlock_indicator = false; break; @@ -1101,8 +1360,21 @@ int main(int argc, char *argv[]) { show_failed_attempts = true; break; default: +#ifdef EXTRAS + errx( + EXIT_FAILURE, + "Syntax: i3lock-extended [-v] [-n] [-b] [-D] [-d] [-E] " + "[-L] [-c color] [-B color] [-F color] [-G color] " + "[-J text] [-O color] [-R color] [-r refresh rate] [-u] " + "[-W horizontal-alignment] [-X horizontal-alignment] " + "[-x horizontal-alignment] [-Y vertical-alignment] " + "[-y vertical-alignment] [-Z vertical-alignment] " + "[-p win|default] [-i image.png] [-t] [-e] [-I timeout] " + "[-f]"); +#else errx(EXIT_FAILURE, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]" " [-i image.png] [-t] [-e] [-I timeout] [-f]"); +#endif } } @@ -1291,6 +1563,11 @@ int main(int argc, char *argv[]) { ev_prepare_init(xcb_prepare, xcb_prepare_cb); ev_prepare_start(main_loop, xcb_prepare); +#ifdef EXTRAS + ev_timer refresh_tick_watcher; + ev_timer_init (&refresh_tick_watcher, refresh_tick_cb, 1.0, 1.0 / refresh_rate); + ev_timer_start (main_loop, &refresh_tick_watcher); +#endif /* Invoke the event callback once to catch all the events which were * received up until now. ev will only pick up new events (when the X11 * file descriptor becomes readable). */ diff --git a/pam/i3lock b/pam/i3lock deleted file mode 100644 index 6eb8e68..0000000 --- a/pam/i3lock +++ /dev/null @@ -1,6 +0,0 @@ -# -# PAM configuration file for the i3lock screen locker. By default, it includes -# the 'login' configuration file (see /etc/pam.d/login) -# - -auth include login diff --git a/pam/i3lock-extended b/pam/i3lock-extended new file mode 100644 index 0000000..6eb8e68 --- /dev/null +++ b/pam/i3lock-extended @@ -0,0 +1,6 @@ +# +# PAM configuration file for the i3lock screen locker. By default, it includes +# the 'login' configuration file (see /etc/pam.d/login) +# + +auth include login diff --git a/unlock_indicator.c b/unlock_indicator.c index d6237ed..3d98a5f 100644 --- a/unlock_indicator.c +++ b/unlock_indicator.c @@ -1,11 +1,30 @@ /* - * vim:ts=4:sw=4:expandtab + * This file is part of i3lock-extended + * Copyright (C) 2020 Simeon Simeonov + + * i3lock-extended 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. + + * i3lock-extended 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 . + */ + +/* This file includes software copyrighted by Michael Stapelberg and + * distributed under the following license: See LICENSE for more information * * © 2010 Michael Stapelberg * * See LICENSE for licensing information * */ + #include #include #include @@ -22,17 +41,36 @@ #include "randr.h" #include "dpi.h" +#ifdef EXTRAS +#include "extras.h" +#endif + #define BUTTON_RADIUS 90 #define BUTTON_SPACE (BUTTON_RADIUS + 5) #define BUTTON_CENTER (BUTTON_RADIUS + 5) #define BUTTON_DIAMETER (2 * BUTTON_SPACE) -/******************************************************************************* +/****************************************************************************** * Variables defined in i3lock.c. - ******************************************************************************/ + *****************************************************************************/ extern bool debug_mode; +#ifdef EXTRAS +/* timekeeping */ +time_t now; +struct tm *brokentime; +/* enable the digital clock */ +extern bool digital_clock; +extern bool led_clock; +extern bool elapsed_time; +extern i3lock_digital_clock_t i3lock_digital_clock; +extern i3lock_elapsed_time_t i3lock_elapsed_time; +extern i3lock_led_clock_t i3lock_led_clock; +/* display text */ +extern char *display_text; +#endif + /* The current position in the input buffer. Useful to determine if any * characters of the password have already been entered or not. */ extern int input_position; @@ -62,16 +100,16 @@ extern bool show_failed_attempts; /* Number of failed unlock attempts. */ extern int failed_attempts; -/******************************************************************************* +/****************************************************************************** * Variables defined in xcb.c. - ******************************************************************************/ + *****************************************************************************/ /* The root screen, to determine the DPI. */ extern xcb_screen_t *screen; -/******************************************************************************* +/****************************************************************************** * Local variables. - ******************************************************************************/ + *****************************************************************************/ /* Cache the screen’s visual, necessary for creating a Cairo context. */ static xcb_visualtype_t *vistype; @@ -304,7 +342,34 @@ xcb_pixmap_t draw_image(uint32_t *resolution) { cairo_stroke(ctx); } } - +#ifdef EXTRAS + now = time(NULL); + brokentime = localtime(&now); + if (led_clock) { + i3lock_draw_led_clock(xcb_ctx, + &i3lock_led_clock, + resolution, + brokentime); + } + if (digital_clock) { + i3lock_draw_digital_clock(xcb_ctx, + &i3lock_digital_clock, + resolution, + brokentime); + } + /* elapsed time or display text */ + if (elapsed_time) { + i3lock_draw_elapsed_time(xcb_ctx, + &i3lock_elapsed_time, + resolution, + &now); + } else if (display_text != NULL) { + i3lock_draw_string(xcb_ctx, + display_text, + &i3lock_elapsed_time, + resolution); + } +#endif if (xr_screens > 0) { /* Composite the unlock indicator in the middle of each screen. */ for (int screen = 0; screen < xr_screens; screen++) { -- cgit v1.3