書いてみたもの

mach3/google-spreadsheet.php @ GitHub

Google Spreadsheet Client for PHP. This requires “google/apiclient” package.

導入方法

Composer で導入出来ます。

{
    "require": {
        "mach3/google-spreadsheet": "*"
    }
}

Composer を使わない場合は Github からソースをダウンロードしますが、 その場合は、google/google-api-php-client に依存していますのでそちらも一緒に導入します。

<?php

// Composer の場合
require "vendor/autoload.php";

// ソースを直接ダウンロードした場合
require "the/path/to/google/apiclient/src/Google/autoload.php";
require "the/path/to/google-spreadsheet/src/autoload.php";

使い方

今までの例と同様に鍵ファイルを使用して認証をしますので、 Google Developper Console で鍵ファイルを生成しておきましょう。

認証してスプレッドシートを開く

シートを開いた時点でシート内のデータは取得されています。 なお、シートの1行目はヘッダ行としてフィールド名を連ねるようにしてください。

// 鍵ファイルでクライアントを初期化
$client = Google_Spreadsheet::getClient("the/path/to/key.json");
// スプレッドシートのIDでファイルを取得
$file = $client->file("XXXxxxXXXXxxxXXXX");
// シートのタイトルでシートを取得
$sheet = $file->sheet("Sheet1");

var_dump($sheet->items);

条件で行を選択する

クロージャまたは配列で条件を指定してリストを取得します。

// クロージャ
$items = $sheet->select(function($row){
    return $row["email"] === "foo@example.com";
});
// 配列
$items = $sheet->select(array(
    "id" => 23
));
// 条件がない場合は全部返ってきます
$items = $sheet->select();

行を追加する

シートに新しい行を追加します。

$sheet->insert(array(
    "name" => "Bob",
    "age" => 23,
    "email" => "bob@example.com"
));

セルの値を変更する

行番号と列番号（またはフィールド名）を指定して値を変更します。

// 8行目の"name"の値を"Tom"に変更します
$sheet->update(8, "name", "Tom");

// 8行目の2カラム目を"50"に変更します
$sheet->update(8, 2, 50);

キャッシュを保存する

サーバ上にファイルとしてキャッシュを保存する事ができます。

$client->config(array(
    "cache" => true,
    "cache_dir" => "cache",
    "cache_expires" => 3600
));

データを最新の情報に更新する

// キャッシュを無視したい場合は引数にTRUEを渡します
$sheet->fetch(true);

どこで使えるのか

スプレッドシートをお手軽な簡易データベースとして使うことが出来ますが、 毎度リクエストを飛ばす関係でパフォーマンスはどうしても落ちてしまいます。 また、データを丸ごと引っ張って来ているので大きなデータを扱うのには全く適していません。

• サーバーの都合でデータベースが使用出来ない
• データベースを使うほどのものではない
• エクセルライクなインターフェースで簡単にコンテンツを更新したい！

といったようなニーズにお応えする物でしょうか。 簡単なアンケート集計等にも使えるかもしれませんね。

まとめ

スプレッドシートについてはひとまずこれでやりきった感がありますね。 もっと便利なAPIの使い方があるかもしれないので、 都度ライブラリは改善していきたいと思っています。

良い使い道がある事を祈って。

軽いおさらい

前回は Google Developper Console で鍵ファイルを取得し、 それを使って認証してアクセストークンを取得、 APIにリクエストを投げてスプレッドシートの情報を引っ張るところまでやりました。

以降のコードは下記の変数が宣言されている前提で書かれています。

$accessToken; // アクセストークン文字列
$listfeed; // listfeedのURL
$cellsfeed; // cellsfeedのURL

シートのデータを取得する（listfeed）

listfeed はテーブルの内容を一行ずつまとめて出力する形式です。 セルの住所（A1, C6等）に特に興味がなく、とりあえず一覧用のデータが欲しい場合はこちらの形式が便利ですね。

先ほど取得しておいた “listfeed” のURLへ、同じ要領でリクエストを投げてみます。

$request = new Google_Http_Request(
    $listfeed . "?alt=json",
    "GET",
    array("Authorization" => "Bearer {$accessToken}")
);
$data = json_decode($curl->executeRequest($request)[0]);

例えば次のようなシートを読み込んだ場合…

次のようなデータが返されます。

{
    "feed": {
        "entry": [
            {
                "title": {
                    "type": "text",
                    "$t": "john"
                },
                "content": "age:26, email:john@example.com"
                "gsx$name": {"$t": "John"},
                "gsx$age": {"$t": "26"},
                "gsx$email": {"$t": "john@example.com"}
            }
        ]
    }
}

“title” は1カラム目の情報が、“content” は2カラム以降の情報が “key:value, key:value” の形式で格納されますが、 とりあえずこれらは無視して、“gsx$” の接頭辞が付いている物だけを見ていけば十分でしょう。 接頭辞が邪魔で扱いづらい場合は加工してあげましょう。

// データ加工の例
function _parse_listfeed ($entries){
    $list = array();
    foreach($entries as $entry){
        $item = array();
        foreach($entry as $key => $value){
            if(preg_match('/^gsx\$(.+)$/', $key, $m)){
                $item[$m[1]] = $value->{"\$t"};
            }
        }
        array_push($list, $item);
    }
    return $list;
}

$list = _parse_listfeed($data->feed->entry);

結果をJSONではなくXMLで取得した場合、gsx名前空間の要素を取得するのが少々面倒になります。

cf) PHPでXMLの名前空間つきタグを読み込む色々 – Mach3.laBlog

シートのデータを取得する（cellsfeed）

cellsfeed は、セルの値を1つずつ出力してくれる形式です。 listfeed のように一行ずつエントリーとしてまとめたい場合には加工が必要ですが、 行・列番号を取得しておきたい場合などにはこちらを使うと良いでしょう。

$request = new Google_Http_Request(
    $cellsfeed . "?alt=json",
    "GET",
    array("Authorization" => "Bearer {$accessToken}")
);
$data = json_decode($curl->executeRequest($request)[0]);

結果は次のようなデータが返されます。

{
    "feed": {
        "entry": [
            {
                "title": {
                    "type": "text",
                    "$t": "A1"
                },
                "content": {
                    "type": "text",
                    "$t": "name"
                }
            }
        ]
    }
}

“title” にはセルの住所、“content” にはその値が格納されています。 このエントリーが入力されているセルの数だけ羅列されます。

例えば、（あまり賢い選択とは言えませんが）このデータをリスト形式に整理してみましょう。

// データ加工の例
function _parse_cellsfeed ($entries){
    $fields = array();
    $list = array();

    foreach($entries as $entry){
        preg_match("/^([A-Z]+)(\d+)$/", $entry->title->{"\$t"}, $m);
        $content = $entry->content->{"\$t"};
        $r = (int) $m[2];
        $c = $m[1];

        if($r === 1){
            $fields[$c] = $content;
            continue;
        }
        if(array_key_exists($c, $fields)){
            $list[$r] = is_array($list[$r]) ? $list[$r] : array();
            $list[$r][$fields[$c]] = $content;
        }
    }

    return $list;
}

$list = _parse_cellsfeed($data->feed->entry);

シートに新しいデータを追加する

読み込みの次は、データの書き込みをしてみましょう。 listfeed のURLにXMLの本文付きでPOSTすると、新しい行が追加されます。

既存のテーブルに次のようなデータを追加してみましょう。

本文の形式は “application/atom+xml” になります。 listfeed の読み込みの際に使用した gsx名前空間を活用して本文を作成しましょう。

$postBody = <<<EOS
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:gsx="http://schemas.google.com/spreadsheets/2006/extended">
    <gsx:name>Tom</gsx:name>
    <gsx:age>32</gsx:age>
    <gsx:email>tom@example.com</gsx:email>
</entry>
EOS;

作成した本文と Content-Type ヘッダを付加してリクエストを投げます。

$request = new Google_Http_Request(
    $listfeed
    "POST",
    array(
        "Authorization" => "Bearer {$accessToken}",
        "Content-Type" => "application/atom+xml"
    ),
    $postBody
);

$res = $curl->executeRequest($request);

成功するとシートの最後の行にデータが追加されます。

<, > を含む値を扱う際、そのまま入力するとXMLの文法が不正になりますので、 htmlspecialchars 等を使って特殊文字を変換してあげると良いでしょう。

行・列番号を指定してセルの値を更新する

行単位ではなく、セル単位で値を変更する場合には cellsfeed を使用します。 データの追加と同じく、XMLの本文を作成してPOSTします。

$postBody = <<<EOS
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:gs="http://schemas.google.com/spreadsheets/2006">
    <gs:cell row="3" col="2" inputValue="33"/>
</entry>
EOS;

使用する名前空間は gs になります。ここでは、「3行目の2列目の値を”33″に変更」しています。

$request = new Google_Http_Request(
    $cellsfeed,
    "POST",
    array(
        "Authorization" => "Bearer {$accessToken}",
        "Content-Type" => "application/atom+xml"
    ),
    $postBody
);

$res = $curl->executeRequest($request);

成功するとスプレッドシートのセルの内容が書き換えられます。こちらも値の特殊文字の変換はお忘れなきよう。

めんどくさいですか？

毎度こんな事をしているのは些か面倒なので、 この辺の処理を簡略化したライブラリを書いてみました。 次回はその紹介となります。

下準備

まず必要な物をまとめます。

1. サービスアカウントの鍵ファイル
2. 1のアカウントに編集権限を与えたスプレッドシート
3. Google製のクライアント（PHP）

サービスアカウントの鍵ファイル

1. Google Developper Console でプロジェクトを作成します。
2. 「認証情報」→「認証情報の追加」から「サービスアカウント」を選択
3. 鍵ファイルをJSON形式で取得します。

このファイルは認証情報が記載されている大変重要なファイルなので、 サーバー上に設置する際には公開される状態にしないように配慮しましょう。

新規スプレッドシートの作成

1. Google Drive で新しいスプレッドシートを作成します。
2. 前工程の鍵ファイル内の「client_email」のメールアドレスに「編集者」の権限を与えます
3. アドレスバーからスプレッドシートのIDをコピーしておきます

google/apiclient のインストール

ここでは認証に google-api-php-client を使用します。

Google APIs Client Library for PHP
The Google API Client Library enables you to work with Google APIs such as Google+, Drive, or YouTube on your server.

Composer でインストールするか、直接ソースをダウンロードするかお好みでどうぞ。

Composer の場合

require "vendor/autoload.php";

直接ダウンロードして設置した場合

require "the/path/to/google-api-php-client/src/Google/autoload.php";

認証してアクセストークンを取得する

APIにリクエストを投げるにはアクセストークンが必要なので、 まずはこれを取得します。

// クライアントを新たに生成
$client = new Google_Client();
$client->setApplicationName("DemoApp");
// 証明書を生成して
$credentials = $client->loadServiceAccountJson("./keys.json", array(
    Google_Service_Drive::DRIVE
));
// クライアントに読ませる
$client->setAssertionCredentials($credentials);

// アクセストークンをリフレッシュする
$client->getAuth()->refreshTokenWithAssertion();
// アクセストークンを取得
$accessTokenJson = $client->getAccessToken();
$accessToken = json_decode($accessTokenJson)->access_token;

本来ならばこのアクセストークンはセッションに保存して再利用するのですが、 ここでは例をシンプルにするためにそのくだりは省いています。

スプレッドシートファイルの情報を取得する

google/apiclientにスプレッドシートを色々触れるAPIが用意されていればよかったのですが、 ちょっと見当たらなかったので、Google_Http_Request と Google_IO_Curl を使って直接リクエストを飛ばします。

$sheet_id = "XXXxxxXX-XXXxxxxxXXXXXX";
$request = new Google_Http_Request(
    "https://spreadsheets.google.com/feeds/worksheets/{$sheet_id}/private/full?alt=json",
    "GET",
    array("Authorization" => "Bearer {$accessToken}")
);
$curl = new Google_IO_Curl($client);
$res = $curl->executeRequest($request);

$data = json_decode($res[0]);

URLに alt=json パラメータを付加しておくことでJSONでレスポンスが返ってくるので、デコードしましょう。 （デフォルトではAtomなのですが、PHPでは少々扱いづらい為JSONにしています）

かなり多くの情報が格納されているので目が回りそうですが、 スプレッドシートAPIでは共通して、概ね必要な情報は “feed” オブジェクト内の “entry” の中に入っています。

"entry": [
    {
        "id": {...},
        "category": {...},
        "title": {...},
        "content": {...},
        "link": {...},
        ...
    }
]

こんな感じの構造になっていて、 “entry” の中にはそのスプレッドシートに含まれるシートの数だけオブジェクトが連ねてあります。 ここで肝になるのは “link” の部分で、それぞれのシートを読み書きする際にリクエストを飛ばすエンドポイントURLが記されています。

"link": [
    {
        "rel": "http://schemas.google.com/spreadsheets/2006#listfeed",
        "type": "application/atom+xml",
        "href": "https://spreadsheets.google.com/feeds/list/XXXxxxXX-XXXxxxxxXXXXXX/od6/private/full"
    },
    {
        "rel": "http://schemas.google.com/spreadsheets/2006#cellsfeed",
        "type": "application/atom+xml",
        "href": "https://spreadsheets.google.com/feeds/cells/XXXxxxXX-XXXxxxxxXXXXXX/od6/private/full"
    },
    ...
]

読み書きに必要な “listfeed” と “cellsfeed” を変数等に格納しておきましょう。

続きは次回

今回はスプレッドシートの情報を取得する所までこぎつけました。 次回はいよいよ実際に読み書きの処理を行ってみます。

新しくなった Google スプレッドシート

今までは個人設定をいじる事で旧バージョンのスプレッドシートを使い続ける事ができたのですが、 先日からそのオプションが設定画面から消えていて、特別な方法をとらないと旧バージョンのスプレッドシートを新規作成出来なくなりました。 （すでに作成したスプレッドシートは変更されない様です）

刷新された Google スプレッドシートにどのような素晴らしい機能が追加されたかは未だあまり把握していませんが、 現状で確かな事は、旧バージョンで使えたRSSやJSONでの公開APIが実装されていないという事です。 今後実装されるかどうかはわかりません。

以前書いたGhostsheetはそれらの公開APIを利用した物だったので、新しいスプレッドシートでは使用する事ができません。

2014/11/20 追記

現在ではAPIが整備された様で、新しいスプレッドシートでも旧Ghostsheetが正常に動作する事を確認しました。
Googleスプレッドシートを簡易DBとして利用する -　PHP+Ajax編

Ghostsheet も新しくしました

とはいえ、pubhtml（Webページの公開）APIは利用可能なので、それをスクレイピングしてデータ化する物を新たに書きました。 全く別物になったのでリポジトリも改めています。

• mach3/ghostsheet2 @ GitHub

簡単な使い方

以前と同様に、スプレッドシートを作成して「Webに公開」します。

一行目のヘッダ部分でデータの型を指定する事が出来ます。 上記にある integer、bool の他に、float、json が利用出来ます。 省略時は string になります。

そしてスプレッドシートのキーをメモしておきます。スプレッドシートのキーはURLの下記太文字の箇所になります。

https://docs.google.com/spreadsheets/d/00X_xxxXX_0xXxxXx00XXXxx-xxXXxX0-XxXxXx0XxxX/edit#gid=0

このキーをそのまま引数にしてメソッドの呼び出しをします。

<?php

require "the/path/to/ghostsheet/phplib/Ghostsheet.php";

$gs = new Ghostsheet();
$gs->config("cache_dir", "./cache");
$data = $gs->load("00X_xxxXX_0xXxxXx00XXXxx-xxXXxX0-XxXxXx0XxxX");
var_dump($data);

結果は連想配列で返され、”sheets” の中に各シートのデータが格納されるようになっています。

array(3) {
  ["title"]=>
  string(4) "My Spreadsheet"
  ["key"]=>
  string(44) "00X_xxxXX_0xXxxXx00XXXxx-xxXXxX0-XxXxXx0XxxX"
  ["sheets"]=>
  array(2) { ... }
}

旧版との大きな違い

旧版ではスプレッドシートに含まれるシート名で引くためには複数回リクエストしなければなりませんでしたが、 pubhtmlでは全てのシートがひとつのWebページで公開される為、一回のリクエストで済みます。 あまり大量のデータになると辛そうですが、そういった大きなデータでは利用すべきではないと思うので、 結果的には効率が良くなったと言えそうです。

メソッドの使い分け

Ghostsheet にはデータを取得する為に4つのメソッドがあります。

• load
  • キャッシュファイルが期限切れでなければそれを使用
  • そうでなければリモートから最新のデータを取得し、キャッシュファイルを更新
• cache
  • キャッシュの生死に関わらずキャッシュのデータを返す
• fetch
  • キャッシュの生死に関わらずリモートからデータを取得
  • キャッシュの更新は行わない
• update
  • キャッシュの生死に関わらずリモートからデータを取得
  • キャッシュの更新を行う

一見すると load で良さそうですが、その場合、キャッシュの期限が切れるたびにレスポンスが遅くなるタイミングが出てきてしまいます。 対策としてはデータの取得は常にキャッシュから行い、非同期で load を呼び出すのがレスポンスに優しそうです。

（おまけ） Gruntタスク

おまけ機能としてGruntタスクをつけておきました。 スプレッドシートのデータを引っ張ってJSONファイルとしてローカルに保存するだけの簡単な物です。 シートのデータを元に静的サイトをジェネレートしたい場合などに使えたり、使えなかったり。

grunt.initConfig({
    ghostsheet: {
        dev: {
            files: {
                "./data/mydata.json": "00X_xxxXX_0xXxxXx00XXXxx-xxXXxX0-XxXxXx0XxxX"
            }
        }
    }
});

grunt.loadNpmTasks("ghostsheet2");

まとめ

わりと力技なパースなので、できれば用意されたAPIを使いたい気持ちもありますが…

ちなみに一応旧版でも新規作成する方法は残されていて、下記指定のURLにアクセスするだけで可能です。 旧版のデータが残されている以上、当面は使えそうです。

• https://g.co/oldsheets

cf) 新しい Google スプレッドシートについて – ドキュメント エディタ ヘルプ

まえおき

やりたいこと

• 仮想マシン（Windows）で、ローカルで制作中のWebサイトの動作確認をしたい。
• せっかくなのでhttpアクセスで閲覧したい。
• でもどこかにアップロードしたりローカルサーバ構築したりするのはめんどう。
• せっかちなのでDropboxの同期をまっている心の余裕がない。

こういう時にはPHPビルトインウェブサーバーが簡単でおすすめです。

• 好きなディレクトリをドキュメントルートにしてコマンド一発で即時に簡易Webサーバが立ち上がります。
• ログがターミナルに流れるのでわかりやすく、どことなくテンションがあがります。
• ちょっとしたPHPのスクリプトを確認できるオマケつき。
• ルータースクリプトも使える。

別にやりたくないこと

• PHPの動作確認はちゃんと仮想マシン上のLinux等の開発環境で行います。
  
  （できるだけ本番環境にあわせてチェックを行いたいですし、 PHPを弄る様な方ならば素直にLinux環境のVMで環境構築した方が断然楽だと思います。）

ビルトインウェブサーバーの使い方

PHP5.4+ の導入

ここでは詳しく触れませんが、ビルトインウェブサーバーを使用するにはPHP5.4以降が必要です。 Windowsでもすぐに動くバイナリが配布されていますし、Macならmacportsやhomebrewで導入も容易だと思います。

• PHP For Windows: Binaries and sources Releases
• The MacPorts Project — Home
• Homebrew — OS X用パッケージマネージャー

ビルトインウェブサーバーの起動

• PHP: ビルトインウェブサーバー – Manual

詳しくは上のURLにある通りです。php コマンドに -S オプションを渡す事でウェブサーバーを起動することができます。 その他オプションの書式は下記のようになります。

$ php -S <ホスト名>:<ポート番号> -t <ドキュメントルートのパス>

例えば、localhostの8080番ポートで、 “public_html” ディレクトリをドキュメントルートとしてWebサーバを立ち上げる場合は次のようになります。

$ php -S localhost:8080 -t public_html

仮想マシンから確認する

ホスト名がlocalhostでは仮想環境からアクセスする事ができません。 そこで、次のようにホスト名を “0.0.0.0” にして起動する事で外部から接続できるようになります。

$ php -S 0.0.0.0:8080 -t public_html

例えばサーバを起動するマシンのローカルIPアドレスが 192.168.10.3 などだった場合、 仮想マシンのゲストOSから “http://192.168.10.3:8080” へアクセスすれば直接動作確認をする事ができるようになります。 （これはあくまで一例で、アクセス先のアドレスは仮想マシンのネットワーク設定によって様々なので注意しましょう）

IEの確認には、Microsoft提供の modern.ie が便利です。 昔はVrtualPC用のイメージだけだったのですが、modern.ie になってからはVirtualBox、VMWare、Parallels等、 様々なプラットフォーム用の仮想マシンイメージを配布しています。

• Internet Explorer のテストが簡単に | modern.IE

ルータースクリプトを使う

このビルトインウェブサーバーの素敵なポイントの一つに、ルータースクリプト を簡単に使用出来るという利点があります。 ざっくり言うと、Apacheのmode_rewriteのような処理がPHPスクリプトを通じて行えるようになる代物です。

例えばこれは、Wordpress の .htaccess にある mod_rewrite の記述です。 この記述のおかげで WordPress はURLをデザインする事が出来るわけですね。

# BEGIN WordPress
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . /index.php [L]
</IfModule>
# END WordPress

ここで記述されているルールは非常に単純で、 「アクセスされたURLにあたるファイルやディレクトリが存在しない場合は、index.phpでレスポンスを返す」だけです。 同様の処理をPHPのルータースクリプトで記述してみましょう。

<?php
/* _router.php */
if(file_exists($_SERVER["REQUEST_FILENAME"])){
    // false を返すとリクエストされたリソースをそのまま返します
    return false;
} else {
    require "index.php";
}

あとは、この内容を記述した “_router.php” をコマンドに渡すだけです。

$ php -S 0.0.0.0:8080 -t public_html public_html/_router.php

mod_rewrite のような処理を簡単にテストしたい場合や、 History.pushState を使った構成で制作を進める時などに重宝しています。

Gruntタスクで起動する

Gruntを使って開発をされている方は、grunt-contrib-connect のような感じで開発用サーバを起動したいと考えるでしょう。 ちょうどそのようなプラグインが公開されていたので、ここはひとつ活用させて頂きます。

• sindresorhus/grunt-php @ Github

タスク設定例:

grunt.initConfig({
    php: {
        dist: {
            options: {
                port: 8080,
                hostname: "0.0.0.0",
                base: "public_html",
                router: "_router.php",
                keepalive: true
            }
        }
    }
});

router のパスは base からの相対パスになります。

JavaScriptやCSSのコンパイル等で watch タスクを利用している場合は、サーバーの起動と同時に行えるようにしたいですね。 その際には keepalive を false にし、次のように watch の前に登録して起動します。

// `$ grunt dev` で起動
grunt.registerTask("dev", ["php:dist", "watch"]);

Grunt で php を扱うプラグインにはこの他にも ddprrt/connect-php があります。 こちらは grunt-conrib-connect のミドルウェアとして動かすタイプのライブラリで、 5.4+ でなくても動くかわりに、ルータースクリプト等は使えなさそうです。gruntベースで自前で書けという事でしょう。

また、プラグインを探していた当初、grunt-php が見つからなかった為、 ほぼ同じような動作をする物を自前で書いて使っていたのは秘密です。 私が書いた物よりも grunt-php の方が優秀そうなので、何も書かなかった事にしました。 grunt-php に無くて自前の物にある機能といえばアクセスログの出力ぐらいで、オプションの名前などもほとんど同じでした。 どちらも grunt-contrib-connect を参考にしているので当たり前ですね。

まとめ

単純に確認用のサーバを起動したいのならば grunt-contrib-connect で十分なのですが、 URLのリライト等をしたい場合などはPHPビルトインウェブサーバーの方が楽に設定出来る気がします。 Gruntを使わない人でも簡単に扱えるは大きなメリットですね。

1. やりたい事
2. 書いてみたもの
3. 基本的な使い方
4. Ajaxで利用する
5. JSONPで利用する
6. その他オプション・機能など
7. 必ず気をつけなければならないこと
8. まとめ : Googleスプレッドシートの活用について

「新しくなったスプレッドシートと簡易データベース化」でGhostsheetが使えなくなったと書きましたが、新スプレッドシートでもAPIが整備された様で、2014年11月20日現在では正常に動作する事を確認しています。但し、スクリーンショット類は古い物なのでご注意ください。（スプレッドシートIDの取得はURLを参照されるのが良いでしょう）

やりたい事

• Googleスプレッドシートからデータを利用して展開したい
• データは分かりやすい形に加工しておきたい
• 直接JSONで読めるけど、毎回読みに行くのは非効率なのでなんとかしたい
• スプレッドシートがメンテ中の時も対応したい

つまり、サーバ上に加工したデータをキャッシュとして保存しておけば良いわけですね。

書いてみたもの

Ghostsheet by mach3

今回はPHPで書いてみました。こんな感じにはたらきます。

1. 渡されたIDを頼りにスプレッドシートをJSONで読み込んできます
2. 加工したデータをキャッシュに保存し、返します
3. 二回目以降のリクエストは、キャッシュの期限内であればキャッシュから返します
4. キャッシュが期限切れならば再度リモートから読み込んできます

基本的な使い方

1. スプレッドシートを作る

Googleドライブ で、簡易DBにするスプレッドシートを作成します。 一行目はフィールドのキーで構成されるヘッダ行にします。これらのキーを元にデータは加工されます。

キーの末尾に書かれている :integer 等の文字は、値の型です。 これを指定しておくと、データを加工する際に値をその型にキャストするように頑張ってくれます。 省略時の初期設定は”string”です。 “integer”, “boolean”, “float”等が使用できるほか、”array” ではカンマで区切った配列が、 “json” ではJSON文字列としてパースされた結果が格納されます。

2. スプレッドシートを公開 & IDを取得する

「ファイル」→「ウェブに公開」でシートの公開設定ができます。

1. 「公開開始」ボタンを押して公開します
2. 「公開データへのリンクを取得」で「RSS」を選択します。

すると、次のようなURLが表示されるので、

https://spreadsheets.google.com/feeds/list/XXxxxxXXXxxxXx/od6/public/basic?alt=rss

太文字の “XXxxxxXXXxxxXx/od6” にあたる部分をコピーします。 これはこの後スプレッドシートのIDとして使用されます。

3. Ghostsheetで読み込む

Ghostsheet.php を任意の場所に設置してrequireし、初期化してスプレッドシートを読み込みます。

require "Ghostsheet.php";

$gs = new Ghostsheet();

// キャッシュ用のディレクトリを設定しておきます
// config() で配列を渡すこともできます
$gs->set("cacheDir", "./gscache/");

$mySpreadsheetId = "XXxxxxXXXxxxXx/od6";
$data = $gs->load($mySpreadsheetId); // $dataに加工されたデータが格納されます

あとは、読み込まれたデータを好きな様に料理してください。

Ajaxで利用する

Ghostsheetには、Ajaxで簡単に利用する為の ajax() メソッドが用意されています。 ajax() は引数の配列（省略時のデフォルトは $_GET）を使用して処理し、JSON形式でレスポンスを返します。

ajax.php

require "Ghostsheet.php";

$gs = new Ghostsheet();
$gs->set("cacheDir", "./gscache/");
$gs->ajax();

jQueryによる読み込み例

$.getJSON("ajax.php", {
    id : "XXxxxxXXXxxxXx/od6"
})
.then(function(data){
    console.log(data.items);
});

JSONPで利用する

Ajax同様にJSONPでレスポンスを返すことも出来ます。 あまりおすすめできる機能ではないので、初期設定では無効化されています。

require "Ghostsheet.php";

$gs = new Ghostsheet();
$gs->config(array(
    "cacheDir" => "./gscache",
    "jsonp" => true // JSONP機能を有効に
));
$gs->ajax();

受け取るidのホワイトリストを作ったり、 キャッシュディレクトリを非公開にするなどの対策をして使用した方が良いかな、と思います。

その他のオプション・機能など

ざっくりとしか書いてませんが、APIドキュメントをどうぞ。

Ghostsheet : API Doc

必ず気をつけなければならないこと

Googleスプレッドシートを簡易的なCMSとして使用する上で、気をつければならないこと。

非公開情報は載せない

「Webで公開」機能を利用しないと使えないライブラリなので、 そのスプレッドシートの内容は全て公開されてしまいます。

共有設定に気をつけて

第三者が編集できるような状態にしない。 クライアントと共有したい場合は、限定公開でユーザーを決め打ちしましょう。

「変更が加えられると自動的に再公開する」のチェックはオフに

編集途中の状態で公開されて恥ずかしい思いをする可能性があります。 自動公開ではなく、編集が終わったら都度「今すぐ再公開」ボタンを押すようにしましょう。

まとめ : Googleスプレッドシートの活用について

私は、優秀なクローンでも出ない限り、テーブルの編集でGoogleスプレッドシートの右に出るサービスは無いと思っています。 そして、WYSIWIGではなくテーブルでの管理をしたいWebコンテンツというのも多くあるでしょう。 例えば、

• お店のメニュー表
• 製品リスト
• 詳細画面の要らないニュースリスト
• その他リストコンテンツ

などなど。このようなデータコレクション的なコンテンツは、 CMSでがんばって実装したりするよりはテーブルで管理出来たほうが メンテナンスの効率も良いと感じるのです。

また、WordPressはわからないけどExcelならいつもつかってるからわかるよ！ というWeb担当者も多くいらっしゃると思います。 （専任の枠を割けずに総務の方が兼任しているようなケースでは特に）

そんなわけで、私はこのお題を執拗に探求しているのであります。

HybridAuthとは

HybridAuth, Open Source Social Sign On PHP Library

HybridAuth enable developers to easily build social applications to engage websites vistors and customers on a social level by implementing social signin, social sharing, users profiles, friends list, activities stream, status updates and more.

WebサイトにOAuth認証を簡単に設置する為のPHPライブラリです。 Twitter、Facebook等をはじめとした様々なサービスに対応しています。 サポートされているサービスは、現時点で32。

また、CodeIgniterやCake、Zend等のFWはもちろん、 WordPressやJoomula等のCMSのプラグインとしても利用できます。

• II. Third-party Plugins | Download HybridAuth

HybridAuth と Opauth の違い

HybridAuthはOpauthと似たタイプのライブラリですが、 この2者で大きく異る点、というよりはHybridAuthのメリットを2つご紹介します。

1. 自由にカスタマイズ可能なURL
2. APIにアクセスするメソッド

自由にカスタマイズ可能なURL

Opauthは、ログインURLの一部にサービス名を含んでいないと正常に動きません。 URLの文字列から認証するサービスを判別する為です。 （ここらへん、前回の記事では説明不足でしたね。すみません。）

例えば、「http://www.example.com/login/twitter」ならtwitterの認証画面へ、 「http://www.example.com/login/facebook」ならFacebookの認証画面へ飛ぶわけですね。

一方HybridAuthには、そういった縛りはありません。 そのかわり、認証メソッドの引数にサービス名を渡す事になります。

APIにアクセスするメソッド

Opauthは認証するだけでしたが、HybridAuthは認証した後にAPIにアクセスしてgetしたりpostしたりできます。 これ一本で全部面倒見切れそうですね。

簡単な使い方

HybridAuthを hybirdauth/ ディレクトリに保存したと想定して、 次のようなファイル構成にしてみます。

login.php (ユーザーがアクセスするページ)
config.php (設定ファイル)
hybridauth/ (ダウンロードしたHybridAuthの構成ファイル)
├ config.php
├ index.php
├ install.php
└ Hybrid/

設定ファイルを作る

hybridauth/config.php を参考にして、config.phpを作って必要事項を明記しましょう。 ここでは、Twitterのログインに必要な物だけを記載しておきます。

<?php

return array(
    "base_url" => "http://localhost:8080/hybridauth/",
    "providers" => array(
        "Twitter" => array(
            "enabled" => true,
            "keys" => array(
                "key" => "[your app's consumer key]",
                "secret" => "[your app's consumer secret]"
            )
        )
    )
);

base_url

実際にOAuthのやり取りをしてくれるスクリプトを指します。 多くの場合HybridAuthをインストールしたディレクトリになります。

providers

認証したいサービスの設定を列挙していきます。 Twitterの場合は、作成したアプリケーションのconsumer keyとconsumer secretを記載します。

ログイン処理を書く

./login.php を用意して、ログイン処理を書いてみます。

<?php

// 設定ファイルを引数にして初期化する（配列でもOK）
$auth = new Hybrid_Auth( "./config.php" );

// 認証の実行（未認証の場合はここでリダイレクトされ、認証済みの場合はスルーされます）
$twitter = $auth->authenticate("Twitter");

// ↓ ここから認証済みの場合の処理
echo "<h1>認証されています！</h1>";

// ユーザー情報をまとめてくれる getUserProfile() メソッド
var_dump(
    $twitter->getUserProfile()
);

// APIにアクセスしてみる
var_dump(
    $twitter->api()->get("account/verify_credentials.json")
);

コメントの通りです。authenticateメソッドだけでほとんど余計な処理は省かれて、スッキリしていますね。

実際の動作としては、こんな感じみたいです。

1. ユーザーがlogin.phpにアクセス
2. hybridauth/index.php に移動、そこからサービスの認証画面へリダイレクト
3. 認証が済んだらトークンをセッションに保存して、再びユーザーが元いたlogin.phpに移動

base_url について

config.php で出て来た base_url ですが、少し補足しておきます。

要するにこの項目は、全ての認証処理を代理で行なってくれるイケてるしヤバい hybridauth/index.php にアクセスさせる為の物です。 もっと言えば、そこにアクセスしたユーザーに対して hybridauth/index.php に記述されている処理が走りさえすれば良いです。

ですので、上の例示では hybridauth/ ディレクトリが公開ディレクトリにある前提になっていますが、 そうでない場合（非公開ディレクトリになっていたり、フレームワークの都合上アクセス出来なくなっていたりする場合）、 アクセスさせるファイル内で hybridauth/index.php をインクルードしさえすれば動くはずです。

例えば、”base_url” を /auth.php 等として、該当ファイルを設置し、

require_once("/the/path/to/hybridauth/index.php");

等としておけば良いですね。

気になった事柄

公式の例示では、APIアクセスも、認証済みである事を前提としていました。

認証を使わず、アプリに割り振られたのアクセストークンを使ったAPIアクセスは可能なのか、が気になりました。
それをするならそういうライブラリを使えば良いのですが、一つで済むならそれが一番ですよね。
気が向いたら調べてみます。

HTTPでアクセスしてチェックしたいケースとは

Webページを制作している時、多くの場合はそのままブラウザで開けば動作チェックが出来ますが、 サーバーを通してHTTPでアクセスしないと正常に動作しないケースもあります。

つまり、「file:～」ではなく、「http:～」でアクセスしたい。例えば、

• ChromeからAjaxのテストをしたい
• 各種ウィジェットのスクリプトの表示をチェックしたい

Chromeのケースは起動オプション（”–allow-file-access-from-files”）で解決できますし、 ウィジェットもスクリプトの中身を少しいじれば動くことが多いですが、 いずれもWebサーバーを通せば難なく動作するわけで、それがすぐに出来るのならばその方がシンプルではないかな、と思うわけです。

ではどうしようか

既にXAMPP/MAMPPや仮想マシン等でサーバ環境がある場合は良いのですが、 バーチャルホスト等の諸設定をこなすのが面倒くさかったり、とにかくささっと確認したいような場合は、 簡易的なサーバを利用してのチェックがお勧めです。

サッと起動して、サッ確認し、終わったらサッと終了する。

ここでは、3つの方法を提案してみます。

1. SublimeServerでチェックする
2. PHP5.4+のビルトインサーバーでチェックする
3. ローカルプロキシでチェックする

SublimeServer でチェックする

もし貴方がSublime Text 2を使って制作をしているのならば、これを使わない手はないでしょう。 Sublime Serverは、Sublime Text 2で動作する簡易Webサーバープラグインです。

SublimeServer

learning/SublimeServer

Allow you run a HTTP Server in SublimeText 2, and serves all the open project folders

メリットは、作業環境からすぐに実行できる点ですね。

インストール

1. 「Sublime Package Control」をインストール
2. コマンドパレットから 「Install Package」>「SublimeServer」 と打ち込む

※プラグインの導入法については以前書いた記事などをご参考に

使い方

1. 「Tools」>「SublimeServer」>「Start SublimeServer」で起動
2. 確認したいHTMLファイルを開いて、右クリックし、「View This File in Browser」

これで、デフォルトのブラウザで目的のファイルが開かれます。 URLは以下のようになります。プロジェクトがルートディレクトリのような扱いになっていますね。

http://localhost:8080/[folder name]/index.html

ポート番号の「8080」は、「Tools」>「SublimeServer」>「Settings」 で変更できます。

PHP5.4+のビルトインサーバーでチェックする

マシンにPHP5.4以降がインストールされているのあらば、 PHPにビルトインされている簡易Webサーバーが利用できます。

PHP: ビルトインウェブサーバー – Manual

メリットはPHPの動作チェックが出来る点ですが、 簡易的な物なのでrewrite等は動かず、そこらへんに依存するFW等の動作は難しいでしょう。 そういう大掛かりな物は、きちんと仮想環境を構築してテストしましょう。

使い方

※PHP5.4以降が導入済みで、パスが通っている前提で話を進めます。

1. ターミナル（あるいはコマンドプロンプト）を開く
2. 
   

   目的のファイルがあるディレクトリまで移動して、以下のコマンドを実行する

   
   

   php -S localhost:8080

   
   
3. 
   

   ブラウザを開いてアドレスバーにURLを入力する

   
   

   http://localhost:8080/index.html

   
   

実行したディレクトリがルートディレクトリの扱いになります。

ローカルプロキシでマッピングする

これは前述した2つの方法と違い、ローカルでWebサーバーを起動するのではなく、 ローカルプロキシを利用して、或るドメインへのアクセスをローカルのファイルにマッピングする方法です。

…と言ってもピンと来ないですね。

例えば、「http://example.com/index.html」というファイルへブラウザでアクセスするとして、 その「index.html」の内容を、ローカルにあるファイルに差し替える事が出来ます。 そうすることで、あたかもインターネット上にそのファイルがあるかのように振る舞ってくれるわけですね。

Charles

ここでは、ローカルプロキシツールのCharlesを使ってみます。 有料ではありますがクロスプラットフォームで開発されていて、Windows/Mac/Linux版が用意されています。

Charles Web Debugging Proxy • HTTP Monitor / HTTP Proxy / HTTPS & SSL Proxy / Reverse Proxy

使い方

1. 「Tools」>「Map To Local」で設定ダイアログを開きます
2. 「Add」で新しくマッピングを作成します
3. 
   

   下記のような要領で入力して「OK」

   
   

   

   
   
4. 
   

   設定したURLにアクセスします

   
   

   http://local.test/index.html

   
   

ドメインは、名前解決が出来る必要があります。 プロジェクトに使用する予定のドメインを使うか、適当な「local.test」などの名前をあてがってhostsファイルに127.0.0.1などで書き込んでおくか、 あるいはexample.comやlocalhostを利用するなどしましょう。

まとめ

これらの方法は、DirectoryIndexが指定できなかったりパフォーマンスが悪かったりする為、あくまでも簡易的なチェック向けです。 が、それで十分な場合は多いに制作の手助けになってくれる事でしょう。

特にローカルプロキシは、こういったケースに因らず、様々なシーンで開発効率をあげてくれるので、 （むしろそちらの方がメインですね） ぜひとも導入しておくべきだと思います。

認証はOpauthで

• Opauth – Multi-provider authentication framework for PHP

Opauthは、様々なOAuth認証を一手に引き受けてくれる認証フレームワークです。

執筆時に公式に紹介されていた利用可能なサービスは、Twitter・Facebookなどを含め11件。 これらのサービスへの認証機能は「ストラテジー」という形で外部モジュールとして提供されます。 所謂ストラテジーパターンと呼ばれる物ですね。

その使い方は、認証のみにフォーカスしているライブラリなだけあって恐ろしくシンプルで簡単。 早速試してみます。

インストール

公式のダウンロードページからダウンロードするか、 Githubにリポジトリが公開されているのでそこからcloneします。

• ダウンロードページ
• GitHubリポジトリ

公式の「Opauth bundled with examples」からなら、Twitter、Google、Facebookのストラテジーも同梱されているので 最初に試す際にはこれがおすすめです。 （それ以外ではストラテジーが空っぽの状態なので、別途ダウンロードしてくる必要があります）

設定

ダウンロードして解凍・設置したら、設定ファイルを用意します。 opauth.config.php などとしておきましょう。

$opauth_config = array(
    /**
     * アプリケーションへのパス
     */
    "path" => "/the/path/to/",

    /**
     * Twitterで認証した後に戻るコールバックURL。
     * {path} は前述のpathを展開してくれる。
     */
    "callback_url" => "{path}callback.php",

    /**
     * ハッシュの生成に使われる文字列。任意の文字列を入れておく。
     */
    "security_salt" => md5("foobar"),

    /**
     * ここからがストラテジーの設定
     */
    "Strategy" => array(
        /**
          * Twitterストラテジーの設定
          * key, secret はTwitterの公式から取得。
          */
        "Twitter" => array(
            "key" => "[consumer_key]",
            "secret" => "[consumer_secret]"
        )
    )
);

consumer_key と consumer_secret は、 事前にTwitterでアプリケーションを登録して、自前の物を取得しておきましょう。

• Create an application | Twitter Developers

試してみる

Twitterの認証画面へリダイレクト

まず、Twitterの認証画面へリダイレクトするスクリプトを書きます。 ユーザはログイン時はこのページにアクセスする事になります。

<?php

require "/the/path/to/Opauth.php";
require "/the/path/to/opauth.config.php";

new Opauth($opauth_config);

ライブラリと設定を読み込んでインスタンスを初期化するだけです。
認証画面のURLの取得やらリクエストトークンの取得やらリダイレクト処理やら、
面倒な部分は全て代行してくれます。素晴らしい。

アクセストークンを取得

今度は、Twitterの認証画面から返ってきたユーザのアクセストークンを取得します。

デフォルトの設定では、認証情報は全て$_SESSIONに入るので
事前に*session_start()* しておきましょう。

<?php

session_start();

require "/the/path/to/Opauth.php";
require "/the/path/to/opauth.config.php";


/**
 * コールバック時には第二引数にfalseを入れて初期化する。
 */
$opauth = new Opauth($opauth_config, false);

/**
 * 認証情報を取得します。
 */
if(isset($_SESSION["opauth"]) && isset($_SESSION["credentials"])){

    $uid = $_SESSION["opauth"]["auth"]["id_str"]; // Twitterの数字のID
    $access_token = $_SESSION["credentials"]["token"]; // アクセストークン
    $access_token_secret = $_SESSION["credentials"]["secret"]; // 秘密のアクセストークン

}

コールバック時も、インスタンスを初期化してセッションから情報を取得するだけです。

ここで取得したアクセストークンを使ってTwitterAPIにアクセスするわけですが、
Opauthは認証を代行するライブラリなので、その為の機能は備えていません。
ここから先は、他のライブラリに代行してもらうことにします。

APIの利用はtmhOAuthで

• 
  themattharris/tmhOAuth
  

tmhOAuthは、PEARのServices_TwitterのようにTwitterAPIへのアクセスを代行してくれるライブラリです。
勿論認証機能も備えていますが、あまりにもOpauthが楽すぎたので作業分担をしてもらいます。

その特徴としては、（ほぼ）単ファイルで構成されていること。
tmhOAuth.phpをとってきて読み込むだけでその機能を利用する事ができるので、導入が容易いですね。
（正確には、tmhUtilities.php というユーティリティ用のファイルが同梱されていますが、
依存しているわけではありません）

試してみる

基本的には、前項で取得した4つのトークンを引数にして初期化して、
あとはTwitterAPIへのリクエストを行うだけです。

<?php

require "/the/path/to/tmhOAuth.php";

/**
 * tmhOAuthを初期化。
 * コンストラクタの引数はトークンをまとめた連想配列。
 */
$twitter = new tmhOAuth(
    array(
        "consumer_key" => "[consumer_key_for_your_application]",
        "consumer_secret" => "[consumer_secret_for_your_application]",
        "user_token" => "[access_token_of_the_user]",
        "user_secret" => "[access_token_secret_of_the_user]"
    )
);

/**
 * requestメソッドでTwitterAPIにリクエストを送る。
 * ここではユーザーのホームタイムラインを取得してみる。
 */
$status = $twitter->request(
    "GET", // リクエストメソッド
    $twitter->url("1/statuses/home_timeline"), // エンドポイントを指定
    array( "count" => 8 ) // パラメータ
);

/**
 * requestの返り値はHTTPのステータスコード
 */
if($status == 200){
    /**
     * データはメンバのresponseの中に、
     * さらに生のデータはその中の"response"の中にJSONで格納されている。
     */
    $response = $twitter->response;
    $data = json_decode($response["response"]);
    var_dump($data); // あとは煮たり焼いたりする
}

無事タイムラインを取得出来ましたでしょうか。
requestの返り値に注意しましょう。

こちらのライブラリもまた、かなりシンプルな使い勝手になっていますね。

まとめ

PEARのServices_Twitterには、個人的にいくつかの不安がありました。

• 
  ながらくβ版のままで、あまりメンテナンスされていない
  
• 
  ローカルコピーでプロジェクトに同梱しづらい
  

そこで他の選択肢を探していましたところ、
これらの2つのライブラリが候補として挙がって来ました。

お手軽さも上々なので、今後是非試していきたいリソースです。

はじめてのKohana

本連載は、私がKohanaに興味をもって導入し、色々試してみた記録をまとめたものなので、 あまり体系的に紹介できていない部分があるかもしれませんが、ご了承ください。 また、導入時に書いた物なので、そこまで突っ込んだ内容はありません。

続きを読む

インデックス

1. Hello World !

1. はじめに
2. Kohanaについて
3. インストール
4. 初期設定

2. コントローラとビューの基本

1. ルーティングとコントローラ
2. ビューを使って出力する

3. コントローラ

1. コントローラファイル
2. パラメータを受け取る
3. before / after

4. ルーティング

1. ルーティングを設定してURLをデザインする
2. パラメータを増やす
3. パラメータを省略する
4. 様々な形式のフィードを出力する

5. ビュー

1. ビューファイル
2. ビューに値を渡す（set）
3. 値を参照渡しする（bind）
4. 共用の値を設定する
5. ビューの中のビュー

6. モデルとデータベース

1. モデルファイル
2. データベースの初期設定
3. データベースインスタンスとクエリの実行
4. 結果を受け取る
5. クエリビルダー
6. プリペアドステートメント
7. DBクラスでのデータベース指定

7. バリデーション

1. 値のチェックができるValidクラス
2. Validationクラス
3. エラーメッセージのカスタマイズ
4. 独自のルールでチェックする