Added readme instructions

This commit is contained in:
JohanK66
2025-02-28 20:21:40 +01:00
parent 0d65d4b69b
commit 78e69a3c2e
10 changed files with 212 additions and 2 deletions
Vendored
BIN
View File
Binary file not shown.
+3
View File
@@ -0,0 +1,3 @@
__pycache__/.DS_Store
assets/.DS_Store
.DS_Store
+15 -2
View File
@@ -1,2 +1,15 @@
# WebhookImage
# WebhookImage
# ComfyUI WebhookImage
This package provides a custom node to ComfyUI to send a message and image by means of a webhook
## WebhookImage
Send a webhook to the specified URL.
If you are using this on a local installation, the webhook could be generate by using ngrok https://ngrok.com/
<img src="assets/webhookimage_node.jpg" width="400"/>
## Further details
Will be added soon
+11
View File
@@ -0,0 +1,11 @@
from .nodes.webhook import WebhookImage
NODE_CLASS_MAPPINGS = {
"Notif-Webhook": WebhookImage,
}
NODE_DISPLAY_NAME_MAPPINGS = {
"Notif-Webhook": "WebhookImage",
}
WEB_DIRECTORY = "./web"
Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

+5
View File
@@ -0,0 +1,5 @@
# Hack: string type that is always equal in not equal comparisons
# Thanks to https://github.com/pythongosssss/ComfyUI-Custom-Scripts
class ComfyAnyType(str):
def __ne__(self, __value: object) -> bool:
return False
+120
View File
@@ -0,0 +1,120 @@
import requests
import json
import os
from PIL import Image
from PIL.PngImagePlugin import PngInfo
import numpy as np
from datetime import datetime
import folder_paths
class WebhookImage:
def __init__(self):
self.output_dir = folder_paths.get_output_directory()
self.type = 'output'
self.prefix_append = ''
@classmethod
def INPUT_TYPES(cls):
"""
Defines the input types for the node.
Returns:
dict: A dictionary specifying required and hidden inputs.
"""
return {
"required": {
'images': ('IMAGE', ),
"webhook_url": ("STRING", {'default': '<yourwebhook>'}),
"verify_ssl": ("BOOLEAN", {"default": True}),
"safe_prompt": (["enable", "disable"], {"default": "disable"}),
"notification_text": ('STRING', {'default': 'Your image is ready.'}),
"json_format": ('STRING', {'default': '{"text": "<notification_text>"}'}),
"send_notification": (["enable", "disable"], {"default": "disable"}),
"timeout": ('FLOAT', {'default': 3, 'min': 0, 'max': 60}),
'image_preview': (['disabled', 'enabled'], {'default': 'enabled'}),
},
"optional": {
"positive_text_opt": ("STRING", {"forceInput": True}),
"negative_text_opt": ("STRING", {"forceInput": True}),
},
"hidden": {"prompt": "PROMPT", "extra_pnginfo": "EXTRA_PNGINFO"},
}
FUNCTION = 'hookImage'
OUTPUT_NODE = True
RETURN_TYPES = tuple()
CATEGORY = "notifications"
@staticmethod
def sendTxtMessage( webhook_url, notification_text, json_format, timeout, verify_ssl ):
"""
handles sending text message to the webhook
Args:
notification_text (str):
"""
payload = json_format.replace("<notification_text>", notification_text)
payload = json.loads(payload)
res = requests.post( webhook_url, json=payload, timeout=timeout, verify=verify_ssl)
res.raise_for_status()
def hookImage(self, images, webhook_url, notification_text, json_format, timeout, verify_ssl, negative_text_opt=None, positive_text_opt=None, extra_pnginfo=None, prompt=None, safe_prompt="disable", image_preview="disable", send_notification="disable" ):
counter = 1
results = list()
for image in images:
i = 255. * image.cpu().numpy()
img = Image.fromarray(np.clip(i, 0, 255).astype(np.uint8))
metadata = PngInfo()
metadata.add_text("webhook_url", webhook_url )
metadata.add_text("notification_text", notification_text)
if prompt is not None:
if safe_prompt == 'enable':
metadata.add_text("prompt", json.dumps(prompt))
if positive_text_opt is not None:
metadata.add_text("positive_text_opt", json.dumps(positive_text_opt))
if negative_text_opt is not None:
metadata.add_text("negative_text_opt", json.dumps(negative_text_opt))
if extra_pnginfo is not None:
for x in extra_pnginfo:
metadata.add_text(x, json.dumps(extra_pnginfo[x]))
timestamp = datetime.now().strftime('%c')
file = f"telegram_notification_{counter:05}_{timestamp}.png"
image_path = os.path.join(self.output_dir, file)
img.save(image_path, format="PNG", pnginfo=metadata)
results.append({ 'filename': file, 'subfolder': '', 'type': self.type})
counter += 1
try:
with open(image_path, 'rb') as image_file:
files = {
'file': ('photo', image_file, 'image/png')
}
res = requests.post( webhook_url, files=files, timeout=timeout, verify=verify_ssl)
res.raise_for_status()
if res.status_code == 200:
print("Image posted successfully!")
else:
print(f"Failed to post image. Status code: {res.status_code}")
except OSError as e:
print(f'An error occurred while sending: {e}')
else:
if send_notification == 'enable':
WebhookImage.sendTxtMessage( webhook_url, notification_text, json_format, timeout, verify_ssl)
if image_preview == 'disabled':
results = list()
return { 'ui': { 'images': results } }
+1
View File
@@ -0,0 +1 @@
numpy
+52
View File
@@ -0,0 +1,52 @@
export const notificationSetup = () => {
if (!('Notification' in window)) {
console.log('This browser does not support notifications.')
alert('This browser does not support notifications.')
return
}
if (Notification.permission === 'denied') {
console.log('Notifications are blocked. Please enable them in your browser settings.')
alert('Notifications are blocked. Please enable them in your browser settings.')
return
}
if (Notification.permission !== 'granted') {
Notification.requestPermission()
}
return true
}
export const sendNotification = (title, body) => {
if (!notificationSetup()) return
const notification = new Notification(title, { body })
return notification
}
export const getNotificationTextFromArguments = (args) => {
return args[0]?.notification_text[0] ?? 'Your notification has triggered.'
}
export const playSound = (file, volume) => {
if (!file) {
file = 'notify.mp3'
}
if (!file.startsWith('http')) {
if (!file.includes('/')) {
file = 'assets/' + file
}
file = new URL(file, import.meta.url)
}
const url = new URL(file)
const audio = new Audio(url)
audio.volume = volume
audio.play()
}
export const appQueueIsEmpty = async (app) => {
if (app.ui.lastQueueSize !== 0) {
await new Promise((r) => setTimeout(r, 500))
}
if (app.ui.lastQueueSize !== 0) {
return false
}
return true
}
+5
View File
@@ -0,0 +1,5 @@
# Hack: string type that is always equal in not equal comparisons
# Thanks to https://github.com/pythongosssss/ComfyUI-Custom-Scripts
class ComfyAnyType(str):
def __ne__(self, __value: object) -> bool:
return False