#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000  Donald N. Allingham
#
# 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#

"Database Processing/Extract information from names"

#-------------------------------------------------------------------------
#
# python modules
#
#-------------------------------------------------------------------------
import os
import re

#-------------------------------------------------------------------------
#
# gnome/gtk
#
#-------------------------------------------------------------------------
import gtk
import gtk.glade

#-------------------------------------------------------------------------
#
# gramps modules
#
#-------------------------------------------------------------------------
import Utils
from QuestionDialog import OkDialog
from intl import gettext as _

#-------------------------------------------------------------------------
#
# constants
#
#-------------------------------------------------------------------------
_title_re = re.compile(r"^([A-Za-z][A-Za-z]+\.)\s+(.*)$")
_nick_re = re.compile(r"(.+)[(\"](.*)[)\"]")

#-------------------------------------------------------------------------
#
# Search each name in the database, and compare the firstname against the
# form of "Name (Nickname)".  If it matches, change the first name entry
# to "Name" and add "Nickname" into the nickname field.
#
#-------------------------------------------------------------------------
def runTool(database,active_person,callback):
    try:
        PatchNames(database,callback)
    except:
        import DisplayTrace
        DisplayTrace.DisplayTrace()

#-------------------------------------------------------------------------
#
# PatchNames
#
#-------------------------------------------------------------------------
class PatchNames:

    def __init__(self,db,callback):
        self.cb = callback
        self.db = db
        self.title_list = []
        self.nick_list = []

        for key in self.db.getPersonKeys():
        
            person = self.db.getPerson(key)
            first = person.getPrimaryName().getFirstName()
            match = _title_re.match(first)
            if match:
                groups = match.groups()
                self.title_list.append((key,groups[0],groups[1]))
            match = _nick_re.match(first)
            if match:
                groups = match.groups()
                self.nick_list.append((key,groups[0],groups[1]))

        msg = ""

        if len(self.nick_list) > 0 or len(self.title_list) > 0:
            for (id,name,nick) in self.nick_list:
                p = self.db.getPerson(id)
                msg = msg + _("%s will be extracted as a nickname from %s\n") % \
                      (nick,p.getPrimaryName().getName())

            for (id,title,nick) in self.title_list:
                p = self.db.getPerson(id)
                msg = msg + _("%s will be extracted as a title from %s\n") % \
                      (title,p.getPrimaryName().getName())

            base = os.path.dirname(__file__)
            glade_file = base + os.sep + "patchnames.glade"

            self.top = gtk.glade.XML(glade_file,"summary")
            self.top.signal_autoconnect({
                "destroy_passed_object" : Utils.destroy_passed_object,
                "on_ok_clicked" : self.on_ok_clicked
                })

            Utils.set_titles(self.top.get_widget('summary'),
                             self.top.get_widget('title'),
                             _('Name and title extraction tool'))

            self.top.get_widget("textwindow").get_buffer().set_text(msg)
        else:
            OkDialog(_('No modifications made'),
                     _("No titles or nicknames were found"))
            self.cb(0)

    def on_ok_clicked(self,obj):
        for grp in self.nick_list:
            p = self.db.getPerson(grp[0])
            name = p.getPrimaryName()
            name.setFirstName(grp[1])
            p.setNickName(grp[2])
            self.db.buildPersonDisplay(grp[0])
            Utils.modified()

        for grp in self.title_list:
            p = self.db.getPerson(grp[0])
            name = p.getPrimaryName()
            name.setFirstName(grp[2])
            name.setTitle(grp[1])
            self.db.buildPersonDisplay(grp[0])
            Utils.modified()

        Utils.destroy_passed_object(obj)
        self.cb(1)
        
#------------------------------------------------------------------------
#
# 
#
#------------------------------------------------------------------------
from Plugins import register_tool

register_tool(
    runTool,
    _("Extract information from names"),
    category=_("Database Processing"),
    description=_("Searches the entire database and attempts to extract titles and nicknames that may be embedded in a person's given name field.")
    )