モジュールページの情報を確認する

今回のまとめ

ここまで、Simple XML Sitemapをインストールして設定するまでの手順を一通り行ってきました。

途中でお約束した通り、ここではdrupal.orgのモジュールページの見方を説明します。モジュールページの情報を理解することは、モジュールを選定する上でとても大切です。

メンテナンスされていないモジュールを利用するのは、セキュリティ上のリスクがありますし、利用者が少ないモジュールを利用すると、思わぬ不具合に見舞われる可能性もあります。しっかりとメンテナンスされていて、多くの人が利用しているモジュールを選定すると、こういったリスクを下げることに繋がります。モジュールのページは英語ですが、ポイントを押さえれば、簡単に把握することができます。

モジュールページ各セクションの説明

まずは、このモジュールページのどこに何が書かれているのかを、今回使用したSimple XML Sitemapモジュールのページを例にとって確認してみましょう。

1.モジュール名

モジュールの名称です。モジュール名とdrupal.orgのモジュールページのURLは必ずしも一致するとは限りません。 Simple XML SitemapモジュールページのURLは「https://www.drupal.org/project/simple_sitemap」で、「simple_sitemap」というパスを利用しています。

2.説明文

モジュールの説明文です。モジュールの機能説明や、バージョン情報、現時点で発見されている不具合、作動に必要な条件など、そのモジュールに関する全般的な事が記載されています。

3.プロジェクト情報

モジュールのプロジェクト情報です。ここを確認することで、モジュールのメンテナンス状況や、開発状況、インストールサイト数などを確認できます。以下に各項目の意味を一覧表にしました。

4.ダウンロード

モジュールのダウンロードセクションです。ここからモジュールをダウンロードできます。

ここでは以下の図のように「Display Suite」モジュールのダウンロードセクションを例にとって説明します。

各リリース(Release)の違い

ダウンロードセクションは、「Recommended releases」、「Other releases」、「Development releases」の3つのリリースに分かれています。それぞれのリリースの意味は以下の通りです。

この場合、Drupal 8でこのモジュールを利用するのであれば「Recommended releases」である、「8.x-2.5」、Drupal 7であれば、「7.x-2.14」の利用が推奨されます。

バージョン(Version)とリリースタイプについて

拡張モジュールにはバージョン名が付けられています。Drupal 8用のモジュールであれば、「8.x-2.5」、Drupal 7用であれば、「7.x-2.14」のように対応するDrupal本体のバージョンの数値が割り当てられています。

DrupalコミュニティではDrupal 8リリースのタイミングでリリースバージョンにセマンティックバージョニングを採用することを決定しました。

1. APIの変更に互換性のない場合はメジャーバージョンを上げる
2. 後方互換性があり機能性を追加した場合はマイナーバージョンをあげる
3. 後方互換性を伴うバグ修正をした場合はパッチバージョンを上げる

これが基本ルールです。コアのバージョンを例にすると、

• 7.50 から 8.0 へは1.
• 8.0 から 8.1.0 へは2.
• 8.1.1 から 8.1.2 へは3.

にそれぞれ相当します。

なぜセマンティックバージョニングが採用されたかというと、それがオープンな仕様であり、他の多くのオープンソースでも利用されているからです。詳細は セマンティック バージョニング を参照してください。

Development releaseに表示されているバージョンをご覧ください。「8.x-2.x-dev」や「7.x-1.x-dev」のように末尾に「dev」という接尾辞が付いています。これは、「リリースタイプ」と呼ばれ、「dev」であれば「development(開発)バージョン」を意味します。「dev」以外にも「alpha」や「beta」、「rc」などの「リリースタイプ」も存在します。各バージョンの意味は以下の通りです。

ここからも分かる通り、モジュールの開発はalpha、beta、rcを経て安定バージョンとしてリリースされます。これから利用しようとしているモジュールが、現在、開発のどの段階にあるのかを把握することで、

• 「このモジュールはrcだからもう少しで安定版を使えるようになるな」
• 「このモジュールはbetaだから、安定して使えるようになるまでには、まだ時間がかかるな。」
• 「このモジュールはalphaだから、インストールするのはまだ早いな。しばらく様子を見よう。同じ機能を持つ他のモジュールも探してみよう。」

といった、目星をつけることができます。

シールドアイコンの意味

各バージョン名の横に「シールドアイコン」が表示されています。これは、セキュリティアドバイザリーの対象であるという意味です。モジュールやバージョンによっては「シールドアイコン」が表示されていないものもありますが、これらは、セキュリティーアドバイザリーの対象外ですので、脆弱性が存在する可能性が高いと言えます。

5.メンテナンス者情報

モジュールのメンテナンス者の情報です。ここにはメンテナンス者の氏名と、このモジュールに対して、いくつのコミットを行ったかが表示されます。

6.バグや質問、新しい機能リクエスト

ここではDrupalコミュニティのメンバーから報告されたバグや、新しい機能のリクエストについて話し合うフォーラムへのリンクが表示されています。All issuesの項目をみると、「10 open」「81 total」と記載されています。これは、今現在フォーラムで議論されている未解決の問題(open)が10個、すでに解決済みの問題も含めて全部で81個あるという意味です。「10 open」をクリックすると、「Issues for Simple XML sitemap」というフォーラムへ移動します。ここでは「Simple XML sitemap」モジュールに関する、質問、新しい機能リクエスト、バグ報告などさまざまなディスカッションが行われています。モジュールを利用していて不具合などに遭遇した際には、このフォーラムで情報を探してみると解決策に繋がるかもしれません。

7.ライセンス、デモサイト、翻訳プロジェクトなどへのリンク

モジュールによっては、詳細な使い方を説明したDocumentationや、実際に動作を確認できる、デモサイトへのリンクなどが掲載されていることもあります。モジュールを導入する際にはぜひチェックしてみることをお勧めします。

8.開発者向けのAPIやカスタマイズに関する情報

将来的に適応予定であるパッチに関する情報や、コードのレポジトリ、脆弱性に関する情報など開発者向け情報が記載されています。

拡張モジュール選定のための注意点

これまでに、モジュールページの情報の見方を学んできました。これらの情報を元に、Drupal初心者の方々が拡張モジュールを選定する際のポイントをまとめます。

インストール数の多いモジュールを使う

インストール数の多いモジュールは、それだけ多くの人が利用しているのでバグやセキュリティの問題も発見されやすく、それらの修正も迅速かつ、継続的に行われる傾向があります。一方、インストール数の少ないモジュールは途中でメンテナンスが放棄されたり、開発がストップしてDrupal本体のアップデートに対応できないなど、様々な不具合に見舞われるケースもあります。インストール数の多いモジュールであれば、こういったリスクは軽減されるでしょう。

リリースタイプがalpha、beta、dev、rcであるモジュールの使用は控える

リリースタイプに関する説明でも触れましたが、リリースタイプがalpha、beta、devのモジュールは動作が不安定であったり、セキュリティ上の問題点がまだ修正されていないこともあります。また、rcもセキュリティーアドバイザリーの対象外ですので、できれば安定バージョンになってから利用するようにしてください。

シールドアイコンのあるモジュールを使う

シールドアイコンが表示されていない、セキュリティーアドバイザリーの対象外のモジュールの利用は、セキュリティ上お勧めできません。シールドアイコンのあるモジュールの利用をお勧めします。