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_DELETE, 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 };
  66
  67 static struct exfat_repair_problem *find_problem(er_problem_code_t prcode)
  68 {
  69         unsigned int i;
  70
  71         for (i = 0; i < sizeof(problems)/sizeof(problems[0]); i++) {
  72                 if (problems[i].prcode == prcode) {
  73                         return &problems[i];
  74                 }
  75         }
  76         return NULL;
  77 }
  78
  79 static int ask_repair(struct exfat_fsck *fsck, struct exfat_repair_problem *pr)
  80 {
  81         int repair = 0;
  82         char answer[8];
  83
  84         if (fsck->options & FSCK_OPTS_REPAIR_NO ||
  85             pr->flags & ERF_DEFAULT_NO)
  86                 repair = 0;
  87         else if (fsck->options & FSCK_OPTS_REPAIR_YES ||
  88                  pr->flags & ERF_DEFAULT_YES)
  89                 repair = 1;
  90         else {
  91                 if (fsck->options & FSCK_OPTS_REPAIR_ASK) {
  92                         do {
  93                                 if (pr->prompt_type & ERP_RENAME) {
  94                                         printf("%s (Number: ?) ",
  95                                                prompts[pr->prompt_type]);
  96                                 } else {
  97                                         printf(". %s (y/N)? ",
  98                                                prompts[pr->prompt_type]);
  99                                 }
 100                                 fflush(stdout);
 101
 102                                 if (!fgets(answer, sizeof(answer), stdin))
 103                                         continue;
 104
 105                                 if (pr->prompt_type & ERP_RENAME) {
 106                                         unsigned int number = atoi(answer);
 107
 108                                         if (number > 0 && number < pr->max_number)
 109                                                 return number;
 110                                 } else {
 111                                         if (strcasecmp(answer, "Y\n") == 0)
 112                                                 return 1;
 113                                         else if (strcasecmp(answer, "\n") == 0 ||
 114                                                  strcasecmp(answer, "N\n") == 0)
 115                                                 return 0;
 116                                 }
 117                         } while (1);
 118                 } else if (fsck->options & FSCK_OPTS_REPAIR_AUTO &&
 119                            pr->flags & ERF_PREEN_YES)
 120                         repair = 1;
 121         }
 122
 123         if (pr->prompt_type & ERP_RENAME) {
 124                 int print_num = repair ? pr->default_number : pr->bypass_number;
 125
 126                 printf("%s (Number : %d)\n", prompts[pr->prompt_type],
 127                        print_num);
 128                 repair = print_num;
 129         } else {
 130                 printf(". %s (y/N)? %c\n", prompts[pr->prompt_type],
 131                        repair ? 'y' : 'n');
 132         }
 133         return repair;
 134 }
 135
 136 int exfat_repair_ask(struct exfat_fsck *fsck, er_problem_code_t prcode,
 137                      const char *desc, ...)
 138 {
 139         struct exfat_repair_problem *pr = NULL;
 140         va_list ap;
 141         int repair;
 142
 143         pr = find_problem(prcode);
 144         if (!pr) {
 145                 exfat_err("unknown problem code. %#x\n", prcode);
 146                 return 0;
 147         }
 148
 149         va_start(ap, desc);
 150         vprintf(desc, ap);
 151         va_end(ap);
 152
 153         repair = ask_repair(fsck, pr);
 154         if (repair) {
 155                 if (pr->prompt_type & ERP_TRUNCATE)
 156                         fsck->dirty_fat = true;
 157                 fsck->dirty = true;
 158         }
 159         return repair;
 160 }
 161
 162 static int check_bad_char(char w)
 163 {
 164         return (w < 0x0020) || (w == '*') || (w == '?') || (w == '<') ||
 165                 (w == '>') || (w == '|') || (w == '"') || (w == ':') ||
 166                 (w == '/') || (w == '\\');
 167 }
 168
 169 static char *get_rename_from_user(struct exfat_de_iter *iter)
 170 {
 171         char *rename = malloc(ENTRY_NAME_MAX + 2);
 172
 173         if (!rename)
 174                 return NULL;
 175
 176 retry:
 177         /* +2 means LF(Line Feed) and NULL terminator */
 178         memset(rename, 0x1, ENTRY_NAME_MAX + 2);
 179         printf("New name: ");
 180         if (fgets(rename, ENTRY_NAME_MAX + 2, stdin)) {
 181                 int i, len, err;
 182                 struct exfat_lookup_filter filter;
 183
 184                 len = strlen(rename);
 185                 /* Remove LF in filename */
 186                 rename[len - 1] = '\0';
 187                 for (i = 0; i < len - 1; i++) {
 188                         if (check_bad_char(rename[i])) {
 189                                 printf("filename contain invalid character(%c)\n", rename[i]);
 190                                 goto retry;
 191                         }
 192                 }
 193
 194                 exfat_de_iter_flush(iter);
 195                 err = exfat_lookup_file(iter->exfat, iter->parent, rename, &filter);
 196                 if (!err) {
 197                         printf("file(%s) already exists, retry to insert name\n", rename);
 198                         goto retry;
 199                 }
 200         }
 201
 202         return rename;
 203 }
 204
 205 static char *generate_rename(struct exfat_de_iter *iter)
 206 {
 207         char *rename;
 208
 209         if (iter->invalid_name_num > INVALID_NAME_NUM_MAX)
 210                 return NULL;
 211
 212         rename = malloc(ENTRY_NAME_MAX + 1);
 213         if (!rename)
 214                 return NULL;
 215
 216         while (1) {
 217                 struct exfat_lookup_filter filter;
 218                 int err;
 219
 220                 snprintf(rename, ENTRY_NAME_MAX + 1, "FILE%07d.CHK",
 221                          iter->invalid_name_num++);
 222                 err = exfat_lookup_file(iter->exfat, iter->parent, rename,
 223                                         &filter);
 224                 if (!err)
 225                         continue;
 226                 break;
 227         }
 228
 229         return rename;
 230 }
 231
 232 int exfat_repair_rename_ask(struct exfat_fsck *fsck, struct exfat_de_iter *iter,
 233                 char *old_name, er_problem_code_t prcode, char *error_msg)
 234 {
 235         int num;
 236
 237 ask_again:
 238         num = exfat_repair_ask(fsck, prcode, "ERROR: '%s' %s.\n%s",
 239                         old_name, error_msg,
 240                         " [1] Insert the name you want to rename.\n"
 241                         " [2] Automatically renames filename.\n"
 242                         " [3] Bypass this check(No repair)\n");
 243         if (num) {
 244                 __le16 utf16_name[ENTRY_NAME_MAX];
 245                 char *rename = NULL;
 246                 __u16 hash;
 247                 struct exfat_dentry *dentry;
 248                 int ret, i;
 249
 250                 switch (num) {
 251                 case 1:
 252                         rename = get_rename_from_user(iter);
 253                         break;
 254                 case 2:
 255                         rename = generate_rename(iter);
 256                         break;
 257                 case 3:
 258                         break;
 259                 default:
 260                         exfat_info("select 1 or 2 number instead of %d\n", num);
 261                         goto ask_again;
 262                 }
 263
 264                 if (!rename)
 265                         return -EINVAL;
 266
 267                 exfat_info("%s filename is renamed to %s\n", old_name, rename);
 268
 269                 exfat_de_iter_get_dirty(iter, 2, &dentry);
 270
 271                 memset(utf16_name, 0, sizeof(utf16_name));
 272                 ret = exfat_utf16_enc(rename, utf16_name, sizeof(utf16_name));
 273                 free(rename);
 274                 if (ret < 0)
 275                         return ret;
 276
 277                 ret >>= 1;
 278                 memcpy(dentry->name_unicode, utf16_name, ENTRY_NAME_MAX * 2);
 279                 hash = exfat_calc_name_hash(iter->exfat, utf16_name, ret);
 280                 exfat_de_iter_get_dirty(iter, 1, &dentry);
 281                 dentry->stream_name_len = (__u8)ret;
 282                 dentry->stream_name_hash = cpu_to_le16(hash);
 283
 284                 exfat_de_iter_get_dirty(iter, 0, &dentry);
 285                 i = dentry->file_num_ext;
 286                 dentry->file_num_ext = 2;
 287
 288                 for (; i > 2; i--) {
 289                         exfat_de_iter_get_dirty(iter, i, &dentry);
 290                         dentry->type &= EXFAT_DELETE;
 291                 }
 292         }
 293
 294         return 0;
 295 }