docker-offlineimap/offlineimap/head/offlineimap/ui/Tk.py

# Tk UI
# Copyright (C) 2002 John Goerzen
# <jgoerzen@complete.org>
#
#    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 Tkinter import *
import tkFont
from threading import *
import thread, traceback, time
from StringIO import StringIO
from ScrolledText import ScrolledText
from offlineimap import threadutil, version
from Queue import Queue
from UIBase import UIBase

class PasswordDialog:
    def __init__(self, accountname, config, master=None):
        self.top = Toplevel(master)
        self.top.title(version.productname + " Password Entry")
        self.label = Label(self.top,
                           text = "%s: Enter password for %s on %s: " % \
                           (accountname, config.get(accountname, "remoteuser"),
                            config.get(accountname, "remotehost")))
        self.label.pack()

        self.entry = Entry(self.top, show='*')
        self.entry.bind("<Return>", self.ok)
        self.entry.pack()
        self.entry.focus_force()

        self.button = Button(self.top, text = "OK", command=self.ok)
        self.button.pack()

        self.entry.focus_force()
        self.top.wait_window(self.label)

    def ok(self, args = None):
        self.password = self.entry.get()
        self.top.destroy()

    def getpassword(self):
        return self.password

class TextOKDialog:
    def __init__(self, title, message, blocking = 1, master = None):
        if not master:
            self.top = Tk()
        else:
            self.top = Toplevel(master)
        self.top.title(title)
        self.text = ScrolledText(self.top, font = "Courier 10")
        self.text.pack()
        self.text.insert(END, message)
        self.text['state'] = DISABLED
        self.button = Button(self.top, text = "OK", command=self.ok)
        self.button.pack()

        if blocking:
            self.top.wait_window(self.button)

    def ok(self):
        self.top.destroy()
        
                                 

class ThreadFrame(Frame):
    def __init__(self, master=None):
        self.threadextraframe = None
        self.thread = currentThread()
        self.threadid = thread.get_ident()
        Frame.__init__(self, master, relief = RIDGE, borderwidth = 2)
        self.pack(fill = 'x')
        self.threadlabel = Label(self, foreground = '#FF0000',
                                 text ="Thread %d (%s)" % (self.threadid,
                                                     self.thread.getName()))
        self.threadlabel.pack()
        self.setthread(currentThread())

        self.account = "Unknown"
        self.mailbox = "Unknown"
        self.loclabel = Label(self,
                              text = "Account/mailbox information unknown")
        #self.loclabel.pack()

        self.updateloclabel()

        self.message = Label(self, text="Messages will appear here.\n",
                             foreground = '#0000FF')
        self.message.pack(fill = 'x')

    def setthread(self, newthread):
        if newthread:
            self.threadlabel['text'] = newthread.getName()
        else:
            self.threadlabel['text'] = "No thread"
        self.destroythreadextraframe()

    def destroythreadextraframe(self):
        if self.threadextraframe:
            self.threadextraframe.destroy()
            self.threadextraframe = None

    def getthreadextraframe(self):
        if self.threadextraframe:
            return self.threadextraframe
        self.threadextraframe = Frame(self)
        self.threadextraframe.pack(fill = 'x')
        return self.threadextraframe

    def setaccount(self, account):
        self.account = account
        self.mailbox = "Unknown"
        self.updateloclabel()

    def setmailbox(self, mailbox):
        self.mailbox = mailbox
        self.updateloclabel()

    def updateloclabel(self):
        self.loclabel['text'] = "Processing %s: %s" % (self.account,
                                                       self.mailbox)
    
    def appendmessage(self, newtext):
        self.message['text'] += "\n" + newtext

    def setmessage(self, newtext):
        self.message['text'] = newtext
        

class VerboseUI(UIBase):
    def isusable(s):
        try:
            Tk().destroy()
            return 1
        except TclError:
            return 0

    def _createTopWindow(self, doidlevac = 1):
        self.top = Tk()
        self.top.title(version.productname + " " + version.versionstr)
        self.threadframes = {}
        self.availablethreadframes = []
        self.tflock = Lock()
        self.notdeleted = 1

        t = threadutil.ExitNotifyThread(target = self._runmainloop,
                                        name = "Tk Mainloop")
        t.setDaemon(1)
        t.start()

        if doidlevac:
            t = threadutil.ExitNotifyThread(target = self.idlevacuum,
                                            name = "Tk idle vacuum")
            t.setDaemon(1)
            t.start()

    def _runmainloop(s):
        s.top.mainloop()
        s.notdeleted = 0
    
    def getpass(s, accountname, config):
        pd = PasswordDialog(accountname, config)
        return pd.getpassword()

    def gettf(s, newtype=ThreadFrame, master = None):
        if master == None:
            master = s.top
        threadid = thread.get_ident()
        s.tflock.acquire()
        try:
            if threadid in s.threadframes:
                return s.threadframes[threadid]
            if len(s.availablethreadframes):
                tf = s.availablethreadframes.pop(0)
                tf.setthread(currentThread())
            else:
                tf = newtype(master)
            s.threadframes[threadid] = tf
            return tf
        finally:
            s.tflock.release()

    def _msg(s, msg):
        s.gettf().setmessage(msg)

    def threadExited(s, thread):
        threadid = thread.threadid
        s.tflock.acquire()
        if threadid in s.threadframes:
            tf = s.threadframes[threadid]
            tf.setthread(None)
            tf.setaccount("Unknown")
            tf.setmessage("Idle")
            s.availablethreadframes.append(tf)
            del s.threadframes[threadid]
        s.tflock.release()

    def idlevacuum(s):
        while s.notdeleted:
            time.sleep(10)
            s.tflock.acquire()
            while len(s.availablethreadframes):
                tf = s.availablethreadframes.pop()
                tf.destroy()
            s.tflock.release()
            
    def threadException(s, thread):
        msg =  "Thread '%s' terminated with exception:\n%s" % \
              (thread.getName(), thread.getExitStackTrace())
        print msg
    
        s.top.destroy()
        s.top = None
        TextOKDialog("Thread Exception", msg)
        s.terminate(100)

    def mainException(s):
        sbuf = StringIO()
        traceback.print_exc(file = sbuf)
        msg = "Main program terminated with exception:\n" + sbuf.getvalue()
        print msg

        s.top.destroy()
        s.top = None
        TextOKDialog("Main Program Exception", msg)

    def warn(s, msg):
        TextOKDialog("OfflineIMAP Warning", msg)

    def showlicense(s):
        TextOKDialog(version.productname + " License",
                     version.bigcopyright + "\n" +
                     version.homepage + "\n\n" + version.license,
                     blocking = 0, master = s.top)


    def init_banner(s):
        s._createTopWindow()
        s._msg(version.productname + " " + version.versionstr + ", " +\
               version.copyright)
        tf = s.gettf().getthreadextraframe()

        b = Button(tf, text = "About", command = s.showlicense)
        b.pack(side = LEFT)
        
        b = Button(tf, text = "Exit", command = s.terminate)
        b.pack(side = RIGHT)

    def deletingmessages(s, uidlist, destlist):
        ds = s.folderlist(destlist)
        s._msg("Deleting %d messages in %s" % (len(uidlist), ds))

    def _sleep_cancel(s, args = None):
        s.sleeping_abort = 1

    def sleep(s, sleepsecs):
        s.sleeping_abort = 0
        tf = s.gettf().getthreadextraframe()

        sleepbut = Button(tf, text = 'Sync immediately',
                          command = s._sleep_cancel)
        sleepbut.pack()
        UIBase.sleep(s, sleepsecs)
        
    def sleeping(s, sleepsecs, remainingsecs):
        if remainingsecs:
            s._msg("Next sync in %d:%02d" % (remainingsecs / 60,
                                             remainingsecs % 60))
        else:
            s._msg("Wait done; synchronizing now.")
            s.gettf().destroythreadextraframe()
        time.sleep(sleepsecs)
        return s.sleeping_abort

TkUI = VerboseUI

################################################## Blinkenlights

class LEDCanvas(Canvas):
    def createLEDLock(self):
        self.ledlock = Lock()
    def acquireLEDLock(self):
        self.ledlock.acquire()
    def releaseLEDLock(self):
        self.ledlock.release()
    def setLEDCount(self, arg):
        self.ledcount = arg
    def getLEDCount(self):
        return self.ledcount
    def incLEDCount(self):
        self.ledcount += 1

class LEDThreadFrame:
    def __init__(self, master):
        self.canvas = master
        self.color = ''
        try:
            self.canvas.acquireLEDLock()
            startpos = 5 + self.canvas.getLEDCount() * 10
            self.canvas.incLEDCount()
        finally:
            self.canvas.releaseLEDLock()
        self.ovalid = self.canvas.create_oval(startpos, 5, startpos + 5,
                                              10, fill = 'gray',
                                              outline = '#303030')

    def setcolor(self, newcolor):
        if newcolor != self.color:
            self.canvas.itemconfigure(self.ovalid, fill = newcolor)
            self.color = newcolor

    def getcolor(self):
        return self.color

    def setthread(self, newthread):
        if newthread:
            self.setcolor('gray')
        else:
            self.setcolor('black')

    def destroythreadextraframe(self):
        pass

    def getthreadextraframe(self):
        raise NotImplementedError

    def setaccount(self, account):
        pass
    def setmailbox(self, mailbox):
        pass
    def updateloclabel(self):
        pass
    def appendmessage(self, newtext):
        pass
    def setmessage(self, newtext):
        pass
         

class Blinkenlights(VerboseUI):
    def _createTopWindow(self):
        VerboseUI._createTopWindow(self, 0)
        #self.top.resizable(width = 0, height = 0)
        self.top.configure(background = 'black', bd = 0)
        c = LEDCanvas(self.top, background = 'black', height = 20, bd = 0,
                      highlightthickness = 0)
        c.setLEDCount(0)
        c.createLEDLock()
        self.canvas = c
        c.pack(side = BOTTOM, expand = 0, fill = X)
        widthmetric = tkFont.Font(family = 'Helvetica', size = 8).measure("0")
        self.loglines = 5
        if self.config.has_option("ui.Tk.Blinkenlights", "loglines"):
            self.loglines = self.config.getint("ui.Tk.Blinkenlights",
                                               "loglines")
        self.bufferlines = 500
        if self.config.has_option("ui.Tk.Blinkenlights", "bufferlines"):
            self.bufferlines = self.config.getint("ui.Tk.Blinkenlights",
                                                  "bufferlines")
        self.text = ScrolledText(self.top, bg = 'black', #scrollbar = 'y',
                                 font = ("Helvetica", 8),
                                 bd = 0, highlightthickness = 0, setgrid = 0,
                                 state = DISABLED, height = self.loglines,
                                 wrap = NONE, width = 10)
        self.text.vbar.configure(background = '#000050',
                                 activebackground = 'blue',
                                 highlightbackground = 'black',
                                 troughcolor = "black", bd = 0,
                                 elementborderwidth = 2)
                                 
        self.textenabled = 0
        self.tags = []
        self.textlock = Lock()

    def gettf(s, newtype=LEDThreadFrame):
        return VerboseUI.gettf(s, newtype, s.canvas)

    def init_banner(s):
        s._createTopWindow()
        menubar = Menu(s.top, activebackground = "black",
                       activeforeground = "white",
                       activeborderwidth = 0,
                       background = "black", foreground = "blue",
                       font = ("Helvetica", 8), bd = 0)
        menubar.add_command(label = "About", command = s.showlicense)
        menubar.add_command(label = "Show Log", command = s._togglelog)
        menubar.add_command(label = "Exit", command = s.terminate)
        s.top.config(menu = menubar)
        s.menubar = menubar
        s.gettf().setcolor('red')
        s._msg(version.banner)
        s.text.see(END)
        s.top.resizable(width = 0, height = 0)
        if s.config.has_option("ui.Tk.Blinkenlights", "showlog") and \
           s.config.getboolean("ui.Tk.Blinkenlights", "showlog"):
            s._togglelog()
        #s.tflock.acquire()
        #try:
        #    for i in range(s.top.winfo_reqwidth() / 10 - 1):
        #        newframe = LEDThreadFrame(s.canvas)
        #        newframe.setthread(None)
        #        s.availablethreadframes.append(newframe)
        #finally:
        #    s.tflock.release()

    def _togglelog(s):
        if s.textenabled:
            s.oldtextheight = s.text.winfo_height()
            s.text.pack_forget()
            s.textenabled = 0
            s.menubar.entryconfig('Hide Log', label = 'Show Log')
            s.top.update()
            s.top.geometry("")
            s.top.update()
            s.top.resizable(width = 0, height = 0)
            s.top.update()
        
        else: 
            s.text.pack(side = BOTTOM, expand = 1, fill = BOTH)
            s.textenabled = 1
            s.top.update()
            s.top.geometry("")
            s.menubar.entryconfig('Show Log', label = 'Hide Log')
            s._rescroll()
            s.top.resizable(width = 1, height = 1)


    def acct(s, accountname):
        s.gettf().setcolor('purple')
        VerboseUI.acct(s, accountname)

    def connecting(s, hostname, port):
        s.gettf().setcolor('gray')
        VerboseUI.connecting(s, hostname, port)

    def syncfolders(s, srcrepos, destrepos):
        s.gettf().setcolor('blue')
        VerboseUI.syncfolders(s, srcrepos, destrepos)

    def syncingfolder(s, srcrepos, srcfolder, destrepos, destfolder):
        s.gettf().setcolor('cyan')
        VerboseUI.syncingfolder(s, srcrepos, srcfolder, destrepos, destfolder)

    def loadmessagelist(s, repos, folder):
        s.gettf().setcolor('green')
        s._msg("Scanning folder [%s/%s]" % (s.getnicename(repos),
                                            folder.getvisiblename()))

    def syncingmessages(s, sr, sf, dr, df):
        s.gettf().setcolor('blue')
        VerboseUI.syncingmessages(s, sr, sf, dr, df)

    def copyingmessage(s, uid, src, destlist):
        s.gettf().setcolor('orange')
        VerboseUI.copyingmessage(s, uid, src, destlist)

    def deletingmessages(s, uidlist, destlist):
        s.gettf().setcolor('red')
        VerboseUI.deletingmessages(s, uidlist, destlist)

    def deletingmessage(s, uid, destlist):
        s.gettf().setcolor('red')
        VerboseUI.deletingmessage(s, uid, destlist)

    def addingflags(s, uid, flags, destlist):
        s.gettf().setcolor('yellow')
        VerboseUI.addingflags(s, uid, flags, destlist)

    def deletingflags(s, uid, flags, destlist):
        s.gettf().setcolor('pink')
        VerboseUI.deletingflags(s, uid, flags, destlist)

    def threadExited(s, thread):
        threadid = thread.threadid
        s.tflock.acquire()
        try:
            if threadid in s.threadframes:
                tf = s.threadframes[threadid]
                del s.threadframes[threadid]
                s.availablethreadframes.append(tf)
                tf.setthread(None)
        finally:
            s.tflock.release()

    def sleep(s, sleepsecs):
        s.sleeping_abort = 0
        s.menubar.add_command(label = "Sync now", command = s._sleep_cancel)
        s.gettf().setcolor('red')
        s._msg("Next sync in %d:%02d" % (sleepsecs / 60, sleepsecs % 60))
        UIBase.sleep(s, sleepsecs)

    def _rescroll(s):
        s.text.see(END)
        lo, hi = s.text.vbar.get()
        s.text.vbar.set(1.0 - (hi - lo), 1.0)

    def _msg(s, msg):
        if "\n" in msg:
            for thisline in msg.split("\n"):
                s._msg(thisline)
            return
        VerboseUI._msg(s, msg)
        color = s.gettf().getcolor()
        rescroll = 1
        s.textlock.acquire()
        try:
            if s.text.vbar.get()[1] != 1.0:
                rescroll = 0
            s.text.config(state = NORMAL)
            if not color in s.tags:
                s.text.tag_config(color, foreground = color)
                s.tags.append(color)
            s.text.insert(END, "\n" + msg, color)

            # Trim down.  Not quite sure why I have to say 7 instead of 5,
            # but so it is.
            while float(s.text.index(END)) > s.bufferlines + 2.0:
                s.text.delete(1.0, 2.0)

            if rescroll:
                s._rescroll()
        finally:
            s.text.config(state = DISABLED)
            s.textlock.release()

    def sleeping(s, sleepsecs, remainingsecs):
        if remainingsecs:
            s.menubar.entryconfig('end', label = "Sync now (%d:%02d remain)" % \
                          (remainingsecs / 60, remainingsecs % 60))
            if s.gettf().getcolor() == 'red':
                s.gettf().setcolor('black')
            else:
                s.gettf().setcolor('red')
            time.sleep(sleepsecs)
        else:
            s.menubar.delete('end')
            s.gettf().setcolor('black')
        return s.sleeping_abort