gramps/src/EditSource.py

#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2005  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
#

# $Id$

#-------------------------------------------------------------------------
#
# Python modules
#
#-------------------------------------------------------------------------
from gettext import gettext as _
import gc
import sys

log = sys.stderr.write

#-------------------------------------------------------------------------
#
# GTK/Gnome modules
#
#-------------------------------------------------------------------------
import gobject
import gtk.glade

#-------------------------------------------------------------------------
#
# gramps modules
#
#-------------------------------------------------------------------------
import const
import Utils
import ImageSelect
import ListModel
import RelLib
import NameDisplay
import RepositoryRefEdit
import Spell
import GrampsDisplay
import DisplayState

from WindowUtils import GladeIf

#-------------------------------------------------------------------------
#
# Constants
#
#-------------------------------------------------------------------------

class ReposRefListModel(gtk.ListStore):
    def __init__(self, source=None):
        gtk.ListStore.__init__(self,
                               object    # repostory reference
                               )
        self.set_source(source)

    def rebuild(self):
        """Clear the list and repopulate from the current source record."""
        self.clear()

        for repos_ref in self._source.get_reporef_list():
            self.append([repos_ref])

    def update(self,repos_ref):
        """Add the record if it is not already in the list otherwise
        replace the record with the new one."""

        found = False
        for val in range(0,len(self)):
            iter = self.get_iter(val)
            if repos_ref == self.get_value(iter,0):
                self.row_changed(self.get_path(iter),iter)
                found = True
                break

        if not found:
            self.append([repos_ref])
        
    def set_source(self, source):
        self._source = source
        self.rebuild()

class ReposRefListView:

    def __init__(self, dbstate, widget):
        self._dbstate = dbstate        
        self.database_changed(self._dbstate.db)
        self._db.connect('database-changed', self.database_changed)

        self._widget = widget

        # Create the tree columns
        self._col1 = gtk.TreeViewColumn(_("Name"))
        self._col2 = gtk.TreeViewColumn(_("Type"))
        self._col3 = gtk.TreeViewColumn(_("Note"))

        # Add columns
        self._widget.append_column(self._col1)
        self._widget.append_column(self._col2)
        self._widget.append_column(self._col3)

        # Create cell renders
        self._col1_cell = gtk.CellRendererText()
        self._col2_cell = gtk.CellRendererText()
        self._col3_cell = gtk.CellRendererText()

        # Add cells to view
        self._col1.pack_start(self._col1_cell, True)
        self._col2.pack_start(self._col2_cell, True)
        self._col3.pack_start(self._col3_cell, True)

        # Setup the cell data callback funcs
        self._col1.set_cell_data_func(self._col1_cell, self.object_name)
        self._col2.set_cell_data_func(self._col2_cell, self.object_type)
        self._col3.set_cell_data_func(self._col3_cell, self.object_note)                        
        self._widget.set_enable_search(False)

        
    def database_changed(self,db):
        self._db = db

    # Methods for rendering the cells.
    
    def object_name(self, column, cell, model, iter, user_data=None):
        o = model.get_value(iter, 0)
        repos_hdl = o.get_reference_handle()
        repos = self._db.get_repository_from_handle(repos_hdl)
        cell.set_property('text', repos.get_name())

    def object_type(self, column, cell, model, iter, user_data=None):
        o = model.get_value(iter, 0)
        repos_hdl = o.get_reference_handle()
        repos = self._db.get_repository_from_handle(repos_hdl)
        rtype = repos.get_type()
        if rtype[0] == RelLib.Event.CUSTOM or rtype[0] not in Utils.repository_types:
            name = rtype[1]
        else:
            name = Utils.repository_types[rtype[0]]
        cell.set_property('text', name)

    def object_note(self, column, cell, model, iter, user_data=None):
        o = model.get_value(iter, 0)
        cell.set_property('text', o.get_note())

    # proxy methods to provide access to the real widget functions.
    
    def set_model(self,model=None):
        self._widget.set_model(model)

    def get_model(self):
        return self._widget.get_model()

    def get_selection(self):
        return self._widget.get_selection()

        
class EditSource(DisplayState.ManagedWindow):

    def __init__(self,dbstate,uistate,track,source,readonly=False):
        self.dbstate = dbstate
        self.track = track
        self.uistate = uistate

        self.db = dbstate.db
        self.idle = None
        self.name_display = NameDisplay.displayer.display

        DisplayState.ManagedWindow.__init__(self, uistate, self.track, source)

        if source:
            self.source = source
            self.ref_not_loaded = 1
        else:
            self.source = RelLib.Source()
            self.ref_not_loaded = 0

        self.path = self.db.get_save_path()
        self.not_loaded = 1
        self.lists_changed = 0
        self.gallery_ok = 0
        mode = not self.db.readonly

        self.top_window = gtk.glade.XML(const.gladeFile,"sourceEditor","gramps")
        self.window = self.top_window.get_widget("sourceEditor")
        self.gladeif = GladeIf(self.top_window)

        Utils.set_titles(self.window,self.top_window.get_widget('title'),
                         _('Source Editor'))
        
        plwidget = self.top_window.get_widget("iconlist")
        self.gallery = ImageSelect.Gallery(source, self.db.commit_place,
                                           self.path,
                                           plwidget,
                                           self.db, self, self.window)
        self.author = self.top_window.get_widget("author")
        self.pubinfo = self.top_window.get_widget("pubinfo")
        self.abbrev = self.top_window.get_widget("abbrev")
        self.note = self.top_window.get_widget("source_note")
        self.note.set_editable(mode)
        self.spell = Spell.Spell(self.note)
        self.notes_buffer = self.note.get_buffer()
        self.gallery_label = self.top_window.get_widget("source_edit_gallery")
        self.refs_label = self.top_window.get_widget("source_edit_refs")
        self.notes_label = self.top_window.get_widget("source_edit_notes")
        self.data_label = self.top_window.get_widget("source_edit_data")
        self.flowed = self.top_window.get_widget("source_flowed")
        self.flowed.set_sensitive(mode)
        self.preform = self.top_window.get_widget("source_preform")
        self.preform.set_sensitive(mode)
        
        self.refinfo = self.top_window.get_widget("refinfo")
        
        self.title = self.top_window.get_widget("source_title")
        self.title.set_text(source.get_title())
        self.title.set_editable(mode)
        self.author.set_text(source.get_author())
        self.author.set_editable(mode)
        self.pubinfo.set_text(source.get_publication_info())
        self.pubinfo.set_editable(mode)
        self.abbrev.set_text(source.get_abbreviation())
        self.abbrev.set_editable(mode)

        self.top_window.get_widget('del_data').set_sensitive(mode)
        self.top_window.get_widget('add_data').set_sensitive(mode)
        self.top_window.get_widget('add_photo').set_sensitive(mode)
        self.top_window.get_widget('sel_photo').set_sensitive(mode)
        self.top_window.get_widget('delete_photo').set_sensitive(mode)

        self.repos_ref_view = ReposRefListView(self.dbstate,
                                              self.top_window.get_widget('repository_ref_list'))
        self.repos_ref_model = ReposRefListModel(self.source)
        self.repos_ref_view.set_model(self.repos_ref_model)
        
        self.top_window.get_widget('add_repos_ref').set_sensitive(mode)
        self.top_window.get_widget('edit_repos_ref').set_sensitive(mode)
        self.top_window.get_widget('del_repos_ref').set_sensitive(mode)

        if source.get_note():
            self.notes_buffer.set_text(source.get_note())
            Utils.bold_label(self.notes_label)
            if source.get_note_format() == 1:
                self.preform.set_active(1)
            else:
                self.flowed.set_active(1)
        else:
            Utils.unbold_label(self.notes_label)

        if self.source.get_media_list():
            Utils.bold_label(self.gallery_label)
        else:
            Utils.unbold_label(self.gallery_label)

        self.gladeif.connect('sourceEditor','delete_event',self.on_delete_event)
        self.gladeif.connect('button90','clicked',self.close)
        self.gladeif.connect('ok','clicked',self.on_source_apply_clicked)
        self.gladeif.connect('button166','clicked',self.on_help_clicked)
        self.gladeif.connect('notebook2','switch_page',self.on_switch_page)
        self.gladeif.connect('add_data','clicked',self.on_add_data_clicked)
        self.gladeif.connect('del_data','clicked',self.on_delete_data_clicked)
        self.gladeif.connect('add_photo','clicked',self.gallery.on_add_media_clicked)
        self.gladeif.connect('sel_photo','clicked',self.gallery.on_select_media_clicked)
        self.gladeif.connect('edit_photo','clicked',self.gallery.on_edit_media_clicked)
        self.gladeif.connect('delete_photo','clicked',self.gallery.on_delete_media_clicked)
        self.gladeif.connect('add_repos_ref','clicked',self.on_add_repos_ref_clicked)
        self.gladeif.connect('del_repos_ref','clicked',self.on_delete_repos_ref_clicked)
        self.gladeif.connect('edit_repos_ref','clicked',self.on_edit_repos_ref_clicked)
        self.gladeif.connect('repository_ref_list','row_activated',self.on_edit_repos_ref_clicked)

        if self.source.get_handle() == None or self.db.readonly:
            self.top_window.get_widget("edit_photo").set_sensitive(False)
            self.top_window.get_widget("delete_photo").set_sensitive(False)

        self.datalist = self.top_window.get_widget('datalist')
        colno = 0
        first = True
        for title in [ (_('Key'),0,175), (_('Value'),1,150)]:
            renderer = gtk.CellRendererText()
            renderer.set_property('editable',True)
            renderer.connect('edited',self.edit_cb, colno)
            column = gtk.TreeViewColumn(title[0], renderer, text=colno)
            colno += 1
            column.set_clickable(True)
            column.set_resizable(True)
            column.set_min_width(title[2])
            column.set_sort_column_id(title[1])
            self.datalist.append_column(column)
            if first:
                first = False
                self.key_cell = renderer
                self.key_col = column

        self.data_model = gtk.ListStore(str,str)
        self.datalist.set_model(self.data_model)
        dmap = self.source.get_data_map()
        for item in dmap.keys():
            self.data_model.append(row=[item,dmap[item]])

        if dmap:
            Utils.bold_label(self.data_label)
        else:
            Utils.unbold_label(self.data_label)

        self.top_window.get_widget('ok').set_sensitive(not self.db.readonly)

        self.show()

        self.model = None # This will hold the model for backreferences once it is complete.
        
        if self.ref_not_loaded:
            self.ref_not_loaded = 0
            Utils.temp_label(self.refs_label,self.window)
            self.cursor_type = None
            self.idle = gobject.idle_add(self.display_references)
            
        self.data_sel = self.datalist.get_selection()

    def build_window_key(self,source):
        if source:
            return source.get_handle()
        else:
            return id(self)

    def build_menu_names(self,source):
        if source:
            label = "Edit Source"
        else:
            label = "New Source"
        return (label, _('Source Editor'))        

    def on_add_data_clicked(self,widget):
        node = self.data_model.append(row=['',''])
        self.data_sel.select_iter(node)
        path = self.data_model.get_path(node)
        self.datalist.set_cursor_on_cell(path,
                                         focus_column=self.key_col,
                                         focus_cell=None,
                                         start_editing=True)


    def on_delete_data_clicked(self,widget):
        (model,node) = self.data_sel.get_selected()
        if node:
            model.remove(node)

    def on_add_repos_ref_clicked(self,widget):
        RepositoryRefEdit.RepositoryRefEdit(RelLib.RepoRef(),self.dbstate,
                                            self.repos_ref_model.update,self)

    def on_delete_repos_ref_clicked(self,widget):
        selection = self.repos_ref_view.get_selection()
        model, iter = selection.get_selected()
        if iter:
            model.remove(iter)
        return        


    def on_edit_repos_ref_clicked(self,widget,path=None,colm=None,userp=None):
        selection = self.repos_ref_view.get_selection()
        model, iter = selection.get_selected()
        
        if iter:
            repos_ref = model.get_value(iter,0)
            
            RepositoryRefEdit.RepositoryRefEdit(repos_ref,self.dbstate,
                                                self.repos_ref_model.update,self)


    def edit_cb(self, cell, path, new_text, data):
        node = self.data_model.get_iter(path)
        self.data_model.set_value(node,data,new_text)

    def on_delete_event(self,obj,b):
        self.close_child_windows()
        self.remove_itself_from_menu()
        self.gladeif.close()
        gc.collect()

    def on_help_clicked(self,obj):
        """Display the relevant portion of GRAMPS manual"""
        GrampsDisplay.help('adv-src')

    def close(self,obj):
        self.gallery.close()
        self.gladeif.close()
        self.window.destroy()
        if self.idle != None:
            gobject.source_remove(self.idle)
        gc.collect()
        
    def button_press(self,obj):
        data = self.model.get_selected_objects()
        if not data:
            return
        (data_type,handle) = data[0]
        if data_type == 0:
            import EditPerson
            person = self.db.get_person_from_handle(handle)
            EditPerson.EditPerson(self.state, self.uistate, self.track, person)
        elif data_type == 1:
            import Marriage
            family = self.db.get_family_from_handle(handle)
            Marriage.Marriage(self.parent,family,self.db)
        elif data_type == 2:
            import EventEdit
            event = self.db.get_event_from_handle(handle)
            event_name = event.get_name()
            if Utils.family_events.has_key(event_name):
                EventEdit.EventEditor(
                    self,", ", const.marriageEvents, Utils.family_events,
                    event, None, 0, None, None, self.db.readonly)
            elif Utils.personal_events.has_key(event_name):
                EventEdit.EventEditor(
                    self,", ", const.personalEvents, Utils.personal_events,
                    event, None, 0, None, None, self.db.readonly)
            elif event_name in ["Birth","Death"]:
                EventEdit.EventEditor(
                    self,", ", const.personalEvents, Utils.personal_events,
                    event, None, 1, None, None, self.db.readonly)
        elif data_type == 3:
            import EditPlace
            place = self.db.get_place_from_handle(handle)
            EditPlace.EditPlace(self.parent,place)
        elif data_type == 4:
            source = self.db.get_source_from_handle(handle)
            EditSource(source,self.db,self.parent,None,self.db.readonly)
        elif data_type == 5:
            media = self.db.get_object_from_handle(handle)
            ImageSelect.GlobalMediaProperties(self.db,media,self)

    def display_references(self):

        if not self.model:
            self.any_refs = False
            source_handle = self.source.get_handle()

            slist = self.top_window.get_widget('slist')
            titles = [(_('Type'),0,150),(_('ID'),1,75),(_('Name'),2,150)]
            self.model = ListModel.ListModel(slist,
                                             titles,
                                             event_func=self.button_press)
            self.backlink_generator = self.db.find_backlink_handles(source_handle)
            


        while True: # The loop is broken when the backlink_generator finishes

            try:
                reference = self.backlink_generator.next()
            except StopIteration:
                # Last reference reached.
                break

            # If we make it here then there is at least one reference
            self.any_refs = True
            
            cls_name,handle = reference
            
            if cls_name == 'Person':
                person = self.db.get_person_from_handle(handle)
                name = self.name_display(person)
                gramps_id = person.get_gramps_id()
                self.model.add([_("Person"),gramps_id,name],(0,handle))
                
            elif cls_name == 'Event':
                event = self.db.get_event_from_handle(handle)
                name = event.get_name()
                gramps_id = event.get_gramps_id()
                self.model.add([_("Event"),gramps_id,name],(2,handle))
                
            elif cls_name == 'Family':
                family = self.db.get_family_from_handle(handle)
                name = Utils.family_name(family,self.db)
                gramps_id = family.get_gramps_id()
                self.model.add([_("Family"),gramps_id,name],(1,handle))

            elif cls_name == 'Place':
                place = self.db.get_place_from_handle(handle)
                name = place.get_title()
                gramps_id = place.get_gramps_id()
                self.model.add([_("Place"),gramps_id,name],(3,handle))
                
            elif cls_name == 'Source':
                source = self.db.get_source_from_handle(handle)
                name = source.get_title()
                gramps_id = source.get_gramps_id()
                self.model.add([_("Source"),gramps_id,name],(4,handle))
                self.any_refs = True
                
            elif cls_name == 'Media':
                obj = self.db.get_object_from_handle(handle)
                name = obj.get_description()
                gramps_id = obj.get_gramps_id()
                self.model.add([_("Media"),gramps_id,name],(5,handle))

            elif cls_name == 'Repository':
                pass # handled by seperate Repositories tab in UI

            else:
                # If we get here it means there is a new Primary object type
                # that has been added to the database. Print a warning
                # to remind us that this code need updating.
                log("WARNING: Unhandled Primary object type returned from "
                    "find_backlink_handles()\n")
                
            if gtk.events_pending():
                return True

        if self.any_refs:
            Utils.bold_label(self.refs_label,self.window)
        else:
            Utils.unbold_label(self.refs_label,self.window)
            
        self.ref_not_loaded = 0
        self.backlink_generator = None
        
        return False

    def on_source_apply_clicked(self,obj):

        title = unicode(self.title.get_text())
        author = unicode(self.author.get_text())
        pubinfo = unicode(self.pubinfo.get_text())
        abbrev = unicode(self.abbrev.get_text())
        note = unicode(
            self.notes_buffer.get_text(self.notes_buffer.get_start_iter(),
                                       self.notes_buffer.get_end_iter(),
                                       False))
        format = self.preform.get_active()

        if author != self.source.get_author():
            self.source.set_author(author)
        
        if title != self.source.get_title():
            self.source.set_title(title)
        
        if pubinfo != self.source.get_publication_info():
            self.source.set_publication_info(pubinfo)
        
        if abbrev != self.source.get_abbreviation():
            self.source.set_abbreviation(abbrev)
        
        if note != self.source.get_note():
            self.source.set_note(note)

        if format != self.source.get_note_format():
            self.source.set_note_format(format)

        new_map = {}
        for val in range(0,len(self.data_model)):
            node = self.data_model.get_iter(val)
            key = self.data_model.get_value(node,0)
            value = self.data_model.get_value(node,1)
            if key:
                new_map[unicode(key)] = unicode(value)
        if new_map != self.source.get_data_map():
            self.source.set_data_map(new_map)

        # update repository refs
        repos_ref_list = []
        for val in range(0,len(self.repos_ref_model)):
            iter = self.repos_ref_model.get_iter(val)
            repos_ref_list.append(self.repos_ref_model.get_value(iter,0))
            
        self.source.set_reporef_list(repos_ref_list)
        
        self.gallery_ok = 1

        trans = self.db.transaction_begin()
        if self.source.get_handle() == None:
            self.db.add_source(self.source,trans)
        else:
            self.db.commit_source(self.source,trans)
        self.db.transaction_commit(trans,_("Edit Source (%s)") % title)
        self.close(obj)

    def on_switch_page(self,obj,a,page):
        if page == 2 and self.not_loaded:
            self.not_loaded = 0
            self.gallery.load_images()
        elif page == 3 and self.ref_not_loaded:
            self.ref_not_loaded = 0
            Utils.temp_label(self.refs_label,self.window)
            self.idle = gobject.idle_add(self.display_references)
        text = unicode(
            self.notes_buffer.get_text(self.notes_buffer.get_start_iter(),
                                       self.notes_buffer.get_end_iter(),
                                       False)
            )
        if text:
            Utils.bold_label(self.notes_label,self.window)
        else:
            Utils.unbold_label(self.notes_label,self.window)

    def update_repositories(self, repos_ref):
        """Make the repository list reflect the change or addition of repos_ref"""
        pass


class DelSrcQuery:
    def __init__(self,source,db,the_lists):
        self.source = source
        self.db = db
        self.the_lists = the_lists

    def query_response(self):
        trans = self.db.transaction_begin()
        self.db.disable_signals()
        
        (person_list,family_list,event_list,
            place_list,source_list,media_list) = self.the_lists

        src_handle_list = [self.source.get_handle()]

        for handle in person_list:
            person = self.db.get_person_from_handle(handle)
            person.remove_source_references(src_handle_list)
            self.db.commit_person(person,trans)

        for handle in family_list:
            family = self.db.get_family_from_handle(handle)
            family.remove_source_references(src_handle_list)
            self.db.commit_family(family,trans)

        for handle in event_list:
            event = self.db.get_event_from_handle(handle)
            event.remove_source_references(src_handle_list)
            self.db.commit_event(event,trans)

        for handle in place_list:
            place = self.db.get_place_from_handle(handle)
            place.remove_source_references(src_handle_list)
            self.db.commit_place(place,trans)

        for handle in source_list:
            source = self.db.get_source_from_handle(handle)
            source.remove_source_references(src_handle_list)
            self.db.commit_source(source,trans)

        for handle in media_list:
            media = self.db.get_object_from_handle(handle)
            media.remove_source_references(src_handle_list)
            self.db.commit_media_object(media,trans)

        self.db.enable_signals()
        self.db.remove_source(self.source.get_handle(),trans)
        self.db.transaction_commit(
            trans,_("Delete Source (%s)") % self.source.get_title())