#!/usr/bin/env bash

define() { IFS='\n' read -r -d '' ${1} || true ; }

myname="${0##*/}"

define pod <<"=cut"

=encoding utf-8

=head1 NAME

    xlate - TRANSlate CLI front-end for App::Greple::xlate module

=head1 SYNOPSIS

    xlate [ options ] -t lang file [ greple options ]
	-h   help
	-v   show version
	-d   debug
	-n   dry-run
	-a   use API
	-c   just check translation area
	-r   refresh cache
	-u   force update cache
	-s   silent mode
	-e # translation engine (*deepl, gpt3, gpt4, gpt4o)
	-p # pattern to determine translation area
	-x # file containing mask patterns
	-w # wrap line by # width
	-o # output format (*xtxt, cm, ifdef, space, space+, colon)
	-f # from lang (ignored)
	-t # to lang (required, no default)
	-m # max length per API call
	-l # show library files (XLATE.mk, xlate.el)
        --   end of option
        N.B. default is marked as *

    Make options
	-M   run make
	-n   dry-run

    Docker options
	-G   mount git top-level directory
	-H   mount home directory
	-V # specify mount directory
	-U   do not mount
	-R   mount read-only
        -K   do not remove and keep live container
	-X   remove live container
	-E # specify environment variable to be inherited
	-I # docker image or version (default: tecolicom/xlate:version)

	-D * run xlate on the container with the same parameters
	-C * run following command on the container, or run shell
	-L * create or attach to the live container
	N.B. -D/-C/-L terminates option handling

    Control Files:
	*.LANG    translation languates
	*.FORMAT  translation foramt (xtxt, cm, ifdef, colon, space)
	*.ENGINE  translation engine (deepl, gpt3, gpt4, gpt4o)

=head1 VERSION

    Version 0.45

=cut

[[ $pod =~ Version\ +([0-9.]+) ]] && my_version=${BASH_REMATCH[1]}

git_topdir() {
    [ "$(git rev-parse --is-inside-work-tree 2>/dev/null)" == true ] || return
    local         dir="$(git rev-parse --show-superproject-working-tree)"
    [ "$dir" ] || dir="$(git rev-parse --show-toplevel)"
    echo -n $dir
}

get_ip() {
    local ip=$(ifconfig 2>/dev/null | awk '/inet /{print $2}' | tail -1)
    echo $ip
}

warn() {
    [[ $quiet ]] && return
    echo ${1+"$@"} >&2
}

pwd=$(pwd)
owner=tecolicom
repository=$owner/$myname
hostname=
mount=yes
remove=yes
container=
version=
workdir=/work
mount_mode=rw
read_only=
display=
localtime=/etc/localtime
givenname=

ENV=(
    LANG TZ
    HTTP_PROXY HTTPS_PROXY
    http_proxy https_proxy
    TERM_PROGRAM TERM_BGCOLOR COLORTERM
    DEEPL_AUTH_KEY
    OPENAI_API_KEY
    ANTHROPIC_API_KEY
    LLM_PERPLEXITY_KEY
)

container_name() {
    local name
    if [[ $givenname ]]
    then
	name=$givename
    else
	if [[ $image =~ (.*/)?([-_.a-zA-Z]+) ]]
	then name=${BASH_REMATCH[2]}
	else name=$myname
	fi
	[[ $volume ]] && name+=.${volume##*/}
    fi
    echo $name
}

##
## Docker
##
while getopts :dq${DOCKER_OPT:=dURAI:E:HV:GN:XLKCD} OPT
do
    [ "$XLATE_RUNNING_ON_DOCKER" ] && break
    case $OPT in
	d) debug=yes ; set -x ;;
	q) quiet=yes ;;
	U) mount= ;;
	R) mount_mode=ro ;;
	I)
	    if [[ $OPTARG =~ ^:(.+)$ ]]
	    then
		version="${BASH_REMATCH[1]}"
	    else 
		image="$OPTARG"
	    fi
	    ;;
	E)
	    ENV+=("$OPTARG")
	    ;;
	H|V|G)
	    case $OPT in
		 H)  volume="$HOME"
		     ENV+=(HOME=$workdir)
		     ;;
		 V)  volume="$OPTARG" ;;
		 G)
		     if [[ ${topdir:=$(git_topdir)} && $topdir != $pwd ]]
		     then
			 volume="$topdir"
		     fi
		     ;;
	    esac
	    if [[ $volume && $volume != $pwd ]]
	    then
		warn "Mount $volume to $workdir"
		[[ "${pwd#$volume/}" != $pwd ]] && relative="${pwd#$volume/}"
	    fi
	    ;;
	N) givenname="$OPTARG" ;;
	X)
	    : ${container:=$(container_name)}
	    if [[ $(docker ps -a -q -f name="/$container\$") ]]
	    then
		docker rm -f $container | sed 's/$/ is removed/'
	    else
		echo $container does not exist
	    fi
	    if [[ ${@:$OPTIND:1} =~ XL ]]
	    then
		(( OPTIND++ ))
	    else
		exit
	    fi
	    ;&
	L)
	    : ${container:=$(container_name)}
	    if [[ $(docker ps -q -f status=exited -f name="^/$container$") ]]
	    then
		warn start and attach to \"$container\"
		exec docker start -ia $container || exit 1
	    fi
	    if [[ $(docker ps -q -f status=running -f name="/$container\$") ]]
	    then
		warn attach to \"$container\"
		exec docker attach $container || exit 1
	    fi
	    ;&
	K)
	    : ${container:=$(container_name)}
	    warn create live conainer \"$container\"
	    remove=
	    ;&
	C|D)
	    if [[ $DISPLAY && "${ip:=$(get_ip)}" ]]
	    then
		display="$ip:0"
	    fi
	    if [[ ! $version && $my_version =~ ^[0-9]+\.[0-9_]+$ ]]
	    then
		version=$my_version
	    fi
	    declare -a command
	    case "$OPT" in
		D) command=(xlate) ;;
		*) shift $((OPTIND - 1)) ;;
	    esac
	    command+=(${1+"$@"})
	    : ${image:=${repository}${version:+:$version}}
	    : ${hostname:=$(<<< ${image} sed -e s:.*/:: -e s/:.*//)}
	    declare -a dockopt=(
		-e XLATE_RUNNING_ON_DOCKER=1
		--interactive
	    )
	    if [ "$remove" ]
	    then dockopt+=(--rm)
	    else dockopt+=(${container:+--name "$container"})
	    fi
	    [ -t 0 ]            && dockopt+=(--tty)
	    [ -e "$localtime" ] && dockopt+=(-v $localtime:$localtime:ro)
	    [ "$mount" ]        && dockopt+=(
		    -v "${volume:-$pwd}:${workdir}:${mount_mode}" 
		    -w "${workdir}${relative:+/${relative}}"
		)
	    dockopt+=(
		${read_only:+--read-only}
		${hostname:+--hostname "${hostname}"}
		${display:+-e DISPLAY="$display"}
		${ENV[@]/#/-e }
	    )
	    exec docker run "${dockopt[@]}" "${image}" "${command[@]}" || exit 1
	    ;;
    esac
done
OPTIND=1

mod="App-Greple-xlate"
share=$(perl -MFile::Share=:all -E "say dist_dir '$mod'")

declare -a pattern

while getopts dq"${DOCKER_OPT}"'Macrusne:w:o:f:t:m:x:p:l:hv' OPT
do
    case $OPT in
	[$DOCKER_OPT]) : ;;
	d)     debug=yes ; set -x ;;
	q)     quiet=yes ;;
	M)  run_make=yes ;;
	a)   use_api=yes ;;
	c)     check=yes ;;
	r)   refresh=yes ;;
	u)    update=yes ;;
	s)    silent=yes ;;
	n)    dryrun=yes ;;
	e)    engine="$OPTARG" ;;
	w)      wrap="$OPTARG" ;;
	o)    format="$OPTARG" ;;
	f) from_lang="$OPTARG" ;;
	t)   to_lang="$OPTARG" ;;
	m)       max="$OPTARG" ;;
	x)  maskfile="$OPTARG" ;;
	p)
	    pattern+=(-E "$OPTARG")
	    ;;
	l)
	    file="$share/$OPTARG"
	    if [ -f "$file" ]
	    then
		cat $file
	    else
		echo $share
		ls -1 $share | sed 's/^/\t/'
	    fi
	    exit
	    ;;
	h)
	    sed -r \
		-e '/^$/N' \
		-e '/^\n*(#|=encoding)/d' \
		-e 's/^(\n*)=[a-z]+[0-9]* */\1/' \
		-e '/Version/q' \
		<<< $pod
	    exit
	    ;;
	v)
	    echo $my_version
	    exit
	    ;;
    esac
done	
shift $((OPTIND - 1))

##
## Make
##
if [ "$run_make" == yes ]
then
    declare -a opt
    for m in "$@"
    do
	if [ -f "$m" ]
	then
	    # GNU Make behaves differently in different versions with
	    # respect to double-quoted strings and spaces within them.
	    files="${files:+$files|||}$m"
	else
	    opt+=("$m")
	fi
    done
    unset MAKELEVEL
    exec make -f $share/XLATE.mk \
	 ${dryrun:+-n} \
	 XLATE_LANG=\""$to_lang"\" \
	 XLATE_DEBUG=$debug \
	 XLATE_MAXLEN=$max \
	 XLATE_USEAPI=$use_api \
	 XLATE_UPDATE=$update \
	 ${engine:+XLATE_ENGINE=\""$engine"\"} \
	 ${format:+XLATE_FORMAT=\""$format"\"} \
	 ${files:+XLATE_FILES=\""$files"\"} \
	 ${opt[@]} \
    || exit 1
fi

if [ ! "$to_lang" ]
then
    warn "-t option is required."
    exit 1
fi

: ${format:=xtxt}
: ${engine:=deepl}

if [[ "$format" =~ ^(.+)-fold$ ]]
then
    format=${BASH_REMATCH[1]}
    : ${wrap:=76}
fi

declare -a module option

module+=(-Mxlate) 
option+=(--xlate-engine="$engine")
option+=(--xlate-to="$to_lang" --xlate-format="$format" --xlate-cache=yes)
option+=(--all)

[ "$use_api" == yes ] || use_clipboard=yes
[ "$check"   == yes ] || option+=(--xlate${use_clipboard:+-labor})
[ "$wrap"           ] && option+=(--xlate-fold-line --xlate-fold-width=$wrap)
[ "$debug"   == yes ] && option+=(-dmo)
[ "$refresh" == yes ] && option+=(--xlate-cache=clear)
[ "$update"  == yes ] && option+=(--xlate-update)
[ "$silent"  == yes ] && option+=(--no-xlate-progress)
[ "$max"            ] && option+=(--xlate-maxlen="$max")
[ "$maskfile"       ] && option+=(--xlate-setopt "maskfile=$maskfile")

declare -a area
case $1 in
    *.txt)
	area=(-E '^(.+\n)+')
	;;
    *.md)
	area=(-E '(?x) ^[-+#].*\n | ^\h+\K.*\n | ^(.+\n)+ ')
	;;
    *.pm|*.pod)
	module+=(-Mperl)
	option+=(--pod)
	option+=(--exclude '^=head\d +(VERSION|AUTHOR|LICENSE|COPYRIGHT|SEE.?ALSO).*\n(?s:.*?)(?=^=|\z)')
	area=(-E '^([\w\pP].+\n)+')
	;;
    *.doc|*.docx|*.pptx|*.xlsx)
	module+=(-Mmsdoc)
	;&
    *.stxt)
	option+=(--exclude '^\[.*\b(doc|docx|pptx|xlsx)\b.*\]\n')
	area=(-E '^.+\n')
	;;
    *)
	area=(-E '^(.+\n)+')
	;;
esac

if (( ${#pattern[@]} > 0))
then
    option+=("${pattern[@]}")
else
    option+=("${area[@]}")
fi

exec=(greple "${module[@]}" "${option[@]}" ${1+"$@"})

if [[ $dryrun ]]
then
    echo "${exec[@]}"
else
    "${exec[@]}"
fi

exit

: <<'=cut'

=head1 DESCRIPTION

B<XLATE> is a versatile command-line tool designed as a user-friendly
frontend for the B<greple> C<-Mxlate> module, simplifying the process
of multilingual automatic translation using various API services.  It
streamlines the interaction with the underlying module, making it
easier for users to handle diverse translation needs across multiple
file formats and languages.

A key feature of B<xlate> is its seamless integration with Docker
environments, allowing users to quickly set up and use the tool
without complex environment configurations.  This Docker support
ensures consistency across different systems and simplifies
deployment, benefiting both individual users and teams working on
translation projects.

B<xlate> supports various document formats, including C<.docx>,
C<.pptx>, and C<.md> files, and offers multiple output formats to suit
different requirements.  By combining Docker capabilities with
built-in make functionality, B<xlate> enables powerful automation of
translation workflows.  This combination facilitates efficient batch
processing of multiple files, streamlined project management, and easy
integration into continuous integration/continuous deployment (CI/CD)
pipelines, significantly enhancing productivity in large-scale
localization efforts.

=head2 Basic Usage

To translate a file, use the following command:

    xlate -t <target_language> <file>

For example, to translate a file from English to Japanese:

    xlate -t JA example.txt

=head2 Translation Engines

xlate supports multiple translation engines.  Use the -e option to
specify the engine:

    xlate -e deepl -t JA example.txt

Available engines: deepl, gpt3, gpt4, gpt4o

=head2 Output Formats

Various output formats are supported. Use the -o option to specify the format:

    xlate -o cm -t JA example.txt

Available formats: xtxt, cm, ifdef, space, space+, colon

=head2 Docker Support

B<xlate> offers seamless integration with Docker, providing a powerful
and flexible environment for translation tasks.  This approach
combines the strengths of xlate's translation capabilities with
Docker's containerization benefits.

=head3 Key Concepts

=over 4

=item B<Containerized Environment>

By running xlate in a Docker container, you ensure a consistent and
isolated environment for all translation tasks.  This eliminates
issues related to system dependencies or conflicting software
versions.

=item B<Integration with Make>

The Docker functionality can be combined with xlate's B<make> feature,
allowing for complex, multi-file translation projects to be managed
efficiently within a containerized environment. For example:

    xlate -DM -t 'EN FR DE' project_files/*.docx

This command runs B<xlate> in a Docker container, utilizing make to
process multiple files with specified target languages.

=item B<Flexible Mount Options>

B<xlate> provides options to mount different directories, including
Git repositories (C<-G>) and read-only mounts (C<-R>).  This allows
for flexible workflow integration while maintaining data security.

=item B<Environment Variable Handling>

With the ability to pass specific environment variables into the
container (C<-E>), you can easily manage API keys and other
configuration settings without modifying the container itself.

=back

=head2 Make Support

xlate utilizes GNU Make for automating and managing translation tasks.
This feature is particularly useful for handling translations of
multiple files or to different languages.

To use the make feature:

    xlate -M [options] [target]

xlate provides a specialized Makefile (F<XLATE.mk>) that defines
translation tasks and rules.  This file is located in the xlate
library directory and is automatically used when the -M option is
specified.

Example usage:

    xlate -M -t 'EN FR DE' document.docx

This command will use make to translate document.docx to English,
French, and German, following the rules defined in XLATE.mk.

The C<-n> option can be used with C<-M> for a dry-run, showing what
actions would be taken without actually performing the translations:

    xlate -M -n -t 'EN FR DE' document.docx

Users can customize the translation process using parameter files:

=over 4

=item F<*.LANG>:

Specifies target languages for a specific file

=item F<*.FORMAT>:

Defines output formats for a specific file

=item F<*.ENGINE>:

Selects the translation engine for a specific file

=back

For more detailed information on the make functionality and available
rules, refer to the F<XLATE.mk> file in the xlate library directory.

=head1 OPTIONS

=over 7

=item B<-h>

Show help message.

=item B<-v>

Show version information.

=item B<-d>

Enable debug mode.

=item B<-n>

Perform a dry-run without making any changes.

=item B<-a>

Use API for translation.

=item B<-c>

Check translation area without performing translation.

=item B<-r>

Refresh the translation cache.

=item B<-u>

Force update of the translation cache.

=item B<-s>

Run in silent mode.

=item B<-e> I<engine>

Specify the translation engine to use.

=item B<-p> I<pattern>

Specify a pattern to determine the translation area.

=item B<-x> I<file>

Specify a file containing mask patterns.

=item B<-w> I<width>

Wrap lines at the specified width.

=item B<-o> I<format>

Specify the output format.

=item B<-f> I<lang>

Specify the source language (currently ignored).

=item B<-t> I<lang>

Specify the target language (required).

=item B<-m> I<length>

Specify the maximum length per API call.

=item B<-l> I<file>

Show library files (XLATE.mk, xlate.el).

=back

=head2 MAKE OPTIONS

=over 7

=item B<-M>

Run make.

=item B<-n>

Dry run.

=back

=head2 DOCKER OPTIONS

Docker feature is invoked by the B<-D>, B<-C> or B<-L> option.  These
are exclusive, so only one of them can be used.  Also, once these two
options appear, subsequent options are not interpreted, so they should
always be the last of Docker related options.

When running in a docker environment, the current directory is mounted
by default.  If another directory is specified to be mounted, such as
the git top directory or the home directory, it will still be moved to
the current location within that tree and executed.

=over 7

=item B<-G>

Mount L<git(1)> top-level directory.

=item B<-H>

Mount user's home directory.  The environment variable C<HOME> is set
to the mount point.

=item B<-V> I<directory>

Specify directory to be mounted.

=item B<-U>

Do not mount any directory.

=item B<-R>

Mount directory as read-only.

=item B<-E> I<name>[=I<value>]

Specify environment variable to be inherited in Docker.
Repeatable.

=item B<-I> I<image>

Specify Docker image name.  If it begins with a colon (C<:>), it is
treated as a version of the default image.

=item B<-K>

Keep containers alive after execution.  By default, container is
automatically removed upon exit (C<--rm>).  This option disables that
automatic deletion.

=item B<-N>

Specifies the name of the live container.  Default is C<xlate>.

=item B<-X>

Remove the existing live container.  If a container with the specified
name (default is C<xlate>) exists, it will be stopped and removed.

If specified as C<-XL>, then a new container is launched after the
existing container is removed.

=item B<-D>

Run B<xlate> scirpt on the Docker container with the rest of the
parameters.

=item B<-C>

Run the following command on the Docker container, or run a shell if
no command is provided.

=item B<-L>

Attach to a continuously running live container.  If the container
does not exist, a new one is created, and if there is a stopped
container, it is restarted before connecting.

The other docker options only apply the first time the container is
launched.  Therefore, if you are changing the configuration, such as
changing the mount directory, use the C<-X> option to remove the
existing container before starting.  Alternatively, the C<-XL> option
can be used to remove and create at the same time.

=back

=head1 ENVIRONMENT

=over 4

=item DEEPL_AUTH_KEY

DeepL API key.

=item OPENAI_API_KEY

OpenAI API key.

=item ANTHROPIC_API_KEY

Anthropic API key.

=item LLM_PERPLEXITY_KEY

Perplexity API key.

=back

=head1 FILES

=over 4

=item F<*.LANG>

Specifies translation languages.

=item F<*.FORMAT>

Specifies translation format.

=item F<*.ENGINE>

Specifies translation engine.

=back

=head1 EXAMPLES

1. Translate a Word document to English:

   xlate -DMa -t EN-US example.docx

2. Translate to multiple languages and formats:

   xlate -M -o 'xtxt ifdef' -t 'EN-US KO ZH' example.docx

3. Run a command in Docker container:

   xlate -C sdif -V --nocdif example.EN-US.cm | less

4. Translate without using API (via clipboard):

   xlate -t JA README.md

=head1 SEE ALSO

L<App::Greple::xlate>

=head1 AUTHOR

Kazumasa Utashiro

=head1 LICENSE

Copyright © 2023-2024 Kazumasa Utashiro.

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=cut
