# -*- coding: utf-8 -*-
#
# Copyright (C) 2016 Dr. Robert C. Green II.
#
# This file is part of Combox.
#
# Combox 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 3 of the License, or
# (at your option) any later version.
#
# Combox 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 Combox (see COPYING). If not, see
# .
import os
import tkFileDialog
from os import path
from os.path import expanduser
from Tkinter import *
from combox.config import config_cb
#
# Adapted from:
# http://effbot.org/tkinterbook/tkinter-dialog-windows.htm
class ComboxConfigDialog(object):
"""ComboxConfigDialog(title=None, config_dir=path.join(expanduser("~"), '.combox')
Graphical interface combox configuration.
Uses :mod:`Tkinter`.
"""
def __init__(self, title=None,
config_dir=path.join(expanduser("~"), '.combox')):
self.root = Tk()
if title:
self.root.title(title)
self.config_dir = config_dir
self.result = None
self.body_frame = Frame(self.root)
self.initial_focus = self.body(self.body_frame)
self.body_frame.pack(padx=5, pady=5, fill=BOTH)
self.buttonbox()
self.statusbar()
# init. lists to store fields related to "node information".
self.node_path_labels = []
self.node_size_labels = []
self.node_path_entries = []
self.node_size_entries = []
self.root.grab_set()
if not self.initial_focus:
self.initial_focus = self.root
self.root.protocol("WM_DELETE_WINDOW", self.cancel)
self.center_it()
self.initial_focus.focus_set()
self.root.wait_window(self.root)
#
# construction hooks
# Adapted from:
# https://bbs.archlinux.org/viewtopic.php?id=149559
def center_it(self):
"""Center combox configuration dialog with respect to the screen.
"""
self.root.withdraw()
self.root.update_idletasks()
x = (self.root.winfo_screenwidth() - self.root.winfo_reqwidth()) / 2
y = (self.root.winfo_screenheight() - self.root.winfo_reqheight()) / 2
self.root.geometry("+%d+%d" % (x, y))
self.root.deiconify()
def body(self, master):
"""Populate the fields for the configuration diaglog.
:param Tkinter.Frame master:
It is :attr:`self.body_frame`.
"""
Label(master, text="name of this combox").grid(row=0, sticky=W)
Label(master, text="path to combox directory").grid(row=1, sticky=W)
Label(master, text="passphrase").grid(row=2, sticky=W)
Label(master, text="re-enter passphrase").grid(row=3, sticky=W)
Label(master, text="no. of nodes").grid(row=4, sticky=W)
self.cb_name_entry = Entry(master, width=40)
self.cb_dir_entry = Entry(master, width=40)
self.cb_pp_entry = Entry(master, width=40, show='*')
self.cb_rpp_entry = Entry(master, width=40, show='*')
self.cb_no_nodes_entry = Entry(master, width=40)
self.cb_name_entry.grid(row=0, column=1)
self.cb_dir_entry.grid(row=1, column=1, padx=5)
self.cb_pp_entry.grid(row=2, column=1)
self.cb_rpp_entry.grid(row=3, column=1)
self.cb_no_nodes_entry.grid(row=4, column=1)
self.cb_no_nodes_entry.bind("", self.populate_node_fields)
self.cb_dir_entry.bind("",
lambda e: self.create_askdirectory_button(
e.widget, e.widget.grid_info()['row']))
self.cb_dir_entry.bind("",
lambda e: self.destroy_askdirectory_button())
self.cb_rpp_entry.bind("",
lambda e: self.validate_passphrase())
return self.cb_name_entry # initial focus
#
# status bar methods start
#
# adapted from:
# http://effbot.org/tkinterbook/tkinter-application-windows.htm
def statusbar(self):
"""Initialize the status bar.
"""
# status bar
box = Frame(self.root)
box.pack(fill=BOTH)
self.status_bar = Label(box, bd=1, relief=SUNKEN, anchor=W)
self.status_bar.pack(fill=X)
def status_bar_set(self, format, *args):
"""Set status bar text.
:param str format:
`Formatted string`_.
:param tuple args:
Values for the formatted string.
.. _Formatted string: https://docs.python.org/2/library/stdtypes.html#string-formatting
"""
print type(args), args
self.status_bar.config(text=format % args)
self.status_bar.update_idletasks()
def status_bar_clear(self):
"""Clear status bar text.
"""
self.status_bar.config(text="")
self.status_bar.update_idletasks()
#
# status bar methods end
def buttonbox(self):
"""Initialize button box with "OK" and "Cancel" buttons.
"""
# add standard button box. override if you don't want the
# standard buttons
box = Frame(self.root)
box.pack(fill=BOTH)
w = Button(box, text="OK", width=10, command=self.ok, default=ACTIVE)
w.pack(side=LEFT, padx=5, pady=5)
w = Button(box, text="Cancel", width=10, command=self.cancel)
w.pack(side=LEFT, padx=5, pady=5)
self.root.bind("", self.ok)
self.root.bind("", self.cancel)
#
# standard button semantics
def ok(self, event=None):
"""Called when "OK" button or "" is hit.
"""
if not self.validate():
return
self.root.withdraw()
self.root.update_idletasks()
self.apply()
self.cancel()
def cancel(self, event=None):
"""Called when "Cancel" button or "" is hit.
It destroys the combox configuration dialog.
"""
#self.parent.focus_set()
self.root.destroy()
# command hooks
def validate_passphrase(self):
"""Check if the entered passphrase in "passphrase" and "re-enter passphrase" are the same.
:returns: `True` if the both passphrases match; `False` otherwise.
:rtype: bool
"""
if not (self.cb_pp_entry.get() == self.cb_rpp_entry.get()):
self.status_bar_set("%s", "passphrase don't match")
self.cb_pp_entry.focus_set()
return False
else:
self.status_bar_clear()
return True
def validate(self):
"""Validate all inputs.
:returns: `True` iff all inputs are sane and valid; `False`
otherwise.
:rtype: bool
"""
if not self.cb_name_entry.get():
self.status_bar_set("%s", "give this combox a name")
self.cb_name_entry.focus_set()
return False
elif not self.cb_dir_entry.get():
self.status_bar_set("%s", "give the path to combox directory")
self.cb_dir_entry.focus_set()
return False
elif not self.validate_passphrase():
return False
elif self.validate_passphrase():
# ok, check if passphrase is empty.
if not self.cb_pp_entry.get():
self.status_bar_set("%s", "give a passphrase")
self.cb_pp_entry.focus_set()
return False
# validate node information
try:
int(self.cb_no_nodes_entry.get())
except ValueError:
self.status_bar_set("%s", "Oops! You got to enter a number")
self.cb_no_nodes_entry.focus_set()
return False
no_nodes = int(self.cb_no_nodes_entry.get())
if no_nodes < 2:
self.status_bar_set("%s", "no. of nodes must be > 2")
self.cb_no_nodes_entry.focus_set()
return False
# validate node paths
for i in xrange(len(self.node_path_entries)):
if not self.node_path_entries[i].get():
self.status_bar_set("%s %d", "give the path for node", i)
self.node_path_entries[i].focus_set()
return False
# validate node sizes
for i in xrange(len(self.node_size_entries)):
if not self.node_size_entries[i].get():
self.status_bar_set("%s %d", "give the size of node", i)
self.node_size_entries[i].focus_set()
return False
# check if it is a number.
try:
int(self.node_size_entries[i].get())
except ValueError:
self.status_bar_set("%s %d %s", "the size of node", i,
"must be a number")
self.node_size_entries[i].focus_set()
return False
return True
def apply(self):
"""Write combox configuration to disk.
Uses :func:`~combox.config.config_cb`.
"""
combox_name = self.cb_name_entry.get()
combox_dir = self.cb_dir_entry.get()
no_nodes = self.cb_no_nodes_entry.get()
passp = self.cb_pp_entry.get()
config_info = [combox_name, combox_dir, '', no_nodes]
# get info about nodes.
for i in xrange(len(self.node_path_entries)):
config_info.append("node_%d" % i)
config_info.append(self.node_path_entries[i].get())
config_info.append(self.node_size_entries[i].get())
config_info_iter = iter(config_info)
def_input = lambda(x): next(config_info_iter)
def_pass = lambda: passp
config_cb(config_dir=self.config_dir,
pass_func=def_pass, input_func=def_input)
def create_askdirectory_button(self, entry, row):
"""Create a button, at `row`, that calls :func:`tkFileDialog.askdirectory`.
:param Tkinter.Entry entry:
The entry to which the directory path must be copied to.
:param int row:
The row number of the entry.
"""
self.ask_dir_btn = Button(self.body_frame, text="select directory",
command=lambda: self.askdirectory(entry))
self.ask_dir_btn.grid(row=row, column=2)
def destroy_askdirectory_button(self):
"""Destroy the button that calls :func:`tkFileDialog.askdirectory`.
"""
self.ask_dir_btn.destroy()
def askdirectory(self, entry):
"""Spawn a file dialog to read a directory for `entry`.
:param Tkinter.Entry entry:
The entry to which the directory path must be copied to.
"""
# first clear the entry
entry.delete(0, 'end')
# spawn dialog to choose directory.
dir_path = tkFileDialog.askdirectory()
entry.insert(0, dir_path)
def clear_node_info_fields(self):
"""Clear all fields related to "node information".
"""
for i in xrange(len(self.node_path_labels)):
self.node_path_labels[i].destroy()
self.node_path_entries[i].destroy()
self.node_size_labels[i].destroy()
self.node_size_entries[i].destroy()
self.node_path_labels = []
self.node_size_labels = []
self.node_path_entries = []
self.node_size_entries = []
def populate_node_fields(self, event):
"""Populate node fields.
"""
no_nodes_str = self.cb_no_nodes_entry.get()
if not no_nodes_str:
# do nothing.
return
no_nodes = 0
try:
no_nodes = int(no_nodes_str)
except ValueError:
self.status_bar_set("%s", "Oops! You got to enter a number")
self.cb_no_nodes_entry.focus_set()
return
# clear status bar
self.status_bar_clear()
# last occupied row number in self.body_frame.
last_occ_row = 4
if self.node_path_labels:
# means, we've already created fields related to "node
# information" before; get rid of 'em.
self.clear_node_info_fields()
for i in xrange(no_nodes):
node_path_str = 'node %d path' % i
node_size_str = 'node %d size (in mega bytes)' % i
lp = Label(self.body_frame,text=node_path_str)
lp.grid(row=last_occ_row + 1, sticky=W)
ls = Label(self.body_frame, text=node_size_str)
ls.grid(row=last_occ_row + 2, sticky=W)
self.node_path_labels.append(lp)
self.node_size_labels.append(ls)
ep = Entry(self.body_frame, width=40)
ep.grid(row=last_occ_row + 1, column=1, padx=5)
es = Entry(self.body_frame, width=40)
es.grid(row=last_occ_row + 2, column=1)
self.node_path_entries.append(ep)
self.node_size_entries.append(es)
self.node_path_entries[i].bind("",
lambda e: self.create_askdirectory_button(
e.widget,
e.widget.grid_info()['row']))
self.node_path_entries[i].bind("",
lambda e: self.destroy_askdirectory_button())
last_occ_row = last_occ_row + 2
#
# It is here for testing purposes only, will be removed in the future.
if __name__ == "__main__":
dialog = ComboxConfigDialog("combox configuration")