2 * Main functions of the program.
4 * Copyright (C) 2007 David Härdeman <david@hardeman.nu>
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; only version 2 of the License is applicable.
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.
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.
21 #include <sys/types.h>
25 #include <sys/xattr.h>
31 #include "metastore.h"
34 #include "metaentry.h"
36 /* metastore settings */
37 static struct metasettings settings
= {
40 .do_emptydirs
= false,
41 .do_removeemptydirs
= false,
45 /* Used to create lists of dirs / other files which are missing in the fs */
46 static struct metaentry
*missingdirs
= NULL
;
47 static struct metaentry
*missingothers
= NULL
;
49 /* Used to create lists of dirs / other files which are missing in metadata */
50 static struct metaentry
*extradirs
= NULL
;
53 * Inserts an entry in a linked list ordered by pathlen
56 insert_entry_plist(struct metaentry
**list
, struct metaentry
*entry
)
58 struct metaentry
**parent
;
60 for (parent
= list
; *parent
; parent
= &((*parent
)->list
)) {
61 if ((*parent
)->pathlen
> entry
->pathlen
)
65 entry
->list
= *parent
;
70 * Inserts an entry in a linked list ordered by pathlen descendingly
73 insert_entry_pdlist(struct metaentry
**list
, struct metaentry
*entry
)
75 struct metaentry
**parent
;
77 for (parent
= list
; *parent
; parent
= &((*parent
)->list
)) {
78 if ((*parent
)->pathlen
< entry
->pathlen
)
82 entry
->list
= *parent
;
87 * Prints differences between real and stored actual metadata
88 * - for use in mentries_compare
91 compare_print(struct metaentry
*real
, struct metaentry
*stored
, int cmp
)
93 if (!real
&& !stored
) {
94 msg(MSG_ERROR
, "%s called with incorrect arguments\n", __FUNCTION__
);
98 if (cmp
== DIFF_NONE
) {
99 msg(MSG_DEBUG
, "%s:\tno difference\n", real
->path
);
103 msg(MSG_QUIET
, "%s:\t", real
? real
->path
: stored
->path
);
105 if (cmp
& DIFF_ADDED
)
106 msg(MSG_QUIET
, "added ", real
->path
);
108 msg(MSG_QUIET
, "removed ", stored
->path
);
109 if (cmp
& DIFF_OWNER
)
110 msg(MSG_QUIET
, "owner ");
111 if (cmp
& DIFF_GROUP
)
112 msg(MSG_QUIET
, "group ");
114 msg(MSG_QUIET
, "mode ");
116 msg(MSG_QUIET
, "type ");
117 if (cmp
& DIFF_MTIME
)
118 msg(MSG_QUIET
, "mtime ");
119 if (cmp
& DIFF_XATTR
)
120 msg(MSG_QUIET
, "xattr ");
121 msg(MSG_QUIET
, "\n");
125 * Tries to change the real metadata to match the stored one
126 * - for use in mentries_compare
129 compare_fix(struct metaentry
*real
, struct metaentry
*stored
, int cmp
)
132 struct passwd
*owner
;
138 if (!real
&& !stored
) {
139 msg(MSG_ERROR
, "%s called with incorrect arguments\n",
145 if (S_ISDIR(stored
->mode
))
146 insert_entry_plist(&missingdirs
, stored
);
148 insert_entry_plist(&missingothers
, stored
);
150 msg(MSG_NORMAL
, "%s:\tremoved\n", stored
->path
);
155 if (S_ISDIR(real
->mode
))
156 insert_entry_pdlist(&extradirs
, real
);
157 msg(MSG_NORMAL
, "%s:\tadded\n", real
->path
);
161 if (cmp
== DIFF_NONE
) {
162 msg(MSG_DEBUG
, "%s:\tno difference\n", real
->path
);
166 if (cmp
& DIFF_TYPE
) {
167 msg(MSG_NORMAL
, "%s:\tnew type, will not change metadata\n",
172 msg(MSG_QUIET
, "%s:\tchanging metadata\n", real
->path
);
174 while (cmp
& (DIFF_OWNER
| DIFF_GROUP
)) {
175 if (cmp
& DIFF_OWNER
) {
176 msg(MSG_NORMAL
, "%s:\tchanging owner from %s to %s\n",
177 real
->path
, real
->group
, stored
->group
);
178 owner
= xgetpwnam(stored
->owner
);
180 msg(MSG_DEBUG
, "\tgetpwnam failed: %s\n",
187 if (cmp
& DIFF_GROUP
) {
188 msg(MSG_NORMAL
, "%s:\tchanging group from %s to %s\n",
189 real
->path
, real
->group
, stored
->group
);
190 group
= xgetgrnam(stored
->group
);
192 msg(MSG_DEBUG
, "\tgetgrnam failed: %s\n",
199 if (lchown(real
->path
, uid
, gid
)) {
200 msg(MSG_DEBUG
, "\tlchown failed: %s\n",
207 if (cmp
& DIFF_MODE
) {
208 msg(MSG_NORMAL
, "%s:\tchanging mode from 0%o to 0%o\n",
209 real
->path
, real
->mode
& 07777, stored
->mode
& 07777);
210 if (chmod(real
->path
, stored
->mode
& 07777))
211 msg(MSG_DEBUG
, "\tchmod failed: %s\n", strerror(errno
));
214 /* FIXME: Use utimensat here, or even better - lutimensat */
215 if ((cmp
& DIFF_MTIME
) && S_ISLNK(real
->mode
)) {
216 msg(MSG_NORMAL
, "%s:\tsymlink, not changing mtime\n", real
->path
);
217 } else if (cmp
& DIFF_MTIME
) {
218 msg(MSG_NORMAL
, "%s:\tchanging mtime from %ld to %ld\n",
219 real
->path
, real
->mtime
, stored
->mtime
);
220 tbuf
.actime
= stored
->mtime
;
221 tbuf
.modtime
= stored
->mtime
;
222 if (utime(real
->path
, &tbuf
)) {
223 msg(MSG_DEBUG
, "\tutime failed: %s\n", strerror(errno
));
228 if (cmp
& DIFF_XATTR
) {
229 for (i
= 0; i
< real
->xattrs
; i
++) {
230 /* Any attrs to remove? */
231 if (mentry_find_xattr(stored
, real
, i
) >= 0)
234 msg(MSG_NORMAL
, "%s:\tremoving xattr %s\n",
235 real
->path
, real
->xattr_names
[i
]);
236 if (lremovexattr(real
->path
, real
->xattr_names
[i
]))
237 msg(MSG_DEBUG
, "\tlremovexattr failed: %s\n",
241 for (i
= 0; i
< stored
->xattrs
; i
++) {
242 /* Any xattrs to add? (on change they are removed above) */
243 if (mentry_find_xattr(real
, stored
, i
) >= 0)
246 msg(MSG_NORMAL
, "%s:\tadding xattr %s\n",
247 stored
->path
, stored
->xattr_names
[i
]);
248 if (lsetxattr(stored
->path
, stored
->xattr_names
[i
],
249 stored
->xattr_values
[i
],
250 stored
->xattr_lvalues
[i
], XATTR_CREATE
))
251 msg(MSG_DEBUG
, "\tlsetxattr failed: %s\n",
258 * Tries to fix any empty dirs which are missing from the filesystem by
262 fixup_emptydirs(void)
264 struct metaentry
*entry
;
265 struct metaentry
*cur
;
266 struct metaentry
**parent
;
270 struct metaentry
*new;
274 msg(MSG_DEBUG
, "\nAttempting to recreate missing dirs\n");
276 /* If directory x/y is missing, but file x/y/z is also missing,
277 * we should prune directory x/y from the list of directories to
278 * recreate since the deletition of x/y is likely to be genuine
279 * (as opposed to empty dir pruning like git/cvs does).
281 * Also, if file x/y/z is missing, any child directories of
282 * x/y should be pruned as they are probably also intentionally
286 msg(MSG_DEBUG
, "List of candidate dirs:\n");
287 for (cur
= missingdirs
; cur
; cur
= cur
->list
)
288 msg(MSG_DEBUG
, " %s\n", cur
->path
);
290 for (entry
= missingothers
; entry
; entry
= entry
->list
) {
291 msg(MSG_DEBUG
, "Pruning using file %s\n", entry
->path
);
292 bpath
= xstrdup(entry
->path
);
293 delim
= strrchr(bpath
, '/');
295 msg(MSG_NORMAL
, "No delimiter found in %s\n", bpath
);
301 parent
= &missingdirs
;
302 for (cur
= *parent
; cur
; cur
= cur
->list
) {
303 if (strcmp(cur
->path
, bpath
)) {
308 msg(MSG_DEBUG
, "Prune phase 1 - %s\n", cur
->path
);
312 /* Now also prune subdirs of the base dir */
315 blen
= strlen(bpath
);
317 parent
= &missingdirs
;
318 for (cur
= *parent
; cur
; cur
= cur
->list
) {
319 if (strncmp(cur
->path
, bpath
, blen
)) {
324 msg(MSG_DEBUG
, "Prune phase 2 - %s\n", cur
->path
);
330 msg(MSG_DEBUG
, "\n");
332 for (cur
= missingdirs
; cur
; cur
= cur
->list
) {
333 msg(MSG_QUIET
, "%s:\trecreating...", cur
->path
);
334 if (mkdir(cur
->path
, cur
->mode
)) {
335 msg(MSG_QUIET
, "failed (%s)\n", strerror(errno
));
338 msg(MSG_QUIET
, "ok\n");
340 new = mentry_create(cur
->path
);
342 msg(MSG_QUIET
, "Failed to get metadata for %s\n");
346 compare_fix(new, cur
, mentry_compare(new, cur
, &settings
));
351 * Deletes any empty dirs present in the filesystem that are missing
353 * An "empty" dir is one which either:
355 * - only contains empty dirs
358 fixup_newemptydirs(void)
360 struct metaentry
**cur
;
361 int removed_dirs
= 1;
366 /* This is a simpleminded algorithm that attempts to rmdir() all
367 * directories discovered missing from the metadata. Naturally, this will
368 * succeed only on the truly empty directories, but depending on the order,
369 * it may mean that parent directory removal are attempted to be removed
370 * *before* the children. To circumvent this, keep looping around all the
371 * directories until none have been successfully removed. This is a
372 * O(N**2) algorithm, so don't try to remove too many nested directories
373 * at once (e.g. thousands).
375 * Note that this will succeed only if each parent directory is writable.
377 while (removed_dirs
) {
379 msg(MSG_DEBUG
, "\nAttempting to delete empty dirs\n");
380 for (cur
= &extradirs
; *cur
;) {
381 msg(MSG_QUIET
, "%s:\tremoving...", (*cur
)->path
);
382 if (rmdir((*cur
)->path
)) {
383 msg(MSG_QUIET
, "failed (%s)\n", strerror(errno
));
387 /* No freeing, because OS will do the job at the end. */
390 msg(MSG_QUIET
, "ok\n");
395 /* Outputs version information and exits */
399 msg(MSG_QUIET
, "metastore %s\n", METASTORE_VER
);
404 /* Prints usage message and exits */
406 usage(const char *arg0
, const char *message
)
409 msg(MSG_CRITICAL
, "%s: %s\n\n", arg0
, message
);
411 "Usage: %s ACTION [OPTION...] [PATH...]\n",
415 "Where ACTION is one of:\n"
416 " -c, --compare Show differences between stored and real metadata\n"
417 " -s, --save Save current metadata\n"
418 " -a, --apply Apply stored metadata\n"
419 " -d, --dump Dump stored (if no PATH is given) or real metadata\n"
420 " (if PATH is present, e.g. ./) in human-readable form\n"
421 " -V, --version Output version information and exit\n"
422 " -h, --help Help message (this text)\n"
424 "Valid OPTIONS are:\n"
425 " -v, --verbose Print more verbose messages\n"
426 " -q, --quiet Print less verbose messages\n"
427 " -m, --mtime Also take mtime into account for diff or apply\n"
428 " -e, --empty-dirs Recreate missing empty directories\n"
429 " -E, --remove-empty-dirs Remove extra empty directories\n"
430 " -g, --git Do not omit .git directories\n"
431 " -f, --file=FILE Set metadata file (" METAFILE
" by default)\n"
434 exit(message
? EXIT_FAILURE
: EXIT_SUCCESS
);
438 static struct option long_options
[] = {
439 { "compare", no_argument
, NULL
, 'c' },
440 { "save", no_argument
, NULL
, 's' },
441 { "apply", no_argument
, NULL
, 'a' },
442 { "dump", no_argument
, NULL
, 'd' },
443 { "version", no_argument
, NULL
, 'V' },
444 { "help", no_argument
, NULL
, 'h' },
445 { "verbose", no_argument
, NULL
, 'v' },
446 { "quiet", no_argument
, NULL
, 'q' },
447 { "mtime", no_argument
, NULL
, 'm' },
448 { "empty-dirs", no_argument
, NULL
, 'e' },
449 { "remove-empty-dirs", no_argument
, NULL
, 'E' },
450 { "git", no_argument
, NULL
, 'g' },
451 { "file", required_argument
, NULL
, 'f' },
457 main(int argc
, char **argv
)
460 struct metahash
*real
= NULL
;
461 struct metahash
*stored
= NULL
;
467 int option_index
= 0;
468 c
= getopt_long(argc
, argv
, "csadVhvqmeEgf:",
469 long_options
, &option_index
);
473 case 'c': /* compare */ action
|= ACTION_DIFF
; i
++; break;
474 case 's': /* save */ action
|= ACTION_SAVE
; i
++; break;
475 case 'a': /* apply */ action
|= ACTION_APPLY
; i
++; break;
476 case 'd': /* dump */ action
|= ACTION_DUMP
; i
++; break;
477 case 'V': /* version */ action
|= ACTION_VER
; i
++; break;
478 case 'h': /* help */ action
|= ACTION_HELP
; i
++; break;
479 case 'v': /* verbose */ adjust_verbosity(1); break;
480 case 'q': /* quiet */ adjust_verbosity(-1); break;
481 case 'm': /* mtime */ settings
.do_mtime
= true; break;
482 case 'e': /* empty-dirs */ settings
.do_emptydirs
= true; break;
483 case 'E': /* remove-empty-dirs */ settings
.do_removeemptydirs
= true;
485 case 'g': /* git */ settings
.do_git
= true; break;
486 case 'f': /* file */ settings
.metafile
= optarg
; break;
488 usage(argv
[0], "unknown option");
492 /* Make sure only one action is specified */
494 usage(argv
[0], "incorrect option(s)");
496 /* Make sure --empty-dirs is only used with apply */
497 if (settings
.do_emptydirs
&& action
!= ACTION_APPLY
)
498 usage(argv
[0], "--empty-dirs is only valid with --apply");
500 /* Make sure --remove-empty-dirs is only used with apply */
501 if (settings
.do_removeemptydirs
&& action
!= ACTION_APPLY
)
502 usage(argv
[0], "--remove-empty-dirs is only valid with --apply");
504 if (action
== ACTION_VER
)
507 if (action
== ACTION_HELP
)
508 usage(argv
[0], NULL
);
511 if (action
& ACTIONS_READING
&& !(action
== ACTION_DUMP
&& optind
< argc
)) {
512 mentries_fromfile(&stored
, settings
.metafile
);
514 msg(MSG_CRITICAL
, "Failed to load metadata from %s\n",
521 while (optind
< argc
)
522 mentries_recurse_path(argv
[optind
++], &real
, &settings
);
523 } else if (action
!= ACTION_DUMP
) {
524 mentries_recurse_path(".", &real
, &settings
);
527 if (!real
&& (action
!= ACTION_DUMP
|| optind
< argc
)) {
529 "Failed to load metadata from file system\n");
535 mentries_compare(real
, stored
, compare_print
, &settings
);
538 mentries_tofile(real
, settings
.metafile
);
541 mentries_compare(real
, stored
, compare_fix
, &settings
);
542 if (settings
.do_emptydirs
)
544 if (settings
.do_removeemptydirs
)
545 fixup_newemptydirs();
548 mentries_dump(real
? real
: stored
);