From a55e36eb071e1a4ef46b64e534e757e638382a02 Mon Sep 17 00:00:00 2001 From: Ethanfel Date: Tue, 23 Jun 2026 11:17:09 +0200 Subject: [PATCH] ComfyPeeper Companion v1.0.0 ComfyUI extension that bridges with the ComfyPeeper Discord plugin: - GET /comfypeeper/info advertises a friendly name + capabilities - POST /comfypeeper/load loads a workflow into the open editor tab - POST /comfypeeper/send uploads an output image to a Discord webhook - right-click "Send to Discord" on image nodes - "Send to Discord (ComfyPeeper)" node: auto-post every image (workflow embedded in the PNG) to the webhook Co-Authored-By: Claude Opus 4.8 --- .gitignore | 11 + LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 61 ++++ __init__.py | 201 +++++++++++++ config.example.json | 4 + pyproject.toml | 14 + web/comfypeeper.js | 72 +++++ 7 files changed, 1037 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 __init__.py create mode 100644 config.example.json create mode 100644 pyproject.toml create mode 100644 web/comfypeeper.js diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..39f8829 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +# local config (holds the Discord webhook secret) +config.json + +# python bytecode +__pycache__/ +*.pyc + +# editor / OS +.DS_Store +.vscode/ +.idea/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..00bd724 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# ComfyPeeper Companion (ComfyUI extension) + +A small ComfyUI extension that pairs with the **[ComfyPeeper](https://github.com/ethanfel/Discord-ComfyPeeper)** +Discord plugin to enable two things plain ComfyUI's API can't: + +- **Send to ComfyUI** โ€” ComfyPeeper can load a workflow straight into your **open ComfyUI + editor tab** (not just queue it headless). +- **Send to Discord** โ€” get an output image into a Discord channel, either by **right-click โ†’ + ๐Ÿ“ค Send to Discord**, or by wiring the **Send to Discord (ComfyPeeper)** node into your graph + so every generation is posted automatically. Both go to a Discord **webhook** you configure; + the image carries its workflow in its PNG metadata, so ComfyPeeper detects it on the Discord side. + +It also advertises a **friendly name** so ComfyPeeper can label the server and only show the +companion buttons where the companion is actually installed. + +## Install + +```bash +cd /custom_nodes +git clone https://github.com/Ethanfel/ComfyUI-ComfyPeeper-compagnon +cd ComfyUI-ComfyPeeper-compagnon +cp config.example.json config.json +# edit config.json: set "name", and "discord_webhook" if you want Send to Discord +# restart ComfyUI +``` + +Verify: `curl http://127.0.0.1:8188/comfypeeper/info` โ†’ `{"app":"ComfyPeeper","name":"โ€ฆ",โ€ฆ}`. + +## config.json + +| key | meaning | +|-----|---------| +| `name` | Friendly name shown by ComfyPeeper (e.g. `"4090 rig"`). | +| `discord_webhook` | A Discord channel **webhook URL** (Channel โ†’ Edit โ†’ Integrations โ†’ Webhooks). Leave empty to disable **Send to Discord**. | + +## Nodes + +| node | what it does | +|------|--------------| +| **Send to Discord (ComfyPeeper)** (`ComfyPeeper` category) | Output node โ€” wire your images into it and every run posts them to the webhook, with the workflow embedded in the PNG. Optional `message` and `filename_prefix`. Previews what it sent. | + +## Routes + +| method ยท path | purpose | +|---------------|---------| +| `GET /comfypeeper/info` | `{ name, version, caps }` โ€” `caps` includes `"send"` only when a webhook is set. | +| `POST /comfypeeper/load` | `{ workflow }` โ†’ pushed to open tabs; the frontend loads it. | +| `POST /comfypeeper/send` | `{ filename, subfolder, type }` โ†’ uploads that output image to the webhook. | + +## Notes + +- **Send to ComfyUI** needs a ComfyUI **tab open** to receive the workflow, and the editor + (`workflow`) graph โ€” which ComfyPeeper has for most posts. +- The webhook URL stays **only** in this `config.json` on your ComfyUI host โ€” it's never sent + to or stored by the Discord plugin. (`config.json` is git-ignored.) +- The routes are unauthenticated, same trust model as the rest of the ComfyUI server โ€” run the + companion only on instances you control / trust. + +## License + +[GPL-3.0-or-later](LICENSE) โ€” same as ComfyPeeper. Not affiliated with Discord, Vencord, or ComfyUI. diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..ce262e6 --- /dev/null +++ b/__init__.py @@ -0,0 +1,201 @@ +""" +ComfyPeeper Companion โ€” bridges ComfyUI with the ComfyPeeper Discord plugin. + +Drop this folder into ComfyUI/custom_nodes/ (as `comfypeeper`) and restart ComfyUI. +It adds three routes on the ComfyUI server: + + GET /comfypeeper/info advertise a friendly name + capabilities (so the plugin can + label this server and light up companion features) + POST /comfypeeper/load { workflow } -> push the workflow to open editor tabs, which + the bundled frontend extension loads via app.loadGraphData() + POST /comfypeeper/send { filename, subfolder, type } -> upload that output image to + the configured Discord webhook (the image carries its workflow + in PNG metadata, so ComfyPeeper detects it on the Discord side) + +Configure by copying config.example.json -> config.json and setting `name` (and +`discord_webhook` if you want "Send to Discord"). +""" + +import asyncio +import io +import json +import os + +import aiohttp +from aiohttp import web + +import folder_paths +from server import PromptServer + +VERSION = "1.0.0" +_DIR = os.path.dirname(os.path.realpath(__file__)) +_CONFIG_PATH = os.path.join(_DIR, "config.json") + + +def _config(): + try: + with open(_CONFIG_PATH, "r", encoding="utf-8") as f: + cfg = json.load(f) + except Exception: + cfg = {} + return { + "name": (cfg.get("name") or "ComfyUI").strip(), + "discord_webhook": (cfg.get("discord_webhook") or "").strip(), + } + + +def _resolve_image_path(filename, subfolder, type_): + """Resolve a /view-style image ref to a file path, clamped inside the type's base dir.""" + if not filename: + return None + base = folder_paths.get_directory_by_type(type_ or "output") + if not base: + return None + base = os.path.abspath(base) + target = os.path.abspath(os.path.join(base, subfolder or "", filename)) + # block path traversal outside the base directory + if os.path.commonpath([base, target]) != base: + return None + return target if os.path.isfile(target) else None + + +async def _upload_to_webhook(webhook, filename, data, content=""): + """POST image bytes to a Discord webhook as multipart/form-data. Returns (ok, status, body).""" + form = aiohttp.FormData() + form.add_field("payload_json", json.dumps({"content": content})) + form.add_field("files[0]", data, filename=filename, content_type="application/octet-stream") + async with aiohttp.ClientSession() as session: + async with session.post(webhook, data=form) as resp: + return resp.status in (200, 204), resp.status, (await resp.text())[:300] + + +routes = PromptServer.instance.routes + + +@routes.get("/comfypeeper/info") +async def comfypeeper_info(_request): + cfg = _config() + caps = ["load"] + if cfg["discord_webhook"]: + caps.append("send") + return web.json_response({"app": "ComfyPeeper", "name": cfg["name"], "version": VERSION, "caps": caps}) + + +@routes.post("/comfypeeper/load") +async def comfypeeper_load(request): + try: + data = await request.json() + except Exception: + return web.json_response({"ok": False, "error": "invalid json"}, status=400) + workflow = data.get("workflow") + if workflow is None: + return web.json_response({"ok": False, "error": "no workflow"}, status=400) + # broadcast to every connected tab; the frontend extension calls app.loadGraphData() + PromptServer.instance.send_sync("comfypeeper.load", {"workflow": workflow}) + return web.json_response({"ok": True}) + + +@routes.post("/comfypeeper/send") +async def comfypeeper_send(request): + webhook = _config()["discord_webhook"] + if not webhook: + return web.json_response({"ok": False, "error": "no webhook configured"}, status=400) + try: + data = await request.json() + except Exception: + return web.json_response({"ok": False, "error": "invalid json"}, status=400) + + path = _resolve_image_path(data.get("filename"), data.get("subfolder", ""), data.get("type", "output")) + if not path: + return web.json_response({"ok": False, "error": "image not found"}, status=404) + + try: + with open(path, "rb") as f: + file_bytes = f.read() + except Exception as e: + return web.json_response({"ok": False, "error": str(e)}, status=500) + + try: + ok, status, body = await _upload_to_webhook(webhook, os.path.basename(path), file_bytes, (data.get("content") or "").strip()) + return web.json_response({"ok": ok, "status": status, "data": body}) + except Exception as e: + return web.json_response({"ok": False, "error": str(e)}, status=500) + + +class SendToDiscord: + """Output node: send each incoming image (with workflow metadata) to the Discord webhook.""" + + @classmethod + def INPUT_TYPES(cls): + return { + "required": {"images": ("IMAGE",)}, + "optional": { + "message": ("STRING", {"default": "", "multiline": True}), + "filename_prefix": ("STRING", {"default": "ComfyPeeper"}), + }, + "hidden": {"prompt": "PROMPT", "extra_pnginfo": "EXTRA_PNGINFO"}, + } + + RETURN_TYPES = () + FUNCTION = "send" + OUTPUT_NODE = True + CATEGORY = "ComfyPeeper" + + def send(self, images, message="", filename_prefix="ComfyPeeper", prompt=None, extra_pnginfo=None): + webhook = _config()["discord_webhook"] + if not webhook: + print("[ComfyPeeper] SendToDiscord: no discord_webhook in config.json โ€” skipping") + return {"ui": {"images": []}} + + import numpy as np # lazy: keep the routes working even if image libs are unusual + from PIL import Image + from PIL.PngImagePlugin import PngInfo + + temp_dir = folder_paths.get_temp_directory() + os.makedirs(temp_dir, exist_ok=True) + ui_images = [] + for i, image in enumerate(images): + arr = np.clip(255.0 * image.cpu().numpy(), 0, 255).astype(np.uint8) + img = Image.fromarray(arr) + # embed workflow + prompt into the PNG, same as ComfyUI's SaveImage, so ComfyPeeper detects it + meta = PngInfo() + try: + if prompt is not None: + meta.add_text("prompt", json.dumps(prompt)) + for k, v in (extra_pnginfo or {}).items(): + meta.add_text(k, json.dumps(v)) + except Exception as e: + print(f"[ComfyPeeper] SendToDiscord: metadata embed failed: {e}") + buf = io.BytesIO() + img.save(buf, format="PNG", pnginfo=meta, compress_level=4) + data = buf.getvalue() + + # run the upload on the server's event loop (this node runs in a worker thread) + try: + fut = asyncio.run_coroutine_threadsafe( + _upload_to_webhook(webhook, f"{filename_prefix}_{i:03d}.png", data, (message or "").strip()), + PromptServer.instance.loop, + ) + ok, status, _ = fut.result(timeout=60) + if not ok: + print(f"[ComfyPeeper] SendToDiscord: webhook returned {status}") + except Exception as e: + print(f"[ComfyPeeper] SendToDiscord: send failed: {e}") + + # drop a temp copy so the node previews what it sent + try: + tmp_name = f"comfypeeper_{i:03d}.png" + with open(os.path.join(temp_dir, tmp_name), "wb") as f: + f.write(data) + ui_images.append({"filename": tmp_name, "subfolder": "", "type": "temp"}) + except Exception: + pass + return {"ui": {"images": ui_images}} + + +WEB_DIRECTORY = "./web" +NODE_CLASS_MAPPINGS = {"ComfyPeeperSendToDiscord": SendToDiscord} +NODE_DISPLAY_NAME_MAPPINGS = {"ComfyPeeperSendToDiscord": "Send to Discord (ComfyPeeper)"} +__all__ = ["NODE_CLASS_MAPPINGS", "NODE_DISPLAY_NAME_MAPPINGS", "WEB_DIRECTORY"] + +print(f"[ComfyPeeper] companion loaded (v{VERSION}) โ€” name: {_config()['name']!r}") diff --git a/config.example.json b/config.example.json new file mode 100644 index 0000000..11779ea --- /dev/null +++ b/config.example.json @@ -0,0 +1,4 @@ +{ + "name": "My GPU rig", + "discord_webhook": "" +} diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..884a0d6 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,14 @@ +[project] +name = "comfyui-comfypeeper-companion" +description = "Bridge ComfyUI with the ComfyPeeper Discord plugin: load workflows into the open tab, and send output images (with embedded workflow) to a Discord webhook." +version = "1.0.0" +license = { text = "GPL-3.0-or-later" } +dependencies = [] + +[project.urls] +Repository = "https://github.com/Ethanfel/ComfyUI-ComfyPeeper-compagnon" + +[tool.comfy] +PublisherId = "ethanfel" +DisplayName = "ComfyPeeper Companion" +Icon = "" diff --git a/web/comfypeeper.js b/web/comfypeeper.js new file mode 100644 index 0000000..0564246 --- /dev/null +++ b/web/comfypeeper.js @@ -0,0 +1,72 @@ +import { app } from "../../scripts/app.js"; + +/* + * ComfyPeeper companion โ€” frontend extension. + * - listens for "comfypeeper.load" (pushed by POST /comfypeeper/load) and loads the + * workflow into this open tab via app.loadGraphData() + * - adds a "Send to Discord" right-click item to image-output nodes, which POSTs the + * image ref to /comfypeeper/send (the server uploads it to the configured webhook) + */ + +function toast(severity, detail) { + try { app.extensionManager?.toast?.add?.({ severity, summary: "ComfyPeeper", detail, life: 4000 }); } + catch { /* older ComfyUI: no toast API */ } + if (severity === "error") console.error("[ComfyPeeper]", detail); +} + +/** Parse a ComfyUI image element src (/view?filename=..&subfolder=..&type=..) into a ref. */ +function imgRef(src) { + try { + const u = new URL(src, window.location.origin); + const filename = u.searchParams.get("filename"); + if (!filename) return null; + return { filename, subfolder: u.searchParams.get("subfolder") || "", type: u.searchParams.get("type") || "output" }; + } catch { return null; } +} + +async function sendToDiscord(node) { + const imgs = node?.imgs || []; + const src = imgs[node.imageIndex ?? 0]?.src || imgs[0]?.src; + const ref = src && imgRef(src); + if (!ref) { toast("error", "No image on this node to send"); return; } + try { + const r = await app.api.fetchApi("/comfypeeper/send", { + method: "POST", + headers: { "Content-Type": "application/json" }, + body: JSON.stringify(ref) + }); + const j = await r.json().catch(() => ({})); + if (j?.ok) toast("success", "Sent to Discord"); + else toast("error", "Send failed: " + (j?.error || ("HTTP " + r.status))); + } catch (err) { + toast("error", "Send failed: " + err); + } +} + +app.registerExtension({ + name: "comfypeeper.companion", + + async setup() { + app.api.addEventListener("comfypeeper.load", async e => { + const wf = e?.detail?.workflow; + if (!wf) return; + try { + await app.loadGraphData(typeof wf === "string" ? JSON.parse(wf) : wf); + toast("success", "Workflow loaded from Discord"); + } catch (err) { + toast("error", "Couldn't load that workflow"); + } + }); + }, + + // add "Send to Discord" to image-bearing nodes. getExtraMenuOptions is the most broadly + // compatible hook today (newer ComfyUI shows a deprecation notice but still honours it). + async beforeRegisterNodeDef(nodeType, nodeData) { + if (!["SaveImage", "PreviewImage"].includes(nodeData?.name)) return; + const orig = nodeType.prototype.getExtraMenuOptions; + nodeType.prototype.getExtraMenuOptions = function (canvas, options) { + orig?.apply(this, arguments); + if ((this.imgs || []).length) options.push({ content: "๐Ÿ“ค Send to Discord", callback: () => sendToDiscord(this) }); + }; + } +});