sitemaps フレームワーク

概要

サイトマップ (sitemap) とは，自分のサイト上のページの更新頻度や特定のペー ジ間の「重要度」を検索エンジンのインデクサに対して知らせるために，Web サイ ト上に配置する XML ファイルです．この情報があると，検索エンジンがサイトのイ ンデクスを生成するときに役立ちます．

Django のサイトマップフレームワークを使うと，この XML ファイルの情報を Python コードで表現でき，ファイルの生成を自動化できます．

sitemaps は Django の 配信フレームワーク によく似ています．サイトマップ の生成は簡単で，ただ Sitemap クラスを書いて， URLconf に指定するだけで す．

インストール

sitemaps アプリケーションは以下の手順でインストールします:

1. INSTALLED_APPS 設定に 'django.contrib.sitemaps' を加えます．
2. TEMPLATE_LOADERS 設定に， 'django.template.loaders.app_directories.load_template_source' が入っているか確かめます．デフォルトの設定ファイルには入っているので， 注意が必要なのは設定を変更している時だけです．
3. sites フレームワーク をインストールしておいてください．

(注意: sitemaps アプリケーションは，データベースに何らテーブルをインストール しません． INSTALLED_APPS に sitemaps を入れておかねばならないのは， load_template_source テンプレートローダがデフォルトのテンプレートを捜し 出せるようにするためです．)

初期化

自分の Django サイト上でサイトマップ生成を行わせるには， URLconf に以下の 行を追加します:

(r'^sitemap.xml$', 'django.contrib.sitemaps.views.sitemap',
     {'sitemaps': sitemaps})

これで， Django はクライアントが /sitemap.xml にアクセスしたときにサイ トマップを生成するようになります．

サイトマップファイルの名前はさして重要ではありませんが，ファイルの場所は重 要です．検索エンジンは，サイトマップ内のリンクをインデクス化する際，ファイ ルの置かれている URL レベルとその下のリンクしかたどりません．例えば， sitemap.xml がルートディレクトリ下にあれば， Google はサイト上の全ての URL を参照します．一方，サイトマップの場所が /content/sitemap.xml であ れば， /content/ で始まる URL しか参照しません．

ビュー関数 sitemap() には，必須の引数 {'sitemaps': sitemaps} があり ます． sitemaps はセクションラベル (例えば blog や news) を， Sitemap クラス (例えば BlogSitemap や NewsSitemap) に対応づける 辞書にします．あるいは， Sitemap クラスの インスタンス (例えば BlogSitemap(some_bar)) でもかまいません．

Sitemap クラス

Sitemap クラスとは，サイトマップ上のエントリの「セクション」を表現する ための Python のクラスです．例えば，ある Sitemap クラスはブログ上の全て のエントリを表し，別のクラスはイベントカレンダー上の全てのイベントを表現す る，といった具合です．

最も単純化すれば，全てのセクションは sitemap.xml という一つのファイルに まとめあげられることになります．とはいえ， sitemaps フレームワークを使えば， 各セクションごとに個別のサイトマップファイルがあるようなサイトマップインデ クスを生成できます (後述の サイトマップインデクスを生成する を参照してく ださい)．

Sitemap クラスは django.contrib.sitemaps.Sitemap のサブクラスでなけ ればなりません．クラスはコードベースのどこに置いてもかまいません．

簡単な例

ブログシステムを使っていて， Entry というモデルがあるとしましょう． サイトマップに全てのブログエントリへのリンクを含めたければ，サイトマップク ラスは以下のようになります:

from django.contrib.sitemaps import Sitemap
from mysite.blog.models import Entry

class BlogSitemap(Sitemap):
    changefreq = "never"
    priority = 0.5

    def items(self):
        return Entry.objects.filter(is_draft=False)

    def lastmod(self, obj):
        return obj.pub_date

注意点:

• changefreq と priority はクラス属性で，それぞれ <changefreq> および <priority> エレメントに対応しています．こ れらの属性は，上の例の lastmod のように，メソッドとしても定義でき ます．
• items() はオブジェクトのリストを返すだけのメソッドです．このメソッ ドの返すオブジェクトは，サイトマップの各プロパティ (location, lastmod, changefreq, priority) に対応するメソッドに渡され ます．
• lastmod は Python の datetime オブジェクトを返さねばなりませ ん．
• この例には location メソッドがありませんが，自分でメソッドを定義 して，オブジェクトの URL を指定してもかまいません．デフォルトでは， location() は各オブジェクトに対して get_absolute_url() を呼び 出し，その結果を返します．

Sitemap クラスリファレンス

Sitemap クラスのサブクラスでは，以下のメソッドや属性を定義できます:

ショートカット

sitemaps フレームワークでは，よく使われる状況向けに，二つの便宜クラスを用意 しています:

from django.conf.urls.defaults import *
from django.contrib.sitemaps import FlatPageSitemap, GenericSitemap
from mysite.blog.models import Entry

info_dict = {
    'queryset': Entry.objects.all(),
    'date_field': 'pub_date',
}

sitemaps = {
    'flatpages': FlatPageSitemap,
    'blog': GenericSitemap(info_dict, priority=0.6),
}

urlpatterns = patterns('',
    # info_dict を使った汎用ビューの設定
    # ...

    # サイトマップ
    (r'^sitemap.xml$', 'django.contrib.sitemaps.views.sitemap',
        {'sitemaps': sitemaps})
)

サイトマップインデクスを生成する

sitemap フレームワークには，個々のサイトマップファイルを参照するサイトマッ プインデクスを生成する機能もあります．サイトマップインデクスからサイトマッ プファイルへの参照は， sitemaps 辞書に定義されている各セクションごとに ひとつづつ作成されます．サイトマップインデクスを使うには，少しだけやり方を 変えます:

• URLconf に， django.contrib.sitemaps.views.index と django.contrib.sitemaps.views.sitemap という二つのビューを使いま す．
• django.contrib.sitemaps.views.sitemap にキーワード引数 section を指定します．

上の例にならうと，URLconf は以下のようになります:

(r'^sitemap.xml$', 'django.contrib.sitemaps.views.index',
    {'sitemaps': sitemaps})
(r'^sitemap-(?P<section>.+).xml$',
    'django.contrib.sitemaps.views.sitemap',
    {'sitemaps': sitemaps})

この設定では， sitemap-flatpages.xml と sitemap-blog.xml への参照が 入った sitemap.xml が自動生成されます． Sitemap クラスと sitemaps 辞書に手を加える必要はありません．

Google に ping を打つ

サイトマップの変更時に，Google に「ping を打」って，サイトのインデクスを再 構築させたい場合もあるでしょう． sitemap フレームワークで ping を打つには， django.contrib.sitemaps.ping_google() を呼び出します．

ping_google() にはオプションの引数 sitemap_url があります．この引数 にはサイトのサイトマップの絶対 URL (例えば '/sitemap.xml') を指定します． sitemap_url を指定しなかった場合， ping_google() は URLconf の逆引 きを行って，サイトマップの在処を探します．

サイトマップの URL を捜し出せなかった場合， ping_google() は django.contrib.sitemaps.SitemapNotFound 例外を送出します．

ping_google() の用法として有用なのは，モデルの save() メソッドで呼 び出すというものです:

from django.contrib.sitemaps import ping_google

class Entry(models.Model):
    # ...
    def save(self):
        super(Entry, self).save()
        try:
            ping_google()
        except Exception:
            # HTTP にまつわる例外も送出され得るので，ここは空の
            # 'except' 節にしておきます．
            pass

とはいえ， ping_google() は Google のサーバに HTTP リクエストを送信する ので， save() のたびにネットワークアクセスのオーバヘッドが生じます．もっ と効率的にやりたければ， cron 化されたスクリプトなど，一定の時点で実行する ようスケジュールしたタスクの中で ping_google() を呼び出すとよいでしょう．