utils/adesklets_frontend.sh.in

   1 #! /bin/sh
   2 # adesklets - Shell script frontend for the adesklets interpreter
   3 # ------------------------------------------------------------------------------
   4 # Copyright (C) 2005 Sylvain Fourmanoit <syfou@users.sourceforge.net>
   5 #
   6 # Permission is hereby granted, free of charge, to any person obtaining a copy
   7 # of this software and associated documentation files (the "Software"), to
   8 # deal in the Software without restriction, including without limitation the
   9 # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  10 # sell copies of the Software, and to permit persons to whom the Software is
  11 # furnished to do so, subject to the following conditions:
  12 #
  13 # The above copyright notice and this permission notice shall be included in
  14 # all copies of the Software and its documentation and acknowledgment shall be
  15 # given in the documentation and software packages that this Software was
  16 # used.
  17 #
  18 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  21 # THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  22 # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  23 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24 # ------------------------------------------------------------------------------
  25 # This is the shell script frontend for the adesklets interpreter, introduced
  26 # in adesklets 0.4.11. It serves a couple simple purposes:
  27 #
  28 # - Bring all the fake-root windows detection code out of the binary
  29 # interpreter, and detect them from a front-end. It makes it far simpler
  30 # and quicker to adapt to new situations, as this code is no longer written
  31 # in C, but in a sh-compatible scripting form. Hopefully, in this new format,
  32 # people will be able to contribute new detection routines for specific
  33 # Window Manager easily.
  34 #
  35 # - Print out a couple of warnings to hopefully prevent some people that
  36 # would not read the fourth chapter from the manual from not invoking
  37 # adesklets right.
  38 #
  39 # - Add a couple of functionalities, such as configuration file cleanup, and
  40 # desklets killing.
  41 #
  42 # PORTABILITY NOTICE:
  43 # ===================
  44 #
  45 # This shell script was made to comply with the POSIX 1003.2 and 1003.2a
  46 # specification for the shell, and not use any vendor-specific extension
  47 # for any program invoked. It has been tested on both BASH 3.00.16 and NetBSD
  48 # ash 1.6.1 on a variety of platforms. It also uses some low-level, fairly
  49 # common utilities or builtin, all also described in POSIX, namely:
  50 #
  51 # 1) a Streaming EDitor (sed). It as been tested on GNU sed 4.0.9, and FreeBSD
  52 #    4.9 sed
  53 # 2) test, conforming to POSIX 1003.2
  54 # 3) mkdir and rmdir
  55 # 4) sleep
  56 # 5) kill
  57 # 6) ls
  58 # 7) ps (only for the -w switch)
  59 #
  60 # The xprop and xwinfinfo programs can also be used, if a given fake-root
  61 # window detection routine is explicitely invoked. Both XFree86 and X.org
  62 # implementations of these utilities have been tested. Window Manager specific
  63 # detection will also potentially need WM specific programs:
  64 #
  65 # kde: need consolde dcop client
  66 #
  67 # ------------------------------------------------------------------------------
  68 # Lock/unlock function
  69 # Based on the fact that creating a directory is atomic
  70 #
  71 LOCKFILE=@LOCKFILES_DIR@/adesklets_frontend_$UID.lock
  72
  73 lock() {
  74     while : ; do
  75         mkdir $LOCKFILE > /dev/null 2> /dev/null && break
  76         sleep .2
  77     done
  78 }
  79
  80 unlock() {
  81     rmdir $LOCKFILE > /dev/null 2> /dev/null
  82 }
  83
  84 # ------------------------------------------------------------------------------
  85 # Kill all desklets function
  86 #
  87 kill_desklets() {
  88     LOCK=`ls @LOCKFILES_DIR@/adesklets_uid$UID_*.lock 2> /dev/null`
  89     test "x$LOCK" = "x" || {
  90         PIDS=`cat $LOCK`
  91         kill $PIDS > /dev/null 2> /dev/null
  92         sleep 1
  93         kill -9 $PIDS > /dev/null 2> /dev/null
  94     }
  95 }
  96
  97 # ------------------------------------------------------------------------------
  98 # Detect potential fake root windows function
  99 #
 100 roots() {
 101     local GEOM=`xwininfo -root | sed -n '/geometry/{s/^.*geometry[ \t]*//;p}'`
 102     local ID
 103     if test $# -eq 0 ; then
 104         ID="-root"
 105     else
 106         ID="-id $*"
 107         echo $*
 108     fi
 109     xwininfo $ID -tree | sed -n "/$GEOM/"'{s/^[ \t]*\(0x[0-9a-f]\+\).*/\1/;p}'
 110 }
 111
 112 # ------------------------------------------------------------------------------
 113 # Error handling function
 114 #
 115 error () {
 116     test $# -gt 0 && echo "Error: $*" && echo
 117     test $# -eq 0; exit
 118 }
 119
 120 # Command line error handling function
 121 #
 122 usage () {
 123     test $# -gt 0 && echo "Error: $*" && echo
 124     if test "x$ADESKLETS_EMBEDDED" = "x" ; then
 125         DESC='Usage: adesklets [OPTION]... [string_id]'
 126     else
 127         DESC='Possible options are:'
 128     fi
 129     cat<<EOF
 130 $DESC
 131
 132 Fake root window detection
 133    --kde          KDE >= 3.4.1 desktop detection
 134    --nautilus     Nautilus desktop detection
 135    --rox          ROX-Filer detection (incomplete)
 136    --user         Interactive detection (by user click)
 137    --xfce4        Xfce4 desktop detection (tested on Xfce4 4.2.x,
 138                   with xfdesktop managing the icons)
 139    --xffm         Xffm desktop window detection (tested on xffm 4.3.3.1,
 140                   with xffm-deskview managing the icons)
 141
 142    --do-it-once   When applicable, do not run the detection for each desklet,
 143                   but only once for all. Of course, desklets on multiple
 144                   screens will unlikely detect the right fake root window, but
 145                   it will speed things up for single screen settings.
 146 Miscellany
 147    -h,--help      Print out this message and exit
 148    -w progname    Wait for at least one 'progname' instance to run under
 149                   the current user id (UID) before performing any further
 150                   action
 151    -d delay       Wait for a given delay (in seconds) before performing any
 152                   further action
 153    -e editor      Use an alternate editor for configuring the desklets; it
 154                   needs to be a standalone executable that does not need
 155                   a pseudo terminal
 156 EOF
 157     if test "x$ADESKLETS_EMBEDDED" = "x" ; then
 158         cat<<EOF
 159    -v,--version   Printout adesklets version
 160    -k,--killall   Kill all running, registered desklets
 161    -c,--cleanup   Remove all dead entries from \$HOME/.adesklets
 162                   (this implies \`--killall')
 163    -i,--installer Invoke the desklet frontend installer
 164                   (requires Python)
 165    -f script      Execute command set from the \`script' file
 166
 167 If no \`string_id' is given, adesklets acts as a launcher (unless
 168 the \`-f' switch is involved). Otherwise, adesklets acts as
 169 an interpreter, if no \`-k' or \`-c' switch is used.
 170
 171 The most usual invokation of adesklets is the bare \`adesklets' command,
 172 without arguments: it makes adesklets launch every registered desklets
 173 from \$HOME/.adesklets, without any fake root window detection.
 174 EOF
 175     fi
 176     test $# -eq 0; exit
 177 }
 178
 179 # ------------------------------------------------------------------------------
 180 # Initial test
 181 #
 182 test -e $HOME/.adesklets && {
 183     test -f $HOME/.adesklets || \
 184         error "$HOME/.adesklets is not a configuration file; please remove it."
 185 }
 186
 187 # ------------------------------------------------------------------------------
 188 # Parse the command line.
 189 #
 190 SELF=$0
 191 OPTS=
 192 MODE=
 193 DO_IT_ONCE=0
 194 while test $# -gt 0 ; do
 195   case "$1" in
 196       --kde|--nautilus|--rox|--user|--xfce4|--xffm)
 197           MODE=`echo $1 | sed 's/--//'`
 198           ;;
 199       --do-it-once)
 200           DO_IT_ONCE=1
 201           ;;
 202       -h|--help)
 203           usage
 204           ;;
 205       -d)
 206           test $# -gt 1 || usage "no delay given after -d switch."
 207           sleep $2 > /dev/null 2> /dev/null || \
 208               usage "Invalid delay of \`$2' seconds given."
 209           shift
 210           ;;
 211       -w)
 212           test $# -gt 1 || usage "no progname given after -w switch."
 213           while : ; do
 214               test -z "`ps -u $UID -U $UID -o comm | sed -n "/$2/p"`" || break
 215               sleep 10
 216           done
 217           shift
 218           ;;
 219       -e)
 220           test $# -gt 1 || usage "no editor given after -e switch."
 221           ADESKLETS_EDITOR="$HOME/.adesklets_editor.sh"
 222           echo '#! /bin/sh'     > $ADESKLETS_EDITOR
 223           echo "$2 &"          >> $ADESKLETS_EDITOR
 224           echo 'kill -9 $PPID' >> $ADESKLETS_EDITOR
 225           chmod +x $ADESKLETS_EDITOR
 226           test -x $ADESKLETS_EDITOR || usage "could not create editor wrapper"
 227           export EDITOR="$ADESKLETS_EDITOR"
 228           shift
 229           ;;
 230       -v|--version)
 231           echo "adesklets @VERSION@"
 232           echo "Written By Sylvain Fourmanoit <syfou@users.sourceforge.net>"
 233           exit 0
 234           ;;
 235       -k|--killall)
 236           kill_desklets
 237           exit 0
 238           ;;
 239       -c|--cleanup)
 240           # The cleanup routine assumes the file is EXACTLY formatted as
 241           # it is output by the binary interpreter.
 242           kill_desklets
 243           LINE=
 244           for DESKLET in `sed -n 's/^\[//;s/]$//;/^\//{=;p}' $HOME/.adesklets`
 245             do
 246             if test "$DESKLET" -gt 0 2> /dev/null ; then
 247                 ID=$DESKLET
 248             else
 249                 test -x "$DESKLET" || LINE="$LINE $ID"
 250             fi
 251           done
 252           sed -i "`echo "$LINE" | sed 's/[0-9]\+/&,+1d;/g'`" $HOME/.adesklets
 253           exit 0
 254           ;;
 255       -i|--installer)
 256           shift
 257           exec adesklets_installer $*
 258           ;;
 259       -f)
 260           test $# -gt 1 || usage "no file name given after -f switch."
 261           test -r $2 || usage "could not read file \`$2'."
 262           OPTS="-f $2"
 263           shift
 264           ;;
 265       -*)
 266           usage "invalid option \`$1'."
 267           ;;
 268       *)
 269           test "x$OPTS" = "x" || \
 270               usage "invalid combination, \`$OPTS' and \`$1'."
 271           OPTS="$1"
 272           ;;
 273   esac
 274   shift
 275 done
 276
 277 # ------------------------------------------------------------------------------
 278 # Fake root window detection code
 279 #
 280 test "x$MODE" = "x" || ADESKLETS_MODE="$MODE"
 281 test "x$ADESKLETS_MODE" = "x" || {
 282     case "$ADESKLETS_MODE" in
 283         xfce4|nautilus)
 284             # Identify the lead desktop window from root property,
 285             # then find the last child with the proper dimension
 286             # For now on, we take advantage from the "compatibility code"
 287             # included in xfce4.
 288             DESKTOP=`xprop -root | \
 289              sed -n '/^NAUTILUS_DESKTOP_WINDOW_ID/{s/.* \(0x[0-9a-f]\+\)/\1/;p}'`
 290             for ROOT in `roots $DESKTOP` ; do : ; done
 291             ADESKLETS_ROOT=$ROOT
 292             ;;
 293         xffm)
 294             # Get the first child of the last window named 'xffm-deskview'.
 295             # The bet is on: how long before this changes?
 296             DESKTOP=`xwininfo -root -tree | \
 297              sed -n '/xffm-deskview/{s/[ \t]*\(0x[0-9a-f]\+\).*/\1/;p}' | \
 298              sed -n '$p'`
 299             ADESKLETS_ROOT=`xwininfo -id $DESKTOP -tree | \
 300              sed -n '/^[ \t]*0x[0-9a-f]\+/{s/[ \t]*\(0x[0-9a-f]\+\).*/\1/;p}' | \
 301              sed '1q'`
 302             ;;
 303         kde)
 304             test "x`dcop kdesktop default isIconsEnabled`" = "xtrue" && {
 305                 # First, we need to sync. the real root pixmap
 306                 # with the desktop: the fake root window is using a
 307                 # ParentRelative backgroundPixmap, with the real image
 308                 # from one of its parent, but the root being empty.
 309                 # We are very lucky this work... But for how long?
 310                 test "x$MODE" = "x" || {
 311                     # Just do this at high level
 312                     for I in 0 1; do
 313                         dcop kdesktop default setIconsEnabled $I
 314                     done
 315                 }
 316                 # Detect the fake root window
 317                 for ROOT in `roots` ; do
 318                     ADESKLETS_ROOT=`xprop -id $ROOT | \
 319                        sed -n '/__SWM_VROOT/{s/.*\(0x[0-9a-f]\+\)/\1/;p}'`
 320                     test "x$ADESKLETS_ROOT" = "x" || break
 321                 done
 322             }
 323             ;;
 324         rox)
 325             # Find first full screen window with a Rox-Filer somewhere in
 326             # its property
 327             for ROOT in `roots` ; do
 328                 test "x`xprop -id $ROOT | sed -n '/ROX-Filer/p'`" = "x" || break
 329             done
 330             ADESKLETS_ROOT=$ROOT
 331             ;;
 332         user)
 333             # In this special mode, the pseudo-root is determined
 334             # interactively using xwininfo. Since xwininfo needs to
 335             # grab the pointer, just make sure we serialize all calls
 336             # using a lock.
 337             lock
 338             ADESKLETS_ROOT=`xwininfo  | \
 339                sed -n '/Window id/{s/.*Window id: \([^ ]*\) .*/\1/p}'`
 340             unlock
 341             ;;
 342         *)
 343             error "unknown mode."
 344             ;;
 345     esac
 346     test "$DO_IT_ONCE" -eq 0 && export ADESKLETS_MODE
 347     export ADESKLETS_ROOT
 348 }
 349
 350 # ------------------------------------------------------------------------------
 351 # Now, re-invoke the binary
 352 #
 353 export ADESKLETS_FRONTEND=1
 354 exec adesklets $OPTS