From 5fed2f9169fdd0585cc83ff0fa8210d97da77cb2 Mon Sep 17 00:00:00 2001 From: =?utf8?q?David=20H=C3=A4rdeman?= Date: Sat, 19 May 2007 17:14:12 +0200 Subject: [PATCH] 80-col align code, add license headers --- LICENSE | 339 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Makefile | 34 +++++- metaentry.c | 100 +++++++++++++----- metaentry.h | 64 ++++++++---- metastore.c | 98 ++++++++++++++---- metastore.h | 26 +++++ utils.c | 41 +++++++- utils.h | 43 ++++++++ 8 files changed, 675 insertions(+), 70 deletions(-) create mode 100644 LICENSE rewrite metaentry.h (63%) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d511905 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/Makefile b/Makefile index 91bb1ce..8f5e1ea 100644 --- a/Makefile +++ b/Makefile @@ -1,18 +1,46 @@ +# +# Copyright (C) 2007 David Härdeman +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; version 2 of the License. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + +# +# Generic settings +# CC = gcc CFLAGS = -g -Wall LDFLAGS = INCLUDES = COMPILE = $(CC) $(INCLUDES) $(CFLAGS) LINK = $(CC) $(CFLAGS) $(LDFLAGS) +OBJECTS = utils.o metastore.o metaentry.o +HEADERS = utils.h metastore.h metaentry.h -objects = utils.o metastore.o metaentry.o +# +# Targets +# -%.o: %.c +%.o: %.c $(HEADERS) $(COMPILE) -o $@ -c $< -metastore: $(objects) +metastore: $(OBJECTS) $(LINK) -o $@ $^ +all: metastore +.PHONY: all +.DEFAULT: all + clean: rm -f *.o metastore .PHONY: clean + diff --git a/metaentry.c b/metaentry.c index 83f84fa..d8c7cb8 100644 --- a/metaentry.c +++ b/metaentry.c @@ -1,3 +1,23 @@ +/* + * Various functions to work with meta entries. + * + * Copyright (C) 2007 David Härdeman + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation version 2 of the License. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + */ + #define _GNU_SOURCE #include #include @@ -95,7 +115,8 @@ mentry_print(const struct metaentry *mentry) int i; if (!mentry || !mentry->path) { - msg(MSG_DEBUG, "Incorrect meta entry passed to printmetaentry\n"); + msg(MSG_DEBUG, + "Incorrect meta entry passed to printmetaentry\n"); return; } @@ -145,19 +166,22 @@ mentry_create(const char *path) struct metaentry *mentry; if (lstat(path, &sbuf)) { - msg(MSG_ERROR, "lstat failed for %s: %s\n", path, strerror(errno)); + msg(MSG_ERROR, "lstat failed for %s: %s\n", + path, strerror(errno)); return NULL; } pbuf = getpwuid(sbuf.st_uid); if (!pbuf) { - msg(MSG_ERROR, "getpwuid failed for %i: %s\n", (int)sbuf.st_uid, strerror(errno)); + msg(MSG_ERROR, "getpwuid failed for %i: %s\n", + (int)sbuf.st_uid, strerror(errno)); return NULL; } gbuf = getgrgid(sbuf.st_gid); if (!gbuf) { - msg(MSG_ERROR, "getgrgid failed for %i: %s\n", (int)sbuf.st_gid, strerror(errno)); + msg(MSG_ERROR, "getgrgid failed for %i: %s\n", + (int)sbuf.st_gid, strerror(errno)); return NULL; } @@ -175,14 +199,16 @@ mentry_create(const char *path) lsize = listxattr(path, NULL, 0); if (lsize < 0) { - msg(MSG_ERROR, "listxattr failed for %s: %s\n", path, strerror(errno)); + msg(MSG_ERROR, "listxattr failed for %s: %s\n", + path, strerror(errno)); return NULL; } list = xmalloc(lsize); lsize = listxattr(path, list, lsize); if (lsize < 0) { - msg(MSG_ERROR, "listxattr failed for %s: %s\n", path, strerror(errno)); + msg(MSG_ERROR, "listxattr failed for %s: %s\n", + path, strerror(errno)); return NULL; } @@ -209,7 +235,8 @@ mentry_create(const char *path) mentry->xattr_names[i] = xstrdup(attr); vsize = getxattr(path, attr, NULL, 0); if (vsize < 0) { - msg(MSG_ERROR, "getxattr failed for %s: %s\n", path, strerror(errno)); + msg(MSG_ERROR, "getxattr failed for %s: %s\n", + path, strerror(errno)); return NULL; } @@ -218,7 +245,8 @@ mentry_create(const char *path) vsize = getxattr(path, attr, mentry->xattr_values[i], vsize); if (vsize < 0) { - msg(MSG_ERROR, "getxattr failed for %s: %s\n", path, strerror(errno)); + msg(MSG_ERROR, "getxattr failed for %s: %s\n", + path, strerror(errno)); return NULL; } i++; @@ -264,7 +292,8 @@ mentries_recurse(const char *path, struct metaentry **mhead) return; if (lstat(path, &sbuf)) { - msg(MSG_ERROR, "lstat failed for %s: %s\n", path, strerror(errno)); + msg(MSG_ERROR, "lstat failed for %s: %s\n", + path, strerror(errno)); return; } @@ -277,12 +306,15 @@ mentries_recurse(const char *path, struct metaentry **mhead) if (S_ISDIR(sbuf.st_mode)) { dir = opendir(path); if (!dir) { - msg(MSG_ERROR, "opendir failed for %s: %s\n", path, strerror(errno)); + msg(MSG_ERROR, "opendir failed for %s: %s\n", + path, strerror(errno)); return; } while ((dent = readdir(dir))) { - if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, "..") || !strcmp(dent->d_name, ".git")) + if (!strcmp(dent->d_name, ".") || + !strcmp(dent->d_name, "..") || + !strcmp(dent->d_name, ".git")) continue; snprintf(tpath, PATH_MAX, "%s/%s", path, dent->d_name); tpath[PATH_MAX - 1] = '\0'; @@ -328,7 +360,8 @@ mentries_tofile(const struct metaentry *mhead, const char *path) for (i = 0; i < mentry->xattrs; i++) { write_string(mentry->xattr_names[i], to); write_int(mentry->xattr_lvalues[i], 4, to); - write_binary_string(mentry->xattr_values[i], mentry->xattr_lvalues[i], to); + write_binary_string(mentry->xattr_values[i], + mentry->xattr_lvalues[i], to); } } @@ -362,9 +395,11 @@ mentries_fromfile(struct metaentry **mhead, const char *path) exit(EXIT_FAILURE); } - mmapstart = mmap(NULL, (size_t)sbuf.st_size, PROT_READ, MAP_SHARED, fd, 0); + mmapstart = mmap(NULL, (size_t)sbuf.st_size, PROT_READ, + MAP_SHARED, fd, 0); if (mmapstart == MAP_FAILED) { - msg(MSG_CRITICAL, "Unable to mmap %s: %s\n", path, strerror(errno)); + msg(MSG_CRITICAL, "Unable to mmap %s: %s\n", + path, strerror(errno)); exit(EXIT_FAILURE); } ptr = mmapstart; @@ -384,7 +419,8 @@ mentries_fromfile(struct metaentry **mhead, const char *path) while (ptr < mmapstart + sbuf.st_size) { if (*ptr == '\0') { - msg(MSG_CRITICAL, "Invalid characters in file %s\n", path); + msg(MSG_CRITICAL, "Invalid characters in file %s\n", + path); goto out; } @@ -397,16 +433,26 @@ mentries_fromfile(struct metaentry **mhead, const char *path) mentry->mode = (mode_t)read_int(&ptr, 2, max); mentry->xattrs = (unsigned int)read_int(&ptr, 4, max); - if (mentry->xattrs > 0) { - mentry->xattr_names = xmalloc(mentry->xattrs * sizeof(char *)); - mentry->xattr_lvalues = xmalloc(mentry->xattrs * sizeof(int)); - mentry->xattr_values = xmalloc(mentry->xattrs * sizeof(char *)); + if (!mentry->xattrs) { + mentry_insert(mentry, mhead); + continue; + } - for (i = 0; i < mentry->xattrs; i++) { - mentry->xattr_names[i] = read_string(&ptr, max); - mentry->xattr_lvalues[i] = (int)read_int(&ptr, 4, max); - mentry->xattr_values[i] = read_binary_string(&ptr, mentry->xattr_lvalues[i], max); - } + mentry->xattr_names = xmalloc(mentry->xattrs * + sizeof(char *)); + mentry->xattr_lvalues = xmalloc(mentry->xattrs * + sizeof(int)); + mentry->xattr_values = xmalloc(mentry->xattrs * + sizeof(char *)); + + for (i = 0; i < mentry->xattrs; i++) { + mentry->xattr_names[i] = read_string(&ptr, max); + mentry->xattr_lvalues[i] = + (int)read_int(&ptr, 4, max); + mentry->xattr_values[i] = + read_binary_string(&ptr, + mentry->xattr_lvalues[i], + max); } mentry_insert(mentry, mhead); } @@ -440,7 +486,8 @@ mentry_find_xattr(struct metaentry *haystack, struct metaentry *needle, int n) continue; if (haystack->xattr_lvalues[i] != needle->xattr_lvalues[n]) return -1; - if (bcmp(haystack->xattr_values[i], needle->xattr_values[n], needle->xattr_lvalues[n])) + if (bcmp(haystack->xattr_values[i], needle->xattr_values[n], + needle->xattr_lvalues[n])) return -1; return i; } @@ -493,7 +540,8 @@ mentry_compare(struct metaentry *left, struct metaentry *right) retval |= DIFF_TYPE; if (do_mtime && strcmp(left->path, METAFILE) && - (left->mtime != right->mtime || left->mtimensec != right->mtimensec)) + (left->mtime != right->mtime || + left->mtimensec != right->mtimensec)) retval |= DIFF_MTIME; if (mentry_compare_xattr(left, right)) { diff --git a/metaentry.h b/metaentry.h dissimilarity index 63% index dfc43cb..0a2dde1 100644 --- a/metaentry.h +++ b/metaentry.h @@ -1,18 +1,46 @@ -void mentries_recurse_path(const char *, struct metaentry **); -void mentries_tofile(const struct metaentry *, const char *); -void mentries_fromfile(struct metaentry **, const char *); -int mentry_find_xattr(struct metaentry *, struct metaentry *, int); - -#define DIFF_NONE 0x00 -#define DIFF_OWNER 0x01 -#define DIFF_GROUP 0x02 -#define DIFF_MODE 0x04 -#define DIFF_TYPE 0x08 -#define DIFF_MTIME 0x10 -#define DIFF_XATTR 0x20 -#define DIFF_ADDED 0x40 -#define DIFF_DELE 0x80 -void mentries_compare(struct metaentry *, struct metaentry *, - void (*printfunc)(struct metaentry *, struct metaentry *, int)); - - +/* + * Various functions to work with meta entries. + * + * Copyright (C) 2007 David Härdeman + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation version 2 of the License. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + */ + +void mentries_recurse_path(const char *opath, struct metaentry **mhead); + +void mentries_tofile(const struct metaentry *mhead, const char *path); + +void mentries_fromfile(struct metaentry **mhead, const char *path); + +int mentry_find_xattr(struct metaentry *heystack, + struct metaentry *needle, + int n); + +#define DIFF_NONE 0x00 +#define DIFF_OWNER 0x01 +#define DIFF_GROUP 0x02 +#define DIFF_MODE 0x04 +#define DIFF_TYPE 0x08 +#define DIFF_MTIME 0x10 +#define DIFF_XATTR 0x20 +#define DIFF_ADDED 0x40 +#define DIFF_DELE 0x80 +void mentries_compare(struct metaentry *, + struct metaentry *, + void (*printfunc)(struct metaentry *, + struct metaentry *, + int) + ); + diff --git a/metastore.c b/metastore.c index 7a2ac7a..9ebc8fc 100644 --- a/metastore.c +++ b/metastore.c @@ -1,3 +1,23 @@ +/* + * Main functions of the program. + * + * Copyright (C) 2007 David Härdeman + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation version 2 of the License. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + */ + #include #include #include @@ -13,8 +33,13 @@ #include "utils.h" #include "metaentry.h" +/* Used to signal whether mtimes should be corrected */ int do_mtime = 0; +/* + * Prints differences between stored and actual metadata + * - for use in mentries_compare + */ static void compare_print(struct metaentry *left, struct metaentry *right, int cmp) { @@ -49,6 +74,10 @@ compare_print(struct metaentry *left, struct metaentry *right, int cmp) msg(MSG_QUIET, "\n"); } +/* + * Tries to change the real metadata to match the stored one + * - for use in mentries_compare + */ static void compare_fix(struct metaentry *left, struct metaentry *right, int cmp) { @@ -60,7 +89,8 @@ compare_fix(struct metaentry *left, struct metaentry *right, int cmp) int i; if (!left && !right) { - msg(MSG_ERROR, "%s called with incorrect arguments\n", __FUNCTION__); + msg(MSG_ERROR, "%s called with incorrect arguments\n", + __FUNCTION__); return; } @@ -80,7 +110,8 @@ compare_fix(struct metaentry *left, struct metaentry *right, int cmp) } if (cmp & DIFF_TYPE) { - msg(MSG_NORMAL, "%s:\tnew type, will not change metadata\n", left->path); + msg(MSG_NORMAL, "%s:\tnew type, will not change metadata\n", + left->path); return; } @@ -88,40 +119,47 @@ compare_fix(struct metaentry *left, struct metaentry *right, int cmp) while (cmp & (DIFF_OWNER | DIFF_GROUP)) { if (cmp & DIFF_OWNER) { - msg(MSG_NORMAL, "\tchanging owner from %s to %s\n", left->path, left->group, right->group); + msg(MSG_NORMAL, "\tchanging owner from %s to %s\n", + left->path, left->group, right->group); owner = getpwnam(right->owner); if (!owner) { - msg(MSG_DEBUG, "\tgetpwnam failed: %s\n", strerror(errno)); + msg(MSG_DEBUG, "\tgetpwnam failed: %s\n", + strerror(errno)); break; } uid = owner->pw_uid; } if (cmp & DIFF_GROUP) { - msg(MSG_NORMAL, "\tchanging group from %s to %s\n", left->path, left->group, right->group); + msg(MSG_NORMAL, "\tchanging group from %s to %s\n", + left->path, left->group, right->group); group = getgrnam(right->group); if (!group) { - msg(MSG_DEBUG, "\tgetgrnam failed: %s\n", strerror(errno)); + msg(MSG_DEBUG, "\tgetgrnam failed: %s\n", + strerror(errno)); break; } gid = group->gr_gid; } if (lchown(left->path, uid, gid)) { - msg(MSG_DEBUG, "\tlchown failed: %s\n", strerror(errno)); + msg(MSG_DEBUG, "\tlchown failed: %s\n", + strerror(errno)); break; } break; } if (cmp & DIFF_MODE) { - msg(MSG_NORMAL, "%s:\tchanging mode from 0%o to 0%o\n", left->path, left->mode, right->mode); + msg(MSG_NORMAL, "%s:\tchanging mode from 0%o to 0%o\n", + left->path, left->mode, right->mode); if (chmod(left->path, left->mode)) msg(MSG_DEBUG, "\tchmod failed: %s\n", strerror(errno)); } if (cmp & DIFF_MTIME) { - msg(MSG_NORMAL, "%s:\tchanging mtime from %ld to %ld\n", left->path, left->mtime, right->mtime); + msg(MSG_NORMAL, "%s:\tchanging mtime from %ld to %ld\n", + left->path, left->mtime, right->mtime); /* FIXME: Use utimensat here */ tbuf.actime = right->mtime; tbuf.modtime = right->mtime; @@ -140,7 +178,8 @@ compare_fix(struct metaentry *left, struct metaentry *right, int cmp) msg(MSG_NORMAL, "%s:\tremoving xattr %s\n", left->path, left->xattr_names[i]); if (lremovexattr(left->path, left->xattr_names[i])) - msg(MSG_DEBUG, "\tlremovexattr failed: %s\n", strerror(errno)); + msg(MSG_DEBUG, "\tlremovexattr failed: %s\n", + strerror(errno)); } for (i = 0; i < right->xattrs; i++) { @@ -151,12 +190,15 @@ compare_fix(struct metaentry *left, struct metaentry *right, int cmp) msg(MSG_NORMAL, "%s:\tadding xattr %s\n", right->path, right->xattr_names[i]); if (lsetxattr(right->path, right->xattr_names[i], - right->xattr_values[i], right->xattr_lvalues[i], XATTR_CREATE)) - msg(MSG_DEBUG, "\tlsetxattr failed: %s\n", strerror(errno)); + right->xattr_values[i], + right->xattr_lvalues[i], XATTR_CREATE)) + msg(MSG_DEBUG, "\tlsetxattr failed: %s\n", + strerror(errno)); } } } +/* Prints usage message and exits */ static void usage(const char *arg0, const char *message) { @@ -164,7 +206,7 @@ usage(const char *arg0, const char *message) msg(MSG_CRITICAL, "%s: %s\n\n", arg0, msg); msg(MSG_CRITICAL, "Usage: %s ACTION [OPTIONS] [PATH]...\n\n", arg0); msg(MSG_CRITICAL, "Where ACTION is one of:\n" - " -d, --diff\tShow differences between stored and actual metadata\n" + " -d, --diff\tShow differences between stored and real metadata\n" " -s, --save\tSave current metadata\n" " -a, --apply\tApply stored metadata\n" " -h, --help\tHelp message (this text)\n\n" @@ -175,6 +217,7 @@ usage(const char *arg0, const char *message) exit(message ? EXIT_FAILURE : EXIT_SUCCESS); } +/* Options */ static struct option long_options[] = { {"compare", 0, 0, 0}, {"save", 0, 0, 0}, @@ -186,6 +229,7 @@ static struct option long_options[] = { {0, 0, 0, 0} }; +/* Main function */ int main(int argc, char **argv, char **envp) { @@ -194,19 +238,23 @@ main(int argc, char **argv, char **envp) struct metaentry *mfhead = NULL; int action = 0; + /* Parse options */ i = 0; while (1) { int option_index = 0; - c = getopt_long(argc, argv, "csahvqm", long_options, &option_index); + c = getopt_long(argc, argv, "csahvqm", + long_options, &option_index); if (c == -1) break; switch (c) { case 0: if (!strcmp("verbose", long_options[option_index].name)) { verbosity++; - } else if (!strcmp("quiet", long_options[option_index].name)) { + } else if (!strcmp("quiet", + long_options[option_index].name)) { verbosity--; - } else if (!strcmp("mtime", long_options[option_index].name)) { + } else if (!strcmp("mtime", + long_options[option_index].name)) { do_mtime = 1; } else { action |= (1 << option_index); @@ -243,14 +291,17 @@ main(int argc, char **argv, char **envp) } } + /* Make sure only one action is specified */ if (i != 1) usage(argv[0], "incorrect option(s)"); + /* Perform action */ switch (action) { case ACTION_DIFF: mentries_fromfile(&mfhead, METAFILE); if (!mfhead) { - msg(MSG_CRITICAL, "Failed to load metadata from file\n"); + msg(MSG_CRITICAL, "Failed to load metadata from %s\n", + METAFILE); exit(EXIT_FAILURE); } @@ -262,7 +313,8 @@ main(int argc, char **argv, char **envp) } if (!mhead) { - msg(MSG_CRITICAL, "Failed to load metadata from file system\n"); + msg(MSG_CRITICAL, + "Failed to load metadata from file system\n"); exit(EXIT_FAILURE); } @@ -278,7 +330,8 @@ main(int argc, char **argv, char **envp) } if (!mhead) { - msg(MSG_CRITICAL, "Failed to load metadata from file system\n"); + msg(MSG_CRITICAL, + "Failed to load metadata from file system\n"); exit(EXIT_FAILURE); } @@ -288,7 +341,8 @@ main(int argc, char **argv, char **envp) case ACTION_APPLY: mentries_fromfile(&mfhead, METAFILE); if (!mfhead) { - msg(MSG_CRITICAL, "Failed to load metadata from file\n"); + msg(MSG_CRITICAL, "Failed to load metadata from %s\n", + METAFILE); exit(EXIT_FAILURE); } @@ -300,7 +354,8 @@ main(int argc, char **argv, char **envp) } if (!mhead) { - msg(MSG_CRITICAL, "Failed to load metadata from file system\n"); + msg(MSG_CRITICAL, + "Failed to load metadata from file system\n"); exit(EXIT_FAILURE); } @@ -313,3 +368,4 @@ main(int argc, char **argv, char **envp) exit(EXIT_SUCCESS); } + diff --git a/metastore.h b/metastore.h index e8f52bb..62c9ff0 100644 --- a/metastore.h +++ b/metastore.h @@ -1,16 +1,42 @@ +/* + * Main functions of the program. + * + * Copyright (C) 2007 David Härdeman + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation version 2 of the License. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + */ + +/* Each file starts with SIGNATURE and VERSION */ #define SIGNATURE "MeTaSt00r3" #define SIGNATURELEN 10 #define VERSION "\0\0\0\0\0\0\0\0" #define VERSIONLEN 8 + +/* Default filename */ #define METAFILE "./.metadata" +/* Utility defines for the action to take */ #define ACTION_DIFF 0x01 #define ACTION_SAVE 0x02 #define ACTION_APPLY 0x04 #define ACTION_HELP 0x08 +/* Used to signal whether mtimes should be corrected */ extern int do_mtime; +/* Data structure to hold all metadata for a file */ struct metaentry { struct metaentry *next; char *path; diff --git a/utils.c b/utils.c index dc053ea..3c73c6b 100644 --- a/utils.c +++ b/utils.c @@ -1,3 +1,23 @@ +/* + * Main functions of the program. + * + * Copyright (C) 2007 David Härdeman + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation version 2 of the License. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + */ + #include #include #include @@ -7,8 +27,13 @@ #include "utils.h" +/* Controls the verbosity level for msg() */ int verbosity = 0; +/* + * Prints messages to console according to the current verbosity + * - see utils.h for level defines + */ int msg(int level, const char *fmt, ...) { @@ -29,6 +54,7 @@ msg(int level, const char *fmt, ...) return ret; } +/* Malloc which either succeeds or exits */ void * xmalloc(size_t size) { @@ -40,6 +66,7 @@ xmalloc(size_t size) return result; } +/* Ditto for strdup */ char * xstrdup(const char *s) { @@ -51,6 +78,7 @@ xstrdup(const char *s) return result; } +/* Human-readable printout of binary data */ void binary_print(const char *s, ssize_t len) { @@ -64,6 +92,7 @@ binary_print(const char *s, ssize_t len) } } +/* Writes data to a file or exits on failure */ void xfwrite(const void *ptr, size_t size, FILE *stream) { @@ -73,6 +102,7 @@ xfwrite(const void *ptr, size_t size, FILE *stream) } } +/* Writes an int to a file, using len bytes, in bigendian order */ void write_int(uint64_t value, size_t len, FILE *to) { @@ -84,18 +114,21 @@ write_int(uint64_t value, size_t len, FILE *to) xfwrite(buf, len, to); } +/* Writes a binary string to a file */ void write_binary_string(const char *string, size_t len, FILE *to) { xfwrite(string, len, to); } +/* Writes a normal C string to a file */ void write_string(const char *string, FILE *to) { xfwrite(string, strlen(string) + 1, to); } +/* Reads an int from a file, using len bytes, in bigendian order */ uint64_t read_int(char **from, size_t len, const char *max) { @@ -103,7 +136,8 @@ read_int(char **from, size_t len, const char *max) int i; if (*from + len > max) { - msg(MSG_CRITICAL, "Attempt to read beyond end of file, corrupt file?\n"); + msg(MSG_CRITICAL, + "Attempt to read beyond end of file, corrupt file?\n"); exit(EXIT_FAILURE); } @@ -113,13 +147,15 @@ read_int(char **from, size_t len, const char *max) return result; } +/* Reads a binary string from a file */ char * read_binary_string(char **from, size_t len, const char *max) { char *result; if (*from + len > max) { - msg(MSG_CRITICAL, "Attempt to read beyond end of file, corrupt file?\n"); + msg(MSG_CRITICAL, + "Attempt to read beyond end of file, corrupt file?\n"); exit(EXIT_FAILURE); } @@ -129,6 +165,7 @@ read_binary_string(char **from, size_t len, const char *max) return result; } +/* Reads a normal C string from a file */ char * read_string(char **from, const char *max) { diff --git a/utils.h b/utils.h index dac3bc4..76d6ca5 100644 --- a/utils.h +++ b/utils.h @@ -1,24 +1,67 @@ +/* + * Main functions of the program. + * + * Copyright (C) 2007 David Härdeman + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation version 2 of the License. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + */ + +/* For uint64_t */ #include +/* Controls the verbosity level for msg() */ extern int verbosity; + +/* Verbosity levels using stdout */ #define MSG_NORMAL 0 #define MSG_DEBUG 1 #define MSG_QUIET -1 +/* Verbosity levels using stderr */ #define MSG_ERROR -2 #define MSG_CRITICAL -3 +/* Prints messages to console according to the current verbosity */ int msg(int level, const char *fmt, ...); +/* Malloc which either succeeds or exits */ void *xmalloc(size_t size); + +/* Ditto for strdup */ char *xstrdup(const char *s); + +/* Human-readable printout of binary data */ void binary_print(const char *s, ssize_t len); + +/* Writes data to a file or exits on failure */ void xfwrite(const void *ptr, size_t size, FILE *stream); +/* Writes an int to a file, using len bytes, in bigendian order */ void write_int(uint64_t value, size_t len, FILE *to); + +/* Writes a binary string to a file */ void write_binary_string(const char *string, size_t len, FILE *to); + +/* Writes a normal C string to a file */ void write_string(const char *string, FILE *to); +/* Reads an int from a file, using len bytes, in bigendian order */ uint64_t read_int(char **from, size_t len, const char *max); + +/* Reads a binary string from a file */ char *read_binary_string(char **from, size_t len, const char *max); + +/* Reads a normal C string from a file */ char *read_string(char **from, const char *max); -- 2.11.4.GIT