GitHub
ポエム
ネタ
gitLib
いぬ

イッヌハブ をつくってみよう

More than 1 year has passed since last update.

イラスト担当:

イッヌハブ

イッヌハブは、いぬたちがそれぞれにじまんのリードを持ちより、みんなでほめあう場です。

ほかのいぬのステキなリードがほしいときは...がまんしておフロに入ると、ごほうびに神様が複製を作ってくれる決まりになっています。この決まりは、「イッヌハブ・オフロー」と呼ばれています。

リードのつづきをあみこんで、もっとステキなリードを作ることもできます。このことをアミッコと呼んでいます。世界中のいぬたちが、たくさんのアミッコをつみたててステキなリードを共有しているんですよ。

イッヌハブは、平和な場ですが、それでも、ときどき、うまくいかないことがあるのを、遠くからブルドッグのチームが見守っています。

たとえば、昔のアミッコがほつれているのが見つかると、ブルがそこまで出かけていって、だまって座りこんで近くのいぬに圧をかけてきます。

これを「ブルリクエスト」といいます。ほうっておくとブルリクエストはたまるいっぽうです。すこしずつでいいからなおしていきましょうね。


イッヌハブはつくれる?

さて、なんだかQiita運営から「内容がないよう」「なので明日夕方には利用規約に基づいて削除しますぞ」と言われてしまいました。

良い勉強の機会なので、もしもこういうGitHubっぽいサービス(GitHubクローン)を作るとしたらどうやるのかな?というのをサクッと考えてデモを作ってみようと思います。


既存のGitHubクローンの実装

いぬ用に限らない汎用的なGitHubクローンは、既にいろいろな言語で出ています。

いずれもオープンソースなので、少し実装を参考にしてみましょう。


Gitリポジトリーへのアクセス方法の違い

これらGitHubクローンは、どうやってGitリポジトリーのデータをパースしているのでしょうか。

大きく2つの方式に分かれるようです。


  • 実行環境のgitコマンドを実行して、得られた出力をパースする(つまりgitコマンドのラッパー)


    • GitLab


      • GitLab自作のgitlab_gitというライブラリーを利用しています。



    • Gitonomy


      • Gitnomy自作のgitlibというライブラリーを利用しています。



    • Gogs


      • Gogs自作のgit-moduleというライブラリーを利用しています。





  • gitコマンドに依存せず、独自のGit実装によりGitリポジトリーをパースする


    • GitBucket



      • JGitというpure JavaなGit実装ライブラリーを利用しています。





どっちかいうと、私はJGitのようにgitコマンドに依存しない実装の方が好きですね。gitコマンドのラッパーを使う方式だと、運用中にコマンドとラッパーのバージョン不整合が起こりやすそうで心配というのもあるのですが、gitコマンドをexecして別プロセスで動いてしまったものを間違いなく扱う自信があまり無い、というのも強いです。

とはいえ、いずれも利用実績の多いライブラリーです。言語を問わずに自分のコードからGitリポジトリーにアクセスできるというのは、クローンサービスを作るうえでは非常に心強いですね。

今回はあまり時間が無いので、私の数少ない引き出しで対応するためにPHP + CodeIgniter + gitlibで挑戦してみようと思います。


gitlibを使ってGitリポジトリーにアクセスしてみる

試しに、Gitリポジトリーの中の各コミットの情報を取得して、Webブラウザー上で表示できるかやってみましょう。

gitlibのリファレンスマニュアルを見ながらやっていきます。

たとえば次のような、いぬたちが作り始めたGitリポジトリーがあったとします。

masterブランチ1本だけで、コミットも2回だけです。

(GitのコミットメッセージにはUnicode絵文字が使えますから、きっと犬の文字3種がよく使われるでしょう)

sourcetree.png

これに、gitlibでアクセスしてみます。

Repository オブジェクトからmasterブランチの Branch オブジェクトを取り出して、そこから Commit オブジェクトをiterableっぽく取得することも可能なのですが、どうも良い感じのコードが書けませんでした。

代わりに、 Log オブジェクトからCommitオブジェクトの配列を取得してみます。

$repository = new Gitonomy\Git\Repository('/path/to/repository');

$commit_informations = array();

$paths = array();
$offset = 0;
$limit = 10;
$log = $repository->getLog('master', $paths, $offset, $limit);
$commits = $log->getCommits();
foreach ($commits as $commit)
{
$commit_informations[] = array(
'hash' => $commit->getHash(),
'committer_date' => $commit->getCommitterDate()
->setTimeZone(new DateTimeZone('Asia/Tokyo'))
->format('Y-m-d H:i:s'),
'message' => $commit->getMessage()
);
}

これをViewに出力すると...

gitlib01.PNG

おっ 何やら取得できますね~

コミット日付がなんだかずれちゃうのは謎ですが...

ともかく、Gitリポジトリーの内容をWebアプリから参照できるようになりました。


イッヌハブ アミッコ履歴表示の実装

サンプル実装がほどほどにできましたので、ちょっとだけイッヌハブらしい実装をやってみましょう。

Gitの「コミット」のように、イッヌハブ上でいぬがリードの続きを継ぎ足して新しいリードを紡いでいく想像上の動作を「アミッコ」と表現しました。(ダジャレとしてはかなり苦しかったのが残念)

アミッコの現実的な表現として、リポジトリー内にあるリードの画像をWeb画面上でGitのリビジョングラフの線として利用する、というのをやってみましょう。

アミッコのサンプルとして使うのは次の画像ファイル8個です。

gitlib02.PNG

画像ファイル名は amikko.png で固定して、次のように同じファイル名でひたすらコミットし続けた状態のリポジトリーを作っておきます。

gitlib03.png


BlobオブジェクトとTreeオブジェクト

Gitでは、リポジトリーから取得できるファイル実体のことをblobと呼んでいます。blobデータには識別子としてのファイル名が無く、SHA1ハッシュによってのみデータを一意に決めることができます。ファイル名は別途treeデータにより管理されています。

gitlibのオブジェクト構造もこれをなぞったものになっており、まず Tree オブジェクトを取得し、その情報にしたがって Blob オブジェクトを取得することで、リポジトリー内のファイル実体を扱えるようになっています。

では、先ほどのコードを少し変えて、 amikko.png とコミットメッセージだけ取り出した状態にしましょう。

$repository = new Gitonomy\Git\Repository('/path/to/repository');

$commit_informations = array();

$paths = array('amikko.png');
$offset = 0;
$limit = 10;
$log = $repository->getLog('master', $paths, $offset, $limit);
$commits = $log->getCommits();
foreach ($commits as $commit)
{
$blob = $commit->getTree()->getEntry('amikko.png');
$commit_informations[] = array(
'amikko' => $blob->getContent(),
'message' => $commit->getMessage()
);
}

getContent() で取り出したデータは、この場合ではPNG画像のバイナリーデータそのものです。Web画面に表示する方法として、ここではかんたんにBASE64エンコードしてから <img> 要素のdataスキームに埋め込んでしまいます。

リード画像の結合点に○記号をつけて出力してみると...

gitlib04.png

おお!リポジトリー内の歴代の amikko.png がリビジョングラフのように並びましたね!


イッヌハブ アミッコ投稿の実装

よしよし、ではいよいよアミッコを投稿する機能の実装だぞ、と思いきや...


なんとgitlibはコミット未対応!!!

ここに来て衝撃の事実が発覚するわけですが、gitlabにはcommit、reset、pushなどの、リポジトリーに変更を与える類のAPI実装が2016年10月時点でありませんでした。うむむ...Gitonomyはどうやっているんだろう...

その代わりに、Repositoryクラスのメソッドで、run()というGitコマンドを直接何でもexecできるものがあります。これで最低限commitくらいはできるか確認してみましょう。


なんでもできてしまうrun()

run()は、任意のgitコマンドを実行することができます。なんでもできます!!!

一応gitlibの方でエラーハンドリングをしているので、素でexecするよりは1億倍マシと言えるでしょう。

$repository->run(addやcommitなどのコマンド文字列, 引数文字列の配列);

addからcommitの流れであれば、次のような感じで動かすことができます。

$repository = new Gitonomy\Git\Repository('/path/to/repository');

// sourceからtargetに上書きします
file_put_contents(
'/path/to/repository/target.jpg',
file_get_contents('/source.jpg')
);
$repository->run('add', array('target.jpg'));
$repository->run('commit', array('-m "target.jpg"'));

さて、ほんとうにコミットされたのでしょうか...

05.png

おお!コミットされていますね!

これで、


  • クライアントは、アミッコ(画像)をサーバーにアップロードする

  • サーバーは、アップロードされたアミッコ(画像)をGitリポジトリーに登録する

  • サーバーは、Gitリポジトリーに登録されているアミッコ(画像)の履歴を一覧表示する

という、イッヌハブのごく基本的な機能を実装できるようになりました!


サーバーを立てて動かしてみよう

さて、ここまではWindows PC上で動作確認して記事を書いています。

いよいよ、技術デモとしてWeb上に公開するため、AWSのLinuxサーバーにデプロイしましょう。

私はリッチじゃないのでt2.microで様子を見ます。

なお、ドメインは先ほど取得しました。 現在、 http://innuhub.com/ で、アミッコを表示するデモが見られます。投稿までは今日中に間に合いませんでした…


そういえばソースコードは...

GitHubで公開 しました!コーディングうまくないので恥ずかしい…composer使いたい…


イッヌハブ作れました。今回のところは以上です。

ここまでやってもこの記事削除されちゃうのかな!!わかんない!!!

不足した機能とか見てくれは、この後ゆっくりいじっていきます。