src/vfs/sfs/sfs.c

   1 /*
   2    Single File fileSystem
   3
   4    Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
   5    2011
   6    The Free Software Foundation, Inc.
   7
   8    This file is part of the Midnight Commander.
   9
  10    The Midnight Commander is free software: you can redistribute it
  11    and/or modify it under the terms of the GNU General Public License as
  12    published by the Free Software Foundation, either version 3 of the License,
  13    or (at your option) any later version.
  14
  15    The Midnight Commander is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24 /**
  25  * \file
  26  * \brief Source: Single File fileSystem
  27  *
  28  * This defines whole class of filesystems which contain single file
  29  * inside. It is somehow similar to extfs, except that extfs makes
  30  * whole virtual trees and we do only single virtual files.
  31  *
  32  * If you want to gunzip something, you should open it with \verbatim #ugz \endverbatim
  33  * suffix, DON'T try to gunzip it yourself.
  34  *
  35  * Namespace: exports vfs_sfs_ops
  36  */
  37
  38 #include <config.h>
  39 #include <errno.h>
  40 #include <sys/types.h>
  41 #include <unistd.h>
  42 #include <stdio.h>
  43 #include <string.h>
  44 #include <fcntl.h>
  45
  46 #include "lib/global.h"
  47 #include "lib/util.h"
  48 #include "lib/widget.h"         /* D_ERROR, D_NORMAL */
  49
  50 #include "src/execute.h"        /* EXECUTE_AS_SHELL */
  51
  52 #include "lib/vfs/vfs.h"
  53 #include "lib/vfs/utilvfs.h"
  54 #include "src/vfs/local/local.h"
  55 #include "lib/vfs/gc.h"         /* vfs_stamp_create */
  56
  57 #include "sfs.h"
  58
  59 /*** global variables ****************************************************************************/
  60
  61 /*** file scope macro definitions ****************************************************************/
  62
  63 #define MAXFS 32
  64
  65 #define F_1 1
  66 #define F_2 2
  67 #define F_NOLOCALCOPY 4
  68 #define F_FULLMATCH 8
  69
  70 #define COPY_CHAR \
  71     if ((size_t) (t - pad) > sizeof(pad)) \
  72     { \
  73         g_free (pqname); \
  74         return -1; \
  75     } \
  76     else \
  77         *t++ = *s_iter;
  78
  79 #define COPY_STRING(a) \
  80     if ((t - pad) + strlen(a) > sizeof(pad)) \
  81     { \
  82         g_free (pqname); \
  83         return -1; \
  84     } \
  85     else \
  86     { \
  87         strcpy (t, a); \
  88         t += strlen (a); \
  89     }
  90
  91 /*** file scope type declarations ****************************************************************/
  92
  93 typedef struct cachedfile
  94 {
  95     char *name;
  96     char *cache;
  97 } cachedfile;
  98
  99 /*** file scope variables ************************************************************************/
 100
 101 static GSList *head;
 102 static struct vfs_class vfs_sfs_ops;
 103
 104 static int sfs_no = 0;
 105 static char *sfs_prefix[MAXFS];
 106 static char *sfs_command[MAXFS];
 107 static int sfs_flags[MAXFS];
 108
 109 /*** file scope functions ************************************************************************/
 110
 111 static int
 112 cachedfile_compare (const void *a, const void *b)
 113 {
 114     const cachedfile *cf = (const cachedfile *) a;
 115     const char *name = (const char *) b;
 116
 117     return strcmp (name, cf->name);
 118 }
 119
 120 /* --------------------------------------------------------------------------------------------- */
 121
 122 static int
 123 sfs_vfmake (const vfs_path_t * vpath, vfs_path_t * cache_vpath)
 124 {
 125     int w;
 126     char pad[10240];
 127     char *s_iter, *t = pad;
 128     int was_percent = 0;
 129     vfs_path_t *pname, *s;      /* name of parent archive */
 130     char *pqname;               /* name of parent archive, quoted */
 131     const vfs_path_element_t *path_element;
 132
 133     path_element = vfs_path_get_by_index (vpath, -1);
 134     pname = vfs_path_clone (vpath);
 135     vfs_path_remove_element_by_index (pname, -1);
 136
 137     w = (*path_element->class->which) (path_element->class, path_element->vfs_prefix);
 138     if (w == -1)
 139         vfs_die ("This cannot happen... Hopefully.\n");
 140
 141     if ((sfs_flags[w] & F_1) == 0 && strcmp (vfs_path_get_last_path_str (pname), PATH_SEP_STR) != 0)
 142     {
 143         vfs_path_free (pname);
 144         return -1;
 145     }
 146
 147     /*    if ((sfs_flags[w] & F_2) || (!inpath) || (!*inpath)); else return -1; */
 148     if ((sfs_flags[w] & F_NOLOCALCOPY) == 0)
 149     {
 150         s = mc_getlocalcopy (pname);
 151         if (s == NULL)
 152         {
 153             vfs_path_free (pname);
 154             return -1;
 155         }
 156         pqname = name_quote (vfs_path_get_last_path_str (s), 0);
 157         vfs_path_free (s);
 158     }
 159     else
 160     {
 161         char *pname_str;
 162
 163         pname_str = vfs_path_to_str (pname);
 164         pqname = name_quote (pname_str, 0);
 165         g_free (pname_str);
 166     }
 167     vfs_path_free (pname);
 168
 169
 170     for (s_iter = sfs_command[w]; *s_iter != '\0'; s_iter++)
 171     {
 172         if (was_percent)
 173         {
 174             const char *ptr = NULL;
 175
 176             was_percent = 0;
 177
 178             switch (*s_iter)
 179             {
 180             case '1':
 181                 ptr = pqname;
 182                 break;
 183             case '2':
 184                 ptr = path_element->path;
 185                 break;
 186             case '3':
 187                 ptr = vfs_path_get_by_index (cache_vpath, -1)->path;
 188                 break;
 189             case '%':
 190                 COPY_CHAR;
 191                 continue;
 192             }
 193             if (ptr != NULL)
 194             {
 195                 COPY_STRING (ptr);
 196             }
 197         }
 198         else
 199         {
 200             if (*s_iter == '%')
 201                 was_percent = 1;
 202             else
 203                 COPY_CHAR;
 204         }
 205     }
 206
 207     g_free (pqname);
 208     open_error_pipe ();
 209     if (my_system (EXECUTE_AS_SHELL, "/bin/sh", pad))
 210     {
 211         close_error_pipe (D_ERROR, NULL);
 212         return -1;
 213     }
 214
 215     close_error_pipe (D_NORMAL, NULL);
 216     return 0;                   /* OK */
 217 }
 218
 219 /* --------------------------------------------------------------------------------------------- */
 220
 221 static const char *
 222 sfs_redirect (const vfs_path_t * vpath)
 223 {
 224     GSList *cur;
 225     cachedfile *cf;
 226     vfs_path_t *cache_vpath;
 227     int handle;
 228     const vfs_path_element_t *path_element;
 229     char *path;
 230
 231     path = vfs_path_to_str (vpath);
 232     path_element = vfs_path_get_by_index (vpath, -1);
 233     cur = g_slist_find_custom (head, path, cachedfile_compare);
 234     g_free (path);
 235
 236     if (cur != NULL)
 237     {
 238         cf = (cachedfile *) cur->data;
 239         vfs_stamp (&vfs_sfs_ops, cf);
 240         return cf->cache;
 241     }
 242
 243     handle = vfs_mkstemps (&cache_vpath, "sfs", path_element->path);
 244
 245     if (handle == -1)
 246         return "/SOMEONE_PLAYING_DIRTY_TMP_TRICKS_ON_US";
 247
 248     close (handle);
 249
 250     if (sfs_vfmake (vpath, cache_vpath) == 0)
 251     {
 252         cf = g_new (cachedfile, 1);
 253         cf->name = vfs_path_to_str (vpath);
 254         cf->cache = vfs_path_to_str (cache_vpath);
 255         head = g_slist_prepend (head, cf);
 256         vfs_path_free (cache_vpath);
 257
 258         vfs_stamp_create (&vfs_sfs_ops, (cachedfile *) head->data);
 259         return cf->cache;
 260     }
 261
 262     mc_unlink (cache_vpath);
 263     vfs_path_free (cache_vpath);
 264     return "/I_MUST_NOT_EXIST";
 265 }
 266
 267 /* --------------------------------------------------------------------------------------------- */
 268
 269 static void *
 270 sfs_open (const vfs_path_t * vpath /*struct vfs_class *me, const char *path */ , int flags,
 271           mode_t mode)
 272 {
 273     int *sfs_info;
 274     int fd;
 275
 276     fd = open (sfs_redirect (vpath), NO_LINEAR (flags), mode);
 277     if (fd == -1)
 278         return 0;
 279
 280     sfs_info = g_new (int, 1);
 281     *sfs_info = fd;
 282
 283     return sfs_info;
 284 }
 285
 286 /* --------------------------------------------------------------------------------------------- */
 287
 288 static int
 289 sfs_stat (const vfs_path_t * vpath, struct stat *buf)
 290 {
 291     return stat (sfs_redirect (vpath), buf);
 292 }
 293
 294 /* --------------------------------------------------------------------------------------------- */
 295
 296 static int
 297 sfs_lstat (const vfs_path_t * vpath, struct stat *buf)
 298 {
 299 #ifndef HAVE_STATLSTAT
 300     return lstat (sfs_redirect (vpath), buf);
 301 #else
 302     return statlstat (sfs_redirect (vpath), buf);
 303 #endif
 304 }
 305
 306 /* --------------------------------------------------------------------------------------------- */
 307
 308 static int
 309 sfs_chmod (const vfs_path_t * vpath, mode_t mode)
 310 {
 311     return chmod (sfs_redirect (vpath), mode);
 312 }
 313
 314 /* --------------------------------------------------------------------------------------------- */
 315
 316 static int
 317 sfs_chown (const vfs_path_t * vpath, uid_t owner, gid_t group)
 318 {
 319     return chown (sfs_redirect (vpath), owner, group);
 320 }
 321
 322 /* --------------------------------------------------------------------------------------------- */
 323
 324 static int
 325 sfs_utime (const vfs_path_t * vpath, struct utimbuf *times)
 326 {
 327     return utime (sfs_redirect (vpath), times);
 328 }
 329
 330 /* --------------------------------------------------------------------------------------------- */
 331
 332 static int
 333 sfs_readlink (const vfs_path_t * vpath, char *buf, size_t size)
 334 {
 335     return readlink (sfs_redirect (vpath), buf, size);
 336 }
 337
 338 /* --------------------------------------------------------------------------------------------- */
 339
 340 static vfsid
 341 sfs_getid (const vfs_path_t * vpath)
 342 {
 343     GSList *cur;
 344     char *path = vfs_path_to_str (vpath);
 345
 346     cur = g_slist_find_custom (head, path, cachedfile_compare);
 347     g_free (path);
 348
 349     return (vfsid) (cur != NULL ? cur->data : NULL);
 350 }
 351
 352 /* --------------------------------------------------------------------------------------------- */
 353
 354 static void
 355 sfs_free (vfsid id)
 356 {
 357     struct cachedfile *which;
 358     GSList *cur;
 359
 360     which = (struct cachedfile *) id;
 361     cur = g_slist_find (head, which);
 362     if (cur == NULL)
 363         vfs_die ("Free of thing which is unknown to me\n");
 364
 365     which = (struct cachedfile *) cur->data;
 366     unlink (which->cache);
 367     g_free (which->cache);
 368     g_free (which->name);
 369     g_free (which);
 370
 371     head = g_slist_delete_link (head, cur);
 372 }
 373
 374 /* --------------------------------------------------------------------------------------------- */
 375
 376 static void
 377 sfs_fill_names (struct vfs_class *me, fill_names_f func)
 378 {
 379     GSList *cur;
 380
 381     (void) me;
 382
 383     for (cur = head; cur != NULL; cur = g_slist_next (cur))
 384         func (((cachedfile *) cur->data)->name);
 385 }
 386
 387 /* --------------------------------------------------------------------------------------------- */
 388
 389 static int
 390 sfs_nothingisopen (vfsid id)
 391 {
 392     /* FIXME: Investigate whether have to guard this like in
 393        the other VFSs (see fd_usage in extfs) -- Norbert */
 394     (void) id;
 395     return 1;
 396 }
 397
 398 /* --------------------------------------------------------------------------------------------- */
 399
 400 static vfs_path_t *
 401 sfs_getlocalcopy (const vfs_path_t * vpath)
 402 {
 403     return vfs_path_from_str (sfs_redirect (vpath));
 404 }
 405
 406 /* --------------------------------------------------------------------------------------------- */
 407
 408 static int
 409 sfs_ungetlocalcopy (const vfs_path_t * vpath, const vfs_path_t * local, gboolean has_changed)
 410 {
 411     (void) vpath;
 412     (void) local;
 413     (void) has_changed;
 414     return 0;
 415 }
 416
 417 /* --------------------------------------------------------------------------------------------- */
 418
 419 static int
 420 sfs_init (struct vfs_class *me)
 421 {
 422     char *mc_sfsini;
 423     FILE *cfg;
 424     char key[256];
 425
 426     (void) me;
 427
 428     mc_sfsini = g_build_filename (mc_global.sysconfig_dir, "sfs.ini", (char *) NULL);
 429     cfg = fopen (mc_sfsini, "r");
 430
 431     if (cfg == NULL)
 432     {
 433         fprintf (stderr, _("%s: Warning: file %s not found\n"), "sfs_init()", mc_sfsini);
 434         g_free (mc_sfsini);
 435         return 0;
 436     }
 437     g_free (mc_sfsini);
 438
 439     sfs_no = 0;
 440     while (sfs_no < MAXFS && fgets (key, sizeof (key), cfg))
 441     {
 442         char *c, *semi = NULL, flags = 0;
 443
 444         if (*key == '#' || *key == '\n')
 445             continue;
 446
 447         for (c = key; *c; c++)
 448             if ((*c == ':') || (*c == '/'))
 449             {
 450                 semi = c;
 451                 if (*c == '/')
 452                 {
 453                     *c = 0;
 454                     flags |= F_FULLMATCH;
 455                 }
 456                 break;
 457             }
 458
 459         if (!semi)
 460         {
 461           invalid_line:
 462             fprintf (stderr, _("Warning: Invalid line in %s:\n%s\n"), "sfs.ini", key);
 463             continue;
 464         }
 465
 466         c = semi + 1;
 467         while (*c && (*c != ' ') && (*c != '\t'))
 468         {
 469             switch (*c)
 470             {
 471             case '1':
 472                 flags |= F_1;
 473                 break;
 474             case '2':
 475                 flags |= F_2;
 476                 break;
 477             case 'R':
 478                 flags |= F_NOLOCALCOPY;
 479                 break;
 480             default:
 481                 fprintf (stderr, _("Warning: Invalid flag %c in %s:\n%s\n"), *c, "sfs.ini", key);
 482             }
 483             c++;
 484         }
 485         if (!*c)
 486             goto invalid_line;
 487
 488         c++;
 489         *(semi + 1) = 0;
 490         semi = strchr (c, '\n');
 491         if (semi != NULL)
 492             *semi = 0;
 493
 494         sfs_prefix[sfs_no] = g_strdup (key);
 495         sfs_command[sfs_no] = g_strdup (c);
 496         sfs_flags[sfs_no] = flags;
 497         sfs_no++;
 498     }
 499     fclose (cfg);
 500     return 1;
 501 }
 502
 503 /* --------------------------------------------------------------------------------------------- */
 504
 505 static void
 506 sfs_done (struct vfs_class *me)
 507 {
 508     int i;
 509
 510     (void) me;
 511
 512     for (i = 0; i < sfs_no; i++)
 513     {
 514         g_free (sfs_prefix[i]);
 515         g_free (sfs_command[i]);
 516         sfs_prefix[i] = sfs_command[i] = NULL;
 517     }
 518     sfs_no = 0;
 519 }
 520
 521 /* --------------------------------------------------------------------------------------------- */
 522
 523 static int
 524 sfs_which (struct vfs_class *me, const char *path)
 525 {
 526     int i;
 527
 528     (void) me;
 529
 530     for (i = 0; i < sfs_no; i++)
 531         if (sfs_flags[i] & F_FULLMATCH)
 532         {
 533             if (!strcmp (path, sfs_prefix[i]))
 534                 return i;
 535         }
 536         else if (!strncmp (path, sfs_prefix[i], strlen (sfs_prefix[i])))
 537             return i;
 538
 539     return -1;
 540 }
 541
 542 /* --------------------------------------------------------------------------------------------- */
 543 /*** public functions ****************************************************************************/
 544 /* --------------------------------------------------------------------------------------------- */
 545
 546 void
 547 init_sfs (void)
 548 {
 549     vfs_sfs_ops.name = "sfs";
 550     vfs_sfs_ops.init = sfs_init;
 551     vfs_sfs_ops.done = sfs_done;
 552     vfs_sfs_ops.fill_names = sfs_fill_names;
 553     vfs_sfs_ops.which = sfs_which;
 554     vfs_sfs_ops.open = sfs_open;
 555     vfs_sfs_ops.close = local_close;
 556     vfs_sfs_ops.read = local_read;
 557     vfs_sfs_ops.stat = sfs_stat;
 558     vfs_sfs_ops.lstat = sfs_lstat;
 559     vfs_sfs_ops.fstat = local_fstat;
 560     vfs_sfs_ops.chmod = sfs_chmod;
 561     vfs_sfs_ops.chown = sfs_chown;
 562     vfs_sfs_ops.utime = sfs_utime;
 563     vfs_sfs_ops.readlink = sfs_readlink;
 564     vfs_sfs_ops.ferrno = local_errno;
 565     vfs_sfs_ops.lseek = local_lseek;
 566     vfs_sfs_ops.getid = sfs_getid;
 567     vfs_sfs_ops.nothingisopen = sfs_nothingisopen;
 568     vfs_sfs_ops.free = sfs_free;
 569     vfs_sfs_ops.getlocalcopy = sfs_getlocalcopy;
 570     vfs_sfs_ops.ungetlocalcopy = sfs_ungetlocalcopy;
 571     vfs_register_class (&vfs_sfs_ops);
 572 }
 573
 574 /* --------------------------------------------------------------------------------------------- */