iWant

CLIベースの分散型ピアツーピアファイル共有

ビルドステータス

概要

LANネットワーク内でファイルを検索・ダウンロードするためのコマンドラインツールです。中央サーバーは必要ありません。

特徴

• 分散型 : 中央サーバーでファイルをホストする必要はありません。そのため、単一障害点もありません。
• 簡単なファイル発見 : Googleで何かを検索するのと同じくらい簡単です。
• 複数ピアからのファイルダウンロード : シーダーがグループを離脱・失敗した場合でも、リーチャーはネットワーク内の別のシーダーからダウンロードを継続します。
• ディレクトリダウンロード : ディレクトリのダウンロードに対応しています。
• ダウンロード再開 : 中断したところからダウンロードを再開できます。
• データの一貫性 : 共有フォルダ内のファイルに変更（修正、削除、追加）があれば、即座にネットワークに反映されます。
• クロスプラットフォーム : Linux/Windows/Macで動作します。Macではさらなるテストが必要です。

なぜ作ったのか？

• ターミナルにファイル名を打ち込んで、周りの人が持っていればダウンロードできるというアイデアが気に入ったから。
• サードパーティへの登録は不要。
• 複雑な設定は不要。
• クロスプラットフォームにしたかった。
• ダウンタイムゼロ。
• ブラウザ不要…ターミナルだけでいい。
• 楽しみのため ¯\(ツ)/¯

インストール

pip install iwant

または、ソースからダウンロードした場合

python setup.py install --user

システム依存関係

以下のシステム依存関係がインストールされていることを確認してください：

• libffi-dev
• libssl-dev

使い方

iWant.

    LANネットワーク内でファイルを検索・ダウンロードするためのコマンドラインツール。中央サーバー不要。


使い方:
    iwanto start
    iwanto search <名前>
    iwanto download <ハッシュ>
    iwanto share <パス>
    iwanto download to <保存先>
    iwanto view config
    iwanto --version

オプション:
    -h --help                           この画面を表示します。
    --version                           バージョンを表示します。
    start                               システムでiwantサーバーを起動します。
    search <名前>                       ネットワーク内のファイルを発見します。例: iwanto search batman
    download <ハッシュ>                 ネットワークからファイルをダウンロードします。
    share <パス>                        共有フォルダを変更します。
    view config                         共有フォルダとダウンロードフォルダを表示します。
    download to <保存先>                ダウンロードフォルダを変更します。

注意: 共有フォルダとダウンロードフォルダは同じにできません

実行方法

iwanto start を実行します（これでiwantサービスが起動します）。

クライアントの実行

検索、ダウンロード、設定の表示・変更などのサービスを実行するには、別のターミナルを開き、iwantサーバーが起動していることを確認してください。

サーバーの実行

Windowsでは、サーバーを実行するために管理者権限が必要です。

iwanto start

ファイルの検索

ファイル名を入力してください。（正確な名前でなくても大丈夫です）

iwanto search <ファイル名>

例:

iwanto search "slicon valey"

ファイルのダウンロード

ファイルをダウンロードするには、検索後に表示されるファイルのハッシュを入力してください。

iwanto download <ファイルのハッシュ>

例:

iwanto download b8f67e90097c7501cc0a9f1bb59e6443

共有フォルダの変更

いつでも共有フォルダを変更できます（iwantサービス実行中でも）。

iwanto share <パス>

例:

iwanto share /home/User/Movies/

Windowsの場合は引用符で囲んでください:

iwanto share "C:\Users\xyz\books\"

ダウンロードフォルダの変更

いつでもダウンロードフォルダを変更できます。

iwanto download to <パス>

例:

iwanto download to /home/User/Downloads

Windowsの場合は引用符で囲んでください:

iwanto download to "C:\User\Downloads"

共有/ダウンロードフォルダの表示

iwanto view config

仕組み

プログラムが起動すると、選挙デーモン、フォルダ監視デーモン、__サーバーデーモン__が生成されます。

1. 選挙デーモン は以下の活動を担当します。

   • コンセンサスを管理します。
   • リーダーが変更されたらすぐに__サーバーデーモン__に通知します。
   • 選挙への立候補、リーダーの不在、ネットワーク障害、スプリットブレイン状況などについて、ネットワーク内の他ピアと調整します。
   • ピア発見には__マルチキャスト__を使用します。コンセンサスの説明はこちらに記載されています。

2. フォルダ監視デーモン が起動すると、以下の手順を実行します。

   • 共有フォルダ内のすべてのファイルをインデックス化します。
   • データベースのエントリを更新します。
   • インデックス化したファイルとフォルダについてサーバーに通知します。
   • 共有フォルダ内で変更があった場合、__フォルダ監視デーモン__が変更をトリガーし、変更されたファイルをインデックス化し、データベースを更新し、サーバーに変更を通知します。

3. iwantクライアント は、ユーザーが以下を行いたいときに__サーバーデーモン__と通信します。

   • ファイルの検索
   • ファイルのダウンロード
   • 共有フォルダの変更
   • ダウンロードフォルダの変更

4. サーバーデーモン は__iwantクライアント__からのコマンドと、__ファイル監視デーモン__および__選挙デーモン__からの更新を受け取ります。

   • __フォルダ監視デーモン__からの更新（インデックス化されたファイル/フォルダ情報など）はリーダーに転送されます。
   • __選挙デーモン__からの「リーダー変更」イベントなどの更新は、サーバーがインデックス化されたファイル/フォルダ情報を新しいリーダーに転送するトリガーとなります。
   • __iwantクライアント__からの「ファイル検索」などのクエリはリーダーに転送され、リーダーが他のピアから受け取ったメタデータに対してあいまい検索を実行し、(ファイル名, サイズ, チェックサム)のリストを返します。
   • __iwantクライアント__からの「ファイルダウンロード」などのクエリはリーダーに転送され、リーダーがファイル/フォルダのルートハッシュとそのファイルを持つピアのリストを転送します。__サーバーデーモン__はそのピアリストに含まれるピアとのダウンロードプロセスを開始します。
   • __iwantクライアント__からの「共有フォルダの変更」などの更新は、__サーバーデーモン__が__フォルダ監視デーモン__に新しいフォルダをインデックス化させるトリガーとなります。インデックス化が完了したら、__サーバーデーモン__は新しいインデックス化されたファイル/フォルダのメタ情報でリーダーを更新します。

TODO

• 強固なセキュリティ機構の導入
• Python3対応の追加
• ビデオプレビューの追加
• ストリーミング機能の追加
• 基本的なNATトラバーサルの追加
• テストモジュールの作成
• ファイル/フォルダダウンロード進捗バーのUI改善

うまく動作しない可能性がある理由

• ファイアウォール
• ルーターがマルチキャストに対応していない。

エラー

すべてのログは ~/.iwant/.iwant.log または AppData\Roaming\.iwant\.iwant.log にあります。

プロジェクトを気に入っていただけましたか？

アイデア、バグ、修正のご要望があれば、お気軽にPRをお送りください :)