pySimReader.py

# Copyright (C) 2005, Todd Whiteman
#
# 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

#===============================================================================
#               F U N C T I O N A L   D E S C R I P T I O N
#===============================================================================
"""
pySIM application

Smartcard functions for PIN, phonebook and SMS management.
"""

#===============================================================================
#                            I M P O R T S
#===============================================================================

import wx
import wx.html as html_module
from traceback import print_exc

#import pySIMpcsc
import pySIMserial
import pySIMphonebook
import pySIMsms
import pySIMinfo
import pySIMpin
import pySIMlastnum
from pySIMskin import *
from pySIMutils import *
from pySIMconstants import *
import time
import logging

#####################################################################################
#               wx Identifiers for menus and button controls                        #
#####################################################################################

ID_MENU_FILE_EXIT = wx.NewId()
ID_MENU_PHONEBOOK_ADN = wx.NewId()
ID_MENU_PHONEBOOK_FDN = wx.NewId()
ID_MENU_LND = wx.NewId()
ID_MENU_SMS = wx.NewId()
ID_MENU_SIM_INFO = wx.NewId()
ID_MENU_SIM_PIN_CHANGE = wx.NewId()
ID_MENU_SIM_PIN_ENABLE = wx.NewId()
ID_MENU_SIM_PIN_DISABLE = wx.NewId()
ID_MENU_SIM_BACKUP = wx.NewId()
ID_MENU_SIM_RESTORE = wx.NewId()
ID_MENU_HELP_HELP = wx.NewId()
ID_MENU_HELP_ABOUT = wx.NewId()

ID_BUTTON_CONNECT = wx.NewId()
ID_BUTTON_PHONEBOOK = wx.NewId()
ID_BUTTON_SMS = wx.NewId()
ID_BUTTON_EXIT = wx.NewId()


#####################################################################################
#                 Setup logging for the pySIM application                           #
#####################################################################################

log = None

def initaliseLogger():
    global log
    log = logging.getLogger("pySimReader")
    #~ log.setLevel(logging.INFO)
    log.setLevel(logging.WARNING)
    # Define the handler and formmatter
    myLogHandler = logging.FileHandler("pySimReader.log", "w")
    # Attach the formatter to the handler and the handler to the log
    myLogHandler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)-5s : %(message)s", "%H:%M:%S"))
    log.addHandler(myLogHandler)
    log.info("Started pySimReader: %s" % (time.asctime()))


#####################################################################################
#     This class will be the main windows for the pySIM application                 #
#####################################################################################

class pySIM(wxskinFrame):
    def __init__(self, parent, ID, title, pos, size):
        wxskinFrame.__init__(self, parent, ID, title, pos, size)
        if pySIMserial.SerialError:
            pySIMmessage(self, "Couldnt open serial port", "Serial error")
            raise "Serial error"
        self.SIM = pySIMserial.Serialcontroller(self)
        self.createLayout()
        self.pb = None
        self.sms = None

    def createLayout(self):
        # A Statusbar in the bottom of the window
        self.statusBar = self.CreateStatusBar()
        self.createMenus()
        self.createFrames()
        #Disable some menus until we have the reader connected
        self.enableMenus(0)

    def createMenus(self):
        # Creating the menubar.
        menuBar = wx.MenuBar()

        # Setting up the 'File' menu.
        self.menuFile = wx.Menu()
        self.menuFile.Append(ID_MENU_FILE_EXIT, "E&xit"," Terminate this program")
        menuBar.Append(self.menuFile,"&File")

        # Setting up the 'Phonebook' menu.
        self.menuPhonebook = wx.Menu()
        self.menuPhonebook.Append(ID_MENU_PHONEBOOK_ADN, "Phonebook (ADN)"," Manage your phonebook (Abbreviated Dial Numbers)")
        self.menuPhonebook.Append(ID_MENU_PHONEBOOK_FDN, "Fixed Dialing Numbers (FDN)"," Manage your Fixed Dialing Numbers")
        self.menuPhonebook.Append(ID_MENU_LND, "Last # dialed (LND)"," Manage your Fixed Dialing Numbers")
        menuBar.Append(self.menuPhonebook,"&Phonebook")

        # Setting up the 'SMS' menu.
        self.menuMessages = wx.Menu()
        self.menuMessages.Append(ID_MENU_SMS, "SMS"," Manage your SMS messages")
        menuBar.Append(self.menuMessages,"&Messages")

        # Setting up the 'SIM' menu.
        self.menuSIM = wx.Menu()
        self.menuSIM.Append(ID_MENU_SIM_INFO, "SIM Information"," Information about your SIM card")
        self.menuSIM.AppendSeparator()
        self.menuSIM.Append(ID_MENU_SIM_PIN_CHANGE, "Change PIN"," Change your PIN code (CHV1)")
        self.menuSIM.Append(ID_MENU_SIM_PIN_ENABLE, "Enable PIN"," Prompt for PIN when turning on phone")
        self.menuSIM.Append(ID_MENU_SIM_PIN_DISABLE, "Disable PIN"," Remove the PIN prompt when turning on phone")
        #self.menuSIM.AppendSeparator()
        #self.menuSIM.Append(ID_MENU_SIM_BACKUP, "Backup"," Backup your SIM information")
        #self.menuSIM.Append(ID_MENU_SIM_RESTORE, "Restore"," Restore your SIM information from a previous backup")
        menuBar.Append(self.menuSIM, "&SIM")

        # Setting up the menu.
        self.menuHelp = wx.Menu()
        self.menuHelp.Append(ID_MENU_HELP_HELP, "&Help"," Help documentation")
        self.menuHelp.AppendSeparator()
        self.menuHelp.Append(ID_MENU_HELP_ABOUT, "&About"," Information about this program")
        menuBar.Append(self.menuHelp,"&Help")

        # Adding the MenuBar to the Frame content.
        self.SetMenuBar(menuBar)

        #Add the menu handlers
        wx.EVT_MENU(self, ID_MENU_FILE_EXIT, self.closeWindow)
        wx.EVT_MENU(self, ID_MENU_PHONEBOOK_ADN, self.buttonPhonebook)
        wx.EVT_MENU(self, ID_MENU_PHONEBOOK_FDN, self.buttonFDN)
        wx.EVT_MENU(self, ID_MENU_LND, self.buttonLND)
        wx.EVT_MENU(self, ID_MENU_SMS, self.buttonSMS)
        wx.EVT_MENU(self, ID_MENU_SIM_INFO, self.menuSIMInfo)
        wx.EVT_MENU(self, ID_MENU_SIM_PIN_CHANGE, self.menuChangePIN)
        wx.EVT_MENU(self, ID_MENU_SIM_PIN_ENABLE, self.menuEnablePIN)
        wx.EVT_MENU(self, ID_MENU_SIM_PIN_DISABLE, self.menuDisablePIN)
        wx.EVT_MENU(self, ID_MENU_HELP_HELP, self.menuHelpHelp)
        wx.EVT_MENU(self, ID_MENU_HELP_ABOUT, self.menuHelpAbout)

    def createFrames(self):
        # Create the layout component and add controls to it
        self.sizer1 = wx.BoxSizer(wx.HORIZONTAL)
        self.bConnect = wx.Button(self, ID_BUTTON_CONNECT, "Connect reader")
        self.sizer1.Add(self.bConnect, 1, wx.EXPAND|wx.ALL)

        self.sizer2 = wx.BoxSizer(wx.HORIZONTAL)
        self.bPhonebook = wx.Button(self, ID_BUTTON_PHONEBOOK, "Phonebook")
        self.bSMS = wx.Button(self, ID_BUTTON_SMS, "SMS")
        self.sizer2.Add(self.bPhonebook, 1, wx.EXPAND|wx.LEFT|wx.RIGHT, 5)
        self.sizer2.Add(self.bSMS, 1, wx.EXPAND|wx.LEFT|wx.RIGHT, 5)

        self.sizer3 = wx.BoxSizer(wx.HORIZONTAL)
        self.bExit = wx.Button(self, ID_BUTTON_EXIT, "Quit")

        self.sizer3.Add(self.bExit, 1, wx.EXPAND|wx.ALL)

        # Use sizers to set layout options
        self.sizer = wx.BoxSizer(wx.VERTICAL)
        self.sizer.Add(self.sizer1,1,wx.EXPAND|wx.LEFT|wx.RIGHT|wx.TOP,15)
        self.sizer.Add(self.sizer2,1,wx.EXPAND|wx.ALL,10)
        self.sizer.Add(self.sizer3,1,wx.EXPAND|wx.LEFT|wx.RIGHT|wx.BOTTOM,15)
        self.sizer.SetMinSize((250,150))

        # Layout for frame
        self.SetSizer(self.sizer)
        self.SetAutoLayout(1)
        self.sizer.Fit(self)

        # Add the button handlers
        wx.EVT_BUTTON(self, ID_BUTTON_CONNECT, self.buttonConnectReader)
        wx.EVT_BUTTON(self, ID_BUTTON_PHONEBOOK, self.buttonPhonebook)
        wx.EVT_BUTTON(self, ID_BUTTON_SMS, self.buttonSMS)
        wx.EVT_BUTTON(self, ID_BUTTON_EXIT, self.closeWindow)
        wx.EVT_CLOSE(self, self.closeWindow)

    def closeWindow(self, event):
        """Close the application"""
        if self.pb:
            self.pb.Close(True)
        if self.sms:
            self.sms.Close(True)
        self.Destroy()

    def menuHelpHelp(self, event):
        """Show help dialog"""
        dlg = wx.MessageDialog(self, 'Not Yet Implimented!', 'ToDo',
                             wx.OK | wx.ICON_INFORMATION)
        dlg.ShowModal()
        dlg.Destroy()


    aboutPySIM = """pySIM is a multifunctional SIM handling program.

    Phonebook:
      - Editing existing entries
      - Adding or deleting entries
      - Phonebook backup and restore
    SMS:
      - Reading SMS messages
      - SMS backup and restore


    Program Author:
      - Todd Whiteman
      - twhitema@gmail.com
      - http://twhiteman.netfirms.com/pySIM.html
"""
    aboutPySIMhtml = """<html><body>
    pySIM is a multifunctional SIM handling program.

    Phonebook:
      - Editing existing entries
      - Adding or deleting entries
      - Phonebook backup and restore
    SMS:
      - Reading SMS messages
      - SMS backup and restore


    Program Author:
      - Todd Whiteman
      - twhitema@gmail.com
      - <a href="http://twhiteman.netfirms.com/pySIM.html">pySIM Website</a>
    </body></html>
"""
    def menuHelpAbout(self, event):
        """Show about pySIM dialog"""
        dlg = wx.MessageDialog(self, self.aboutPySIM, 'About pySIM',
                             wx.OK | wx.ICON_INFORMATION)
        #~ ovr = html_module.HtmlWindow(dlg, -1, size=(400, 400))
        #~ ovr.SetPage(self.aboutPySIMhtml)
        dlg.ShowModal()
        dlg.Destroy()

    def buttonConnectReader(self, event):
        """Connect and disconnect the smartcard reader"""
        if self.SIM.getState() == SIM_STATE_DISCONNECTED:
            self.SIM.connectReader()
            if self.SIM.getState() == SIM_STATE_CONNECTED:
                self.statusBar.SetStatusText("Card reader connected.")
                self.bConnect.SetLabel("Disconnect reader")
                self.enableMenus(1)
        else:
            self.SIM.disconnectReader()
            if self.SIM.getState() == SIM_STATE_DISCONNECTED:
                self.statusBar.SetStatusText("Card reader disconnected.")
                self.bConnect.SetLabel("Connect reader")
                self.enableMenus(0)

    def buttonLND(self, event):
        """Display the phonebook window"""
        self.lnd = pySIMlastnum.LastNumber(self, self.SIM)
        self.lnd.showWindow()

    def buttonPhonebook(self, event):
        """Display the phonebook window"""
        self.pb = pySIMphonebook.Phonebook(self, self.SIM, pySIMphonebook.ADN_FILE_PATH)
        self.pb.showWindow()

    def buttonFDN(self, event):
        """Display the FDN phonebook window"""
        self.fdn = pySIMphonebook.Phonebook(self, self.SIM, pySIMphonebook.FDN_FILE_PATH)
        self.fdn.showWindow()
            
    def buttonSMS(self, event):
        """Display the SMS messages window"""
        self.sms = pySIMsms.SMS(self, self.SIM)
        self.sms.showWindow()

    def menuSIMInfo(self, event):
        """Display the SIM information dialog"""
        self.cp = pySIMinfo.pySIMInfo(self, self.SIM)
        self.cp.Show(1)

    def menuChangePIN(self, event):
        """Display the change PIN dialog"""
        self.cp = pySIMpin.ChangePin(self, self.SIM)
        self.cp.ShowModal()
        self.cp.Destroy()

    def menuEnablePIN(self, event):
        """Display the enable PIN dialog"""
        self.cp = pySIMpin.ChangePin(self, self.SIM)
        self.cp.ShowModal()
        self.cp.Destroy()
        self.enableMenus(1)

    def menuDisablePIN(self, event):
        """Remove the PIN verification"""
        try:
            self.SIM.gotoFile(["3F00"])
            if self.SIM.checkAndVerifyCHV1(CHV_ALWAYS):
                apdu = "A026000108%s" % ASCIIToPIN(self.SIM.chv1)
                self.SIM.sendAPDUmatchSW(apdu, SW_OK)
                self.SIM.chv1_enabled = 0
                self.SIM.chv1 = ''
                pySIMmessage(self, "PIN verification has been removed!", "PIN disable")
        except:
            print_exc()
            pySIMmessage(self, "Unable to disable your PIN!", "SIM card error")
        self.enableMenus(1)

    def enableMenus(self, val=1):
        """Enable or disable menu's and buttons"""
        self.menuPhonebook.Enable(ID_MENU_PHONEBOOK_ADN,val)
        self.menuPhonebook.Enable(ID_MENU_PHONEBOOK_FDN,0)
        self.menuPhonebook.Enable(ID_MENU_LND,val)
        if self.SIM.FDN_available:
            self.menuPhonebook.Enable(ID_MENU_PHONEBOOK_FDN,val)
        self.menuMessages.Enable(ID_MENU_SMS,val)
        self.menuSIM.Enable(ID_MENU_SIM_INFO,val)
        self.menuSIM.Enable(ID_MENU_SIM_PIN_ENABLE,0)
        self.menuSIM.Enable(ID_MENU_SIM_PIN_DISABLE,0)
        self.menuSIM.Enable(ID_MENU_SIM_PIN_CHANGE,0)
        if self.SIM.chv1_enabled:
            self.menuSIM.Enable(ID_MENU_SIM_PIN_DISABLE,val)
            self.menuSIM.Enable(ID_MENU_SIM_PIN_CHANGE,val)
        else:
            self.menuSIM.Enable(ID_MENU_SIM_PIN_ENABLE,val)
        #self.menuSIM.Enable(ID_MENU_SIM_BACKUP,val)
        #self.menuSIM.Enable(ID_MENU_SIM_RESTORE,val)
        self.bPhonebook.Enable(val)
        self.bSMS.Enable(val)

#####################################################################################
#----------------------------------------------------------------------
#####################################################################################

class pySIMApp(wx.App):
    """Class to control the WX application"""
    def OnInit(self):
        #print "hi!"
        frame = pySIM(None, -1, "pySIM", wx.DefaultPosition,(250,250) )
        frame.Show(True)
        # self.setTopWindow(frame)
        return True

#####################################################################################
#----------------------------------------------------------------------
#####################################################################################

if __name__ == '__main__':
    initaliseLogger()
    try:
        # create instance and start the event loop
        pySIMApp().MainLoop()
    except Exception, exc:
        #~ print_exc()
        log.exception(exc)