path: root/src/ephy-tab.c

/*
 *  Copyright (C) 2000-2003 Marco Pesenti Gritti
 *  Copyright (C) 2003, 2004 Christian Persch
 *  Copyright (C) 2004 Crispin Flowerday
 *  Copyright (C) 2004 Adam Hooper
 *
 *  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, 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.
 *
 *  $Id$
 */

#include "config.h"

#include "ephy-tab.h"
#include "eel-gconf-extensions.h"
#include "ephy-prefs.h"
#include "ephy-embed-factory.h"
#include "ephy-embed-prefs.h"
#include "ephy-debug.h"
#include "ephy-string.h"
#include "ephy-notebook.h"
#include "ephy-file-helpers.h"
#include "ephy-zoom.h"
#include "ephy-favicon-cache.h"
#include "ephy-embed-persist.h"
#include "ephy-history.h"
#include "ephy-embed-shell.h"
#include "ephy-embed-single.h"
#include "ephy-shell.h"
#include "ephy-permission-manager.h"

#include <glib/gi18n.h>
#include <libgnomevfs/gnome-vfs-uri.h>
#include <gtk/gtklabel.h>
#include <gtk/gtkbutton.h>
#include <gtk/gtkstock.h>
#include <gtk/gtkmisc.h>
#include <gtk/gtkhbox.h>
#include <gtk/gtkimage.h>
#include <gtk/gtkiconfactory.h>
#include <gtk/gtkstyle.h>
#include <gtk/gtkselection.h>
#include <gtk/gtkmain.h>
#include <gtk/gtkmenu.h>
#include <gtk/gtkuimanager.h>
#include <gtk/gtkradioaction.h>
#include <gtk/gtkclipboard.h>
#include <string.h>

#define EPHY_TAB_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE ((object), EPHY_TYPE_TAB, EphyTabPrivate))

#define CONF_LOCKDOWN_DISABLE_JAVASCRIPT_CHROME  "/apps/epiphany/lockdown/disable_javascript_chrome"

struct _EphyTabPrivate
{
    char *status_message;
    char *link_message;
    char *icon_address;
    char *address;
    char *title;
    int load_percent;
    gboolean visibility;
    gboolean load_status;
    TabAddressExpire address_expire;
    int cur_requests;
    int total_requests;
    int width;
    int height;
    GtkToggleAction *action;
    float zoom;
    gboolean setting_zoom;
    EmbedSecurityLevel security_level;
    GSList *hidden_popups;
    GSList *shown_popups;
    TabNavigationFlags nav_flags;
};

static void ephy_tab_class_init     (EphyTabClass *klass);
static void ephy_tab_init       (EphyTab *tab);
static void ephy_tab_finalize       (GObject *object);

enum
{
    PROP_0,
    PROP_ADDRESS,
    PROP_ICON,
    PROP_LOAD_PROGRESS,
    PROP_LOAD_STATUS,
    PROP_MESSAGE,
    PROP_NAVIGATION,
    PROP_SECURITY,
    PROP_HIDDEN_POPUP_COUNT,
    PROP_POPUPS_ALLOWED,
    PROP_TITLE,
    PROP_VISIBLE,
    PROP_ZOOM
};

typedef struct
{
    char *url;
    char *features;
} PopupInfo;

static GObjectClass *parent_class = NULL;

static gulong tab_id = 0;

/* internal functions, accessible only from this file */
static void ephy_tab_set_icon_address   (EphyTab *tab,
                         const char *location);
static void ephy_tab_set_load_status    (EphyTab *tab,
                         gboolean status);
static void ephy_tab_set_link_message   (EphyTab *tab,
                         char *message);
static void ephy_tab_set_load_percent   (EphyTab *tab,
                         int percent);
static void ephy_tab_update_navigation_flags(EphyTab *tab,
                         EphyEmbed *embed);
static void ephy_tab_set_security_level (EphyTab *tab,
                         EmbedSecurityLevel level);
static void ephy_tab_set_title      (EphyTab *tab,
                         EphyEmbed *embed,
                         const char *new_title);
static void ephy_tab_set_zoom       (EphyTab *tab,
                         float zoom);
static guint    popup_blocker_n_hidden      (EphyTab *tab);
static gboolean ephy_tab_get_popups_allowed (EphyTab *tab);
static void ephy_tab_set_popups_allowed (EphyTab *tab,
                         gboolean allowed);

/* Class functions */

GType
ephy_tab_get_type (void)
{
        static GType type = 0;

        if (G_UNLIKELY (type == 0))
        {
                static const GTypeInfo our_info =
                {
                        sizeof (EphyTabClass),
                        NULL, /* base_init */
                        NULL, /* base_finalize */
                        (GClassInitFunc) ephy_tab_class_init,
                        NULL,
                        NULL, /* class_data */
                        sizeof (EphyTab),
                        0, /* n_preallocs */
                        (GInstanceInitFunc) ephy_tab_init
                };

                type = g_type_register_static (GTK_TYPE_BIN,
                           "EphyTab",
                           &our_info, 0);
        }

        return type;
}

static void
ephy_tab_set_property (GObject *object,
               guint prop_id,
               const GValue *value,
               GParamSpec *pspec)
{
    EphyTab *tab = EPHY_TAB (object);

    switch (prop_id)

    {
        case PROP_ADDRESS:
            ephy_tab_set_location (tab, g_value_get_string (value),
                           TAB_ADDRESS_EXPIRE_NOW);
            break;
        case PROP_POPUPS_ALLOWED:
            ephy_tab_set_popups_allowed
                (tab, g_value_get_boolean (value));
            break;
        case PROP_ICON:
        case PROP_LOAD_PROGRESS:
        case PROP_LOAD_STATUS:
        case PROP_MESSAGE:
        case PROP_NAVIGATION:
        case PROP_SECURITY:
        case PROP_HIDDEN_POPUP_COUNT:
        case PROP_TITLE:
        case PROP_VISIBLE:
        case PROP_ZOOM:
            /* read only */
            break;
    }
}

static void
ephy_tab_get_property (GObject *object,
               guint prop_id,
               GValue *value,
               GParamSpec *pspec)
{
    EphyTab *tab = EPHY_TAB (object);

    switch (prop_id)
    {
        case PROP_ADDRESS:
            g_value_set_string (value, tab->priv->address);
            break;
        case PROP_ICON:
            g_value_set_string (value, tab->priv->icon_address);
            break;
        case PROP_LOAD_PROGRESS:
            g_value_set_int (value, tab->priv->load_percent);
            break;
        case PROP_LOAD_STATUS:
            g_value_set_boolean (value, tab->priv->load_status);
            break;
        case PROP_MESSAGE:
            g_value_set_string (value, ephy_tab_get_status_message (tab));
            break;
        case PROP_NAVIGATION:
            g_value_set_int (value, tab->priv->nav_flags);
            break;
        case PROP_SECURITY:
            g_value_set_int (value, tab->priv->security_level);
            break;
        case PROP_HIDDEN_POPUP_COUNT:
            g_value_set_int (value, popup_blocker_n_hidden (tab));
            break;
        case PROP_POPUPS_ALLOWED:
            g_value_set_boolean
                (value, ephy_tab_get_popups_allowed (tab));
            break;
        case PROP_TITLE:
            g_value_set_string (value, tab->priv->title);
            break;
        case PROP_VISIBLE:
            g_value_set_boolean (value, tab->priv->visibility);
            break;
        case PROP_ZOOM:
            g_value_set_float (value, tab->priv->zoom);
            break;
    }
}

static void
ephy_tab_size_allocate (GtkWidget *widget,
            GtkAllocation *allocation)
{
    GtkWidget *child;
    GtkAllocation invalid = { -1, -1, 1, 1 };

    widget->allocation = *allocation;

    child = GTK_BIN (widget)->child;
    g_return_if_fail (child != NULL);

    /* only resize if we're mapped (bug #128191),
     * or if this is the initial size-allocate (bug #156854).
     */
    if (GTK_WIDGET_MAPPED (child) ||
        memcmp (&child->allocation, &invalid, sizeof (GtkAllocation)) == 0)
    {
        gtk_widget_size_allocate (child, allocation);
    }
}

static void
ephy_tab_map (GtkWidget *widget)
{
    GtkWidget *child;

    g_return_if_fail (GTK_WIDGET_REALIZED (widget));

    child = GTK_BIN (widget)->child;
    g_return_if_fail (child != NULL);

    /* we do this since the window might have been resized while this
     * tab wasn't mapped (i.e. was a non-active tab during the resize).
     * See bug #156854.
     */
    if (memcmp (&widget->allocation, &child->allocation,
        sizeof (GtkAllocation)) != 0)
    {
        gtk_widget_size_allocate (child, &widget->allocation);
    }

    GTK_WIDGET_CLASS (parent_class)->map (widget);  
}

static EphyWindow *
ephy_tab_get_window (EphyTab *tab)
{
    GtkWidget *toplevel;

    toplevel = gtk_widget_get_toplevel (GTK_WIDGET (tab));
    g_return_val_if_fail (toplevel != NULL, NULL);

    return EPHY_WINDOW (toplevel);
}

static void
ephy_tab_action_activate_cb (GtkAction *action, EphyTab *tab)
{
    EphyWindow *window;

    g_return_if_fail (EPHY_IS_TAB (tab));

    window = ephy_tab_get_window (tab);
    g_return_if_fail (window != NULL);

    if (gtk_toggle_action_get_active (GTK_TOGGLE_ACTION (action)) &&
        ephy_window_get_active_tab (window) != tab)
    {
        ephy_window_jump_to_tab (window, tab);
    }
}

static void
ephy_tab_class_init (EphyTabClass *class)
{
        GObjectClass *object_class = G_OBJECT_CLASS (class);
    GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(class);

        parent_class = g_type_class_peek_parent (class);

        object_class->finalize = ephy_tab_finalize;
    object_class->get_property = ephy_tab_get_property;
    object_class->set_property = ephy_tab_set_property;

    widget_class->size_allocate = ephy_tab_size_allocate;
    widget_class->map = ephy_tab_map;

    g_object_class_install_property (object_class,
                     PROP_ADDRESS,
                     g_param_spec_string ("address",
                                  "Address",
                                  "The tab's address",
                                  "",
                                  G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_ICON,
                     g_param_spec_string ("icon",
                                  "Icon address",
                                  "The tab icon's address",
                                  NULL,
                                  G_PARAM_READABLE));

    g_object_class_install_property (object_class,
                     PROP_LOAD_PROGRESS,
                     g_param_spec_int ("load-progress",
                               "Load progress",
                               "The tab's load progress in percent",
                               0,
                               100,
                               0,
                               G_PARAM_READABLE));

    g_object_class_install_property (object_class,
                     PROP_LOAD_STATUS,
                     g_param_spec_boolean ("load-status",
                                   "Load status",
                                   "The tab's load status",
                                   FALSE,
                                   G_PARAM_READABLE));

    g_object_class_install_property (object_class,
                     PROP_MESSAGE,
                     g_param_spec_string ("message",
                                  "Message",
                                  "The tab's statusbar message",
                                  NULL,
                                  G_PARAM_READABLE));

    g_object_class_install_property (object_class,
                     PROP_NAVIGATION,
                     g_param_spec_int ("navigation",
                               "Navigation flags",
                               "The tab's navigation flags",
                                0,
                                TAB_NAV_UP |
                                TAB_NAV_BACK |
                                TAB_NAV_FORWARD,
                                0,
                                G_PARAM_READABLE));

    g_object_class_install_property (object_class,
                     PROP_SECURITY,
                     g_param_spec_int ("security-level",
                               "Security Level",
                               "The tab's security level",
                                STATE_IS_UNKNOWN,
                                STATE_IS_SECURE_HIGH,
                                STATE_IS_UNKNOWN,
                                G_PARAM_READABLE));

    g_object_class_install_property (object_class,
                     PROP_HIDDEN_POPUP_COUNT,
                     g_param_spec_int ("hidden-popup-count",
                               "Number of Blocked Popups",
                               "The tab's number of blocked popup windows",
                                0,
                                G_MAXINT,
                                0,
                                G_PARAM_READABLE));

    g_object_class_install_property (object_class,
                     PROP_POPUPS_ALLOWED,
                     g_param_spec_boolean ("popups-allowed",
                                   "Popups Allowed",
                                   "Whether popup windows are to be displayed",
                                   FALSE,
                                   G_PARAM_READABLE | G_PARAM_WRITABLE));

    g_object_class_install_property (object_class,
                     PROP_TITLE,
                     g_param_spec_string ("title",
                                  "Title",
                                  "The tab's title",
                                  _("Blank page"),
                                  G_PARAM_READABLE));

    g_object_class_install_property (object_class,
                     PROP_VISIBLE,
                     g_param_spec_boolean ("visible",
                                   "Visibility",
                                   "The tab's visibility",
                                   TRUE,
                                   G_PARAM_READABLE));

    g_object_class_install_property (object_class,
                     PROP_ZOOM,
                     g_param_spec_float ("zoom",
                                 "Zoom",
                                 "The tab's zoom",
                                 ZOOM_MINIMAL,
                                 ZOOM_MAXIMAL,
                                 1.0,
                                 G_PARAM_READABLE));

    g_type_class_add_private (object_class, sizeof(EphyTabPrivate));
}

static void
popups_manager_free_info (PopupInfo *popup)
{
    g_free (popup->url);
    g_free (popup->features);
    g_free (popup);
}

static void
popups_manager_add (EphyTab *tab,
            const char *url,
            const char *features)
{
    PopupInfo *popup;

    LOG ("popups_manager_add: tab %p, url %s, features %s",
         tab, url, features)

    g_return_if_fail (EPHY_IS_TAB (tab));

    popup = g_new0 (PopupInfo, 1);

    popup->url = g_strdup (url);
    popup->features = g_strdup (features);

    tab->priv->hidden_popups = g_slist_prepend
        (tab->priv->hidden_popups, popup);

    g_object_notify (G_OBJECT (tab), "hidden-popup-count");
}

static gboolean
popups_manager_remove_window (EphyTab *tab,
                  EphyWindow *window)
{
    tab->priv->shown_popups = g_slist_remove (tab->priv->shown_popups,
                          window);

    return FALSE;
}

static void
disconnect_popup (EphyWindow *window,
          EphyTab *tab)
{
    g_signal_handlers_disconnect_by_func
        (window, G_CALLBACK (popups_manager_remove_window), tab);
}

static void
popups_manager_add_window (EphyTab *tab,
               EphyWindow *window)
{
    LOG ("popups_manager_add_window: tab %p, window %p", tab, window)

    g_return_if_fail (EPHY_IS_TAB (tab));
    g_return_if_fail (EPHY_IS_WINDOW (window));

    tab->priv->shown_popups = g_slist_prepend
        (tab->priv->shown_popups, window);

    g_signal_connect_swapped (window, "destroy",
                  G_CALLBACK (popups_manager_remove_window),
                  tab);
}

static gboolean
ephy_tab_get_popups_allowed (EphyTab *tab)
{
    EphyPermissionManager *permission_manager;
    EphyPermission response;
    EphyEmbed *embed;
    char *location;
    gboolean allow;

    g_return_val_if_fail (EPHY_IS_TAB (tab), FALSE);

    permission_manager = EPHY_PERMISSION_MANAGER
        (ephy_embed_shell_get_embed_single (embed_shell));
    g_return_val_if_fail (EPHY_IS_PERMISSION_MANAGER (permission_manager),
                  FALSE);

    embed = ephy_tab_get_embed (tab);
    g_return_val_if_fail (EPHY_IS_EMBED (embed), FALSE);

    location = ephy_embed_get_location (embed, TRUE);
    if (location == NULL) return FALSE; /* FALSE, TRUE... same thing */

    response = ephy_permission_manager_test
        (permission_manager, location, EPT_POPUP);

    switch (response)
    {
        case EPHY_PERMISSION_ALLOWED:
            allow = TRUE;
            break;
        case EPHY_PERMISSION_DENIED:
            allow = FALSE;
            break;
        case EPHY_PERMISSION_DEFAULT:
        default:
            allow = eel_gconf_get_boolean
                (CONF_SECURITY_ALLOW_POPUPS);
            break;
    }

    g_free (location);

    LOG ("ephy_tab_get_popups_allowed: tab %p, allowed: %d", tab, allow)

    return allow;
}

static void
popups_manager_show (PopupInfo *popup,
             EphyTab *tab)
{
    EphyEmbed *embed;
    EphyEmbedSingle *single;

    embed = ephy_tab_get_embed (tab);

    single = EPHY_EMBED_SINGLE
        (ephy_embed_shell_get_embed_single (embed_shell));

    ephy_embed_single_open_window (single, embed, popup->url, "",
                       popup->features);

    popups_manager_free_info (popup);
}

static void
popups_manager_show_all (EphyTab *tab)
{
    LOG ("popup_blocker_show_all: tab %p", tab)

    g_slist_foreach (tab->priv->hidden_popups,
             (GFunc) popups_manager_show, tab);
    g_slist_free (tab->priv->hidden_popups);
    tab->priv->hidden_popups = NULL;

    g_object_notify (G_OBJECT (tab), "hidden-popup-count");
}

static char *
popups_manager_new_window_info (EphyWindow *window)
{
    EphyEmbedChrome chrome;
    char *features;
    int w, h;

    g_object_get (window, "chrome", &chrome, NULL);
    gtk_window_get_size (GTK_WINDOW (window), &w, &h);

    features = g_strdup_printf
        ("width=%d,height=%d,menubar=%d,status=%d,toolbar=%d",
         w, h,
         (chrome & EPHY_EMBED_CHROME_MENUBAR) > 0,
         (chrome & EPHY_EMBED_CHROME_STATUSBAR) > 0,
         (chrome & EPHY_EMBED_CHROME_TOOLBAR) > 0);

    return features;
}

static void
popups_manager_hide (EphyWindow *window,
             EphyTab *parent_tab)
{
    EphyEmbed *embed;
    char *location;
    char *features;

    embed = ephy_window_get_active_embed (window);
    g_return_if_fail (EPHY_IS_EMBED (embed));

    location = ephy_embed_get_location (embed, TRUE);
    if (location == NULL) return;

    features = popups_manager_new_window_info (window);

    popups_manager_add (parent_tab, location, features);

    gtk_widget_destroy (GTK_WIDGET (window));

    g_free (location);
    g_free (features);
}

static void
popups_manager_hide_all (EphyTab *tab)
{
    LOG ("popup_blocker_hide_all: tab %p", tab)

    g_slist_foreach (tab->priv->shown_popups,
             (GFunc) popups_manager_hide, tab);
    g_slist_free (tab->priv->shown_popups);
    tab->priv->shown_popups = NULL;
}

static void
ephy_tab_set_popups_allowed (EphyTab *tab,
                 gboolean allowed)
{
    char *location;
    EphyEmbed *embed;
    EphyPermissionManager *manager;
    EphyPermission permission;

    g_return_if_fail (EPHY_IS_TAB (tab));

    embed = ephy_tab_get_embed (tab);

    location = ephy_embed_get_location (embed, TRUE);
    g_return_if_fail (location != NULL);

    manager = EPHY_PERMISSION_MANAGER
        (ephy_embed_shell_get_embed_single (embed_shell));
    g_return_if_fail (EPHY_IS_PERMISSION_MANAGER (manager));

    permission = allowed ? EPHY_PERMISSION_ALLOWED
                 : EPHY_PERMISSION_DENIED;

    ephy_permission_manager_add (manager, location, EPT_POPUP, permission);

    if (allowed)
    {
        popups_manager_show_all (tab);
    }
    else
    {
        popups_manager_hide_all (tab);
    }

    g_free (location);
}

static guint
popup_blocker_n_hidden (EphyTab *tab)
{
    return g_slist_length (tab->priv->hidden_popups);
}

static void
popups_manager_reset (EphyTab *tab)
{
    g_return_if_fail (EPHY_IS_TAB (tab));

    g_slist_foreach (tab->priv->hidden_popups,
             (GFunc) popups_manager_free_info, NULL);
    g_slist_free (tab->priv->hidden_popups);
    tab->priv->hidden_popups = NULL;

    g_slist_foreach (tab->priv->shown_popups,
             (GFunc) disconnect_popup, tab);
    g_slist_free (tab->priv->shown_popups);
    tab->priv->shown_popups = NULL;

    g_object_notify (G_OBJECT (tab), "hidden-popup-count");
}

static void
ephy_tab_finalize (GObject *object)
{
        EphyTab *tab = EPHY_TAB (object);

    g_idle_remove_by_data (tab);

    if (tab->priv->action != NULL)
    {
        g_object_unref (tab->priv->action);
    }

    g_free (tab->priv->title);
    g_free (tab->priv->address);
    g_free (tab->priv->icon_address);
    g_free (tab->priv->link_message);
    g_free (tab->priv->status_message);
    popups_manager_reset (tab);

    G_OBJECT_CLASS (parent_class)->finalize (object);

    LOG ("EphyTab finalized %p", tab)
}

static gboolean
address_has_web_scheme (const char *address)
{
    gboolean has_web_scheme;

    if (address == NULL) return FALSE;

    has_web_scheme = (g_str_has_prefix (address, "http:") ||
              g_str_has_prefix (address, "https:") ||
              g_str_has_prefix (address, "ftp:") ||
              g_str_has_prefix (address, "file:") ||
              g_str_has_prefix (address, "data:") ||
              g_str_has_prefix (address, "about:") ||
              g_str_has_prefix (address, "gopher:"));

    return has_web_scheme;
}

/* Public functions */

/**
 * ephy_tab_new:
 *
 * Equivalent to g_object_new(), but returns an #EphyTab so you don't have to
 * cast it.
 *
 * Returns: a new #EphyTab
 **/
EphyTab *
ephy_tab_new (void)
{
    return EPHY_TAB (g_object_new (EPHY_TYPE_TAB, NULL));
}

static void
ephy_tab_set_load_status (EphyTab *tab, gboolean status)
{
    g_return_if_fail (EPHY_IS_TAB (tab));

    tab->priv->load_status = status;

    g_object_notify (G_OBJECT (tab), "load-status");
}

/**
 * ephy_tab_get_load_status:
 * @tab: an #EphyTab
 *
 * Returns whether the web page in @tab has finished loading. A web page is
 * only finished loading after all images, styles, and other dependencies have
 * been downloaded and rendered.
 *
 * Return value: %TRUE if the page is still loading, %FALSE if complete
 **/
gboolean
ephy_tab_get_load_status (EphyTab *tab)
{
    g_return_val_if_fail (EPHY_IS_TAB (tab), FALSE);

    return tab->priv->load_status;
}

static void
ephy_tab_set_link_message (EphyTab *tab, char *message)
{
    g_return_if_fail (EPHY_IS_TAB (tab));

    g_free (tab->priv->link_message);
    tab->priv->link_message = ephy_string_blank_chr (message);

    g_object_notify (G_OBJECT (tab), "message");
}

/**
 * ephy_tab_get_link_message:
 * @tab: an #EphyTab
 *
 * Returns the message displayed in @tab's #EphyWindow's #EphyStatusbar when
 * the user hovers the mouse over a hyperlink.
 *
 * The message returned has a limited lifetime, and so should be copied with
 * g_strdup() if it must be stored.
 *
 * Listen to the "link_message" signal on the @tab's #EphyEmbed to be notified
 * when the link message changes.
 *
 * Return value: The current link statusbar message
 **/
const char *
ephy_tab_get_link_message (EphyTab *tab)
{
    g_return_val_if_fail (EPHY_IS_TAB (tab), NULL);

    return tab->priv->link_message;
}

/**
 * ephy_tab_get_embed:
 * @tab: an #EphyTab
 *
 * Returns @tab's #EphyEmbed.
 *
 * Return value: @tab's #EphyEmbed
 **/
EphyEmbed *
ephy_tab_get_embed (EphyTab *tab)
{
    g_return_val_if_fail (EPHY_IS_TAB (tab), NULL);

    return EPHY_EMBED (gtk_bin_get_child (GTK_BIN (tab)));
}

/**
 * ephy_tab_for_embed
 * @embed: an #EphyEmbed
 *
 * Returns the #EphyTab which holds @embed.
 *
 * Return value: the #EphyTab which holds @embed
 **/
EphyTab *
ephy_tab_for_embed (EphyEmbed *embed)
{
    GtkWidget *parent;

    g_return_val_if_fail (EPHY_IS_EMBED (embed), NULL);

    parent = GTK_WIDGET (embed)->parent;
    g_return_val_if_fail (parent != NULL, NULL);

    return EPHY_TAB (parent);
}

/**
 * ephy_tab_get_size:
 * @tab: an #EphyTab
 * @width: return location for width, or %NULL
 * @height: return location for height, or %NULL
 *
 * Obtains the size of @tab. This is not guaranteed to be the actual number of
 * pixels occupied by the #EphyTab.
 **/
void
ephy_tab_get_size (EphyTab *tab, int *width, int *height)
{
    g_return_if_fail (EPHY_IS_TAB (tab));

    if (width != NULL)
    {
        *width = tab->priv->width;
    }
    if (height != NULL)
    {
        *height = tab->priv->height;
    }
}

/**
 * ephy_tab_get_visibility:
 * @tab: an #EphyTab
 *
 * FIXME: Nobody really knows what this does. Someone must investigate.
 *
 * Return value; %TRUE if @tab's "visibility" property is set
 **/
gboolean
ephy_tab_get_visibility (EphyTab *tab)
{
    g_return_val_if_fail (EPHY_IS_TAB (tab), FALSE);

    return tab->priv->visibility;
}

static void
ephy_tab_icon_cache_changed_cb (EphyFaviconCache *cache,
                const char *address,
                EphyTab *tab)
{
    g_return_if_fail (address != NULL);

    /* is this for us? */
    if (tab->priv->icon_address != NULL &&
        strcmp (tab->priv->icon_address, address) == 0)
    {
        /* notify */
        g_object_notify (G_OBJECT (tab), "icon");
    }
}

static void
ephy_tab_set_icon_address (EphyTab *tab, const char *address)
{
    EphyBookmarks *eb;
    EphyHistory *history;

    g_return_if_fail (EPHY_IS_TAB (tab));

    g_free (tab->priv->icon_address);

    tab->priv->icon_address = g_strdup (address);

    if (tab->priv->icon_address)
    {
        eb = ephy_shell_get_bookmarks (ephy_shell);
        history = EPHY_HISTORY
            (ephy_embed_shell_get_global_history (embed_shell));
        ephy_bookmarks_set_icon (eb, tab->priv->address,
                         tab->priv->icon_address);
        ephy_history_set_icon (history, tab->priv->address,
                       tab->priv->icon_address);
    }

    g_object_notify (G_OBJECT (tab), "icon");
}

/**
 * ephy_tab_get_icon_address:
 * @tab: an #EphyTab
 *
 * Returns a URL which points to @tab's favicon.
 *
 * Return value: a URL to @tab's favicon
 **/
const char *
ephy_tab_get_icon_address (EphyTab *tab)
{
    g_return_val_if_fail (EPHY_IS_TAB (tab), NULL);

    return tab->priv->icon_address;
}

/* Private callbacks for embed signals */

static void
ephy_tab_favicon_cb (EphyEmbed *embed,
             const char *address,
             EphyTab *tab)
{
    ephy_tab_set_icon_address (tab, address);
}

static void
ephy_tab_link_message_cb (EphyEmbed *embed,
              EphyTab *tab)
{
    ephy_tab_set_link_message (tab, ephy_embed_get_link_message (embed));
}

static void
ephy_tab_address_cb (EphyEmbed *embed, const char *address, EphyTab *tab)
{
    const char *uv_address;

    LOG ("ephy_tab_address_cb tab %p address %s", tab, address)

    /* Do not expose about:blank to the user, an empty address
       bar will do better */
    if (address && strcmp (address, "about:blank") == 0)
    {
        uv_address = "";
    }
    else
    {
        uv_address = address;
    }

    if (tab->priv->address_expire == TAB_ADDRESS_EXPIRE_NOW)
    {
        ephy_tab_set_location (tab, uv_address, TAB_ADDRESS_EXPIRE_NOW);
    }

    ephy_tab_set_link_message (tab, NULL);
    ephy_tab_set_icon_address (tab, NULL);
    ephy_tab_update_navigation_flags (tab, embed);
}

static void
ephy_tab_content_change_cb (EphyEmbed *embed, const char *address, EphyTab *tab)
{
    /* restore zoom level */
    if (address_has_web_scheme (address))
    {
        EphyHistory *history;
        EphyNode *host;
        GValue value = { 0, };
        float zoom = 1.0, current_zoom;

        history = EPHY_HISTORY
            (ephy_embed_shell_get_global_history (embed_shell));
        host = ephy_history_get_host (history, address);

        if (host != NULL && ephy_node_get_property
                     (host, EPHY_NODE_HOST_PROP_ZOOM, &value))
        {
            zoom = g_value_get_float (&value);
            g_value_unset (&value);
        }

        current_zoom = ephy_embed_get_zoom (embed);
        if (zoom != current_zoom)
        {
            tab->priv->setting_zoom = TRUE;
            ephy_embed_set_zoom (embed, zoom);
            tab->priv->setting_zoom = FALSE;
        }
    }

    popups_manager_reset (tab);
    g_object_notify (G_OBJECT (tab), "popups-allowed");
}

static void
ephy_tab_zoom_changed_cb (EphyEmbed *embed, float zoom, EphyTab *tab)
{
    char *address;

    LOG ("ephy_tab_zoom_changed_cb tab %p zoom %f", tab, zoom)

    ephy_tab_set_zoom (tab, zoom);

    if (tab->priv->setting_zoom)
    {
        return;
    }

    address = ephy_embed_get_location (embed, TRUE);
    if (address_has_web_scheme (address))
    {
        EphyHistory *history;
        EphyNode *host;
        GValue value = { 0, };
        history = EPHY_HISTORY
            (ephy_embed_shell_get_global_history (embed_shell));
        host = ephy_history_get_host (history, address);

        if (host != NULL)
        {
            float zoom;

            zoom = ephy_embed_get_zoom (embed);

            g_value_init (&value, G_TYPE_FLOAT);
            g_value_set_float (&value, zoom);
            ephy_node_set_property
                (host, EPHY_NODE_HOST_PROP_ZOOM, &value);
            g_value_unset (&value);
        }
    }

    g_free (address);
}

static void
ephy_tab_title_cb (EphyEmbed *embed, EphyTab *tab)
{
    char *title;

    title = ephy_embed_get_title (embed);

    ephy_tab_set_title (tab, embed, title);

    g_free (title);
}

static int
build_load_percent (int requests_done, int requests_total)
{
    int percent= 0;

    if (requests_total > 0)
    {
        percent = (requests_done * 100) / requests_total;

        /* Mozilla sometimes report more done requests than
           total requests. Their progress widget clamp the value */
        percent = CLAMP (percent, 0, 100);
    }

    return percent;
}

static void
update_net_state_message (EphyTab *tab, const char *uri, EmbedState flags)
{
    GnomeVFSURI *vfs_uri = NULL;
    const char *msg = NULL;
    const char *host = NULL;

    if (uri != NULL)
    {
        vfs_uri = gnome_vfs_uri_new (uri);
    }

    if (vfs_uri != NULL)
    {
        host = gnome_vfs_uri_get_host_name (vfs_uri);
    }

    if (host == NULL || host[0] == '\0') goto out;

    /* IS_REQUEST and IS_NETWORK can be both set */
    if (flags & EMBED_STATE_IS_REQUEST)
    {
        if (flags & EMBED_STATE_REDIRECTING)
        {
            msg = _("Redirecting to %s...");
        }
        else if (flags & EMBED_STATE_TRANSFERRING)
        {
            msg = _("Transferring data from %s...");
        }
        else if (flags & EMBED_STATE_NEGOTIATING)
        {
            msg = _("Waiting for authorization from %s...");
        }
    }

    if (flags & EMBED_STATE_IS_NETWORK)
    {
        if (flags & EMBED_STATE_START)
        {
            msg = _("Loading %s...");
        }
    }

    if ((flags & EMBED_STATE_IS_NETWORK) &&
        (flags & EMBED_STATE_STOP))
    {
        g_free (tab->priv->status_message);
        tab->priv->status_message = NULL;
        g_object_notify (G_OBJECT (tab), "message");

    }
    else if (msg != NULL)
    {
        g_free (tab->priv->status_message);
        tab->priv->status_message = g_strdup_printf (msg, host);
        g_object_notify (G_OBJECT (tab), "message");
    }

out:
    if (vfs_uri != NULL)
    {
        gnome_vfs_uri_unref (vfs_uri);
    }
}

static void
build_progress_from_requests (EphyTab *tab, EmbedState state)
{
    int load_percent;

    if (state & EMBED_STATE_IS_REQUEST)
        {
                if (state & EMBED_STATE_START)
                {
            tab->priv->total_requests ++;
        }
        else if (state & EMBED_STATE_STOP)
        {
            tab->priv->cur_requests ++;
        }

        load_percent = build_load_percent (tab->priv->cur_requests,
                           tab->priv->total_requests);

        ephy_tab_set_load_percent (tab, load_percent);
    }
}

static void
ensure_page_info (EphyTab *tab, EphyEmbed *embed, const char *address)
{
    if ((tab->priv->address == NULL || *tab->priv->address == '\0') &&
        tab->priv->address_expire == TAB_ADDRESS_EXPIRE_NOW)
        {
        ephy_tab_set_location (tab, address, TAB_ADDRESS_EXPIRE_NOW);
    }

    if (tab->priv->title == NULL)
    {
        ephy_tab_set_title (tab, embed, NULL);
    }
}

static void
ephy_tab_net_state_cb (EphyEmbed *embed, const char *uri,
               EmbedState state, EphyTab *tab)
{
    update_net_state_message (tab, uri, state);

    if (state & EMBED_STATE_IS_NETWORK)
    {
        if (state & EMBED_STATE_START)
        {
            tab->priv->total_requests = 0;
            tab->priv->cur_requests = 0;
            ensure_page_info (tab, embed, uri);

            ephy_tab_set_load_percent (tab, 0);
            ephy_tab_set_load_status (tab, TRUE);
            ephy_tab_update_navigation_flags (tab, embed);
        }
        else if (state & EMBED_STATE_STOP)
        {
            ephy_tab_set_load_percent (tab, 100);
            ephy_tab_set_load_status (tab, FALSE);
            ephy_tab_update_navigation_flags (tab, embed);
            tab->priv->address_expire = TAB_ADDRESS_EXPIRE_NOW;
        }
    }

    build_progress_from_requests (tab, state);
}

static void
ephy_tab_new_window_cb (EphyEmbed *embed, EphyEmbed **new_embed,
            EphyEmbedChrome chromemask, EphyTab *tab)
{
    EphyTab *new_tab;
    EphyWindow *window;

    LOG ("ephy_tab_new_window_cb tab %p with parent %p chrome %d",
         tab, ((GtkWidget *) tab)->parent, chromemask)

    if (eel_gconf_get_boolean (CONF_LOCKDOWN_DISABLE_JAVASCRIPT_CHROME))
    {
        window = ephy_window_new ();
    }
    else
    {
        window = ephy_window_new_with_chrome (chromemask);
    }

    new_tab = ephy_tab_new ();
    gtk_widget_show (GTK_WIDGET (new_tab));

        ephy_window_add_tab (window, new_tab, -1, FALSE);

    *new_embed = ephy_tab_get_embed (new_tab);

    popups_manager_add_window (tab, window);
}

static void
ephy_tab_popup_blocked_cb (EphyEmbed *embed, const char *url,
               const char *features, EphyTab *tab)
{
    popups_manager_add (tab, url, features);
}

static gboolean
let_me_resize_hack (GtkWidget *tab)
{
    gtk_widget_set_size_request (tab, -1, -1);

    return FALSE;
}

static void
ephy_tab_visibility_cb (EphyEmbed *embed, gboolean visibility,
            EphyTab *tab)
{
    LOG ("ephy_tab_visibility_cb tab %p visibility %d",
         tab, visibility)

    if (visibility)
    {
        gtk_widget_show (GTK_WIDGET (tab));
    }
    else
    {
        gtk_widget_hide (GTK_WIDGET (tab));
    }

    tab->priv->visibility = visibility;

    g_object_notify (G_OBJECT (tab), "visible");
}

static void
ephy_tab_destroy_brsr_cb (EphyEmbed *embed, EphyTab *tab)
{
    EphyWindow *window;
    GtkWidget *notebook;

    g_return_if_fail (EPHY_IS_TAB (tab));

    LOG ("ephy_tab_destroy_browser_cb tab %p parent %p",
         tab, ((GtkWidget *) tab)->parent)

    window = ephy_tab_get_window (tab);
    g_return_if_fail (window != NULL);

    /* Do not use ephy_window_remove_tab because it will
       check for unsubmitted forms */
    notebook = ephy_window_get_notebook (window);
    ephy_notebook_remove_tab (EPHY_NOTEBOOK (notebook), tab);
}

static void
ephy_tab_size_to_cb (EphyEmbed *embed, gint width, gint height,
             EphyTab *tab)
{
    GtkWidget *notebook;
    EphyWindow *window;

    LOG ("ephy_tab_size_to_cb tab %p width %d height %d", tab, width, height)

    tab->priv->width = width;
    tab->priv->height = height;

    window = ephy_tab_get_window (tab);
    notebook = ephy_window_get_notebook (window);

    /* Do not resize window with multiple tabs.
     * Do not resize window already showed because
     * it's not possible to calculate a sensible window
     * size based on the embed size */
    if (gtk_notebook_get_n_pages (GTK_NOTEBOOK (notebook)) == 1 &&
        !tab->priv->visibility)
    {
        gtk_widget_set_size_request
            (GTK_WIDGET (tab), width, height);

        /* HACK reset widget requisition after the container
         * has been resized. It appears to be the only way
         * to have the window sized according to embed
         * size correctly.
         */

        g_idle_add ((GSourceFunc) let_me_resize_hack, tab);
    }
}

static gboolean
open_link_in_new_tab (EphyTab *tab,
              const char *link_address)
{
    EphyWindow *window;
    gboolean new_tab;

    window = ephy_tab_get_window (tab);
    g_return_val_if_fail (window != NULL, FALSE);

    new_tab = address_has_web_scheme (link_address);

    if (new_tab)
    {
        ephy_shell_new_tab (ephy_shell, window, tab,
                    link_address,
                    EPHY_NEW_TAB_OPEN_PAGE |
                    EPHY_NEW_TAB_IN_EXISTING_WINDOW);
    }

    return new_tab;
}

static void
save_property_url (EphyEmbed *embed,
           EphyEmbedEvent *event,
           const char *property,
           const char *key)
{
    const char *location;
    const GValue *value;
    EphyEmbedPersist *persist;

    ephy_embed_event_get_property (event, property, &value);
    location = g_value_get_string (value);

    persist = EPHY_EMBED_PERSIST
        (ephy_embed_factory_new_object (EPHY_TYPE_EMBED_PERSIST));

    ephy_embed_persist_set_embed (persist, embed);
    ephy_embed_persist_set_flags (persist, 0);
    ephy_embed_persist_set_persist_key (persist, key);
    ephy_embed_persist_set_source (persist, location);

    ephy_embed_persist_save (persist);

    g_object_unref (G_OBJECT(persist));
}

static void
clipboard_text_received_cb (GtkClipboard *clipboard,
                const char *text,
                gpointer *weak_ptr)
{
    if (*weak_ptr != NULL && text != NULL)
    {
        EphyEmbed *embed = (EphyEmbed *) *weak_ptr;

        ephy_embed_load_url (embed, text);
    }

    if (*weak_ptr != NULL)
    {
        g_object_remove_weak_pointer (G_OBJECT (*weak_ptr), weak_ptr);
    }

    g_free (weak_ptr);
}

static gboolean
ephy_tab_dom_mouse_click_cb (EphyEmbed *embed,
                 EphyEmbedEvent *event,
                 EphyTab *tab)
{
    EphyEmbedEventType type;
    EmbedEventContext context;
    guint modifier;
    gboolean handled = TRUE;
    gboolean with_control, with_shift, is_left_click, is_middle_click;
    gboolean is_link, is_image, is_middle_clickable;
    gboolean middle_click_opens;
    gboolean is_input;

    g_return_val_if_fail (EPHY_IS_EMBED_EVENT(event), FALSE);

    type = ephy_embed_event_get_event_type (event);
    context = ephy_embed_event_get_context (event);
    modifier = ephy_embed_event_get_modifier (event);

    LOG ("ephy_tab_dom_mouse_click_cb: type %d, context %x, modifier %x",
         type, context, modifier)

    with_control = (modifier & GDK_CONTROL_MASK) != 0;
    with_shift = (modifier & GDK_SHIFT_MASK) != 0;
    is_left_click = (type == EPHY_EMBED_EVENT_MOUSE_BUTTON1);
    is_middle_click = (type == EPHY_EMBED_EVENT_MOUSE_BUTTON2);

    middle_click_opens =
        eel_gconf_get_boolean (CONF_INTERFACE_MIDDLE_CLICK_OPEN_URL) &&
        !eel_gconf_get_boolean (CONF_LOCKDOWN_DISABLE_ARBITRARY_URL);

    is_link = (context & EMBED_CONTEXT_LINK) != 0;
    is_image = (context & EMBED_CONTEXT_IMAGE) != 0;
    is_middle_clickable = !((context & EMBED_CONTEXT_LINK)
                || (context & EMBED_CONTEXT_INPUT)
                || (context & EMBED_CONTEXT_EMAIL_LINK));
    is_input = (context & EMBED_CONTEXT_INPUT) != 0;

    /* ctrl+click or middle click opens the link in new tab */
    if (is_link && ((is_left_click && with_control) || is_middle_click))
    {
        const GValue *value;
        const char *link_address;

        ephy_embed_event_get_property (event, "link", &value);
        link_address = g_value_get_string (value);
        handled = open_link_in_new_tab (tab, link_address);
    }
    /* shift+click saves the link target */
    else if (is_link && is_left_click && with_shift)
    {
        save_property_url (embed, event, "link", CONF_STATE_SAVE_DIR);
    }
    /* shift+click saves the non-link image
     * Note: pressing enter to submit a form synthesizes a mouse click event
     */
    else if (is_image && is_left_click && with_shift && !is_input)
    {
        save_property_url (embed, event, "image", CONF_STATE_SAVE_IMAGE_DIR);
    }
    /* middle click opens the selection url */
    else if (is_middle_clickable && is_middle_click && middle_click_opens)
    {
        /* See bug #133633 for why we do it this way */

        /* We need to make sure we know if the embed is destroyed between
         * requesting the clipboard contents, and receiving them.
         */
        gpointer *weak_ptr;

        weak_ptr = g_new (gpointer, 1);
        *weak_ptr = embed;
        g_object_add_weak_pointer (G_OBJECT (embed), weak_ptr);

        gtk_clipboard_request_text
            (gtk_widget_get_clipboard (GTK_WIDGET (embed),
                           GDK_SELECTION_PRIMARY),
             (GtkClipboardTextReceivedFunc) clipboard_text_received_cb,
             weak_ptr);
    }
    /* we didn't handle the event */
    else
    {
        handled = FALSE;
    }

    return handled;
}

static void
ephy_tab_security_change_cb (EphyEmbed *embed, EmbedSecurityLevel level,
                   EphyTab *tab)
{
    ephy_tab_set_security_level (tab, level);
}

static void
ephy_tab_init (EphyTab *tab)
{
    GObject *embed;
    EphyFaviconCache *cache;
    char *id;

    LOG ("EphyTab initialising %p", tab)

    tab->priv = EPHY_TAB_GET_PRIVATE (tab);

    tab->priv->total_requests = 0;
    tab->priv->cur_requests = 0;
    tab->priv->width = -1;
    tab->priv->height = -1;
    tab->priv->load_percent = 0;
    tab->priv->load_status = FALSE;
    tab->priv->security_level = STATE_IS_UNKNOWN;
    tab->priv->zoom = 1.0;
    tab->priv->address_expire = TAB_ADDRESS_EXPIRE_NOW;

    embed = ephy_embed_factory_new_object (EPHY_TYPE_EMBED);
    g_assert (embed != NULL);

    gtk_container_add (GTK_CONTAINER (tab), GTK_WIDGET (embed));
    gtk_widget_show (GTK_WIDGET (embed));

    id = g_strdup_printf ("Tab%lu", tab_id++);

    tab->priv->action = g_object_new (GTK_TYPE_TOGGLE_ACTION,
                      "name", id,
                      "label", _("Blank page"),
                      "draw_as_radio", TRUE,
                      NULL);

    g_free (id);
    g_signal_connect (tab->priv->action, "activate",
              G_CALLBACK (ephy_tab_action_activate_cb), tab);

    g_signal_connect_object (embed, "link_message",
                 G_CALLBACK (ephy_tab_link_message_cb),
                 tab, 0);
    g_signal_connect_object (embed, "ge_location",
                 G_CALLBACK (ephy_tab_address_cb),
                 tab, 0);
    g_signal_connect_object (embed, "title",
                 G_CALLBACK (ephy_tab_title_cb),
                 tab, 0);
    g_signal_connect_object (embed, "ge_zoom_change",
                 G_CALLBACK (ephy_tab_zoom_changed_cb),
                 tab, 0);
    g_signal_connect_object (embed, "ge_net_state",
                 G_CALLBACK (ephy_tab_net_state_cb),
                 tab, 0);
    g_signal_connect_object (embed, "ge_new_window",
                 G_CALLBACK (ephy_tab_new_window_cb),
                 tab, 0);
    g_signal_connect_object (embed, "ge_popup_blocked",
                 G_CALLBACK (ephy_tab_popup_blocked_cb),
                 tab, 0);
    g_signal_connect_object (embed, "visibility",
                 G_CALLBACK (ephy_tab_visibility_cb),
                 tab, 0);
    g_signal_connect_object (embed, "destroy_browser",
                 G_CALLBACK (ephy_tab_destroy_brsr_cb),
                 tab, 0);
    g_signal_connect_object (embed, "size_to",
                 G_CALLBACK (ephy_tab_size_to_cb),
                 tab, 0);
    g_signal_connect_object (embed, "ge_dom_mouse_click",
                 G_CALLBACK (ephy_tab_dom_mouse_click_cb),
                 tab, 0);
    g_signal_connect_object (embed, "ge_security_change",
                 G_CALLBACK (ephy_tab_security_change_cb),
                 tab, 0);
    g_signal_connect_object (embed, "ge_favicon",
                 G_CALLBACK (ephy_tab_favicon_cb),
                 tab, 0);
    g_signal_connect_object (embed, "ge_content_change",
                 G_CALLBACK (ephy_tab_content_change_cb),
                 tab, 0);

    cache = EPHY_FAVICON_CACHE
        (ephy_embed_shell_get_favicon_cache (EPHY_EMBED_SHELL (ephy_shell)));
    g_signal_connect_object (G_OBJECT (cache), "changed",
                 G_CALLBACK (ephy_tab_icon_cache_changed_cb),
                 tab,  0);
}

/**
 * ephy_tab_set_load_percent:
 * @tab: an #EphyTab
 * @percent: a percentage, from 0 to 100.
 *
 * Sets the load percentage. This will be displayed in the progressbar.
 **/
void
ephy_tab_set_load_percent (EphyTab *tab, int percent)
{
    g_return_if_fail (EPHY_IS_TAB (tab));

    if (percent != tab->priv->load_percent)
    {
        tab->priv->load_percent = percent;

        g_object_notify (G_OBJECT (tab), "load-progress");
    }
}

/**
 * ephy_tab_get_load_percent:
 * @tab: an #EphyTab
 *
 * Returns the page load percentage (displayed in the progressbar).
 *
 * Return value: a percentage from 0 to 100.
 **/
int
ephy_tab_get_load_percent (EphyTab *tab)
{
    g_return_val_if_fail (EPHY_IS_TAB (tab), 0);

    return tab->priv->load_percent;
}

static void
ephy_tab_update_navigation_flags (EphyTab *tab, EphyEmbed *embed)
{
    TabNavigationFlags flags = 0;

    if (ephy_embed_can_go_up (embed))
    {
        flags |= TAB_NAV_UP;
    }

    if (ephy_embed_can_go_back (embed))
    {
        flags |= TAB_NAV_BACK;
    }

    if (ephy_embed_can_go_forward (embed))
    {
        flags |= TAB_NAV_FORWARD;
    }

    if (flags != tab->priv->nav_flags)
    {
        tab->priv->nav_flags = flags;

        g_object_notify (G_OBJECT (tab), "navigation");
    }
}

/**
 * ephy_tab_get_navigation_flags:
 * @tab: an #EphyTab
 *
 * Returns @tab's navigation flags.
 *
 * Return value: @tab's navigation flags
 **/
TabNavigationFlags
ephy_tab_get_navigation_flags (EphyTab *tab)
{
    g_return_val_if_fail (EPHY_IS_TAB (tab), 0);

    return tab->priv->nav_flags;
}

/**
 * ephy_tab_get_status_message:
 * @tab: an #EphyTab
 *
 * Returns the message displayed in @tab's #EphyWindow's #EphyStatusbar. If the
 * user is hovering the mouse over a hyperlink, this function will return the
 * same value as ephy_tab_get_link_message(). Otherwise, it will return a
 * network status message, or NULL.
 *
 * The message returned has a limited lifetime, and so should be copied with
 * g_strdup() if it must be stored.
 *
 * Listen to "notify::message" to be notified when the message property changes.
 *
 * Return value: The current statusbar message
 **/
const char *
ephy_tab_get_status_message (EphyTab *tab)
{
    g_return_val_if_fail (EPHY_IS_TAB (tab), NULL);

    if (tab->priv->link_message && tab->priv->link_message[0] != '\0')
    {
        return tab->priv->link_message;
    }
    else if (tab->priv->status_message)
    {
        return tab->priv->status_message;
    }
    else
    {
        return NULL;
    }
}

#define MAX_LABEL_LENGTH    32

static void
ephy_tab_set_title (EphyTab *tab, EphyEmbed *embed, const char *new_title)
{
    char *title = NULL;

    g_return_if_fail (EPHY_IS_TAB (tab));

    g_free (tab->priv->title);

    if (new_title == NULL || new_title[0] == '\0')
    {
        GnomeVFSURI *uri = NULL;
        char *address;

        address = ephy_embed_get_location (embed, TRUE);

        if (address)
        {
            uri = gnome_vfs_uri_new (address);
        }

        if (uri)
        {
            title = gnome_vfs_uri_to_string (uri,
                    GNOME_VFS_URI_HIDE_USER_NAME |
                    GNOME_VFS_URI_HIDE_PASSWORD |
                    GNOME_VFS_URI_HIDE_HOST_PORT |
                    GNOME_VFS_URI_HIDE_TOPLEVEL_METHOD |
                    GNOME_VFS_URI_HIDE_FRAGMENT_IDENTIFIER);
            gnome_vfs_uri_unref (uri);
        }
        else if (address != NULL && strncmp (address, "about:blank", 11) != 0)
        {
            title = g_strdup (address);
        }

        if (title == NULL || title[0] == '\0')
        {
            g_free (title);
            title = g_strdup (_("Blank page"));
        }

        g_free (address);
    }
    else
    {
        title = g_strdup (new_title);
    }

    tab->priv->title = title;

    g_object_set (G_OBJECT (tab->priv->action),
              "label", title,
              NULL);

    g_object_notify (G_OBJECT (tab), "title");
}

/**
 * ephy_tab_get_title:
 * @tab: an #EphyTab
 *
 * Returns the title of the web page loaded in @tab.
 *
 * Return value: @tab's loaded web page's title
 **/
const char *
ephy_tab_get_title (EphyTab *tab)
{
    g_return_val_if_fail (EPHY_IS_TAB (tab), "");

    return tab->priv->title;
}

/**
 * ephy_tab_get_location:
 * @tab: an #EphyTab
 *
 * Returns the text that @tab's #EphyWindow will display in its location toolbar
 * entry when @tab is selected.
 *
 * This is not guaranteed to be the same as @tab's #EphyEmbed's location,
 * available through ephy_embed_get_location(). As the user types a new address
 * into the location entry, ephy_tab_get_location()'s returned string will
 * change.
 *
 * Return value: @tab's #EphyWindow's location entry when @tab is selected
 **/
const char *
ephy_tab_get_location (EphyTab *tab)
{
    g_return_val_if_fail (EPHY_IS_TAB (tab), "");

    return tab->priv->address;
}

/**
 * ephy_tab_set_location:
 * @tab: an #EphyTab
 * @address: a string (ideally a URL)
 * @expire: beats me
 *
 * DO NOT USE
 */
void
ephy_tab_set_location (EphyTab *tab,
               const char *address,
               TabAddressExpire expire)
{
    g_return_if_fail (EPHY_IS_TAB (tab));

    if (tab->priv->address) g_free (tab->priv->address);
    tab->priv->address = g_strdup (address);

    if (expire == TAB_ADDRESS_EXPIRE_CURRENT &&
        !tab->priv->load_status)
    {
        tab->priv->address_expire = TAB_ADDRESS_EXPIRE_NOW;
    }
    else
    {
        tab->priv->address_expire = expire;
    }

    g_object_notify (G_OBJECT (tab), "address");
}

static void
ephy_tab_set_security_level (EphyTab *tab, EmbedSecurityLevel level)
{
    g_return_if_fail (EPHY_IS_TAB (tab));

    tab->priv->security_level = level;

    g_object_notify (G_OBJECT (tab), "security-level");
}

/**
 * ephy_tab_get_security_level:
 * @tab: an #EphyTab
 *
 * Returns the security level of the webpage loaded in @tab.
 *
 * Return value: @tab's loaded page's security level
 **/
EmbedSecurityLevel
ephy_tab_get_security_level (EphyTab *tab)
{
    g_return_val_if_fail (EPHY_IS_TAB (tab), STATE_IS_UNKNOWN);

    return tab->priv->security_level;
}

static void
ephy_tab_set_zoom (EphyTab *tab, float zoom)
{
    g_return_if_fail (EPHY_IS_TAB (tab));

    tab->priv->zoom = zoom;

    g_object_notify (G_OBJECT (tab), "zoom");
}

/**
 * ephy_tab_get_zoom:
 * @tab: an #EphyTab
 *
 * Returns the zoom level of the web page loaded in @tab. A return value of
 * 1.0 corresponds to 100% zoom (normal size).
 *
 * Return value: @tab's loaded page's zoom level
 **/
float
ephy_tab_get_zoom (EphyTab *tab)
{
    g_return_val_if_fail (EPHY_IS_TAB (tab), 1.0);

    return tab->priv->zoom;
}

/**
 * ephy_tab_get_action:
 * @tab: an #EphyTab
 *
 * DO NOT USE
 *
 * Returns the #GtkToggleAction represented by the labelled tab displayed at the
 * top of @tab's #EphyWindow when multiple tabs are loaded. Activating this
 * action will switch the window to display @tab.
 *
 * Return value: @tab's #GtkToggleAction
 **/
GObject *
ephy_tab_get_action (EphyTab *tab)
{
    g_return_val_if_fail (EPHY_IS_TAB (tab), NULL);

    return G_OBJECT (tab->priv->action);
}