#! /usr/bin/python
#
# Copyright (C) 1998-2009 by the Free Software Foundation, Inc.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
# USA.

"""Invite members to a list from the command line.

Usage:
    invite_members [options] listname

Options:

    --regular-members-file=file
    -r file
        A file containing addresses of the members to be added, one
        address per line.  This list of people are invited to become
        non-digest members although they can switch during web
        acceptance.  If file is `-', read addresses from stdin.

    --digest-members-file=file
    -d file
        Similar to above, but these people are invited to become
        digest members.

    --message-file=file
    -m file
        A file containing text to be added ahead of the standard
        invite.txt invitation.  If you provide this, the file should
        end with a blank line.

    --help
    -h
        Print this help message and exit.

    listname
        The name of the Mailman list you are inviting members to.  It must
        already exist.

You must supply at least one of -r and -d options.  At most one of the
files can be `-'.

Admin notification and list welcome message will be sent or not according
to list settings when the invitation is accepted.
"""

import sys
import getopt
from cStringIO import StringIO

import paths
# Import this /after/ paths so that the sys.path is properly hacked
from email.Utils import parseaddr

from Mailman import MailList
from Mailman import Utils
from Mailman import Errors
from Mailman import mm_cfg
from Mailman import i18n
from Mailman.UserDesc import UserDesc

_ = i18n._



def usage(status, msg=''):
    if status:
        fd = sys.stderr
    else:
        fd = sys.stdout
    print >> fd, _(__doc__)
    if msg:
        print >> fd, msg
    sys.exit(status)



def readfile(filename):
    if filename == '-':
        fp = sys.stdin
        closep = 0
    else:
        fp = open(filename)
        closep = 1
    # strip all the lines of whitespace and discard blank lines
    lines = filter(None, [line.strip() for line in fp.readlines()])
    if closep:
        fp.close()
    return lines



class Tee:
    def __init__(self, outfp):
        self.__outfp = outfp

    def write(self, msg):
        sys.stdout.write(msg)
        self.__outfp.write(msg)



def addall(mlist, members, digest, text, outfp):
    tee = Tee(outfp)
    for member in members:
        userdesc = UserDesc()
        userdesc.fullname, userdesc.address = parseaddr(member)
        userdesc.digest = digest
        userdesc.password = Utils.MakeRandomPassword()
        userdesc.language = mlist.preferred_language
        # Don't forget the special invite hack.
        userdesc.invitation = mlist.internal_name()
        if mlist.isMember(userdesc.address):
            print >> tee, _('Already a member: %(member)s')
            continue
        try:
            mlist.InviteNewMember(userdesc, text)
        except Errors.MembershipIsBanned, pattern:
            print >> tee, ('%s:' %
                           member), _('Banned address (matched %(pattern)s)')
        except Errors.MMBadEmailError:
            if userdesc.address == '':
                print >> tee, _('Bad/Invalid email address: blank line')
            else:
                print >> tee, _('Bad/Invalid email address: %(member)s')
        except Errors.MMHostileAddress:
            print >> tee, _('Hostile address (illegal characters): %(member)s')
        else:
            print >> tee, _('Invited: %(member)s')



def main():
    try:
        opts, args = getopt.getopt(sys.argv[1:],
                                   'r:d:m:h',
                                   ['regular-members-file=',
                                    'digest-members-file=',
                                    'message-file=',
                                    'help'])
    except getopt.error, msg:
        usage(1, msg)

    if len(args) <> 1:
        usage(1)

    listname = args[0].lower().strip()
    nfile = None
    dfile = None
    tfile = None
    send_welcome_msg = None
    admin_notif = None
    for opt, arg in opts:
        if opt in ('-h', '--help'):
            usage(0)
        elif opt in ('-d', '--digest-members-file'):
            dfile = arg
        elif opt in ('-r', '--regular-members-file'):
            nfile = arg
        elif opt in ('-m', '--message-file'):
            tfile = arg

    if dfile is None and nfile is None:
        usage(1)

    if dfile == "-" and nfile == "-":
        usage(1, _('Cannot read both digest and normal members '
                   'from standard input.'))

    try:
        mlist = MailList.MailList(listname)
    except Errors.MMUnknownListError:
        usage(1, _('No such list: %(listname)s'))

    try:
        # Set up defaults
        if tfile == None:
            text = ''
        else:
            text = open(tfile).read()

        otrans = i18n.get_translation()
        # Read the regular and digest member files
        dmembers = []
        if dfile:
            dmembers = readfile(dfile)

        nmembers = []
        if nfile:
            nmembers = readfile(nfile)

        if not dmembers and not nmembers:
            usage(0, _('Nothing to do.'))

        s = StringIO()
        i18n.set_language(mlist.preferred_language)
        if nmembers:
            addall(mlist, nmembers, 0, text, s)

        if dmembers:
            addall(mlist, dmembers, 1, text, s)

        mlist.Save()
    finally:
        mlist.Unlock()
        i18n.set_translation(otrans)


if __name__ == '__main__':
    main()