__main__.py

# -*- coding: utf-8 -*-
"""
:program:`javaproperties`
-------------------------

.. versionadded:: 0.2.0

NAME
^^^^

:program:`javaproperties` — Basic manipulation of Java ``.properties`` files

SYNOPSIS
^^^^^^^^

.. code-block:: shell

    javaproperties get    [<OPTIONS>] <file> <key> ...
    javaproperties select [<OPTIONS>] <file> <key> ...
    javaproperties set    [<OPTIONS>] <file> <key> <value>
    javaproperties delete [<OPTIONS>] <file> <key> ...
    javaproperties format [<OPTIONS>] [<file>]

.. note::

    If the `javaproperties` package was installed but the
    :program:`javaproperties` script is not present, this command can still be
    run by replacing ``javaproperties`` with ``python -m javaproperties`` on
    the command line.


:command:`get`
^^^^^^^^^^^^^^

.. code-block:: shell

    javaproperties get [<OPTIONS>] <file> <key> ...

Print out the values of the given keys in the given ``.properties`` file.  Each
value is printed out on a separate line with escape sequences interpolated.

If you want the output to also be in ``.properties`` format, see :ref:`select`.

Options
'''''''

.. program:: javaproperties get

.. option:: -d <value>, --default-value <value>

    Default value for undefined keys.  If this option is not specified, keys
    requested on the command line that are not defined in either the main
    ``.properties`` file or the :option:`--defaults` file will cause a warning
    to be printed to stderr and the command to exit with a failure status.

.. option:: -D <file>, --defaults <file>

    ``.properties`` file of default values.  If this option is specified, keys
    requested on the command line that are not defined in the main
    ``.properties`` file will be looked up in this file.

.. option:: -e, --escaped

    Parse the keys and default value specified on the command line for
    ``.properties``-style escape sequences (specifically, those supported by
    `~javaproperties.unescape`)

.. option:: -E <encoding>, --encoding <encoding>

    Specifies the encoding of the input file(s); default value: ``iso-8859-1``
    (a.k.a. Latin-1).  Output always uses the locale's encoding.


.. _select:

:command:`select`
^^^^^^^^^^^^^^^^^

.. code-block:: shell

    javaproperties select [<OPTIONS>] <file> <key> ...

Print out the key-value entries in the given ``.properties`` file for the given
keys.  The output is in ``.properties`` format, reformatted as though by
:ref:`format`.


Options
'''''''

.. program:: javaproperties select

.. option:: -d <value>, --default-value <value>

    Default value for undefined keys.  If this option is not specified, keys
    requested on the command line that are not defined in either the main
    ``.properties`` file or the :option:`--defaults` file will cause a warning
    to be printed to stderr and the command to exit with a failure status.

.. option:: -D <file>, --defaults <file>

    ``.properties`` file of default values.  If this option is specified, keys
    requested on the command line that are not defined in the main
    ``.properties`` file will be looked up in this file.

.. option:: -e, --escaped

    Parse the keys and default value specified on the command line for
    ``.properties``-style escape sequences (specifically, those supported by
    `~javaproperties.unescape`)

.. option:: -E <encoding>, --encoding <encoding>

    Specifies the encoding of the input and output files; default value:
    ``iso-8859-1`` (a.k.a. Latin-1)

.. option:: -o <file>, --outfile <file>

    Write output to this file instead of standard output

.. option:: -s <sep>, --separator <sep>

    Use ``<sep>`` as the key-value separator in the output; default value:
    ``=``


:command:`set`
^^^^^^^^^^^^^^

.. code-block:: shell

    javaproperties set [<OPTIONS>] <file> <key> <value>

Set the value of ``<key>`` in the ``.properties`` file ``<file>`` to
``<value>`` and output the results.  The other entries in the file (including
comments, possibly not including the timestamp; see below) will be left as-is.

Options
'''''''

.. program:: javaproperties set

.. option:: -e, --escaped

    Parse ``<key>`` and ``<value>`` for ``.properties``-style escape sequences
    (specifically, those supported by `~javaproperties.unescape`)

.. option:: -E <encoding>, --encoding <encoding>

    Specifies the encoding of the input and output files; default value:
    ``iso-8859-1`` (a.k.a. Latin-1)

.. option:: -o <file>, --outfile <file>

    Write output to this file instead of standard output

.. option:: -s <sep>, --separator <sep>

    Separate ``<key>`` and ``<value>`` in the output with ``<sep>``; default
    value: ``=``

.. option:: -T, --preserve-timestamp

    Do not modify the timestamp in the ``.properties`` file.  By default, if a
    timestamp is found, it is updated to the current time, even if the rest of
    the file is unchanged.


:command:`delete`
^^^^^^^^^^^^^^^^^

.. code-block:: shell

    javaproperties delete [<OPTIONS>] <file> <key> ...

Remove all entries for the given keys from the given ``.properties`` file and
output the results.  The other entries in the file (including comments,
possibly not including the timestamp; see below) will be left as-is.

Options
'''''''

.. program:: javaproperties delete

.. option:: -e, --escaped

    Parse the keys specified on the command line for ``.properties``-style
    escape sequences (specifically, those supported by
    `~javaproperties.unescape`)

.. option:: -E <encoding>, --encoding <encoding>

    Specifies the encoding of the input and output files; default value:
    ``iso-8859-1`` (a.k.a. Latin-1)

.. option:: -o <file>, --outfile <file>

    Write output to this file instead of standard output

.. option:: -T, --preserve-timestamp

    Do not modify the timestamp in the ``.properties`` file.  By default, if a
    timestamp is found, it is updated to the current time, even if the rest of
    the file is unchanged.


.. _format:

:command:`format`
^^^^^^^^^^^^^^^^^

.. code-block:: shell

    javaproperties format [<OPTIONS>] [<file>]

Normalize the formatting of the given ``.properties`` file (or standard input
if no file is given) and output the results.  All comments, excess whitespace,
invalid escapes, and duplicate keys are removed, and the entries are sorted and
converted to ASCII with `~javaproperties.escape`.

Options
'''''''

.. program:: javaproperties format

.. option:: -E <encoding>, --encoding <encoding>

    Specifies the encoding of the input and output files; default value:
    ``iso-8859-1`` (a.k.a. Latin-1)

.. option:: -o <file>, --outfile <file>

    Write output to this file instead of standard output

.. option:: -s <sep>, --separator <sep>

    Use ``<sep>`` as the key-value separator in the output; default value:
    ``=``
"""

from   __future__ import print_function
import re
import click
from   six        import iteritems
from   .          import __version__
from   .reading   import load, parse, unescape
from   .writing   import dump, join_key_value, java_timestamp, to_comment
from   .util      import infile_type, outfile_type

@click.group(context_settings={"help_option_names": ["-h", "--help"]})
@click.version_option(__version__, '-V', '--version',
                      message='%(prog)s %(version)s')
def javaproperties():
    """ Basic manipulation of Java .properties files """
    pass

@javaproperties.command()
@click.option('-d', '--default-value', metavar='VALUE',
              help='Default value for undefined keys')
@click.option('-D', '--defaults', metavar='FILE', type=infile_type,
              help='.properties file of default values')
@click.option('-e', '--escaped', is_flag=True,
              help='Parse command-line keys & values for escapes')
@click.option('-E', '--encoding', default='iso-8859-1', show_default=True,
              help='Encoding of the .properties files')
@click.argument('file', type=infile_type)
@click.argument('key', nargs=-1, required=True)
@click.pass_context
def get(ctx, default_value, defaults, escaped, file, key, encoding):
    """ Query values from a Java .properties file """
    ok = True
    for k,v in getselect(file, key, defaults, default_value, encoding, escaped):
        if v is None:
            click.echo(u'javaproperties: {0}: key not found'.format(k),
                       err=True)
            ok = False
        else:
            click.echo(v)
    ctx.exit(0 if ok else 1)

@javaproperties.command()
@click.option('-d', '--default-value', metavar='VALUE',
              help='Default value for undefined keys')
@click.option('-D', '--defaults', metavar='FILE', type=infile_type,
              help='.properties file of default values')
@click.option('-e', '--escaped', is_flag=True,
              help='Parse command-line keys & values for escapes')
@click.option('-E', '--encoding', default='iso-8859-1', show_default=True,
              help='Encoding of the .properties files')
@click.option('-o', '--outfile', type=outfile_type, default='-',
              help='Write output to this file')
@click.option('-s', '--separator', default='=', show_default=True,
              help='Key-value separator to use in output')
@click.argument('file', type=infile_type)
@click.argument('key', nargs=-1, required=True)
@click.pass_context
def select(ctx, default_value, defaults, escaped, separator, file, key,
           encoding, outfile):
    """ Extract key-value pairs from a Java .properties file """
    ok = True
    with click.open_file(outfile, 'w', encoding=encoding) as fpout:
        print(to_comment(java_timestamp()), file=fpout)
        for k,v in getselect(file, key, defaults, default_value, encoding,
                             escaped):
            if v is None:
                click.echo(u'javaproperties: {0}: key not found'.format(k),
                           err=True)
                ok = False
            else:
                print(join_key_value(k, v, separator=separator), file=fpout)
    ctx.exit(0 if ok else 1)

@javaproperties.command('set')
@click.option('-e', '--escaped', is_flag=True,
              help='Parse command-line keys & values for escapes')
@click.option('-E', '--encoding', default='iso-8859-1', show_default=True,
              help='Encoding of the .properties file')
@click.option('-s', '--separator', default='=', show_default=True,
              help='Key-value separator to use in output')
@click.option('-o', '--outfile', type=outfile_type, default='-',
              help='Write output to this file')
@click.option('-T', '--preserve-timestamp', is_flag=True,
              help='Keep the timestamp from the input file')
@click.argument('file', type=infile_type)
@click.argument('key')
@click.argument('value')
def setprop(escaped, separator, outfile, preserve_timestamp, file, key, value,
            encoding):
    """ Set values in a Java .properties file """
    if escaped:
        key = unescape(key)
        value = unescape(value)
    with click.open_file(file, encoding=encoding) as fpin:
        with click.open_file(outfile, 'w', encoding=encoding) as fpout:
            setproperties(fpin, fpout, {key: value}, preserve_timestamp,
                          separator)

@javaproperties.command()
@click.option('-e', '--escaped', is_flag=True,
              help='Parse command-line keys & values for escapes')
@click.option('-E', '--encoding', default='iso-8859-1', show_default=True,
              help='Encoding of the .properties file')
@click.option('-o', '--outfile', type=outfile_type, default='-',
              help='Write output to this file')
@click.option('-T', '--preserve-timestamp', is_flag=True,
              help='Keep the timestamp from the input file')
@click.argument('file', type=infile_type)
@click.argument('key', nargs=-1, required=True)
def delete(escaped, outfile, preserve_timestamp, file, key, encoding):
    """ Remove values from a Java .properties file """
    if escaped:
        key = list(map(unescape, key))
    with click.open_file(file, encoding=encoding) as fpin:
        with click.open_file(outfile, 'w', encoding=encoding) as fpout:
            setproperties(fpin, fpout, dict.fromkeys(key), preserve_timestamp)

@javaproperties.command()
@click.option('-E', '--encoding', default='iso-8859-1', show_default=True,
              help='Encoding of the .properties file')
@click.option('-o', '--outfile', type=outfile_type, default='-',
              help='Write output to this file')
@click.option('-s', '--separator', default='=', show_default=True,
              help='Key-value separator to use in output')
@click.argument('file', type=infile_type, default='-')
def format(outfile, separator, file, encoding):
    """ Format/"canonicalize" a Java .properties file """
    with click.open_file(file, encoding=encoding) as fpin:
        with click.open_file(outfile, 'w', encoding=encoding) as fpout:
            dump(load(fpin), fpout, sort_keys=True, separator=separator)

def getproperties(fp, keys):
    keys = set(keys)
    def getprops(seq):
        props = {}
        for k,v in seq:
            if k in keys:
                props[k] = v
        return props
    return load(fp, object_pairs_hook=getprops)

def getselect(file, key, defaults, default_value, encoding, escaped):
    if escaped:
        key = list(map(unescape, key))
        if default_value is not None:
            default_value = unescape(default_value)
    with click.open_file(file, encoding=encoding) as fp:
        props = getproperties(fp, key)
    if defaults is not None:
        with click.open_file(defaults, encoding=encoding) as fp:
            defaults = getproperties(fp, key)
    else:
        defaults = {}
    for k in key:
        v = default_value
        if k in props:
            v = props[k]
        elif k in defaults:
            v = defaults[k]
        yield (k,v)

TIMESTAMP_RGX = r'^\s*[#!]\s*\w+ \w+ [ \d]?\d \d\d:\d\d:\d\d \w* \d{4,}\s*$'

def setproperties(fpin, fpout, newprops, preserve_timestamp=False,
                  separator='='):
    in_header = True
    prevsrc = None
    for k, _, src in parse(fpin):
        if in_header:
            if k is None:
                if prevsrc is not None:
                    print(prevsrc, end='', file=fpout)
                prevsrc = src
                continue
            else:
                if prevsrc is not None:
                    if preserve_timestamp:
                        print(prevsrc, end='', file=fpout)
                    else:
                        if not re.match(TIMESTAMP_RGX, prevsrc, flags=re.U):
                            print(prevsrc, end='', file=fpout)
                        print(to_comment(java_timestamp()), file=fpout)
                elif not preserve_timestamp:
                    print(to_comment(java_timestamp()), file=fpout)
                in_header = False
        if k in newprops:
            if newprops[k] is not None:
                print(join_key_value(k, newprops[k], separator=separator),
                      file=fpout)
                newprops[k] = None
        else:
            # In case the last line of the file ends with a trailing line
            # continuation:
            src = re.sub(r'(?<!\\)((?:\\\\)*)\\$', r'\1', src)
            print(src.rstrip('\r\n'), file=fpout)
    for key, value in iteritems(newprops):
        if value is not None:
            print(join_key_value(key, value, separator=separator), file=fpout)

if __name__ == '__main__':
    javaproperties()