path: root/src/file-manager/fm-search-list-view.c

/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */

/* fm-search-list-view.c - implementation of list view of a virtual directory,
   based on FMListView.

   Copyright (C) 2000 Eazel, Inc.

   The Gnome Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   The Gnome Library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with the Gnome Library; see the file COPYING.LIB.  If not,
   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.

   Authors: Rebecca Schulman <rebecka@eazel.com>
*/

/* Perhaps this would be better off as a set of actual special cases rather than a subclass? 
   We haven't changed much, and there is a lot of copied code (duplicate functionality)*/

#include <config.h>
#include "fm-search-list-view.h"

#include "fm-directory-view.h"
#include "fm-list-view-private.h"
#include <libnautilus-extensions/nautilus-file-attributes.h>
#include <libnautilus-extensions/nautilus-file-utilities.h>
#include <libnautilus-extensions/nautilus-search-bar-criterion.h>
#include <libnautilus-extensions/nautilus-string.h>

#include <libgnomevfs/gnome-vfs-utils.h>

#include <libgnome/gnome-i18n.h>
#include <libnautilus-extensions/nautilus-gtk-macros.h>

/* Paths to use when creating & referring to Bonobo menu items */
#define MENU_PATH_REVEAL_IN_NEW_WINDOW 		"/File/Reveal"

static void 	fm_search_list_view_initialize       	 (gpointer          object,
						      	  gpointer          klass);
static void 	fm_search_list_view_initialize_class 	 (gpointer          klass);
static void 	real_add_file				 (FMDirectoryView  *view,
							  NautilusFile 	   *file);
static void	real_create_selection_context_menu_items (FMDirectoryView  *view,
					  		  GtkMenu 	   *menu,
					  		  GList 	   *selection);
static void	real_adding_file 			 (FMListView 	   *view, 
							  NautilusFile 	   *file);
static void	real_removing_file 			 (FMListView 	   *view, 
							  NautilusFile 	   *file);
static gboolean real_file_still_belongs 		 (FMListView 	   *view, 
							  NautilusFile 	   *file);
static int  	real_get_number_of_columns           	 (FMListView       *list_view);
static int  	real_get_link_column                 	 (FMListView       *list_view);
static char *   real_get_default_sort_attribute      	 (FMListView       *view);
static void 	real_get_column_specification        	 (FMListView       *list_view,
						      	  int               column_number,
						      	  FMListViewColumn *specification);
static NautilusStringList * real_get_emblem_names_to_exclude         (FMDirectoryView  *view);
static void	real_merge_menus 		     	 (FMDirectoryView  *view);
static gboolean real_supports_properties 	     	 (FMDirectoryView  *view);
static void 	load_location_callback               	 (NautilusView 	   *nautilus_view, 
						      	  char 		   *location);
static void	real_update_menus 		     	 (FMDirectoryView  *view);


NAUTILUS_DEFINE_CLASS_BOILERPLATE (FMSearchListView,
				   fm_search_list_view,
				   FM_TYPE_LIST_VIEW)

static void
load_location_callback (NautilusView *nautilus_view, char *location)
{
	char *human_string;
	
	human_string = nautilus_search_bar_criterion_human_from_uri (location);

	nautilus_view_set_title (nautilus_view, human_string);

	g_free (human_string);

}

static void
fm_search_list_view_initialize_class (gpointer klass)
{
	FMDirectoryViewClass *fm_directory_view_class;
	FMListViewClass *fm_list_view_class;
	
	fm_directory_view_class = FM_DIRECTORY_VIEW_CLASS (klass);
	fm_list_view_class = FM_LIST_VIEW_CLASS (klass);

  	fm_directory_view_class->add_file = real_add_file;
  	fm_directory_view_class->merge_menus = real_merge_menus;
  	fm_directory_view_class->update_menus =	real_update_menus;
	fm_directory_view_class->supports_properties = 
		real_supports_properties;
	fm_directory_view_class->create_selection_context_menu_items = 
		real_create_selection_context_menu_items;
	fm_directory_view_class->get_emblem_names_to_exclude = 
		real_get_emblem_names_to_exclude;

	fm_list_view_class->adding_file = real_adding_file;
	fm_list_view_class->removing_file = real_removing_file;
	fm_list_view_class->get_number_of_columns = real_get_number_of_columns;
	fm_list_view_class->get_link_column = real_get_link_column;
	fm_list_view_class->get_column_specification = real_get_column_specification;
	fm_list_view_class->get_default_sort_attribute = real_get_default_sort_attribute;
	fm_list_view_class->file_still_belongs = real_file_still_belongs;
}

static void
fm_search_list_view_initialize (gpointer object,
				gpointer klass)
{
	NautilusView *nautilus_view;
	FMDirectoryView *directory_view;
 
 	g_assert (GTK_BIN (object)->child == NULL);
 
 	directory_view = FM_DIRECTORY_VIEW (object);

	nautilus_view = fm_directory_view_get_nautilus_view (directory_view);

	gtk_signal_connect (GTK_OBJECT(nautilus_view),
			    "load_location",
			    GTK_SIGNAL_FUNC (load_location_callback),
			    NULL);

}

static int
real_get_number_of_columns (FMListView *view)
{
	return 7;
}

static char *
get_sort_attribute_from_search_criterion (const char *criterion)
{
	if (criterion != NULL) {
		if (strcmp (criterion, NAUTILUS_SEARCH_URI_TEXT_NAME) == 0) {
			return g_strdup ("name");
		} else if (strcmp (criterion, NAUTILUS_SEARCH_URI_TEXT_TYPE) == 0) {
			return g_strdup ("type");
		} else if (strcmp (criterion, NAUTILUS_SEARCH_URI_TEXT_SIZE) == 0) {
			return g_strdup ("size");
		} else if (strcmp (criterion, NAUTILUS_SEARCH_URI_TEXT_EMBLEMS) == 0) {
			return g_strdup ("emblems");
		} else if (strcmp (criterion, NAUTILUS_SEARCH_URI_TEXT_DATE_MODIFIED) == 0) {
			return g_strdup ("date_modified");
		}
	}

	return NULL;
}

static char *
real_get_default_sort_attribute (FMListView *view)
{
	char *uri;
	char *criterion;
	char *sort_attribute;

	uri = fm_directory_view_get_uri (FM_DIRECTORY_VIEW (view));
	criterion = nautilus_search_uri_get_first_criterion (uri);
	g_free (uri);
	sort_attribute = get_sort_attribute_from_search_criterion (criterion);

	/* Default to "name" if we're using some unknown search criterion, or
	 * search criterion that doesn't correspond to any column.
	 */
	if (sort_attribute == NULL) {
		return g_strdup ("name");
	}

	return sort_attribute;
}

static NautilusStringList *
real_get_emblem_names_to_exclude (FMDirectoryView *view)
{
	g_assert (FM_IS_DIRECTORY_VIEW (view));

	/* Overridden to show even the trash emblem here */
	return NULL;
}

static int
real_get_link_column (FMListView *view)
{
	return 3;
}

static void
real_get_column_specification (FMListView *view,
			       int column_number,
			       FMListViewColumn *specification)
{
	switch (column_number) {
	case 0:
		fm_list_view_column_set (specification,
					 "icon", NULL,
					 NAUTILUS_FILE_SORT_BY_TYPE,
					 0, 0, 0, FALSE);
		break;
	case 1:
		fm_list_view_column_set (specification,
					 "emblems", NULL,
					 NAUTILUS_FILE_SORT_BY_EMBLEMS,
					 20, 40, 300, FALSE);
		break;
	case 2:
		fm_list_view_column_set (specification,
					 "directory", _("Directory"),
					 NAUTILUS_FILE_SORT_BY_DIRECTORY,
					 30, 130, 500, FALSE);
		break;
	case 3:
		fm_list_view_column_set (specification,
					 "name", _("Name"),
					 NAUTILUS_FILE_SORT_BY_NAME,
					 30, 200, 300, FALSE);
		break;
	case 4:
		fm_list_view_column_set (specification,
					 "size", _("Size"),
					 NAUTILUS_FILE_SORT_BY_SIZE,
					 20, 55, 80, TRUE);
		break;
	case 5:
		fm_list_view_column_set (specification,
					 "type", _("Type"),
					 NAUTILUS_FILE_SORT_BY_TYPE,
					 20, 95, 200, FALSE);
		break;
	case 6:
		fm_list_view_column_set (specification,
					 "date_modified", _("Date Modified"),
					 NAUTILUS_FILE_SORT_BY_MTIME,
					 30, 95, 200, FALSE);
		break;
	default:
		g_assert_not_reached ();
	}
}

static void
compute_reveal_item_name_and_sensitivity (GList *selected_files,
					  gboolean include_accelerator_underbars,
					  char **return_name,
					  gboolean *return_sensitivity)
{
	char *name;
	char *stripped;
	int count;

	g_assert (*return_name != NULL);
	g_assert (return_sensitivity != NULL);

	count = g_list_length (selected_files);
	if (count <= 1) {
		name = g_strdup (_("_Reveal in New Window"));
	} else {
		name = g_strdup_printf (_("Reveal in %d _New Windows"), count);
	}

	*return_sensitivity = selected_files != NULL;
	
	if (!include_accelerator_underbars) {
		stripped = nautilus_str_strip_chr (name, '_');
		g_free (name);
		name = stripped;
	}

	*return_name = name;
}

static void
real_add_file (FMDirectoryView *view, NautilusFile *file)
{
	char *fake_file_name;
	char *real_file_uri;
	NautilusFile *real_file;
	
	g_return_if_fail (FM_IS_SEARCH_LIST_VIEW (view));

	/* Get the real file that the funky search symbolic link file 
	 * refers to. The real file name is hacked into the name of the
	 * search results virtual file.
	 */
	fake_file_name = nautilus_file_get_name (file);
	real_file_uri = gnome_vfs_unescape_string (fake_file_name, NULL);
	real_file = nautilus_file_get (real_file_uri);

	/* Tell the normal list-view code to add this file. It will add
	 * and ref it only if it's not already in the list.
	 */ 
	NAUTILUS_CALL_PARENT_CLASS 
		(FM_DIRECTORY_VIEW_CLASS, add_file, (view, real_file));

	g_free (fake_file_name);
	g_free (real_file_uri);
	nautilus_file_unref (real_file);
}

static void
real_create_selection_context_menu_items (FMDirectoryView *view,
					  GtkMenu *menu,
					  GList *selection)
{
	GtkWidget *menu_item;
	char *name;
	gboolean sensitive;
	gint position;
	
	g_assert (FM_IS_SEARCH_LIST_VIEW (view));
	g_assert (GTK_IS_MENU (menu));

	NAUTILUS_CALL_PARENT_CLASS
		(FM_DIRECTORY_VIEW_CLASS, 
		 create_selection_context_menu_items,
		 (view, menu, selection));

	/* The Reveal item is inserted directly after the
	 * existing Open With item.
	 */
	position = fm_directory_view_get_context_menu_index
		(FM_DIRECTORY_VIEW_MENU_PATH_OPEN_WITH) + 1;
	compute_reveal_item_name_and_sensitivity (selection, FALSE, &name, &sensitive);
        menu_item = gtk_menu_item_new_with_label (name);
        g_free (name);
        gtk_widget_set_sensitive (menu_item, sensitive);
	gtk_widget_show (menu_item);

	/* FIXME bugzilla.eazel.com 1750: need to connect callback */
	/* gtk_signal_connect (GTK_OBJECT (menu_item), "activate", callback, view); */
	gtk_menu_insert (menu, menu_item, position);
}

static void
real_adding_file (FMListView *view, NautilusFile *file)
{
	GList *attributes;

	g_assert (FM_IS_SEARCH_LIST_VIEW (view));
	g_assert (NAUTILUS_IS_FILE (file));

	NAUTILUS_CALL_PARENT_CLASS (FM_LIST_VIEW_CLASS, adding_file, (view, file));

	gtk_signal_connect_object (GTK_OBJECT (file),
				   "changed",
				   fm_directory_view_queue_file_change,
				   GTK_OBJECT (view));
	/* Monitor the things needed to get the right
	 * icon. Also monitor a directory's item count because
	 * the "size" attribute is based on that.
	 */
	attributes = nautilus_icon_factory_get_required_file_attributes ();		
	attributes = g_list_prepend (attributes,
				     NAUTILUS_FILE_ATTRIBUTE_DIRECTORY_ITEM_COUNT);	nautilus_file_monitor_add (file, view, attributes, TRUE);
	g_list_free (attributes);
}

static void
real_removing_file (FMListView *view, NautilusFile *file)
{
	g_assert (FM_IS_SEARCH_LIST_VIEW (view));
	g_assert (NAUTILUS_IS_FILE (file));

	nautilus_file_monitor_remove (file, view);
	gtk_signal_disconnect_by_func 
		(GTK_OBJECT (file), fm_directory_view_queue_file_change, view);
	NAUTILUS_CALL_PARENT_CLASS (FM_LIST_VIEW_CLASS, removing_file, (view, file));
}

static gboolean
real_file_still_belongs (FMListView *view, NautilusFile *file)
{
	g_assert (FM_IS_SEARCH_LIST_VIEW (view));
	g_assert (NAUTILUS_IS_FILE (file));

	return !nautilus_file_is_gone (file);
}

static void
real_merge_menus (FMDirectoryView *view)
{
	BonoboUIHandler *ui_handler;
	GList *selected_files;
	char *name;
	gboolean sensitive;

	g_assert (FM_IS_LIST_VIEW (view));

	NAUTILUS_CALL_PARENT_CLASS (FM_DIRECTORY_VIEW_CLASS, merge_menus, (view));

	ui_handler = fm_directory_view_get_bonobo_ui_handler (view);
	selected_files = fm_directory_view_get_selection (view);

	compute_reveal_item_name_and_sensitivity (selected_files, TRUE, &name, &sensitive);

	/* FIXME bugzilla.eazel.com 1750: need to connect callback */
	bonobo_ui_handler_menu_new_item (
		ui_handler,
		MENU_PATH_REVEAL_IN_NEW_WINDOW, name,
		_("Reveal each selected item in its original folder"),
		bonobo_ui_handler_menu_get_pos 
			(ui_handler, 
			 FM_DIRECTORY_VIEW_MENU_PATH_OPEN_WITH) + 1, 
		BONOBO_UI_HANDLER_PIXMAP_NONE, NULL,
		0, 0,
		NULL, NULL);
	g_free (name);
	bonobo_ui_handler_menu_set_sensitivity 
		(ui_handler, MENU_PATH_REVEAL_IN_NEW_WINDOW, sensitive);

        nautilus_file_list_free (selected_files);
}


static gboolean
real_supports_properties (FMDirectoryView *view)
{
	/* Disable "Show Properties" menu item in this view, because changing
	 * properties could cause the item to no longer match the search
	 * criteria. Eventually we might want to solve this a different way,
	 * perhaps by showing items that don't match the search criteria any
	 * more a different way.
	 */
	return FALSE;
}

static void
real_update_menus (FMDirectoryView *view)
{
	BonoboUIHandler *ui_handler;
	GList *selected_files;
	char *name;
	gboolean sensitive;

	g_assert (FM_IS_LIST_VIEW (view));

	NAUTILUS_CALL_PARENT_CLASS (FM_DIRECTORY_VIEW_CLASS, update_menus, (view));

	ui_handler = fm_directory_view_get_bonobo_ui_handler (view);
	selected_files = fm_directory_view_get_selection (view);

	compute_reveal_item_name_and_sensitivity 
		(selected_files, TRUE, &name, &sensitive);
        bonobo_ui_handler_menu_set_sensitivity 
        	(ui_handler, MENU_PATH_REVEAL_IN_NEW_WINDOW, sensitive);
        bonobo_ui_handler_menu_set_label 
        	(ui_handler, MENU_PATH_REVEAL_IN_NEW_WINDOW, name);

	g_free (name);

        nautilus_file_list_free (selected_files);
}