OpenPNE 3

更新履歴 988cb390db2b8a82ccf4d1e435f955fe7017962a で適用されました。

OpenPNE を使用しており、以下のどちらかまたはすべての条件を満たしている

上記の説明に間違いがある 「以下のどちらかまたは」とあるが、以下の記述の説明がない

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

コードチェックをしました。

ドキュメントとしての適正¶

• master
  • (en) https://github.com/openpne/OpenPNE3/blob/a9edd7656cb73169e172ff5cf513e89bdf69e8d3/doc/en/OpenPNE3_Version_Up_Guide.txt
  • (ja) https://github.com/openpne/OpenPNE3/blob/a9edd7656cb73169e172ff5cf513e89bdf69e8d3/doc/ja/OpenPNE3_Version_Up_Guide.txt

最新版（OpenPNE-3.7相当）のドキュメントであるにもかかわらず、英語版は "How to Update OpenPNE3.3", 日本語版は「OpenPNE 3.4 バージョンアップ手順」と古いバージョンが示されています（内容自体は適用できるものであるため不適切とは言い切れませんが、バージョンが一致していないという点で不要な誤解を生じさせる要因になるかもしれません）。

• バージョンが古いままになっている
• 英語版と日本語版でバージョンが一致していない

上記2点については、ドキュメントとして適正に欠けるものの、本チケットの内容とは直接関係しないためここでは問題としません。

このドキュメントでは "This document is for updating OpenPNE 3.2.0 + to OpenPNE 3.3.x.", 「このドキュメントは、 OpenPNE 3.2.0 + から OpenPNE 3.4.x へのバージョンアップ作業の手順を示したものです。」と示されています。つまり 3.2 より前のバージョンからの手順は載せる必要がない文書であることになっています。

今回の修正に対するレビュー¶

追加された記述を示します。

• Txt doc/en/OpenPNE3_Version_Up_Guide.txt
  

  71: OpenPNE 3.4.9 or OpenPNE 3.2.7.2 or OpenPNE 3.6beta6 or
  72: earlier versions of the original, please perform the following command.
  73: 
  74: Please check the following blog post before performing the command.
  75: http://www.openpne.jp/archives/5689/
  76: 
  77: ::
  78: 
  79:   $ ./symfony openpne:fix-session-db
  80: 
  

• doc/ja/OpenPNE3_Version_Up_Guide.txt
  

  71: 3.2.7.2 以下、 3.4.9 以下、 3.6beta6 以下のOpenPNE からのバージョンアップの場合、
  72: 以下のコマンドを実施する必要があります。
  74: 
  75: コマンドの実施前に以下のブログ記事をお読みください。
  76: 
  77: 【緊急リリース】OpenPNE 3 に存在するセッション管理の不備に関する複数の脆弱性のお知らせ
  78: http://www.openpne.jp/archives/5689/
  79: 
  80: ::
  81: 
  82:  $ ./symfony openpne:fix-session-db
  

• 技術的内容について
  • http://www.openpne.jp/archives/5689/ の内容に対して、英語版・日本語版ともに（バージョンの誤記などは見られないので）修正は妥当だと判断しています。3.0 系の記述がない点についても、このドキュメントの想定するバージョンに関する前提があるため妥当だと判断しています。
• 表記の統一性などについて
  • (p1) 英語版では "OpenPNE 3.4.9 or OpenPNE 3.2.7.2 or OpenPNE 3.6beta6" と記述していますが、日本語版では「3.2.7.2 以下、 3.4.9 以下、 3.6beta6」と記述されています。バージョンの記述順序が異なっていますが、これは気にする程度のものではないのか確認してください。統一した方がよければ修正してください。
  • (p2) 日本語版で「以下のOpenPNE から」と記述されています。 "OpenPNE" の後にのみスペースが記述されてますがこれは不自然かもしれません（軽微な指摘なので修正するかどうかは作業者の裁量にお任せします）。
• コーディング規約の観点から
  • (p3) 英語版・日本語版ともに、上記 71-72 行目に関して、1つの段落（1つの文章）であるにもかかわらず改行が含まれています。RSTの構文的に一文中で改行を含むことは（統一性の観点からも）問題はないでしょうか。

致命的な誤りはないと判断しています。その点ではコードチェックはOKですが、上記(p1),(p2),(p3)について念のため確認してください。

追記¶

74: Please check the following blog post before performing the command.
75: http://www.openpne.jp/archives/5689/

および

77: 【緊急リリース】OpenPNE 3 に存在するセッション管理の不備に関する複数の脆弱性のお知らせ
78: http://www.openpne.jp/archives/5689/

の記述では rst2pdf などで構文エラーが生じるようです。一方で、少なくとも次行がURLではない文章であれば (p1) の記述は問題がないようです。URLの直前に空行を入れるなどすれば大丈夫なようです。より適切な修正方法を検討するためにはRSTの文法などを調べる必要があるかもしれません。

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

note-7, note-8 までの修正を以て、コードチェックはOKです。

テストOKです。