Qtの応用 - rsyncのソースを表示

== 概要 ==
librsyncライブラリは、ネットワーク効率的なファイル同期を実現するためのC言語ライブラリである。<br>
Qtフレームワーク環境でもlibrsyncライブラリを使用することができ、効率的なデータ同期機能を実装する場合に役立つ。<br>
<br>
librsyncライブラリの主な特徴は、rsyncアルゴリズムを実装していることである。<br>
このアルゴリズムにより、ファイルの変更された部分のみを転送することができるため、大幅な帯域幅の節約が可能になる。<br>
<br>
librsyncライブラリを使用する場合の基本的な流れを以下に示す。<br>
# まず、元のファイル (ディレクトリ) のシグネチャを生成する。
# 次に、更新されたファイルとそのシグネチャを比較してデルタを作成する。
# 最後に、元のファイルにデルタを適用して更新を完了する。
<br>
librsyncライブラリの主要な関数には、<code>rs_sig_begin</code>関数や<code>rs_sig_file</code>等のシグネチャ生成関数、<br>
<code>rs_delta_begin</code>関数や<code>rs_delta_file</code>関数等のデルタ生成関数、<br>
そして、<code>rs_patch_begin</code>関数や<code>rs_patch_file</code>関数等のパッチ適用関数がある。<br>
<br>
これらの関数を適切に組み合わせることにより、効率的なファイル同期機能を実装することができる。<br>
<br>
エラーハンドリングも重要な要素である。<br>
librsyncライブラリの関数は、一般的に、<code>rs_result</code>型の値を返す。<br>
これを確認することにより、操作が成功したかどうかを判断することができる。<br>
<br>
メモリ管理にも注意が必要である。<br>
librsyncライブラリは、一部の関数でメモリを動的に割り当てるため、使用後は適切に解放する必要がある。<br>
<br>
librsyncライブラリはマルチスレッド環境での使用を想定していないため、Qtのマルチスレッド機能と併用する場合は注意が必要となる。<br>
必要に応じて、ミューテックスやロック等の同期プリミティブを使用して、スレッドセーフな実装を行うことが重要である。<br>
<br><br>

== libRsyncのインストール ==
==== libRsyncの概要 ====
librsyncは、rsyncと同様、効率的にファイルを転送する他のプログラムを構築するためのものである。<br>
バックアップおよびプログラムにバイナリパッチを配布したり、ディレクトリをサーバやピア間で同期するために記述したプログラムである。<br>
<br>
librsyncは、ネットワーク差分を計算し適用するためのライブラリであり、多様なネットワークソフトウェアに統合できるように設計されたインターフェイスを備えている。<br>
<br>
librsyncは、rsyncプロトコルのコアアルゴリズムをカプセル化して、2つのファイルの差分を効率的に計算するのに役立つ。<br>
rsyncアルゴリズムは、差分を計算するために2つのファイルが存在する必要が無いため、ほとんどの差分アルゴリズムとは異なる。<br>
<br>
その代わり、一方のファイルの各ブロックのチェックサムのセットを必要とし、それらが一緒になってそのファイルの署名を形成する。<br>
もう一方のファイルのどの位置のブロックでも、チェックサムが同じであれば、同一である可能性が高く、残ったものが差分となる。<br>
<br>
このアルゴリズムは、同じシステム上で両方のファイルを必要とすることなく、2つのファイル間の差分を転送する。<br>
<br>
librsyncは、元々、HTTPのデルタ圧縮におけるrproxy実験のために作成された。<br>
現在では、Dropbox、rdiff-backup、Duplicity等で使用されている。<br>
<br>
<u>※注意</u><br>
<u>librsyncライブラリは、rsyncワイヤプロトコルを実装していない。</u><br>
<u>ファイルを転送するためにrsyncサーバと対話する場合は、rsyncにシェルアウトする必要がある。</u><br>
<br>
<u>librsyncライブラリは、ファイル名、パーミッション、ディレクトリ等のファイルのメタデータや構造を扱わない。</u><br>
<u>このライブラリにとって、ファイルは単なるバイトのストリームである。</u><br>
<br>
<u>librsyncライブラリは、SSHやその他のサーバと通信するためのネットワーク関数も含まれていない。</u><br>
<u>そのため、リモートファイルシステムにアクセスするには、独自のコードを提供する、または、他の仮想ファイルシステムレイヤーを使用する必要がある。</u><br>
<br>
<u>libRsyncライブラリのライセンスは、LGPL v2.1に準拠している。</u><br>
<br>
libRsyncライブラリの詳細な使用方法は、公式WebサイトまたはGithubを参照すること。<br>
* 公式Webサイト : https://librsync.github.io/
<br>
==== ソースコードからインストール ====
ビルドに必要な依存関係のライブラリをインストールする。<br>
 sudo zypper install libb2-devel
<br>
[https://github.com/librsync/librsync libRsyncのGitHub]からソースコードをダウンロードする。<br>
ダウンロードしたファイルを解凍する。<br>
 tar xf librsync-<バージョン>.tar.gz
 cd librsync-<バージョン>
<br>
または、Githubからソースコードをクローンする。<br>
 git clone https://github.com/librsync/librsync.git
 cd librsync
<br>
libRsyncをビルドおよびインストールする。<br>
 mkdir build && cd build
 
 cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=<libRsyncインストールディレクトリ> ..
 make -j $(nproc)
 make install
<br>
~/.profileファイル等に、環境変数を追記する。<br>
 vi ~/.profile
<br>
 # ~/.profileファイル
 
 export PATH="/<libRsyncのインストールディレクトリ>/bin:$PATH"
 export LD_LIBRARY_PATH="/<libRsyncのインストールディレクトリ>/lib64:$LD_LIBRARY_PATH"
<br>
==== パッケージ管理システムからインストール ====
 sudo zypper install librsync2
<br><br>

== ライブラリのリンク ==
Pkg-configを使用してlibrsyncライブラリを検索して、プロジェクトにリンクする。<br>
システムにPkg-configとlibrsyncライブラリがインストールされていることを確認すること。<br>
<br>
* Qtプロジェクトファイル (.pro) の場合
 <syntaxhighlight lang="make">
 # Pkg-configを使用
 CONFIG += link_pkgconfig
 PKGCONFIG += librsync
 </syntaxhighlight>
<br>
* CMakeLists.txtファイルの場合
 <syntaxhighlight lang="cmake">
 # librsyncの依存関係を確認
 pkg_check_modules(LIBRSYNC REQUIRED librsync)
 
 # 実行可能ファイルを追加
 add_executable(<ターゲット名>
    main.cpp
 )
 
 # インクルードディレクトリを追加
 target_include_directories(<ターゲット名> PRIVATE ${LIBRSYNC_INCLUDE_DIRS})
 
 # リンクオプションを追加 (必要な場合)
 target_link_options(<ターゲット名> PRIVATE
    ${LIBRSYNC_LDFLAGS}
 )
 
 # pkg_check_modulesコマンドがLIBRSYNC_LDFLAGSを提供していない場合や追加のカスタムフラグが必要な場合
 #target_link_options(<ターゲット名> PRIVATE
 #   "-L${LIBRSYNC_LIBRARY_DIRS}"
 #)
 
 # ライブラリをリンク
 target_link_libraries(<ターゲット名> PRIVATE
    ${LIBRSYNC_LIBRARIES}
 )
 </syntaxhighlight>
<br><br>

== ローカルディレクトリとの同期 ==
以下の例では、librsyncライブラリを使用して、同一PC上のファイルおよびディレクトリを非同期でファイルを差分転送している。<br>
<br>
* 非同期処理
*: QtConcurrent::runメソッドを実行して、ファイル同期を非同期で実行する。
*: QFutureクラスを使用して、非同期処理の結果を管理する。
* ストリーミング処理
*: librsyncライブラリを使用して、ファイルをストリーミング方式で読み込み、差分を計算する。
*: 大きなファイルでもメモリ効率良く処理することができる。
* 進捗報告
*: progressUpdatedシグナルを使用して、処理の進捗を報告する。
* ディレクトリ構造の維持
*: ソースディレクトリの構造を宛先ディレクトリに複製する。
<br>
 <syntaxhighlight lang="c++">
 // FileSyncWorker.hファイル
 
 #include <QCoreApplication>
 #include <QFileInfo>
 #include <QDir>
 #include <QDirIterator>
 #include <QFuture>
 #include <QtConcurrent>
 #include <librsync.h>
 #include <QDebug>
 
 class FileSyncWorker : public QObject
 {
    Q_OBJECT
 
 public:
    explicit FileSyncWorker(QObject *parent = nullptr) : QObject(parent) {}
 
    // ディレクトリの同期を非同期で実行
    QFuture<void> syncFiles(const QString &sourcePath, const QString &destPath)
    {
       return QtConcurrent::run([this, sourcePath, destPath]() {
          QDirIterator it(sourcePath, QDir::Files | QDir::Dirs | QDir::NoDotAndDotDot, QDirIterator::Subdirectories);
          while (it.hasNext()) {
             QString sourceFilePath   = it.next();
             QString relativeFilePath = QDir(sourcePath).relativeFilePath(sourceFilePath);
             QString destFilePath     = QDir(destPath).filePath(relativeFilePath);
 
             QFileInfo sourceInfo(sourceFilePath);
             if (sourceInfo.isDir()) {
                QDir().mkpath(destFilePath);
             }
             else {
                syncFile(sourceFilePath, destFilePath);
             }
          }
       });
    }
 
 signals:
    void progressUpdated(int progress);
    void errorOccurred(const QString &error);
 
 private:
    // 個別のファイルを同期するメソッド
    void syncFile(const QString &sourcePath, const QString &destPath)
    {
       QFile sourceFile(sourcePath);
       QFile destFile(destPath);
 
       if (!sourceFile.open(QIODevice::ReadOnly)) {
          emit errorOccurred(QString("ソースファイルを開けません: %1").arg(sourcePath));
          return;
       }
 
       if (!destFile.open(QIODevice::ReadWrite)) {
          emit errorOccurred(QString("宛先ファイルを開けません: %1").arg(destPath));
          sourceFile.close();
 
          return;
       }
 
       // librsyncライブラリを使用して、ファイルの差分を計算して適用
       rs_result result;
       rs_buffers_t buf;
 
       // 入力バッファの設定
       char inbuf[8192] = {};
       buf.next_in      = inbuf;
       buf.avail_in     = 0;
 
       // 出力バッファの設定
       char outbuf[8192] = {};
       buf.next_out      = outbuf;
       buf.avail_out     = sizeof(outbuf);
 
       // シグネチャの生成
       rs_job_t *job = rs_sig_begin(RS_DEFAULT_BLOCK_LEN, 0, RS_MD4_SIG_MAGIC);
       if (!job) {
          emit errorOccurred("シグネチャジョブの作成に失敗しました");
          sourceFile.close();
          destFile.close();
 
          return;
       }
 
       do {
          if (buf.avail_in == 0) {
             buf.avail_in = sourceFile.read(inbuf, sizeof(inbuf));
             buf.next_in = inbuf;
          }
 
          result = rs_job_iter(job, &buf);
 
          if (buf.avail_out == 0) {
             destFile.write(outbuf, sizeof(outbuf));
             buf.next_out = outbuf;
             buf.avail_out = sizeof(outbuf);
          }
       } while (result == RS_BLOCKED);
 
       if (result != RS_DONE) {
          emit errorOccurred(QString("シグネチャの生成に失敗しました: %1").arg(rs_strerror(result)));
          rs_job_free(job);
          sourceFile.close();
          destFile.close();
 
          return;
       }
 
       if (buf.avail_out < sizeof(outbuf)) {
          destFile.write(outbuf, sizeof(outbuf) - buf.avail_out);
       }
 
       rs_job_free(job);
       sourceFile.close();
       destFile.close();
 
       // 進捗の更新 (各ファイルを1単位としている)
       emit progressUpdated(1);
    }
 };
 </syntaxhighlight>
<br>
 <syntaxhighlight lang="c++">
 // main.cppファイル
 
 #inlcude "FileSyncWorker.h"
 
 int main(int argc, char *argv[])
 {
    QCoreApplication a(argc, argv);
 
    QString sourcePath = "<同期元ディレクトリ>";
    QString destPath   = "<同期先ディレクトリ>";
 
    FileSyncWorker worker;
    QObject::connect(&worker, &FileSyncWorker::progressUpdated, [](int progress) {
       qDebug() << "進捗: " << progress;
    });
 
    QObject::connect(&worker, &FileSyncWorker::errorOccurred, [](const QString &error) {
       qDebug() << "エラー: " << error;
    });
 
    // 同期完了まで待機
    QFuture<void> future = worker.syncFiles(sourcePath, destPath);
    future.waitForFinished();
 
    return a.exec();
 }
 </syntaxhighlight>
<br><br>

== リモートPCのディレクトリとの同期 ==
==== クライアント側 ====
以下の例では、librsyncライブラリを使用して、リモートPC上のファイルおよびディレクトリを非同期でファイルを差分転送している。<br>
<br>
* 非同期処理
*: QtConcurrent::runメソッドを実行して、ファイル同期を非同期で実行する。
*: QFutureクラスを使用して、非同期処理の結果を管理する。
* ネットワーク通信
*: QTcpSocketクラスを使用して、リモートホストと通信する。
* ストリーミング処理
*: ファイルデータとコマンドをストリーミングで送受信する。
* ディレクトリ構造の維持
*: ソースディレクトリの構造を宛先ディレクトリに複製する。
<br>
 <syntaxhighlight lang="c++">
 // RemoteFileSyncWorker.hファイル
 
 #include <QObject>
 #include <QDir>
 #include <QDirIterator>
 #include <QFileInfo>
 #include <QDataStream>
 #include <QFuture>
 #include <QtConcurrent>
 #include <QTcpSocket>
 #include <librsync.h>
 
 class RemoteFileSyncWorker : public QObject
 {
    Q_OBJECT
 
 private:
    QTcpSocket *socket;
 
    void syncFile(const QString &sourcePath, const QString &destPath)
    {
       QFile sourceFile(sourcePath);
       if (!sourceFile.open(QIODevice::ReadOnly)) {
          emit errorOccurred(QString("ソースファイルのオープンに失敗: %1").arg(sourcePath));
          return;
       }
 
       // リモートファイルのシグネチャを要求
       QByteArray command = "SIGNATURE:" + destPath.toUtf8();
       if (!sendData(command)) {
          emit errorOccurred("シグネチャ要求の送信に失敗");
          return;
       }
 
       QByteArray remoteSignature = receiveData();
       if (remoteSignature.isEmpty()) {
          emit errorOccurred("リモートシグネチャの受信に失敗");
          return;
       }
 
       // デルタの計算
       rs_result result;
       rs_buffers_t buf;
       char inbuf[8192];
       char outbuf[8192];
 
       rs_job_t *job = rs_delta_begin(new rs_signature_t());
       if (!job) {
          emit errorOccurred("デルタジョブの作成に失敗");
          return;
       }
 
       do {
          buf.next_in   = inbuf;
          buf.avail_in  = sourceFile.read(inbuf, sizeof(inbuf));
          buf.next_out  = outbuf;
          buf.avail_out = sizeof(outbuf);
 
          result = rs_job_iter(job, &buf);
 
          if (buf.avail_out < sizeof(outbuf)) {
             QByteArray deltaData(outbuf, sizeof(outbuf) - buf.avail_out);
             if (!sendData(deltaData)) {
                emit errorOccurred("デルタデータの送信に失敗");
                rs_job_free(job);
 
                return;
             }
          }
       } while (result == RS_BLOCKED);
 
       rs_job_free(job);
 
       if (result != RS_DONE) {
          emit errorOccurred(QString("デルタの計算に失敗しました: %1").arg(rs_strerror(result)));
          return;
       }
 
       // 完了通知
       if (!sendData("DONE")) {
          emit errorOccurred("完了通知の送信に失敗");
          return;
       }
 
       emit progressUpdated(1);
    }
 
    bool connectToHost(const QString &host, quint16 port)
    {
       socket->connectToHost(host, port);
       return socket->waitForConnected(5000);
    }
 
    void disconnectFromHost()
    {
       if (socket->state() == QAbstractSocket::ConnectedState) {
          socket->disconnectFromHost();
       }
    }
 
    bool sendData(const QByteArray &data)
    {
       QDataStream out(socket);
       out << quint32(data.size());
       out.writeRawData(data.constData(), data.size());
 
       return socket->waitForBytesWritten(5000);
   }
 
    QByteArray receiveData()
    {
       if (!socket->waitForReadyRead(5000)) {
          return QByteArray();
       }
 
       QDataStream in(socket);
       quint32 blockSize;
       in >> blockSize;
 
       while (socket->bytesAvailable() < blockSize) {
          if (!socket->waitForReadyRead(5000)) {
             return QByteArray();
          }
       }
 
       QByteArray data;
       data.resize(blockSize);
       in.readRawData(data.data(), blockSize);
 
       return data;
    }
 
 public:
    explicit RemoteFileSyncWorker(QObject *parent = nullptr) : QObject(parent), socket(new QTcpSocket(this))
    {}
 
    ~RemoteFileSyncWorker()
    {
       disconnectFromHost();
    }
 
    QFuture<void> syncFiles(const QString &sourcePath, const QString &destPath, const QString &host, quint16 port)
    {
       return QtConcurrent::run([this, sourcePath, destPath, host, port]() {
          if (!connectToHost(host, port)) {
             emit errorOccurred("リモートホストへの接続に失敗しました");
             return;
          }
 
          QDirIterator it(sourcePath, QDir::Files | QDir::Dirs | QDir::NoDotAndDotDot, QDirIterator::Subdirectories);
          while (it.hasNext()) {
             QString sourceFilePath = it.next();
             QString relativeFilePath = QDir(sourcePath).relativeFilePath(sourceFilePath);
             QString destFilePath = QDir(destPath).filePath(relativeFilePath);
 
             QFileInfo sourceInfo(sourceFilePath);
             if (sourceInfo.isDir()) {
                // リモートPCでディレクトリを作成するコマンドを送信
                QByteArray command = "MKDIR:" + destFilePath.toUtf8();
                if (!sendData(command)) {
                   emit errorOccurred("ディレクトリ作成コマンドの送信に失敗");
                   return;
                }
             }
             else {
                syncFile(sourceFilePath, destFilePath);
             }
          }
 
          disconnectFromHost();
       });
    }
 
 signals:
    void progressUpdated(int progress);
    void errorOccurred(const QString &error);
 };
 
 #endif // REMOTEFILESYNCWORKER_H
 </syntaxhighlight>
<br>
 <syntaxhighlight lang="c++">
 #include <QCoreApplication>
 #include <QDebug>
 #include "RemoteFileSyncWorker.h"
 
 int main(int argc, char *argv[])
 {
    QCoreApplication a(argc, argv);
 
    QString sourcePath = "<同期元ディレクトリ>";
    QString destPath   = "<同期先ディレクトリ>";
    QString remoteHost = "<リモートホストのIPアドレス>";
    quint16 remotePort = <リモートホストのポート番号>;
 
    RemoteFileSyncWorker worker;
    QObject::connect(&worker, &RemoteFileSyncWorker::progressUpdated, [](int progress) {
       qDebug() << "進捗: " << progress;
    });
 
    QObject::connect(&worker, &RemoteFileSyncWorker::errorOccurred, [](const QString &error) {
       qDebug() << "エラー: " << error;
    });
 
    // 同期の開始
    QFuture<void> future = worker.syncFiles(sourcePath, destPath, remoteHost, remotePort);
 
    // メインイベントループを開始
    int result = a.exec();
 
    // 同期完了まで待機
    future.waitForFinished();
 
    return result;
 }
 </syntaxhighlight>
<br>
==== サーバ側 ====
<br><br>


__FORCETOC__
[[カテゴリ:Qt]]