From f68bb2c8c68624376145ce426251c39bafbb6157 Mon Sep 17 00:00:00 2001 From: Gregory DAVID Date: Fri, 21 Jun 2024 21:16:01 +0200 Subject: [PATCH] my-public-ip: add a new block to display the current public IP --- my-public-ip/LICENSE | 340 ++++++++++++++++++++++++++++ my-public-ip/README.md | 36 +++ my-public-ip/i3blocks.conf | 14 ++ my-public-ip/my-public-ip | 83 +++++++ my-public-ip/my-public-ip-long.png | Bin 0 -> 1392 bytes my-public-ip/my-public-ip-short.png | Bin 0 -> 788 bytes 6 files changed, 473 insertions(+) create mode 100755 my-public-ip/LICENSE create mode 100755 my-public-ip/README.md create mode 100755 my-public-ip/i3blocks.conf create mode 100755 my-public-ip/my-public-ip create mode 100644 my-public-ip/my-public-ip-long.png create mode 100644 my-public-ip/my-public-ip-short.png diff --git a/my-public-ip/LICENSE b/my-public-ip/LICENSE new file mode 100755 index 00000000..8cdb8451 --- /dev/null +++ b/my-public-ip/LICENSE @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) 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 +this service 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 make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. 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. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE 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. + + 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 +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {description} + Copyright (C) {year} {fullname} + + 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 2 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, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision 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, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + {signature of Ty Coon}, 1 April 1989 + Ty Coon, President of Vice + +This 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. + diff --git a/my-public-ip/README.md b/my-public-ip/README.md new file mode 100755 index 00000000..e4b5a743 --- /dev/null +++ b/my-public-ip/README.md @@ -0,0 +1,36 @@ +# `my-public-ip` + +Display the public IP address returned by an public IP provider, +such as [ip.yunohost.org](http://ip.yunohost.org) or +[ipv4.icanhazeip.com](http://ipv4.icanhazeip.com). + +Offers clipboarding with middle mouse button click on the block, even +in short display. + +![](my-public-ip-long.png) +![](my-public-ip-short.png) + +# Dependencies + +- `wget` or `curl` for HTTP request, +- `xclip` for clipboarding. + +# Config +## Output with pango markup available +```INI +[my-public-ip] +command=$SCRIPT_DIR/my-public-ip +markup=pango +interval=60 +color=#aaffaa +# public_ip_provider=ip.yunohost.org +``` + +## Classic output +```INI +[my-public-ip] +command=$SCRIPT_DIR/my-public-ip +interval=60 +color=#aaffaa +# public_ip_provider=ipv4.icanhazeip.com +``` diff --git a/my-public-ip/i3blocks.conf b/my-public-ip/i3blocks.conf new file mode 100755 index 00000000..8ddc9d0d --- /dev/null +++ b/my-public-ip/i3blocks.conf @@ -0,0 +1,14 @@ +# Output with pango markup available +[my-public-ip] +command=$SCRIPT_DIR/my-public-ip +markup=pango +interval=60 +color=#aaffaa +# public_ip_provider=ip.yunohost.org + +# Classic output +[my-public-ip] +command=$SCRIPT_DIR/my-public-ip +interval=60 +color=#aaffaa +# public_ip_provider=ip.yunohost.org diff --git a/my-public-ip/my-public-ip b/my-public-ip/my-public-ip new file mode 100755 index 00000000..11d78bef --- /dev/null +++ b/my-public-ip/my-public-ip @@ -0,0 +1,83 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2024 Gregory David + +# 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 . + +import os +import subprocess +import sys +from typing import Dict, List + +CONFIG: dict = dict(os.environ) +DEFAULT_COLOR: str = CONFIG.get("color", "#ffffff") +PANGO_MARKUP: bool = CONFIG.get("markup", "") == "pango" +PUBLIC_IP_PROVIDER: str = CONFIG.get("public_ip_provider", "ip.yunohost.org") + + +def print_format( + long_text: str, + short_text: str, + color: str = DEFAULT_COLOR, + pango: bool = PANGO_MARKUP, +): + if pango: + print(f"{long_text}") + print(f"{short_text}") + else: + print(long_text) + print(short_text) + print(color) + + +def my_public_ip_block(): + ip_getters: Dict[str, List[str]] = { + "curl": ["-s", "-L"], + "wget": ["-q", "-O", "-"], + } + my_public_ip: subprocess.CompletedProcess = None + + for getter, getter_options in ip_getters.items(): + try: + args = [getter] + getter_options + [PUBLIC_IP_PROVIDER] + my_public_ip = subprocess.run( + args, + universal_newlines=True, + check=False, + capture_output=True, + ) + break + except FileNotFoundError: + continue + + if not my_public_ip: + print_format(long_text="Need curl or wget", short_text="") + return 33 + + my_public_ip = my_public_ip.stdout.strip() + if my_public_ip: + if CONFIG.get("BLOCK_BUTTON") == "2": + for selection in ["clipboard", "primary"]: + with subprocess.Popen( + ["xclip", "-selection", selection], + stdin=subprocess.PIPE, + close_fds=True, + ) as p: + p.communicate(input=my_public_ip.encode("utf_8")) + print_format(long_text=f" {my_public_ip}", short_text=" ") + return 0 + + +if __name__ == "__main__": + sys.exit(my_public_ip_block()) diff --git a/my-public-ip/my-public-ip-long.png b/my-public-ip/my-public-ip-long.png new file mode 100644 index 0000000000000000000000000000000000000000..5beb805e3f75a982dedc5f3d13ce1e65fbfbd5bc GIT binary patch literal 1392 zcmV-$1&{iPP)EX>4Tx04R}tkv&MmP!xqvQ?()$hgJ}A$WWc^q9Tr3g(6f4wL+^7CNKSiCJjl7 zi=*ILaPVib>fqw6tAnc`2>yULJ2)x2NQw6)g%&Yhc)XAE?m4`7A0RX;OtZRX0Zq5f zbTT1kbE{(L6+IY41ObF(W*Kvml!9-4-BTacU7Tn6_x)M@YTjZ%KqQ`JhG`RT5KnK~ z2Iqa^C@aY-@j3ChNf#u3)BVfh)c3uQq_0Ptxmc zEp`M9Yy%h9ZB5w&E_Z;TCqp)6R|?V+3I*W(jJ_!cL~en;HE(XMbDTZ^8Jbn<1~@nb z#)_1^?(^>6&bj^D)0*E8B?WSaoHsDn00006VoOIv0RI600RN!9r;`8x010qNS#tmY zE+YT{E+YYWr9XB6000McNliru=mr%NA^>NWI!gcm18qq}K~z}7?U-L^Q&$|vKS`4& zskw#xk(y6VcopqVDH z{F)GoTgmIShT>L4s4gUoMMhyOwTaWWPm54pNa|&Ej73J_E_Vw+n5|~fJ<=_<*Ke2l zTx$YEs4gVbq$=X+ctKusO*tQfViVcfEL&^05^f0-ZVBTFdMK|dr{kLr);ZQ`&bvEu zmj^Qs3ieveXXd#+aGm9)WftZZn7K8B!{d;88Ouw{WPZ&2b=O_))U{h>sz6Uxy4k~w5GI@EjAg@I< z73ECk4CxzbM$V7q^;#Ty{}2PQ0Uj?rF37J*BQ2{aqjY`gng(tuv7nw;IrrW^n6ip80y_eE{Yo~!zL^by4UBy`R*+wHBYnceR}(D$wg^CAM*znQ4j%se zkgk1Q+@HR`W`P%(icpg(qhE}2?elASeIZ-ceg)Vn4(% z6`OE+opcX(bM>>Un!bHk`|29$iSJJQ&8bOMoc-mjsCc6yZ^Mu^Of6rvuSzs@HatBx z7!0C0(JUIe8lJmO=4EwUK9}%RdITVBicOpxIw|T}>!e;*=h@+V#i!XYWq#$zd8ZF0 zhB!5Gibr#gm>!=d(U#!e=so&B?q_OjN;@@c_qqr3iFy24TV0;ko yOI}U?gq3yvO$_=EFa3*D4_!wOT@PJn_52Bfj!4^WP)EX>4Tx04R}tkv&MmP!xqvQ?()$hgJ}A$WWc^q9Tr3g(6f4wL+^7CNKSiCJjl7 zi=*ILaPVib>fqw6tAnc`2>yULJ2)x2NQw6)g%&Yhc)XAE?m4`7A0RX;OtZRX0Zq5f zbTT1kbE{(L6+IY41ObF(W*Kvml!9-4-BTacU7Tn6_x)M@YTjZ%KqQ`JhG`RT5KnK~ z2Iqa^C@aY-@j3ChNf#u3)BVfh)c3uQq_0Ptxmc zEp`M9Yy%h9ZB5w&E_Z;TCqp)6R|?V+3I*W(jJ_!cL~en;HE(XMbDTZ^8Jbn<1~@nb z#)_1^?(^>6&bj^D)0*E8B?WSaoHsDn00006VoOIv0RI600RN!9r;`8x010qNS#tmY zE+YT{E+YYWr9XB6000McNliru=mr%NAO$7LtVRF;0TD?=K~y-)V`N}p_|HHkz{EgB zFhUGt!6v9`p~?_c6~w^7%fayA!UKkdg$o%By$l)dp1#ZQ>GdbP2L4CK)jO;I3rP#1 zh!w3a`rmV@=RdD7?|*E17#JA-V|5t|8wZ^A%eRUm_bhXIP1qM;%~%}$7c-#>q+JOad(#TocS`ABow*)3-o ze*gH*z`(%3pkk)NASfls@b&#yhGv&$hL`tV5*GpW`|B~pidGl>U+`hUe`Ql;oDsmx zz`)Rek@%RI7&7N%GFV4iGsx-4F