Newer
Older
twander / twander.py
#!/usr/bin/env python
# twander - Wander around the file system
# Copyright (c) 2002 TundraWare Inc.  All Rights Reserved.


PROGNAME = "twander"
RCSID = "$Id: twander.py,v 1.48 2002/11/13 23:17:16 tundra Exp $"
VERSION = RCSID.split()[2]


#----------------------------------------------------------#
#                     Imports                              #
#----------------------------------------------------------#

from Tkinter import *
import getopt
import os
import sys

#----------------------------------------------------------#
#          Variables User Might Change                     #
#----------------------------------------------------------#

#####
# Defaults
#####

# Configuration file

CONF   = os.path.join(os.getenv("HOME"), # Name of default config file
                      "." +
                      PROGNAME
                      )

# Initial Dimensions

HEIGHT = 25
WIDTH  = 60

# Starting directory

ROOTDIR = "." + os.sep

# Colors
BCOLOR  = "black"
FCOLOR  = "green"

# Fonts

FNAME = "Courier"
FSZ   = 12
FWT   = "bold"

# Warnings

WARN = TRUE


#------------------- Nothing Below Here Should Need Changing ------------------#


#----------------------------------------------------------#
#               Aliases & Redefinitions                    #
#----------------------------------------------------------#



#----------------------------------------------------------#
#              Constants & Literals                        #
#----------------------------------------------------------#



#####
# Booleans
#####

# Don't need to define TRUE & FALSE - they are defined in the Tkinter module

#####
# Constants
#####


#####
# General Literals
#####

DIR_LDELIM = '['              # Directory left dsply. delimiter
DIR_RDELIM = ']'              # Directory left dsply. delimiter
PSEP       = os.sep           # Character separating path components


#####
# Configuration File Related Literals
#####

CMDKEY     = r'&'             # Command key delimiter
COMMENT    = r"#"             # Comment character
DIRNAME    = r'[DIRECTORY]'   # Substitution field in config files
FILENAME   = r'[FILE]'        # Substitution field in config files
ENVIRO     = r'$'             # Introduces environment variables


#----------------------------------------------------------#
#            Prompts, & Application Strings                #
#----------------------------------------------------------#


#####
# Error & Warning  Messages
#####

eBADROOT = " %s Is Not A Directory"
eDIRRD   = "Cannot Open Directory : %s  ---  Check Permissions."
eDUPKEY  = "Duplicate Key In Configuration File Found In Entry: \'%s\'"
eERROR   = "ERROR"
eNOCONF  = "Cannot Find Configuration File: %s"
eNOENV   = "Configuration File References Undefined Environment Variable: %s"
eOPEN    = "Cannot Open File: %s"
eTOOMANY = "You Can Only Specify One Starting Directory."

wCMDKEY  = "Configuration File Entry For: \'%s\' Has No Command Key Defined."
wWARN    = "WARNING"


#####
# Informational Messages
#####



#####
# Usage Prompts
#####

uTable = [PROGNAME + " " + VERSION + " - Copyright 2002, TundraWare Inc., All Rights Reserved\n",
          "usage:  " + PROGNAME + " [-bcfhnsvwxy] [startdir] where,\n",
          "          startdir  name of directory in which to begin (default: current dir)",
          "          -b color  background color (default: black)",
          "          -c file   name of configuration file (default: " + CONF + ")",
          "          -f color  foreground color (default: green)",
          "          -h        print this help information",
          "          -n name   name of font to use (default: courier)",
          "          -q        quiet mode - no warnings (default: warnings on)",
          "          -s size   size of font to use (default: 12)",
          "          -v        print detailed version information",
          "          -w wght   weight/style of font to use (default: bold)",
          "          -x width  window width (default: 60)",
          "          -y height window height (default: 25)",
          ]


#####
# Prompts
#####



#----------------------------------------------------------#
#        Global Variables & Data Structures                #
#----------------------------------------------------------#


LASTDIR      = []
STARTDIR     = ""

#---------------------------Code Begins Here----------------------------------#


#----------------------------------------------------------#
#           Object Base Class Definitions                  #
#----------------------------------------------------------#


#----------------------------------------------------------#
#           Supporting Function Definitions                #
#----------------------------------------------------------#

#####
# Return Ordered List Of Directories & Files For Current Root
#####

def BuildDirList(ROOTDIR):

    dList, fList = [], []
    
    # Walk the directory separate subdirs and files
    try:
        for file in os.listdir(ROOTDIR):
            if os.path.isdir(os.path.join(ROOTDIR,file)):
                dList.append(DIR_LDELIM + file + DIR_RDELIM)
            else:
                fList.append(file)
    except:
        ErrMsg(eDIRRD % ROOTDIR)

    dList.sort()

    # Entry to move up one directory is always first,
    # no matter what the sort.  This is necessary because
    # OSs like Win32 like to use '$' in file names  which
    # sorts before "."

    if ROOTDIR != os.path.abspath(PSEP):
        dList.insert(0, DIR_LDELIM + ".." + DIR_RDELIM)

    fList.sort()
    return dList + fList

# End of  'BuildDirList()'


#####
# Print An Error Message
#####

def ErrMsg(emsg):
    print PROGNAME + " " + VERSION + " " + eERROR + ": " + emsg

# End of 'ErrMsg()'


#####
# Get Directory Of Current ROOTDIR And Load Into UI
#####

def LoadDirList(newdir, save=TRUE):
    global LASTDIR, ROOTDIR
    
    # Canonicalize the current directory name
    newdir = os.path.abspath(newdir)

    # Push last directory visited onto the visited stack
    # Do not do this if we've been told not to OR if
    # what we're about to save is the same as the top
    # of the stack
    
    # If there is anything on the stack, see if last element
    # matches what we're about to put there.
    
    if LASTDIR:
        if LASTDIR[-1] == ROOTDIR:
            save = FALSE
    if save:
        LASTDIR.append(ROOTDIR)

    # And select new directory to visit
    ROOTDIR = newdir

    # And make sure it ends with a path separator character
    if ROOTDIR[-1] != PSEP:
        ROOTDIR = ROOTDIR + PSEP

    # Update the widget
    UpdateDirList()

# End of 'LoadDirList():


#####
# Update/Redraw Directory Listing
#####

def UpdateDirList():

    # Clear out the old contents
    UI.DirList.delete(0,END)

    # Load new directory contents into UI
    for x in BuildDirList(ROOTDIR):
        UI.DirList.insert(END, x)

# End of 'UpdateDirList()'


#####
# Parse & Process The Configuraton File
#####

def ParseRC():

    try:
        cf = open(CONF)
    except:
        ErrMsg(eOPEN % CONF)
        sys.exit(1)

    # Process and massage the configuration file
    for line in cf.read().splitlines():

        # Lex for comment token and discard until EOL
        # A line beginning with the comment token is thus
        # turned into a blank line, which is discarded.

        idx = line.find(COMMENT)
        if idx > -1:             # found a comment character
            line = line[:idx]

        # Anything which gets through the next conditional
        # must be a non-blank line - i.e., Configuration information
        # we care about, so process it and save for future use.

        if line != "":
            fields = line.split()
            for x in range(1,len(fields)):

                # Process environment variables
                if fields[x][0] == ENVIRO:
                    envval = os.getenv(fields[x][1:])
                    if not envval:       # Environment variable not defined
                        ErrMsg(eNOENV % fields[x])
                        sys.exit(1)
                    else:
                        fields[x] = envval

            # Get command key value and store in dictionary

            keypos = fields[0].find(CMDKEY) # Look for key delimiter

            # No delimiter or delimiter at end of string
            if (keypos < 0) or (CMDKEY == fields[0][-1]):
                WrnMsg(wCMDKEY % fields[0])
                key = fields[0]             # Use whole word as index

            # Found legit delimiter, so use it as
            # dictionary index - mapped to lower case so
            # command keys are case insensitive.
            else:
                key = fields[0][keypos+1].lower()

            if key in rcfile:               # This is a Python 2.2 or later idiom
                ErrMsg(eDUPKEY % fields[0]) # Duplicate key found
                cf.close()
                sys.exit(1)
                
            # Save command name and command using key as index
            rcfile[key] = ["".join(fields[0].split(CMDKEY)),
                           " ".join(fields[1:])
                          ]

    cf.close()

# End of 'ParseRC()'


#####
# Print Usage Information
#####

def Usage():
    for x in uTable:
        print x
        
# End of 'Usage()'


#####
# Print A Warning Message
#####

def WrnMsg(wmsg):
    if WARN:
	print PROGNAME + " " + VERSION + " " + wWARN + ": " + wmsg

# End of 'WrnMsg()'


#####
# Process Current Selection
#####

def DirListHandler(event):
    global ROOTDIR

    # Get current selection.  If none, just return, otherwise process
    selected =  UI.CurrentSelection()
    if not selected:
        return
    
    # If selection is a directory, move there and list contents.
    # We examine this by checking the string for the directory
    # delimiter characters previously inserted in BuildDirList()
    
    if selected[0] == DIR_LDELIM and selected[-1] == DIR_RDELIM:

        # Strip off delimiters to get real name
        selected = selected[1:-1]

        # Build full path name
        selected = os.path.join(os.path.abspath(ROOTDIR), selected)

        # Convert ending ".." into canonical path
        if selected.endswith(".."):
            selected = PSEP.join(selected.split(PSEP)[:-2])
        
        # Need to end the directory string with a path
        # separator character so that subsequent navigation
        # will work when we hit the root directory of the file
        # system.  In the case of Unix, this means that
        # if we ended up at the root directory, we'll just
        # get "/".  In the case of Win32, we will get
        # "DRIVE:/".

        selected += PSEP

        # Load UI with new directory
        LoadDirList(selected)

        # And always force selection of first item there.
        # This guarantees a selection in the new
        # directory context, so subsequent commands
        # won't try to operate on an item selected in a
        # previous directory
        
        UI.DirList.selection_set(('0',))

    # File selected
    else:
        pass

    # Update the window title
    UI.UpdateTitle(UIroot)

# End of 'DirListHandler()'


#----------------------------------------------------------#
#               GUI Classes And Handlers                   #
#----------------------------------------------------------#



#####
# Enacapsulate the UI in a class
#####


class twanderUI:

    def __init__(self, root):

        # Setup the visual elements

        self.hSB = Scrollbar(root, orient=HORIZONTAL)
        self.vSB = Scrollbar(root, orient=VERTICAL)
        self.DirList = Listbox(root,
                               foreground = FCOLOR,
                               background  = BCOLOR,
                               font = (FNAME, FSZ, FWT),
                               selectmode=SINGLE,
                               exportselection=0,
                               xscrollcommand=self.hSB.set,
                               yscrollcommand=self.vSB.set,
                               height = HEIGHT,
                               width = WIDTH,
                               )

        # Make them visible by packing
        
        self.hSB.config(command=self.DirList.xview)
        self.hSB.pack(side=BOTTOM, fill=X)
        self.vSB.config(command=self.DirList.yview)
        self.vSB.pack(side=RIGHT, fill=Y)
        self.DirList.pack(side=LEFT, fill=BOTH, expand=1)

        #####
        # Bind the relevant widget event handlers
        #####
        
        # We'll accept Single-Clicks as a selection
        self.DirList.bind('<ButtonRelease-1>', DirListHandler)

        # Bind the relevant root window handlers

        # Bind handler for "Up Dir"
        root.bind('<BackSpace>', KeyUpDir)

        # Bind handler for "Quit Program"
        root.bind('<Escape>', KeyQuitProg)

        # Bind handler for "Goto Starting Dir"
        root.bind('<Home>', KeyStartDir)

        # Bind handler for "Previous Dir"
        root.bind('<Control-Left>', KeyPrevDir)

        # Set up keystroke handler for application
        # These will be checked against the command
        # key definitions in the configuration file
        root.bind('<KeyPress>', KeystrokeHandler)

        # Bind handler for "Item Select"
        root.bind('<space>', DirListHandler)

        # Bind handler for "Refresh Dir Listing"
        root.bind('<Control-l>', RefreshDirList)

        self.DirList.focus()

        # End if method 'twanderUI.__init__()'


    #####
    # Support periodic polling to make sure widget stays
    # in sync with reality of current directory.
    #####

    def poll(self):

        RefreshDirList()
        self.DirList.after(1000, self.poll)

    # End of method 'twanderUI.poll()'


    #####
    # Return name of currently selected item
    #####

    def CurrentSelection(self):
        index = self.DirList.curselection()
        if index:
            return self.DirList.get(index)
        else:
            return ""

    # End of method 'twanderUI.CurrentSelection()'


    #####
    # Update title bar with most current information
    #####

    def UpdateTitle(self, mainwin):

        # Get current selection
        selected = self.CurrentSelection()

        # Only append selection if it is a file
        if selected[0] == DIR_LDELIM and selected[-1] == DIR_RDELIM:
            selected = ""

        # Update the titlebar
        mainwin.title(PROGNAME + " " + VERSION + "       " + ROOTDIR + selected)

    # End of method 'twanderUI.UpdateTitle()'

# End of class definition, 'twanderUI'


#####
# Refresh contents of directory listing to stay in sync with reality
#####

def RefreshDirList(*args):


    # Save current selection and active entry
    number = 0
    active=UI.DirList.index(ACTIVE)
    
    index = UI.DirList.curselection()
    if index:
        number = UI.DirList.index(index)

    LoadDirList(ROOTDIR, save=FALSE)

    
    # Restore current selection and active entry
    # Make sure they are still in range singe we
    # may have fewer items after the refresh.
    # If out of range, just set to last item in list
    
    maxindex =  UI.DirList.size() - 1

    if number > maxindex:
        number = maxindex
    if active >maxindex:
        active = maxindex
    
    UI.DirList.select_set(number)
    UI.DirList.see(number)
    UI.DirList.activate(active)

    # Update the window title
    UI.UpdateTitle(UIroot)

# End of 'RefreshDirList()


#####
# Event Handler For Backspace Key - Move up one directory
#####

def KeyUpDir(event):
    global ROOTDIR

    # Move up one directory level unless we're already at the root
    if ROOTDIR != os.path.abspath(PSEP):
        LoadDirList(ROOTDIR + "..")


# End of 'KeyUpDir()'


#####
# Event Handler For Esc Key - Program Quit
#####

def KeyQuitProg(event):
    sys.exit()

# End of 'KeyQuitProg()'


#####
# Event Handler For Left Arrow Key - Move To Previous Directory
#####

def KeyPrevDir(event):
    global LASTDIR

    # Move to last directory visited, if any - inhibit this from
    # being placed on the directory traversal stack
    if LASTDIR:
        LoadDirList(LASTDIR.pop(), save=FALSE)

    # No previous directory
    else:
        pass

# End of 'KeyPrevDir()'


#####
# Event Handler For Home Key - Go Back to Initial Directory
#####

def KeyStartDir(event):
    global ROOTDIR, STARTDIR
    
    LoadDirList(STARTDIR)

# End of 'KeyStartDir()'


#####
# Event Handler For Individual Keystrokes
#####

def KeystrokeHandler(event):

    # If the key pressed is a command key,
    # get its associated string and
    # execute the command.

    cmd = rcfile.get(event.char.lower(), ["",""])[1]

    # cmd == null means no matching command key -  do nothing
    # Otherwise, replace config tokens with actual file/dir names
    if cmd:

        # Replace runtime-determined tokens
        cmd = cmd.replace(FILENAME, UI.CurrentSelection())
        cmd = cmd.replace(DIRNAME, ROOTDIR)

        # Actually execute the command
        os.system(cmd)
    
# end of 'KeystrokeHandler()'
    

#----------------------------------------------------------#
#                  Program Entry Point                     #
#----------------------------------------------------------#

# Newline to make sure cursor of invoking window is
# at LHS in case we get errors or warnings.

print ""

# Command line processing

try:
    opts, args = getopt.getopt(sys.argv[1:], '-b:c:f:hn:qs:vw:x:y:')
except getopt.GetoptError:
    Usage()
    sys.exit(1)

# Parse command line

for opt, val in opts:
    if opt == "-b":
        BCOLOR = val
    if opt == "-c":
        CONF = val
    if opt == "-f":
        FCOLOR = val
    if opt == "-h":
        Usage()
        sys.exit(0)
    if opt == "-n":
        FNAME = val
    if opt == "-q":
        WARN = FALSE
    if opt == "-s":
        FSZ = val
    if opt == "-v":
        print RCSID
        sys.exit(0)
    if opt == "-w":
        FWT = val
    if opt == "-x":
        WIDTH = val
    if opt == "-y":
        HEIGHT = val


# Can only have 0 or 1 arguments
# Make sure any starting directory argument is legit

if len(args) > 1:
    ErrMsg(eTOOMANY)
    sys.exit(1)

if len(args) == 1:
    ROOTDIR = args[0]
    if not os.path.isdir(ROOTDIR):
        ErrMsg(eBADROOT % ROOTDIR)
        sys.exit(1)


# This program requires a config file

if not os.path.exists(CONF):
    ErrMsg(eNOCONF % CONF)
    sys.exit(1)

# Parse contents into dictionary

rcfile = {}
ParseRC()

# Create an instance of the UI
UIroot = Tk()
UI = twanderUI(UIroot)

# Canonicalize ROOTDIR
ROOTDIR = os.path.abspath(ROOTDIR) + PSEP

# Save the initial starting directory in case we want to return later
STARTDIR = ROOTDIR

# Initialize the UI directory listing
LoadDirList(ROOTDIR)

# And start the periodic polling of the widget
UI.poll()

# Run the program interface
UIroot.mainloop()