src/ring_client.cpp

/*
 *  Copyright (C) 2015 Savoir-Faire Linux Inc.
 *  Author: Stepan Salenikovich <stepan.salenikovich@savoirfairelinux.com>
 *
 *  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 3 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  If you modify this program, or any covered work, by linking or
 *  combining it with the OpenSSL project's OpenSSL library (or a
 *  modified version of that library), containing parts covered by the
 *  terms of the OpenSSL or SSLeay licenses, Savoir-Faire Linux Inc.
 *  grants you additional permission to convey the resulting work.
 *  Corresponding Source for a non-source form of such a combination
 *  shall include the source code for the parts of OpenSSL used as well
 *  as that of the covered work.
 */

#include "ring_client.h"

#include <gtk/gtk.h>
#include <glib/gi18n.h>
#include <QtCore/QCoreApplication>
#include <QtCore/QString>
#include <QtCore/QByteArray>
#include <callmodel.h>
#include <QtCore/QItemSelectionModel>
#include <useractionmodel.h>
#include <clutter-gtk/clutter-gtk.h>
#include <categorizedhistorymodel.h>

#include "ring_client_options.h"
#include "ringmainwindow.h"
#include "backends/minimalhistorybackend.h"

struct _RingClientClass
{
  GtkApplicationClass parent_class;
};

struct _RingClient
{
    GtkApplication parent;
};

typedef struct _RingClientPrivate RingClientPrivate;

struct _RingClientPrivate {
    /* main window */
    GtkWidget        *win;
    /* for libRingclient */
    QCoreApplication *qtapp;
};

G_DEFINE_TYPE_WITH_PRIVATE(RingClient, ring_client, GTK_TYPE_APPLICATION);

#define RING_CLIENT_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), RING_CLIENT_TYPE, RingClientPrivate))

static void
init_exception_dialog(const char* msg)
{
    g_warning("%s", msg);
    GtkWidget *dialog = gtk_message_dialog_new(NULL,
                            (GtkDialogFlags)(GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT),
                            GTK_MESSAGE_ERROR, GTK_BUTTONS_CLOSE,
                            _("Unable to initialize.\nMake sure the Ring daemon (dring) is running.\nError: %s"),
                            msg);

    gtk_window_set_title(GTK_WINDOW(dialog), _("Ring Error"));
    gtk_dialog_run(GTK_DIALOG(dialog));
    gtk_widget_destroy(dialog);
}

static int
ring_client_command_line(GApplication *app, GApplicationCommandLine *cmdline)
{
    RingClient *client = RING_CLIENT(app);
    RingClientPrivate *priv = RING_CLIENT_GET_PRIVATE(client);

    gint argc;
    gchar **argv = g_application_command_line_get_arguments(cmdline, &argc);
    GOptionContext *context = ring_client_options_get_context();
    GError *error = NULL;
    if (g_option_context_parse(context, &argc, &argv, &error) == FALSE) {
        g_print(_("%s\nRun '%s --help' to see a full list of available command line options.\n"),
                error->message, argv[0]);
        g_error_free(error);
        g_option_context_free(context);
        return 1;
    }
    g_option_context_free(context);

    /* init clutter */
    int clutter_error;
    if ((clutter_error = gtk_clutter_init(&argc, &argv)) != CLUTTER_INIT_SUCCESS) {
        g_critical("Could not init clutter : %d\n", clutter_error);
        return 1;
    }

    /* init libRingClient and make sure its connected to the dbus */
    try {
        /* TODO: do we care about passing the cmd line arguments here? */
        priv->qtapp = new QCoreApplication(argc, argv);
        /* the call model will try to connect to dring via dbus */
        CallModel::instance();
    } catch (const char * msg) {
        init_exception_dialog(msg);
        return 1;
    } catch(QString& msg) {
        QByteArray ba = msg.toLocal8Bit();
        const char *c_str = ba.data();
        init_exception_dialog(c_str);
        return 1;
    }

    /* add backends */
    CategorizedHistoryModel::instance()->addCollection<MinimalHistoryBackend>(LoadOptions::FORCE_ENABLED);

    /* Override theme since we don't have appropriate icons for a dark them (yet) */
    GtkSettings *gtk_settings = gtk_settings_get_default();
    g_object_set(G_OBJECT(gtk_settings), "gtk-application-prefer-dark-theme",
                 FALSE, NULL);
    /* enable button icons */
    g_object_set(G_OBJECT(gtk_settings), "gtk-button-images",
                 TRUE, NULL);

    /* create an empty window */
    if (priv->win == NULL) {
        priv->win = ring_main_window_new(GTK_APPLICATION(app));
    }

    gtk_window_present(GTK_WINDOW(priv->win));

    return 0;
}

static void
call_accept(G_GNUC_UNUSED GSimpleAction *action, G_GNUC_UNUSED GVariant *param, G_GNUC_UNUSED gpointer client)
{
    g_debug("call accpet action");

    /* TODO: implement using UserActionModel once its fixed */

    QModelIndex idx = CallModel::instance()->selectionModel()->currentIndex();
    if (idx.isValid()) {
        Call *call = CallModel::instance()->getCall(idx);
        call->performAction(Call::Action::ACCEPT);
    }
}

static void
call_hangup(G_GNUC_UNUSED GSimpleAction *action, G_GNUC_UNUSED GVariant *param, G_GNUC_UNUSED gpointer client)
{
    g_debug("call hangup action");

    /* TODO: implement using UserActionModel once its fixed */

    QModelIndex idx = CallModel::instance()->selectionModel()->currentIndex();
    if (idx.isValid()) {
        Call *call = CallModel::instance()->getCall(idx);
        call->performAction(Call::Action::REFUSE);
    }
}

static void
call_hold(GSimpleAction *action, GVariant *state, G_GNUC_UNUSED gpointer data)
{
    g_debug("call hold action");

    /* TODO: implement using UserActionModel once its fixed */

    /* get the requested state and apply it */
    gboolean requested = g_variant_get_boolean(state);
    g_simple_action_set_state(action, g_variant_new_boolean(requested));

    QModelIndex idx = CallModel::instance()->selectionModel()->currentIndex();
    if (idx.isValid()) {
        Call *call = CallModel::instance()->getCall(idx);
        call->performAction(Call::Action::HOLD);
    }
}

/* starting glib 2.40 the action() parameter in the action entry (the second one)
 * can be left NULL for stateful boolean actions and they will automatically be
 * toggled; for older versions of glib we must explicitly set a handler to toggle them */
#if GLIB_CHECK_VERSION(2,40,0)

static const GActionEntry ring_actions[] =
{
    { "accept",     call_accept, NULL, NULL,    NULL, {0} },
    { "hangup",     call_hangup, NULL, NULL,    NULL, {0} },
    { "hold",       NULL,        NULL, "false", call_hold, {0} },
    /* TODO implement the other actions */
    // { "mute_audio", NULL,        NULL, "false", NULL, {0} },
    // { "mute_video", NULL,        NULL, "false", NULL, {0} },
    // { "transfer",   NULL,        NULL, "flase", NULL, {0} },
    // { "record",     NULL,        NULL, "false", NULL, {0} }
};

#else

/* adapted from glib 2.40, gsimpleaction.c */
static void
g_simple_action_change_state(GSimpleAction *simple, GVariant *value)
{
    GAction *action = G_ACTION(simple);

    guint change_state_id = g_signal_lookup("change-state", G_OBJECT_TYPE(simple));

    /* If the user connected a signal handler then they are responsible
    * for handling state changes.
    */
    if (g_signal_has_handler_pending(action, change_state_id, 0, TRUE))
        g_signal_emit(action, change_state_id, 0, value);

    /* If not, then the default behaviour is to just set the state. */
    else
        g_simple_action_set_state(simple, value);
}

/* define activate handler for simple toggle actions for glib < 2.40
 * adapted from glib 2.40, gsimpleaction.c */
static void
g_simple_action_toggle(GSimpleAction *action, GVariant *parameter, G_GNUC_UNUSED gpointer user_data)
{
    const GVariantType *parameter_type = g_action_get_parameter_type(G_ACTION(action));
    g_return_if_fail(parameter_type == NULL ?
                    parameter == NULL :
                    (parameter != NULL &&
                    g_variant_is_of_type(parameter, parameter_type)));

    if (parameter != NULL)
        g_variant_ref_sink(parameter);

    if (g_action_get_enabled(G_ACTION(action))) {
        /* make sure it is a stateful action and toggle it */
        GVariant *state = g_action_get_state(G_ACTION(action));
        if (state) {
            /* If we have no parameter and this is a boolean action, toggle. */
            if (parameter == NULL && g_variant_is_of_type(state, G_VARIANT_TYPE_BOOLEAN)) {
                gboolean was_enabled = g_variant_get_boolean(state);
                g_simple_action_change_state(action, g_variant_new_boolean(!was_enabled));
            }
            /* else, if the parameter and state type are the same, do a change-state */
            else if (g_variant_is_of_type (state, g_variant_get_type(parameter)))
                g_simple_action_change_state(action, parameter);
        }
        g_variant_unref(state);
    }

    if (parameter != NULL)
        g_variant_unref (parameter);
}

static const GActionEntry ring_actions[] =
{
    { "accept",     call_accept,            NULL, NULL,    NULL, {0} },
    { "hangup",     call_hangup,            NULL, NULL,    NULL, {0} },
    { "hold",       g_simple_action_toggle, NULL, "false", call_hold, {0} },
    /* TODO implement the other actions */
    // { "mute_audio", NULL,        NULL, "false", NULL, {0} },
    // { "mute_video", NULL,        NULL, "false", NULL, {0} },
    // { "transfer",   NULL,        NULL, "flase", NULL, {0} },
    // { "record",     NULL,        NULL, "false", NULL, {0} }
};

#endif

/* TODO: uncomment when UserActionModel is fixed and used
typedef union _int_ptr_t
{
    int value;
    gpointer ptr;
} int_ptr_t;

static void
activate_action(GSimpleAction *action, G_GNUC_UNUSED GVariant *parameter, gpointer user_data)
{
    g_debug("activating action: %s", g_action_get_name(G_ACTION(action)));

    int_ptr_t key;
    key.ptr = user_data;
    UserActionModel::Action a = static_cast<UserActionModel::Action>(key.value);
    UserActionModel* uam = CallModel::instance()->userActionModel();

    uam << a;
}
*/

static void
ring_client_startup(GApplication *app)
{
    G_APPLICATION_CLASS(ring_client_parent_class)->startup(app);

    RingClient *client = RING_CLIENT(app);

    g_action_map_add_action_entries(
        G_ACTION_MAP(app), ring_actions, G_N_ELEMENTS(ring_actions), client);

    /* TODO: Bind actions to the useractionmodel once it is working */
    // UserActionModel* uam = CallModel::instance()->userActionModel();
    // QHash<int, GSimpleAction*> actionHash;
    // actionHash[ (int)UserActionModel::Action::ACCEPT          ] = G_SIMPLE_ACTION(g_action_map_lookup_action(G_ACTION_MAP(app), "accept"));
    // actionHash[ (int)UserActionModel::Action::HOLD            ] = G_SIMPLE_ACTION(g_action_map_lookup_action(G_ACTION_MAP(app), "hold"));
    // // actionHash[ (int)UserActionModel::Action::MUTE_AUDIO      ] = G_SIMPLE_ACTION(g_action_map_lookup_action(G_ACTION_MAP(app), "mute_audio"));
    // // actionHash[ (int)UserActionModel::Action::SERVER_TRANSFER ] = G_SIMPLE_ACTION(g_action_map_lookup_action(G_ACTION_MAP(app), "transfer"));
    // // actionHash[ (int)UserActionModel::Action::RECORD          ] = G_SIMPLE_ACTION(g_action_map_lookup_action(G_ACTION_MAP(app), "record"));
    // actionHash[ (int)UserActionModel::Action::HANGUP          ] = G_SIMPLE_ACTION(g_action_map_lookup_action(G_ACTION_MAP(app), "hangup"));

    // for (QHash<int,GSimpleAction*>::const_iterator i = actionHash.begin(); i != actionHash.end(); ++i) {
    //    GSimpleAction* sa = i.value();
    //    // UserActionModel::Action a = static_cast<UserActionModel::Action>(i.key());
    //    // connect(ea, &QAction::triggered, [uam,a](bool) {uam << a;});
    //    int_ptr_t user_data;
    //    user_data.value = i.key();
    //    g_signal_connect(G_OBJECT(sa), "activate", G_CALLBACK(activate_action), user_data.ptr);

    // }

    // QObject::connect(uam,&UserActionModel::dataChanged, [actionHash,uam](const QModelIndex& tl, const QModelIndex& br) {
    //    const int first(tl.row()),last(br.row());
    //    for(int i = first; i <= last;i++) {
    //       const QModelIndex& idx = uam->index(i,0);
    //       GSimpleAction* sa = actionHash[(int)qvariant_cast<UserActionModel::Action>(idx.data(UserActionModel::Role::ACTION))];
    //       if (sa) {
    //          // a->setText   ( idx.data(Qt::DisplayRole).toString()                 );
    //          // a->setEnabled( idx.flags() & Qt::ItemIsEnabled                      );
    //          g_simple_action_set_enabled(sa, idx.flags() & Qt::ItemIsEnabled);
    //          // a->setChecked( idx.data(Qt::CheckStateRole) == Qt::Checked          );
    //          /* check if statefull action */
    //          if (g_action_get_state_type(G_ACTION(sa)) != NULL)
    //             g_simple_action_set_state(sa, g_variant_new_boolean(idx.data(Qt::CheckStateRole) == Qt::Checked));
    //          // a->setAltIcon( qvariant_cast<QPixmap>(idx.data(Qt::DecorationRole)) );
    //       }
    //    }
    // });
}

static void
ring_client_shutdown(GApplication *app)
{
    RingClient *self = RING_CLIENT(app);
    RingClientPrivate *priv = RING_CLIENT_GET_PRIVATE(self);

    /* free the QCoreApplication, which will destroy all libRingClient models
     * and thus send the Unregister signal over dbus to dring */
    delete priv->qtapp;

    /* Chain up to the parent class */
    G_APPLICATION_CLASS(ring_client_parent_class)->shutdown(app);
}

static void
ring_client_init(RingClient *self)
{
    RingClientPrivate *priv = RING_CLIENT_GET_PRIVATE(self);

    /* init widget */
    priv->win = NULL;
    priv->qtapp = NULL;
}

static void
ring_client_class_init(RingClientClass *klass)
{
    G_APPLICATION_CLASS(klass)->startup = ring_client_startup;
    G_APPLICATION_CLASS(klass)->command_line = ring_client_command_line;
    G_APPLICATION_CLASS(klass)->shutdown = ring_client_shutdown;
}

RingClient *
ring_client_new()
{
    return (RingClient *)g_object_new(ring_client_get_type(),
                                      "application-id", "cx.ring.RingGnome",
                                      "flags", G_APPLICATION_HANDLES_COMMAND_LINE, NULL);
}