fpdb/pyfpdb/fpdb.py

#!/usr/bin/python

#Copyright 2008 Steffen Jobbagy-Felso
#This program is free software: you can redistribute it and/or modify
#it under the terms of the GNU Affero General Public License as published by
#the Free Software Foundation, version 3 of the License.
#
#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 Affero General Public License
#along with this program. If not, see <http://www.gnu.org/licenses/>.
#In the "official" distribution you can find the license in
#agpl-3.0.txt in the docs folder of the package.

import os
import sys
import re

# if path is set to use an old version of python look for a new one:
# (does this work in linux?)
if os.name == 'nt' and sys.version[0:3] not in ('2.5', '2.6') and '-r' not in sys.argv:
    #print "old path =", os.environ['PATH']
    dirs = re.split(os.pathsep, os.environ['PATH'])
    # remove any trailing / or \ chars from dirs:
    dirs = [re.sub('[\\/]$','',p) for p in dirs]
    # remove any dirs containing 'python' apart from those ending in 'python25', 'python26' or 'python':
    dirs = [p for p in dirs if not re.search('python', p, re.I) or re.search('python25$', p, re.I) or re.search('python26$', p, re.I)]
    tmppath = ";".join(dirs)
    #print "new path =", tmppath
    if re.search('python', tmppath, re.I):
        os.environ['PATH'] = tmppath
        print "Python " + sys.version[0:3] + ' - press return to continue\n'
        sys.stdin.readline()
        os.execvpe('python.exe', ('python.exe', 'fpdb.py', '-r'), os.environ) # first arg is ignored (name of program being run)
    else:
        print "\npython 2.5 not found, please install python 2.5 or 2.6 for fpdb\n"
        exit
else:
    pass
    #print "debug - not changing path"

if os.name == 'nt':
    import win32api
    import win32con

print "Python " + sys.version[0:3] + '...\n'

import traceback
import threading
import Options
import string
cl_options = string.join(sys.argv[1:])
(options, argv) = Options.fpdb_options()

if not options.errorsToConsole:
    print "Note: error output is being diverted to fpdb-error-log.txt and HUD-error.txt. Any major error will be reported there _only_."
    errorFile = open('fpdb-error-log.txt', 'w', 0)
    sys.stderr = errorFile

import logging

import pygtk
pygtk.require('2.0')
import gtk

import interlocks


import GuiPrefs
import GuiBulkImport
import GuiPlayerStats
import GuiPositionalStats
import GuiTableViewer
import GuiAutoImport
import GuiGraphViewer
import GuiSessionViewer
import SQL
import Database
import FpdbSQLQueries
import Configuration
import Exceptions

VERSION = "0.12"

class fpdb:
    def tab_clicked(self, widget, tab_name):
        """called when a tab button is clicked to activate that tab"""
        self.display_tab(tab_name)

    def add_and_display_tab(self, new_tab, new_tab_name):
        """just calls the component methods"""
        self.add_tab(new_tab, new_tab_name)
        self.display_tab(new_tab_name)

    def add_tab(self, new_page, new_tab_name):
        """adds a tab, namely creates the button and displays it and appends all the relevant arrays"""
        for name in self.nb_tabs: #todo: check this is valid
            if name == new_tab_name:
                return # if tab already exists, just go to it

        used_before = False
        for i, name in enumerate(self.tab_names): #todo: check this is valid
            if name == new_tab_name:
                used_before = True
                event_box = self.tabs[i]
                page = self.pages[i]
                break

        if not used_before:
            event_box = self.create_custom_tab(new_tab_name, self.nb)
            page = new_page
            self.pages.append(new_page)
            self.tabs.append(event_box)
            self.tab_names.append(new_tab_name)
        
        #self.nb.append_page(new_page, gtk.Label(new_tab_name))
        self.nb.append_page(page, event_box)
        self.nb_tabs.append(new_tab_name)
        page.show()

    def display_tab(self, new_tab_name):
        """displays the indicated tab"""
        tab_no = -1
        for i, name in enumerate(self.nb_tabs):
            if new_tab_name == name:
                tab_no = i
                break

        if tab_no < 0 or tab_no >= self.nb.get_n_pages():
            raise FpdbError("invalid tab_no " + str(tab_no))
        else:
            self.nb.set_current_page(tab_no)

    def create_custom_tab(self, text, nb):
        #create a custom tab for notebook containing a 
        #label and a button with STOCK_ICON
        eventBox = gtk.EventBox()
        tabBox = gtk.HBox(False, 2)
        tabLabel = gtk.Label(text)
        tabBox.pack_start(tabLabel, False)       
        eventBox.add(tabBox)

        if nb.get_n_pages() > 0:
            tabButton = gtk.Button()

            tabButton.connect('clicked', self.remove_tab, (nb, text))
            #Add a picture on a button
            self.add_icon_to_button(tabButton)
            tabBox.pack_start(tabButton, False)

        # needed, otherwise even calling show_all on the notebook won't
        # make the hbox contents appear.
        tabBox.show_all()
        return eventBox

    def add_icon_to_button(self, button):
        iconBox = gtk.HBox(False, 0)        
        image = gtk.Image()
        image.set_from_stock(gtk.STOCK_CLOSE, gtk.ICON_SIZE_MENU)
        gtk.Button.set_relief(button, gtk.RELIEF_NONE)
        settings = gtk.Widget.get_settings(button);
        (w,h) = gtk.icon_size_lookup_for_settings(settings, gtk.ICON_SIZE_MENU);
        gtk.Widget.set_size_request (button, w + 4, h + 4);
        image.show()
        iconBox.pack_start(image, True, False, 0)
        button.add(iconBox)
        iconBox.show()
        return 
    
    # Remove a page from the notebook
    def remove_tab(self, button, data):
        (nb, text) = data
        page = -1
        #print "\n remove_tab: start", text
        for i, tab in enumerate(self.nb_tabs):
            if text == tab:
                page = i
        #print "   page =", page
        if page >= 0 and page < self.nb.get_n_pages():
            #print "   removing page", page
            del self.nb_tabs[page]
            nb.remove_page(page)
        # Need to refresh the widget -- 
        # This forces the widget to redraw itself.
        #nb.queue_draw_area(0,0,-1,-1) needed or not??

    def delete_event(self, widget, event, data=None):
        return False

    def destroy(self, widget, data=None):
        self.quit(widget)

    def dia_about(self, widget, data=None):
        #self.warning_box("About FPDB:\n\nFPDB was originally created by a guy named Steffen, sometime in 2008, \nand is mostly worked on these days by people named Eratosthenes, s0rrow, _mt, EricBlade, sqlcoder, and other strange people.\n\n", "ABOUT FPDB")
        dia = gtk.AboutDialog()
        dia.set_name("FPDB")
        dia.set_version(VERSION)
        dia.set_copyright("2008-2009, Steffen, Eratosthenes, s0rrow, EricBlade, _mt, sqlcoder, and others")
        dia.set_comments("GTK AboutDialog comments here")
        dia.set_license("GPL v3")
        dia.set_website("http://fpdb.sourceforge.net/")
        dia.set_authors("Steffen, Eratosthenes, s0rrow, EricBlade, _mt, and others")
        dia.set_program_name("FPDB")
        dia.run()
        dia.destroy()

    def dia_preferences(self, widget, data=None):
        dia = gtk.Dialog("Preferences",
                         self.window,
                         gtk.DIALOG_MODAL | gtk.DIALOG_DESTROY_WITH_PARENT,
                         (gtk.STOCK_CANCEL, gtk.RESPONSE_REJECT,
                          gtk.STOCK_SAVE, gtk.RESPONSE_ACCEPT))
        dia.set_default_size(500, 500)
        prefs = GuiPrefs.GuiPrefs(self.config, self.window, dia.vbox)
        response = dia.run()
        if response == gtk.RESPONSE_ACCEPT:
            # save updated config
            self.config.save()
        dia.destroy()

    def dia_create_del_database(self, widget, data=None):
        self.warning_box("Unimplemented: Create/Delete Database")
        self.obtain_global_lock()
        self.release_global_lock()

    def dia_create_del_user(self, widget, data=None):
        self.warning_box("Unimplemented: Create/Delete user")
        self.obtain_global_lock()
        self.release_global_lock()

    def dia_database_stats(self, widget, data=None):
        self.warning_box("Unimplemented: Database Stats")

    def dia_delete_db_parts(self, widget, data=None):
        self.warning_box("Unimplemented: Delete Database Parts")
        self.obtain_global_lock()
        self.release_global_lock()

    def dia_edit_profile(self, widget=None, data=None, create_default=False, path=None):
        self.warning_box("Unimplemented: Edit Profile")
        self.obtain_global_lock()
        self.release_global_lock()

    def dia_export_db(self, widget, data=None):
        self.warning_box("Unimplemented: Export Database")
        self.obtain_global_lock()
        self.release_global_lock()

    def dia_get_db_root_credentials(self):
        """obtains db root credentials from user"""
        self.warning_box("Unimplemented: Get Root Database Credentials")
#        user, pw=None, None
#
#        dialog=gtk.Dialog(title="DB Credentials needed", parent=None, flags=0,
#                buttons=(gtk.STOCK_CANCEL,gtk.RESPONSE_CANCEL,"Connect and recreate",gtk.RESPONSE_OK))
#
#        label_warning1=gtk.Label("Please enter credentials for a database user for "+self.host+" that has permissions to create a database.")
#
#
#        label_user=gtk.Label("Username")
#        dialog.vbox.add(label_user)
#        label_user.show()
#
#        response=dialog.run()
#        dialog.destroy()
#        return (user, pw, response)

    def dia_import_db(self, widget, data=None):
        self.warning_box("Unimplemented: Import Database")
        self.obtain_global_lock()
        self.release_global_lock()

    def dia_licensing(self, widget, data=None):
        self.warning_box("Unimplemented: Licensing")

    def dia_load_profile(self, widget, data=None):
        """Dialogue to select a file to load a profile from"""
        if self.obtain_global_lock():  # returns true if successful
            #try:
            #    chooser = gtk.FileChooserDialog(title="Please select a profile file to load",
            #            action=gtk.FILE_CHOOSER_ACTION_OPEN,
            #            buttons=(gtk.STOCK_CANCEL,gtk.RESPONSE_CANCEL,gtk.STOCK_OPEN,gtk.RESPONSE_OK))
            #    chooser.set_filename(self.profile)

            #    response = chooser.run()
            #    chooser.destroy()
            #    if response == gtk.RESPONSE_OK:
            #        self.load_profile(chooser.get_filename())
            #    elif response == gtk.RESPONSE_CANCEL:
            #        print 'User cancelled loading profile'
            #except:
            #    pass
            #try:
            self.load_profile()
            #except:
            #    pass
            self.release_global_lock()

    def dia_recreate_tables(self, widget, data=None):
        """Dialogue that asks user to confirm that he wants to delete and recreate the tables"""
        if self.obtain_global_lock():  # returns true if successful

            #lock_released = False
            dia_confirm = gtk.MessageDialog(parent=None, flags=0, type=gtk.MESSAGE_WARNING,
                    buttons=(gtk.BUTTONS_YES_NO), message_format="Confirm deleting and recreating tables")
            diastring = "Please confirm that you want to (re-)create the tables. If there already are tables in the database " \
                        +self.db.database+" on "+self.db.host+" they will be deleted."
            dia_confirm.format_secondary_text(diastring)#todo: make above string with bold for db, host and deleted

            response = dia_confirm.run()
            dia_confirm.destroy()
            if response == gtk.RESPONSE_YES:
                #if self.db.backend == self.fdb_lock.fdb.MYSQL_INNODB:
                    # mysql requires locks on all tables or none - easier to release this lock
                    # than lock all the other tables
                    # ToDo: lock all other tables so that lock doesn't have to be released
                #    self.release_global_lock()
                #    lock_released = True
                self.db.recreate_tables()
                #else:
                    # for other dbs use same connection as holds global lock
                #    self.fdb_lock.fdb.recreate_tables()
            elif response == gtk.RESPONSE_NO:
                print 'User cancelled recreating tables'
            #if not lock_released:
            self.release_global_lock()

    def dia_recreate_hudcache(self, widget, data=None):
        if self.obtain_global_lock():
            self.dia_confirm = gtk.MessageDialog(parent=None, flags=0, type=gtk.MESSAGE_WARNING, buttons=(gtk.BUTTONS_YES_NO), message_format="Confirm recreating HUD cache")
            diastring = "Please confirm that you want to re-create the HUD cache."
            self.dia_confirm.format_secondary_text(diastring)

            hb = gtk.HBox(True, 1)
            self.start_date = gtk.Entry(max=12)
            self.start_date.set_text( self.db.get_hero_hudcache_start() )
            lbl = gtk.Label(" Hero's cache starts: ")
            btn = gtk.Button()
            btn.set_image(gtk.image_new_from_stock(gtk.STOCK_INDEX, gtk.ICON_SIZE_BUTTON))
            btn.connect('clicked', self.__calendar_dialog, self.start_date)

            hb.pack_start(lbl, expand=True, padding=3)
            hb.pack_start(self.start_date, expand=True, padding=2)
            hb.pack_start(btn, expand=False, padding=3)
            self.dia_confirm.vbox.add(hb)
            hb.show_all()

            response = self.dia_confirm.run()
            self.dia_confirm.destroy()
            if response == gtk.RESPONSE_YES:
                self.db.rebuild_hudcache( self.start_date.get_text() )
            elif response == gtk.RESPONSE_NO:
                print 'User cancelled rebuilding hud cache'

        self.release_global_lock()

    def __calendar_dialog(self, widget, entry):
        self.dia_confirm.set_modal(False)
        d = gtk.Window(gtk.WINDOW_TOPLEVEL)
        d.set_title('Pick a date')

        vb = gtk.VBox()
        cal = gtk.Calendar()
        vb.pack_start(cal, expand=False, padding=0)

        btn = gtk.Button('Done')
        btn.connect('clicked', self.__get_date, cal, entry, d)

        vb.pack_start(btn, expand=False, padding=4)

        d.add(vb)
        d.set_position(gtk.WIN_POS_MOUSE)
        d.show_all()

    def __get_dates(self):
        t1 = self.start_date.get_text()
        if t1 == '':
            t1 = '1970-01-01'
        return (t1)

    def __get_date(self, widget, calendar, entry, win):
        # year and day are correct, month is 0..11
        (year, month, day) = calendar.get_date()
        month += 1
        ds = '%04d-%02d-%02d' % (year, month, day)
        entry.set_text(ds)
        win.destroy()
        self.dia_confirm.set_modal(True)

    def dia_regression_test(self, widget, data=None):
        self.warning_box("Unimplemented: Regression Test")
        self.obtain_global_lock()
        self.release_global_lock()

    def dia_save_profile(self, widget, data=None):
        self.warning_box("Unimplemented: Save Profile (try saving a HUD layout, that should do it)")

    def diaSetupWizard(self, path):
        diaSetupWizard = gtk.Dialog(title="Fatal Error - Config File Missing", parent=None, flags=0, buttons=(gtk.STOCK_QUIT,gtk.RESPONSE_OK))

        label = gtk.Label("Please copy the config file from the docs folder to:")
        diaSetupWizard.vbox.add(label)
        label.show()

        label = gtk.Label(path)
        diaSetupWizard.vbox.add(label)
        label.show()

        label = gtk.Label("and edit it according to the install documentation at http://fpdb.sourceforge.net")
        diaSetupWizard.vbox.add(label)
        label.show()

        response = diaSetupWizard.run()
        sys.exit(1)

    def get_menu(self, window):
        """returns the menu for this program"""
        fpdbmenu = """
            <ui>
              <menubar name="MenuBar">
                <menu action="main">
                  <menuitem action="LoadProf"/>
                  <menuitem action="EditProf"/>
                  <menuitem action="SaveProf"/>
                  <menuitem action="Preferences"/>
                  <separator/>
                  <menuitem action="Quit"/>
                </menu>
                <menu action="import">
                  <menuitem action="sethharchive"/>
                  <menuitem action="bulkimp"/>
                  <menuitem action="autoimp"/>
                  <menuitem action="autorate"/>
                </menu>
                <menu action="viewers">
                  <menuitem action="autoimp"/>
                  <menuitem action="graphs"/>
                  <menuitem action="handreplay"/>
                  <menuitem action="playerdetails"/>
                  <menuitem action="playerstats"/>
                  <menuitem action="posnstats"/>
                  <menuitem action="sessionstats"/>
                  <menuitem action="sessionreplay"/>
                  <menuitem action="tableviewer"/>
                </menu>
                <menu action="database">
                  <menuitem action="createdb"/>
                  <menuitem action="createuser"/>
                  <menuitem action="createtabs"/>
                  <menuitem action="rebuildhudcache"/>
                  <menuitem action="stats"/>
                </menu>
                <menu action="help">
                  <menuitem action="Abbrev"/>
                  <separator/>
                  <menuitem action="About"/>
                  <menuitem action="License"/>
                </menu>
              </menubar>
            </ui>"""

        uimanager = gtk.UIManager()
        accel_group = uimanager.get_accel_group()
        actiongroup = gtk.ActionGroup('UIManagerExample')

        # Create actions
        actiongroup.add_actions([('main', None, '_Main'),
                                 ('Quit', gtk.STOCK_QUIT, '_Quit', None, 'Quit the Program', self.quit),
                                 ('LoadProf', None, '_Load Profile (broken)', '<control>L', 'Load your profile', self.dia_load_profile),
                                 ('EditProf', None, '_Edit Profile (todo)', '<control>E', 'Edit your profile', self.dia_edit_profile),
                                 ('SaveProf', None, '_Save Profile (todo)', '<control>S', 'Save your profile', self.dia_save_profile),
                                 ('Preferences', None, '_Preferences', None, 'Edit your preferences', self.dia_preferences),
                                 ('import', None, '_Import'),
                                 ('sethharchive', None, '_Set HandHistory Archive Directory', None, 'Set HandHistory Archive Directory', self.select_hhArchiveBase),
                                 ('bulkimp', None, '_Bulk Import', '<control>B', 'Bulk Import', self.tab_bulk_import),
                                 ('autorate', None, 'Auto _Rating (todo)', '<control>R', 'Auto Rating (todo)', self.not_implemented),
                                 ('viewers', None, '_Viewers'),
                                 ('autoimp', None, '_Auto Import and HUD', '<control>A', 'Auto Import and HUD', self.tab_auto_import),
                                 ('graphs', None, '_Graphs', '<control>G', 'Graphs', self.tabGraphViewer),
                                 ('handreplay', None, 'Hand _Replayer (todo)', None, 'Hand Replayer (todo)', self.not_implemented),
                                 ('playerdetails', None, 'Player _Details (todo)', None, 'Player Details (todo)', self.not_implemented),
                                 ('playerstats', None, '_Player Stats (tabulated view)', '<control>P', 'Player Stats (tabulated view)', self.tab_player_stats),
                                 ('posnstats', None, 'P_ositional Stats (tabulated view)', '<control>O', 'Positional Stats (tabulated view)', self.tab_positional_stats),
                                 ('sessionstats', None, 'Session Stats', None, 'Session Stats', self.tab_session_stats),
                                 ('sessionreplay', None, '_Session Replayer (todo)', None, 'Session Replayer (todo)', self.not_implemented),
                                 ('tableviewer', None, 'Poker_table Viewer (mostly obselete)', None, 'Poker_table Viewer (mostly obselete)', self.tab_table_viewer),
                                 ('database', None, '_Database'),
                                 ('createdb', None, 'Create or Delete _Database (todo)', None, 'Create or Delete Database', self.dia_create_del_database),
                                 ('createuser', None, 'Create or Delete _User (todo)', None, 'Create or Delete User', self.dia_create_del_user),
                                 ('createtabs', None, 'Create or Recreate _Tables', None, 'Create or Recreate Tables ', self.dia_recreate_tables),
                                 ('rebuildhudcache', None, 'Rebuild HUD Cache', None, 'Rebuild HUD Cache', self.dia_recreate_hudcache),
                                 ('stats', None, '_Statistics (todo)', None, 'View Database Statistics', self.dia_database_stats),
                                 ('help', None, '_Help'),
                                 ('Abbrev', None, '_Abbrevations (todo)', None, 'List of Abbrevations', self.tab_abbreviations),
                                 ('About', None, 'A_bout', None, 'About the program', self.dia_about),
                                 ('License', None, '_License and Copying (todo)', None, 'License and Copying', self.dia_licensing),
                                ])
        actiongroup.get_action('Quit').set_property('short-label', '_Quit')

        uimanager.insert_action_group(actiongroup, 0)
        merge_id = uimanager.add_ui_from_string(fpdbmenu)

        # Create a MenuBar
        menubar = uimanager.get_widget('/MenuBar')
        window.add_accel_group(accel_group)
        return menubar

    def load_profile(self):
        """Loads profile from the provided path name."""
        self.config = Configuration.Config(file=options.config, dbname=options.dbname)
        self.settings = {}
        self.settings['global_lock'] = self.lock
        if (os.sep=="/"):
            self.settings['os']="linuxmac"
        else:
            self.settings['os']="windows"

        self.settings.update({'cl_options': cl_options})
        self.settings.update(self.config.get_db_parameters())
        self.settings.update(self.config.get_tv_parameters())
        self.settings.update(self.config.get_import_parameters())
        self.settings.update(self.config.get_default_paths())

        if self.db is not None and self.db.fdb is not None:
            self.db.disconnect()

        self.sql = SQL.Sql(db_server = self.settings['db-server'])
        try:
            self.db = Database.Database(self.config, sql = self.sql)
        except Exceptions.FpdbMySQLAccessDenied:
            self.warning_box("MySQL Server reports: Access denied. Are your permissions set correctly?")
            exit()
        except Exceptions.FpdbMySQLNoDatabase:
            msg = "MySQL client reports: 2002 error. Unable to connect - Please check that the MySQL service has been started"
            self.warning_box(msg)
            exit

#        except FpdbMySQLFailedError:
#            self.warning_box("Unable to connect to MySQL! Is the MySQL server running?!", "FPDB ERROR")
#            exit()
#        except FpdbError:
#            #print "Failed to connect to %s database with username %s." % (self.settings['db-server'], self.settings['db-user'])
#            self.warning_box("Failed to connect to %s database with username %s." % (self.settings['db-server'], self.settings['db-user']), "FPDB ERROR")
#            err = traceback.extract_tb(sys.exc_info()[2])[-1]
#            print "*** Error: " + err[2] + "(" + str(err[1]) + "): " + str(sys.exc_info()[1])
#            sys.stderr.write("Failed to connect to %s database with username %s." % (self.settings['db-server'], self.settings['db-user']))
#        except:
#            #print "Failed to connect to %s database with username %s." % (self.settings['db-server'], self.settings['db-user'])
#            self.warning_box("Failed to connect to %s database with username %s." % (self.settings['db-server'], self.settings['db-user']), "FPDB ERROR")
#            err = traceback.extract_tb(sys.exc_info()[2])[-1]
#            print "*** Error: " + err[2] + "(" + str(err[1]) + "): " + str(sys.exc_info()[1])
#            sys.stderr.write("Failed to connect to %s database with username %s." % (self.settings['db-server'], self.settings['db-user']))

        if self.db.wrongDbVersion:
            diaDbVersionWarning = gtk.Dialog(title="Strong Warning - Invalid database version", parent=None, flags=0, buttons=(gtk.STOCK_OK,gtk.RESPONSE_OK))

            label = gtk.Label("An invalid DB version or missing tables have been detected.")
            diaDbVersionWarning.vbox.add(label)
            label.show()

            label = gtk.Label("This error is not necessarily fatal but it is strongly recommended that you recreate the tables by using the Database menu.")
            diaDbVersionWarning.vbox.add(label)
            label.show()

            label = gtk.Label("Not doing this will likely lead to misbehaviour including fpdb crashes, corrupt data etc.")
            diaDbVersionWarning.vbox.add(label)
            label.show()

            response = diaDbVersionWarning.run()
            diaDbVersionWarning.destroy()

        if self.status_bar is None:
            self.status_bar = gtk.Label("Status: Connected to %s database named %s on host %s"%(self.db.get_backend_name(),self.db.database, self.db.host))
            self.main_vbox.pack_end(self.status_bar, False, True, 0)
            self.status_bar.show()
        else:
            self.status_bar.set_text("Status: Connected to %s database named %s on host %s" % (self.db.get_backend_name(),self.db.database, self.db.host))

        # Database connected to successfully, load queries to pass on to other classes
        self.db.rollback()

        self.validate_config()

    def not_implemented(self, widget, data=None):
        self.warning_box("Unimplemented menu entry")

    def obtain_global_lock(self):
        ret = self.lock.acquire(False) # will return false if lock is already held
        if ret:
            print "\nGlobal lock taken ..."
        else:
            print "\nFailed to get global lock."
        return ret
        # need to release it later:
        # self.lock.release()

    def quit(self, widget, data=None):
        # TODO: can we get some / all of the stuff done in this function to execute on any kind of abort?
        print "Quitting normally"
        # TODO: check if current settings differ from profile, if so offer to save or abort
        self.db.disconnect()
        self.statusIcon.set_visible(False)
        gtk.main_quit()

    def release_global_lock(self):
        self.lock.release()
        print "Global lock released.\n"

    def tab_abbreviations(self, widget, data=None):
        print "todo: implement tab_abbreviations"

    def tab_auto_import(self, widget, data=None):
        """opens the auto import tab"""
        new_aimp_thread = GuiAutoImport.GuiAutoImport(self.settings, self.config, self.sql)
        self.threads.append(new_aimp_thread)
        aimp_tab=new_aimp_thread.get_vbox()
        self.add_and_display_tab(aimp_tab, "Auto Import")

    def tab_bulk_import(self, widget, data=None):
        """opens a tab for bulk importing"""
        #print "start of tab_bulk_import"
        new_import_thread = GuiBulkImport.GuiBulkImport(self.settings, self.config, self.sql)
        self.threads.append(new_import_thread)
        bulk_tab=new_import_thread.get_vbox()
        self.add_and_display_tab(bulk_tab, "Bulk Import")

    def tab_player_stats(self, widget, data=None):
        new_ps_thread = GuiPlayerStats.GuiPlayerStats(self.config, self.sql, self.window)
        self.threads.append(new_ps_thread)
        ps_tab=new_ps_thread.get_vbox()
        self.add_and_display_tab(ps_tab, "Player Stats")

    def tab_positional_stats(self, widget, data=None):
        new_ps_thread = GuiPositionalStats.GuiPositionalStats(self.config, self.sql)
        self.threads.append(new_ps_thread)
        ps_tab=new_ps_thread.get_vbox()
        self.add_and_display_tab(ps_tab, "Positional Stats")

    def tab_session_stats(self, widget, data=None):
        new_ps_thread = GuiSessionViewer.GuiSessionViewer(self.config, self.sql, self.window)
        self.threads.append(new_ps_thread)
        ps_tab=new_ps_thread.get_vbox()
        self.add_and_display_tab(ps_tab, "Session Stats")

    def tab_main_help(self, widget, data=None):
        """Displays a tab with the main fpdb help screen"""
        mh_tab=gtk.Label("""Welcome to Fpdb!
For documentation please visit our website at http://fpdb.sourceforge.net/ or check the docs directory in the fpdb folder.
Please note that default.conf is no longer needed nor used, all configuration now happens in HUD_config.xml
This program is licensed under the AGPL3, see docs"""+os.sep+"agpl-3.0.txt")
        self.add_and_display_tab(mh_tab, "Help")

    def tab_table_viewer(self, widget, data=None):
        """opens a table viewer tab"""
        new_tv_thread = GuiTableViewer.GuiTableViewer(self.db, self.settings, self.config)
        self.threads.append(new_tv_thread)
        tv_tab = new_tv_thread.get_vbox()
        self.add_and_display_tab(tv_tab, "Table Viewer")

    def tabGraphViewer(self, widget, data=None):
        """opens a graph viewer tab"""
        new_gv_thread = GuiGraphViewer.GuiGraphViewer(self.sql, self.config)
        self.threads.append(new_gv_thread)
        gv_tab = new_gv_thread.get_vbox()
        self.add_and_display_tab(gv_tab, "Graphs")

    def __init__(self):
        self.threads = []
        # no more than 1 process can this lock at a time:
        self.lock = interlocks.InterProcessLock(name="fpdb_global_lock")
        self.db = None
        self.status_bar = None

        self.window = gtk.Window(gtk.WINDOW_TOPLEVEL)
        self.window.connect("delete_event", self.delete_event)
        self.window.connect("destroy", self.destroy)
        self.window.set_title("Free Poker DB - v%s or higher" % (VERSION, ))
        self.window.set_border_width(1)
        self.window.set_default_size(900,720)
        self.window.set_resizable(True)

        self.main_vbox = gtk.VBox(False, 1)
        self.main_vbox.set_border_width(1)
        self.window.add(self.main_vbox)
        self.main_vbox.show()

        menubar = self.get_menu(self.window)
        self.main_vbox.pack_start(menubar, False, True, 0)
        menubar.show()
        #done menubar

        self.nb = gtk.Notebook()
        self.nb.set_show_tabs(True)
        self.nb.show()
        self.main_vbox.pack_start(self.nb, True, True, 0)
        self.pages=[]
        self.tabs=[]
        self.tab_names=[]
        self.nb_tabs=[]

        self.tab_main_help(None, None)

        self.window.show()
        self.load_profile()

        self.statusIcon = gtk.StatusIcon()
        if os.path.exists('../gfx/fpdb-cards.png'):
            self.statusIcon.set_from_file('../gfx/fpdb-cards.png')
        elif os.path.exists('/usr/share/pixmaps/fpdb-cards.png'):
            self.statusIcon.set_from_file('/usr/share/pixmaps/fpdb-cards.png')
        else:
            self.statusIcon.set_from_stock(gtk.STOCK_HOME)
        self.statusIcon.set_tooltip("Free Poker Database")
        self.statusIcon.connect('activate', self.statusicon_activate)
        self.statusMenu = gtk.Menu()
        menuItem = gtk.ImageMenuItem(gtk.STOCK_ABOUT)
        menuItem.connect('activate', self.dia_about)
        self.statusMenu.append(menuItem)
        menuItem = gtk.ImageMenuItem(gtk.STOCK_QUIT)
        menuItem.connect('activate', self.quit)
        self.statusMenu.append(menuItem)
        self.statusIcon.connect('popup-menu', self.statusicon_menu, self.statusMenu)
        self.statusIcon.set_visible(True)

        self.window.connect('window-state-event', self.window_state_event_cb)
        sys.stderr.write("fpdb starting ...")

    def window_state_event_cb(self, window, event):
        print "window_state_event", event
        if event.changed_mask & gtk.gdk.WINDOW_STATE_ICONIFIED:
            # -20 = GWL_EXSTYLE can't find it in the pywin32 libs
            #bits = win32api.GetWindowLong(self.window.window.handle, -20)
            #bits = bits ^ (win32con.WS_EX_TOOLWINDOW | win32con.WS_EX_APPWINDOW)

            #win32api.SetWindowLong(self.window.window.handle, -20, bits)

            if event.new_window_state & gtk.gdk.WINDOW_STATE_ICONIFIED:
                self.window.hide()
                self.window.set_skip_taskbar_hint(True)
                self.window.set_skip_pager_hint(True)
            else:
                self.window.set_skip_taskbar_hint(False)
                self.window.set_skip_pager_hint(False)
        # Tell GTK not to propagate this signal any further
        return True

    def statusicon_menu(self, widget, button, time, data = None):
        # we don't need to pass data here, since we do keep track of most all
        # our variables .. the example code that i looked at for this
        # didn't use any long scope variables.. which might be an alright
        # idea too sometime
        if button == 3:
            if data:
                data.show_all()
                data.popup(None, None, None, 3, time)
        pass

    def statusicon_activate(self, widget, data = None):
        # Let's allow the tray icon to toggle window visibility, the way
        # most other apps work
        shown = self.window.get_property('visible')
        if shown:
            self.window.hide()
        else:
            self.window.show()
            self.window.present()

    def warning_box(self, str, diatitle="FPDB WARNING"):
            diaWarning = gtk.Dialog(title=diatitle, parent=None, flags=0, buttons=(gtk.STOCK_OK,gtk.RESPONSE_OK))

            label = gtk.Label(str)
            diaWarning.vbox.add(label)
            label.show()

            response = diaWarning.run()
            diaWarning.destroy()
            return response

    def validate_config(self):
        hhbase    = self.config.get_import_parameters().get("hhArchiveBase")
        hhbase    = os.path.expanduser(hhbase)
        #hhdir     = os.path.join(hhbase,site)
        hhdir       = hhbase
        if not os.path.isdir(hhdir):
            diapath = gtk.MessageDialog(parent=None, flags=0, type=gtk.MESSAGE_WARNING, buttons=(gtk.BUTTONS_YES_NO), message_format="Setup hh dir")
            diastring = "WARNING: Unable to find output hh directory %s\n\n Press YES to create this directory, or NO to select a new one." % hhdir
            diapath.format_secondary_text(diastring)
            response = diapath.run()
            diapath.destroy()
            if response == gtk.RESPONSE_YES:
                try:
                    os.makedirs(hhdir)
                except:
                    self.warning_box("WARNING: Unable to create hand output directory. Importing is not likely to work until this is fixed.")
            elif response == gtk.RESPONSE_NO:
               self.select_hhArchiveBase()

    def select_hhArchiveBase(self, widget=None):
        fc = gtk.FileChooserDialog(title="Select HH Output Directory", parent=None, action=gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER, buttons=(gtk.STOCK_OPEN,gtk.RESPONSE_OK), backend=None)
        fc.run()
        # TODO: We need to put in a Cancel button, and handle if the user presses that or the "Close" box without selecting anything as a cancel, and return to the prior setting
        #self.warning_box("You selected %s" % fc.get_filename())
        self.config.set_hhArchiveBase(fc.get_filename())
        self.config.save()
        self.load_profile() # we can't do this at the end of this func because load_profile calls this func
        fc.destroy() # TODO: loop this to make sure we get valid data back from it, because the open directory thing in GTK lets you select files and not select things and other stupid bullshit

    def main(self):
        gtk.main()
        return 0

if __name__ == "__main__":
    me = fpdb()
    me.main()