# HG changeset patch
# User Aleksej Bobylev <al.bobylev@gmail.com>
# Date 1409049110 -10800
# Node ID e96aa956e72ea7112bf7e4e621761a32ec07471c
# Parent  ce9cbd90365aef8cda0f96c00304033d1202c391
tramys-client, tramys-server: now using http headers only (no more additional info in the server logs); added a lot of comments.

diff -r ce9cbd90365a -r e96aa956e72e tramys-client/receipt
--- a/tramys-client/receipt	Mon Aug 25 10:52:38 2014 +0200
+++ b/tramys-client/receipt	Tue Aug 26 13:31:50 2014 +0300
@@ -1,7 +1,7 @@
 # SliTaz package receipt.
 
 PACKAGE="tramys-client"
-VERSION="140824"
+VERSION="140826"
 CATEGORY="system-tools"
 SHORT_DESC="Tool for managing translation files for SliTaz GNU/Linux, client part"
 MAINTAINER="al.bobylev@gmail.com"
diff -r ce9cbd90365a -r e96aa956e72e tramys-client/stuff/tramys2
--- a/tramys-client/stuff/tramys2	Mon Aug 25 10:52:38 2014 +0200
+++ b/tramys-client/stuff/tramys2	Tue Aug 26 13:31:50 2014 +0300
@@ -6,6 +6,7 @@
 . /etc/slitaz/slitaz.conf
 . /lib/libtaz.sh
 
+# Ask for root access in order to install the files in the system.
 if [ $(id -u) != 0 ]; then
 	exec tazbox su $0 $@; exit 0
 fi
@@ -14,8 +15,14 @@
 WORKING=$(mktemp -d)
 LOG="/tmp/tramys.log"
 TGZ="/tmp/tramys.tgz"
+URL="http://cook.slitaz.org/tramys2.cgi"
+
+# Common Yad options.
 YADCONF="--center --window-icon=config-language --image=config-language --image-on-top"
 
+# First step. Describes the functions of the program.
+# It is possible to set the language.
+# Also here the user has the ability to stop the program.
 yad $YADCONF --title="tramys (1/3)" --text="$(_ \
 'Now translations for all installed programs will be found and downloaded.
 You can change locale if you want, or proceed.
@@ -27,23 +34,44 @@
 	1) exit 0 ;;
 esac
 
-busybox wget -U "$(cd $INSTALLED; ls -1 | tr '\n' ' ')" \
-	"http://cook.slitaz.org/tramys2.cgi?lang=$LANG&rel=$(cat /etc/slitaz-release)" \
-	-O - | tee $LOG | \
+# your locale -> HTTP_ACCEPT_LANGUAGE
+# your SliTaz release -> HTTP_ACCEPT (different releases have different translations)
+# your installed packages list -> HTTP_COOKIE (list=...)
+# Note clean address "tramys2.cgi" in the server access logs.
+#
+# Server sending and Yad shows user useful info using log widget.
+# We are temporarily stored this log in the $LOG file in order to get
+# a download token (see below).
+# Here the user can refuse to download the file.
+busybox wget --header "Accept-Language: $LANG" \
+	--header "Accept: $(cat /etc/slitaz-release)" \
+	--header "Cookie: list=$(cd $INSTALLED; ls -1 | tr '\n' ' ')" \
+	$URL -O - | tee $LOG | \
 	yad $YADCONF --title="tramys (2/3)" --progress --width=320 --text="$(_ \
 'The server processes the request.
 Please wait.')" \
 	--enable-log --log-expanded \
 	--button "gtk-cancel:1" --button "gtk-go-forward:0"
-case $? in
-	1) exit 0 ;;
+ANSWER=$?
+
+# In the last line of log server gives us a download token.
+# We can download archive which the server has prepared for us.
+# Get download token and remove log.
+DLKEY=$(tail -n1 $LOG); rm -f $LOG
+
+case $ANSWER in
+	1)
+		# We need to remove archive that the user has refused to download.
+		# This command passed in HTTP_COOKIE (rm=...)
+		busybox wget --header "Cookie: rm=$DLKEY" $URL -O /dev/null; exit 0 ;;
 esac
 
-DLKEY=$(tail -n1 $LOG); rm -f $LOG
-
-busybox wget "http://cook.slitaz.org/tramys2.cgi?dl=$DLKEY" -O $TGZ 2>&1 | \
-yad $YADCONF --title="tramys (3/3)" --progress --pulsate --width=320 \
-	--text="$(_ \
+# We want to download the file. Show pulsate progress bar.
+# This command passed in HTTP_COOKIE (dl=...)
+# Also here the user can terminate file downloading.
+busybox wget --header "Cookie: dl=$DLKEY" $URL -O $TGZ 2>&1 | \
+	yad $YADCONF --title="tramys (3/3)" --progress --pulsate --width=320 \
+		--text="$(_ \
 'Downloading in progress.
 Please wait.')" \
 	--button "gtk-cancel:1" --button "gtk-ok:0"
@@ -51,11 +79,21 @@
 	1) exit 0 ;;
 esac | \
 
+# Unpack archive content to a temporary folder.
 busybox tar -xz -C $WORKING -f $TGZ
+# All folders and files in the archive are owned by user www and group www.
+# This is because the CGI script on the server is executed by the user www.
+# If we had just unpacked the archive content into our file system, then there
+# would be a big trouble. For example, all folders: /, /usr, /usr/share,
+# /usr/share/locale, etc. would be owned by user www and become unavailable
+# for a regular user. So force all folders and files to root own.
 chown -R root:root $WORKING
+# copy all translation files to root file system.
 cp -fpr $WORKING/* /
+# remove temporary folder and file, they are no longer needed.
 rm -f $TGZ
 rm -rf $WORKING
 
+# Final message.
 yad $YADCONF --title="tramys" --text="$(_ \
 'Translation files have been installed in your system.')"
diff -r ce9cbd90365a -r e96aa956e72e tramys-client/stuff/tramys2.desktop
--- a/tramys-client/stuff/tramys2.desktop	Mon Aug 25 10:52:38 2014 +0200
+++ b/tramys-client/stuff/tramys2.desktop	Tue Aug 26 13:31:50 2014 +0300
@@ -2,6 +2,7 @@
 Type=Application
 Name=tramys
 Comment=Translate My SliTaz!
+Comment[ru]=Переведите свой SliTaz!
 Exec=tramys2
 Icon=config-language
 Categories=GTK;Settings;DesktopSettings;
diff -r ce9cbd90365a -r e96aa956e72e tramys-server/receipt
--- a/tramys-server/receipt	Mon Aug 25 10:52:38 2014 +0200
+++ b/tramys-server/receipt	Tue Aug 26 13:31:50 2014 +0300
@@ -1,7 +1,7 @@
 # SliTaz package receipt.
 
 PACKAGE="tramys-server"
-VERSION="140824"
+VERSION="140826"
 CATEGORY="system-tools"
 SHORT_DESC="Tool for managing translation files for SliTaz GNU/Linux, server part"
 MAINTAINER="al.bobylev@gmail.com"
diff -r ce9cbd90365a -r e96aa956e72e tramys-server/stuff/tramys2.cgi
--- a/tramys-server/stuff/tramys2.cgi	Mon Aug 25 10:52:38 2014 +0200
+++ b/tramys-server/stuff/tramys2.cgi	Tue Aug 26 13:31:50 2014 +0300
@@ -4,40 +4,34 @@
 # Aleksej Bobylev <al.bobylev@gmail.com>, 2014
 
 # How to use:
-# 1. tramys2.cgi?lang=$LANG&rel=$RELEASE to generate archive
-# Pass packages list in HTTP_USER_AGENT header
-# (seems it have no restrictions for length and no encoded symbols ' ' and '+')
-# 2. tramys2.cgi?dl=$DL_KEY to download archive (user can cancel downloading)
+# 1. Request for archive:
+#    HTTP_ACCEPT_LANGUAGE -> users locale
+#    HTTP_ACCEPT -> SliTaz release
+#    HTTP_COOKIE (list=...) -> space-separated list of packages to process
+#
+# 2. Remove archive that the user has refused to download:
+#    HTTP_COOKIE (rm=DLKEY) -> remove /tmp/tmp.DLKEY.tgz file
+#
+# 3. Send archive to user:
+#    HTTP_COOKIE (dl=DLKEY) -> send /tmp/tmp.DLKEY.tgz file
 
 . /usr/bin/httpd_helper.sh
 
-WORKING=$(mktemp -d)
-DATADIR=/usr/share/tramys
+WORKING=$(busybox mktemp -d) # make temp working dir /tmp/tmp.??????
+DATADIR=/usr/share/tramys    # this folder contains lists
 
-# hide script
-if [ "x$(GET lang)$(GET rel)$(GET dl)" == "x" ]; then
-	echo -e "HTTP/1.1 404 Not Found\nContent-Type: text/html\n\n<!DOCTYPE html><html><head><title>404 - Not Found</title></head><body><h1>404 - Not Found</h1></body></html>"
-	exit
-fi
+# Get user settings from HTTP headers.
+lang="$HTTP_ACCEPT_LANGUAGE"
+rel="$HTTP_ACCEPT"
+cmd="${HTTP_COOKIE%%=*}"
+arg="${HTTP_COOKIE#*=}"
 
-# begin: compress and give to client
-if [ "x$(GET dl)" != "x" ]; then
-	WORKING="/tmp/tmp.$(echo $(GET dl) | tr -cd 'A-Za-z0-9')" # avoid relative paths
-	cat <<EOT
-Content-Type: application/x-compressed-tar
-Content-Length: $(stat -c %s $WORKING.tgz)
-Content-Disposition: attachment; filename=tramys.tgz
+#-----------#
+# Functions #
+#-----------#
 
-EOT
-	cat $WORKING.tgz
-	rm -f $WORKING.tgz
-	exit 0
-fi
-# end: compress and give to client
-
-
-# prepare list for search
-# original GNU gettext searches precisely in this order
+# Prepare list for search.
+# Original GNU gettext searches precisely in this order.
 locales_list() {
 	LL=$(echo $1 | sed 's|^\([^_.@]*\).*$|\1|')
 	CC=$(echo $1 | sed -n '/_/s|^[^_]*\(_[^.@]*\).*$|\1|p')
@@ -59,73 +53,127 @@
 	[ "$ee" ]					&& echo -n "$LL$ee "
 	echo "$LL"
 }
-MY_LOCALES=$(locales_list $(GET lang))
+MY_LOCALES=$(locales_list $lang)
 
-# constants to use in lists
-US="/usr/share"
-LC="LC_MESSAGES"
-PY="/usr/lib/python2.7/site-packages"
-R="/usr/lib/R/library"
-RT="$R/translations/%/$LC"
+# Search and copy translation files
+copy_translations() {
+	# for all packages in list
+	for P in $arg; do
 
-# supported 4.0 (as stable now) an cooking (rolling, 5.0)
-# don't know what to do with "arm" and "x86_64" woks
-case $(GET rel) in
-	4*) PREFIX="stable_"; WOK="stable"  ;;
-	*)  PREFIX="";       WOK="cooking" ;;
-esac
-WOK="/home/slitaz/$WOK/chroot/home/slitaz/wok"
+		echo "$((100*$NUM/$PKGNUM))" # send percentage to Yad client
+		NUM=$(($NUM+1))              # next package
 
-PKGNUM=$(echo $HTTP_USER_AGENT | wc -w)
-NUM=1
+		# for all list types
+		for list_type in mo qm; do
+			IFS=$'\n'
+			for line in $(grep -e "^$P	" $DATADIR/$PREFIX$list_type.list); do
+				locales=$(echo $line | cut -d'	' -f2)
+				names=$(echo $line | cut -d'	' -f3)
+					[ "x$names" == "x" ] && names=$P
+				paths=$(echo $line | cut -d'	' -f4)
+					[ "x$paths" == "x" ] && paths="$US/locale/%/$LC"
 
-echo -e "Content-Type: text/plain\n\n" # to Yad client
-echo "#Number of packages: $PKGNUM"
-echo "#Searching in progress..."
+				IFS=' '
+				# for all valid locale variants
+				for locale in $MY_LOCALES; do
+					if $(echo " $locales " | grep -q " $locale "); then
 
-for P in $HTTP_USER_AGENT; do
+						# for all file names
+						for name in $names; do
+							# for all paths
+							for path in $paths; do
+								# substitute variables and "%"
+								eval "fullname=${path//%/$locale}/${name//%/$locale}.$list_type"
 
-	echo "$((100*$NUM/$PKGNUM))" # percentage to Yad client
-	NUM=$(($NUM+1))
-
-	for list_type in mo qm; do
-		IFS=$'\n'
-		for line in $(grep -e "^$P	" $DATADIR/$PREFIX$list_type.list); do
-			locales=$(echo $line | cut -d'	' -f2)
-			names=$(echo $line | cut -d'	' -f3)
-				[ "x$names" == "x" ] && names=$P
-			pathes=$(echo $line | cut -d'	' -f4)
-				[ "x$pathes" == "x" ] && pathes="$US/locale/%/$LC"
-
-			IFS=' '
-			for locale in $MY_LOCALES; do
-				if $(echo " $locales " | grep -q " $locale "); then
-
-					for name in $names; do
-						for path in $pathes; do
-							eval "fullname=${path//%/$locale}/${name//%/$locale}.$list_type"
-							mkdir -p $WORKING$(dirname $fullname)
-							cp -pf $WOK/$P/install$fullname $WORKING$fullname
+								# copy translation file to working dir
+								mkdir -p $WORKING$(dirname $fullname)
+								cp -pf $WOK/$P/install$fullname $WORKING$fullname
+							done
 						done
-					done
-					break
-				fi
+						break
+					fi
+				done
 			done
 		done
 	done
-done
+}
 
-echo "#" # to Yad client log
-echo "#Preparing archive. Please wait"
+#----------#
+#   Main   #
+#----------#
 
-busybox tar -czf $WORKING.tgz -C $WORKING .
-rm -rf $WORKING
+# Branch commands: list, rm, dl.
+case "x$cmd" in
+	xlist) # Main actions: get list, search translations, make an archive.
+		# constants to use in lists
+		US="/usr/share"
+		LC="LC_MESSAGES"
+		PY="/usr/lib/python2.7/site-packages"
+		R="/usr/lib/R/library"
+		RT="$R/translations/%/$LC"
 
-echo "#" # to Yad client log
-echo "#Done!"
-echo "#Now you can proceed to downloading"
-echo "#and installing your translations."
-echo "#File size: $(stat -c %s $WORKING.tgz)"
+		# Supported 4.0 (as stable now) and cooking (rolling, 5.0)
+		# Don't know what to do with "arm" and "x86_64" woks ???
+		case "x$rel" in
+			x4*|xstable) PREFIX="stable_"; WOK="stable"  ;;
+			*)           PREFIX="";        WOK="cooking" ;;
+		esac
+		# Path to the specified WOK in the SliTaz server.
+		WOK="/home/slitaz/$WOK/chroot/home/slitaz/wok"
 
-echo "${WORKING#*.}" # give download key to Yad client
+		PKGNUM=$(echo $arg | wc -w) # number of packages in the list
+		NUM=1 # initial value
+
+		echo -e "Content-Type: text/plain\n\n" # to Yad client
+		echo "#Number of packages: $PKGNUM"    # Message to Yad log
+		echo "#Searching in progress..."       # And another one
+
+		copy_translations
+
+		echo "#"                                  # Message to Yad log
+		echo "#Preparing archive. Please wait..." # And another one
+
+		# Make the archive from working dir and remove temp working dir.
+		busybox tar -czf $WORKING.tgz -C $WORKING .
+		rm -rf $WORKING
+
+		echo "#" # to Yad client log
+		echo "#Done!"
+		echo "#Now you can proceed to downloading"
+		echo "#and installing your translations."
+		echo "#File size: $(stat -c %s $WORKING.tgz) bytes."
+
+		echo "${WORKING#*.}" # give download token to Yad client
+		exit 0 ;;
+
+	xrm) # Remove archive.
+		# Avoid relative path to avoid removing of any system file.
+		archive="/tmp/tmp.$(echo $arg | tr -cd 'A-Za-z0-9').tgz"
+		rm -f $archive
+		cat <<EOT
+Content-Type: text/plain
+Content-Length: 0
+
+EOT
+		exit 0 ;;
+
+	xdl) # Send archive to client.
+		# Avoid relative path to avoid hijacking of any system file.
+		archive="/tmp/tmp.$(echo $arg | tr -cd 'A-Za-z0-9').tgz"
+		cat <<EOT
+Content-Type: application/x-compressed-tar
+Content-Length: $(stat -c %s $archive)
+Content-Disposition: attachment; filename=tramys.tgz
+
+EOT
+		cat $archive
+		# Remove archive after sending.
+		rm -f $archive
+		exit 0 ;;
+
+	*) # Hide the script from the web bots and browsers.
+		echo -e "HTTP/1.0 404 Not Found\nContent-Type: text/html\n\n<!DOCTYPE html><html><head><title>404 - Not Found</title></head><body><h1>404 - Not Found</h1></body></html>"
+		exit ;;
+esac
+
 exit 0