Утилита для обмена двух файлов

Aug 17 2020

Хотя мне никогда не приходилось менять местами два файла, я всегда задавался вопросом, есть ли команда для обмена двумя файлами, и недавно я решил посмотреть, есть ли один. В конце концов я узнал, что его нет, и решил создать его.

Вот код: main.cc

#include <iostream>
#include <filesystem>
#include <cstring>
#include <cassert>

static auto print_help() -> void {
    std::cout << "Usage: swap [file1] [file2]\n";
    std::cout << "swaps the contents of file1 and file2\n";
    std::cout << "use swap --help to print this message\n";
}

static auto validate_files(const std::filesystem::path& file1_path, const std::filesystem::path& file2_path) -> void {
    {
        /* check if file exists */
        const auto file1_exists = std::filesystem::exists(file1_path);
        const auto file2_exists = std::filesystem::exists(file2_path);
        const auto exists = file1_exists && file2_exists;


        if (!exists) {
            if (!file1_exists) std::cerr << "cannot find file " << file1_path << '\n';
            if (!file2_exists) std::cerr << "cannot find file " << file2_path << '\n';
            exit(EXIT_FAILURE);
        }
    }

    {
        if (file1_path == file2_path) {
            std::cerr << "swaping the same two files does nothing\n";
            exit(EXIT_SUCCESS);
        }
    }
}

static auto get_temp_filename(char* template_name) -> void {
    /* tmpnam_s does not work on linux */
#if defined(WIN32) || defined(_WIN32)
    errno_t err = tmpnam_s(template_name, L_tmpnam);
    assert(!err);
#else
    int err = mkstemp(template_name);
    assert(err != -1);
#endif
}

int main(int argc, char** argv) {
    std::ios::sync_with_stdio(false);
    switch (argc) {
        case 2: {
            /* convert the second arg to upper case */
            std::transform(argv[1],
                argv[1] + strlen(argv[1]),
                argv[1],
                ::toupper);
            if (!strcmp(argv[1], "--HELP")) {
                print_help();
                return EXIT_SUCCESS;
            }
            else {
                std::cerr << "Invalid args see --help for usage\n";
                return EXIT_FAILURE;
            }
        }
        case 3:
            break;
        default: {
            std::cerr << "Invalid args see --help for usage\n";
            return EXIT_FAILURE;
        }
    }
    const auto file1_path = std::filesystem::path{ argv[1] };
    const auto file2_path = std::filesystem::path{ argv[2] };


    validate_files(file1_path, file2_path);
    char temp_filename[L_tmpnam] = "XXXXXX";
    get_temp_filename(temp_filename);
    const auto temp_filepath = std::filesystem::path{ temp_filename };
    /* move-swap the files instead of copy-swaping */
    /* renaming a file is the same as moving it */
    std::filesystem::rename(file1_path, temp_filepath);
    std::filesystem::rename(file2_path, file1_path);
    std::filesystem::rename(temp_filepath, file2_path);
}

Вот пример использования:

swap doc1.txt doc2.txt

Ответы

11 vnp Aug 17 2020 at 06:22
  • file1_path == file2_pathобязательно говорит о том, что пути относятся к одному и тому же файлу. Однако даже если file1_path != file2_pathони все еще могут ссылаться на один и тот же файл.

  • file1_exists = std::filesystem::exists(file1_path);вводит условие гонки TOC-TOU. Файл может существовать во время тестирования, но исчезнуть к моменту использования. Смотрите следующий пункт.

  • std::filesystem::renameможет потерпеть неудачу. Вы называете это временами дерева. Если второй или третий вызов терпит неудачу (за исключением!), Файловая система оказывается не в том состоянии, в котором можно было бы ожидать. Используйте noexceptперегрузку, проверяйте error_codeпосле каждого вызова и откатывайте все действия до сбоя. Это также автоматически позаботится о несуществующих путях.

  • Не надо assert. Хорошо только вылавливать ошибки, а не проблемы выполнения. В производственном коде (скомпилированном с помощью -DNDEBUG) он ничего не делает, и ваша программа не обнаружит mkstempсбоя.

  • Программа молча ничего не делает, если вызывается, скажем, с 4 аргументами. Также требуется много усилий, если он вызывается с двумя аргументами. Позвонить в print_help()любое время argc != 3намного проще.

1 Razzle Aug 28 2020 at 20:26

Я предполагаю, что «вопрос» требует критики кода. Если я ошибаюсь, будьте осторожны .. LOL

Первое впечатление - удобочитаемость main. Переключатель синтаксического анализа большого аргумента скрывает более важную логику.

Может быть, облегчить чтение (строковые объекты и сравнение без учета регистра?). Еще лучше: отнести к вспомогательному методу домашнего хозяйства.

(Также: иногда упрощение - это нормально. Если вы не получаете два аргумента имени файла, вы можете немедленно выплюнуть справку, а не сообщать пользователю, чтобы он явно просил о помощи.)