finddup.c

   1
   2 /*
   3  *  finddup is a simple utility to find duplicated files, files common
   4  *  to several directories, or files present in one directory and not
   5  *  in another one.
   6  *
   7  *  Copyright (c) 2010 Francois Fleuret
   8  *  Written by Francois Fleuret <francois@fleuret.org>
   9  *
  10  *  This file is part of finddup.
  11  *
  12  *  finddup is free software: you can redistribute it and/or modify it
  13  *  under the terms of the GNU General Public License version 3 as
  14  *  published by the Free Software Foundation.
  15  *
  16  *  finddup is distributed in the hope that it will be useful, but WITHOUT
  17  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  18  *  or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
  19  *  License for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License
  22  *  along with finddup.  If not, see <http://www.gnu.org/licenses/>.
  23  *
  24  */
  25
  26 #define VERSION_NUMBER "0.6"
  27
  28 #define _BSD_SOURCE
  29
  30 #include <sys/types.h>
  31 #include <sys/stat.h>
  32 #include <sys/param.h>
  33 #include <dirent.h>
  34 #include <stdlib.h>
  35 #include <stdio.h>
  36 #include <unistd.h>
  37 #include <errno.h>
  38 #include <string.h>
  39 #include <sys/ioctl.h>
  40 #include <locale.h>
  41 #include <getopt.h>
  42 #include <fcntl.h>
  43
  44 /* 1M really helps compared to 64k */
  45 #define READ_BUFFER_SIZE (1024 * 1024)
  46
  47 typedef int64_t size_sum_t;
  48
  49 /* Yeah, global variables! */
  50
  51 int ignore_dotfiles = 0; /* 1 means ignore files and directories
  52                             starting with a dot */
  53
  54 int ignore_empty_files = 0; /* 1 means ignore empty files */
  55
  56 int show_realpaths = 0; /* 1 means ignore files and directories
  57                             starting with a dot */
  58
  59 int show_progress = 0; /* 1 means show a progress bar when we are in a
  60                           tty */
  61
  62 int show_hits = 1; /* 1 means to show the files from dir2
  63                       corresponding to the ones from dir1 */
  64
  65 int show_groups = 1; /* 1 means to show the group IDs when printing
  66                         file names */
  67
  68 int ignore_same_inode = 0; /* 1 means that comparison between two file
  69                               with same inode will always be false */
  70
  71 int tty_width = -1; /* Positive value means what width to use to show
  72                        the progress bar */
  73
  74 /********************************************************************/
  75
  76 /* malloc with error checking.  */
  77
  78 void *safe_malloc(size_t n) {
  79   void *p = malloc(n);
  80   if (!p && n != 0) {
  81     printf("Can not allocate memory: %s\n", strerror(errno));
  82     exit(EXIT_FAILURE);
  83   }
  84   return p;
  85 }
  86
  87 /********************************************************************/
  88
  89 int ignore_entry(const char *name) {
  90   return
  91     strcmp(name, ".") == 0 ||
  92     strcmp(name, "..") == 0 ||
  93     (ignore_dotfiles && name[0] == '.');
  94 }
  95
  96 void print_size_sum(size_sum_t s) {
  97   char tmp[100];
  98   char *a = tmp + sizeof(tmp)/sizeof(char);
  99   *(--a) = '\0';
 100   if(s) {
 101     while(s) {
 102       *(--a) = s%10 + '0';
 103       s /= 10;
 104     }
 105   } else {
 106     *(--a) = '0';
 107   }
 108   printf(a);
 109 }
 110
 111 /**********************************************************************/
 112
 113 struct file_with_size {
 114   char *filename;
 115   size_t size;
 116   ino_t inode;
 117   struct file_with_size *next;
 118   int group_id, dir_id;
 119 };
 120
 121 void file_list_delete(struct file_with_size *head) {
 122   struct file_with_size *next;
 123   while(head) {
 124     next = head->next;
 125     free(head->filename);
 126     free(head);
 127     head = next;
 128   }
 129 }
 130
 131 int file_list_length(struct file_with_size *head) {
 132   int l = 0;
 133   while(head) {
 134     l++;
 135     head = head->next;
 136   }
 137   return l;
 138 }
 139
 140 /**********************************************************************/
 141
 142 int same_content(struct file_with_size *f1, struct file_with_size *f2,
 143                  char *buffer1, char *buffer2) {
 144   int fd1, fd2, s1, s2;
 145
 146   fd1 = open(f1->filename, O_RDONLY);
 147   fd2 = open(f2->filename, O_RDONLY);
 148
 149   if(fd1 >= 0 && fd2 >= 0) {
 150     while(1) {
 151       s1 = read(fd1, buffer1, READ_BUFFER_SIZE);
 152       s2 = read(fd2, buffer2, READ_BUFFER_SIZE);
 153
 154       if(s1 < 0 || s2 < 0) {
 155         close(fd1);
 156         close(fd2);
 157         return 0;
 158       }
 159
 160       if(s1 == s2) {
 161         if(s1 == 0) {
 162           close(fd1);
 163           close(fd2);
 164           return 1;
 165         } else {
 166           if(memcmp(buffer1, buffer2, s1)) {
 167             close(fd1);
 168             close(fd2);
 169             return 0;
 170           }
 171         }
 172       } else {
 173         fprintf(stderr,
 174                 "Different read size without error on files of same size.\n");
 175         exit(EXIT_FAILURE);
 176       }
 177     }
 178   } else {
 179
 180     if(fd1 < 0) {
 181       fprintf(stderr,
 182               "Can not open \"%s\" error: %s\n",
 183               f1->filename,
 184               strerror(errno));
 185     }
 186
 187     if(fd2 < 0) {
 188       fprintf(stderr,
 189               "Can not open \"%s\" error: %s\n",
 190               f2->filename,
 191               strerror(errno));
 192     }
 193     exit(EXIT_FAILURE);
 194   }
 195 }
 196
 197 int same_files(struct file_with_size *f1, struct file_with_size *f2,
 198                char *buffer1, char *buffer2) {
 199   if(ignore_same_inode && f1->inode == f2->inode) {
 200     return 0;
 201   }
 202   return f1->size == f2->size && same_content(f1, f2, buffer1, buffer2);
 203 }
 204
 205 /**********************************************************************/
 206
 207 struct file_with_size *scan_directory(struct file_with_size *tail,
 208                                       const char *name) {
 209   DIR *dir;
 210   struct dirent *dir_e;
 211   struct stat sb;
 212   struct file_with_size *tmp;
 213   char subname[PATH_MAX + 1];
 214
 215   if(lstat(name, &sb) != 0) {
 216     fprintf(stderr, "Can not stat \"%s\": %s\n", name, strerror(errno));
 217     exit(EXIT_FAILURE);
 218   }
 219
 220   if(S_ISLNK(sb.st_mode)) {
 221     return tail;
 222   }
 223
 224   dir = opendir(name);
 225
 226   if(dir) {
 227     while((dir_e = readdir(dir))) {
 228       if(!ignore_entry(dir_e->d_name)) {
 229         snprintf(subname, PATH_MAX, "%s/%s", name, dir_e->d_name);
 230         tail = scan_directory(tail, subname);
 231       }
 232     }
 233     closedir(dir);
 234   } else {
 235     if(S_ISREG(sb.st_mode)) {
 236       if(!ignore_entry(name)) {
 237         if(!ignore_empty_files || sb.st_size > 0) {
 238           tmp = safe_malloc(sizeof(struct file_with_size));
 239           tmp->next = tail;
 240           tmp->filename = strdup(name);
 241           tmp->size = sb.st_size;
 242           tmp->inode = sb.st_ino;
 243           tmp->group_id = -1;
 244           tmp->dir_id = -1;
 245           tail = tmp;
 246         }
 247       }
 248     }
 249   }
 250
 251   return tail;
 252 }
 253
 254 void print_file(struct file_with_size *node) {
 255   char tmp[PATH_MAX + 1];
 256   if(show_realpaths) {
 257     if(realpath(node->filename, tmp)) {
 258       if(show_groups) {
 259         printf("%d %s\n", node->group_id, tmp);
 260       } else {
 261         printf("%s\n", tmp);
 262       }
 263     } else {
 264       printf("Can not get the realpath of \"%s\": %s\n",
 265              node->filename,
 266              strerror(errno));
 267       exit(EXIT_FAILURE);
 268     }
 269   } else {
 270     if(show_groups) {
 271       printf("%d %s\n", node->group_id, node->filename);
 272     } else {
 273       printf("%s\n", node->filename);
 274     }
 275   }
 276 }
 277
 278 int compare_nodes(const void *x1, const void *x2) {
 279   const struct file_with_size **f1, **f2;
 280
 281   f1 = (const struct file_with_size **) x1;
 282   f2 = (const struct file_with_size **) x2;
 283
 284   if((*f1)->group_id < (*f2)->group_id) {
 285     return -1;
 286   } else if((*f1)->group_id > (*f2)->group_id) {
 287     return 1;
 288   } else {
 289     if((*f1)->dir_id < (*f2)->dir_id) {
 290       return -1;
 291     } else if((*f1)->dir_id > (*f2)->dir_id) {
 292       return 1;
 293     } else {
 294       return 0;
 295     }
 296   }
 297 }
 298
 299
 300 void print_result(struct file_with_size *list1, struct file_with_size *list2) {
 301   struct file_with_size *node1, *node2;
 302   struct file_with_size **nodes;
 303   int nb, n;
 304
 305   nb = 0;
 306   for(node1 = list1; node1; node1 = node1->next) {
 307     if(node1->group_id >= 0) { nb++; }
 308   }
 309
 310   if(list2) {
 311     for(node2 = list2; node2; node2 = node2->next) {
 312       if(node2->group_id >= 0) { nb++; }
 313     }
 314   }
 315
 316   nodes = safe_malloc(nb * sizeof(struct file_with_size *));
 317
 318   n = 0;
 319   for(node1 = list1; node1; node1 = node1->next) {
 320     if(node1->group_id >= 0) {
 321       nodes[n++] = node1;
 322     }
 323   }
 324
 325   if(list2) {
 326     for(node2 = list2; node2; node2 = node2->next) {
 327       if(node2->group_id >= 0) {
 328         nodes[n++] = node2;
 329       }
 330     }
 331   }
 332
 333   qsort(nodes, nb, sizeof(struct file_with_size *), compare_nodes);
 334
 335   for(n = 0; n < nb; n++) {
 336     if(!show_groups && n > 0 && nodes[n]->group_id != nodes[n-1]->group_id) {
 337       printf("\n");
 338     }
 339     print_file(nodes[n]);
 340   }
 341
 342   free(nodes);
 343 }
 344
 345 void print_progress(int max, int n, int *pp) {
 346   int p, k;
 347   int width;
 348   if(show_progress && tty_width > 0) {
 349     width = tty_width - 7;
 350     p = (width * n) / (max - 1);
 351     if(p > *pp) {
 352       for(k = 0; k < p; k++) {
 353         fprintf(stderr, "+");
 354       }
 355       for(; k < width; k++) {
 356         fprintf(stderr, "-");
 357       }
 358       *pp = p;
 359       p = (100 * n) / (max - 1);
 360       fprintf(stderr, " [%3d%%]\r", p);
 361     }
 362   }
 363 }
 364
 365 void start(const char *dirname1, const char *dirname2) {
 366   struct file_with_size *list1, *list2;
 367   struct file_with_size *node1, *node2;
 368   int not_in, found;
 369   int nb_groups, nb_nodes;
 370   int list1_length, previous_progress;
 371
 372   char *buffer1 = safe_malloc(sizeof(char) * READ_BUFFER_SIZE);
 373   char *buffer2 = safe_malloc(sizeof(char) * READ_BUFFER_SIZE);
 374
 375   not_in = 0;
 376
 377   if(show_progress) {
 378     fprintf(stderr, "Scanning %s ... ", dirname1);
 379   }
 380
 381   list1 = scan_directory(0, dirname1);
 382
 383   if(dirname2) {
 384     if(strncmp(dirname2, "not:", 4) == 0) {
 385       not_in = 1;
 386       /* groups are not computed in the not: mode */
 387       show_groups = 0;
 388       dirname2 += 4;
 389     } else if(strncmp(dirname2, "and:", 4) == 0) {
 390       dirname2 += 4;
 391     }
 392     if(show_progress) {
 393       fprintf(stderr, "%s ... ", dirname2);
 394     }
 395     list2 = scan_directory(0, dirname2);
 396   } else {
 397     list2 = list1;
 398   }
 399
 400   if(show_progress) {
 401     fprintf(stderr, "done.\n");
 402   }
 403
 404   nb_groups = 0;
 405   previous_progress = -1;
 406   nb_nodes = 0;
 407   list1_length = file_list_length(list1);
 408
 409   if(not_in) {
 410     for(node1 = list1; node1; node1 = node1->next) {
 411       print_progress(list1_length, nb_nodes, &previous_progress);
 412       nb_nodes++;
 413
 414       found = 0;
 415
 416       for(node2 = list2; !found && node2; node2 = node2->next) {
 417         if(same_files(node1, node2, buffer1, buffer2)) {
 418           found = 1;
 419         }
 420       }
 421
 422       if(!found) {
 423         if(show_realpaths) {
 424           printf("%s\n", realpath(node1->filename, 0));
 425         } else {
 426           printf("%s\n", node1->filename);
 427         }
 428       }
 429     }
 430
 431   } else {
 432     for(node1 = list1; node1; node1 = node1->next) {
 433       print_progress(list1_length, nb_nodes, &previous_progress);
 434       nb_nodes++;
 435
 436       for(node2 = list2; node2; node2 = node2->next) {
 437         if(node1->group_id < 0 || node2->group_id < 0) {
 438           if(same_files(node1, node2, buffer1, buffer2)) {
 439             if(node1->group_id < 0) {
 440               if(node2->group_id >= 0) {
 441                 node1->group_id = node2->group_id;
 442               } else {
 443                 node1->group_id = nb_groups;
 444                 node1->dir_id = 1;
 445                 nb_groups++;
 446               }
 447             }
 448             if(node2->group_id < 0) {
 449               node2->group_id = node1->group_id;
 450               node2->dir_id = 2;
 451             }
 452           }
 453         }
 454       }
 455     }
 456   }
 457
 458   if(show_progress) {
 459     fprintf(stderr, "\n");
 460   }
 461
 462   if(dirname2) {
 463     print_result(list1, list2);
 464     file_list_delete(list1);
 465     file_list_delete(list2);
 466   } else {
 467     print_result(list1, 0);
 468     file_list_delete(list1);
 469   }
 470
 471   free(buffer1);
 472   free(buffer2);
 473 }
 474
 475 void print_help(FILE *out) {
 476   fprintf(out, "Usage: finddup [OPTION]... DIR1 [[and:|not:]DIR2]\n");
 477   fprintf(out, "Version %s (%s)\n", VERSION_NUMBER, UNAME);
 478   fprintf(out, "Without DIR2, lists duplicated files found in DIR1. With DIR2, lists files common to both directories. With the not: prefix, lists files found in DIR1 which do not exist in DIR2. The and: prefix is the default and should be used only if you have a directory starting with 'not:'\n");
 479   fprintf(out, "\n");
 480   fprintf(out, "   -h   show this help\n");
 481   fprintf(out, "   -d   ignore dot files and directories\n");
 482   fprintf(out, "   -0   ignore empty files\n");
 483   fprintf(out, "   -c   do not show which files in DIR2 corresponds to those in DIR1\n");
 484   fprintf(out, "   -g   do not show the file groups\n");
 485   fprintf(out, "   -p   show progress\n");
 486   fprintf(out, "   -r   show the real file paths\n");
 487   fprintf(out, "   -i   consider files with same inode as different\n");
 488   fprintf(out, "\n");
 489   fprintf(out, "Report bugs and comments to <francois@fleuret.org>\n");
 490 }
 491
 492 /**********************************************************************/
 493
 494 int main(int argc, char **argv) {
 495   int c;
 496   struct file_with_size *root;
 497   struct winsize win;
 498
 499   root = 0;
 500
 501   setlocale (LC_ALL, "");
 502
 503   while (1) {
 504     c = getopt(argc, argv, "hircgd0p");
 505     if (c == -1)
 506       break;
 507
 508     switch (c) {
 509
 510     case 'h':
 511       print_help(stdout);
 512       exit(EXIT_SUCCESS);
 513
 514       break;
 515
 516     case 'd':
 517       ignore_dotfiles = 1;
 518       break;
 519
 520     case '0':
 521       ignore_empty_files = 1;
 522       break;
 523
 524     case 'r':
 525       show_realpaths = 1;
 526       break;
 527
 528     case 'i':
 529       ignore_same_inode = 1;
 530       break;
 531
 532     case 'g':
 533       show_groups = 0;
 534       break;
 535
 536     case 'p':
 537       show_progress = 1;
 538       break;
 539
 540     case 'c':
 541       show_hits = 0;
 542       break;
 543
 544     default:
 545       exit(EXIT_FAILURE);
 546     }
 547   }
 548
 549   if(show_progress &&
 550      isatty(STDOUT_FILENO) &&
 551      !ioctl (STDOUT_FILENO, TIOCGWINSZ, (char *) &win)) {
 552     tty_width = win.ws_col;
 553   }
 554
 555   if(optind + 2 == argc) {
 556     start(argv[optind], argv[optind + 1]);
 557   } else if(optind + 1 == argc) {
 558     ignore_same_inode = 1;
 559     start(argv[optind], 0);
 560   } else {
 561     print_help(stderr);
 562     exit(EXIT_FAILURE);
 563   }
 564
 565   exit(EXIT_SUCCESS);
 566 }