metaentry.h

   1 /*
   2  * Various functions to work with meta entries.
   3  *
   4  * Copyright (C) 2007 David Härdeman <david@hardeman.nu>
   5  *
   6  *      This program is free software; you can redistribute it and/or modify it
   7  *      under the terms of the GNU General Public License as published by the
   8  *      Free Software Foundation version 2 of the License.
   9  *
  10  *      This program is distributed in the hope that it will be useful, but
  11  *      WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  *      General Public License for more details.
  14  *
  15  *      You should have received a copy of the GNU General Public License along
  16  *      with this program; if not, write to the Free Software Foundation, Inc.,
  17  *      51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  */
  20
  21 #ifndef METAENTRY_H
  22 #define METAENTRY_H
  23
  24 #include <stdbool.h>
  25
  26 #include "settings.h"
  27
  28 /* Data structure to hold all metadata for a file/dir */
  29 struct metaentry {
  30         struct metaentry *next; /* For the metahash chains */
  31         struct metaentry *list; /* For creating additional lists of entries */
  32
  33         char *path;
  34         unsigned int pathlen;
  35
  36         char *owner;
  37         char *group;
  38         mode_t mode;
  39         time_t mtime;
  40         long mtimensec;
  41
  42         unsigned int xattrs;
  43         char **xattr_names;
  44         ssize_t *xattr_lvalues;
  45         char **xattr_values;
  46 };
  47
  48 #define HASH_INDEXES 1024
  49
  50 /* Data structure to hold a number of metadata entries */
  51 struct metahash {
  52         struct metaentry *bucket[HASH_INDEXES];
  53         unsigned int count;
  54 };
  55
  56 /* Create a metaentry for the file/dir/etc at path */
  57 struct metaentry *mentry_create(const char *path);
  58
  59 /* Recurses opath and adds metadata entries to the metaentry list */
  60 void mentries_recurse_path(const char *opath, struct metahash **mhash, msettings *st);
  61
  62 /* Stores a metaentry list to a file */
  63 void mentries_tofile(const struct metahash *mhash, const char *path);
  64
  65 /* Creates a metaentry list from a file */
  66 void mentries_fromfile(struct metahash **mhash, const char *path);
  67
  68 /* Searches haystack for an xattr matching xattr number n in needle */
  69 int mentry_find_xattr(struct metaentry *haystack,
  70                       struct metaentry *needle,
  71                       unsigned n);
  72
  73 #define DIFF_NONE  0x00
  74 #define DIFF_OWNER 0x01
  75 #define DIFF_GROUP 0x02
  76 #define DIFF_MODE  0x04
  77 #define DIFF_TYPE  0x08
  78 #define DIFF_MTIME 0x10
  79 #define DIFF_XATTR 0x20
  80 #define DIFF_ADDED 0x40
  81 #define DIFF_DELE  0x80
  82
  83 /* Compares two metaentries and returns an int with a bitmask of differences */
  84 int mentry_compare(struct metaentry *left,
  85                    struct metaentry *right,
  86                    msettings *st);
  87
  88 /* Compares lists of real and stored metadata and calls pfunc for each */
  89 void mentries_compare(struct metahash *mhashreal,
  90                       struct metahash *mhashstored,
  91                       void (*pfunc)(struct metaentry *real,
  92                                     struct metaentry *stored,
  93                                     int cmp),
  94                       msettings *st);
  95
  96 #endif /* METAENTRY_H */