2つのファイルを交換するユーティリティ

Aug 17 2020

2つのファイルを交換する必要はありませんでしたが、2つのファイルを交換するコマンドがあるかどうか常に疑問に思っていましたが、最近、1つあるかどうかを確認することにしました。やがて、存在しないことがわかり、作成することにしました。

コードは次のとおりです。 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失敗する可能性があります。あなたはそれをツリータイムと呼びます。2番目または3番目の呼び出しが失敗した場合(例外を除いて!)、ファイルシステムは期待どおりの状態になりません。noexceptオーバーロードを使用し、error_code各呼び出しの後にテストし、失敗する前にすべてのアクションをロールバックします。それはまた、存在しないパスを自動的に処理します。

  • しないでくださいassert。実行時の問題ではなく、バグをキャッチするだけでよいのです。(でコンパイルされた-DNDEBUG)本番コードでは何も実行せず、プログラムはmkstemp障害を検出しません。

  • たとえば、4つの引数を指定して呼び出された場合、プログラムはサイレントに何も実行しません。また、2つの引数を指定して呼び出すと、非常に手間がかかります。print_help()いつでも電話をかけるのargc != 3ははるかに簡単です。

1 Razzle Aug 28 2020 at 20:26

「質問」はコード批評を求めていると思います。私がそれについて間違っているなら、優しくしてください..笑

私の第一印象は、メインの読みやすさです。大きな引数解析スイッチは、より重要なロジックを隠しています。

読みやすくするかもしれません(文字列オブジェクトと大文字と小文字を区別しない比較?)。さらに良い方法:ハウスキーピングヘルパーメソッドに任せます。

(また、単純化しても問題ない場合があります。2つのファイル名引数を受け取らない場合は、ユーザーに明示的にヘルプを要求するのではなく、すぐにヘルプを吐き出すことができます。)