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 #
  59 # The xprop and xwinfinfo programs can also be used, if a given fake-root
  60 # window detection routine is explicitely invoked. Both XFree86 and X.org
  61 # implementations of these utilities have been tested. Window Manager specific
  62 # detection will also potentially need WM specific programs:
  63 #
  64 # kde: need consolde dcop client
  65 #
  66 # ------------------------------------------------------------------------------
  67 # Lock/unlock function
  68 # Based on the fact that creating a directory is atomic
  69 #
  70 LOCKFILE=@LOCKFILES_DIR@/adesklets_frontend_$UID.lock
  71
  72 lock() {
  73     while : ; do
  74         mkdir $LOCKFILE > /dev/null 2> /dev/null && break
  75         sleep .2
  76     done
  77 }
  78
  79 unlock() {
  80     rmdir $LOCKFILE > /dev/null 2> /dev/null
  81 }
  82
  83 # ------------------------------------------------------------------------------
  84 # Kill all desklets function
  85 #
  86 kill_desklets() {
  87     LOCK=`ls @LOCKFILES_DIR@/adesklets_uid$UID_*.lock 2> /dev/null`
  88     test "x$LOCK" = "x" || {
  89         PIDS=`cat $LOCK`
  90         kill $PIDS > /dev/null 2> /dev/null
  91         sleep 1
  92         kill -9 $PIDS > /dev/null 2> /dev/null
  93     }
  94 }
  95
  96 # ------------------------------------------------------------------------------
  97 # Detect potential fake root windows function
  98 #
  99 roots() {
 100     local GEOM=`xwininfo -root | sed -n '/geometry/{s/^.*geometry[ \t]*//;p}'`
 101     local ID
 102     if test $# -eq 0 ; then
 103         ID="-root"
 104     else
 105         ID="-id $*"
 106     fi
 107     echo xwininfo $ID -tree
 108     xwininfo $ID -tree | sed -n "/$GEOM/"'{s/^[ \t]*\(0x[0-9a-f]\+\).*/\1/;p}'
 109 }
 110
 111 # ------------------------------------------------------------------------------
 112 # Error handling function
 113 #
 114 error () {
 115     test $# -gt 0 && echo "Error: $*" && echo
 116     test $# -eq 0; exit
 117 }
 118
 119 # Command line error handling function
 120 #
 121 usage () {
 122     test $# -gt 0 && echo "Error: $*" && echo
 123     if test "x$ADESKLETS_EMBEDDED" = "x" ; then
 124         DESC='Usage: adesklets [OPTION] ... [string_id], where OPTION is in:'
 125     else
 126         DESC='Possible options are:'
 127     fi
 128     cat<<EOF
 129 $DESC
 130
 131  Fake root window detection
 132    --xfce4      Xfce4 desktop detection (tested on Xfce4 4.2.0)
 133    --nautilus   Nautilus desktop detection
 134    --kde        KDE >= 3.4.1 desktop detection
 135    --user       Interactive detection (by user click)
 136    --do-it-once When applicable, do not run the detection for each desklet,
 137                 but only once for all. Of course, desklets on multiple
 138                 screens will unlikely detect the right fake root window, but
 139                 it will speed things up for single screen settings.
 140  Miscellany
 141    -h,--help    Print out this message and exit
 142    -d delay     Wait for a given delay (in seconds) before
 143                 performing any further action
 144 EOF
 145     if test "x$ADESKLETS_EMBEDDED" = "x" ; then
 146         cat<<EOF
 147    -k,--killall Kill all running, registered desklets
 148    -c,--cleanup Remove all dead entries from \$HOME/.adesklets
 149                 (this implies \`--killall')
 150    -f script    Execute command set from the \`script' file
 151
 152 If no \`string_id' is given, adesklets acts as a launcher (unless
 153 the \`-f' switch is involved). Otherwise, adesklets acts as
 154 an interpreter, if no \`-k' or \`-c' switch is used.
 155
 156 The most usual invokation of adesklets is the bare \`adesklets' command,
 157 without arguments: it makes adesklets launch every registered desklets
 158 from \$HOME/.adesklets.
 159 EOF
 160     fi
 161     test $# -eq 0; exit
 162 }
 163
 164 # ------------------------------------------------------------------------------
 165 # Initial test
 166 #
 167 test -e $HOME/.adesklets && {
 168     test -f $HOME/.adesklets || \
 169         error "$HOME/.adesklets is not a configuration file; please remove it."
 170 }
 171
 172 # ------------------------------------------------------------------------------
 173 # Parse the command line.
 174 #
 175 SELF=$0
 176 OPTS=
 177 MODE=
 178 DO_IT_ONCE=0
 179 while test $# -gt 0 ; do
 180   case "$1" in
 181       --xfce4|--nautilus|--kde|--user)
 182           MODE=`echo $1 | sed 's/--//'`
 183           ;;
 184       --do-it-once)
 185           DO_IT_ONCE=1
 186           ;;
 187       -h|--help)
 188           usage
 189           ;;
 190       -d)
 191           test $# -gt 1 || usage "no delay given after -d switch."
 192           sleep $2 > /dev/null 2> /dev/null || \
 193               usage "Invalid delay of \`$2' seconds given."
 194           shift
 195           ;;
 196       -k|--killall)
 197           kill_desklets
 198           exit 0
 199           ;;
 200       -c|--cleanup)
 201           # The cleanup routine assumes the file is EXACTLY formatted as
 202           # it is output by the binary interpreter.
 203           kill_desklets
 204           LINE=
 205           for DESKLET in `sed -n 's/^\[//;s/]$//;/^\//{=;p}' $HOME/.adesklets`
 206             do
 207             if test "$DESKLET" -gt 0 2> /dev/null ; then
 208                 ID=$DESKLET
 209             else
 210                 test -x "$DESKLET" || LINE="$LINE $ID"
 211             fi
 212           done
 213           sed -i "`echo "$LINE" | sed 's/[0-9]\+/&,+1d;/g'`" $HOME/.adesklets
 214           exit 0
 215           ;;
 216       -f)
 217           test $# -gt 1 || usage "no file name given after -f switch."
 218           test -r $2 || usage "could not read file \`$2'."
 219           OPTS="-f $2"
 220           shift
 221           ;;
 222       -*)
 223           usage "invalid option \`$1'."
 224           ;;
 225       *)
 226           test "x$OPTS" = "x" || \
 227               usage "invalid combination, \`$OPTS' and \`$1'."
 228           OPTS="$1"
 229           ;;
 230   esac
 231   shift
 232 done
 233
 234 # ------------------------------------------------------------------------------
 235 # Fake root window detection code
 236 #
 237 test "x$MODE" = "x" || ADESKLETS_MODE="$MODE"
 238 test "x$ADESKLETS_MODE" = "x" || {
 239     case "$ADESKLETS_MODE" in
 240         xfce4|nautilus)
 241             # Identify the lead desktop window from root property,
 242             # then find the last child with the proper dimension
 243             # For now on, we take advantage from the "compatibility code"
 244             # included in xfce4.
 245             DESKTOP=`xprop -root | \
 246               sed -n '/^NAUTILUS_DESKTOP_WINDOW_ID/{s/.* \(0x[0-9a-f]\+\)/\1/;p}'`
 247             ADESKLETS_ROOT=`roots $DESKTOP | sed '$p'`
 248             ;;
 249         kde)
 250             test "x`dcop kdesktop default isIconsEnabled`" = "xtrue" && {
 251                 # First, we need to sync. the real root pixmap
 252                 # with the desktop: the fake root window is using a
 253                 # ParentRelative backgroundPixmap, with the real image
 254                 # from one of its parent, but the root being empty.
 255                 # We are very lucky this work... But for how long?
 256                 test "x$MODE" = "x" || {
 257                     # Just do this at high level
 258                     for I in 0 1; do
 259                         dcop kdesktop default setIconsEnabled $I
 260                     done
 261                 }
 262                 # Detect the fake root window
 263                 for ROOT in `roots` ; do
 264                     ADESKLETS_ROOT=`xprop -id $ROOT | \
 265                        sed -n '/__SWM_VROOT/{s/.*\(0x[0-9a-f]\+\)/\1/;p}'`
 266                     test "x$ADESKLETS_ROOT" = "x" || break
 267                 done
 268             }
 269             ;;
 270         user)
 271             # In this special mode, the pseudo-root is determined
 272             # interactively using xwininfo. Since xwininfo needs to
 273             # grab the pointer, just make sure we serialize all calls
 274             # using a lock.
 275             lock
 276             ADESKLETS_ROOT=`xwininfo  | \
 277                sed -n '/Window id/{s/.*Window id: \([^ ]*\) .*/\1/p}'`
 278             unlock
 279             ;;
 280         *)
 281             error "unknown mode."
 282             ;;
 283     esac
 284     test "$DO_IT_ONCE" -eq 0 && export ADESKLETS_MODE
 285     export ADESKLETS_ROOT
 286 }
 287
 288 # ------------------------------------------------------------------------------
 289 # Now, re-invoke the binary
 290 #
 291 export ADESKLETS_FRONTEND=1
 292 exec adesklets $OPTS