daemon/room_save.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 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   int fd;
  53
  54   log_info("Saving project '%s' in room '%s' to '%s'", room_ptr->project_name, room_ptr->name, room_ptr->project_dir);
  55
  56   ladish_check_integrity();
  57
  58   time(&timestamp);
  59   ctime_r(&timestamp, timestamp_str);
  60   timestamp_str[24] = 0;
  61
  62   ret = false;
  63
  64   if (!ensure_dir_exist(room_ptr->project_dir, 0777))
  65   {
  66     goto exit;
  67   }
  68
  69   uuid_generate(room_ptr->project_uuid); /* TODO: the uuid should be changed on "save as" but not on "rename" */
  70   uuid_unparse(room_ptr->project_uuid, uuid_str);
  71
  72   filename = catdup(room_ptr->project_dir, LADISH_PROJECT_FILENAME);
  73   if (filename == NULL)
  74   {
  75     log_error("catdup() failed to compose project xml filename");
  76     goto exit;
  77   }
  78
  79   bak_filename = catdup(filename, ".bak");
  80   if (bak_filename == NULL)
  81   {
  82     log_error("catdup() failed to compose project xml backup filename");
  83     goto free_filename;
  84   }
  85
  86   fd = open(filename, O_WRONLY | O_TRUNC | O_CREAT, 0666);
  87   if (fd == -1)
  88   {
  89     log_error("open(%s) failed: %d (%s)", filename, errno, strerror(errno));
  90     goto free_bak_filename;
  91   }
  92
  93   if (!ladish_write_string(fd, "<?xml version=\"1.0\"?>\n"))
  94   {
  95     goto close;
  96   }
  97
  98   if (!ladish_write_string(fd, "<!--\n"))
  99   {
 100     goto close;
 101   }
 102
 103   if (!ladish_write_string(fd, PROJECT_HEADER_TEXT))
 104   {
 105     goto close;
 106   }
 107
 108   if (!ladish_write_string(fd, "-->\n"))
 109   {
 110     goto close;
 111   }
 112
 113   if (!ladish_write_string(fd, "<!-- "))
 114   {
 115     goto close;
 116   }
 117
 118   if (!ladish_write_string(fd, timestamp_str))
 119   {
 120     goto close;
 121   }
 122
 123   if (!ladish_write_string(fd, " -->\n"))
 124   {
 125     goto close;
 126   }
 127
 128   if (!ladish_write_string(fd, "<project name=\""))
 129   {
 130     goto close;
 131   }
 132
 133   if (!ladish_write_string_escape(fd, room_ptr->project_name))
 134   {
 135     return false;
 136   }
 137
 138   if (!ladish_write_string(fd, "\" uuid=\""))
 139   {
 140     return false;
 141   }
 142
 143   if (!ladish_write_string(fd, uuid_str))
 144   {
 145     return false;
 146   }
 147
 148   if (!ladish_write_string(fd, "\">\n"))
 149   {
 150     goto close;
 151   }
 152
 153   if (room_ptr->project_description != NULL)
 154   {
 155     if (!ladish_write_indented_string(fd, 1, "<description>"))
 156     {
 157       goto close;
 158     }
 159
 160     if (!ladish_write_string_escape(fd, room_ptr->project_description))
 161     {
 162       goto close;
 163     }
 164
 165     if (!ladish_write_string(fd, "</description>\n"))
 166     {
 167       goto close;
 168     }
 169   }
 170
 171   if (room_ptr->project_notes != NULL)
 172   {
 173     if (!ladish_write_indented_string(fd, 1, "<notes>"))
 174     {
 175       goto close;
 176     }
 177
 178     if (!ladish_write_string_escape(fd, room_ptr->project_notes))
 179     {
 180       goto close;
 181     }
 182
 183     if (!ladish_write_string(fd, "</notes>\n"))
 184     {
 185       goto close;
 186     }
 187   }
 188
 189   if (!ladish_write_indented_string(fd, 1, "<room>\n"))
 190   {
 191     goto close;
 192   }
 193
 194   if (!ladish_write_room_link_ports(fd, 2, (ladish_room_handle)room_ptr))
 195   {
 196     log_error("ladish_write_room_link_ports() failed");
 197     return false;
 198   }
 199
 200   if (!ladish_write_indented_string(fd, 1, "</room>\n"))
 201   {
 202     goto close;
 203   }
 204
 205   if (!ladish_write_indented_string(fd, 1, "<jack>\n"))
 206   {
 207     goto close;
 208   }
 209
 210   if (!ladish_write_jgraph(fd, 2, room_ptr->graph, room_ptr->app_supervisor))
 211   {
 212     log_error("ladish_write_jgraph() failed for room graph");
 213     goto close;
 214   }
 215
 216   if (!ladish_write_indented_string(fd, 1, "</jack>\n"))
 217   {
 218     goto close;
 219   }
 220
 221   if (!ladish_write_vgraph(fd, 1, room_ptr->graph, room_ptr->app_supervisor))
 222   {
 223     log_error("ladish_write_vgraph() failed for studio");
 224     goto close;
 225   }
 226
 227   if (!ladish_write_dict(fd, 1, ladish_graph_get_dict(room_ptr->graph)))
 228   {
 229     goto close;
 230   }
 231
 232   if (!ladish_write_string(fd, "</project>\n"))
 233   {
 234     goto close;
 235   }
 236
 237   ladish_app_supervisor_save(room_ptr->app_supervisor);
 238
 239   ladish_room_emit_project_properties_changed(room_ptr);
 240
 241   ret = true;
 242
 243 close:
 244   close(fd);
 245 free_bak_filename:
 246   free(bak_filename);
 247 free_filename:
 248   free(filename);
 249 exit:
 250   return ret;
 251 }
 252
 253 /* TODO: base dir must be a runtime setting */
 254 char * compose_project_dir_from_name(const char * project_name)
 255 {
 256   const char * home_dir;
 257   char * project_dir;
 258   size_t home_dir_len;
 259
 260   home_dir = getenv("HOME");
 261   home_dir_len = strlen(home_dir);
 262
 263   project_dir = malloc(home_dir_len + DEFAULT_PROJECT_BASE_DIR_LEN + max_escaped_length(strlen(project_name)) + 1);
 264   if (project_dir == NULL)
 265   {
 266     log_error("malloc() failed to allocate buffer for project dir");
 267     return NULL;
 268   }
 269
 270   memcpy(project_dir, home_dir, home_dir_len);
 271   memcpy(project_dir + home_dir_len, DEFAULT_PROJECT_BASE_DIR, DEFAULT_PROJECT_BASE_DIR_LEN);
 272   escape_simple(project_name, project_dir + home_dir_len + DEFAULT_PROJECT_BASE_DIR_LEN, LADISH_ESCAPE_FLAG_ALL);
 273
 274   return project_dir;
 275 }
 276
 277 #define room_ptr ((struct ladish_room *)room_handle)
 278
 279 bool
 280 ladish_room_save_project(
 281   ladish_room_handle room_handle,
 282   const char * project_dir_param,
 283   const char * project_name_param)
 284 {
 285   bool first_time;
 286   bool dir_supplied;
 287   bool name_supplied;
 288   char * project_dir;
 289   char * project_name;
 290   char * old_project_dir;
 291   char * old_project_name;
 292   char * buffer;
 293   bool ret;
 294
 295   ret = false;
 296   project_name = NULL;
 297   project_dir = NULL;
 298
 299   /* project has either both name and dir no none of them */
 300   ASSERT((room_ptr->project_dir == NULL && room_ptr->project_name == NULL) || (room_ptr->project_dir != NULL && room_ptr->project_name != NULL));
 301   first_time = room_ptr->project_dir == NULL;
 302
 303   dir_supplied = strlen(project_dir_param) != 0;
 304   name_supplied = strlen(project_name_param) != 0;
 305
 306   if (first_time)
 307   {
 308     if (!dir_supplied && !name_supplied)
 309     {
 310       log_error("Cannot save unnamed project in room '%s'", room_ptr->name);
 311       goto exit;
 312     }
 313
 314     if (dir_supplied && name_supplied)
 315     {
 316       project_dir = strdup(project_dir_param);
 317       project_name = strdup(project_name_param);
 318     }
 319     else if (dir_supplied)
 320     {
 321       ASSERT(!name_supplied);
 322
 323       buffer = strdup(project_dir_param);
 324       if (buffer == NULL)
 325       {
 326         log_error("strdup() failed for project dir");
 327         goto exit;
 328       }
 329
 330       project_name = basename(buffer);
 331       log_info("Project name for dir '%s' will be '%s'", project_dir_param, project_name);
 332       project_name = strdup(project_name);
 333       free(buffer);
 334       project_dir = strdup(project_dir_param); /* buffer cannot be used because it may be modified by basename() */
 335     }
 336     else if (name_supplied)
 337     {
 338       ASSERT(!dir_supplied);
 339
 340       project_dir = compose_project_dir_from_name(project_name_param);
 341       if (!project_dir)
 342       {
 343         goto exit;
 344       }
 345
 346       log_info("Project dir for name '%s' will be '%s'", project_name_param, project_dir);
 347
 348       project_name = strdup(project_name_param);
 349     }
 350     else
 351     {
 352       ASSERT_NO_PASS;
 353       goto exit;
 354     }
 355
 356     ladish_app_supervisor_set_directory(room_ptr->app_supervisor, project_dir);
 357   }
 358   else
 359   {
 360     ASSERT(room_ptr->project_name != NULL);
 361     ASSERT(room_ptr->project_dir != NULL);
 362
 363     project_name = name_supplied ? strdup(project_name_param) : room_ptr->project_name;
 364     project_dir = dir_supplied ? strdup(project_dir_param) : room_ptr->project_dir;
 365   }
 366
 367   if (project_name == NULL || project_dir == NULL)
 368   {
 369     log_error("strdup() failed for project name or dir");
 370     goto exit;
 371   }
 372
 373   old_project_dir = room_ptr->project_dir;
 374   old_project_name = room_ptr->project_name;
 375   room_ptr->project_name = project_name;
 376   room_ptr->project_dir = project_dir;
 377   ret = ladish_room_save_project_do(room_ptr);
 378   if (!ret)
 379   {
 380     room_ptr->project_name = old_project_name;
 381     room_ptr->project_dir = old_project_dir;
 382   }
 383   else
 384   {
 385     room_ptr->project_state = ROOM_PROJECT_STATE_LOADED;
 386   }
 387
 388 exit:
 389   if (project_name != NULL && project_name != room_ptr->project_name)
 390   {
 391     free(room_ptr->project_name);
 392   }
 393
 394   if (project_dir != NULL && project_dir != room_ptr->project_dir)
 395   {
 396     free(room_ptr->project_dir);
 397   }
 398
 399   /* free strings that are allocated and stored only in the stack */
 400   if (project_name != NULL && project_name != room_ptr->project_name)
 401   {
 402     free(project_name);
 403   }
 404   if (project_dir != NULL && project_dir != room_ptr->project_dir)
 405   {
 406     free(project_dir);
 407   }
 408
 409   return ret;
 410 }
 411
 412 #undef room_ptr