gimp/tools/gimp-remote.c

/* The GIMP -- an image manipulation program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 * 
 * gimp-remote.c
 * Copyright (C) 2000 Sven Neumann <sven@gimp.org>
 *                and Simon Budig <simon@gimp.org>
 * 
 * Tells a running gimp to open files by creating a synthetic drop-event.
 *
 * compile with
 *  gcc -o gimp-remote `gtk-config --cflags --libs` -lXmu -Wall gimp-remote.c
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

/* This file contains code derived from:
 * 
 * remote.c --- remote control of Netscape Navigator for Unix.
 * version 1.1.3, for Netscape Navigator 1.1 and newer.
 *
 * Copyright © 1996 Netscape Communications Corporation, all rights reserved.
 * Created: Jamie Zawinski <jwz@netscape.com>, 24-Dec-94.
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation.  No representations are made about the suitability of this
 * software for any purpose.  It is provided "as is" without express or 
 * implied warranty.
 */

/* Disclaimer:
 *
 * It is a really bad idea to use Drag'n'Drop for inter-client
 * communication. Dont even think about doing this in your own newly
 * created application. We do this *only*, because we are in a
 * feature freeze for Gimp 1.2 and adding a completely new communication
 * infrastructure for remote controlling Gimp is definitely a new
 * feature...
 * Think about sockets or Corba when you want to do something similiar.
 * We definitely consider this for Gimp 2.0.
 *                                                Simon
 */

/* TODO:
 *
 * Should try to execv the gimp in the same path as the gimp-remote executable,
 * then fall back to execvp ("gimp", argv).
 */

#include "config.h"

#include <errno.h>
#include <unistd.h>

#include <gdk/gdkx.h>
#include <gtk/gtk.h>

#include <X11/Xmu/WinUtil.h>       /*  for XmuClientWindow ()  */

#include "libgimp/gimpfeatures.h"  /*  for GIMP_VERSION        */


static gboolean  start_new = FALSE;


static Window
gimp_remote_find_window (Display *display)
{
    Window root_window;
    Window root, parent, *children;
    Window result = None;
    Atom WM_CLASS;
    Atom WM_STRING;
    guint nchildren;
    gint i;
  
    g_return_val_if_fail (display != NULL, 0);

    root_window = RootWindowOfScreen (DefaultScreenOfDisplay (display));

    if (XQueryTree (display, root_window, 
                    &root, &parent, &children, &nchildren) == 0)
        return None;
  
    if (! (children && nchildren))
        return None;

    WM_CLASS  = XInternAtom (display, "WM_CLASS", False);
    WM_STRING = XInternAtom (display, "STRING", False);

    for (i = nchildren - 1; i >= 0; i--)
      {
        Atom type;
        gint format;
        gulong nitems, bytesafter;
        guchar *version = 0;
        Window window = XmuClientWindow (display, children[i]);
        gint status = 0;

        /*  We are searching the Gimp toolbox: Its WM_CLASS Property
         *  has the values "toolbox\0Gimp\0". This is pretty relieable,
         *  it is more reliable when we ask a special property, explicitely
         *  set from the gimp. See below... :-)
         */

        status = XGetWindowProperty (display, window, WM_CLASS,
                                     0, (128 / sizeof (long)),
                                     False, WM_STRING,
                                     &type, &format, &nitems, &bytesafter,
                                     &version);

        if (status == Success && type != None && nitems > 0) 
	  {
            if (!strcmp (version, "toolbox") && !strcmp (version+8, "Gimp")) 
	      {
		result = window;
		break;
	      }
            XFree (version);
	  }
      }
  
    XFree (children);
  
    return result;
}

static void  
source_selection_get (GtkWidget          *widget,
		      GtkSelectionData   *selection_data,
		      guint               info,
		      guint               time,
		      gpointer            data)
{
    gchar *uri = (gchar *) data;

    gtk_selection_data_set (selection_data,
			    selection_data->target,
			    8, uri, strlen (uri));
    gtk_main_quit ();
}

static int
toolbox_hidden (gpointer data)
{
    g_printerr ("Could not connect to the Gimp.\n"
                "Make sure that the Toolbox is visible!\n");
    gtk_main_quit ();
    return 0;
}
  
static void
usage (void)
{
  g_print ("gimp-remote version %s\n", GIMP_VERSION);
  g_print ("Tells a running Gimp to open a (local or remote) image file.\n\n"
	   "Usage: gimp-remote [options] [FILE|URI]...\n"
	   "Valid options are:\n" 
	   "  -h --help       Output this help.\n"
	   "  -v --version    Output version info.\n"
	   "  -n --new        Start gimp if no active gimp window was found.\n\n"
	   "Example:  gimp-remote http://www.gimp.org/icons/frontpage-small.gif\n"
	   "     or:  gimp-remote localfile.png\n");
}

static void
start_new_gimp (GString *file_list)
{     
  gint    i;
  gchar **argv;
  
  file_list = g_string_prepend (file_list, "gimp\n");
  argv = g_strsplit (file_list->str, "\n", 0);
  g_string_free (file_list, TRUE);

  for (i = 1; argv[i]; i++)
    {
      if (g_strncasecmp ("file:", argv[i], 5) == 0)
	argv[i] += 5;
    }
  execvp ("gimp", argv);
	  
  /*  if execvp returns, there was an arror  */
  g_printerr ("Couldn't start gimp for the following reason: %s\n", g_strerror (errno));
  exit (-1);
}

static void
parse_option (gchar *arg)
{
  if (strcmp (arg, "-v") == 0 || 
      strcmp (arg, "--version") == 0)
    {
      g_print ("gimp-remote version %s\n", GIMP_VERSION);
      exit (0);
    }
  else if (strcmp (arg, "-h") == 0 || 
	   strcmp (arg, "-?") == 0 || 
	   strcmp (arg, "--help") == 0 || 
	   strcmp (arg, "--usage") == 0)
    {
      usage ();
      exit (0);
    }
  else if (strcmp (arg, "-n") == 0 ||
	   strcmp (arg, "--new") == 0)
    {
      start_new = TRUE;
    }
  else
    {
      g_print ("Unknown option %s\n", arg);
      g_print ("Try gimp-remote --help to get detailed usage instructions.\n");
      exit (0);
    }
}

gint 
main (gint    argc, 
      gchar **argv)
{
    GtkWidget *source;
    GdkWindow *gimp_window;
    Window     gimp_x_window;

    GdkDragContext  *context;
    GdkDragProtocol  protocol;

    GdkAtom   sel_type;
    GdkAtom   sel_id;
    GList    *targetlist;
    guint     timeout;
    gboolean  options = TRUE;

    GString  *file_list = g_string_new ("");
    gchar    *cwd       = g_get_current_dir();
    gchar    *file_uri  = "";
    guint    i;

    for (i = 1; i < argc; i++)
      {
	if (strlen (argv[i]) == 0)
	  continue;

	if (options && *argv[i] == '-')
	  {
	    if (strcmp (argv[i], "--"))
	      {
		parse_option (argv[i]);
		continue;
	      }
	    else
	      {
		/*  everything following a -- is interpreted as arguments  */
		options = FALSE;
		continue;
	      }
	  }

	/* If not already a valid URI */
        if (g_strncasecmp ("file:", argv[i], 5) &&
            g_strncasecmp ("ftp:",  argv[i], 4) &&
            g_strncasecmp ("http:", argv[i], 5))
	  {
	    if (g_path_is_absolute (argv[i]))
		file_uri = g_strconcat ("file:", argv[i], NULL);
	    else
		file_uri = g_strconcat ("file:", cwd, "/", argv[i], NULL);
	  }
	else
	  file_uri = g_strdup (argv[i]);

	if (file_list->len > 0)
	  file_list = g_string_append_c (file_list, '\n');

	file_list = g_string_append (file_list, file_uri);
	g_free (file_uri);
      }

    if (file_list->len == 0) 
      {
	usage ();
        exit (0);
      }

    gtk_init (&argc, &argv); 

    /*  locate Gimp window and make it comfortable for us */
    gimp_x_window = gimp_remote_find_window (gdk_display);
    if (gimp_x_window == None)
      {
	if (start_new)
	  start_new_gimp (file_list);

	g_printerr ("No gimp window found on display %s\n", gdk_get_display ());
	exit (-1);
      }

    gdk_drag_get_protocol (gimp_x_window, &protocol);
    if (protocol != GDK_DRAG_PROTO_XDND)
      {
       g_printerr ("Gimp-Window doesnt use Xdnd-Protocol - huh?\n");
	exit (-1);
      }	

    gimp_window = gdk_window_foreign_new (gimp_x_window);
    if (!gimp_window)
      {
	g_printerr ("Couldn't create gdk_window for gimp_x_window\n");
	exit (-1);
      }

    /*  Problem: If the Toolbox is hidden via Tab (gtk_widget_hide)
     *  it does not accept DnD-Operations and gtk_main() will not be
     *  terminated. If the Toolbox is simply unmapped (by the Windowmanager)
     *  DnD works. But in both cases gdk_window_is_visible () == 0.... :-( 
     *  To work around this add a timeout and abort after 1.5 seconds.
     */
 
    timeout = gtk_timeout_add (1500, toolbox_hidden, NULL);


    /*  set up an DND-source  */
    source = gtk_window_new (GTK_WINDOW_TOPLEVEL);
    gtk_signal_connect (GTK_OBJECT (source), "selection_get",
		        GTK_SIGNAL_FUNC (source_selection_get), file_list->str);
    gtk_widget_realize (source);


    /*  specify the id and the content-type of the selection used to
     *  pass the URIs to Gimp.
     */
    sel_id = gdk_atom_intern ("XdndSelection", FALSE);
    sel_type = gdk_atom_intern ("text/uri-list", FALSE);
    targetlist = g_list_prepend (NULL, GUINT_TO_POINTER (sel_type));


    /*  assign the selection to our DnD-source  */
    gtk_selection_owner_set (source, sel_id, GDK_CURRENT_TIME);
    gtk_selection_add_target (source, sel_id, sel_type, 0);


    /*  drag_begin/motion/drop  */
    context = gdk_drag_begin (source->window, targetlist);
  
    gdk_drag_motion (context, gimp_window, protocol, 0, 0,
                     GDK_ACTION_COPY, GDK_ACTION_COPY, GDK_CURRENT_TIME);

    gdk_drag_drop (context, GDK_CURRENT_TIME);

    /*  finally enter the mainloop to handle the events  */
    gtk_main ();

    gtk_timeout_remove (timeout);
    g_string_free (file_list, TRUE);

    exit (0);
}