fsck/repair.c

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  *  Copyright (C) 2020 Hyunchul Lee <hyc.lee@gmail.com>
   4  */
   5 #include <stdio.h>
   6 #include <string.h>
   7 #include <stdarg.h>
   8 #include <stdlib.h>
   9 #include <errno.h>
  10
  11 #include "exfat_ondisk.h"
  12 #include "libexfat.h"
  13 #include "repair.h"
  14 #include "exfat_fs.h"
  15 #include "fsck.h"
  16
  17 struct exfat_repair_problem {
  18         er_problem_code_t       prcode;
  19         unsigned int            flags;
  20         unsigned int            prompt_type;
  21         unsigned int            default_number;
  22         unsigned int            bypass_number;
  23         unsigned int            max_number;
  24 };
  25
  26 /* Problem flags */
  27 #define ERF_PREEN_YES           0x00000001
  28 #define ERF_DEFAULT_YES         0x00000002
  29 #define ERF_DEFAULT_NO          0x00000004
  30
  31 /* Prompt types */
  32 #define ERP_FIX                 0x00000001
  33 #define ERP_TRUNCATE            0x00000002
  34 #define ERP_DELETE              0x00000003
  35 #define ERP_RENAME              0x00000004
  36
  37 static const char *prompts[] = {
  38         "Repair",
  39         "Fix",
  40         "Truncate",
  41         "Delete",
  42         "Select",
  43 };
  44
  45 static struct exfat_repair_problem problems[] = {
  46         {ER_BS_CHECKSUM, ERF_PREEN_YES, ERP_FIX, 0, 0, 0},
  47         {ER_BS_BOOT_REGION, 0, ERP_FIX, 0, 0, 0},
  48         {ER_DE_CHECKSUM, ERF_PREEN_YES, ERP_DELETE, 0, 0, 0},
  49         {ER_DE_UNKNOWN, ERF_PREEN_YES, ERP_DELETE, 0, 0, 0},
  50         {ER_DE_FILE, ERF_PREEN_YES, ERP_DELETE, 0, 0, 0},
  51         {ER_DE_SECONDARY_COUNT, ERF_PREEN_YES, ERP_FIX, 0, 0, 0},
  52         {ER_DE_STREAM, ERF_PREEN_YES, ERP_DELETE, 0, 0, 0},
  53         {ER_DE_NAME, ERF_PREEN_YES, ERP_DELETE, 0, 0, 0},
  54         {ER_DE_NAME_HASH, ERF_PREEN_YES, ERP_FIX, 0, 0, 0},
  55         {ER_DE_NAME_LEN, ERF_PREEN_YES, ERP_FIX, 0, 0, 0},
  56         {ER_DE_DOT_NAME, ERF_PREEN_YES, ERP_RENAME, 2, 3, 4},
  57         {ER_DE_DUPLICATED_NAME, ERF_PREEN_YES, ERP_RENAME, 2, 3, 4},
  58         {ER_FILE_VALID_SIZE, ERF_PREEN_YES, ERP_FIX, 0, 0, 0},
  59         {ER_FILE_INVALID_CLUS, ERF_PREEN_YES, ERP_TRUNCATE, 0, 0, 0},
  60         {ER_FILE_FIRST_CLUS, ERF_PREEN_YES, ERP_TRUNCATE, 0, 0, 0},
  61         {ER_FILE_SMALLER_SIZE, ERF_PREEN_YES, ERP_TRUNCATE, 0, 0, 0},
  62         {ER_FILE_LARGER_SIZE, ERF_PREEN_YES, ERP_TRUNCATE, 0, 0, 0},
  63         {ER_FILE_DUPLICATED_CLUS, ERF_PREEN_YES, ERP_TRUNCATE, 0, 0, 0},
  64         {ER_FILE_ZERO_NOFAT, ERF_PREEN_YES, ERP_FIX, 0, 0, 0},
  65         {ER_VENDOR_GUID, ERF_DEFAULT_NO, ERP_FIX, 0, 0, 0},
  66 };
  67
  68 static struct exfat_repair_problem *find_problem(er_problem_code_t prcode)
  69 {
  70         unsigned int i;
  71
  72         for (i = 0; i < sizeof(problems)/sizeof(problems[0]); i++) {
  73                 if (problems[i].prcode == prcode) {
  74                         return &problems[i];
  75                 }
  76         }
  77         return NULL;
  78 }
  79
  80 static int ask_repair(struct exfat_fsck *fsck, struct exfat_repair_problem *pr)
  81 {
  82         int repair = 0;
  83         char answer[8];
  84
  85         if (fsck->options & FSCK_OPTS_REPAIR_NO ||
  86             pr->flags & ERF_DEFAULT_NO)
  87                 repair = 0;
  88         else if (fsck->options & FSCK_OPTS_REPAIR_YES ||
  89                  pr->flags & ERF_DEFAULT_YES)
  90                 repair = 1;
  91         else {
  92                 if (fsck->options & FSCK_OPTS_REPAIR_ASK) {
  93                         do {
  94                                 if (pr->prompt_type & ERP_RENAME) {
  95                                         printf("%s (Number: ?) ",
  96                                                prompts[pr->prompt_type]);
  97                                 } else {
  98                                         printf(". %s (y/N)? ",
  99                                                prompts[pr->prompt_type]);
 100                                 }
 101                                 fflush(stdout);
 102
 103                                 if (!fgets(answer, sizeof(answer), stdin))
 104                                         continue;
 105
 106                                 if (pr->prompt_type & ERP_RENAME) {
 107                                         unsigned int number = atoi(answer);
 108
 109                                         if (number > 0 && number < pr->max_number)
 110                                                 return number;
 111                                 } else {
 112                                         if (strcasecmp(answer, "Y\n") == 0)
 113                                                 return 1;
 114                                         else if (strcasecmp(answer, "\n") == 0 ||
 115                                                  strcasecmp(answer, "N\n") == 0)
 116                                                 return 0;
 117                                 }
 118                         } while (1);
 119                 } else if (fsck->options & FSCK_OPTS_REPAIR_AUTO &&
 120                            pr->flags & ERF_PREEN_YES)
 121                         repair = 1;
 122         }
 123
 124         if (pr->prompt_type & ERP_RENAME) {
 125                 int print_num = repair ? pr->default_number : pr->bypass_number;
 126
 127                 printf("%s (Number : %d)\n", prompts[pr->prompt_type],
 128                        print_num);
 129                 repair = print_num;
 130         } else {
 131                 printf(". %s (y/N)? %c\n", prompts[pr->prompt_type],
 132                        repair ? 'y' : 'n');
 133         }
 134         return repair;
 135 }
 136
 137 int exfat_repair_ask(struct exfat_fsck *fsck, er_problem_code_t prcode,
 138                      const char *desc, ...)
 139 {
 140         struct exfat_repair_problem *pr = NULL;
 141         va_list ap;
 142         int repair;
 143
 144         pr = find_problem(prcode);
 145         if (!pr) {
 146                 exfat_err("unknown problem code. %#x\n", prcode);
 147                 return 0;
 148         }
 149
 150         va_start(ap, desc);
 151         vprintf(desc, ap);
 152         va_end(ap);
 153
 154         repair = ask_repair(fsck, pr);
 155         if (repair) {
 156                 if (pr->prompt_type & ERP_TRUNCATE)
 157                         fsck->dirty_fat = true;
 158                 fsck->dirty = true;
 159         }
 160         return repair;
 161 }
 162
 163 static int check_bad_char(char w)
 164 {
 165         return (w < 0x0020) || (w == '*') || (w == '?') || (w == '<') ||
 166                 (w == '>') || (w == '|') || (w == '"') || (w == ':') ||
 167                 (w == '/') || (w == '\\');
 168 }
 169
 170 static char *get_rename_from_user(struct exfat_de_iter *iter)
 171 {
 172         char *rename = malloc(ENTRY_NAME_MAX + 2);
 173
 174         if (!rename)
 175                 return NULL;
 176
 177 retry:
 178         /* +2 means LF(Line Feed) and NULL terminator */
 179         memset(rename, 0x1, ENTRY_NAME_MAX + 2);
 180         printf("New name: ");
 181         if (fgets(rename, ENTRY_NAME_MAX + 2, stdin)) {
 182                 int i, len, err;
 183                 struct exfat_lookup_filter filter;
 184
 185                 len = strlen(rename);
 186                 /* Remove LF in filename */
 187                 rename[len - 1] = '\0';
 188                 for (i = 0; i < len - 1; i++) {
 189                         if (check_bad_char(rename[i])) {
 190                                 printf("filename contain invalid character(%c)\n", rename[i]);
 191                                 goto retry;
 192                         }
 193                 }
 194
 195                 exfat_de_iter_flush(iter);
 196                 err = exfat_lookup_file(iter->exfat, iter->parent, rename, &filter);
 197                 if (!err) {
 198                         printf("file(%s) already exists, retry to insert name\n", rename);
 199                         goto retry;
 200                 }
 201         }
 202
 203         return rename;
 204 }
 205
 206 static char *generate_rename(struct exfat_de_iter *iter)
 207 {
 208         char *rename;
 209
 210         if (iter->invalid_name_num > INVALID_NAME_NUM_MAX)
 211                 return NULL;
 212
 213         rename = malloc(ENTRY_NAME_MAX + 1);
 214         if (!rename)
 215                 return NULL;
 216
 217         while (1) {
 218                 struct exfat_lookup_filter filter;
 219                 int err;
 220
 221                 snprintf(rename, ENTRY_NAME_MAX + 1, "FILE%07d.CHK",
 222                          iter->invalid_name_num++);
 223                 err = exfat_lookup_file(iter->exfat, iter->parent, rename,
 224                                         &filter);
 225                 if (!err)
 226                         continue;
 227                 break;
 228         }
 229
 230         return rename;
 231 }
 232
 233 int exfat_repair_rename_ask(struct exfat_fsck *fsck, struct exfat_de_iter *iter,
 234                 char *old_name, er_problem_code_t prcode, char *error_msg)
 235 {
 236         int num;
 237
 238 ask_again:
 239         num = exfat_repair_ask(fsck, prcode, "ERROR: '%s' %s.\n%s",
 240                         old_name, error_msg,
 241                         " [1] Insert the name you want to rename.\n"
 242                         " [2] Automatically renames filename.\n"
 243                         " [3] Bypass this check(No repair)\n");
 244         if (num) {
 245                 __le16 utf16_name[ENTRY_NAME_MAX];
 246                 char *rename = NULL;
 247                 __u16 hash;
 248                 struct exfat_dentry *dentry;
 249                 int ret;
 250
 251                 switch (num) {
 252                 case 1:
 253                         rename = get_rename_from_user(iter);
 254                         break;
 255                 case 2:
 256                         rename = generate_rename(iter);
 257                         break;
 258                 case 3:
 259                         break;
 260                 default:
 261                         exfat_info("select 1 or 2 number instead of %d\n", num);
 262                         goto ask_again;
 263                 }
 264
 265                 if (!rename)
 266                         return -EINVAL;
 267
 268                 exfat_info("%s filename is renamed to %s\n", old_name, rename);
 269
 270                 exfat_de_iter_get_dirty(iter, 2, &dentry);
 271
 272                 memset(utf16_name, 0, sizeof(utf16_name));
 273                 ret = exfat_utf16_enc(rename, utf16_name, sizeof(utf16_name));
 274                 free(rename);
 275                 if (ret < 0)
 276                         return ret;
 277
 278                 ret >>= 1;
 279                 memcpy(dentry->name_unicode, utf16_name, ENTRY_NAME_MAX * 2);
 280                 hash = exfat_calc_name_hash(iter->exfat, utf16_name, ret);
 281                 exfat_de_iter_get_dirty(iter, 1, &dentry);
 282                 dentry->stream_name_len = (__u8)ret;
 283                 dentry->stream_name_hash = cpu_to_le16(hash);
 284                 return 1;
 285
 286         }
 287
 288         return 0;
 289 }