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                 COPY_STRING (ptr);
 195             }
 196         }
 197         else
 198         {
 199             if (*s_iter == '%')
 200                 was_percent = 1;
 201             else
 202                 COPY_CHAR;
 203         }
 204     }
 205
 206     g_free (pqname);
 207     open_error_pipe ();
 208     if (my_system (EXECUTE_AS_SHELL, "/bin/sh", pad))
 209     {
 210         close_error_pipe (D_ERROR, NULL);
 211         return -1;
 212     }
 213
 214     close_error_pipe (D_NORMAL, NULL);
 215     return 0;                   /* OK */
 216 }
 217
 218 /* --------------------------------------------------------------------------------------------- */
 219
 220 static const char *
 221 sfs_redirect (const vfs_path_t * vpath)
 222 {
 223     GSList *cur;
 224     cachedfile *cf;
 225     vfs_path_t *cache_vpath;
 226     int handle;
 227     const vfs_path_element_t *path_element;
 228     char *path;
 229
 230     path = vfs_path_to_str (vpath);
 231     path_element = vfs_path_get_by_index (vpath, -1);
 232     cur = g_slist_find_custom (head, path, cachedfile_compare);
 233     g_free (path);
 234
 235     if (cur != NULL)
 236     {
 237         cf = (cachedfile *) cur->data;
 238         vfs_stamp (&vfs_sfs_ops, cf);
 239         return cf->cache;
 240     }
 241
 242     handle = vfs_mkstemps (&cache_vpath, "sfs", path_element->path);
 243
 244     if (handle == -1)
 245         return "/SOMEONE_PLAYING_DIRTY_TMP_TRICKS_ON_US";
 246
 247     close (handle);
 248
 249     if (sfs_vfmake (vpath, cache_vpath) == 0)
 250     {
 251         cf = g_new (cachedfile, 1);
 252         cf->name = vfs_path_to_str (vpath);
 253         cf->cache = vfs_path_to_str (cache_vpath);
 254         head = g_slist_prepend (head, cf);
 255         vfs_path_free (cache_vpath);
 256
 257         vfs_stamp_create (&vfs_sfs_ops, (cachedfile *) head->data);
 258         return cf->cache;
 259     }
 260
 261     mc_unlink (cache_vpath);
 262     vfs_path_free (cache_vpath);
 263     return "/I_MUST_NOT_EXIST";
 264 }
 265
 266 /* --------------------------------------------------------------------------------------------- */
 267
 268 static void *
 269 sfs_open (const vfs_path_t * vpath /*struct vfs_class *me, const char *path */ , int flags,
 270           mode_t mode)
 271 {
 272     int *sfs_info;
 273     int fd;
 274
 275     fd = open (sfs_redirect (vpath), NO_LINEAR (flags), mode);
 276     if (fd == -1)
 277         return 0;
 278
 279     sfs_info = g_new (int, 1);
 280     *sfs_info = fd;
 281
 282     return sfs_info;
 283 }
 284
 285 /* --------------------------------------------------------------------------------------------- */
 286
 287 static int
 288 sfs_stat (const vfs_path_t * vpath, struct stat *buf)
 289 {
 290     return stat (sfs_redirect (vpath), buf);
 291 }
 292
 293 /* --------------------------------------------------------------------------------------------- */
 294
 295 static int
 296 sfs_lstat (const vfs_path_t * vpath, struct stat *buf)
 297 {
 298 #ifndef HAVE_STATLSTAT
 299     return lstat (sfs_redirect (vpath), buf);
 300 #else
 301     return statlstat (sfs_redirect (vpath), buf);
 302 #endif
 303 }
 304
 305 /* --------------------------------------------------------------------------------------------- */
 306
 307 static int
 308 sfs_chmod (const vfs_path_t * vpath, mode_t mode)
 309 {
 310     return chmod (sfs_redirect (vpath), mode);
 311 }
 312
 313 /* --------------------------------------------------------------------------------------------- */
 314
 315 static int
 316 sfs_chown (const vfs_path_t * vpath, uid_t owner, gid_t group)
 317 {
 318     return chown (sfs_redirect (vpath), owner, group);
 319 }
 320
 321 /* --------------------------------------------------------------------------------------------- */
 322
 323 static int
 324 sfs_utime (const vfs_path_t * vpath, struct utimbuf *times)
 325 {
 326     return utime (sfs_redirect (vpath), times);
 327 }
 328
 329 /* --------------------------------------------------------------------------------------------- */
 330
 331 static int
 332 sfs_readlink (const vfs_path_t * vpath, char *buf, size_t size)
 333 {
 334     return readlink (sfs_redirect (vpath), buf, size);
 335 }
 336
 337 /* --------------------------------------------------------------------------------------------- */
 338
 339 static vfsid
 340 sfs_getid (const vfs_path_t * vpath)
 341 {
 342     GSList *cur;
 343     char *path = vfs_path_to_str (vpath);
 344
 345     cur = g_slist_find_custom (head, path, cachedfile_compare);
 346     g_free (path);
 347
 348     return (vfsid) (cur != NULL ? cur->data : NULL);
 349 }
 350
 351 /* --------------------------------------------------------------------------------------------- */
 352
 353 static void
 354 sfs_free (vfsid id)
 355 {
 356     struct cachedfile *which;
 357     GSList *cur;
 358
 359     which = (struct cachedfile *) id;
 360     cur = g_slist_find (head, which);
 361     if (cur == NULL)
 362         vfs_die ("Free of thing which is unknown to me\n");
 363
 364     which = (struct cachedfile *) cur->data;
 365     unlink (which->cache);
 366     g_free (which->cache);
 367     g_free (which->name);
 368     g_free (which);
 369
 370     head = g_slist_delete_link (head, cur);
 371 }
 372
 373 /* --------------------------------------------------------------------------------------------- */
 374
 375 static void
 376 sfs_fill_names (struct vfs_class *me, fill_names_f func)
 377 {
 378     GSList *cur;
 379
 380     (void) me;
 381
 382     for (cur = head; cur != NULL; cur = g_slist_next (cur))
 383         func (((cachedfile *) cur->data)->name);
 384 }
 385
 386 /* --------------------------------------------------------------------------------------------- */
 387
 388 static int
 389 sfs_nothingisopen (vfsid id)
 390 {
 391     /* FIXME: Investigate whether have to guard this like in
 392        the other VFSs (see fd_usage in extfs) -- Norbert */
 393     (void) id;
 394     return 1;
 395 }
 396
 397 /* --------------------------------------------------------------------------------------------- */
 398
 399 static vfs_path_t *
 400 sfs_getlocalcopy (const vfs_path_t * vpath)
 401 {
 402     return vfs_path_from_str (sfs_redirect (vpath));
 403 }
 404
 405 /* --------------------------------------------------------------------------------------------- */
 406
 407 static int
 408 sfs_ungetlocalcopy (const vfs_path_t * vpath, const vfs_path_t * local, gboolean has_changed)
 409 {
 410     (void) vpath;
 411     (void) local;
 412     (void) has_changed;
 413     return 0;
 414 }
 415
 416 /* --------------------------------------------------------------------------------------------- */
 417
 418 static int
 419 sfs_init (struct vfs_class *me)
 420 {
 421     char *mc_sfsini;
 422     FILE *cfg;
 423     char key[256];
 424
 425     (void) me;
 426
 427     mc_sfsini = g_build_filename (mc_global.sysconfig_dir, "sfs.ini", (char *) NULL);
 428     cfg = fopen (mc_sfsini, "r");
 429
 430     if (cfg == NULL)
 431     {
 432         fprintf (stderr, _("%s: Warning: file %s not found\n"), "sfs_init()", mc_sfsini);
 433         g_free (mc_sfsini);
 434         return 0;
 435     }
 436     g_free (mc_sfsini);
 437
 438     sfs_no = 0;
 439     while (sfs_no < MAXFS && fgets (key, sizeof (key), cfg))
 440     {
 441         char *c, *semi = NULL, flags = 0;
 442
 443         if (*key == '#' || *key == '\n')
 444             continue;
 445
 446         for (c = key; *c; c++)
 447             if ((*c == ':') || (*c == '/'))
 448             {
 449                 semi = c;
 450                 if (*c == '/')
 451                 {
 452                     *c = 0;
 453                     flags |= F_FULLMATCH;
 454                 }
 455                 break;
 456             }
 457
 458         if (!semi)
 459         {
 460           invalid_line:
 461             fprintf (stderr, _("Warning: Invalid line in %s:\n%s\n"), "sfs.ini", key);
 462             continue;
 463         }
 464
 465         c = semi + 1;
 466         while (*c && (*c != ' ') && (*c != '\t'))
 467         {
 468             switch (*c)
 469             {
 470             case '1':
 471                 flags |= F_1;
 472                 break;
 473             case '2':
 474                 flags |= F_2;
 475                 break;
 476             case 'R':
 477                 flags |= F_NOLOCALCOPY;
 478                 break;
 479             default:
 480                 fprintf (stderr, _("Warning: Invalid flag %c in %s:\n%s\n"), *c, "sfs.ini", key);
 481             }
 482             c++;
 483         }
 484         if (!*c)
 485             goto invalid_line;
 486
 487         c++;
 488         *(semi + 1) = 0;
 489         semi = strchr (c, '\n');
 490         if (semi != NULL)
 491             *semi = 0;
 492
 493         sfs_prefix[sfs_no] = g_strdup (key);
 494         sfs_command[sfs_no] = g_strdup (c);
 495         sfs_flags[sfs_no] = flags;
 496         sfs_no++;
 497     }
 498     fclose (cfg);
 499     return 1;
 500 }
 501
 502 /* --------------------------------------------------------------------------------------------- */
 503
 504 static void
 505 sfs_done (struct vfs_class *me)
 506 {
 507     int i;
 508
 509     (void) me;
 510
 511     for (i = 0; i < sfs_no; i++)
 512     {
 513         g_free (sfs_prefix[i]);
 514         g_free (sfs_command[i]);
 515         sfs_prefix[i] = sfs_command[i] = NULL;
 516     }
 517     sfs_no = 0;
 518 }
 519
 520 /* --------------------------------------------------------------------------------------------- */
 521
 522 static int
 523 sfs_which (struct vfs_class *me, const char *path)
 524 {
 525     int i;
 526
 527     (void) me;
 528
 529     for (i = 0; i < sfs_no; i++)
 530         if (sfs_flags[i] & F_FULLMATCH)
 531         {
 532             if (!strcmp (path, sfs_prefix[i]))
 533                 return i;
 534         }
 535         else if (!strncmp (path, sfs_prefix[i], strlen (sfs_prefix[i])))
 536             return i;
 537
 538     return -1;
 539 }
 540
 541 /* --------------------------------------------------------------------------------------------- */
 542 /*** public functions ****************************************************************************/
 543 /* --------------------------------------------------------------------------------------------- */
 544
 545 void
 546 init_sfs (void)
 547 {
 548     vfs_sfs_ops.name = "sfs";
 549     vfs_sfs_ops.init = sfs_init;
 550     vfs_sfs_ops.done = sfs_done;
 551     vfs_sfs_ops.fill_names = sfs_fill_names;
 552     vfs_sfs_ops.which = sfs_which;
 553     vfs_sfs_ops.open = sfs_open;
 554     vfs_sfs_ops.close = local_close;
 555     vfs_sfs_ops.read = local_read;
 556     vfs_sfs_ops.stat = sfs_stat;
 557     vfs_sfs_ops.lstat = sfs_lstat;
 558     vfs_sfs_ops.fstat = local_fstat;
 559     vfs_sfs_ops.chmod = sfs_chmod;
 560     vfs_sfs_ops.chown = sfs_chown;
 561     vfs_sfs_ops.utime = sfs_utime;
 562     vfs_sfs_ops.readlink = sfs_readlink;
 563     vfs_sfs_ops.ferrno = local_errno;
 564     vfs_sfs_ops.lseek = local_lseek;
 565     vfs_sfs_ops.getid = sfs_getid;
 566     vfs_sfs_ops.nothingisopen = sfs_nothingisopen;
 567     vfs_sfs_ops.free = sfs_free;
 568     vfs_sfs_ops.getlocalcopy = sfs_getlocalcopy;
 569     vfs_sfs_ops.ungetlocalcopy = sfs_ungetlocalcopy;
 570     vfs_register_class (&vfs_sfs_ops);
 571 }
 572
 573 /* --------------------------------------------------------------------------------------------- */