wh.py

# (c) 2013-2022 Andreas Pflug
#
# Licensed under the Apache License, 
# see LICENSE.TXT for conditions of usage


import wx.grid
import os, time, datetime, shutil 
from ast import literal_eval
from shlex import shlex

import logger
loaddir=None

def localTimeMillis():
  return time.time()*1000


def SetLoaddir(d):
  global loaddir
  loaddir=d

StringType=(str)

class AcceleratorHelper:
  def __init__(self, frame):
    self.list=[]
    self.frame=frame
    
  def Add(self, flags, keycode, cmd):
    if not isinstance(cmd, int):
      cmd=self.frame.GetMenuId(cmd)
    if not isinstance(keycode, int):
      keycode=ord(keycode)
    self.list.append(wx.AcceleratorEntry(flags, keycode, cmd) )
  
  def GetTable(self):
    return wx.AcceleratorTable(self.list)
  
  def Realize(self):
    self.frame.SetAcceleratorTable(self.GetTable())
  


class Grid(wx.grid.Grid):
  """
  Grid handling row selection more consistent
  """
  def __init__(self, parent):
    wx.grid.Grid.__init__(self, parent)
    self.Bind(wx.grid.EVT_GRID_LABEL_LEFT_CLICK, self.OnLabelLeftClick)

  def SetTable(self, table):
    super(Grid, self).SetTable(table, True)
    self.table=table
    
  def OnLabelLeftClick(self, evt):
    self.SetFocus()
    if not evt.ShiftDown():
      self.GoToCell(evt.Row, 0)
    evt.Skip()
    return

  def GetAllSelectedRows(self):
    rows=wx.grid.Grid.GetSelectedRows(self)
    tll=self.GetSelectionBlockTopLeft()
    if tll:
      for tl, br in zip(tll, self.GetSelectionBlockBottomRight()):
        for row in range(tl[0], br[0]+1):
          if not row in rows:
            rows.append(row) 
    rows.sort()
    return rows

  def quoteVal(self, val, quoteChar):
    try:
      _=float(val)
      return str(val)
    except:
      val.replace(quoteChar, "%s%s" % (quoteChar, quoteChar))
      return "%s%s%s" % (quoteChar, str(val), quoteChar) 
    
    
  def GetAllSelectedCellValues(self, withLabel=True):
    """
    GetAllSelectedCellValues
    
    returns 2-dim array of possibly quoted values
    Only one row is returned, if:
    - only cells are selected, no rows or cols  or
    - only one col is selected
    if more than one row is present, a column label might be added
    """
    vals=[]
    cells=self.GetSelectedCells()
    tll=self.GetSelectionBlockTopLeft()
    if tll:
      for tl, br in zip(tll, self.GetSelectionBlockBottomRight()):
        for row in range(tl[0], br[0]+1):
          for col in range(tl[1], br[1]+1):
            cells.append( (row, col))
      cells.sort()
    if cells:
      for row,col in cells:
        vals.append(self.GetQuotedCellValue(row, col))
      return [vals]
    else:
      rows=self.GetAllSelectedRows()
      if rows:
        cols=range(self.GetTable().GetColsCount())
      else:
        cols=self.GetSelectedCols()
        if cols:
          rows=range(self.GetTable().GetRowsCount())
          if len(cols) == 1:
            for row in rows:
              vals.append(self.GetQuotedCellValue(row, cols[0]))
            return [vals]
        else:
          return [[self.GetQuotedCellValue(self.GetGridCursorRow(), self.GetGridCursorCol())]]
      if withLabel and len(rows) > 1:
        v=[]
        for col in cols:
          v.append(self.GetQuotedColLabelValue(col))
        vals.append(v)
      for row in rows:
        v=[]
        for col in cols:
          v.append(self.GetQuotedCellValue(row, col))
        vals.append(v)
      return vals
 


class ToolBar(wx.ToolBar):
  def __init__(self, frame, size=32, style=wx.TB_FLAT|wx.TB_NODIVIDER):
    wx.ToolBar.__init__(self, frame, -1, style=style)
    self.frame=frame
    if not isinstance(size, wx.Size):
      size=wx.Size(size, size)
    self.SetToolBitmapSize(size);
    frame.SetToolBar(self)

  def Enable(self, procOrId, how=None):
    if how != None:
      if not isinstance(procOrId, int):
        procOrId=self.frame.GetMenuId(procOrId)
      self.EnableTool(procOrId, how)
    else:
      wx.ToolBar.Enable(self, procOrId)

  def AddCheck(self, procOrCls, text=None, bitmap=None):
    """
    AddCheck(self, procOrCls, text=None, bitmap=None)
    
    Adds a tool to the toolbar.
    If text==None, proc is assumed to be an class with an OnExecute method, name and toolbitmap statics 
    """
    return self.Add(procOrCls, text, bitmap, kind=wx.ITEM_CHECK)

  def Add(self, procOrCls, text=None, bitmap=None, kind=wx.ITEM_NORMAL):
    """
    Add(self, procOrCls, text=None, bitmap=None)
    
    Adds a tool to the toolbar.
    If text==None, proc is assumed to be an class with an OnExecute method, name and toolbitmap statics 
    """
    if text:
      mid=self.frame.GetMenuId(procOrCls)
      bmp=GetBitmap(bitmap, self.frame)
    else:
      mid=self.frame.BindMenuId(procOrCls.OnExecute)
      text=procOrCls.name
      bmp=GetBitmap(procOrCls.toolbitmap, procOrCls)
#    self.DoAddTool(id, text, bmp, kind=kind)
    self.AddTool(mid, text, bmp, kind=kind)
    return mid
  
  
class FileManager:
  maxLastFiles=10
  def __init__(self, frame, config=None):
    self.frame=frame
    self.configName="%sRecentFiles" % config.getWinName(frame)
    self.config=config
    self.currentFile=None
    self.filename=None
    self.recentMenu=None
    
    if config:
      self.lastFiles=config.Read(self.configName, [])
    else:
      self.lastFiles=[]
    self.firstId=self.frame.BindMenuId(self.OnSelectFile, True)
    for _ in range(self.maxLastFiles-1):
      _fid=self.frame.BindMenuId(self.OnSelectFile, True)
      
    self._handleConfig() # fill lastFiles array
    

  def _currentDirectory(self):
    return ""
  
  def _makePatterns(self, filePatterns):
    pattern=[]
    for txt, ext in filePatterns:
      pattern.append("%s (%s)" % (xlt(txt), ext))
      pattern.append(ext)
    return "|".join(pattern)
  
  
  def _saveFile(self, wnd, contents, filePatterns, message, filename):
    if filename:
      self.filename=filename
    else:
      if self.currentFile: defaultFile=self.currentFile
      else:                defaultFile=""
      if not message:
        message=xlt("Save File")
      dlg=wx.FileDialog(wnd, message, 
                        self._currentDirectory(), defaultFile, 
                        wildcard=self._makePatterns(filePatterns), 
                        style=wx.FD_SAVE|wx.FD_OVERWRITE_PROMPT)
      if dlg.ShowModal() == wx.ID_CANCEL:
        return False
      self.filename=dlg.GetPath()
      
    f=open(self.filename, 'w')
    f.write(contents)
    f.close()
    self._handleConfig()
    return True
  
  def OpenFile(self, wnd, filePatterns, message=None, filename=None):
    """
    OpenFile(self, wnd, filePatterns, message=None, filename=None):
    
    returns: filename or NONE
    """
    if filename:
      self.filename=filename
    else:
      if not message:
        message=xlt("Save File")
      if self.currentFile: defaultFile=self.currentFile
      else:                defaultFile=""
      dlg=wx.FileDialog(wnd, message,
                        self._currentDirectory(), defaultFile, 
                        wildcard=self._makePatterns(filePatterns) )
      if dlg.ShowModal() == wx.ID_CANCEL:
        return None
      self.filename = dlg.GetPath()
    self._handleConfig()
    return self.filename
        

  def SaveFile(self, wnd, content, filePatterns, message=None):
    """
    SaveFile(self, wnd, content, filePatterns, message=None):
    returns True if written, 
            False if FileDialog was aborted
    throws FileException
    """
    return self._saveFile(wnd, content, filePatterns, message, self.currentFile)

  def SaveFileAs(self, wnd, content, filePatterns, message=None):
    return self._saveFile(wnd, content, filePatterns, message, None)
  
  
  def OnSelectFile(self, evt):
    fid=evt.GetId() 
    fid -= self.firstId
    self.filename=self.lastFiles[fid]
    self.frame.OnRecentFileOpened(self.filename)
    self._handleConfig()

  def GetRecentFilesMenu(self):
    """
    GetRecentFileMenu()
    
    If used, the frame.OnRecentFileOpened(filename) called when a recent file is selected
    """
    if not self.recentMenu:
      self.recentMenu=Menu(self.frame)
    self._handleMenu()
    return self.recentMenu
  
  def _handleMenu(self):
    if self.recentMenu:
      for item in self.recentMenu.GetMenuItems():
        self.recentMenu.Delete(item)
      mid=self.firstId
      for file in self.lastFiles:
        self.recentMenu.Append(mid, file)
        mid +=1
        
  def _handleConfig(self):
    if self.filename:
      self.currentFile=self.filename
      if self.filename in self.lastFiles:
        if self.filename == self.lastFiles[0]:
          return # skip writing config and menu
        else:
          self.lastFiles.remove(self.filename)
      self.lastFiles.insert(0, self.filename)
    while len(self.lastFiles) > self.maxLastFiles:
      del self.lastFiles[self.maxLastFiles]
    if self.filename:
      if self.config:
        self.config.Write(self.configName, self.lastFiles)
      self._handleMenu()
    
        
def localizePath(path):
  """
  str localizePath(path)
  
  returns the localized version path of a file if it exists, else the global.
  """
  #locale='de_DE'
  #locPath=os.path.join(os.path.dirname(path), locale, os.path.basename(path))
  #if os.path.exists(locPath):
  #  return locPath
  return path


def modPath(name, mod):
  """
  str modPath(filename, module)
  
  prepend module's path to filename
  """
  if mod:
    if not isinstance(mod, StringType):
      mod=mod.__module__
    ri=mod.rfind('.')
    if ri > 0:
      return os.path.join(loaddir, mod[0:ri].replace('.', '/'), name)

  return os.path.join(loaddir, name)
    

def evalAsPython(val, default=None):
  try:
    return literal_eval(val)
  except:
    return default


def GetIcon(name, module=None):
  """
  wx.Icon GetIcon(iconName, module=None)
  
  Get an icon from a file, possibly prepending the module's path
  """
  name=modPath(name, module)
  return wx.Icon(name + ".ico")


def GetBitmap(name, module=None):
  """
  wx.Bitmap GetBitmap(bmpName, module=None)
  
  Get a bitmap from a file, possibly prepending the module's path
  """
  name=modPath(name, module)

  for ext in ["png", "ico"]:
    fn="%s.%s" % (name, ext)
    if os.path.exists(fn):
      with wx.LogNull():
        return wx.Bitmap(fn)

  for ext in ["xpm"]:
    fn="%s.%s" % (name, ext)
    if os.path.exists(fn):
      data=[]
      f=open(fn)
      for line in f:
        if line.startswith('"'):
          data.append(line[1:line.rfind('"')])
      f.close()
      return wx.Bitmap(data)   # .FromXPMData

  for ext in ["ico"]:  # superseded
    fn="%s.%s" % (name, ext)
    if os.path.exists(fn):
      bmp=wx.Bitmap().CopyFromIcon(wx.Icon(fn))
      return bmp
  return None


class Timer(wx.Timer):
  timerId=100
  def __init__(self, wnd, proc):
    super(Timer, self).__init__(wnd, Timer.timerId)
    wnd.Bind(wx.EVT_TIMER, proc, self)
#    wx.EVT_TIMER(wnd, Timer.timerId, proc)
    Timer.timerId += 1

class Menu(wx.Menu):
  def __init__(self, menuOwner=None):
    wx.Menu.__init__(self)
    self.menuOwner=menuOwner
  
  def Popup(self, evt):
    try:
      point=evt.GetPosition()
    except:
      point=evt.GetPoint()
    evt.EventObject.PopupMenu(self, point)
       
  def getId(self, something):
    if isinstance(something, wx.MenuItem):
      return something.GetId()
    elif isinstance(something, int):
      return something
    return self.menuOwner.GetMenuId(something)

  def Enable(self, something, how):
    wx.Menu.Enable(self, self.getId(something), how)
    
  def IsEnabled(self, something):
    return wx.Menu.IsEnabled(self, self.getId(something))
    
  def Check(self, something, how):
    wx.Menu.Check(self, self.getId(something), how)
    
  def IsChecked(self, something):
    return wx.Menu.IsChecked(self, self.getId(something))
    
  def Add(self, onproc, name, desc=None, mid=-1, macproc=None):
    if desc == None: desc=name
    if mid==-1:
      mid=self.menuOwner.BindMenuId(onproc)
      item=self.Append(mid, name, desc)
    else:
      item=self.Append(mid, name, desc)
      self.menuOwner.Bind(wx.EVT_MENU, onproc, id=mid)
      
    if macproc and wx.Platform == "__WXMAC__":
      macproc(mid)
    return item

  def AddCheck(self, onproc, name, desc, how=True):
    if desc == None: desc=name
    mid=self.menuOwner.BindMenuId(onproc)
    item=self.AppendCheckItem(mid, name, desc)
    self.Check(mid, how)
    return item
  
  def AppendOneMenu(self, menu, txt, hlp=None):
    if not hlp:
      hlp=""
    ic = menu.GetMenuItemCount()
    if ic > 1:
      return self.AppendSubMenu(menu, txt, hlp)
    if ic == 1:
      i=menu.GetMenuItems()[0]
      item=self.Append(i.GetId(), i.GetItemLabel(), i.GetHelp())
      return item
    return None


  def Dup(self):
    menu=Menu(self.menuOwner)
    for i in self.GetMenuItems():
      item=menu.Append(i.GetId(), i.GetItemLabel(), i.GetHelp())
      item.SetBitmap(i.GetBitmap())
    return menu

  def getRepr(self, m, indentstr):
    strings=[]
    for i in m.GetMenuItems():
      if i.IsSeparator():
        strings.append("%s---" % indentstr)
      else:
        strings.append("%s%d: %s" % (indentstr, i.GetId(), i.GetItemLabel()))
        if i.IsSubMenu():
          strings.extend(self.getRepr(i.GetSubMenu(), "%s  " & indentstr))
    return strings

  def __str__(self):
    return "\n".join(self.getRepr(self, ""))




def YesNo(b):
  if b:
    return xlt("Yes")
  else:
    return xlt("No")


def xlt(s): # translate
  return s
  t=wx.GetTranslation(s)
  # if dict set and t == s: log untranslated
  return t


def removeSmartQuote(txt):
  """
  removeSmartQuote(txt):
  
  Changes typographic quotation marks back to straight ones
  """
  return txt.replace(chr(0x201c), '"').replace(chr(0x201d), '"').replace(chr(0x2018), "'").replace(chr(0x2019), "'")


def quoteIfNeeded(txt, quoteChar='"'):
  """
  quoteIfNeededtxt)
  
  surrounds txt with quotes if txt includes spaces or the quote char
  """
  if isinstance(txt, bytes):
    txt=txt.decode()
  if txt.find(quoteChar) or txt.find(' '):
    return "%s%s%s" % (quoteChar, txt.replace(quoteChar, "\\%s" % quoteChar), quoteChar)
  return txt

  
def shlexSplit(txt, sep):
  """
  shlexSplit(str, sep)
  
  split string by separator, observing quotes
  """
  if not txt:
    return []
  if isinstance(txt, bytes):
    txt=txt.decode()
  lex=shlex(txt, posix=True)
  lex.whitespace=sep
  lex.commenters=''
  lex.whitespace_split=True
  return list(lex)
  
def copytree(src, dst, symlinks=False, ignore=None, replace=True):
  """
  this is mostly a copy of shutil.copytree, except it will optionally
  not barf if target files/directories already exists.
  """
  names = os.listdir(src)
  if ignore is not None:
    ignored_names = ignore(src, names)
  else:
    ignored_names = set()

  if not replace or not os.path.exists(dst):
    os.makedirs(dst)

  errors = []
  for name in names:
    if name in ignored_names:
      continue
    srcname = os.path.join(src, name)
    dstname = os.path.join(dst, name)
    try:
      if symlinks and os.path.islink(srcname):
        linkto = os.readlink(srcname) # @UndefinedVariable
        os.symlink(linkto, dstname)   # @UndefinedVariable 
      elif os.path.isdir(srcname):
        copytree(srcname, dstname, symlinks, ignore, replace)
      else:
        # Will raise a SpecialFileError for unsupported file types
        if replace and os.path.exists(dstname):
          os.unlink(dstname)
        shutil.copy2(srcname, dstname)
    # catch the Error from the recursive copytree so that we can
    # continue with other files
    except shutil.Error as err:
      errors.extend(err.args[0])
    except EnvironmentError as why:
      errors.append((srcname, dstname, str(why)))
  try:
    shutil.copystat(src, dst)
  except OSError as why:
    if hasattr(shutil, "WindowsError") and shutil.WindowsError is not None and isinstance(why, shutil.WindowsError):
      # Copying file access times may fail on Windows
      pass
    else:
      errors.append((src, dst, str(why)))
  if errors:
    raise shutil.Error(errors)


class ParamDict(dict):
  def __init__(self, txt=None):
    dict.__init__(self)
    if txt:
      self.setString(txt)

  def setString(self, items):
    if not isinstance(items, list):
      items=items.split()
    for item in items:
      s=item.split('=')
      if len(s) == 2:
        self[s[0]] = s[1]
      else:
        logger.debug("ParamString %s invalid: %s", items, item)

  def getList(self):
    l=[]
    for key, val in self.items():
      l.append("%s=%s" % (key, val))
    return l

  def getString(self):
    return " ".join(self.getList())

def restoreSize(_unused_name, _unused_defSize=None, _unused_defPos=None):
  size=(600,400)
  pos=(50,50)
  return size,pos


decimalSeparators=",."


def breakLines(text, breakLen=80):
  if not text:
    return ""
  result=[]
  line=""
  for part in text.split():
    if line:  line += " %s" % part
    else:     line=part
    if len(line) > breakLen:
      result.append(line)
      line=""
  if line:
    result.append(line)
  return "\n".join(result)


def splitValUnit(value):
  num=""
  unit=""
  canDot=True
  for c in str(value):
    if  unit:
      unit += c
    else:
      if c in decimalSeparators and canDot:
        num+=c
        canDot=False
      elif c in "1234567890":
        num+=c
      else:
        unit+=c

  return num, unit.strip()


def strToIsoDate(val):
  zpos=val.find('Z')
  if zpos > 0:
    l=zpos
  else:
    l=len(val)
  if l < 8:
    return val
  elif l < 10:
    fmtstr="%Y%m%d"
  elif l < 14:
    fmtstr="%Y%m%d%H%M"
  else:
    l=14
    fmtstr="%Y%m%d%H%M%S"

  try:
    ts=time.strptime(val[:l], fmtstr)
  except Exception as e:
    logger.error("Invalid datetime format %s: %s", val, e)
    return val

  try:
    gmt=time.mktime(ts)
  except Exception as e:
    logger.error("Invalid datetime format %s: %s", val, e)
    return val

  if zpos > 0:
    # adjust time: interpreted as local but actually gmt
    ts=time.localtime(gmt)
    if ts.tm_isdst > 0:
      gmt -= time.altzone
    else:
      gmt -= time.timezone

    zpi=val[zpos+1:]
    if zpi:
      try:
        gmt += 3600*zpi
      except:
        logger.error("Invalid time zone %s", val)
        pass
  return prettyDate(gmt, True)


def utc2local(value):
  ts=time.strptime(value, "%Y-%m-%d %H:%M:%S")
  gmt=time.mktime(ts)
  if time.localtime(gmt).tm_isdst > 0:
    gmt -= time.altzone
  else:
    gmt -= time.timezone
  return time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(gmt))

def isoDateToStr(value):
  ts=time.strptime(value, "%Y-%m-%d %H:%M:%S")
  gmt=time.gmtime(time.mktime(ts))
  return time.strftime("%Y%m%d%H%M%SZ", gmt)


def timeToFloat(value):
  factors={ "ms": .001, "us": .001*.001, "ns": .001*.001*.001, "s": 1.,
            "m": 60., "h": 60*60., "d":24*60*60. }
  num, unit=splitValUnit(value)

  if not num:
    return 0.
  val=float(num)
  unit = unit.lower()
  if unit:
    u=unit.split(' ')
    unit=u[0]
    factor=factors.get(unit)
    if not factor:
      logger.debug("Factor for unit %s not found", unit)
      return None
    else:
      val *= factor
    if len(u) > 1:
      add=timeToFloat(" ".join(u[1:]))
      if add == None:
        return None
      val += add
  return val

def floatToTime(value, nk=1):
  if value:
    if hasattr(value, 'total_seconds'):
      val=value.total_seconds()
    else:
      val=float(value)
  else:
    val=0.
  if val < 0:
    val = -val
    vz="-"
  else:
    vz=""

  if val >= 90:
    fmt="%%.0%df" % nk
    sec= val % 60
    val -= sec
    val = int(val+.1)/60
    mins = val % 60
    val /= 60
    hour= val % 24
    day=val/24

    if day:
      if nk < 0:
        if not mins:
          if not hour:
            return "%dd" % day
          else:
            return "%dd %dh" % (day, hour) 
      return "%dd %dh %dm" % (day, hour, mins)
    elif hour:
      if nk < 0:
        if not sec:
          if not mins:
            return "%dh" % hour
          else:
            return "%dh %dm" % (hour, mins)
      return "%dh %dm %ds" % (hour, mins, int(sec))
    elif min:
      if nk < 0 and not sec:
        return "%dm" % mins
      return "%dm %ds" % (mins, int(sec))
    else:
      return fmt%sec
  elif not val:
    val=0.
    unit="s"
  elif val > .2:
    if val < 90:
      unit="s"
  else:
    val *= 1000.
    if val > .2:
      unit="ms"
    else:
      val *= 1000
      if val > .2:
        unit="us"
      else:
        val *= 1000
        unit="ns"

  if nk < 0:
    nk=0
  fmt="%%s%%.0%df %%s" % nk
  return fmt % (vz, val, unit)


def prettyTime(val, nk=1):
  return floatToTime(timeToFloat(val), nk)

def prettyDate(val, long=True):
  if isinstance(val, datetime.datetime):
    val=val.timetuple()
  if not isinstance(val, time.struct_time):
    val=time.localtime(val)
  if long:
    return time.strftime("%Y-%m-%d %H:%M:%S", val)
  else:
    return time.strftime("%Y-%m-%d", val)


def sizeToFloat(value):
  factors={ "kb":  1000., "mb":  1000*1000, "gb":  1000*1000*1000., "tb":  1000*1000*1000*1000,
            "k":   1024., "m":   1024*1024, "g":   1024*1024*1024.,   "t": 1024*1024*1024*1024,
            "kib": 1024., "mib": 1024*1024, "gib": 1024*1024*1024., "tib": 1024*1024*1024*1024, }

  num,unit=splitValUnit(value)
  if not num:
    return 0.
  val=float(num)
  unit = unit.lower()
  if unit:
    factor=factors.get(unit)
    if not factor:
      logger.debug("Factor for unit %s not found", unit)
      return None
    else:
      val *= factor
  return val


def prettySize(val):
  if not isinstance(val, (int,float)):
    val=sizeToFloat(val)
  return floatToSize(val)

def floatToSize(val, resolution=0):
  """
  string floatToSize(val, resolution=0)
  
  formats and decorates <val>. <resolution> controls the decimal point.
  """
  if not val:
    return "0"

  unit=""
  orgVal = float(val)
  val = orgVal / 1024.
  if val < 2048:
    unit="KiB"
  else:
    val /= 1024.
    if val < 1500:
      unit="MiB"
    else:
      val /= 1024.
      if val < 1500:
        unit="GiB"
      else:
        val /= 1024.
        unit="TiB"
  if val < 15 and orgVal >= resolution*100:
    return "%0.02f %s" % (val, unit)
  elif val < 150 and val >= resolution*10:
    return "%0.01f %s" % (val, unit)
  else:
    return "%0.0f %s" % (val, unit)