alp.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-

# Alp software: Alp time tools
# Copyright (C) 2010  Niels G. W. Serup

# 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 3 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, see <http://www.gnu.org/licenses/>.

# Version:...... 0.1.0
# Maintainer:... Niels G. W. Serup <ngws@metanohi.name>
# Website:...... http://metanohi.name/projects/alp/
# Development:.. http://gitorious.org/Alp

version = (0, 1, 0)

__doc__ = """\
alp
"""

import sys
from datetime import datetime, timedelta
import re
import time as time_module
try:
    import curses
    _has_curses = True
except ImportError:
    _has_curses = False
try:
    import termcolor
    _has_termcolor = True
    colored_orig = termcolor.colored
    _normal_esc_seq = colored_orig('>', 'grey').split('>')[1]
    def _colored(color, typ):
        if color == 'black':
            color = 'grey'
        if typ == 'bg':
            fg_color = None
            bg_color = 'on_' + color
        elif typ == 'fg':
            fg_color = color
            bg_color = None
        return colored_orig('>', fg_color, bg_color).split('>')[0]

    def _formatted(typ):
        try:
            return colored_orig('>', attrs=[typ]).split('>')[0]
        except KeyError:
            if typ == 'normal':
                return _normal_esc_seq
            else:
                return ''
except ImportError:
    _has_termcolor = False
    _colored = lambda color, typ: ''
    _formatted = lambda typ: ''

######################################################################

# Basic constants
_epoch = datetime(2010, 10, 15, 12, 00, 00)
_one_alp = 2 ** 18
_hexalp_divide = 2 ** 14
_qvalp_divide = 2 ** 12
_salp_divide = 2 ** 8
_talp_divide = 2 ** 4

class AlpTime(object):
    """The Alp time object"""
    seconds_since_epoch=None
    seconds=None
    alp=None
    hexalp=None
    qvalp=None
    salp=None
    talp=None
    second=None

    def __init__(self):
        self.speed = 1
        self.set_start_date()

    def set_start_date(self, date=None):
        """Set the start date (using Python's datetime module)"""
        now = datetime.utcnow()
        if date is None:
            date = now
        self.start_date = date
        self.start_diff = self.start_date - _epoch
        self.now_diff = self.start_date - now
        self.update()

    def get_start_date(self):
        """Get the start date"""
        return self.start_date

    def set_speed(self, speed=1):
        """Set the debug speed"""
        self.speed = speed

    def get_speed(self):
        """Get the debug speed"""
        return self.speed

    def get_seconds_since_epoch(self, date=None):
        """Get the number of seconds since epoch"""
        if date is None:
            date = datetime.utcnow() + self.now_diff
        diff = self.start_diff + (date - self.start_date) * self.speed
        return diff.days * 86400 + diff.seconds, diff

    def update(self, date=None):
        """Update the internal time"""
        passed, diff = self.get_seconds_since_epoch(date)
        self.date = self.start_date + diff
        self.real_date = self.start_date + diff - self.start_diff

        seconds_total = passed % _one_alp
        alp = passed / _one_alp
        seconds_left = seconds_total
        hexalp = seconds_left / _hexalp_divide
        seconds_left -= hexalp * _hexalp_divide
        qvalp = seconds_left / _qvalp_divide
        seconds_left -= qvalp * _qvalp_divide
        salp = seconds_left / _salp_divide
        seconds_left -= salp * _salp_divide
        talp = seconds_left / _talp_divide
        seconds_left -= talp * _talp_divide
        second = seconds_left

        self.seconds_since_epoch = passed
        self.alp = int(alp)
        self.seconds = int(seconds_total)
        self.hexalp = int(hexalp)
        self.qvalp = int(qvalp)
        self.salp = int(salp)
        self.talp = int(talp)
        self.second = int(second)

    def __str__(self):
        return 'AlpTime{alp: %d, hexalp: %d, qvalp: %d, \
salp: %d, talp: %d, second: %d}' % \
            (self.alp, self.hexalp, self.qvalp,
             self.salp, self.talp, self.second)

time = AlpTime()

def update(date=None):
    """Update the internal time"""
    time.update(date)

def set_start_date(date=None):
    """Set the start date (using Python's datetime module)"""
    time.set_start_date(date)

def set_speed(speed=1):
    """Set the debug speed"""
    time.set_speed(speed)

def get_seconds_since_epoch(date=None):
    """Get the number of seconds since epoch"""
    return time.get_seconds_since_epoch(date)

def alp_to_datetime(alp, hexalp, qvalp, salp, talp, second):
    """Return a datetime object of the given Alp date"""
    date = [alp, hexalp, qvalp, salp, talp, second]
    date[0] = int(date[0])
    try:
        for i in range(len(date) - 1):
            date[i + 1] = int(date[i + 1], 16)
    except TypeError:
        pass
    secs = date[0] * _one_alp + date[1] * _hexalp_divide + \
        date[2] * _qvalp_divide + date[3] * _salp_divide + \
        date[4] * _talp_divide + date[5]
    return _epoch + timedelta(seconds=secs)

######################################################################

# Using curses without initscr
_curses_colors = ('BLUE', 'GREEN', 'CYAN', 'RED', 'MAGENTA', 'YELLOW',
                  'WHITE', 'BLACK')

_curses_controls = {
    'up': 'cuu1', 'down': 'cud1', 'left': 'cub1', 'right': 'cuf1',
    'clear_screen': 'clear', 'clear_line': 'el', 'bold': 'bold', 'blink': 'blink', 'dim': 'dim',
    'reverse': 'rev', 'underline': 'smul', 'normal': 'sgr0',
    'hide_cursor': 'civis', 'show_cursor': 'cnorm'
}

_formatter_control_regex = re.compile(r'!\((.+?)\)')
_formatter_bg_color_regex = re.compile(r'#\((.+?)\)')
_formatter_fg_color_regex = re.compile(r'\$\((.+?)\)')
_formatter_codes_regex = re.compile(r'[!#\$]\(.+?\)')
_formatter_not_all_codes_regex = re.compile(
    r'([#\$]\(.+?\)|!\((bold|underline|blink|reverse)\))')

def unformat(text, also_controls=True):
    """Remove formatting codes from text"""
    if also_controls:
        return _formatter_codes_regex.sub('', text)
    else:
        return _formatter_not_all_codes_regex.sub('', text)

def _textlen(text):
    return len(unformat(text).decode('utf-8'))

class BaseFormatter(object):
    """A generic text formatting generator"""

    def _generate_part(self, attr, obj):
        return ''

    def generate(self, text, put=False):
        """
        Generate formatted text according to these codes:

        Foreground color codes: $(color) (e.g. $(green))
        Background color codes: #(color) (e.g. #(red))
        Formatting codes: !(code) (e.g. !(up))

        You can use blue, green, cyan, red, magenta, yellow, white and
        black as colors.

        These are the formatting codes with their actions and curses
        equivalents:
        
        code         | description          | in curses
        -------------+----------------------+----------
        up           | one line up          | cuu1
        down         | one line down        | cud1
        left         | one char left        | cub1
        right        | one char right       | cuf1
        clear_screen | clear screen         | clear
        clear_line   | clear line           | el
        bold         | bold text            | bold
        blink        | blinking text        | blink
        dim          | dim text             | dim
        reverse      | reverse text         | rev
        underline    | underline text       | smul
        normal       | reset all formatting | sgr0
        hide_cursor  | hide cursor          | civis
        show_cursor  | show cursor          | cnorm
        """
        text = _formatter_control_regex.sub(
            lambda obj: self._generate_part('controls', obj), text)
        text = _formatter_bg_color_regex.sub(
            lambda obj: self._generate_part('bg_colors', obj), text)
        text = _formatter_fg_color_regex.sub(
            lambda obj: self._generate_part('fg_colors', obj), text)
        if put:
            sys.stdout.write(text)
        return text

    def clear(self):
        """Clear line"""
        self.generate('!(clear_line)', True)

    def _end(self):
        pass

class _CursesControls(BaseFormatter):
    """
    A text formatting generator and a container of curses escape
    sequences
    """

    def __init__(self):
        self.bg_colors = {}
        self.fg_colors = {}
        self.controls = {}
        self.cols = 0
        self.lines = 0

        if not sys.stdout.isatty():
            return
        try:
            curses.setupterm()
        except Exception, e:
            return
        bg_seq = curses.tigetstr('setab') or curses.tigetstr('setb') or ''
        fg_seq = curses.tigetstr('setaf') or curses.tigetstr('setf') or ''

        # Get escape sequences
        for color in _curses_colors:
            index = getattr(curses, 'COLOR_%s' % color)
            color = color.lower()
            self.bg_colors[color] = curses.tparm(bg_seq, index)
            self.fg_colors[color] = curses.tparm(fg_seq, index)
        for control in _curses_controls:
            self.controls[control] = curses.tigetstr(_curses_controls[control]) or ''

        self.cols = curses.tigetnum('cols')
        self.lines = curses.tigetnum('lines')

    def _generate_part(self, attr, obj):
        return self.__getattribute__(attr)[obj.groups(1)[0]]

    def _end(self):
        print formatter.generate('!(normal)!(show_cursor)!(up)')

class _FakeCursesControls(BaseFormatter):
    """A text formatting generator without curses"""

    def _generate_part(self, attr, obj):
        obj = obj.groups(1)[0]
        if attr == 'bg_colors':
            return _colored(obj, 'bg')
        elif attr == 'fg_colors':
            return _colored(obj, 'fg')
        elif attr == 'controls':
            return _formatted(obj)
        # Else
        return ''

    def _end(self):
        print formatter.generate('!(normal)')

formatter = None
def start_formatter(use_curses=True):
    """
    Start the formatter, making the global formatter variable into an
    instance of a class related with the BaseFormatter class
    """
    global formatter, start_formatter, _using_curses
    if not _has_curses or not use_curses:
        _using_curses = False
        formatter = _FakeCursesControls()
    else:
        formatter = _CursesControls()
        _using_curses = True
    start_formatter = lambda *arg: True
    return formatter

######################################################################

# Date formats
## a '#' in the end returns the number in hex
## an '_' in the end followed by a number prepends
 # (<number> - len(str(number)) zeroes to the number
## Available "units":
### seconds, seconds_since_epoch, alp, hexalp, qvalp, salp, talp, second

_default_hex_date_format = '\
!(bold)#(black)$(yellow)ALP\
#(cyan)$(yellow)&(alp_4)\
#(blue)$(white)/\
#(black)$(green)&(hexalp#)\
$(cyan)&(qvalp)\
$(red)&(salp#)\
&(talp#)\
$(white)&(second#)'
         # e.g. 2403/93EC2

_date_format_unit_regex = re.compile(r'&\((.+?)\)')

def _format_replace(obj):
    unit = obj.groups(1)[0]
    zero_prepend = '_' in unit
    as_hex = unit.endswith('#')
    if zero_prepend:
        spl = unit.split('_')
        unit = spl[0]
        z_num = spl[1]
    elif as_hex:
        unit = unit[:-1]
    value = time.__dict__[unit]
    if zero_prepend:
        return ('%0' + z_num + 'd') % value
    elif as_hex:
        return hex(value)[2:].upper()
    else:
        return str(value)

def get_date_text(date_format=None):
    """Get the Alp date in date_format"""
    if date_format is None:
        date_format = _default_hex_date_format
    return _date_format_unit_regex.sub(_format_replace, date_format)

######################################################################

# Virtual LEDs creating a clock
_clock_letters = 'abcdefghijklmnopqrs'

_default_clock_layout = '''\
   a  b  c  d
e  g  h  i  j
f  k  l  m  n
o  p  q  r  s\
'''

_default_clock_controls = '#(yellow)'

class _Container(object):
    pass

class _Lamp(object):
    """A simulation of a simple lamp"""
    def __init__(self, **kwds):
        self.items = {
            True: _Container(), False: _Container()}
        for key, val in kwds.iteritems():
            if key[-1] in ('0', '1'):
                key_vals = bool(int(key[-1])),
                key = key[:-1]
            else:
                key_vals = True, False

            for x in key_vals:
                self.items[x].__setattr__(key, val)
        for x in self.items.values():
            d = x.__dict__
            if not 'letter' in d:
                x.letter = 'o'
            if not 'fg' in d:
                x.fg = None
            if not 'bg' in d:
                x.bg = None
            if not 'controls' in d:
                x.controls = None

    def generate(self, state):
        info = self.items[state]
        text = info.letter
        pre_esc = ''
        if info.bg:
            pre_esc += '#(%s)' % info.bg
        if info.fg:
            pre_esc += '$(%s)' % info.fg
        if info.controls:
            for x in info.controls:
                pre_esc += '!(' + x + ')'
        text = pre_esc + text
        if pre_esc:
            text += '!(normal)'
        return text

_clock_formatting = {
    'a': _Lamp(bg='yellow', fg='green', letter0='·', letter1='O', controls=['bold']),
    'b': _Lamp(bg='yellow', fg='green', letter0='·', letter1='O', controls=['bold']),
    'c': _Lamp(bg='yellow', fg='green', letter0='·', letter1='O', controls=['bold']),
    'd': _Lamp(bg='yellow', fg='green', letter0='·', letter1='O', controls=['bold']),
    'e': _Lamp(bg='magenta', fg='cyan', letter0='·', letter1='#', controls=['bold']),
    'f': _Lamp(bg='magenta', fg='cyan', letter0='·', letter1='#', controls=['bold']),
    'g': _Lamp(bg='black', fg='red', letter0='·', letter1='o', controls=['bold']),
    'h': _Lamp(bg='black', fg='red', letter0='·', letter1='o', controls=['bold']),
    'i': _Lamp(bg='black', fg='red', letter0='·', letter1='o', controls=['bold']),
    'j': _Lamp(bg='black', fg='red', letter0='·', letter1='o', controls=['bold']),
    'k': _Lamp(bg='blue', fg='red', letter0='·', letter1='o', controls=['bold']),
    'l': _Lamp(bg='blue', fg='red', letter0='·', letter1='o', controls=['bold']),
    'm': _Lamp(bg='blue', fg='red', letter0='·', letter1='o', controls=['bold']),
    'n': _Lamp(bg='blue', fg='red', letter0='·', letter1='o', controls=['bold']),
    'o': _Lamp(bg='yellow', fg='white', letter0='·', letter1='>', controls=['bold']),
    'p': _Lamp(bg='yellow', fg='white', letter0='·', letter1='>', controls=['bold']),
    'q': _Lamp(bg='yellow', fg='white', letter0='·', letter1='>', controls=['bold']),
    'r': _Lamp(bg='yellow', fg='white', letter0='·', letter1='>', controls=['bold']),
    's': _Lamp(bg='yellow', fg='white', letter0='·', letter1='>', controls=['bold']),
    '*': _Lamp(letter0='.', letter1='o') # For eventual non-defined letters
}

_clock_states = {}

def _set_states_from_hex(unit_time, *var):
    global _clock_states
    for i in range(len(var) - 1, -1, -1):
        t = unit_time / 2**i
        unit_time -= t * 2**i
        _clock_states[var[i]] = bool(t)

def _get_states_from_hex(unit_time, w=4):
    num = []
    for i in range(w - 1, -1, -1):
        t = unit_time / 2**i
        unit_time -= t * 2**i
        num.append(bool(t))
    num.reverse()
    return num

def update_clock():
    """Update the internal representation of a physical Alp clock"""
    global _clock_states
    _set_states_from_hex(time.hexalp, 'a', 'b', 'c', 'd')
    _set_states_from_hex(time.qvalp, 'e', 'f')
    _set_states_from_hex(time.salp, 'g', 'h', 'i', 'j')
    _set_states_from_hex(time.talp, 'k', 'l', 'm', 'n')

    Q = _get_states_from_hex(time.second)
    O = Q[0] or Q[1]
    P = Q[2] ^ Q[3]
    R = not Q[2] and not Q[3]

    val_e = (not Q[0] and Q[1] and P) or (Q[0] and \
        ((Q[2] and Q[3]) or (not Q[1] and not Q[2] and not Q[3])))
    val_d = Q[1] and ((not Q[0] and not P) or (Q[0] \
                          and ((not Q[2] and Q[3]) or Q[2])))
    val_c = (Q[3] and (Q[2] or not O)) or (Q[0] and Q[1] and R)
    val_b = (not O and Q[2] and not Q[3]) or (Q[3] and (O or Q[2]))
    val_a = Q[3] or (Q[2] and O)

    _clock_states['o'] = val_e
    _clock_states['p'] = val_d
    _clock_states['q'] = val_c
    _clock_states['r'] = val_b
    _clock_states['s'] = val_a

def _get_clock_formatting(obj):
    obj = obj.groups(1)[0]
    try:
        return _clock_formatting[obj].generate(_clock_states[obj])
    except KeyError:
        return _clock_formatting['*'].generate(_clock_states[obj])

def get_clock_text(clock_layout=None):
    """Get a representation of a physical Alp clock"""
    if clock_layout is None:
        clock_layout = _default_clock_layout

    clock_layout = re.sub(r'([' + _clock_letters + '])',
                        lambda obj: _get_clock_formatting(obj) \
                            + _default_clock_controls, clock_layout)

    text = _default_clock_controls + clock_layout.replace(
        '\n', '!(normal)\n' + _default_clock_controls) + '!(normal)'
    return text

update_clock()

######################################################################

# Gregorian calendar compatibility

# Format (using strftime)
_default_gregorian_date_format = '\
!(bold)#(red)$(white)GR\
#(yellow) \
!(bold)#(cyan)$(yellow)%Y\
#(blue)$(white)-\
#(cyan)$(yellow)%m\
#(blue)$(white)-\
#(cyan)$(yellow)%d\n\
!(bold)#(red)$(white)EGOR\
#(yellow) \
#(black)$(cyan)%H\
#(blue)$(white):\
#(black)$(green)%M\
#(blue)$(white):\
#(black)$(red)%S'

def get_gregorian_date_text(date_format=None):
    """Get the Gregorian date in date_format"""
    if date_format is None:
        date_format = _default_gregorian_date_format
    return time.real_date.strftime(date_format)

######################################################################

# Convenience functions

def update_all(date=None):
    """Update both internal time and clock representation"""
    update(date)
    update_clock()

def print_time(date_format=None, greg_date_format=None,
               clock_layout=None, date=None, show=None,
               formatting=False, continous=None, **kwds):
    """
    Print the time in different ways. All arguments can be given as
    keyword arguments instead of ordinary arguments.
    """
    date_format = date_format or kwds.get('date_format')
    greg_date_format = greg_date_format or kwds.get('greg_date_format')
    clock_layout = clock_layout or kwds.get('clock_layout')
    date = date or kwds.get('date') or datetime.utcnow()
    show = show or kwds.get('show') or ['datetime']
    use_formatting = formatting
    if use_formatting is None:
        use_formatting = kwds.get('formatting')
        if use_formatting is None:
            use_formatting = True
    be_continous = continous or kwds.get('continous') or False

    def _print_part():
        t = ''
        for x in show:
            if x == 'datetime':
                date_text = get_date_text(date_format)
                t += '\n\n' + date_text
            elif x == 'gregdatetime':
                greg_date_text = get_gregorian_date_text(greg_date_format)
                t += '\n\n' + greg_date_text
            elif x == 'clock':
                update_clock()
                clock_text = get_clock_text(clock_layout)
                t += '\n\n' + clock_text
        t = t.strip()
        return t + '!(normal)'
    
    start_formatter()
    formatter.generate('!(hide_cursor)', True)

    update()
    prev = time.seconds_since_epoch

    if not be_continous:
        text = _print_part()
        text = text.replace('\n', '!(normal)\n') + '!(normal)'
        if not use_formatting:
            text = unformat(text, False)
        text = formatter.generate(text)
        if _using_curses:
            print text
        else:
            print text,
        return

    go_up = 0
    try:
        while True:
            update()
            now = time.seconds_since_epoch
            if now > prev:
                prev = now
                if _using_curses:
                    text = '!(up)' * go_up + '!(up)\n' + \
                        _print_part() + '!(up)!(down)'
                else:
                    text = _print_part() + '\n\n'
                text = text.replace('\n', '!(normal)\n') + '!(normal)'
                go_up = text.count('\n') - 1
                if not use_formatting:
                    text = unformat(text, False)
                formatter.generate(text, True)

            sleep_time = 0.5 / time.speed
            if sleep_time < 0.01:
                sleep_time = 0.01
            time_module.sleep(sleep_time)
    except KeyboardInterrupt:
        formatter.generate('\n!(up)' + '!(clear_line)!(up)' * go_up, True)
        raise KeyboardInterrupt()

######################################################################

if __name__ == '__main__':
    from optparse import OptionParser
    class XParser(OptionParser):
        def format_epilog(self, formatter):
            return self.epilog

    parser = XParser(
        usage='Usage: %prog [options] [date]',
        description='Alp time tools',
        version='''Alp software %s
Copyright (C) 2010  Niels G. W. Serup
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.''' % '.'.join(map(str, version)),
        epilog='''
The date format is "GRE:year,month,day,hour,minute,second"
if you specify a date from the Gregorian calendar, or
"ALP:alp,hexalp,qvalp,salp,talp,second" if you specify a date
using the Alp units. If no date is given, it defaults to "now".

Examples:

  Show both the Alp time, the gregorian time, and an Alp clock
    alp -s all -c

  Show only the Alp time:
    alp -c

  Show once, then exit
    alp

  Continously show a clock with no formatting:
    alp -c -F -s clock

''')
    parser.add_option('-s', '--show', dest='show', metavar='TYPE', action='append',
                      help='choose which types of displays to show. You \
can choose between "datetime" (or "1"), "clock" (or "2"), and \
"gregdatetime" (or "3"). You can also set it to "all". This setting can \
be specified more than once, but if it isn\'t given at all, only \
"datetime" is shown')
    parser.add_option('-c', '--continous', dest='continous',
                      action='store_true', default=False,
                      help='Instead of printing the date just once, \
print it again and again until you interrupt it')
    parser.add_option('-F', '--no-formatting', dest='formatting',
                      action='store_false', default=True,
                      help='don\'t attempt to format strings (i.e. using \
colors and making the text bold)')
    parser.add_option('--no-curses', dest='use_curses',
                      action='store_false', default=True,
                      help='do not attempt to use the curses library')
    parser.add_option('--debug-speed', dest='debug_speed',
                      metavar='SPEED', type='int',
                      help='change the speed (default is 1; setting it to \
a higher value makes it go faster).')

    options, args = parser.parse_args()

    try:
        date = args[0].lower().split(':')
        typ = date[0]
        date = date[1].split(',')
        if typ == 'alp':
            date = alp_to_datetime(*date)
        elif typ == 'gre':
            date = datetime(*map(int, date))
    except IndexError:
        date = datetime.utcnow()

    if options.show is None:
        options.show = ['datetime']
    elif 'all' in options.show:
        options.show = ['datetime', 'clock', 'gregdatetime']
    else:
        for i in range(len(options.show)):
            if options.show[i] == '1':
                options.show[i] = 'datetime'
            elif options.show[i] == '2':
                options.show[i] = 'clock'
            elif options.show[i] == '3':
                options.show[i] = 'gregdatetime'

    if options.debug_speed is not None:
        set_speed(options.debug_speed)

    try:
        from setproctitle import setproctitle
        setproctitle('alp')
    except ImportError:
        pass

    start_formatter(options.use_curses)
    set_start_date(date)

    try:
        print_time(date=date, show=options.show,
                   formatting=options.formatting,
                   continous=options.continous)
    except (KeyboardInterrupt, EOFError):
        pass
    finally:
        formatter._end()