view MoinMoin/events/ @ 2385:53fbdf5899ff

Use the event handling framework to (re)generate xapian indexes.
author Karol 'grzywacz' Nowak <>
date Sat, 14 Jul 2007 18:42:12 +0200
parents 2b31b87db417
children 5d1c31b0c6b5
line wrap: on
line source
# -*- coding: iso-8859-1 -*-
    MoinMoin - email notification plugin from event system

    This code sends email notifications about page changes.
    TODO: refactor it to handle separate events for page changes, creations, etc

    @copyright: 2007 by Karol Nowak <>
    @license: GNU GPL, see COPYING for details.

    from sets import Set as set

from MoinMoin import user
from MoinMoin.Page import Page
from MoinMoin.mail import sendmail
from import PageChangedEvent, UserCreatedEvent, FileAttachedEvent
from MoinMoin.user import User, getUserList
import as notification

def prep_page_changed_mail(request, page, comment, email_lang, revisions, trivial):
    """ Prepare information required for email notification about page change

    @param page: the modified page instance
    @param comment: editor's comment given when saving the page
    @param email_lang: language of email
    @param revisions: revisions of this page (newest first!)
    @param trivial: the change is marked as trivial
    @return: dict with email title and body
    @rtype: dict

    _ = request.getText
    body = notification.page_change_message("page_changed", request, page, email_lang, comment=comment, revisions=revisions)

    subject = _('[%(sitename)s] %(trivial)sUpdate of "%(pagename)s" by %(username)s', formatted=False) % {
            'trivial': (trivial and _("Trivial ", formatted=False)) or "",
            'sitename': page.cfg.sitename or "Wiki",
            'pagename': page.page_name,
            'username': page.uid_override or user.getUserIdentification(request),

    return {'subject': subject, 'body': body}

def send_notification(request, from_address, emails, data):
    """ Send notification email

    @param emails: list of email addresses
    @return: sendmail result
    @rtype int

    return sendmail.sendmail(request, emails, data['subject'], data['body'], mail_from=from_address)

def notify_subscribers(request, page, comment, trivial):
    """ Send email to all subscribers of given page.

    @param comment: editor's comment given when saving the page
    @param trivial: editor's suggestion that the change is trivial (Subscribers may ignore this)
    @rtype: string
    @return: message, indicating success or errors.

    _ = request.getText
    subscribers = page.getSubscribers(request, return_users=1, trivial=trivial)
    mail_from = page.cfg.mail_from

    if subscribers:
        recipients = set()

        # get a list of old revisions, and append a diff
        revisions = page.getRevList()

        # send email to all subscribers
        for lang in subscribers:
            emails = [ for u in subscribers[lang] if u.notify_by_email]
            names = [ for u in subscribers[lang] if u.notify_by_email]
            data = prep_page_changed_mail(request, page, comment, lang, revisions, trivial)

            if send_notification(request, mail_from, emails, data):

        if recipients:
            return notification.Success(recipients)

def handle_user_created(event):
    """Sends an email to super users that have subscribed to this event type"""

    emails = []
    _ = event.request.getText
    user_ids = getUserList(event.request)
    event_name = event.__class__.__name__

    from_address = event.request.cfg.mail_from
    email = or u"NOT SET"
    sitename = event.request.cfg.sitename
    username =

    data = notification.user_created_message(event.request, sitename, username, email)

    for id in user_ids:
        usr = User(event.request, id=id)
        if not usr.notify_by_email:

        # Currently send this only to super users
        if usr.isSuperUser() and event_name in usr.subscribed_events and usr.notify_by_email:

    send_notification(event.request, from_address, emails, data)

def handle_file_attached(event):
    """Sends an email to super users that have subscribed to this event type"""

    names = set()
    _ = event.request.getText
    event_name = event.__class__.__name__
    from_address = event.request.cfg.mail_from
    request = event.request
    page = Page(request, event.pagename)

    subscribers = page.getSubscribers(request, return_users=1)
    notification.filter_subscriber_list(event, subscribers, False)
    data = notification.attachment_added(request, event.pagename,, event.size)

    for lang in subscribers:
        emails = []

        for usr in subscribers[lang]:
            if usr.notify_by_email and event_name in usr.subscribed_events:

            if send_notification(request, from_address, emails, data):

    return notification.Success(names)

def handle(event):
    """An event handler"""

    if not event.request.cfg.mail_enabled:

    if isinstance(event, PageChangedEvent):
        return notify_subscribers(event.request,, event.comment, event.trivial)
    elif isinstance(event, UserCreatedEvent):
        return handle_user_created(event)
    elif isinstance(event, FileAttachedEvent):
        return handle_file_attached(event)