view MoinMoin/ @ 836:942b53b4e095

use whoosh for user lookup, add EMAIL/OPENID to latest-revs schema fix some minor test issues with unicode/str data types
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Sat, 03 Sep 2011 23:33:02 +0200
parents 8fcaf02251de
children f0dceb963342
line wrap: on
line source
# Copyright: 2000-2004 Juergen Hermann <>
# Copyright: 2003-2011 MoinMoin:ThomasWaldmann
# Copyright: 2007 MoinMoin:JohannesBerg
# Copyright: 2007 MoinMoin:HeinrichWendel
# Copyright: 2008 MoinMoin:ChristopherDenter
# Copyright: 2010 MoinMoin:DiogenesAugusto
# License: GNU GPL v2 (or any later version), see LICENSE.txt for details.

    MoinMoin - User Accounts

    TODO: Currently works on unprotected user backend

    This module contains functions to access user accounts (list all users, get
    some specific user). User instances are used to access the user profile of
    some specific user (name, password, email, bookmark, trail, settings, ...).

from __future__ import absolute_import, division

import time
import copy

from uuid import uuid4
make_uuid = lambda: unicode(uuid4().hex)

from babel import parse_locale

from flask import current_app as app
from flask import g as flaskg
from flask import session, request, url_for

from whoosh.query import Term, And, Or

from MoinMoin import config, wikiutil
from MoinMoin.i18n import _, L_, N_
from MoinMoin.util.interwiki import getInterwikiHome, getInterwikiName, is_local_wiki
from MoinMoin.util.crypto import crypt_password, upgrade_password, valid_password, \
                                 generate_token, valid_token
from import NoSuchItemError, ItemAlreadyExistsError, NoSuchRevisionError

def create_user(username, password, email, openid=None):
    """ create a user """
    # Create user profile
    theuser = User(auth_method="new-user") = unicode(username)

    # Don't allow creating users with invalid names
    if not isValidName(
        return _("""Invalid user name '%(name)s'.
Name may contain any Unicode alpha numeric character, with optional one
space between words. Group page name is not allowed.""",

    # Name required to be unique. Check if name belong to another user.
    if getUserId(
        return _("This user name already belongs to somebody else.")

    pw_checker = app.cfg.password_checker
    if pw_checker:
        pw_error = pw_checker(, password)
        if pw_error:
            return _("Password not acceptable: %(msg)s", msg=pw_error)

    # Encode password
        theuser.enc_password = crypt_password(password)
    except UnicodeError as err:
        # Should never happen
        return "Can't encode password: %(msg)s" % dict(msg=str(err))

    # try to get the email, for new users it is required = email
    if not
        return _("Please provide your email address. If you lose your"
                 " login information, you can get it by email.")

    # Email should be unique - see also MoinMoin/script/accounts/
    if and app.cfg.user_email_unique:
        if get_by_email(
            return _("This email already belongs to somebody else.")

    # Openid should be unique
    theuser.openid = openid
    if theuser.openid and get_by_openid(theuser.openid):
            return _('This OpenID already belongs to somebody else.')

    # save data

def get_user_backend():
    return flaskg.unprotected_storage

def get_revs_by_filter(**q):
    """ Searches for a user with a given filter """
    q.update(wikiname=app.cfg.interwikiname) # XXX for now, search only users of THIS wiki
                                             # maybe add option to not index wiki users separately,
                                             # but share them in the index also
    backend = get_user_backend()
    docs = backend.documents(all_revs=False, **q)
    return list(docs)

def getUserList():
    """ Get a list of all (numerical) user IDs.

    :rtype: list
    :returns: all user IDs
    revs = get_revs_by_filter()
    return [rev[UUID] for rev in revs]

def get_by_email(email):
    """ Searches for an user with a particular e-mail address and returns it. """
    revs = get_revs_by_filter(email=email)
    if revs:
        return User(revs[0][UUID])

def get_by_openid(openid):
    Searches for a user using an openid identifier.

    :param openid: the openid to filter with
    :type openid: unicode
    :returns: the user whose openid is this one
    :rtype: user object or None
    revs = get_revs_by_filter(openid=openid)
    if revs:
        return User(revs[0][UUID])

def getName(uuid):
    """ Get the name for a specific uuid.

    :param uuid: the user uuid to look up
    :rtype: string
    :returns: the corresponding user name or None
    revs = get_revs_by_filter(uuid=uuid)
    if revs:
        return revs[0][NAME]

def getUserId(name):
    """ Get the user ID for a specific user NAME.

    :param name: the user name to look up
    :rtype: unicode
    :returns: the corresponding user ID or None
    revs = get_revs_by_filter(name_exact=name)
    if revs:
        return revs[0][UUID]

def get_editor(userid, addr, hostname):
    """ Return a tuple of type id and string or Page object
        representing the user that did the edit.

        The type id is one of 'ip' (DNS or numeric IP), 'email' (email addr),
        'interwiki' (Interwiki homepage) or 'anon' ('').
    result = 'anon', ''
    if app.cfg.show_hosts and hostname:
        result = 'ip', hostname
    if userid:
        userdata = User(userid)
        if userdata.mailto_author and
            return ('email',
            interwiki = getInterwikiHome(
            if interwiki:
                result = ('interwiki', interwiki)
    return result

def normalizeName(name):
    """ Make normalized user name

    Prevent impersonating another user with names containing leading,
    trailing or multiple whitespace, or using invisible unicode

    Prevent creating user page as sub page, because '/' is not allowed
    in user names.

    Prevent using ':' and ',' which are reserved by acl.

    :param name: user name, unicode
    :rtype: unicode
    :returns: user name that can be used in acl lines
    username_allowedchars = "'@.-_" # ' for names like O'Brian or email addresses.
                                    # "," and ":" must not be allowed (ACL delimiters).
                                    # We also allow _ in usernames for nicer URLs.
    # Strip non alpha numeric characters (except username_allowedchars), keep white space
    name = ''.join([c for c in name if c.isalnum() or c.isspace() or c in username_allowedchars])

    # Normalize white space. Each name can contain multiple
    # words separated with only one space.
    name = ' '.join(name.split())

    return name

def isValidName(name):
    """ Validate user name

    :param name: user name, unicode
    normalized = normalizeName(name)
    return (name == normalized) and not wikiutil.isGroupItem(name)

class User(object):
    """ A MoinMoin User """

    def __init__(self, uid=None, name="", password=None, auth_username="", **kw):
        """ Initialize User object

        :param uid: (optional) user ID
        :param name: (optional) user name
        :param password: (optional) user password (unicode)
        :param auth_username: (optional) already authenticated user name
                              (e.g. when using http basic auth) (unicode)
        :keyword auth_method: method that was used for authentication,
                              default: 'internal'
        :keyword auth_attribs: tuple of user object attribute names that are
                               determined by auth method and should not be
                               changeable by preferences, default: ().
                               First tuple element was used for authentication.
        self._user_backend = get_user_backend()
        self._user = None

        self._cfg = app.cfg
        self.valid = 0
        self.uuid = uid
        self.auth_username = auth_username
        self.auth_method = kw.get('auth_method', 'internal')
        self.auth_attribs = kw.get('auth_attribs', ())
        self.bookmarks = {} # interwikiname: bookmark


        if name:
   = name
        elif auth_username: # this is needed for user autocreate
   = auth_username

        self.recoverpass_key = None

        if password:
            self.enc_password = crypt_password(password)

        self._stored = False

        # attrs not saved to profile

        # we got an already authenticated username:
        check_password = None
        if not self.uuid and self.auth_username:
            self.uuid = getUserId(self.auth_username)
            if not password is None:
                check_password = password
        if self.uuid:
        elif and != 'anonymous':
            self.uuid = getUserId(
            if self.uuid:
                # no password given should fail
                self.load_from_id(password or u'')
        # Still no ID - make new user
        if not self.uuid:
            self.uuid = make_uuid()
            if password is not None:
                self.enc_password = crypt_password(password)

        # "may" so we can say "if"
        if self._cfg.SecurityPolicy:
            self.may = self._cfg.SecurityPolicy(self)
            from import Default
            self.may = Default(self)

    def __repr__(self):
        return "<%s.%s at 0x%x name:%r uuid:%r valid:%r>" % (
            self.__class__.__module__, self.__class__.__name__,
            id(self),, self.uuid, self.valid)

    def language(self):
        l = self._cfg.language_default
        # .locale is either None or something like 'en_US'
        if self.locale is not None:
                l = parse_locale(self.locale)[0]
            except ValueError:
        return l

    def create_or_update(self, changed=False):
        """ Create or update a user profile

        :param changed: bool, set this to True if you updated the user profile values
        if not self.valid and not self.disabled or changed: # do we need to save/update?
   # yes, create/update user profile

    def exists(self):
        """ Do we have a user account for this user?

        :rtype: bool
        :returns: true, if we have a user account
        return self._user_backend.has_item(

    def load_from_id(self, password=None):
        """ Load user account data from disk.

        Can only load user data if the id number is already known.

        This loads all member variables, except "id" and "valid" and
        those starting with an underscore.

        :param password: If not None, then the given password must match the
                         password in the user account file.
            name = getName(self.uuid) # XXX we need the name because backend API is still based on names
            if name is None:
                raise NoSuchItemError("No user name for that uuid.")
            item = self._user_backend.get_item(name)
            self._user = item.get_revision(-1)
        except (NoSuchItemError, NoSuchRevisionError):

        user_data = dict()
        for metadata_key in self._user:
            user_data[metadata_key] = self._user[metadata_key]

        # Validate data from user file. In case we need to change some
        # values, we set 'changed' flag, and later save the user data.
        changed = 0

        if password is not None:
            # Check for a valid password, possibly changing storage
            valid, changed = self._validatePassword(user_data, password)
            if not valid:

        # Copy user data into user object
        for key, val in user_data.items():
            if isinstance(val, tuple):
                val = list(val)
            vars(self)[key] = val

        if not self.disabled:
            self.valid = 1

        # Mark this user as stored so saves don't send
        # the "user created" event
        self._stored = True

        # If user data has been changed, save fixed user data.
        if changed:

    def _validatePassword(self, data, password):
        Check user password.

        This is a private method and should not be used by clients.

        :param data: dict with user data (from storage)
        :param password: password to verify [unicode]
        :rtype: 2 tuple (bool, bool)
        :returns: password is valid, enc_password changed
        pw_hash = data['enc_password']

        # If we have no password set, we don't accept login with username.
        # Require non-empty password.
        if not pw_hash or not password:
            return False, False

        # check the password against the password hash
        if not valid_password(password, pw_hash):
            return False, False

        new_pw_hash = upgrade_password(password, pw_hash)
        if not new_pw_hash:
            return True, False

        data['enc_password'] = new_pw_hash
        return True, True

    def persistent_items(self):
        """ items we want to store into the user profile """
        nonpersistent_keys = ['valid', 'may', 'auth_username',
                              'password', 'password2',
                              'auth_method', 'auth_attribs', 'auth_trusted',
        return [(key, value) for key, value in vars(self).items()
                    if key not in nonpersistent_keys and key[0] != '_' and value is not None]

    def save(self):
        Save user account data to user account file on disk.
        backend_name = # XXX maybe UserProfile/<name> later
            item = self._user_backend.get_item(backend_name)
        except NoSuchItemError:
            item = self._user_backend.create_item(backend_name)
            currentrev = item.get_revision(-1)
            rev_no = currentrev.revno
        except NoSuchRevisionError:
            currentrev = None
            rev_no = -1
        new_rev_no = rev_no + 1
        newrev = item.create_revision(new_rev_no)
        for key, value in self.persistent_items():
            if isinstance(value, list):
                value = tuple(value)
            newrev[key] = value
        newrev[CONTENTTYPE] = u'application/x.moin.userprofile'
        newrev[ACTION] = u'SAVE'

        if not self.disabled:
            self.valid = 1

        if not self._stored:
            self._stored = True
            # XXX UserCreatedEvent
            pass #  XXX UserChangedEvent

    def getText(self, text):
        """ translate a text to the language of this user """
        return text # FIXME, was: self._request.getText(text, lang=self.language)

    # -----------------------------------------------------------------
    # Bookmark

    def setBookmark(self, tm):
        """ Set bookmark timestamp.

        :param tm: timestamp
        if self.valid:
            self.bookmarks[self._cfg.interwikiname] = int(tm)

    def getBookmark(self):
        """ Get bookmark timestamp.

        :rtype: int
        :returns: bookmark timestamp or None
        bm = None
        if self.valid:
                bm = self.bookmarks[self._cfg.interwikiname]
            except (ValueError, KeyError):
        return bm

    def delBookmark(self):
        """ Removes bookmark timestamp.

        :rtype: int
        :returns: 0 on success, 1 on failure
        if self.valid:
                del self.bookmarks[self._cfg.interwikiname]
            except KeyError:
                return 1
            return 0
        return 1

    # -----------------------------------------------------------------
    # Subscribe

    def getSubscriptionList(self):
        """ Get list of pages this user has subscribed to

        :rtype: list
        :returns: pages this user has subscribed to
        return self.subscribed_items

    def isSubscribedTo(self, pagelist):
        """ Check if user subscription matches any page in pagelist.

        The subscription list may contain page names or interwiki page
        names. e.g 'Page Name' or 'WikiName:Page_Name'

        TODO: check if it's fast enough when getting called for many
              users from page.getSubscribersList()

        :param pagelist: list of pages to check for subscription
        :rtype: bool
        :returns: if user is subscribed any page in pagelist
        if not self.valid:
            return False

        import re
        # Create a new list with both names and interwiki names.
        pages = pagelist[:] # TODO: get rid of non-interwiki subscriptions?
        pages += [getInterwikiName(pagename) for pagename in pagelist]
        # Create text for regular expression search
        text = '\n'.join(pages)

        for pattern in self.getSubscriptionList():
            # Try simple match first
            if pattern in pages:
                return True
            # Try regular expression search, skipping bad patterns
                pattern = re.compile(r'^%s$' % pattern, re.M)
            except re.error:
                return True

        return False

    def subscribe(self, pagename):
        """ Subscribe to a wiki page.

        To enable shared farm users, if the wiki has an interwiki name,
        page names are saved as interwiki names.

        :param pagename: name of the page to subscribe
        :type pagename: unicode
        :rtype: bool
        :returns: if page was subscribed
        pagename = getInterwikiName(pagename)
        if pagename not in self.subscribed_items:
            # XXX SubscribedToPageEvent
            return True
        return False

    def unsubscribe(self, pagename):
        """ Unsubscribe a wiki page.

        Try to unsubscribe by removing non-interwiki name (leftover
        from old use files) and interwiki name from the subscription

        Its possible that the user will be subscribed to a page by more
        then one pattern. It can be both pagename and interwiki name,
        or few patterns that all of them match the page. Therefore, we
        must check if the user is still subscribed to the page after we
        try to remove names from the list.

        :param pagename: name of the page to subscribe
        :type pagename: unicode
        :rtype: bool
        :returns: if unsubscrieb was successful. If the user has a
            regular expression that match, it will always fail.
        changed = False
        if pagename in self.subscribed_items:
            changed = True

        interWikiName = getInterwikiName(pagename)
        if interWikiName and interWikiName in self.subscribed_items:
            changed = True

        if changed:
        return not self.isSubscribedTo([pagename])

    # -----------------------------------------------------------------
    # Quicklinks

    def getQuickLinks(self):
        """ Get list of pages this user wants in the navibar

        :rtype: list
        :returns: quicklinks from user account
        return self.quicklinks

    def isQuickLinkedTo(self, pagelist):
        """ Check if user quicklink matches any page in pagelist.

        :param pagelist: list of pages to check for quicklinks
        :rtype: bool
        :returns: if user has quicklinked any page in pagelist
        if not self.valid:
            return False

        for pagename in pagelist:
            if pagename in self.quicklinks:
                return True
            interWikiName = getInterwikiName(pagename)
            if interWikiName and interWikiName in self.quicklinks:
                return True

        return False

    def addQuicklink(self, pagename):
        """ Adds a page to the user quicklinks

        If the wiki has an interwiki name, all links are saved as
        interwiki names. If not, as simple page name.

        :param pagename: page name
        :type pagename: unicode
        :rtype: bool
        :returns: if pagename was added
        changed = False
        interWikiName = getInterwikiName(pagename)
        if interWikiName:
            if pagename in self.quicklinks:
                changed = True
            if interWikiName not in self.quicklinks:
                changed = True
            if pagename not in self.quicklinks:
                changed = True

        if changed:
        return changed

    def removeQuicklink(self, pagename):
        """ Remove a page from user quicklinks

        Remove both interwiki and simple name from quicklinks.

        :param pagename: page name
        :type pagename: unicode
        :rtype: bool
        :returns: if pagename was removed
        changed = False
        interWikiName = getInterwikiName(pagename)
        if interWikiName and interWikiName in self.quicklinks:
            changed = True
        if pagename in self.quicklinks:
            changed = True

        if changed:
        return changed

    # -----------------------------------------------------------------
    # Trail

    def addTrail(self, item_name):
        """ Add item name to trail.

        :param item_name: the item name (unicode) to add to the trail
        item_name = getInterwikiName(item_name)
        trail_in_session = session.get('trail', [])
        trail = trail_in_session[:]
        trail = [i for i in trail if i != item_name] # avoid dupes
        trail.append(item_name) # append current item name at end
        trail = trail[-self._cfg.trail_size:] # limit trail length
        if trail != trail_in_session:
            session['trail'] = trail

    def getTrail(self):
        """ Return list of recently visited item names.

        :rtype: list
        :returns: item names (unicode) in trail
        return session.get('trail', [])

    # -----------------------------------------------------------------
    # Other

    def isCurrentUser(self):
        """ Check if this user object is the user doing the current request """
        return ==

    def host(self):
        """ Return user host """
        host = self.isCurrentUser() and self._cfg.show_hosts and request.remote_addr
        return host or _("<unknown>")

    def wikiHomeLink(self):
        """ Return wiki markup usable as a link to the user homepage,
            it doesn't matter whether it already exists or not.
        wikiname, pagename = getInterwikiHome(
        if is_local_wiki(wikiname):
            markup = '[[%s]]' % pagename
            markup = '[[%s:%s]]' % (wikiname, pagename)
        return markup

    def signature(self):
        """ Return user signature using wiki markup

        Users sign with a link to their homepage.
        Visitors return their host address.

        TODO: The signature use wiki format only, for example, it will
        not create a link when using rst format. It will also break if
        we change wiki syntax.
            return self.wikiHomeLink()

    def generate_recovery_token(self):
        key, token = generate_token()
        self.recoverpass_key = key
        return token

    def apply_recovery_token(self, token, newpass):
        if not valid_token(self.recoverpass_key, token):
            return False
        self.recoverpass_key = None
        self.enc_password = crypt_password(newpass)
        return True

    def mailAccountData(self, cleartext_passwd=None):
        """ Mail a user who forgot his password a message enabling
            him to login again.
        from MoinMoin.mail import sendmail
        token = self.generate_recovery_token()

        text = _("""\
Somebody has requested to email you a password recovery link.

Please use the link below to change your password to a known value:


If you didn't forget your password, please ignore this email.

""", link=url_for('frontend.recoverpass',
              , token=token, _external=True))

        subject = _('[%(sitename)s] Your wiki password recovery link',
                    sitename=self._cfg.sitename or "Wiki")
        mailok, msg = sendmail.sendmail([], subject, text, mail_from=self._cfg.mail_from)
        return mailok, msg