Backport(バックポート) #3169
完了OpenPNE.yml の ssl_base_url に api.php 向けの設定が存在しない
100%
説明
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"
Youichi Kimura さんが12年以上前に更新
- ステータス を New(新規) から Pending Review(レビュー待ち) に変更
- 進捗率 を 0 から 50 に変更
更新履歴 4fbf02ce5f4c020faa75a5ba3dda381ab33c2df4 で適用されました。
Yuma Sakata さんが12年以上前に更新
- ステータス を Pending Review(レビュー待ち) から Rejected(差し戻し) に変更
テスト実施しましたが、修正が必要な点がありましたので確認お願いします。
サブディレクトリを用いたSSL環境で apiBase の値の確認¶
- 試験手順
0. SSL環境でサブディレクトリを用いたSNSを準備しておく
(例:http://example.com/sns)
1. SNSトップページで、ページのソースを表示する
2. 手順1 のソースより apiBase の値を確認する
- 試験結果
apiBase の値にサブディレクトリ名が含まれない
- 修正方針
apiBase の値にサブディレクトリ名が含まれるように修正お願いします。
Youichi Kimura さんが12年以上前に更新
note-4 の問題については api: "https://example.com"
を OpenPNE.yml (OpenPNE.yml.sample ではなく)にも追加すれば一応問題は発生しません。
ただし、OpenPNE.yml.sample がデフォルト値として働くのが本来の挙動なので #3199 としてチケットを作成しました。このチケットの修正は PHP 5.3 以前のバージョン向けに対応するのに時間が掛かりそうなので、ひとまず問題の起こるSNSでは OpenPNE.yml に手動で設定を追加するという方針で良いと思います。
Yuma Sakata さんが12年以上前に更新
- ステータス を Rejected(差し戻し) から Pending Fixing(修正待ち) に変更
- 進捗率 を 50 から 0 に変更
Yuma Sakata さんが12年以上前に更新
- ステータス を Accepted(着手) から Pending Review(レビュー待ち) に変更
- 進捗率 を 0 から 50 に変更
Youichi Kimura さんが12年以上前に更新
note-4 の差し戻しについては、OpenPNE.yml に ssl_base_url の api を手動で追加することで対応とすることとしました。
Rimpei Ogawa さんが12年以上前に更新
- ステータス を Pending Review(レビュー待ち) から Pending Testing(テスト待ち) に変更
- 進捗率 を 50 から 70 に変更
Yuma Sakata さんが12年以上前に更新
- ステータス を Pending Testing(テスト待ち) から Fixed(完了) に変更
- 進捗率 を 70 から 100 に変更
テストOKです。