Implement handling of icon names on Linux

kittens/notify/main.go

@@ -26,6 +26,11 @@ func b64encode(x string) string {
 	return base64.RawStdEncoding.EncodeToString(utils.UnsafeStringToBytes(x))
 }
 
+func check_id_valid(x string) bool {
+	pat := utils.MustCompile(`[^a-zA-Z0-9_+.-]`)
+	return pat.ReplaceAllString(x, "") == x
+}
+
 func create_metadata(opts *Options, wait_till_closed bool, expire_time time.Duration) string {
 	ans := []string{}
 	if opts.AppName != "" {
@@ -46,6 +51,12 @@ func create_metadata(opts *Options, wait_till_closed bool, expire_time time.Dura
 	if wait_till_closed {
 		ans = append(ans, "c=1:a=report")
 	}
+	for _, x := range opts.Icon {
+		ans = append(ans, "n="+b64encode(x))
+	}
+	if opts.IconCacheId != "" {
+		ans = append(ans, "g="+opts.IconCacheId)
+	}
 	m := strings.Join(ans, ":")
 	if m != "" {
 		m = ":" + m
@@ -221,6 +232,15 @@ func main(_ *cli.Command, opts *Options, args []string) (rc int, err error) {
 			return 1, fmt.Errorf("Failed to generate a random identifier with error: %w", err)
 		}
 	}
+	bad_ident := func(which string) error {
+		return fmt.Errorf("Invalid identifier: %s must be only English letters, numbers, hyphens and underscores.", which)
+	}
+	if !check_id_valid(ident) {
+		return 1, bad_ident(ident)
+	}
+	if !check_id_valid(opts.IconCacheId) {
+		return 1, bad_ident(opts.IconCacheId)
+	}
 	var expire_time time.Duration
 	if expire_time, err = parse_duration(opts.ExpireTime); err != nil {
 		return 1, fmt.Errorf("Invalid expire time: %s with error: %w", opts.ExpireTime, err)

kittens/notify/main.py

@@ -3,7 +3,25 @@
 
 import sys
 
-OPTIONS = r'''
+
+def OPTIONS() -> str:
+    from kitty.constants import standard_icon_names
+    return  f'''
+--icon -i
+type=list
+The name of the icon to use for the notification. An icon with this name
+will be searched for on the computer running the terminal emulator. Can
+be specified multiple times, the first name that is found will be used.
+Standard names: {', '.join(sorted(standard_icon_names))}
+
+
+--icon-path -I
+Path to an image file in PNG/JPEG/WEBP/GIF formats to use as the icon. If both
+name and path are specified then first the name will be looked for and if not found
+then the path will be used. Other image formats are supported if ImageMagick is
+installed on the system.
+
+
 --app-name -a
 default=kitten-notify
 The application name for the notification.
@@ -31,7 +49,7 @@ The notification type. Can be any string, it is used by users to create filter r
 for notifications, so choose something descriptive of the notifications, purpose.
 
 
---identifier -i
+--identifier
 The identifier of this notification. If a notification with the same identifier
 is already displayed, it is replaced/updated.
 
@@ -54,7 +72,15 @@ type=bool-set
 Only print the escape code to STDOUT. Useful if using this kitten as part
 of a larger application. If this is specified, the --wait-till-closed option
 will be used for escape code generation, but no actual waiting will be done.
-'''.format
+
+
+--icon-cache-id -g
+Identifier to use when caching icons in the terminal emulator. Using an identifier means
+that icon data needs to be transmitted only once using --icon-path. Subsequent invocations
+will use the cached icon data, at least until the terminal instance is restarted. This is useful
+if this kitten is being used inside a larger application, with --only-print-escape-code.
+'''
+
 help_text = '''\
 Send notifications to the user that are displayed to them via the
 desktop environment's notifications service. Works over SSH as well.