Project

General

Profile

Backport(バックポート) #3169

OpenPNE.yml の ssl_base_url に api.php 向けの設定が存在しない

Added by Yuma Sakata about 7 years ago. Updated about 7 years ago.

Status:
Fixed(完了)
Priority:
Normal(通常)
Target version:
Start date:
2012-08-22
Due date:
% Done:

100%


Description

Overview (現象)

OpenPNE をサブディレクトリに設置している環境でブラウザから SSL でアクセスすると、 openpne.apiBase が下記のようにサブディレクトリを考慮しない値になってしまう。

<script type="text/javascript">
//<![CDATA[

var openpne = {"apiKey":"98432...624ba","apiBase":"\/api.php\/"};

//]]>
</script>

例えば https://example.com/sns/ に OpenPNE を設置しているならば openpne.apiBase の値は \/sns\/api.php\/ となるのが正しい。

Causes (原因)

OpenPNE.yml の ssl_base_url は現在 pc_frontend, mobile_frontend, pc_backend 向けの設定項目があるが、api に対する項目は存在していない。アプリケーションを跨いだ URL を生成する際に opApplicationConfiguration::getAppRouting() の下記の箇所で $sslBaseUrls['api'] の値を取得しようとすると NULL が返ってしまうため、その先の処理で意図しない挙動を起こしてしまう。

    $options = $context->getRouting()->getOptions();
    if ($options['context']['is_secure'])
    {
      $sslBaseUrls = sfConfig::get('op_ssl_base_url');
      $url = $sslBaseUrls[$application];
      $isDefault = 'https://example.com' === $url;
    }
    else
    {
      $url = sfConfig::get('op_base_url');
      $isDefault = 'http://example.com' === $url;
    }

Way to fix (修正内容)

下記のように ssl_base_url に api アプリケーション向けの設定項目を OpenPNE.yml.sample に追加する。

# SSL用URL (Cookie の値を引き継ぐため、 base_url と同一ドメイン・パスである必要があります)
# Base URL for SSL (Set same domain and same path with "base_url" configuration to take over a value of Cookie)
ssl_base_url:
  pc_frontend: "https://example.com" 
  mobile_frontend: "https://example.com" 
  pc_backend: "https://example.com" 
  api: "https://example.com" 

Related issues

Related to OpenPNE 3 - Bug(バグ) #3168: OpenPNE.yml の ssl_base_url に api.php 向けの設定が存在しない Won't fix(対応せず) 2012-08-22
Related to OpenPNE 3 - Bug(バグ) #3199: OpenPNE.yml.sample に記述されているデフォルトの設定が OpenPNE.yml に記述されているものと正しくマージできていない Won't fix(対応せず) 2012-09-11

Associated revisions

Revision 4fbf02ce (diff)
Added by Youichi Kimura about 7 years ago

add ssl_base_url for `api' application in OpenPNE.yml.sample (fixes #3169, BP from #3168)

(cherry picked from commit 32f97ddada57aa848d7570abf1ccc71d93777469)

History

#1 Updated by Yuma Sakata about 7 years ago

  • Target version changed from OpenPNE 3.8.x to OpenPNE 3.8.2

#2 Updated by Youichi Kimura about 7 years ago

  • Description updated (diff)

#3 Updated by Youichi Kimura about 7 years ago

  • Status changed from New(新規) to Pending Review(レビュー待ち)
  • % Done changed from 0 to 50

更新履歴 4fbf02ce5f4c020faa75a5ba3dda381ab33c2df4 で適用されました。

#4 Updated by Yuma Sakata about 7 years ago

  • Status changed from Pending Review(レビュー待ち) to Rejected(差し戻し)

テスト実施しましたが、修正が必要な点がありましたので確認お願いします。

サブディレクトリを用いたSSL環境で apiBase の値の確認

  • 試験手順
    0. SSL環境でサブディレクトリを用いたSNSを準備しておく
    (例:http://example.com/sns)
    1. SNSトップページで、ページのソースを表示する
    2. 手順1 のソースより apiBase の値を確認する
  • 試験結果
    apiBase の値にサブディレクトリ名が含まれない
  • 修正方針
    apiBase の値にサブディレクトリ名が含まれるように修正お願いします。

#5 Updated by Youichi Kimura about 7 years ago

note-4 の問題については api: "https://example.com" を OpenPNE.yml (OpenPNE.yml.sample ではなく)にも追加すれば一応問題は発生しません。
ただし、OpenPNE.yml.sample がデフォルト値として働くのが本来の挙動なので #3199 としてチケットを作成しました。このチケットの修正は PHP 5.3 以前のバージョン向けに対応するのに時間が掛かりそうなので、ひとまず問題の起こるSNSでは OpenPNE.yml に手動で設定を追加するという方針で良いと思います。

#6 Updated by Youichi Kimura about 7 years ago

#3199 の修正が出来たため、テスト等が無事に完了すればこの問題は発生しなくなります。

#7 Updated by Yuma Sakata about 7 years ago

  • Status changed from Rejected(差し戻し) to Pending Fixing(修正待ち)
  • % Done changed from 50 to 0

#8 Updated by Yuma Sakata about 7 years ago

  • Status changed from Pending Fixing(修正待ち) to Accepted(着手)

#9 Updated by Yuma Sakata about 7 years ago

  • Status changed from Accepted(着手) to Pending Review(レビュー待ち)
  • % Done changed from 0 to 50

#10 Updated by Youichi Kimura about 7 years ago

note-4 の差し戻しについては、OpenPNE.yml に ssl_base_url の api を手動で追加することで対応とすることとしました。

#11 Updated by Rimpei Ogawa about 7 years ago

  • Status changed from Pending Review(レビュー待ち) to Pending Testing(テスト待ち)
  • % Done changed from 50 to 70

#12 Updated by Yuma Sakata about 7 years ago

  • Status changed from Pending Testing(テスト待ち) to Fixed(完了)
  • % Done changed from 70 to 100

テストOKです。

Also available in: Atom PDF