gramps/src/Plugins.py

#
# 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
#

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
from gtk import *

import libglade
import intl

_ = intl.gettext

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
import os
import sys
import string
import re

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
import const
import utils

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
_reports = []
_tools   = []
_imports = []
_exports = []

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
OBJECT    = "o"
DOCSTRING = "d"
IMAGE     = "i"
TASK      = "f"
TITLE     = "t"

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
class ReportPlugins:

    def __init__(self,db,active):
        self.db = db
        self.active = active
        
        self.dialog = libglade.GladeXML(const.pluginsFile,"report")
        self.dialog.signal_autoconnect({
            "on_report_apply_clicked" : on_report_apply_clicked,
            "on_report_ok_clicked"    : on_report_apply_clicked,
            "destroy_passed_object"   : utils.destroy_passed_object
            })

        top = self.dialog.get_widget("report")
        top.set_data(OBJECT,self)
        tree = self.dialog.get_widget("tree1")
        self.run_tool = None
        build_tree(tree,_reports,on_report_node_selected)
                   
#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
class ToolPlugins:
    def __init__(self,db,active,update):
        self.db = db
        self.active = active
        self.update = update
        
        self.dialog = libglade.GladeXML(const.pluginsFile,"pluginsel")
        self.dialog.signal_autoconnect({
            "on_apply_clicked"      : on_apply_clicked,
            "on_ok_clicked"         : on_ok_clicked,
            "destroy_passed_object" : utils.destroy_passed_object
            })

        top = self.dialog.get_widget("pluginsel")
        top.set_data(OBJECT,self)
        tree = self.dialog.get_widget("tree")
        self.run_tool = None
        build_tree(tree,_tools,on_node_selected)

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
def build_tree(tree,list,task):
    item_hash = {}
    for report in list:
        item = GtkTreeItem(report[2])
        item.connect("select",task)
        item.set_data(OBJECT,self)
        item.set_data(TASK,report[0])
        item.set_data(TITLE,report[2])
        item.set_data(DOCSTRING,report[3])
        item.set_data(IMAGE,report[4])

        if item_hash.has_key(report[1]):
            item_hash[report[1]].append(item)
        else:
            item_hash[report[1]] = [item]

    key_list = item_hash.keys()
    key_list.sort()
    for key in key_list:
        top_item = GtkTreeItem(key)
        top_item.show()
        tree.append(top_item)
        subtree = GtkTree()
        subtree.show()
        top_item.set_subtree(subtree)
        subtree.show()
        for item in item_hash[key]:
            item.show()
            subtree.append(item)

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
def on_node_selected(obj):
    myobj = obj.get_data(OBJECT)
    doc = obj.get_data(DOCSTRING)
    title = obj.get_data(TITLE)
    
    myobj.dialog.get_widget("description").set_text(doc)
    myobj.dialog.get_widget("pluginTitle").set_text(title)
    myobj.run_tool = obj.get_data(TASK)

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
def on_report_node_selected(obj):
    myobj = obj.get_data(OBJECT)
    doc = obj.get_data(DOCSTRING)
    xpm = obj.get_data(IMAGE)
    title = obj.get_data(TITLE)
    img = myobj.dialog.get_widget("image")
    
    myobj.dialog.get_widget("description").set_text(DOC)

    i,m = create_pixmap_from_xpm_d(GtkWindow(),None,xpm)
    img.set(i,m)
    
    myobj.dialog.get_widget("report_title").set_text(title)
    myobj.run_tool = obj.get_data(TASK)

#-------------------------------------------------------------------------
#
#
#
#-------------------------------------------------------------------------
def on_apply_clicked(obj):
    myobj = obj.get_data(OBJECT)
    utils.destroy_passed_object(obj)
    if myobj.run_tool:
        myobj.run_tool(myobj.db,myobj.active,myobj.update)

#-------------------------------------------------------------------------
#
#
#
#-------------------------------------------------------------------------
def on_report_apply_clicked(obj):
    myobj = obj.get_data(OBJECT)
    utils.destroy_passed_object(obj)
    if myobj.run_tool:
        myobj.run_tool(myobj.db,myobj.active)

#-------------------------------------------------------------------------
#
#
#
#-------------------------------------------------------------------------
def on_ok_clicked(obj):
    on_apply_clicked(obj)

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
def load_plugins(dir):
    pymod = re.compile(r"^(.*)\.py$")

    if not os.path.isdir(dir):
        return

    sys.path.append(dir)
    for file in os.listdir(dir):
        name = os.path.split(file)
        match = pymod.match(name[1])
        if not match:
            continue
        groups = match.groups()
        try: 
            plugin = __import__(groups[0])
        except:
            print _("Failed to load the module: %s") % groups[0]
            import traceback
            traceback.print_exc()

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
def build_export_menu(top_menu,callback):
    myMenu = GtkMenu()

    for report in _exports:
        item = GtkMenuItem(report[1])
        item.connect("activate", callback ,report[0])
        item.show()
        myMenu.append(item)
    top_menu.set_submenu(myMenu)

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
def build_import_menu(top_menu,callback):
    myMenu = GtkMenu()

    for report in _imports:
        item = GtkMenuItem(report[1])
        item.connect("activate", callback ,report[0])
        item.show()
        myMenu.append(item)
    top_menu.set_submenu(myMenu)

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
def register_export(task, name):
    _exports.append((task, name))

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
def register_import(task, name):
    _imports.append((task, name))

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
def register_report(task, name, category=None, description=None, xpm=None):
    if xpm == None:
        xpm_data = no_image()
    elif type(xpm) == type([]):
        xpm_data = xpm
    else:
        xpm_data = xpm

    if category == None:
        category = _("Uncategorized")
    if description == None:
        description = _("No description was provided")
        
    _reports.append((task, category, name, description, xpm_data))

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
def register_tool(task, name, category=None, description=None, xpm=None):
    if xpm == None:
        xpm_data = no_image()
    elif type(xpm) == type([]):
        xpm_data = xpm
    else:
        xpm_data = xpm

    if category == None:
        category = _("Uncategorized")
    if description == None:
        description = _("No description was provided")
        
    _tools.append((task, category, name, description, xpm_data))

#-------------------------------------------------------------------------
#
#
#
#-------------------------------------------------------------------------
def build_menu(top_menu,list,callback):
    report_menu = GtkMenu()
    report_menu.show()
    
    hash = {}
    for report in list:
        if hash.has_key(report[1]):
            hash[report[1]].append((report[2],report[0]))
        else:
            hash[report[1]] = [(report[2],report[0])]

    catlist = hash.keys()
    catlist.sort()
    for key in catlist:
        entry = GtkMenuItem(key)
        entry.show()
        report_menu.append(entry)
        submenu = GtkMenu()
        submenu.show()
        entry.set_submenu(submenu)
        list = hash[key]
        list.sort()
        for name in list:
            subentry = GtkMenuItem(name[0])
            subentry.show()
            subentry.connect("activate",callback,name[1])
            submenu.append(subentry)
    top_menu.set_submenu(report_menu)

#-------------------------------------------------------------------------
#
#
#
#-------------------------------------------------------------------------
def build_report_menu(top_menu,callback):
    build_menu(top_menu,_reports,callback)

#-------------------------------------------------------------------------
#
#
#
#-------------------------------------------------------------------------
def build_tools_menu(top_menu,callback):
    build_menu(top_menu,_tools,callback)

#-------------------------------------------------------------------------
#
# 
#
#-------------------------------------------------------------------------
def no_image():
    return [
        "48 48 5 1",
        " 	c None",
        ".	c #999999",
        "+	c #FFFFCC",
        "@	c #000000",
        "#	c #CCCCCC",
        "                                                ",
        "                                                ",
        "                                                ",
        "                                                ",
        "                                                ",
        "                                                ",
        "                                  ..........    ",
        "                                  .++++++++.    ",
        "                                  .++++++++.    ",
        "                               @@@.++++++++.    ",
        "                               @##.++++++++.    ",
        "                               @# .++++++++.    ",
        "                  ..........   @# ..........    ",
        "                  .++++++++.   @#               ",
        "                  .++++++++.   @#               ",
        "               @@@.++++++++.@@@@#               ",
        "               @##.++++++++.###@# ..........    ",
        "               @# .++++++++.   @# .++++++++.    ",
        "               @# ..........   @# .++++++++.    ",
        "               @#              @@@.++++++++.    ",
        "               @#               ##.++++++++.    ",
        "               @#                 .++++++++.    ",
        "  ..........   @#                 ..........    ",
        "  .++++++++.   @#                               ",
        "  .++++++++.   @#                               ",
        "  .++++++++.@@@@#                               ",
        "  .++++++++.###@#                               ",
        "  .++++++++.   @#                 ..........    ",
        "  ..........   @#                 .++++++++.    ",
        "               @#                 .++++++++.    ",
        "               @#              @@@.++++++++.    ",
        "               @#              @##.++++++++.    ",
        "               @# ..........   @# .++++++++.    ",
        "               @# .++++++++.   @# ..........    ",
        "               @# .++++++++.   @#               ",
        "               @@@.++++++++.@@@@#               ",
        "                ##.++++++++.###@#               ",
        "                  .++++++++.   @# ..........    ",
        "                  ..........   @# .++++++++.    ",
        "                               @# .++++++++.    ",
        "                               @@@.++++++++.    ",
        "                                ##.++++++++.    ",
        "                                  .++++++++.    ",
        "                                  ..........    ",
        "                                                ",
        "                                                ",
        "                                                ",
        "                                                "]