daemon/room_save.c

   1 /* -*- Mode: C ; c-basic-offset: 2 -*- */
   2 /*
   3  * LADI Session Handler (ladish)
   4  *
   5  * Copyright (C) 2010 Nedko Arnaudov <nedko@arnaudov.name>
   6  *
   7  **************************************************************************
   8  * This file contains the parts of room object implementation
   9  * that are related to project save functionality
  10  **************************************************************************
  11  *
  12  * LADI Session Handler is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * LADI Session Handler is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with LADI Session Handler. If not, see <http://www.gnu.org/licenses/>
  24  * or write to the Free Software Foundation, Inc.,
  25  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  26  */
  27
  28 #include <sys/types.h>
  29 #include <sys/stat.h>
  30 #include <fcntl.h>
  31 #include <unistd.h>
  32 #include <libgen.h>             /* POSIX basename() */
  33
  34 #include "room_internal.h"
  35 #include "../common/catdup.h"
  36 #include "save.h"
  37 #include "../common/dirhelpers.h"
  38 #include "escape.h"
  39
  40 #define PROJECT_HEADER_TEXT BASE_NAME " Project.\n"
  41 #define DEFAULT_PROJECT_BASE_DIR "/ladish-projects/"
  42 #define DEFAULT_PROJECT_BASE_DIR_LEN ((size_t)(sizeof(DEFAULT_PROJECT_BASE_DIR) - 1))
  43
  44 static bool ladish_room_save_project_do(struct ladish_room * room_ptr)
  45 {
  46   bool ret;
  47   time_t timestamp;
  48   char timestamp_str[26];
  49   char uuid_str[37];
  50   char * filename;
  51   char * bak_filename;
  52   char * escaped_project_name;
  53   int fd;
  54
  55   log_info("Saving project '%s' in room '%s' to '%s'", room_ptr->project_name, room_ptr->name, room_ptr->project_dir);
  56
  57   time(&timestamp);
  58   ctime_r(&timestamp, timestamp_str);
  59   timestamp_str[24] = 0;
  60
  61   ret = false;
  62
  63   if (!ensure_dir_exist(room_ptr->project_dir, 0777))
  64   {
  65     goto exit;
  66   }
  67
  68   uuid_generate(room_ptr->project_uuid); /* TODO: the uuid should be changed on "save as" but not on "rename" */
  69   uuid_unparse(room_ptr->project_uuid, uuid_str);
  70
  71   escaped_project_name = malloc(max_escaped_length(strlen(room_ptr->project_name)) + 1);
  72   if (escaped_project_name == NULL)
  73   {
  74     log_error("malloc() failed to allocate buffer for storing escaped project name");
  75     goto exit;
  76   }
  77
  78   filename = catdup(room_ptr->project_dir, LADISH_PROJECT_FILENAME);
  79   if (filename == NULL)
  80   {
  81     log_error("catdup() failed to compose project xml filename");
  82     goto free_escaped_project_name;
  83   }
  84
  85   escape_simple(room_ptr->project_name, escaped_project_name);
  86
  87   bak_filename = catdup(filename, ".bak");
  88   if (bak_filename == NULL)
  89   {
  90     log_error("catdup() failed to compose project xml backup filename");
  91     goto free_filename;
  92   }
  93
  94   fd = open(filename, O_WRONLY | O_TRUNC | O_CREAT, 0666);
  95   if (fd == -1)
  96   {
  97     log_error("open(%s) failed: %d (%s)", filename, errno, strerror(errno));
  98     goto free_bak_filename;
  99   }
 100
 101   if (!ladish_write_string(fd, "<?xml version=\"1.0\"?>\n"))
 102   {
 103     goto close;
 104   }
 105
 106   if (!ladish_write_string(fd, "<!--\n"))
 107   {
 108     goto close;
 109   }
 110
 111   if (!ladish_write_string(fd, PROJECT_HEADER_TEXT))
 112   {
 113     goto close;
 114   }
 115
 116   if (!ladish_write_string(fd, "-->\n"))
 117   {
 118     goto close;
 119   }
 120
 121   if (!ladish_write_string(fd, "<!-- "))
 122   {
 123     goto close;
 124   }
 125
 126   if (!ladish_write_string(fd, timestamp_str))
 127   {
 128     goto close;
 129   }
 130
 131   if (!ladish_write_string(fd, " -->\n"))
 132   {
 133     goto close;
 134   }
 135
 136   if (!ladish_write_string(fd, "<project name=\""))
 137   {
 138     goto close;
 139   }
 140
 141   if (!ladish_write_string(fd, escaped_project_name))
 142   {
 143     return false;
 144   }
 145
 146   if (!ladish_write_string(fd, "\" uuid=\""))
 147   {
 148     return false;
 149   }
 150
 151   if (!ladish_write_string(fd, uuid_str))
 152   {
 153     return false;
 154   }
 155
 156   if (!ladish_write_string(fd, "\">\n"))
 157   {
 158     goto close;
 159   }
 160
 161   if (!ladish_write_indented_string(fd, 1, "<room>\n"))
 162   {
 163     goto close;
 164   }
 165
 166   if (!ladish_write_room_link_ports(fd, 2, (ladish_room_handle)room_ptr))
 167   {
 168     log_error("ladish_write_room_link_ports() failed");
 169     return false;
 170   }
 171
 172   if (!ladish_write_indented_string(fd, 1, "</room>\n"))
 173   {
 174     goto close;
 175   }
 176
 177   if (!ladish_write_indented_string(fd, 1, "<jack>\n"))
 178   {
 179     goto close;
 180   }
 181
 182   if (!ladish_write_jgraph(fd, 2, room_ptr->graph))
 183   {
 184     log_error("ladish_write_jgraph() failed for room graph");
 185     goto close;
 186   }
 187
 188   if (!ladish_write_indented_string(fd, 1, "</jack>\n"))
 189   {
 190     goto close;
 191   }
 192
 193   if (!ladish_write_vgraph(fd, 1, room_ptr->graph, room_ptr->app_supervisor))
 194   {
 195     log_error("ladish_write_vgraph() failed for studio");
 196     goto close;
 197   }
 198
 199   if (!ladish_write_dict(fd, 1, ladish_graph_get_dict(room_ptr->graph)))
 200   {
 201     goto close;
 202   }
 203
 204   if (!ladish_write_string(fd, "</project>\n"))
 205   {
 206     goto close;
 207   }
 208
 209   ladish_app_supervisor_save_L1(room_ptr->app_supervisor);
 210
 211   ladish_room_emit_project_properties_changed(room_ptr);
 212
 213   ret = true;
 214
 215 close:
 216   close(fd);
 217 free_bak_filename:
 218   free(bak_filename);
 219 free_filename:
 220   free(filename);
 221 free_escaped_project_name:
 222   free(escaped_project_name);
 223 exit:
 224   return ret;
 225 }
 226
 227 /* TODO: base dir must be a runtime setting */
 228 char * compose_project_dir_from_name(const char * project_name)
 229 {
 230   const char * home_dir;
 231   char * project_dir;
 232   size_t home_dir_len;
 233
 234   home_dir = getenv("HOME");
 235   home_dir_len = strlen(home_dir);
 236
 237   project_dir = malloc(home_dir_len + DEFAULT_PROJECT_BASE_DIR_LEN + max_escaped_length(strlen(project_name)) + 1);
 238   if (project_dir == NULL)
 239   {
 240     log_error("malloc() failed to allocate buffer for project dir");
 241     return NULL;
 242   }
 243
 244   memcpy(project_dir, home_dir, home_dir_len);
 245   memcpy(project_dir + home_dir_len, DEFAULT_PROJECT_BASE_DIR, DEFAULT_PROJECT_BASE_DIR_LEN);
 246   escape_simple(project_name, project_dir + home_dir_len + DEFAULT_PROJECT_BASE_DIR_LEN);
 247
 248   return project_dir;
 249 }
 250
 251 #define room_ptr ((struct ladish_room *)room_handle)
 252
 253 bool
 254 ladish_room_save_project(
 255   ladish_room_handle room_handle,
 256   const char * project_dir_param,
 257   const char * project_name_param)
 258 {
 259   bool first_time;
 260   bool dir_supplied;
 261   bool name_supplied;
 262   char * project_dir;
 263   char * project_name;
 264   char * old_project_dir;
 265   char * old_project_name;
 266   char * buffer;
 267   bool ret;
 268
 269   ret = false;
 270   project_name = NULL;
 271   project_dir = NULL;
 272
 273   /* project has either both name and dir no none of them */
 274   ASSERT((room_ptr->project_dir == NULL && room_ptr->project_name == NULL) || (room_ptr->project_dir != NULL && room_ptr->project_name != NULL));
 275   first_time = room_ptr->project_dir == NULL;
 276
 277   dir_supplied = strlen(project_dir_param) != 0;
 278   name_supplied = strlen(project_name_param) != 0;
 279
 280   if (first_time)
 281   {
 282     if (!dir_supplied && !name_supplied)
 283     {
 284       log_error("Cannot save unnamed project in room '%s'", room_ptr->name);
 285       goto exit;
 286     }
 287
 288     if (dir_supplied && name_supplied)
 289     {
 290       project_dir = strdup(project_dir_param);
 291       project_name = strdup(project_name_param);
 292     }
 293     else if (dir_supplied)
 294     {
 295       ASSERT(!name_supplied);
 296
 297       buffer = strdup(project_dir_param);
 298       if (buffer == NULL)
 299       {
 300         log_error("strdup() failed for project dir");
 301         goto exit;
 302       }
 303
 304       project_name = basename(buffer);
 305       log_info("Project name for dir '%s' will be '%s'", project_dir_param, project_name);
 306       project_name = strdup(project_name);
 307       free(buffer);
 308       project_dir = strdup(project_dir_param); /* buffer cannot be used because it may be modified by basename() */
 309     }
 310     else if (name_supplied)
 311     {
 312       ASSERT(!dir_supplied);
 313
 314       project_dir = compose_project_dir_from_name(project_name_param);
 315       if (!project_dir)
 316       {
 317         goto exit;
 318       }
 319
 320       log_info("Project dir for name '%s' will be '%s'", project_name_param, project_dir);
 321
 322       project_name = strdup(project_name_param);
 323     }
 324     else
 325     {
 326       ASSERT_NO_PASS;
 327       goto exit;
 328     }
 329
 330     ladish_app_supervisor_set_directory(room_ptr->app_supervisor, project_dir);
 331   }
 332   else
 333   {
 334     ASSERT(room_ptr->project_name != NULL);
 335     ASSERT(room_ptr->project_dir != NULL);
 336
 337     project_name = name_supplied ? strdup(project_name_param) : room_ptr->project_name;
 338     project_dir = dir_supplied ? strdup(project_dir_param) : room_ptr->project_dir;
 339   }
 340
 341   if (project_name == NULL || project_dir == NULL)
 342   {
 343     log_error("strdup() failed for project name or dir");
 344     goto exit;
 345   }
 346
 347   old_project_dir = room_ptr->project_dir;
 348   old_project_name = room_ptr->project_name;
 349   room_ptr->project_name = project_name;
 350   room_ptr->project_dir = project_dir;
 351   ret = ladish_room_save_project_do(room_ptr);
 352   if (!ret)
 353   {
 354     room_ptr->project_name = old_project_name;
 355     room_ptr->project_dir = old_project_dir;
 356   }
 357
 358 exit:
 359   if (project_name != NULL && project_name != room_ptr->project_name)
 360   {
 361     free(room_ptr->project_name);
 362   }
 363
 364   if (project_dir != NULL && project_dir != room_ptr->project_dir)
 365   {
 366     free(room_ptr->project_dir);
 367   }
 368
 369   /* free strings that are allocated and stored only in the stack */
 370   if (project_name != NULL && project_name != room_ptr->project_name)
 371   {
 372     free(project_name);
 373   }
 374   if (project_dir != NULL && project_dir != room_ptr->project_dir)
 375   {
 376     free(project_dir);
 377   }
 378
 379   return ret;
 380 }
 381
 382 #undef room_ptr