Skip to content

README_JP.md

Latest commit

 

History

History
441 lines (317 loc) · 16.7 KB

README_JP.md

File metadata and controls

441 lines (317 loc) · 16.7 KB
Raw

qSnapper

Linux向けのBtrfs/Snapperファイルシステムスナップショットを管理するモダンなQt6/QML GUIアプリケーションです。

License
Qt Version
Platform

qSnapper Qt

概要

qSnapperは、Snapperスナップショット管理ツールのグラフィカルユーザインターフェースです。
Btrfsやその他のサポートされているファイルシステム上でファイルシステムスナップショットを作成、閲覧、管理するための直感的な方法を提供します。

機能

  • スナップショット管理:
    ファイルシステムスナップショットの作成、表示、削除
  • スナップショットタイプ:
    Single、Pre、Postスナップショットをサポート
  • クリーンアップポリシー:
    NumberまたはTimelineアルゴリズムを使用した自動クリーンアップの設定
  • ファイル比較: スナップショット間の変更を詳細なdiffプレビューで表示
  • Pre/Postスナップショット比較: Pre/Postスナップショットそれぞれと現在のシステムの差分を切り替え表示し、各スナップショットから個別に復元可能
  • 復元プレビュー: スナップショットから復元する前にファイルをプレビュー
  • 高速復元: 2つの復元モード — Direct Copy (高速、btrfs reflink対応)とYaST互換 — を搭載し、バッチサイズ設定とリアルタイム進捗ログを提供
  • テーマサポート:
    ライト/ダークモード切り替え対応
  • 国際化対応: 多言語サポート (英語、日本語、ドイツ語)
  • モダンなUI:
    Qt6 Quick/QMLで構築された応答性の高いユーザエクスペリエンス
  • 安全な操作:
    D-BusとPolicyKitを使用した権限昇格

スクリーンショット

メインウィンドウ - スナップショット一覧

メインウィンドウには、すべての利用可能なスナップショットがスナップショット番号、タイプ、タイムスタンプ、説明などの詳細情報とともに表示されます。

スナップショット一覧

スナップショット作成ダイアログ

スナップショットタイプ (Single/Pre/Post)、説明、クリーンアップアルゴリズムなど、
カスタマイズ可能なオプションで新しいスナップショットを作成できます。

スナップショット作成ダイアログ

スナップショット詳細ダイアログ

特定のスナップショットの詳細情報 (ファイル変更、メタデータ、利用可能なアクションなど)を表示します。

スナップショット詳細ダイアログ

復元プレビューダイアログ

スナップショットから復元する前にファイル変更をプレビューします。
これにより、何が変更されるかを理解できます。

復元プレビューダイアログ

復元設定ダイアログ

ファイル復元前に、復元方式（ダイレクトコピー / YaST互換）とバッチサイズを設定できます。

復元設定ダイアログ

スナップショット削除ダイアログ

削除されるスナップショットを表示する安全確認ダイアログでスナップショットの削除を確認します。

スナップショット削除ダイアログ

要件

実行時依存関係

  • Linuxオペレーティングシステム (必須)
  • Qt6 (>= 6.2)
    • Qt6 Core
    • Qt6 GUI
    • Qt6 Quick
    • Qt6 QuickControls2
    • Qt6 Qml
    • Qt6 DBus
  • Snapper (>= 0.8.0)
  • PolicyKit (polkit)
  • D-Bus

ビルド依存関係

  • CMake (>= 3.16)
  • C++17対応コンパイラ (GCC、Clang)
  • Qt6開発パッケージ
  • PolicyKit-Qt6開発ファイル
  • Snapper開発ヘッダー
  • scdoc (オプション、manページ生成用。未インストールの場合はmanページ生成をスキップ)

インストール

ソースからビルド

1. 依存関係のインストール

openSUSE Leap 16 / SUSE Linux Enterprise 16

sudo zypper install cmake gcc-c++ \
                    qt6-base-devel qt6-declarative-devel qt6-quickcontrols2-devel qt6-linguist-devel \
                    polkit-devel libpolkit-qt6-1-devel \
                    libsnapper-devel libbtrfsutil-devel scdoc

RHEL 9 / 10

sudo dnf install cmake gcc-c++ \
                 qt6-qtbase-devel qt6-qtdeclarative-devel qt6-qtquickcontrols2-devel qt6-linguist-devel \
                 polkit-devel polkit-qt6-1-devel \
                 snapper-devel btrfs-progs-devel scdoc

2. ビルドとインストール

git clone https://github.com/presire/qSnapper.git
cd qSnapper
mkdir build && cd build

cmake -DCMAKE_INSTALL_PREFIX=/usr ..
make -j$(nproc)
sudo make install

ビルドオプション:

  • SELinuxサポート (オプション、デフォルト: 無効):

    cmake -DCMAKE_INSTALL_PREFIX=/usr -DENABLE_SELINUX=ON ..

    SELinux Mandatory Access Control (MAC) ポリシーモジュールのインストールを有効化します。

    SELinuxの要件:

    • openSUSE / SUSE Linux Enterprise:

      sudo zypper install selinux-policy-devel policycoreutils

    • RHEL 9 / 10:

      sudo dnf install selinux-policy-devel policycoreutils-python-utils

    SELinux設定の詳細については、selinux/README_JP.md を参照してください。

  • ログディレクトリ (オプション、デフォルト: /var/log/qsnapper):

    cmake -DCMAKE_INSTALL_PREFIX=/usr -DQSNAPPER_LOG_DIR=/path/to/log/dir ..

    D-Busサービスがログファイルを出力するディレクトリを変更します。 ログファイル名 (qsnapper-dbus.log)は変更できません。 未指定の場合、ログは /var/log/qsnapper に出力されます。

3. インストール後の手順

インストールプロセスは自動的に以下をインストールします：

  • D-Busサービスファイルを /usr/share/dbus-1/system-services/ に
  • D-Bus設定ファイルを /usr/share/dbus-1/system.d/ に
  • PolicyKitポリシーを /usr/share/polkit-1/actions/ に
  • デスクトップエントリを /usr/share/applications/ に
  • アプリケーションアイコンを /usr/share/icons/hicolor/128x128/apps/ に
  • manページを /usr/share/man/man1/ に (man qsnapper で参照可能。ビルド時にscdocが利用可能な場合のみ)

D-BusとPolicyKitをリロード：

sudo systemctl reload dbus

使用方法

qSnapperの起動

qSnapperは以下の方法で起動できます：

  • アプリケーションメニュー (システムツールカテゴリ)
  • コマンドライン: qsnapper

スナップショットの作成

  1. 「スナップショット作成」ボタンをクリック
  2. スナップショットタイプを選択 (Single、Pre、Post)
  3. 説明を入力
  4. クリーンアップアルゴリズムを選択 (オプション)
  5. 「作成」をクリック

スナップショットの表示

メインウィンドウには、すべてのスナップショットのリストが以下の情報とともに表示されます：

  • スナップショット番号
  • タイプ (Single、Pre、Post)
  • 日付と時刻
  • 作成したユーザ
  • 説明

スナップショットの比較

スナップショットを選択して以下を表示：

  • 追加、変更、削除されたファイル
  • 詳細なファイルの差分

スナップショットからの復元

  1. スナップショットを選択
  2. 「変更点の表示」をクリックしてスナップショット概要画面を開く
  3. ツリービューとdiffパネルでファイル変更を確認
  4. 復元したいファイル/ディレクトリにチェックを入れる
  5. 「選択項目を復元」をクリックしてチェックした項目を復元

Pre/Postスナップショットペアの場合：

  • ラジオボタンでPreスナップショットとPostスナップショットの差分表示を切り替え可能
  • 専用ボタンでPre/Postそれぞれのスナップショットから個別に復元可能

復元モード

qSnapperは2つの復元方式を提供しており、復元確認ダイアログから選択できます：

  • Direct Copy (高速) (デフォルト):
    マウントされたスナップショットから cp -a --reflink=auto でファイルを直接コピーします。
    Btrfsではreflinkによりファイルサイズに関わらずほぼ瞬時のcopy-on-writeが可能です。

  • YaST互換:
    YaSTの「ファイルシステムのスナップショット」モジュールと同じ復元方式 (reflink無しの cp -a)を使用します。
    Direct Copy方式で互換性の問題が発生した場合にこのモードを使用してください。

復元オプション

  • バッチサイズ (1〜1000、デフォルト: 100):
    1バッチあたりの処理ファイル数です。値を大きくするとスループットが向上する場合があります。値を小さくするとより細かな進捗表示が得られます。

復元中は、リアルタイムの進捗ログに各ファイルの復元状況が自動スクロール付きで表示されます。

警告:
スナップショットの復元は現在のデータを上書きする可能性があります。
確認する前に必ず変更を確認してください。

設定

Snapperの設定

qSnapperは既存のSnapper設定を使用します。
ルートファイルシステムのSnapper設定を行うには：

sudo snapper -c root create-config /

他のファイルシステムの場合：

sudo snapper -c <設定名> create-config <マウントポイント>

アプリケーション設定

アプリケーション設定は以下に保存されます：

  • ~/.config/Presire/qSnapper.conf

設定内容：

  • テーマモード (ライト、ダーク)
  • ウィンドウの位置とサイズ
  • 復元方式 (Direct Copy / YaST互換)
  • 復元バッチサイズ (1〜1000)
  • ユーザ設定

テーマ設定

qSnapperは、組み込みのThemeManagerを通じてテーマ切り替えをサポートしています：

  1. ライトモード:
    マテリアルデザインカラーに基づいた最適化された明るい配色
  2. ダークモード:
    低照度環境に適した快適なダーク配色

テーマ設定はアプリケーション設定に自動的に保存され、UIから切り替えることができます。

トラブルシューティング

D-Bus接続エラー

D-Bus接続エラーが表示される場合：

  1. D-Busサービスファイルがインストールされているか確認：

    ls /usr/share/dbus-1/system-services/com.presire.qsnapper.Operations.service

  2. D-Bus設定を確認：

    ls /usr/share/dbus-1/system.d/com.presire.qsnapper.Operations.conf

  3. D-Busサービスのステータスを確認：

    systemctl status dbus

権限拒否エラー

権限エラーで操作が失敗する場合：

  1. PolicyKitポリシーがインストールされているか確認：

    ls /usr/share/polkit-1/actions/com.presire.qsnapper.policy

  2. ユーザが必要なグループに所属しているか確認 (実装固有)

Snapperが設定されていない

Snapperが設定されていない場合：

sudo snapper list-configs

設定が存在しない場合は、設定セクションに示されているように作成してください。

開発

開発用ビルド

mkdir build-debug && cd build-debug
cmake -DCMAKE_BUILD_TYPE=Debug ..
make -j$(nproc)

プロジェクト構造

qSnapper/
├── CMakeLists.txt             # ビルド設定
├── src/                       # C++ソースファイル
│   ├── main.cpp              # アプリケーションエントリポイント
│   ├── fssnapshot.cpp        # スナップショットデータモデル
│   ├── fssnapshotstore.cpp   # スナップショットデータストア
│   ├── snapperservice.cpp    # Snapperサービスインターフェース
│   ├── snapshotlistmodel.cpp # スナップショットリストモデル
│   ├── snapshotgroupmodel.cpp # Pre/Postスナップショットグループ化モデル
│   ├── filechangemodel.cpp   # ファイル変更ツリーモデル
│   ├── thememanager.cpp      # テーマ管理 (ライト/ダークモード)
│   └── dbusservice/          # D-Busサービス実装
│       ├── main.cpp          # D-Busサービスエントリポイント
│       └── snapshotoperations.cpp  # D-Busメソッド実装
├── include/                  # ヘッダーファイル
├── qml/                      # QMLユーザインターフェース
│   ├── Main.qml             # メインウィンドウ (テーマサポート付き)
│   ├── pages/               # ページコンポーネント
│   │   └── SnapshotListPage.qml
│   └── components/          # 再利用可能なコンポーネント
│       ├── SnapshotItem.qml
│       ├── SnapshotDetailDialog.qml
│       ├── RestorePreviewDialog.qml
│       ├── SnapshotTableHeader.qml
│       ├── SnapshotTableRow.qml
│       ├── AboutqSnapperDialog.qml
│       └── AboutQtDialog.qml
├── cmake/                   # CMakeモジュール
│   └── packaging.cmake      # CPackパッケージング設定
├── icons/                   # アプリケーションアイコン
├── dbus/                    # D-Bus設定ファイル
├── polkit/                  # PolicyKitポリシーファイル
├── man/                     # manページソース (scdoc)
│   └── qsnapper.1.scd      # qsnapper(1) manページソース
├── selinux/                 # SELinuxポリシーモジュール
│   ├── qsnapper.te          # Type Enforcementルール
│   ├── qsnapper.if          # インターフェース定義
│   └── qsnapper.fc.in       # ファイルコンテキスト定義
├── Licenses/                # サードパーティライセンス
│   ├── Qt.md
│   ├── D-Bus.md
│   ├── PolicyKit.md
│   ├── Polkit-Qt.md
│   └── Snapper.md
└── translations/            # 翻訳ファイル
    ├── qsnapper_ja.ts       # 日本語翻訳
    └── qsnapper_de.ts       # ドイツ語翻訳

コントリビューション

コントリビューションを歓迎します！
イシューやプルリクエストを自由に提出してください。

ガイドライン

  1. 既存のコードスタイルに従う
  2. 変更を徹底的にテストする
  3. 必要に応じてドキュメントを更新する
  4. すべてのコミットに署名する

ライセンス

このプロジェクトはGNU General Public License v2.0以降の下でライセンスされています。
詳細についてはLICENSE.mdファイルを参照してください。

謝辞

  • Snapper - スナップショット管理ツール
  • Qt Project - クロスプラットフォームフレームワーク
  • PolicyKit - 認可フレームワーク

リンク

作者

Presire