From http://www.jwz.org/xscreensaver/xscreensaver-5.35.tar.gz
[xscreensaver] / driver / xscreensaver-command.c
index cc169d2792d3ea6384b2b8e1cf5a4cd6d77dad14..6adf1fdd5e852ca6a9b9987842b88593b34ac987 100644 (file)
@@ -1,5 +1,4 @@
-/* xscreensaver-command, Copyright (c) 1991-1999
- *  by Jamie Zawinski <jwz@jwz.org>
+/* xscreensaver-command, Copyright (c) 1991-2013 Jamie Zawinski <jwz@jwz.org>
  *
  * Permission to use, copy, modify, distribute, and sell this software and its
  * documentation for any purpose is hereby granted without fee, provided that
@@ -16,6 +15,7 @@
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <time.h>
 #include <sys/time.h>
 #include <sys/types.h>
 
@@ -23,7 +23,7 @@
 # include <unistd.h>
 #endif
 
-#include <X11/Xproto.h>                /* for CARD32 */
+/* #include <X11/Xproto.h>     / * for CARD32 */
 #include <X11/Xlib.h>
 #include <X11/Xatom.h>
 #include <X11/Xutil.h>         /* for XGetClassHint() */
 
 #include <X11/Intrinsic.h>     /* only needed to get through xscreensaver.h */
 
+
+/* You might think that to read an array of 32-bit quantities out of a
+   server-side property, you would pass an array of 32-bit data quantities
+   into XGetWindowProperty().  You would be wrong.  You have to use an array
+   of longs, even if long is 64 bits (using 32 of each 64.)
+ */
+typedef long PROP32;
+
 #include "remote.h"
 #include "version.h"
 
@@ -42,16 +50,22 @@ char *progname;
 
 Atom XA_VROOT;
 Atom XA_SCREENSAVER, XA_SCREENSAVER_VERSION, XA_SCREENSAVER_RESPONSE;
-Atom XA_SCREENSAVER_ID, XA_SCREENSAVER_TIME, XA_SELECT, XA_DEMO;
-static Atom XA_ACTIVATE, XA_DEACTIVATE, XA_CYCLE, XA_NEXT, XA_PREV, XA_EXIT;
-static Atom XA_RESTART, XA_PREFS, XA_LOCK, XA_THROTTLE, XA_UNTHROTTLE;
+Atom XA_SCREENSAVER_ID, XA_SCREENSAVER_STATUS, XA_SELECT, XA_DEMO, XA_EXIT;
+Atom XA_BLANK, XA_LOCK;
+static Atom XA_ACTIVATE, XA_DEACTIVATE, XA_CYCLE, XA_NEXT, XA_PREV;
+static Atom XA_RESTART, XA_PREFS, XA_THROTTLE, XA_UNTHROTTLE;
 
 static char *screensaver_version;
+# ifdef __GNUC__
+  __extension__   /* don't warn about "string length is greater than the
+                     length ISO C89 compilers are required to support" in the
+                     usage string... */
+# endif
 static char *usage = "\n\
 usage: %s -<option>\n\
 \n\
   This program provides external control of a running xscreensaver process.\n\
-  Version %s, copyright (c) 1991-1999 Jamie Zawinski <jwz@jwz.org>.\n\
+  Version %s, copyright (c) 1991-%s Jamie Zawinski <jwz@jwz.org>.\n\
 \n\
   The xscreensaver program is a daemon that runs in the background.\n\
   You control a running xscreensaver process by sending it messages\n\
@@ -89,28 +103,19 @@ usage: %s -<option>\n\
                 with a particular graphics demo.  (The first element in the\n\
                 list is numbered 1, not 0.)\n\
 \n\
-  -exit         Causes the xscreensaver process to exit gracefully.  This is\n\
-                roughly the same as killing the process with `kill', but it\n\
-                is easier, since you don't need to first figure out the pid.\n\
+  -exit         Causes the xscreensaver process to exit gracefully.\n\
+                This does nothing if the display is currently locked.\n\
                 (Note that one must *never* kill xscreensaver with -9!)\n\
 \n\
   -restart      Causes the screensaver process to exit and then restart with\n\
-                the same command line arguments as last time.  Do this after\n\
-                you've changed your X resource settings, to cause\n\
-                xscreensaver to notice the changes.\n\
+                the same command line arguments as last time.  You shouldn't\n\
+                really need to do this, since xscreensaver notices when the\n\
+                .xscreensaver file has changed and re-reads it as needed.\n\
 \n\
   -lock         Tells the running xscreensaver process to lock the screen\n\
                 immediately.  This is like -activate, but forces locking as\n\
                 well, even if locking is not the default.  If the saver is\n\
                 already active, this causes it to be locked as well.\n\
-\n\
-  -throttle     Temporarily switch to ``blank screen'' mode, and don't run\n\
-                any display modes at all, until the screensaver is next\n\
-                de-activated.  This is useful if you're using a machine\n\
-                remotely, and you find that some display modes are using too\n\
-                much CPU.\n\
-\n\
-  -unthrottle   Turn `-throttle' off and resume normal behavior.\n\
 \n\
   -version      Prints the version of xscreensaver that is currently running\n\
                 on the display -- that is, the actual version number of the\n\
@@ -121,15 +126,30 @@ usage: %s -<option>\n\
                 deactivated (roughly, how long the user has been idle or\n\
                 non-idle -- but not quite, since it only tells you when the\n\
                 screen became blanked or un-blanked.)\n\
+\n\
+  -watch        Prints a line each time the screensaver changes state: when\n\
+                the screen blanks, locks, unblanks, or when the running hack\n\
+                is changed.  This option never returns; it is intended for\n\
+                by shell scripts that want to react to the screensaver in\n\
+                some way.\n\
 \n\
   See the man page for more details.\n\
-  For updates, check http://www.jwz.org/xscreensaver/\n\
+  For updates, check https://www.jwz.org/xscreensaver/\n\
 \n";
 
+/* Note: The "-throttle" command is deprecated -- it predates the XDPMS
+   extension.  Instead of using -throttle, users should instead just
+   power off the monitor (e.g., "xset dpms force off".)  In a few
+   minutes, the xscreensaver daemon will notice that the monitor is
+   off, and cease running hacks.
+ */
+
 #define USAGE() do { \
- fprintf (stderr, usage, progname, screensaver_version); exit (1); \
+ fprintf (stderr, usage, progname, screensaver_version, year); exit (1); \
  } while(0)
 
+static int watch (Display *);
+
 int
 main (int argc, char **argv)
 {
@@ -138,12 +158,24 @@ main (int argc, char **argv)
   char *dpyname = 0;
   Atom *cmd = 0;
   long arg = 0L;
+  char *s;
+  Atom XA_WATCH = 0;  /* kludge: not really an atom */
+  char year[5];
 
   progname = argv[0];
+  s = strrchr (progname, '/');
+  if (s) progname = s+1;
+
   screensaver_version = (char *) malloc (5);
   memcpy (screensaver_version, screensaver_id + 17, 4);
   screensaver_version [4] = 0;
 
+  s = strchr (screensaver_id, '-');
+  s = strrchr (s, '-');
+  s++;
+  strncpy (year, s, 4);
+  year[4] = 0;
+
   for (i = 1; i < argc; i++)
     {
       const char *s = argv [i];
@@ -168,7 +200,8 @@ main (int argc, char **argv)
       else if (!strncmp (s, "-throttle", L))   cmd = &XA_THROTTLE;
       else if (!strncmp (s, "-unthrottle", L)) cmd = &XA_UNTHROTTLE;
       else if (!strncmp (s, "-version", L))    cmd = &XA_SCREENSAVER_VERSION;
-      else if (!strncmp (s, "-time", L))       cmd = &XA_SCREENSAVER_TIME;
+      else if (!strncmp (s, "-time", L))       cmd = &XA_SCREENSAVER_STATUS;
+      else if (!strncmp (s, "-watch", L))      cmd = &XA_WATCH;
       else USAGE ();
 
       if (cmd == &XA_SELECT || cmd == &XA_DEMO)
@@ -242,6 +275,15 @@ main (int argc, char **argv)
 
 
   if (!dpyname) dpyname = (char *) getenv ("DISPLAY");
+
+  if (!dpyname)
+    {
+      dpyname = ":0.0";
+      fprintf (stderr,
+               "%s: warning: $DISPLAY is not set: defaulting to \"%s\".\n",
+               progname, dpyname);
+    }
+
   dpy = XOpenDisplay (dpyname);
   if (!dpy)
     {
@@ -254,7 +296,7 @@ main (int argc, char **argv)
   XA_SCREENSAVER = XInternAtom (dpy, "SCREENSAVER", False);
   XA_SCREENSAVER_ID = XInternAtom (dpy, "_SCREENSAVER_ID", False);
   XA_SCREENSAVER_VERSION = XInternAtom (dpy, "_SCREENSAVER_VERSION",False);
-  XA_SCREENSAVER_TIME = XInternAtom (dpy, "_SCREENSAVER_TIME", False);
+  XA_SCREENSAVER_STATUS = XInternAtom (dpy, "_SCREENSAVER_STATUS", False);
   XA_SCREENSAVER_RESPONSE = XInternAtom (dpy, "_SCREENSAVER_RESPONSE", False);
   XA_ACTIVATE = XInternAtom (dpy, "ACTIVATE", False);
   XA_DEACTIVATE = XInternAtom (dpy, "DEACTIVATE", False);
@@ -267,18 +309,142 @@ main (int argc, char **argv)
   XA_DEMO = XInternAtom (dpy, "DEMO", False);
   XA_PREFS = XInternAtom (dpy, "PREFS", False);
   XA_LOCK = XInternAtom (dpy, "LOCK", False);
+  XA_BLANK = XInternAtom (dpy, "BLANK", False);
   XA_THROTTLE = XInternAtom (dpy, "THROTTLE", False);
   XA_UNTHROTTLE = XInternAtom (dpy, "UNTHROTTLE", False);
 
   XSync (dpy, 0);
 
+  if (cmd == &XA_WATCH)
+    {
+      i = watch (dpy);
+      exit (i);
+    }
+
   if (*cmd == XA_ACTIVATE || *cmd == XA_LOCK ||
       *cmd == XA_NEXT || *cmd == XA_PREV || *cmd == XA_SELECT)
     /* People never guess that KeyRelease deactivates the screen saver too,
-       so if we're issuing an activation command, wait a second. */
-    sleep (1);
-
-  i = xscreensaver_command (dpy, *cmd, arg, True);
+       so if we're issuing an activation command, wait a second.
+       No need to do this if stdin is not a tty, meaning we're not being
+       run from the command line.
+     */
+    if (isatty(0))
+      sleep (1);
+
+  i = xscreensaver_command (dpy, *cmd, arg, True, NULL);
   if (i < 0) exit (i);
   else exit (0);
 }
+
+
+static int
+watch (Display *dpy)
+{
+  char *v = 0;
+  Window window = RootWindow (dpy, 0);
+  XWindowAttributes xgwa;
+  XEvent event;
+  PROP32 *last = 0;
+
+  if (v) free (v);
+  XGetWindowAttributes (dpy, window, &xgwa);
+  XSelectInput (dpy, window, xgwa.your_event_mask | PropertyChangeMask);
+
+  while (1)
+    {
+      XNextEvent (dpy, &event);
+      if (event.xany.type == PropertyNotify &&
+          event.xproperty.state == PropertyNewValue &&
+          event.xproperty.atom == XA_SCREENSAVER_STATUS)
+        {
+         Atom type;
+         int format;
+         unsigned long nitems, bytesafter;
+          unsigned char *dataP = 0;
+
+         if (XGetWindowProperty (dpy,
+                                  RootWindow (dpy, 0),  /* always screen #0 */
+                                 XA_SCREENSAVER_STATUS,
+                                 0, 999, False, XA_INTEGER,
+                                 &type, &format, &nitems, &bytesafter,
+                                 &dataP)
+             == Success
+             && type
+             && dataP)
+           {
+              time_t tt;
+              char *s;
+              Bool changed = False;
+              Bool running = False;
+              PROP32 *data = (PROP32 *) dataP;
+
+              if (type != XA_INTEGER || nitems < 3)
+                {
+                STATUS_LOSE:
+                  if (last) XFree (last);
+                  if (data) XFree (data);
+                  fprintf (stderr, "%s: bad status format on root window.\n",
+                           progname);
+                  return -1;
+                }
+                  
+              tt = (time_t) data[1];
+              if (tt <= (time_t) 666000000L) /* early 1991 */
+                goto STATUS_LOSE;
+
+              s = ctime(&tt);
+              if (s[strlen(s)-1] == '\n')
+                s[strlen(s)-1] = 0;
+
+              if (!last || data[0] != last[0])
+                {
+                  /* State changed. */
+                  if (data[0] == XA_BLANK)
+                    printf ("BLANK %s\n", s);
+                  else if (data[0] == XA_LOCK)
+                    printf ("LOCK %s\n", s);
+                  else if (data[0] == 0)
+                    printf ("UNBLANK %s\n", s);
+                  else
+                    goto STATUS_LOSE;
+                }
+
+              if (!last)
+                changed = True;
+              else
+                {
+                  int i;
+                  for (i = 2; i < nitems; i++)
+                    {
+                      if (data[i] != last[i])
+                        changed = True;
+                      if (data[i])
+                        running = True;
+                    }
+                }
+
+              if (running && changed)
+                {
+                  int i;
+                  fprintf (stdout, "RUN");
+                  for (i = 2; i < nitems; i++)
+                    fprintf (stdout, " %d", (int) data[i]);
+                  fprintf (stdout, "\n");
+                }
+
+              fflush (stdout);
+
+              if (last) XFree (last);
+              last = data;
+           }
+         else
+           {
+             if (last) XFree (last);
+             if (dataP) XFree (dataP);
+             fprintf (stderr, "%s: no saver status on root window.\n",
+                      progname);
+             return -1;
+           }
+        }
+    }
+}