don't update xattr of unchanged files if -cache used

Author: Colum Paget

CHANGELOG

@@ -1,3 +1,6 @@
+v1.22 (2024-07-18)
+  * if '-cache' option is used with '-xattr', then do not update files where xattr hash matches the file (feature request from https://github.com/eatnumber1).
+
 v1.21 (2024-06-20)
   * fix -hmac option that's been broken by changes in libUseful
   * add '-list-hashes' option to list available has types

Makefile

@@ -1,10 +1,10 @@
 CC = gcc
 CFLAGS = -g -O2
-LIBS = libUseful-5/libUseful.a -lssl -lcrypto -lz  
+LIBS = libUseful-5/libUseful.a -lssl -lcrypto -lz -lc  
 INSTALL=/usr/bin/install -c
 prefix=/usr/local
 bindir=$(prefix)${exec_prefix}/bin
-FLAGS=$(LDFLAGS) $(CPPFLAGS) $(CFLAGS) -DPACKAGE_NAME=\"\" -DPACKAGE_TARNAME=\"\" -DPACKAGE_VERSION=\"\" -DPACKAGE_STRING=\"\" -DPACKAGE_BUGREPORT=\"\" -DPACKAGE_URL=\"\" -DHAVE_STDIO_H=1 -DHAVE_STDLIB_H=1 -DHAVE_STRING_H=1 -DHAVE_INTTYPES_H=1 -DHAVE_STDINT_H=1 -DHAVE_STRINGS_H=1 -DHAVE_SYS_STAT_H=1 -DHAVE_SYS_TYPES_H=1 -DHAVE_UNISTD_H=1 -DSTDC_HEADERS=1 -DHAVE_LIBZ=1 -DHAVE_LIBCRYPTO=1 -DHAVE_LIBSSL=1
+FLAGS=$(LDFLAGS) $(CPPFLAGS) $(CFLAGS) -DPACKAGE_NAME=\"\" -DPACKAGE_TARNAME=\"\" -DPACKAGE_VERSION=\"\" -DPACKAGE_STRING=\"\" -DPACKAGE_BUGREPORT=\"\" -DPACKAGE_URL=\"\" -DHAVE_STDIO_H=1 -DHAVE_STDLIB_H=1 -DHAVE_STRING_H=1 -DHAVE_INTTYPES_H=1 -DHAVE_STDINT_H=1 -DHAVE_STRINGS_H=1 -DHAVE_SYS_STAT_H=1 -DHAVE_SYS_TYPES_H=1 -DHAVE_UNISTD_H=1 -DSTDC_HEADERS=1 -DHAVE_LIBC=1 -DUSE_XATTR=1 -DHAVE_LIBZ=1 -DHAVE_LIBCRYPTO=1 -DHAVE_LIBSSL=1
 OBJ=common.o encodings.o command-line-args.o ssh.o http.o fingerprint.o include-exclude.o files.o filesigning.o xattr.o check-hash.o find.o otp.o memcached.o frontend.o cgi.o xdialog.o output.o
 EXE=hashrat
 

README.md

@@ -141,7 +141,7 @@ OPTIONS
   -xattr          Use eXtended file ATTRibutes. In hash mode, store hashes in the file attributes, in check mode compare against hashes stored in file attributes.
   -txattr         Use TRUSTED eXtended file ATTRibutes. In hash mode, store hashes in 'trusted' file attributes. 'trusted' attributes can only be read and written by root. Under freebsd this menas SYSTEM attributes.
   -attrs          comma-separated list of filesystem attribute names to be set to the value of the hash.
-  -cache          Use hashes stored in 'user' xattr if they're younger than the mtime of the file. This speeds up outputting hashes.
+  -cache          Use hashes stored in 'user' xattr if they're younger than the mtime of the file. This speeds up outputting hashes. When storing hashes, do not update files that already have the correct hash.
   -u <types>      Update. In checking mode, update hashes for the files as you go. <types> is a comma-separated list of things to update, which can be 'xattr' 'memcached' or a file name. This will update these targets with the hash that was found at the time of checking.
   -hide-input     When reading data from stdin in linemode, set the terminal to not echo characters, thus hiding typed input.
   -star-input     When reading data from stdin in linemode replace characters with stars.

check.sh

@@ -207,7 +207,7 @@ TestHash z85 "ZEROMQ85 encoding" "=SI2F3[n}kp9Zn?Ra>yK"
 Title "Testing Misc. Features"
 
 HR_OUT=`./hashrat -version`
-if [ "$HR_OUT" = "version: 1.21" ]
+if [ "$HR_OUT" = "version: 1.22" ]
 then
 	OkayMessage "Version (-version) works"
 else

command-line-args.c

@@ -538,7 +538,7 @@ void CommandLinePrintUsage()
     printf("  %-15s %s\n","-xattr", "Use eXtended file ATTRibutes. In hash mode, store hashes in the file attributes, in check mode compare against hashes stored in file attributes.");
     printf("  %-15s %s\n","-txattr", "Use TRUSTED eXtended file ATTRibutes. In hash mode, store hashes in 'trusted' file attributes. 'trusted' attributes can only be read and written by root. Under freebsd this menas SYSTEM attributes.");
     printf("  %-15s %s\n","-attrs", "comma-separated list of filesystem attribute names to be set to the value of the hash.");
-    printf("  %-15s %s\n","-cache", "Use hashes stored in 'user' xattr if they're younger than the mtime of the file. This speeds up outputting hashes.");
+    printf("  %-15s %s\n","-cache", "Use hashes stored in 'user' xattr if they're younger than the mtime of the file. This speeds up outputting hashes. Also do not update xattr of a file if it already matches.");
     printf("  %-15s %s\n","-u <types>", "Update. In checking mode, update hashes for the files as you go. <types> is a comma-separated list of things to update, which can be 'xattr' 'memcached' or a file name. This will update these targets with the hash that was found at the time of checking.");
     printf("  %-15s %s\n","-hide-input", "When reading data from stdin in linemode, set the terminal to not echo characters, thus hiding typed input.");
     printf("  %-15s %s\n","-star-input", "When reading data from stdin in linemode replace characters with stars.");

common.c

@@ -69,7 +69,16 @@ void HashratStoreHash(HashratCtx *Ctx, const char *Path, struct stat *Stat, cons
 //	else
 
 
-    if (Ctx->Flags & CTX_STORE_XATTR) HashRatSetXAttr(Ctx, Path, Stat, Ctx->HashType, Hash);
+    if (Ctx->Flags & CTX_STORE_XATTR)
+    {
+        if (Ctx->Flags & CTX_XATTR_CACHE)
+        {
+            if ((Ctx->Flags & CTX_XATTR_ROOT) && (getuid()==0)) XAttrGetHash(Ctx, "trusted", Ctx->HashType, Path, NULL, &Tempstr);
+            else XAttrGetHash(Ctx, "user", Ctx->HashType, Path, NULL, &Tempstr);
+            if (strcmp(Tempstr, Hash) !=0) HashRatSetXAttr(Ctx, Path, Stat, Ctx->HashType, Hash);
+        }
+        else HashRatSetXAttr(Ctx, Path, Stat, Ctx->HashType, Hash);
+    }
 
     if (Ctx->Flags & CTX_STORE_MEMCACHED)
     {

common.h

@@ -5,7 +5,7 @@
 #include "libUseful-5/libUseful.h"
 #include "glob.h"
 
-#define VERSION "1.21"
+#define VERSION "1.22"
 
 #define ACT_NONE 0
 #define ACT_HASH 1

files.c

@@ -232,6 +232,7 @@ int HashratHashSingleFile(HashratCtx *Ctx, const char *HashType, int FileType, c
     HASH *Hash;
     struct stat XattrStat;
     const char *ptr;
+    typedef long long unsigned int llui;
 
     *RetStr=CopyStr(*RetStr,"");
 
@@ -240,7 +241,7 @@ int HashratHashSingleFile(HashratCtx *Ctx, const char *HashType, int FileType, c
     {
         XAttrGetHash(Ctx, "user", Ctx->HashType, Path, &XattrStat, RetStr);
         //only use the hash cached in the xattr address if it's younger than the mtime
-        printf("cache %llu %llu %llu\n",XattrStat.st_mtime, FStat->st_mtime, XattrStat.st_mtime - FStat->st_mtime);
+        printf("cache %llu %llu %llu\n",(llui) XattrStat.st_mtime, (llui) FStat->st_mtime, (llui) (XattrStat.st_mtime - FStat->st_mtime));
         if ( ((XattrStat.st_mtime - FStat->st_mtime) < 10) ) *RetStr=CopyStr(*RetStr,"");
     }
 

hashrat.1

@@ -321,7 +321,7 @@ Use TRUSTED eXtended \fIfile\fP ATTRibutes. In \fIhash\fP mode, store \fIhashes\
 .TP
 .B
 \fB-cache\fP
-Use \fIhashes\fP stored in user xattr if they're younger than the mtime of the \fIfile\fP. This speeds up outputting \fIhashes\fP.
+Use \fIhashes\fP stored in user xattr if they're younger than the mtime of the \fIfile\fP. This speeds up outputting \fIhashes\fP. When storing xattr hashes, do not update files that already have the correct hash.
 .TP
 .B
 \fB-u\fP <types>

main.c

@@ -160,11 +160,11 @@ int main(int argc, char *argv[])
 
         switch (Ctx->Action)
         {
-	case ACT_LIST_TYPES:
-	    Tempstr=HashAvailableTypes(Tempstr);
-	    strrep(Tempstr, ',', '\n');
-	    printf("%s\n", Tempstr);
-	    break;
+        case ACT_LIST_TYPES:
+            Tempstr=HashAvailableTypes(Tempstr);
+            strrep(Tempstr, ',', '\n');
+            printf("%s\n", Tempstr);
+            break;
 
         case ACT_HASH:
             result=ProcessTargetItems(Ctx);

xattr.c

@@ -100,7 +100,7 @@ int XAttrGetHash(HashratCtx *Ctx, const char *XattrType, const char *HashType, c
 {
     int result=FALSE;
     char *Tempstr=NULL;
-    char *ptr;
+    const char *ptr;
     int len;
 
     *Hash=SetStrLen(*Hash,255);
@@ -115,14 +115,16 @@ int XAttrGetHash(HashratCtx *Ctx, const char *XattrType, const char *HashType, c
     fprintf(stderr,"XATTR Support not compiled in.\n");
 #endif
 
+
     if (len > 0)
     {
         (*Hash)[len]='\0';
+
         ptr=*Hash;
-        FStat->st_mtime=(time_t) strtoll(ptr,&ptr,10);
-        if (*ptr==':') ptr++;
-        FStat->st_size=(off_t) strtoll(ptr,&ptr,10);
-        if (*ptr==':') ptr++;
+        ptr=GetToken(ptr, ":", &Tempstr, 0);
+        if (FStat) FStat->st_mtime=(time_t) strtoll(Tempstr,NULL,10);
+        ptr=GetToken(ptr, ":", &Tempstr, 0);
+        if (FStat) FStat->st_size=(off_t) strtoll(Tempstr,NULL,10);
         len=StrLen(ptr);
         memmove(*Hash,ptr,len+1);
         result=TRUE;