daemon/recent_projects.c

   1 /* -*- Mode: C ; c-basic-offset: 2 -*- */
   2 /*
   3  * LADI Session Handler (ladish)
   4  *
   5  * Copyright (C) 2010,2011 Nedko Arnaudov <nedko@arnaudov.name>
   6  *
   7  **************************************************************************
   8  * This file implements the recent project functionality
   9  **************************************************************************
  10  *
  11  * LADI Session Handler is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * LADI Session Handler is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with LADI Session Handler. If not, see <http://www.gnu.org/licenses/>
  23  * or write to the Free Software Foundation, Inc.,
  24  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  25  */
  26
  27 #include "recent_projects.h"
  28 #include "recent_store.h"
  29 #include "../common/catdup.h"
  30 #include "../dbus_constants.h"
  31 #include "../dbus/error.h"
  32 #include "room.h"
  33
  34 #define RECENT_PROJECTS_STORE_FILE "recent_projects"
  35 #define RECENT_PROJECTS_STORE_MAX_ITEMS 50
  36
  37 static ladish_recent_store_handle g_recent_projects_store;
  38
  39 bool ladish_recent_projects_init(void)
  40 {
  41   char * path;
  42   bool ret;
  43
  44   path = catdup(g_base_dir, "/" RECENT_PROJECTS_STORE_FILE);
  45   if (path == NULL)
  46   {
  47     log_error("catdup() failed to compose recent projects store file path");
  48     return false;
  49   }
  50
  51   ret = ladish_recent_store_create(path, RECENT_PROJECTS_STORE_MAX_ITEMS, &g_recent_projects_store);
  52   if (!ret)
  53   {
  54     log_error("creation of recent projects store failed");
  55   }
  56
  57   free(path);
  58
  59   return ret;
  60 }
  61
  62 void ladish_recent_projects_uninit(void)
  63 {
  64   ladish_recent_store_destroy(g_recent_projects_store);
  65 }
  66
  67 void ladish_recent_project_use(const char * project_path)
  68 {
  69   ladish_recent_store_use_item(g_recent_projects_store, project_path);
  70 }
  71
  72 /**********************************************************************************/
  73 /*                                D-Bus methods                                   */
  74 /**********************************************************************************/
  75
  76 struct recent_projects_callback_context
  77 {
  78   DBusMessageIter array_iter;
  79   uint16_t max_items;
  80   bool error;
  81 };
  82
  83 #define ctx_ptr ((struct recent_projects_callback_context *)callback_context)
  84
  85 bool recent_projects_callback(void * callback_context, const char * project_path)
  86 {
  87   DBusMessageIter struct_iter;
  88   DBusMessageIter dict_iter;
  89   char * name;
  90
  91   ASSERT(ctx_ptr->max_items > 0);
  92
  93   name = ladish_get_project_name(project_path);
  94
  95   if (!dbus_message_iter_open_container(&ctx_ptr->array_iter, DBUS_TYPE_STRUCT, NULL, &struct_iter))
  96   {
  97     ctx_ptr->error = true;
  98     goto exit;
  99   }
 100
 101   if (!dbus_message_iter_append_basic(&struct_iter, DBUS_TYPE_STRING, &project_path))
 102   {
 103     ctx_ptr->error = true;
 104     goto close_struct;
 105   }
 106
 107   if (!dbus_message_iter_open_container(&struct_iter, DBUS_TYPE_ARRAY, "{sv}", &dict_iter))
 108   {
 109     ctx_ptr->error = true;
 110     goto close_struct;
 111   }
 112
 113   if (!dbus_maybe_add_dict_entry_string(&dict_iter, "name", name))
 114   {
 115     ctx_ptr->error = true;
 116     goto close_dict;
 117   }
 118
 119 close_dict:
 120   if (!dbus_message_iter_close_container(&struct_iter, &dict_iter))
 121   {
 122     ctx_ptr->error = true;
 123   }
 124
 125 close_struct:
 126   if (!dbus_message_iter_close_container(&ctx_ptr->array_iter, &struct_iter))
 127   {
 128     ctx_ptr->error = true;
 129   }
 130
 131 exit:
 132   free(name);                   /* safe if name is NULL */
 133
 134   if (ctx_ptr->error)
 135   {
 136     return false;               /* stop the iteration if error occurs */
 137   }
 138
 139   ctx_ptr->max_items--;
 140
 141   /* stop iteration if the requested max is reached */
 142   return ctx_ptr->max_items > 0;
 143 }
 144
 145 #undef ctx_ptr
 146
 147 static void get(struct dbus_method_call * call_ptr)
 148 {
 149   DBusMessageIter iter;
 150   struct recent_projects_callback_context ctx;
 151
 152   if (!dbus_message_get_args(call_ptr->message, &cdbus_g_dbus_error, DBUS_TYPE_UINT16, &ctx.max_items, DBUS_TYPE_INVALID))
 153   {
 154     lash_dbus_error(call_ptr, LASH_DBUS_ERROR_INVALID_ARGS, "Invalid arguments to method \"%s\": %s",  call_ptr->method_name, cdbus_g_dbus_error.message);
 155     dbus_error_free(&cdbus_g_dbus_error);
 156     return;
 157   }
 158
 159   if (ctx.max_items == 0)
 160   {
 161     lash_dbus_error(
 162       call_ptr,
 163       LASH_DBUS_ERROR_INVALID_ARGS,
 164       "Invalid arguments to method \"%s\": max cannot be 0",
 165       call_ptr->method_name);
 166   }
 167
 168   call_ptr->reply = dbus_message_new_method_return(call_ptr->message);
 169   if (call_ptr->reply == NULL)
 170   {
 171     goto fail;
 172   }
 173
 174   dbus_message_iter_init_append(call_ptr->reply, &iter);
 175
 176   if (!dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, "(sa{sv})", &ctx.array_iter))
 177   {
 178     goto fail_unref;
 179   }
 180
 181   ctx.error = false;
 182   ladish_recent_store_iterate_items(g_recent_projects_store, &ctx,  recent_projects_callback);
 183   if (ctx.error)
 184   {
 185     goto fail_unref;
 186   }
 187
 188   if (!dbus_message_iter_close_container(&iter, &ctx.array_iter))
 189   {
 190     goto fail_unref;
 191   }
 192
 193   return;
 194
 195 fail_unref:
 196   dbus_message_unref(call_ptr->reply);
 197   call_ptr->reply = NULL;
 198
 199 fail:
 200   log_error("Ran out of memory trying to construct method return");
 201 }
 202
 203 METHOD_ARGS_BEGIN(get, "Get list of recent items")
 204   METHOD_ARG_DESCRIBE_IN("max", "q", "Max number of items caller is interested in")
 205   METHOD_ARG_DESCRIBE_OUT("items", "a(sa{sv})", "Item list")
 206 METHOD_ARGS_END
 207
 208 METHODS_BEGIN
 209   METHOD_DESCRIBE(get, get)
 210 METHODS_END
 211
 212 INTERFACE_BEGIN(g_iface_recent_items, IFACE_RECENT_ITEMS)
 213   INTERFACE_DEFAULT_HANDLER
 214   INTERFACE_EXPOSE_METHODS
 215 INTERFACE_END