"sites" フレームワーク

コンテンツを複数のサイトに関連づける

LJWorld.com と Lawrence.com は同じニュース組織，Kansaz 州 Lawrence にある Lawrence Journal-World newspaper が管理しています． LJWorld.com はニュース に， Lawrence.com は地域の娯楽情報にフォーカスしていますが，編集者は 両方の サイトで同じニュースを公開したいと考える場合もあります．

この問題を何も考えずに処理するなら，サイト構築担当者に対して， LJWorld.com と Lawrence.com に同じ記事を出すよう 2 度依頼することになります．しかしこれ はサイト構築担当にとって非効率的ですし，同じ記事のコピーが複数データベース に入ることになってしまいます．

もっとましで簡単な方法ががあります: どちらのサイトも同じデータベースを使い， 1 つの記事を複数のサイトに関連づけるというものです．この関係は， Django モ デルの用語で言えば Article モデルの ManyToManyField で表現されます:

from django.db import models
from django.contrib.sites.models import Site

class Article(models.Model):
    headline = models.CharField(max_length=200)
    # ...
    sites = models.ManyToManyField(Site)

このモデルは，以下のようにいくつかの点で優れています:

• site 構築担当が 1 つのインタフェース (Django admin サイト) で両方のサ イトにある全てのコンテンツを編集できます．

• 同じ記事をデータベース上に何度も書き込まなくて済み，一つのレコードと して保存できます．

• サイト開発者は同じビューコードを両方のサイトで使えます．ビューコード では，リクエストされている記事が現在のサイト用のものかチェックします． 例えば以下のようなコードになるでしょう:

  from django.conf import settings
  
  def article_detail(request, article_id):
      try:
          a = Article.objects.get(id=article_id, sites__id__exact=settings.SITE_ID)
      except Article.DoesNotExist:
          raise Http404
      # ...
  

コンテンツを単一のサイトに関連づける

あるモデルを ForeignKey を使って他対一の関係で Site に関連づけても 構いません．

例えば，ある記事をあるサイトだけで表示できるようにしたければ，モデルは以下 のように書きます:

from django.db import models
from django.contrib.sites.models import Site

class Article(models.Model):
    headline = models.CharField(max_length=200)
    # ...
    site = models.ForeignKey(Site)

この方法でも，前節で述べたのと同じような恩恵を得られます．

ビュー内で現在のサイトをフックに使う

低水準では， Django ビューの中で sites フレームワークを使って，ビューを呼び 出しているサイトごとに固有の処理を実行できます．

例えば:

from django.conf import settings

def my_view(request):
    if settings.SITE_ID == 3:
        # Do something.
    else:
        # Do something else.

もちろん，上のようにサイト ID をハードコードするのは見栄えよくありません． この種のハードコード化は，すぐに実行しなければならないハックのときにはベス トでしょう．同じことをよりクリーンに実現するには，サイトのドメイン名をチェッ クします:

from django.conf import settings
from django.contrib.sites.models import Site

def my_view(request):
    current_site = Site.objects.get(id=settings.SITE_ID)
    if current_site.domain == 'foo.com':
        # Do something
    else:
        # Do something else.

settings.SITE_ID の値から Site オブジェクトを取得するというイディオ ムはよく使われるので， Site のモデルマネジャには get_current() メソッ ドがあります．以下の例は上の例と同じになります:

from django.contrib.sites.models import Site

def my_view(request):
    current_site = Site.objects.get_current()
    if current_site.domain == 'foo.com':
        # Do something
    else:
        # Do something else.

現在のドメインをディスプレイ用に取得する

LJWorld.com と Lawrence.com には e-mail による通知機能があり，読者が登録し ておくとニュースが届いたときに通知メールを受け取れるようになっています．こ のからくりは簡単で， Web フォームから登録すると，「ご登録ありがとうございま した」という内容のメールを受け取ります．

登録処理を行うコードを二度開発するのは非効率的で冗長なので，舞台裏では複数 サイトで同じコードを使うようにします．ただし，「ご登録ありがとうございます」 通知はサイトごとに変えなければなりません． Site オブジェクトを使えば， 現在のサイトの name と domain の値を使って「ありがとうございます」 メッセージを抽象化できます．

フォーム処理ビューの例は以下のようになります:

from django.contrib.sites.models import Site
from django.core.mail import send_mail

def register_for_newsletter(request):
    # Check form values, etc., and subscribe the user.
    # ...

    current_site = Site.objects.get_current()
    send_mail('Thanks for subscribing to %s alerts' % current_site.name,
        'Thanks for your subscription. We appreciate it.\n\n-The %s team.' % current_site.name,
        'editor@%s' % current_site.domain,
        [user.email])

    # ...

Lawrence.com では， e-mail の件名は "Thanks for subscribing to lawrence.com alerts." です． LJWorld.com では，件名は "Thanks for subscribing to LJWorld.com alerts." で，メール本体も同様です．

より柔軟 (で，重量な) 方法として， Django テンプレートシステムを使った方法 と比較してみましょう． Lawrence.com と LJWorld.com は別々のテンプレートディ レクトリ (TEMPLATE_DIRS) を持っているので，以下のようにすればサイト間の 違いをテンプレートシステムに追い出せます:

from django.core.mail import send_mail
from django.template import loader, Context

def register_for_newsletter(request):
    # Check form values, etc., and subscribe the user.
    # ...

    subject = loader.get_template('alerts/subject.txt').render(Context({}))
    message = loader.get_template('alerts/message.txt').render(Context({}))
    send_mail(subject, message, 'editor@ljworld.com', [user.email])

    # ...

この場合， LJWorld.com と Lawrence.com のテンプレートディレクトリ下に subject.txt と message.txt の二つのテンプレートを作成することになり ます．ただし，こうすればより柔軟にはなりますが，複雑さは増します．

不要な複雑さと冗長性を排除するためには， Site オブジェクトを可能な限り 使うとよいでしょう．

現在のドメインの完全な URL を取得する

Django の get_absolute_url() は，オブジェクトの URL をドメイン名なしで 取得する際には便利ですが，場合によっては，完全な URL，すなわち http:// とドメイン名，その他全てを表示したいこともあるでしょう．これには sites フレー ムワークを使います．簡単な例を示します:

>>> from django.contrib.sites.models import Site
>>> obj = MyModel.objects.get(id=3)
>>> obj.get_absolute_url()
'/mymodel/objects/3/'
>>> Site.objects.get_current().domain
'example.com'
>>> 'http://%s%s' % (Site.objects.get_current().domain, obj.get_absolute_url())
'http://example.com/mymodel/objects/3/'