ladish/cdbus/method.c

/* -*- Mode: C ; c-basic-offset: 2 -*- */
/*
 * LADI Session Handler (ladish)
 *
 * Copyright (C) 2008,2009,2010,2011 Nedko Arnaudov <nedko@arnaudov.name>
 * Copyright (C) 2008 Juuso Alasuutari <juuso.alasuutari@gmail.com>
 *
 **************************************************************************
 * This file contains D-Bus methods helpers
 **************************************************************************
 *
 * Licensed under the Academic Free License version 2.1
 *
 * LADI Session Handler 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.
 *
 * LADI Session Handler 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 LADI Session Handler. If not, see <http://www.gnu.org/licenses/>
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include "../common.h"
#include "helpers.h"
#include "method.h"

void cdbus_error(struct cdbus_method_call * call_ptr, const char * err_name, const char * format, ...)
{
  va_list ap;
  char message[1024];
  const char *interface_name;

  va_start(ap, format);

  vsnprintf(message, sizeof(message), format, ap);
  message[sizeof(message) - 1] = '\0';

  va_end(ap);

  if (call_ptr != NULL)
  {
    interface_name = (call_ptr->iface && call_ptr->iface->name && call_ptr->iface->name[0]) ? call_ptr->iface->name : "<unknown>";

    log_error("In method %s.%s: %s", interface_name, call_ptr->method_name, message);

    call_ptr->reply = dbus_message_new_error(call_ptr->message, err_name, message);
  }
  else
  {
    log_error("%s", message);
  }
}

/*
 * Construct a void method return.
 *
 * The operation can only fail due to lack of memory, in which case
 * there's no sense in trying to construct an error return. Instead,
 * call_ptr->reply will be set to NULL and handled in send_method_return().
 */
void cdbus_method_return_new_void(struct cdbus_method_call * call_ptr)
{
  if (!(call_ptr->reply = dbus_message_new_method_return(call_ptr->message))) {
    log_error("Ran out of memory trying to construct method return");
  }
}

/*
 * Construct a method return which holds a single argument or, if
 * the type parameter is DBUS_TYPE_INVALID, no arguments at all
 * (a void message).
 *
 * The operation can only fail due to lack of memory, in which case
 * there's no sense in trying to construct an error return. Instead,
 * call_ptr->reply will be set to NULL and handled in send_method_return().
 */
void cdbus_method_return_new_single(struct cdbus_method_call * call_ptr, int type, const void * arg)
{
  if (!call_ptr || !arg) {
    log_error("Invalid arguments");
    return;
  }

  call_ptr->reply = dbus_message_new_method_return(call_ptr->message);

  if (!call_ptr->reply)
    goto fail_no_mem;

  /* Prevent crash on NULL input string. */
  if (type == DBUS_TYPE_STRING && !(*((const char **) arg)))
    *((const char **) arg) = "";

  DBusMessageIter iter;

  dbus_message_iter_init_append(call_ptr->reply, &iter);

  if (dbus_message_iter_append_basic(&iter, type, arg))
    return;

  dbus_message_unref(call_ptr->reply);
  call_ptr->reply = NULL;

fail_no_mem:
  log_error("Ran out of memory trying to construct method return");
}

void cdbus_method_return_new_valist(struct cdbus_method_call * call_ptr, int type, ...)
{
  if (!call_ptr) {
    log_error("Call pointer is NULL");
    return;
  }

  if (type == DBUS_TYPE_INVALID) {
    log_error("No argument(s) supplied");
    return;
  }

  va_list argp;

  call_ptr->reply = dbus_message_new_method_return(call_ptr->message);
  if (!call_ptr->reply)
    goto fail_no_mem;

  va_start(argp, type);

  if (dbus_message_append_args_valist(call_ptr->reply, type, argp)) {
    va_end(argp);
    return;
  }

  va_end(argp);

  dbus_message_unref(call_ptr->reply);
  call_ptr->reply = NULL;

fail_no_mem:
  log_error("Ran out of memory trying to construct method return");
}

/*
 * Send a method return.
 *
 * If call_ptr->reply is NULL, i.e. a previous attempt to construct
 * a return has failed, attempt to send a void return.
 */
void cdbus_method_return_send(struct cdbus_method_call * call_ptr)
{
  if (call_ptr->reply) {
  retry_send:
    if (!dbus_connection_send(call_ptr->connection, call_ptr->reply, NULL))
      log_error("Ran out of memory trying to queue "
                 "method return");
    else
      dbus_connection_flush(call_ptr->connection);

    dbus_message_unref(call_ptr->reply);
    call_ptr->reply = NULL;
  } else {
    log_debug("Message was NULL, trying to construct a void return");

    if ((call_ptr->reply = dbus_message_new_method_return(call_ptr->message))) {
      log_debug("Constructed a void return, trying to queue it");
      goto retry_send;
    } else {
      log_error("Failed to construct method return!");
    }
  }
}

bool cdbus_method_return_verify(DBusMessage * msg, const char ** str)
{
  if (!msg || dbus_message_get_type(msg) != DBUS_MESSAGE_TYPE_ERROR)
    return true;

  const char *ptr;

  if (!dbus_message_get_args(msg, &cdbus_g_dbus_error,
                             DBUS_TYPE_STRING, &ptr,
                             DBUS_TYPE_INVALID)) {
    log_error("Cannot read description from D-Bus error message: %s ",
               cdbus_g_dbus_error.message);
    dbus_error_free(&cdbus_g_dbus_error);
    ptr = NULL;
  }

  if (str)
    *str = ptr;

  return false;
}