OpenPNE 3

• 実装予定

diff --git a/apps/api/modules/activity/actions/actions.class.php b/apps/api/modules/activity/actions/actions.class.php
index 9cf307f..891f9d8 100644
--- a/apps/api/modules/activity/actions/actions.class.php
+++ b/apps/api/modules/activity/actions/actions.class.php
@@ -188,6 +188,30 @@ class activityActions extends opJsonApiActions

     $options['source'] = 'API';

+    $imageFile = $request->getFiles('images');
+    if (!empty($imageFile))
+    {
+      $validator = new opValidatorImageFile(array('required' => false));
+      try
+      {
+        $obj = $validator->clean($imageFile);
+      }
+      catch (sfValidatorError $e)
+      {
+        $this->forward400('This image file is invalid.');
+      }
+      $file = new File();
+      $file->setFromValidatedFile($obj);
+      $file->setName('ac_'.$this->getUser()->getMemberId().'_'.$file->getName());
+      $file->save();
+      $options['images'][] = array('file_id' => $file->getId());
+    }
+
     $this->activity = Doctrine::getTable('ActivityData')->updateActivity($memberId, $body, $options);

     $this->setTemplate('object');

簡単なお試し例

<form action="http://{$sns_url}/api.php/activity/post.json" method="post">
<input type="hidden" name="apiKey" value="XXXXXXXXXXXXXXXXXX" />
<input type="text" name="body" value="hoge" />
<input type="file" name="images" />
<input type="submit" name="submit" value="投稿" />
</form>

• APIレスポンス部分

diff --git a/apps/api/lib/helper/opJsonApiHelper.php b/apps/api/lib/helper/opJsonApiHelper.php
index 502ff90..9adc42c 100644
--- a/apps/api/lib/helper/opJsonApiHelper.php
+++ b/apps/api/lib/helper/opJsonApiHelper.php
@@ -58,8 +58,14 @@ function op_api_member_profile_url($memberId)

 function op_api_activity($activity)
 {
   $viewMemberId = sfContext::getInstance()->getUser()->getMemberId();
   $member = $activity->getMember();
+  $images = null;
+  if ($activity->getImages()->count())
+  {
+    $images = $activity->getImages();
+  }

   return array(
     'id' => $activity->getId(),
@@ -69,7 +75,9 @@ function op_api_activity($activity)
     'uri' => $activity->getUri(),
     'source' => $activity->getSource(),
     'source_uri' => $activity->getSourceUri(),
+    'images' => !is_null($images) ? sf_image_path($images[0]->getFile(), array('size' => '48x48'), true) : null, 
+    'images_large' => !is_null($images) ? sf_image_path($images[0]->getFile(), array(), true) : null,
     'created_at' => date('r', strtotime($activity->getCreatedAt())),
   );
 }

• 追記: 余計な修正が入っていたので除去 (2012/06/11 19:54)

• 画像の投稿枚数に上限がないですが、制限は不要でしょうか。OpenPNE に存在する画像投稿機能の場合、一度に画像を投稿できる枚数は 3枚 か 5枚 であることが多いと思います。
• APIでの アクティビティのデータ取得の画像表示についての仕様が見当たりません。 http://houou.github.io/api.php/activity_mentions.html http://houou.github.io/api.php/activity_mentions.html 投稿時の説明と同じく、ドキュメントの修正をしたほうがいいと思います。
• API の応答は 固定で1枚だけ画像のURLを出力するような実装ですが、複数枚投稿できるのであれば、複数枚出力した方が良くないでしょうか。
  • 1枚だけ出力するような仕様に意図的にするのであれば、例えば一番新しい画像のURLを出力する といった対応にしたほうがよいのではないかと思います。
• ActivityData::getImages()->count() で分岐した後、もう一度 ActivityData::getImages() をしていますが、処理に無駄があります。修正案ですが、以下のように処理をすれば、不要な分岐は減ります。

diff --git a/apps/api/lib/helper/opJsonApiHelper.php b/apps/api/lib/helper/opJsonApiHelper.php
index c460778..6228a91 100644
--- a/apps/api/lib/helper/opJsonApiHelper.php
+++ b/apps/api/lib/helper/opJsonApiHelper.php
@@ -60,11 +60,7 @@ function op_api_activity($activity)
 {
   $viewMemberId = sfContext::getInstance()->getUser()->getMemberId();
   $member = $activity->getMember();
-  $images = null;
-  if ($activity->getImages()->count())
-  {
-    $images = $activity->getImages();
-  }
+  $images = $activity->getImages();

   return array(
     'id' => $activity->getId(),
@@ -74,8 +70,8 @@ function op_api_activity($activity)
     'uri' => $activity->getUri(),
     'source' => $activity->getSource(),
     'source_uri' => $activity->getSourceUri(),
-    'image_url' => !is_null($images) ? sf_image_path($images[0]->getFile(), array('size' => '48x48'), true) : null, 
-    'image_large_url' => !is_null($images) ? sf_image_path($images[0]->getFile(), array(), true) : null,
+    'image_url' => count($images) ? sf_image_path($images[0]->getFile(), array('size' => '48x48'), true) : null, 
+    'image_large_url' => count($images) ? sf_image_path($images[0]->getFile(), array(), true) : null,
     'created_at' => date('r', strtotime($activity->getCreatedAt())),
   );
 }

• アクション の209行目以下の処理はファイルのフィールドが空で送信された場合の continue だと思いますが、何の処理であるか、直感で分かりにくいように思います。コメントで説明があったほうがよいかと思います。また、データがないのであれば、バリデーションする必要もないので、先に continue した方がいいのではないでしょうか。

        if (is_null($obj))
        {   
          continue;
        }  

• git show 91745b9e --check で確認してみてください。不要な空白文字が多いです。
• $options['images'][] = array('file_id' => $file->getId()); が可読性がよくないので、 $options['images'][]['file_id'] = $file->getId(); としたほうがよいかもしれません。
• テストコードを書いた方がよいと思います。

取り扱う内容が多いため、いくつかチケットを分割しました。

ドキュメント修正 (#3394)¶

まず、投稿する側の画面は本チケットでは作成されていないということから、APIで投稿する受け側だけ存在すると言うことになります。そのことから、この機能を使うためのドキュメントがないと使い方が分からないという状況になります。 http://houou.github.io/api.php/activity_post.html には画像投稿についての説明がないので、使い方は分からないでしょう。

新たにチケットを作成しました。ドキュメントの修正については #3394 にて扱います。

APIでの アクティビティのデータ取得の画像表示についての仕様が見当たりません。 http://houou.github.io/api.php/activity_mentions.html http://houou.github.io/api.php/activity_mentions.html 投稿時の説明と同じく、ドキュメントの修正をしたほうがいいと思います。

画像投稿のドキュメントと同じく #3394 にて扱います。

アクティビティ画像の複数枚対応 (#3203)¶

続いて #note-2 のサンプルの input[type=file] の要素の name 属性に images という複数形の名称を設定されていながら、1つしか画像投稿はできない例となっていますが、 apps/api/modules/activity/actions/actions.class.php の 198行目では複数の画像を処理するような実装となっていますので、ただしく処理されず、サンプルでは画像投稿ができません。

当初の実装である 91745b9e8bb9c56460b04d561e5be926920ad083 は画像一枚のみを受け付ける実装となっていました (しかしパラメータ名は images です)。パラメーター名に合わせて複数枚対応を行ったのは、当チケットの後に作られた #3203 です。そのため、アクティビティ画像の複数枚対応については (後述のレスポンス形式の修正と合わせて) #3203 で扱います。

API の応答は 固定で1枚だけ画像のURLを出力するような実装ですが、複数枚投稿できるのであれば、複数枚出力した方が良くないでしょうか。
1枚だけ出力するような仕様に意図的にするのであれば、例えば一番新しい画像のURLを出力する といった対応にしたほうがよいのではないかと思います。

これについても #3203 にて扱います。

アクティビティ画像の枚数制限 (#3393)¶

画像の投稿枚数に上限がないですが、制限は不要でしょうか。OpenPNE に存在する画像投稿機能の場合、一度に画像を投稿できる枚数は 3枚 か 5枚 であることが多いと思います。

画像枚数の制限については JSON API に限らない問題であるため、上記の複数枚対応とは別に #3393 にて扱います。

そして、当チケットでは 91745b9e8bb9c56460b04d561e5be926920ad083 に対する可読性や冗長な記述の指摘とテストコードの追加について (note-7 の最後の5つ) を取り扱うものとします。

補足: bbf9839510c25ad9da71c5a1a464f46745d2a370 のテストケースは #3396 の修正に依存しています

動作確認は下記コマンドで行いました。

curl -v -F 'apiKey=<APIキー>' -F 'body=hogehoge' -F 'images[0]=@<ファイルパス>' http://sns.example.com/api.php/activity/post.json

note-18 の問題について、activity/post.json のアクションが #3202 のバグを踏んでいたことが分かりました。現時点で #3202 の修正は master ブランチのみに入っています。