New script s-write-comment for Fatdog64-720

README.md

@@ -27,6 +27,7 @@ Scripts in this page:
 * [gmenu2-fdcp](./README.md#gmenu2-fdcp)
 * [quicklaunch](./README.md#quicklaunch)
 * [roxmm](./README.md#roxmm)
+* [s-write-comment](./README.md#s-write-comment)
 * [tray-radio](./README.md#tray-radio)
 
 ----
@@ -322,6 +323,43 @@ and Tools menu.
 
 ----
 
+<a href="s-write-comment"></a>
+## s-write-comment
+
+File comment writer for Fatdog64 ROX-Filer build
+
+**Target User**
+
+* Fatdog64 72x+ users. This script works best in conjuction with the Fatdog64
+  ROX-Filer build.
+* Users of version of Puppy Linux that feature the "comments" patch for
+  ROX-Filer.
+* Anyone who wants to keep a comment file alongside another file, i.e.
+  `filename.ext.txt` holding comments about `filename.ext`.
+
+**Features**
+
+* Right-click ROX-Filer action "Add Comment File".
+* Command-line options to customize actions and manage comment files.
+
+**Installing**
+
+* Download and unpack the repository snapshot
+  [tar file](https://github.com/step-/scripts-to-go/archive/master.tar.gz).
+* Copy the files rooted in `s-write-comments` to equivalent positions under
+  `/`.
+* Reboot to enable the ROX-Filer right-click action.
+
+**Help** - In a terminal window run `s-write-comment.sh --help`.
+
+**Screenshot**
+
+![Screenshot](img/s-write-comment.png)
+
+Screenshot of version 1.0.0.
+
+----
+
 <a href="tray-radio"></a>
 ## tray-radio
 

s-write-comment/etc/xdg/rox.sourceforge.net/SendTo/Add Comment File

@@ -0,0 +1,20 @@
+[Desktop Entry]
+Name=Edit Comment File
+GenericName=Text Editor
+GenericName[de]=Texteditor
+Comment=Add comment with defaulttexteditor
+# A. Specify editor directly:
+#Exec=sh -c 's-gvim ---s COMMENT "$1.txt"' dummy %F
+# B. Or override default editor setting (defaulttexteditor):
+#Exec=sh -c 'COMMENT_EDITOR='s-gvim ---s COMMENT' "$1.txt"' dummy %F
+# C. Or use exported editor setting in .profile file:
+#   export COMMENT_EDITOR='s-gvim ---s COMMENT'
+Exec=s-write-comment.sh %F
+Terminal=false
+Type=Application
+;Icon=posted
+Icon=posted.png
+#Categories=Utility;TextEditor;
+Categories=SendTo;
+StartupNotify=true
+MimeType=text/plain;

s-write-comment/usr/local/bin/s-write-comment.sh

@@ -0,0 +1,235 @@
+#!/bin/dash
+
+# Create/edit comment files for $@.
+# Author: step
+# Copyright (c)2016-2017 step
+# License: GNU GPLv3
+Version=1.0
+
+# {da,a}sh compatible
+# Allow comment file path/name selection (requires yad >= 0.36.2).
+# Append FILE's extended attributes to comment file.
+# Link ROX-Filer .$1.comment file, see
+#  rox-filer-2013.6-comment.patch - Fatdog64-710
+#  rox-tip-from-comment-file.patch - Fatdog-720
+
+usage() # {{{1
+{
+  local P="${0##*/}"
+  printf "$(gettext 'Create/edit/delete comment files for FILEs.
+TL;DR
+  %s --no-symlink FILE
+  env COMMENT_OPTIONS="--no-symlink" %s FILE
+Usage:
+  %s [Options] FILE [FILE...]
+Options:
+  -h, --help      Show this message and exit.
+  --text-ext=EXT  Comment file name extension. Default "txt".[1]
+  --no-dialog     Do not show a file open dialog.[2]
+  --no-symlink    Do not create symlink .FILE.comment => FILE.EXT.[2][3]
+  --no-xattr      Do not append extended attributes.[2]
+  --rm            Delete comment file for FILE, i.e. rm FILE.txt.
+  --rm-dry-run    Just print the list of files that would be removed.
+  --rm-no-prompt  Do not prompt to confirm --rm action.
+  --              Stop processing options.
+Environment Variables:    (=default)
+  COMMENT_EDITOR=defaulttexteditor
+  COMMENT_OPTIONS=""      Command-line Options override this variable.
+Notes:
+[1] EXT "ROX" creates _regular_ file ".FILE.comment" and implies --no-symlink.
+[2] You can disable a previous --no-<something> option with --<something>, i.e.,
+    "--symlink" disables a "--no-symlink" in $COMMENT_OPTIONS.
+[3] ROX-Filer reads a tooltip for "FILE" from ".FILE.comment" (rox version
+    jun7-2016.12) and also from "FILE.txt" (jun7-2017.11).
+    Link ".FILE.comment" is co-located with "FILE"; "FILE.EXT" may not be.
+Examples:
+  %s --no-symlink FILE
+    Fatdog64-720: writes FILE.txt, which rox displays as tooltip for FILE.
+    Fatdog64-710: omit --no-symlink for tooltip [2].
+  %s --text-ext=note FILE
+    Fatdog64-710 & 720: writes FILE.note and symlink .FILE.comment, which
+    rox displays as a tooltip for FILE.
+  %s --text-ext=note --no-symlink FILE
+    Fatdog64-710 & 720: writes FILE.note only, no rox tooltip.
+  env COMMENT_OPTIONS="--no-xattr --text-ext=note" %s FILE
+    Alternative way to specify options; most useful in your shell profile.
+\n')" "$P" "$P" "$P" "$P" "$P" "$P" "$P"
+}
+
+set_OPTIONS() # In: "$@" Out: $OPTIONS, $SHIFT, $opt_* {{{1
+{
+  unset OPTIONS
+  SHIFT=$#
+  unset opt_no_dialog opt_no_symlink opt_no_xattr opt_text_ext opt_rm
+  while [ "${1#-}" != "$1" ]; do
+    OPTIONS="$OPTIONS $1"
+    case $1 in
+      --) shift; break ;;
+      --help|-h) usage >&2; exit ;;
+      --help=all-gui) usage --help-all | yad \
+        --width=700 --height=600 --center --text-info --title "$APPTITLE - $(gettext "Help")" &
+          exit ;;
+      --no-dialog) opt_no_dialog=1; shift ;;
+         --dialog) unset opt_no_dialog; shift ;;
+      --no-symlink) opt_no_symlink=1; shift ;;
+         --symlink) unset opt_no_symlink; shift ;;
+      --no-xattr) opt_no_xattr=1; shift ;;
+         --xattr) unset opt_no_xattr; shift ;;
+      --rm) opt_rm=prompt; shift ;;
+      --rm-dry-run) opt_rm=dry-run; shift ;;
+      --rm-no-prompt) opt_rm=no-prompt; shift ;;
+      # --rm-prompt-term) opt_rm=prompt-term; shift ;;
+      --text-ext=*) opt_text_ext="${1#*=}"; shift ;;
+      -*) { usage; gettext 'Bad option:'; echo " $1"; } >&2; exit 1;;
+      *) break ;;
+    esac
+  done
+  SHIFT=$(($SHIFT -$#))
+}
+
+dialog_file_open() # $1-comment-filepathname {{{1 In: $opt_no_symlink $FILE
+{
+  local p="$1" caption
+  [ -z "$opt_no_symlink" ] &&
+    caption="$(printf "$(gettext \
+    "<i>Will also create link <tt>%s => .../%s</tt>.\nRead Help to disable.</i>")" \
+      ".${FILE##*/}.comment" "${p##*/}")\n"
+  yad --file --save --filename="$p" --text="$caption" \
+    --button=gtk-ok:0 --button=gtk-cancel:1 --button="gtk-help:$0 --help=all-gui"
+  local exit_val=$? # 0|1|252
+  [ 0 != $exit_val ] && echo "$p"
+  echo $exit_val
+  return $exit_val
+}
+
+# i18n {{{1
+export TEXTDOMAIN=fatdog
+export OUTPUT_CHARSET=UTF-8
+
+# Constants. {{{1
+APPTITLE=$(gettext "Write Comment")
+WINDOW_ICON=~/.local/share/icons/posted.png
+YAD_OPTIONS="--title '$APPTITLE' --window-icon='$WINDOW_ICON' --center --borders=4 --buttons-layout=center"
+export YAD_OPTIONS
+
+# Environment variables. {{{1
+COMMENT_EDITOR=${COMMENT_EDITOR:-defaulttexteditor}
+
+# Parse options. {{{1
+[ "$COMMENT_OPTIONS" ] && set_OPTIONS $COMMENT_OPTIONS
+shift0=${SHIFT:-0}
+set_OPTIONS $OPTIONS "$@"
+shift $(($SHIFT -$shift0))
+if [ 0 = $# ]; then usage >&2; exit 1; fi
+
+# Default values. {{{1
+opt_text_ext="${opt_text_ext:-txt}" # FILE.txt
+opt_text_ext="${opt_text_ext#.}"
+
+# Install traps and create temporary folder. {{{1
+#trap 'rm -rf "${TMPD:-/tmp/dummy}"*' HUP INT QUIT TERM ABRT 0
+trap 'case "${TMPD}" in ""|/|.|..""|./*|../*) false;; esac && rm -rf "${TMPD}"*' HUP INT QUIT TERM ABRT 0
+TMPD=$(mktemp -d -p "${TMPDIR:-/tmp}" ${0##*/}_XXXXXX) # mktemp's default mode = 700
+DATF="${TMPD}/.dat"; >"${DATF}" # list original and comment files
+CFTF="${TMPD}/.cft"; >"${CFTF}" # list comment files
+
+if [ -z "$opt_rm" ]; then # {{{1}}} Write comment file(s).
+  # Press [Cancel] to exit the script.
+  # Press [Esc] to accept the current default file name and go to the next FILE.
+  for FILE; do
+    # Prompt to select comment file path/name. {{{1
+    # Make full pathname, which saves some mouse clicks in yad.
+    case $FILE in /*) f=$FILE ;; *) f="`pwd`/$FILE" ;; esac
+    cf="$f.$opt_text_ext" exit_val=0
+    if [ ROX = $opt_text_ext ]; then
+      cf="${f%/*}/.${f##*/}.comment" opt_no_dialog=1
+    fi
+    # Allow renaming text comment file.
+    if [ -z "$opt_no_dialog" ]; then
+      { read cf; read exit_val; } << EOF
+$(dialog_file_open "$cf")
+EOF
+    fi
+    : "cf($cf)"
+    : "exit_val($exit_val)"
+    case $exit_val in
+      1 ) # 1=Cancel
+        exit
+        ;;
+      0|252) # 0=OK 252=Esc
+        # Queue FILE and comment file full pathnames.
+        printf "%s\n%s\n" "$f" "$cf" >> "$DATF"
+        ;;
+    esac
+  done # {{{1}}}
+  xargs -0 -L 1 < "$DATF"
+  while read f; do
+    read cf &&
+    # Create/edit comment file. {{{1
+    # Link ROX-Filer comment file to txt file. {{{2
+    if [ -z "$opt_no_symlink" ] && [ ROX != $opt_text_ext ]; then
+      # Relative link iff comment file co-resides with FILE.
+      [ "${cf%/*}" = "${f%/*}" ] && tf=${cf##*/} || tf=$cf
+      ln -sfT "$tf" "${f%/*}/.${f##*/}.comment"
+    fi
+
+    # APPEND optional content items. {{{2
+    # Extended attributes.
+    if [ -z "$opt_no_xattr" -a -e "$f" ]
+    then
+      # I would like to use `getfattr -d -m - -e text` but it doesn't decode UTF8 characters properly.
+      #getfattr -d -m - -e text "$f" >> "$cf"
+      # Work-around: use `-e hex` but it doesn't look good for a comment file.
+      # So I use `attr`.
+      attr -ql "$f" | xargs --no-run-if-empty -I{} attr -g {} "$f" >> "$cf"
+    fi
+
+    # Queue2 comment file fullpath. {{{2
+    printf "%s\000" "$cf" >> "$CFTF"
+  done  < "$DATF" # {{{1}}}
+  # Edit comment text in default/preferred program. {{{1
+  # All files in a single editor call. For multiple calls with a single
+  # file add -L 1 to xargs.
+  # Don't quote $COMMENT_EDITOR so the user can specify options.
+  xargs --no-run-if-empty -0 $COMMENT_EDITOR < "$CFTF"
+
+else # {{{1}}} Remove comment file(s).
+  # Press [OK] to remove comment and link (if any) files.
+  # [Cancel] and [Esc] don't remove.
+  for FILE; do
+    # Determine rm target(s) cf and lf. {{{1
+    case $FILE in /*) f=$FILE ;; *) f="`pwd`/$FILE" ;; esac
+    cf= lf="${f%/*}/.${f##*/}.comment" # regular file or link
+    if [ -L "$lf" ]; then
+      cf="$(readlink -f "$lf")"
+    elif [ -f "$lf" ]; then
+      cf="$lf" lf=
+    elif [ -e "$f.$opt_text_ext" ]; then
+      cf="$f.$opt_text_ext" lf=
+    fi
+    # Queue link file and comment file full pathnames. {{{1
+    # -L -o -f ensures detection of dangling links.
+    [ -L "$lf" -o -f "$lf" ] && printf "%s\000" "$lf" >> "$DATF"
+    [ -e "$cf" ] && printf "%s\000" "$cf" >> "$DATF"
+  done # {{{1}}}
+  # Remove files. {{{1
+  case $opt_rm in
+    dry-run ) tr '\0' '\n' < "$DATF"
+      ;;
+    # prompt-term ) # Simple with term ui - NOT-USED
+    #   defaultterm -e xargs --no-run-if-empty -0 --arg-file "$DATF" rm -i
+    #   ;;
+    prompt ) # Fancier with yad gui
+      awk 'BEGIN{RS="\x00"} {print "true\n"$0}' "$DATF" |
+      yad --list \
+        --column="$(gettext rm)":CHK --column="$(gettext File)" --tooltip-column=2 \
+        --print-all --ellipsize=START |
+      awk 'BEGIN{ORS="\x00"} /^TRUE/{print substr($0, 6, length($0)-6)}' |
+      xargs --no-run-if-empty -0 rm
+      ;;
+    no-prompt )
+      xargs --no-run-if-empty -0 --arg-file "$DATF" rm
+      ;;
+  esac
+
+fi # {{{1}}}

s-write-comment/usr/share/applications/write-comment.desktop

@@ -0,0 +1,20 @@
+[Desktop Entry]
+Name=Edit Comment File
+GenericName=Text Editor
+GenericName[de]=Texteditor
+Comment=Add comment with defaulttexteditor
+# A. Specify editor directly:
+#Exec=sh -c 's-gvim ---s COMMENT "$1.txt"' dummy %F
+# B. Or override default editor setting (defaulttexteditor):
+#Exec=sh -c 'COMMENT_EDITOR='s-gvim ---s COMMENT' "$1.txt"' dummy %F
+# C. Or use exported editor setting in .profile file:
+#   export COMMENT_EDITOR='s-gvim ---s COMMENT'
+Exec=s-write-comment.sh %F
+Terminal=false
+Type=Application
+;Icon=posted
+Icon=posted.png
+#Categories=Utility;TextEditor;
+Categories=SendTo;
+StartupNotify=true
+MimeType=text/plain;