"""
Various generic tools for creating and using HTML.
"""
import os
import sys
import olx
import olex
import olexex
import OlexVFS
import gui

import time
from datetime import date

from olexFunctions import OV
debug = OV.IsDebugging()

last_mode = None
last_mode_options = None
current_tooltip_number = 0
HaveModeBox = False

global tutorial_box_initialised
tutorial_box_initialised = False

global time_add
time_add = 0

global hover_buttons
hover_buttons = OV.GetParam('olex2.hover_buttons')

import gui


def makeHtmlTable(dlist):
  """ Pass a list of dictionaries, with one dictionary for each table row.

  In each dictionary set at least the 'varName':(the name of the variable) and 'itemName':(the text to go in the first column).
  If you require a combo box set 'items':(a semi-colon separated list of items).
  If you want a multiline box set 'multiline':'multiline'.
  If you want more than one input box in a row, set 'varName' and 'itemName' plus anything else under a sub-dictionary called 'box1',
  'box2','box3'.
  If you wish to change any of the defaults such as bgcolor, height, width, etc., these can be set in the dictionary to be passed.
  """
  text = ''

  for input_d in dlist:
    row_d = {}
    row_d.setdefault('itemName',input_d['itemName'])
    row_d.setdefault('ctrl_name', "SET_%s" %str.upper(input_d['varName']).replace('.','_'))

    if input_d['varName'] == "InfoLine":
      text += "<tr><td colspan='2'><font color='#555555'>%s</font></td></tr>" %input_d['value']
      continue
    boxText = ''
    i = 0
    for box in ['box1','box2','box3','box4']:
      if box in input_d:
        i += 1
        box_d = input_d[box]
        box_d.setdefault('ctrl_name', "SET_%s" %str.upper(box_d['varName']).replace('.','_'))
        box_d.setdefault('bgcolor',"spy.bgcolor('~name~')")
        if box_d['varName'].startswith('_'): # treat cif items differently
          if OV.IsFileType('cif'):
            box_d.setdefault('value', olx.Cif('%(varName)s' %box_d))
          else:
            box_d.setdefault('value', "spy.get_cif_item('%(varName)s','?','gui')" %box_d)
          box_d.setdefault('onchange',"spy.set_cif_item('%(varName)s',html.GetValue('~name~'))>>spy.AddVariableToUserInputList('%(varName)s')>>spy.changeBoxColour('%(ctrl_name)s','#FFDCDC')" %box_d)
        else:
          box_d.setdefault('value', OV.GetParam('%(varName)s' %box_d))
          box_d.setdefault('onchange',"spy.SetParam('%(varName)s',html.GetValue('~name~'))>>spy.AddVariableToUserInputList('%(varName)s')>>spy.changeBoxColour('~name~','#FFDCDC')" %box_d)

        if 'extra_onchange' in box_d:
          box_d['onchange'] += ">>%s" %box_d['extra_onchange']
        bt =  makeHtmlInputBox(box_d)
        #IN
        label = box_d.get('label')
        if label:
          boxText += '<td align="right" width="%(label_w)s">' + label + '</td><td  align="right" width="%(w)s">' + bt + '</td>'
        else:
          boxText += bt
        #OUT
    if boxText:
      #IN
      if label:
        _ = {'label_w':'20%%', 'w':"%s%%"%int((100-(20*i))/i)}
      else:
        _ = {'w':"100"}
      boxText = boxText%_
      #OUT
      boxText = '<table cellpadding="0" cellspacing="0"><tr>'  + boxText + "</tr></table>"
      row_d.setdefault('input',boxText)
    else:
      input_d.setdefault('ctrl_name', "SET_%s" %str.upper(input_d['varName']).replace('.','_'))
      if input_d['varName'].startswith('_'): # treat cif items differently
        input_d.setdefault('value', "spy.get_cif_item('%(varName)s','?','gui')" %input_d)
        input_d.setdefault('onchange',"spy.set_cif_item('%(varName)s',html.GetValue('~name~'))>>spy.AddVariableToUserInputList('%(varName)s')>>spy.changeBoxColour('~name~','#FFDCDC')" %input_d)
      elif 'snum.report.date_' in input_d['varName']: # treat date fields differently
        which = input_d['varName'].split("_")[1]
        try:
          cd = float(OV.GetParam('snum.report.date_%s' %which))
          cd = date.fromtimestamp(cd)
          time_str = cd.strftime("%d-%m-%Y")
          input_d.setdefault('value', "'%s'" %time_str)
        except:
          input_d.setdefault('value', "'%s'" %OV.GetParam('snum.report.date_collected'))
        input_d.setdefault('onchange',"spy.SetParam('%(varName)s',html.GetValue('~name~'))>>spy.AddVariableToUserInputList('%(varName)s')>>spy.changeBoxColour('~name~','#FFDCDC')" %input_d)
      else:
        input_d.setdefault('value', "spy.GetParam('%(varName)s')" %input_d)
        input_d.setdefault('onchange',"spy.SetParam('%(varName)s',html.GetValue('~name~'))>>spy.AddVariableToUserInputList('%(varName)s')>>spy.changeBoxColour('~name~','#FFDCDC')" %input_d)
      input_d.setdefault('bgcolor',"spy.bgcolor('~name~')")
      if 'extra_onchange' in input_d:
        input_d['onchange'] += ">>%s" %input_d['extra_onchange']
      row_d.setdefault('input',makeHtmlInputBox(input_d))
      row_d.update(input_d)


    text += makeHtmlTableRow(row_d)

  return OV.Translate(text)

def makeHtmlInputBox(inputDictionary):
  # check for old, no value, readonly
  if 'readonly' in inputDictionary:
    if '' == inputDictionary['readonly']:
      inputDictionary['readonly'] = 'true'
  else:
    inputDictionary['readonly'] = 'false'

  if 'items' in inputDictionary:
    inputDictionary.setdefault('type','combo')
  else:
    if inputDictionary.get('onchange', None) and not inputDictionary.get('onleave'):
      inputDictionary['onleave'] = inputDictionary['onchange']
      del inputDictionary['onchange']

  if 'multiline' in inputDictionary:
    inputDictionary.setdefault('height','35')

  dictionary = {
    'width':'95%%',
    'height':"$GetVar('HtmlInputHeight')",
    'onchange':'',
    'onchangealways':'false',
    'onleave':'',
    'onclick':'',
    'items':'',
    'multiline':'false',
    'type':'text',
    'readonly':'false',
    'manage':'',
    'data':'',
    'label':'',
    'valign':'center',
    'bgcolor':'',
  }
  dictionary.update(inputDictionary)

  htmlInputBoxText = '''

<font size="$GetVar('HtmlFontSizeControls')">
<input
type="%(type)s"
multiline=%(multiline)s
width="%(width)s"
height="%(height)s"
name="%(ctrl_name)s"
#label="%(label)s"
value="%(value)s"
items="%(items)s"
valign="%(valign)s"
onchange="%(onchange)s"
onchangealways="%(onchangealways)s"
onleave="%(onleave)s"
onclick="%(onclick)s"
readonly="%(readonly)s"
bgcolor="%(bgcolor)s"
>
</font>
'''%dictionary
  _ = htmlInputBoxText.replace("%%", "@")
  _ = _.replace("%", "%%")
  _ = _.replace("@", "%%")
  return _

def makeHtmlTableRow(dictionary):
#  dictionary.setdefault('font', "size='%s'" %olx.GetVar('HtmlGuiFontSize'))
  dictionary.setdefault('font', "size='2'")
  dictionary.setdefault('trVALIGN','center')
  dictionary.setdefault('trALIGN','left')
  dictionary.setdefault('fieldWidth','30%%')
  dictionary.setdefault('fieldVALIGN','center')
  dictionary.setdefault('fieldALIGN','left')
  dictionary.setdefault('first_col_width', OV.GetParam('gui.html.table_firstcol_width'))
  dictionary.setdefault('first_col_colour', OV.GetParam('gui.html.table_firstcol_colour'))
  #dictionary.setdefault('first_column', '<td width="%(first_col_width)s" bgcolor="%(first_col_colour)s"></td>' %dictionary)
  dictionary.setdefault('first_column', '')

  href_1 = ""
  href_2 = ""

  if 'href' in list(dictionary.keys()):
    href_content= dictionary['href']
    href_1 = '<a href="%s">' %href_content
    href_2 = '</a>'
    dictionary['href'] = ""

  if 'chooseFile' in list(dictionary.keys()):
    chooseFile_dict = dictionary['chooseFile']
    if 'file_type' in list(chooseFile_dict.keys()):
      href = "spy.set_source_file(%(file_type)s,FileOpen('%(caption)s','%(filter)s','%(folder)s'))>>html.Update" %chooseFile_dict
    else:
      href = "%(function)sFileOpen('%(caption)s','%(filter)s','%(folder)s'))>>html.Update" %chooseFile_dict
      pass
    chooseFileText = '''
    <td>
      <a href="%s">
        <zimg border="0" src="toolbar-open.png">
      </a>
    </td>
    ''' %href
    href_1 = '<a href="%s">' %href
    href_2 = '</a>'
    dictionary['chooseFile'] = ""
    #dictionary.setdefault('chooseFile','')

  else:
    dictionary.setdefault('chooseFile','')
  dictionary['href_1'] = href_1
  dictionary['href_2'] = href_2

  FieldText = ''
  count=0
  for field in ['field1','field2']:
    if field in list(dictionary.keys()):
      count += 1
      field_d = dictionary[field]
      field_d.setdefault('itemName', '')
      field_d.setdefault('fieldVALIGN','center')
      field_d.setdefault('fieldALIGN','left')
      if field == 'field1':
        field_d.setdefault('fieldWidth','30%%')
      else:
        field_d.setdefault('fieldWidth','70%%')
      field_d.setdefault('href_1',href_1)
      field_d.setdefault('href_2',href_2)

      field_d.setdefault('font','color=%s' %OV.GetParam('gui.html.table_firstcol_colour'))
      field_d.setdefault('first_col_width', OV.GetParam('gui.html.table_firstcol_width'))
      FieldText += """
                <td VALIGN="%(fieldVALIGN)s" ALIGN="%(fieldALIGN)s" width="%(fieldWidth)s">
                  <b>%(itemName)s</b>
                </td>
                """ %field_d
  if count == 2:
    FieldText = "<td><table cellpadding='0' cellspacing='0' width='100%%'><tr>%s</tr></table></td>" %FieldText

  if FieldText:
    dictionary.setdefault('fieldText',FieldText)

    htmlTableRowText = '''
  <tr NAME="%(ctrl_name)s">
    %(fieldText)s
    <td valign="center" align="right">%(input)s</td>
    %(chooseFile)s
  </tr>
''' %dictionary

  else:

    htmlTableRowText = '''
  <tr NAME="%(ctrl_name)s">
  %(first_column)s
    <td VALIGN="%(fieldVALIGN)s" ALIGN="%(fieldALIGN)s" width="%(fieldWidth)s">
      <b>
        %(href_1)s
          %(itemName)s
        %(href_2)s
      </b>
    </td>
    <td align="right" width="70%%%%">
      %(input)s
    </td>
    %(chooseFile)s
  </tr>
''' %dictionary

  return htmlTableRowText

def make_edit_link(name, box_type):
  editLink = ""
  if OV.IsPluginInstalled('Olex2Portal'):
    if OV.GetParam('olex2.is_logged_on'):
      editLink = '''
      <tr>
      <td align='right'>
      <a href='spy.EditHelpItem(%s-%s)'>
        <b>
          &#187;
        </b>
        Edit
      </a>
      </td>
      </tr>
      ''' %(name, box_type)
  return editLink
def make_gui_edit_link(name):
  editLink = ""
  name = name.replace("\\", "/")
  #if OV.IsPluginInstalled('Olex2Portal') and OV.GetParam('olex2.is_logged_on'):
  if debug:
    if "index" in name:
      editLink ='''
      <hr>
      <a href='spy.EditGuiItem(%s)'>
        Edit INDEX File
      </a>
      ''' %(name)
    else:
      editLink = '''
      <a href='spy.EditGuiItem(%s)'>
        Edit
      </a>
      ''' %(name)

  return editLink
OV.registerFunction(make_gui_edit_link)

def EditGuiItem(OXD,language="English"):
  path = "etc"
  if 'index' in OXD:
    path = r"etc/gui/blocks"
    tool_name = OXD
    gui_file = r"%s/%s/%s.htm" % (olx.BaseDir(),path, OXD)
  else:
    if os.path.exists(OXD):
      gui_file = OXD
    else:
      tool_name = OXD.split("/")[1].split(".")[0]
      gui_file = r"%s/%s/%s" % (olx.BaseDir(),path, OXD)

  if not os.path.exists(gui_file):
    return

  rFile = open(gui_file,'r')
  text = rFile.read()
  if not text:
    return

  inputText = OV.GetUserInput(0,'Modify text for help entry %s in %s' %(OXD, language), text)
  if inputText and inputText != text:
    wFile = open(gui_file,'w')
    wFile.write(inputText)
    olx.html.Update
  else:
    inputText = text
OV.registerFunction(EditGuiItem)

def make_warning_html(colspan):
  txt = "htmltool-warning"
  txt = OV.TranslatePhrase(txt)
  first_col = make_table_first_col()
  html = '''
       <tr>
         %s
         <td colspan="%s" bgcolor="$GetVar('HtmlHighlightColour')">
          <b>
            &nbsp;%s
          </b>
         </td>
       </tr>
       ''' %(first_col, colspan, txt)
  return html
OV.registerFunction(make_warning_html)

def make_table_first_col(help_name=None, popout=False, help_image='large'):
  if help_name is None:
    help = ""
  else:
    help = make_help_href(help_name, popout, image=help_image)
  html ='''
<td valign='top' align='center' bgcolor="$GetVar('HtmlTableFirstcolColour')">
  %s
</td>
''' %help
  return html

def make_html_opening():
  html = '''
  <html>
  <body link=$GetVar(HtmlLinkColour) bgcolor="$GetVar('HtmlBgColour')">
  <font color="$GetVar('HtmlFontColour')" size="$GetVar('HtmlGuiFontSize')" face="$GetVar('HtmlFontName')">
<p> '''
  return html

def make_html_closing():
  html = '''
  </font></body></html>
  '''
  return html

def make_help_href(name, popout, image='normal'):
  help = '''
  $spy.MakeHoverButton("btn-info@%s","spy.make_help_box -name='%s' -popout='%s'")
  ''' %(name, name, popout)

  return help

def make_input_text_box(d):
  name = d.get('ctrl_name')
  dic = {'height':"$GetVar('HtmlInputHeight')",
         'bgcolor':"$GetVar('HtmlInputBgColour')",
         'value':"$spy.GetParam('%(varName)s')",
         'width':'45',
         'onchange':'',
         'onleave':'',
         'label':name,
         'valign':'center',
         'data':'',
         'manage':'',
     }
  dic.update(d)

  html = '''
<font size="$GetVar('HtmlFontSizeControls')">
<input
       bgcolor="$GetVar('HtmlInputBgColour')"
       type="text"
       name="%(ctrl_name)s"
       value="%(value)s"
       width="%(width)s"
       height="%(height)s"
       label="%(label)s"
       valign="%(valign)s"
       onchange="%(onchange)s"
       onleave="%(onleave)s"
       %(manage)s
       data="%(data)s"
>
</font>''' %dic
  return html
def make_combo_text_box(d):
  name = d.get('ctrl_name')
  dic = {'height':"%s" %int(olx.GetVar('HtmlComboHeight')),
         'bgcolor':"$GetVar('HtmlInputBgColour')",
         'value':"$spy.GetParam('%(varName)s')",
         'label':'',
         'valign':'center',
         'halign':'left',
         'width':'70',
         'onchange':'',
         'onchangealways' : 'false',
         'data':'',
         'manage':'manage',
         'readonly':'',
     }
  dic.update(d)

  if 'readonly' in dic:
    if dic['readonly']:
      dic['readonly'] = "readonly"
    else:
      dic['readonly'] = ""

    html = '''
<font size="$GetVar('HtmlFontSizeControls')">
<input
       bgcolor="$GetVar('HtmlInputBgColour')"
       type="combo"
       name="%(ctrl_name)s"
       value="%(value)s"
       halign="%(halign)s"
       valign="%(valign)s"
       items="%(items)s"
       width="%(width)s"
       height="%(height)s"
       label="%(label)s"
       onchange="%(onchange)s"
       onchangealways="%(onchangealways)s"
       %(manage)s
       data="%(data)s"
       %(readonly)s
>
</font>''' %dic
  return html

def make_tick_box_input(d):
  name = d.get('ctrl_name')
  dic = {'bgcolor':"GetVar('HtmlTableBgColour')",
         'fgcolor':"GetVar('HtmlFontColour')",
         'value':"$spy.GetParam('%(varName)s')",
         'onchange':'',
         'value':'%s '%name,
         'oncheck':'',
         'onuncheck':'',
         'data':'',
         'manage':'',
         'state':'',
     }
  dic.update(d)
  if 'checked' in dic:
    dic['checked'] = "checked='%s'" %dic.get('checked')
  else:
    dic.setdefault('checked','')
  html = """
<font size="$GetVar('HtmlFontSizeControls')">
<input
  type="checkbox"
  name="%(ctrl_name)s"
  value="%(value)s"
  bgcolor="%(bgcolor)s"
  fgcolor="%(fgcolor)s"
  %(state)s
  %(checked)s
  oncheck="%(oncheck)s"
  onuncheck="%(onuncheck)s"
  valign="center"
  %(manage)s
  data="%(data)s"
  >
  </font>
""" %dic
  return html

def make_spin_input(d):
  name = d.get('ctrl_name')
  dic = {'width':'12',
         'height':"$GetVar('HtmlSpinHeight')",
         'bgcolor':"$GetVar('HtmlInputBgColour')",
         'value':"$spy.GetParam('%(varName)s')",
         'max':'99',
         'min':'0',
         'width':'45',
         'onchange':'',
         'label':"%s: " %name,
         'valign':'center',
         'halign':'left',
         'manage':'manage',
     }
  dic.update(d)
  html = """
<font size="$GetVar('HtmlFontSizeControls')">
<input
  label="%(label)s"
  valign="%(valign)s"
  halign="%(halign)s"
  type="spin"
  name="%(ctrl_name)s"
  width="%(width)s"
  height="%(height)s"
  max="%(max)s"
  min="%(min)s"
  bgcolor="%(bgcolor)s"
  value="%(value)s"
  onchange="%(onchange)s"
  manage="%(manage)s"
  >
  </font>""" %dic
  return html

def make_input_button(d):
  dic = {'ondown':'',
         'onup':'',
         'onclick':'',
         'hint':'',
         'height':"$GetVar('HtmlButtonHeight')",
         'bgcolor':"$GetVar('HtmlInputBgColour')",
         'valign':'center',
         'halign':'left'
         }
  dic.update(d)
  html = '''
<font size="$GetVar('HtmlFontSizeControls')">
<input
  bgcolor="%(bgcolor)s"
  type="button"
  name="%(name)s_BUTTON"
  value="%(value)s"
  width="%(width)s"
  height="%(height)s"
  hint="%(hint)s"
  flat
''' %dic
  if dic['onclick']:
    html += '''
  onclick="%(onclick)s"
>
</font>
''' %dic
  elif dic['ondown'] or dic['onup']:
    html += '''
  ondown="%(ondown)s"
  onup="%(onup)s"
  >
  </font>
''' %dic
  else:
    html += '\n></font>\n'
  return html

def format_help(txt):
  regex_source = os.path.join(OV.BaseDir(), "etc", "regex", "regex_format_help.txt")
  if os.path.exists(regex_source):
    txt = gui.tools.run_regular_expressions(txt, regex_source)

  import re
  d = {}  # initialise a dictionary, which will be used to store metadata.

  ## find all occurences of strings between **..**. These should be comma separated things to highlight.

  regex = re.compile(r"\*\* (.*?)  \*\*", re.X)
  l = regex.findall(txt)
  if l:
    l = l[0].split(",")
    txt = regex.sub(r"", txt)

    for item in l:
      regex = re.compile(r"((?P<left>\W) (?P<txt>%s) (?P<right>\W))" %item, re.X)
      txt = regex.sub(r"\g<left><b>\g<txt></b>\g<right>", txt)

  ## find all occurences of strings between {{..}}. This will be translated into a dictionary and returned with the txt.
  regex = re.compile(r"\{\{ (.*?)  \}\}", re.X)
  dt = regex.findall(txt)
  if dt:
    txt = regex.sub(r"", txt)
    dt = dt[0]
    dt = dt.replace(",", "','")
    dt = dt.replace(":", "':'")
    dt = "{'%s'}" %dt
    d = eval(dt)


  ### find all occurences of <lb> and replace this with a line-break in a table.
  #regex = re.compile(r"<lb>", re.X)
  #txt = regex.sub(r"<br>", txt)

  ### find all occurences of '->' and replace this with an arrow.
  #regex = re.compile(r"->", re.X)
  #txt = regex.sub(r"<b>&rarr;</b>", txt)

  ### find all occurences of strings between t^..^t. These are the headers for tip of the day.
  #regex = re.compile(r"t \^ (.*?)  \^ t", re.X)
  #txt = regex.sub(r"<font color='$GetVar(HtmlHighlightColour)'><b>\1</b></font>&nbsp;", txt)

  ### find all occurences of strings between <<..>>. These are keys to pressthe headers for tip of the day.
  #regex = re.compile(r"<< (.*?)  >>", re.X)
  #txt = regex.sub(r"<b><code>\1</code></b>", txt)

  ### find all occurences of strings between n^..^n. These are the notes.
  #regex = re.compile(r"n \^ (.*?)  \^ n", re.X)
  #txt = regex.sub(r"<table width='%s' border='0' cellpadding='0' cellspacing='1'><tr bgcolor=#efefef><td><font size=-1><b>Note: </b>\1</font></td></tr></table>", txt)

  ### find all occurences of strings between TT..TT. These are keys to press the headers for tip of the day.
  #regex = re.compile(r"TT (.*?)  TT", re.X)
  #txt = regex.sub(r"<tr><td align='right'><a href='spy.run_autodemo(\1)'><zimg src=tutorial.png></a></td></tr>", txt)

  ### find all occurences of strings between TT..TT. These are keys to pressthe headers for tip of the day.
  #regex = re.compile(r"TT (.*?)  TT", re.X)
  #sx = txt
  #txt = regex.sub(r"<tr><td align='right'>$spy.MakeHoverButton('button-tutorial','spy.demo.run_autodemo(1)')</td></tr>", txt)
  #txt = txt.replace(r"\\\\",r"\\")

  ## find all occurences of strings between l[]. These are links to help or tutorial popup boxes.
  regex = re.compile(r"l\[\s*(?P<linktext>.*?)\s*,\s*(?P<linkurl>.*?)\s*\,\s*(?P<linktype>.*?)\s*\]", re.X)
  txt = regex.sub(r"<font size=+1 color=\"$GetVar('HtmlHighlightColour')\">&#187;</font><a target='Go to \g<linktext>' href='spy.make_help_box -name=\g<linkurl> -type=\g<linktype>'><b>\g<linktext></b></a>", txt)

  ## find all occurences of strings between URL[]. These are links to help or tutorial popup boxes.
  regex = re.compile(r"URL\[\s*(?P<URL>.*?)]", re.X)
  txt = regex.sub(r"<b><a href='shell \g<URL>'><font color='#205c90'>More Info Online</font></a></b>" , txt)

  ## find all occurences of strings between gui[]. These are links make something happen on the GUI.
  regex = re.compile(r"gui\[\s*(?P<linktext>.*?)\s*,\s*(?P<linkurl>.*?)\s*\,\s*(?P<linktype>.*?)\s*\]", re.X)
  txt = regex.sub(r"<font size=+1 color='$GetVar(HtmlHighlightColour)'>&#187;</font><a target='Show Me' href='\g<linkurl>'><b>\g<linktext></b></a>", txt)
  ## find all occurences of strings between XX. These are command line entities.
  width = int(OV.GetHtmlPanelwidth()) - 10

  regex = re.compile(r"  XX (.*?)( [^\\XX\\XX]* ) XX ", re.X)
  m = regex.findall(txt)
  code_bg_colour = OV.GetParam('gui.html.code.bg_colour').hexadecimal
  code_fg_colour = OV.GetParam('gui.html.code.fg_colour').hexadecimal
  html_tag = OV.GetParam('gui.html.code.html_tag')
  if m:
    s = regex.sub(r" <font color='%s'><b><a href='\2'><%s>\2</%s></a></b></font>" %( code_fg_colour, html_tag, html_tag), txt)
  else:
    s = txt
  txt = s


  regex = re.compile(r"  <code> (.*?) </code> ", re.X)
  m = regex.findall(txt)
  code_bg_colour = OV.GetParam('gui.html.code.bg_colour').hexadecimal
  code_fg_colour = OV.GetParam('gui.html.code.fg_colour').hexadecimal
  html_tag = OV.GetParam('gui.html.code.html_tag')
  if m:
    s = regex.sub(r" <font color='%s'><b><a href='\1'><%s>\1</%s></a></b></font>" %( code_fg_colour, html_tag, html_tag), txt)
  else:
    s = txt
  txt = s



  ### find all occurences of strings between ~. These are the entries for the table.
  #regex = re.compile(r"  ~ (.*?)( [^\~\~]* ) ~ ", re.X)
  #m = regex.findall(txt)
  #colour = OV.GetParam('gui.html.highlight_colour').hexadecimal
  #if m:
    #s = regex.sub(r"<p><b><font color='%s'>\2</font></b>&nbsp;" %colour, txt)
  #else:
    #s = txt

  ### find all occurences of strings between@. These are the table headers.
  #txt = s
  #regex = re.compile(r"  @ (.*?)( [^\@\@]* ) @ ", re.X)
  #m = regex.findall(txt)
  #colour = "#232323"
  #if m:
    #s = regex.sub(r"<tr bgcolor=\"$GetVar('HtmlTableFirstcolColour')\"><hr><b>\2</b><br>", txt)
  #else:
    #s = txt

  ### find all occurences of strings between &. These are the tables.
  #txt = s
  #regex = re.compile(r"  (&&) (.*?) (&&) ", re.X)
  #m = regex.findall(txt)
  #if m:
    #s = regex.sub(r"\2", txt)
  #else:
    #s = txt

  return s, d

def reg_command(self, txt):
  regex = re.compile(r"  ~ (.*?)( [^\~\~]* ) ~ ", re.X)
  m = regex.findall(txt)
  colour = OV.GetParam('gui.html.highlight_colour')
  if m:
    s = regex.sub(r'''
    <br>
    <br>
    <b>
    <font color=%s>
      \2
    </font>
    </b>
    <br>
    ''' %colour, txt)
  else:
    s = txt
  return s

def changeBoxColour(ctrl_name,colour):
  if olx.html.GetValue(ctrl_name) in ('?',''):
    olx.html.SetBG(ctrl_name,colour)
  else:
    olx.html.SetBG(ctrl_name,OV.FindValue('gui_html_input_bg_colour'))
  return ''
OV.registerFunction(changeBoxColour)
def switchButton(name,state):
  if state == 'off':
    copy_from = "%soff.png" %name
    copy_to = "%s.png" %name
    OV.CopyVFSFile(copy_from, copy_to)
  else:
    copy_from = "%son.png" %name
    copy_to = "%s.png" %name
    OV.CopyVFSFile(copy_from, copy_to)
  OV.UpdateHtml()
  return ""
OV.registerFunction(switchButton)

def bgcolor(ctrl_name):
  value = olx.html.GetValue(ctrl_name)
  if value in ('?',''):
    colour = "#FFDCDC"
  else:
    #colour = '#ff0000'
    colour = OV.GetParam('gui.html.input_bg_colour').hexadecimal
  return colour
OV.registerFunction(bgcolor)

def getStyles(style_name):
  styles_path = path_from_phil(OV.GetParam('user.report.styles_base_path'))
  if not styles_path:
    styles_path = "%s/etc/CIF/styles" %OV.BaseDir()
    OV.SetParam('user.report.styles_base_path', styles_path)
  if style_name and not style_name.endswith('.css'):
    style_name += '.css'
  elif not style_name:
    return ''
  if not os.path.exists(style_name):
    style_name = '%s/%s' %(styles_path,style_name)
  if not os.path.isfile(style_name):
    return ''
  css = open(style_name,'r').read()
  styleHTML = """
<style type="text/css">
<!--
%s
-->
</style>
""" %css
  return styleHTML
OV.registerFunction(getStyles)

def getPrintStyles(fileName):
  cssPath = '%s/etc/CIF/styles/%s.css' %(OV.BaseDir(),fileName)
  if not os.path.exists(cssPath): return ''
  css = open(cssPath,'r').read()
  styleHTML = """
<style type="text/css" media="print">
<!--
%s
-->
</style>
""" %css
  return styleHTML
OV.registerFunction(getPrintStyles)

def path_from_phil(p):
  if not p:
    p = "%s/etc/CIF/templates" %OV.BaseDir()
  if "()" in p:
    base = p.split('()')
    _ = getattr(OV, base[0])
    path = _()
    p = os.path.join(path, base[1])
  return p

def getStylesList():
  styles_path = path_from_phil(OV.GetParam('user.report.styles_base_path'))
  if not styles_path or not os.path.exists(styles_path):
    styles_path = "%s/etc/CIF/styles" %OV.BaseDir()
    OV.SetParam('user.report.styles_base_path', styles_path)
  styles = os.listdir("%s" %styles_path)
  exclude = set(("rsc.css", "thesis.css", "custom.css"))
  stylesList = ";".join("%s" %style for style in styles\
    if style.endswith('.css') and style not in exclude)
  stylesList += ";++CHOOSE++"
  return stylesList
OV.registerFunction(getStylesList)

def getTemplatesList():
  templates_path = path_from_phil(OV.GetParam('user.report.templates_base_path'))
  if not templates_path:
    templates_path = "%s/etc/CIF/templates" %OV.BaseDir()
    OV.SetParam('user.report.templates_base_path', templates_path)
  templates = os.listdir("%s" %templates_path)
  exclude = ("footer.htm")
  exclude = ()
  templatesList = ";".join("%s.htm" %template[:-4] for template in templates
                        if template not in exclude and template.endswith('.htm') or template.endswith('.rtf') or template.endswith('.tex'))
  templatesList += ";++CHOOSE++"
  return templatesList
OV.registerFunction(getTemplatesList)

def SetReportStyle(val):
  styles_path = path_from_phil(OV.GetParam('user.report.styles_base_path'))
  if "++" in val:
    res = olex.f("FileOpen('Choose style File','.css files|*.css','%s')" %styles_path)
    if not res:
      return
    _ = os.path.split(res)
    styles_path = _[0]
    style_file = _[1]
    OV.SetParam('user.report.styles_base_path', styles_path)
    OV.UpdateHtml()
  else:
    style_file = val
  OV.SetParam('user.report_style', style_file)
  OV.SetParam('user.report.style_full_path', "%s/%s" %(styles_path, style_file))
OV.registerFunction(SetReportStyle)

def SetReportTemplate(val,which):
  templates_path = path_from_phil(OV.GetParam('user.report.templates_base_path'))
  if "++" in val:
    res = olex.f("FileOpen('Choose Template File','.htm files|*.htm','%s')" %templates_path)
    if not res:
      return
    _ = os.path.split(res)
    templates_path = _[0]
    template_file = _[1]
    OV.SetParam('user.report.templates_base_path', templates_path)
    OV.UpdateHtml()
  else:
    template_file = val
  OV.SetParam('user.report_%s' %which, template_file)
  OV.SetParam('user.report.%s_full_path' %which, "%s/%s" %(templates_path, template_file))
OV.registerFunction(SetReportTemplate)

def getPopBoxPosition():
  ws = olx.GetWindowSize('html')
  ws = ws.split(",")
  WS = olx.GetWindowSize('main-cs', ws[0], int(ws[3]))
  WS = WS.split(",")
  sX = int(WS[0])
  sY = int(WS[1]) -2
  sTop = int(ws[1])
  return (sX, sY, sTop)

def get_template(name, base_path=None):
  if not base_path:
    base_path = os.path.join(OV.BaseDir(), 'etc', 'gui', 'blocks', 'templates')
  template = r"%s%s%s.htm" %(base_path, os.sep, name)
  if os.path.exists(template):
    rFile = open(template, 'r')
    s = rFile.read()
    rFile.close()
    return s
  else:
    return None

def makeHtmlBottomPop(txt=None, name='test', replace=None, modequalifiers=None,
     pb_height = 50, y = 0):
  global HaveModeBox
  import OlexVFS
  from ImageTools import IT
  metric = getPopBoxPosition()
  if not txt:
    txt = get_template(name)
    txt = txt.replace(r"<MODENAME>",replace.upper())
    txt = txt.replace(r"<MODEQUALIFIERS>",modequalifiers.upper())
  txt = "$run(focus)\n" + txt
  pop_html = name
  pop_name = name
  htm_location = "%s.htm" %pop_html
  OlexVFS.write_to_olex(htm_location,txt)
  width = int(olx.html.ClientWidth('self'))
  x = metric[0]
  if not y:
    y = metric[1] - pb_height
  pstr = "popup %s '%s' -t='%s' -w=%s -h=%s -x=%s  -y=%s" %(
    pop_name, htm_location, pop_name, width, pb_height, x, y)

  if HaveModeBox:
    OV.cmd(pstr)
  else:
    OV.cmd(pstr)
    olx.html.SetBorders(pop_name,0)
    OV.cmd(pstr)
    olx.html.SetBorders(pop_name,0)
    OV.UpdateHtml(pop_name)
    HaveModeBox = True

OV.registerMacro(makeHtmlBottomPop, 'txt-Text to display&;name-Name of the Bottom html popupbox')

def OnModeChange(*args):
  global last_mode, last_mode_options
  d = {
    'move sel':'three-Move_Near',
    'move sel -c=':'three-Copy_Near',
    'grow':'three-Grow_Mode',
    'split -r=EADP':'button_full-Move_atoms_or_model_disorder',
    'split':'button_full-move_atoms_or_model_disorder',
    'fit':'button_full-fit_group',
    'name':'small-Name',
    'fixu':'small-Fix_U',
    'fixxyz':'small-Fix_xyz',
    'hfix':'small-HFIX',
    'occu':'small-Set_OCCU',
    'off':None
  }
  name = 'mode'
  mode = ""
  i = 0
  mode_disp = ""
  args = args[0].split()
  modes_with_other_stuff_l = ["grow", "name"]
  modequalifiers = ""
  for item in args:
    for m in modes_with_other_stuff_l:
      if m in item:
        item = m
    i += 1
    mode = mode + " " + item
    if i < 2:
      mode_disp += " " + item
    if i >= 2:
      modequalifiers += item
  modequalifiers = modequalifiers.strip("=")
  mode = mode.strip()
  mode_disp = mode_disp.strip()
  mode_short = mode_disp

  if 'name -t=' in mode:
    element = mode.split('=')[1]
    if element:
      active_mode = 'btn-element%s' %element
    else:
      return

  elif 'name' in mode:
    active_mode = 'button_small-name'
  elif 'grow' in mode:
    active_mode = 'button-grow_mode'
  elif 'hfix' in mode:
    active_mode = 'button_small-hfix'
    mode_short = 'hfix'
  else:
    active_mode = d.get(mode, None)

#  mode_disp = "%s" %mode

  if last_mode == active_mode and last_mode is not None and\
     modequalifiers == last_mode_options:
    return

  if not active_mode:
    active_mode = d.get(mode_disp, None)

  if mode == 'off':
    OV.SetParam('olex2.in_mode',None)
    OV.cmd("html.hide pop_%s" %name)
    if not last_mode: return
    control = "IMG_%s" %last_mode.upper()
    if OV.IsControl(control):
      if "element" in control.lower():
        gui.tools.MakeElementButtonsFromFormula()
      else:
        OV.SetImage(control,"up=%soff.png,hover=%shover.png" %(last_mode,last_mode))
    OV.cmd("html.hide pop_%s" %name)
    last_mode = None
    last_mode_options = None
    OV.SetParam('olex2.in_mode',None)
    OV.SetParam('olex2.short_mode',None)
    OV.SetParam('olex2.full_mode',None)
  else:
    OV.SetParam('olex2.in_mode',mode.split("=")[0])
    OV.SetParam('olex2.full_mode',mode)
    makeHtmlBottomPop(replace='mode_disp', name='pop_mode', modequalifiers=modequalifiers, pb_height=50)
    if active_mode:
      control = "IMG_%s" %active_mode.upper()
      if OV.IsControl(control):
        OV.SetImage(control,"up=%son.png,hover=%son.png" %(active_mode,active_mode))

    if last_mode:
      control = "IMG_%s" %last_mode.upper()
      if OV.IsControl(control):
        OV.SetImage(control,"up=%soff.png,hover=%shover.png" %(last_mode,last_mode))

    last_mode = active_mode
    last_mode_options = modequalifiers
    OV.SetParam('olex2.in_mode',mode.split("=")[0])
    OV.SetParam('olex2.short_mode',mode_short)
    last_mode = active_mode
  OV.Refresh()
##  if active_mode == last_mode:
##    active_mode = None

  ## Deal with button images
  #if not active_mode:
    #if not last_mode: return
    #use_image = "%soff.png" %last_mode
    #OV.SetImage("IMG_%s" %last_mode.upper(),use_image)
    #copy_to = "%s.png" %last_mode
    #OV.CopyVFSFile(use_image, copy_to,2)
    #OV.cmd("html.hide pop_%s" %name)
    #last_mode = None
  #else:
    #if last_mode:
      #use_image = "%soff.png" %last_mode
      #OV.SetImage("IMG_%s" %last_mode.upper(),use_image)
      #copy_to = "%s.png" %last_mode
      #OV.CopyVFSFile(use_image, copy_to,2)
      #if active_mode == last_mode:
        #last_mode = None
        #active_mode = None
        #OV.SetVar('olex2_in_mode','False')
        #OV.cmd("html.hide pop_%s" %name)

    #if active_mode:
      #use_image= "%son.png" %active_mode
      #OV.SetImage("IMG_%s" %active_mode.upper(),use_image)
      #copy_to = "%s.png" %active_mode
      #OV.CopyVFSFile(use_image, copy_to,1)
      #last_mode = active_mode
      #OV.SetVar('olex2_in_mode',mode.split("=")[0])

OV.registerCallback('modechange',OnModeChange)

def OnStateChange(*args):
  name = args[0]
  state = args[1]
  d = {
    'basisvis':'three-Show_Basis',
    'cellvis':'three-Show_Cell',
    'htmlttvis':'button-tooltips',
    'helpvis':'button-help',
  }
  img_base = d.get(name)

  if not img_base:
    return False

  state = olx.CheckState(name)
  if state == "true":
    use_image= "up=%son.png" %img_base
    hover_image = "hover=%son.png" %img_base
  else:
    use_image = "up=%soff.png" %img_base
    hover_image = "hover=%shover.png" %img_base
  OV.SetImage("IMG_%s" %img_base.upper(),use_image)
  OV.SetImage("IMG_%s" %img_base.upper(),hover_image)
  OV.Refresh()
  return True

OV.registerCallback('statechange',OnStateChange)

def _check_modes_and_states(name):
  ## Modes
  d = {
    'button-move_near':'movesel',
    'button-copy_near':'movesel -c=',
    'button-grow_mode':'grow',
    'button_full-move_atoms_or_model_disorder':'split -r=EADP',
    'button_full-move_atoms_or_model_disorder':'split',
    'button_small-name':'name',
    'button-fix_u':'fixu',
    'button-fix_xyz':'fixxyz',
    'button-set_occu':'occu',
    'button_small-hfix':'hfix',
  }
  if name in d:
    if 'near' in name:
      mode = OV.GetParam('olex2.full_mode')
    else:
      mode = OV.GetParam('olex2.short_mode')
      if mode:
        if 'hfix' in mode: mode = "hfix"
    if mode == d.get(name):
      return True
  ##States
  d = {
    'button-show_basis':'basisvis',
    'button-show_cell':'cellvis',
    'button-tooltips':'htmlttvis',
    'button-help':'helpvis',
  }
  if name in d:
    state = olx.CheckState(d.get(name))
    if state == 'true':
      return True

  ## Hand-crafted buttons
  if name == 'button_full-move_atoms_or_model_disorder':
    if OV.GetParam('olex2.in_mode') == 'split -r':
      return True
  buttons = ['full-Electron_Density_Map', 'small-Map']
  vis = False
  if olx.xgrid.Visible() == 'true' and OV.GetVar("olex2.map_type") == "eden":
    vis = True
  if name in buttons:
    if vis:
      return True
  buttons = ['small-Void']
  if name in buttons:
    if vis:
      return True
  buttons = ['small-Mask']
  if name in buttons:
    if vis:
      return True

  buttons = ['btn-solve']
  if name in buttons:
    if OV.GetParam('olex2.solving') == True:
      return True
  buttons = ['btn-refine']
  if name in buttons:
    if OV.GetParam('olex2.refining') == True:
      return True
  buttons = ['btn-report']
  if name in buttons:
    if OV.GetParam('olex2.reporting') == True:
      return True

  return False

def CheckForImage(name):
  from PilTools import TI
  if olx.fs.Exists(name) != "true":
    if "logo" in name:
      TI.create_logo()
    elif "sNumTitle" in name:
      sNum = OV.FileName()
      image = TI.make_timage('snumtitle', sNum, 'on', titleCase=False)
      name = r"sNumTitle.png"
      OlexVFS.save_image_to_olex(image, name, 1)
      OV.CopyVFSFile(name, 'SNUMTITLE',2)
OV.registerFunction(CheckForImage)

def MakeHoverButton(name, cmds, onoff="off", btn_bg='table_firstcol_colour'):
  from PilTools import TI
  #global time_add
  #t = time.time()
  btn_type = name.split("-")[0]
  btn_name = name.split("@")[0]#.lower()

  if olx.fs.Exists(btn_name + "off.png") != "true":
    TI.produce_buttons(button_names=[name], btn_type="_%s" %btn_type)
  solo = OV.GetParam('user.solo')
  if onoff != "on":
    on = _check_modes_and_states(name)
    if cmds.lower().startswith("html.itemstate") and "h2" in cmds:
      item = cmds.split()[1]
      tab = item.split("h2-")[1].split("-")[0]
      item_name = item.split("h2-")[1].split("-")[1]
      if solo:
        cmds = "html.itemstate h2-%s* 2>>%s" %(tab,cmds)
    if solo:
      if 'metadata' in cmds:
        cmds = "html.itemstate metadata* 2>>%s" %(cmds)
  else:
    on = True
  if on:
    txt = MakeHoverButtonOn(name, cmds, btn_bg)
  else:
    txt = MakeHoverButtonOff(name, cmds, btn_bg)
  #diff = (time.time() - t)
  #time_add += diff
  #print "MakeHoverButtons took %.6fs (%.4f)" %(diff, time_add)
  return txt

OV.registerFunction(MakeHoverButton)

def MakeHoverButtonOff(name, cmds, btn_bg='table_firstcol_colour'):
  if "None" in name:
    return ""
  global hover_buttons
  click_console_feedback = False
  n = name.split("-")
  d = {'bgcolor': OV.GetParam('gui.html.%s' %btn_bg)}
  if len(n) > 1:
    target=" ".join(n[1:])
  else:
    target="Not Defined"
  if '@' in name:
    tool_img = name.split('@')[0]
  else:
    tool_img = name#.lower()
  d.setdefault('tool_img', tool_img)
  d.setdefault('nameupper', name.upper())
  d.setdefault('name', name)
  #d.setdefault('bt', n[0])
  #d.setdefault('bn', n[1])
  #d.setdefault('BT', n[0].upper())
  #d.setdefault('BN', n[1].upper())
  d.setdefault('cmds', cmds.replace("\(","("))
  if "cbtn" in cmds.lower():
    target = target + "-settings"
  d.setdefault('target', OV.TranslatePhrase("%s-target" %target))
  if click_console_feedback:
    d.setdefault('feedback',">>echo '%(target)s: OK'" %target)
  else:
    d.setdefault('feedback',"")
  on = "on"
  off = "off"
  hover = "hover"
  down = "off"

  if OV.GetParam('gui.image_highlight') == name:
    on = "highlight"
    off = "highlight"
  if not hover_buttons:
    on = "on"
    off = "off"
    hover = "off"
  d.setdefault('on', on)
  d.setdefault('off', off)
  d.setdefault('down', down)
  d.setdefault('hover', hover)
  txt = '''
<font size='$GetVar(HtmlFontSizeControls)'>
<input
  name="IMG_%(nameupper)s"
  type="button"
  image="up=%(tool_img)s%(off)s.png,down=%(tool_img)s%(down)s.png,hover=%(tool_img)s%(hover)s.png"
  hint="%(target)s"
  onclick="%(cmds)s%(feedback)s"
  bgcolor="%(bgcolor)s"
>
</font>
'''%d
  return txt
OV.registerFunction(MakeHoverButtonOff)

def MakeHoverButtonOn(name,cmds,btn_bg='table_firstcol_colour'):
  if "None" in name:
    return ""
  global hover_buttons
  btn_type = name.split("-")[0]
  btn_name = name.split("@")[0]#.lower()

  if olx.fs.Exists(btn_name + "off.png") != "true":
    from PilTools import TI
    TI.produce_buttons(button_names=[name], btn_type="_%s" %btn_type)

  click_console_feedback = False
  n = name.split("-")
  d = {'bgcolor': OV.GetParam('gui.html.%s' %btn_bg)}
  target=" ".join(n[1:])
  if '@' in name:
    tool_img = name.split('@')[0]
  else:
    tool_img = name#.lower()
  d.setdefault('tool_img', tool_img)
  d.setdefault('nameupper', name.upper())
  d.setdefault('cmds', cmds.replace("\(","("))
  if "cbtn" in cmds.lower():
    target = target + "-settings"
  d.setdefault('target', OV.TranslatePhrase("%s-target" %target))
  if click_console_feedback:
    d.setdefault('feedback',">>echo '%(target)s: OK'" %target)
  else:
    d.setdefault('feedback',"")
  on = "on"
  off = "off"
  hover = "hoveron"
  down = "on"

  if OV.GetParam('gui.image_highlight') == name:
    on = "highlight"
    off = "highlight"
  if not hover_buttons:
    on = "on"
    off = "off"
    hover = "on"
  d.setdefault('on', on)
  d.setdefault('off', off)
  d.setdefault('down', down)
  d.setdefault('hover', hover)

  txt = '''
<font size='$GetVar(HtmlFontSizeControls)'>
<input
  name="IMG_%(nameupper)s"
  type="button"
  image="up=%(tool_img)s%(on)s.png,down=%(tool_img)s%(down)s.png,hover=%(tool_img)s%(hover)s.png"
  hint="%(target)s"
  onclick="%(cmds)s%(feedback)s"
  bgcolor="%(bgcolor)s"
>
</font>
'''%d
  return txt
OV.registerFunction(MakeHoverButtonOn)

def MakeActiveGuiButton(name,cmds,toolname=""):
  n = name.split("-")
  d = {}
  if toolname:
    target=toolname#.lower()
  else:
    target=n[1]
  d.setdefault('bt', n[0])
  d.setdefault('bn', n[1])
  d.setdefault('BT', n[0].upper())
  d.setdefault('BN', n[1].upper())
  d.setdefault('cmds', cmds.replace("\(","("))
  d.setdefault('target', OV.TranslatePhrase("%s-target" %target))
  d.setdefault('toolname', toolname)

  txt = '''
    <a href="spy.InActionButton(%(bt)s-%(bn)s,on,%(toolname)s)>>refresh>>%(cmds)s>>echo '%(target)s: OK'>>spy.InActionButton(%(bt)s-%(bn)s,off,%(toolname)s)" target="%(target)s">
      <zimg name=IMG_%(BT)s-%(BN)s%(toolname)s border="0" src="%(bt)s-%(bn)s.png">
    </a>
    '''%d
  txt = '''
$spy.MakeHoverButton(%(name)s,%(cmds)s)''' %d
  return txt
OV.registerFunction(MakeActiveGuiButton)

def InActionButton(name,state,toolname=""):
  if state == "on":
    use_image= "%son.png" %name
    OV.SetImage("IMG_%s%s" %(name.upper().lstrip(".PNG"),toolname),use_image)
  if state == "off":
    use_image= "%soff.png" %name
    OV.SetImage("IMG_%s%s" %(name.upper().lstrip(".PNG"),toolname), use_image)
  return True

OV.registerFunction(InActionButton)
def PopProgram(txt="Fred"):
  name = "pop_prg_analysis"
  makeHtmlBottomPop({'txt':txt, 'name':name}, pb_height=225)

def PopBanner(txt='<zimg src="banner.png">'):
  name = "pop_banner"
  makeHtmlBottomPop({'txt':txt, 'name':name}, pb_height=65, y = 130,panel_diff=22)
OV.registerFunction(PopBanner)
def doBanner(i):
  i = int(i)
  #olx.html.SetImage("BANNER_IMAGE","banner_%i.png" %i)
  OV.CopyVFSFile("banner_%i.png" %i, "banner.png")
  OV.CopyVFSFile("banner_%i.htm" %i, "banner.htm")
  offset = 10
  target = 2
  ist = ""
  cmds = []
  ist += "aio-* 0 "

  d = olx.banner_slide.get(i,0)
  if not d:
    i = i + 1
    d = olx.banner_slide.get(i,0)
  if not d:
    i = i -2
    d = olx.banner_slide.get(i,0)
  if not d:
#    print i, "Nothing"
    return

#  print i, d.get('name')
  OV.SetParam('snum.refinement.banner_slide', i)

  ist += d.get('html.ItemState',0)
  cmds += d.get('cmd',"").split(">>")

  OV.setItemstate(ist)

  for cmd in cmds:
    OV.cmd(cmd)

OV.registerFunction(doBanner)
def getTip(number=0): ##if number = 0: get random tip, if number = "+1" get next tip, otherwise get the named tip
  from random import randint
  global current_tooltip_number
  max_i = 20
  if number == '0':
    txt = "tip-0"
    j = 0
    while "tip-" in txt:
      j += 1
      i = randint (1,max_i)
      if i == current_tooltip_number: continue
      txt = OV.TranslatePhrase("tip-%i" %i)
      if j > max_i * 2: break
    txt += '''
  </td>
</tr>
%s''' %make_edit_link("tip", "%i" %i)

  elif number == "+1":
    i = current_tooltip_number + 1
    txt = OV.TranslatePhrase("tip-%i" %i)
    if "tip-" in txt:
      i = 1
      txt = OV.TranslatePhrase("tip-%i" %i)
    txt += '''
  </td>
</tr>
%s''' %make_edit_link("tip", "%i" %i)

  elif number == "list":
    txt = ""
    for i in range(max_i):
      if i == 0: continue
      t = OV.TranslatePhrase("tip-%i" %i)
      if "tip-" in t:
        break
      t = t.split("^t")[0]
      t += "^t"
      t = t.strip()
      txt += '''
      <b>
        %i.
      </b>
      <a href='spy.GetTip(%i)>>html.Update'>%s</a>
      <br>''' %(i, i,t)
    txt = txt.rstrip("<br>")
    i = 0
  else:
    i = int(number)
    txt = OV.TranslatePhrase("tip-%i" %i)
    txt += '''
  </td>
</tr>
%s''' %make_edit_link("tip", "%i" %i)
  current_tooltip_number = i

  txt, d = format_help(txt)
  if number == "list":
    txt = txt.replace("&nbsp;","")
  OV.SetVar("current_tooltip_number",i)
  try:
    txt = txt.encode('utf-8')
  except:
    print("Can't decode %s" %txt)
  OV.write_to_olex("tip-of-the-day-content.htm", txt)
  return True
OV.registerFunction(getTip)

##TO GO!
#def getNextTip():
  #global current_tooltip_number
  #next = current_tooltip_number + 1
  #txt = OV.TranslatePhrase("tip-%i" %i)
  #if "tip-" in txt:
    #i = 1
    #txt = OV.TranslatePhrase("tip-%i" %i)
    #txt += " | <font size=1>This is Tip %i</font>" %i
  #current_tooltip_number = i
  #OV.write_to_olex("tip-of-the-day.htm", txt)
  #return True

def getGenericSwitchName(name):
  remove_l = ['work-', 'view-', 'info-', 'tools-', 'aio-', 'home-']
  name_full = name
  na = name.split("-")
  if len(na) > 1:
    for remove in remove_l:
      if name.startswith(remove):
        name = name.split(remove,1)[1]
        break
  return name
OV.registerFunction(getGenericSwitchName)

def getGenericSwitchNameTranslation(name):
  name = getGenericSwitchName(name)
  if name:
    text = OV.TranslatePhrase(getGenericSwitchName(name))
  else:
    text = "No text!"
  return text
OV.registerFunction(getGenericSwitchNameTranslation)

def setDisplayQuality(q=None):
  OV.setDisplayQuality(q)
OV.registerFunction(setDisplayQuality)

def include_block(path):
  f = open('%s/etc/%s' %(OV.BaseDir(),path),'r')
  txt = f.read()
  f.close()
  return txt