add default for h* tag items
[brisk.git] / INSTALL.sh
1 #!/bin/bash
2 # set -x
3 #
4 # Defaults
5 #
6 CONFIG_FILE="$HOME/.brisk_install"
7
8 apache_conf="/etc/apache2/sites-available/default"
9 card_hand=3
10 players_n=3
11 tables_n=44
12 tables_appr_n=12
13 tables_auth_n=8
14 tables_cert_n=4
15 brisk_auth_conf="brisk_spu_auth.conf.pho"
16 brisk_debug="0x0400"
17 # brisk_debug="0xffff"
18 web_path="/home/nastasi/web/brisk"
19 ftok_path="/home/nastasi/brisk-priv/ftok/brisk"
20 proxy_path="/home/nastasi/brisk-priv/proxy/brisk"
21 usock_path="/home/nastasi/brisk-priv/brisk.sock"
22 sys_user="www-data"
23 legal_path="/home/nastasi/brisk-priv/brisk"
24 prefix_path="/brisk/"
25 brisk_conf="brisk_spu.conf.pho"
26 web_only="FALSE"
27 test_add="FALSE"
28 #
29 # functions
30 function usage () {
31     echo
32     echo "$1 -h"
33     echo "$1 chk                          - run lintian on all ph* files."
34     echo "$1 pkg                          - build brisk packages."
35     echo "$1 [-W] [-n 3|5] [-c 2|8] [-t <(n>=4)>] [-T <auth_tab>] [-r <appr_tab>] [-G <cert_tab>] [-A <apache-conf>] [-a <auth_file_name>] [-f <conffile>] [-p <outconf>] [-U <usock_path>] [-u <sys_user>] [-d <TRUE|FALSE>] [-w <web_dir>] [-k <ftok_dir>] [-l <legal_path>] [-y <proxy_path>] [-P <prefix_path>] [-x]"
36     echo "  -h this help"
37     echo "  -f use this config file"
38     echo "  -p save preferences in the file"
39     echo "  -W web files only"
40     echo "  -A apache_conf                  - def. $apache_conf"
41     echo "  -c number cards in hand         - def. $card_hand"
42     echo "  -n number of players            - def. $players_n"
43     echo "  -t number of tables             - def. $tables_n"
44     echo "  -r number of appr-only tables   - def. $tables_appr_n"
45     echo "  -T number of auth-only tables   - def. $tables_auth_n"
46     echo "  -G number of cert-only tables   - def. $tables_cert_n"
47     echo "  -a authorization file name      - def. \"$brisk_auth_conf\""
48     echo "  -d activate dabug               - def. $brisk_debug"
49     echo "  -w dir where place the web tree - def. \"$web_path\""
50     echo "  -k dir where place ftok files   - def. \"$ftok_path\""
51     echo "  -l dir where save logs          - def. \"$legal_path\""
52     echo "  -y dir where place proxy files  - def. \"$proxy_path\""
53     echo "  -P prefix path                  - def. \"$prefix_path\""
54     echo "  -C config filename              - def. \"$brisk_conf\""
55     echo "  -U unix socket path             - def. \"$usock_path\""
56     echo "  -u system user to run brisk dae - def. \"$sys_user\""
57     echo "  -x copy tests as normal php     - def. \"$test_add\""
58     echo
59 }
60
61 function get_param () {
62     echo "X$2" | grep -q "^X$1\$"
63     if [ $? -eq 0 ]; then
64         # echo "DECHE" >&2
65         echo "$3"
66         return 2
67     else
68         # echo "DELA" >&2
69         echo "$2" | cut -c 3-
70         return 1
71     fi
72     return 0
73 }
74
75 function searchetc() {
76     local dstart dname pp
77     dstart="$1"
78     dname="$2"
79
80     pp="$dstart"
81     while [ "$pp" != "/" ]; do
82         if [ -d "$pp/$dname" ]; then
83             echo "$pp/$dname"
84             return 0
85         fi
86         pp="$(dirname "$pp")"
87     done
88     
89     return 1
90 }
91
92 #
93 #  MAIN
94 #
95 declare -a nam nam_gz
96 if [ "$1" = "chk" ]; then
97     set -e
98     oldifs="$IFS"
99     IFS='
100 '
101     for i in $(find -name '*.pho' -o -name '*.phh' -o -name '*.php'); do
102         php5 -l $i
103     done
104
105     taggit="$(git describe --tags | sed 's/^v//g')"
106     tagphp="$(grep "^\$G_brisk_version = " web/Obj/brisk.phh | sed 's/^[^"]\+"//g;s/".*//g')" # ' emacs hell
107     if [ "$taggit" != "$tagphp" ]; then
108         echo
109         echo "WARNING: taggit: [$taggit] tagphp: [$tagphp]"
110         echo
111     fi
112     exit 0
113 fi
114
115 # before all check errors on the sources
116 $0 chk || exit 3
117 if [ "$1" = "pkg" ]; then
118     if [ "$2" != "" ]; then
119         tag="$2"
120     else
121         tag="$(git describe)"
122     fi
123     nam=("brisk" "brisk-img" "fieldify")
124     nam_idx=3
125
126     if [ -d ../curl-de-sac ]; then
127        nam[$nam_idx]="curl-de-sac"
128        nam_idx=$((nam_idx + 1))
129     fi
130     pkg_list=""
131     sep=""
132     for i in $( seq 0 $((${#nam[@]} - 1)) ); do
133         echo "$i"
134         nam_gz[$i]="${nam[$i]}_${tag}.tgz"
135         pkg_list="${pkg_list}${sep}${nam_gz[$i]}"
136         sep=", "
137     done
138
139     echo "Build packages ${pkg_list} ."
140     read -p "Proceed [y/n]: " a
141     if [ "$a" != "y" -a  "$a" != "Y" ]; then
142         exit 1
143     fi
144     for i in $( seq 0 $((${#nam[@]} - 1)) ); do
145         cd "../${nam[$i]}"
146         git archive --format=tar --prefix=brisk-${tag}/${nam[$i]}/ $tag | gzip > ../${nam_gz[$i]}
147         cd -
148     done
149     exit 0
150 fi
151
152 if [ -f "$CONFIG_FILE" ]; then
153    source "$CONFIG_FILE"
154    conffile_in="$CONFIG_FILE"
155 fi
156
157 if [ "x$prefix_path" = "x" ]; then
158    prefix_path="$web_path"
159 fi
160
161 action=""
162 while [ $# -gt 0 ]; do
163     # echo aa $1 xx $2 bb
164     conffile=""
165     case $1 in
166         -A*) apache_conf="$(get_param "-A" "$1" "$2")"; sh=$?;;
167         -f*) conffile="$(get_param "-f" "$1" "$2")"; sh=$?;;
168         -p*) outconf="$(get_param "-p" "$1" "$2")"; sh=$?;;
169         -c*) card_hand="$(get_param "-c" "$1" "$2")"; sh=$?;;
170         -n*) players_n="$(get_param "-n" "$1" "$2")"; sh=$?;;
171         -t*) tables_n="$(get_param "-t" "$1" "$2")"; sh=$?;;
172         -r*) tables_appr_n="$(get_param "-r" "$1" "$2")"; sh=$?;;
173         -T*) tables_auth_n="$(get_param "-T" "$1" "$2")"; sh=$?;;
174         -G*) tables_cert_n="$(get_param "-G" "$1" "$2")"; sh=$?;;
175         -a*) brisk_auth_conf="$(get_param "-a" "$1" "$2")"; sh=$?;;
176         -d*) brisk_debug="$(get_param "-d" "$1" "$2")"; sh=$?;;
177         -w*) web_path="$(get_param "-w" "$1" "$2")"; sh=$?;;
178         -k*) ftok_path="$(get_param "-k" "$1" "$2")"; sh=$?;;
179         -y*) proxy_path="$(get_param "-y" "$1" "$2")"; sh=$?;;
180         -P*) prefix_path="$(get_param "-P" "$1" "$2")"; sh=$?;;
181         -C*) brisk_conf="$(get_param "-C" "$1" "$2")"; sh=$?;;
182         -l*) legal_path="$(get_param "-l" "$1" "$2")"; sh=$?;;
183         -U*) usock_path="$(get_param "-U" "$1" "$2")"; sh=$?;;
184         -u*) sys_user="$(get_param "-u" "$1" "$2")"; sh=$?;;
185         system) action=system;;
186         -W) web_only="TRUE";;
187         -x) test_add="TRUE";;
188         -h) usage $0; exit 0;;
189         *) usage $0; exit 1;;
190     esac
191     if [ ! -z "$conffile" ]; then
192         if [ ! -f "$conffile" ]; then
193             echo "config file [$conffile] not found"
194             exit 1
195         fi
196         . "$conffile"
197         conffile_in="$conffile"
198     fi
199     shift $sh
200 done
201
202 #
203 #  Show parameters
204 #
205 echo "    outconf:    \"$outconf\""
206 echo "    apache_conf:\"$apache_conf\""
207 echo "    card_hand:   $card_hand"
208 echo "    players_n:   $players_n"
209 echo "    tables_n:    $tables_n"
210 echo "    tables_appr_n: $tables_appr_n"
211 echo "    tables_auth_n: $tables_auth_n"
212 echo "    tables_cert_n: $tables_cert_n"
213 echo "    brisk_auth_conf: \"$brisk_auth_conf\""
214 echo "    brisk_debug:\"$brisk_debug\""
215 echo "    web_path:   \"$web_path\""
216 echo "    ftok_path:  \"$ftok_path\""
217 echo "    legal_path: \"$legal_path\""
218 echo "    proxy_path: \"$proxy_path\""
219 echo "    prefix_path:\"$prefix_path\""
220 echo "    brisk_conf: \"$brisk_conf\""
221 echo "    usock_path: \"$usock_path\""
222 echo "    sys_user:   \"$sys_user\""
223 echo "    web_only:   \"$web_only\""
224 echo "    test_add:   \"$test_add\""
225
226 if [ ! -z "$outconf" ]; then
227   ( 
228     echo "#"
229     echo "#  Produced automatically by brisk::INSTALL.sh"
230     echo "#"
231     echo "apache_conf=$apache_conf"
232     echo "card_hand=$card_hand"
233     echo "players_n=$players_n"
234     echo "tables_n=$tables_n"
235     echo "tables_appr_n=$tables_appr_n"
236     echo "tables_auth_n=$tables_auth_n"
237     echo "tables_cert_n=$tables_cert_n"
238     echo "brisk_auth_conf=\"$brisk_auth_conf\""
239     echo "brisk_debug=\"$brisk_debug\""
240     echo "web_path=\"$web_path\""
241     echo "ftok_path=\"$ftok_path\""
242     echo "proxy_path=\"$proxy_path\""
243     echo "legal_path=\"$legal_path\""
244     echo "prefix_path=\"$prefix_path\""
245     echo "brisk_conf=\"$brisk_conf\""
246     echo "usock_path=\"$usock_path\""
247     echo "sys_user=\"$sys_user\""
248     echo "web_only=\"$web_only\""
249     echo "test_add=\"$test_add\""
250   ) > "$outconf"
251 fi
252
253 max_players=$((40 + players_n * tables_n))
254
255 if [ "$action" = "system" ]; then
256     scrname="$(echo "$prefix_path" | sed 's@^/@@g;s@/$@@g;s@/@_@g;')"
257     echo
258     echo "script name:  [$scrname]"
259     echo "brisk path:   [$web_path]"
260     echo "private path: [$legal_path]"
261     echo "system user:  [$sys_user]"
262     echo
263     read -p "press enter to continue" sure
264     cp bin/brisk-init.sh brisk-init.sh.wrk
265     sed -i "s@^BPATH=.*@BPATH=\"${web_path}\"@g;s@^PPATH=.*@PPATH=\"${legal_path}\"@g;s@^SSUFF=.*@SSUFF=\"${scrname}\"@g;s@^BUSER=.*@BUSER=\"${sys_user}\"@g" brisk-init.sh.wrk
266
267     su -c "cp brisk-init.sh.wrk /etc/init.d/${scrname}"
268
269     rm brisk-init.sh.wrk
270     echo
271     echo "... DONE."
272     echo "DON'T FORGET: after the first installation you MUST configure your run-levels accordingly"
273     echo
274     echo "Example: su -c 'update-rc.d $scrname defaults'"
275     echo
276     exit 0
277 fi
278 #
279 #  Pre-check
280 #
281 # check for etc path existence
282 dsta="$(dirname "$web_path")"
283 etc_path="$(searchetc "$dsta" Etc)"
284 if [ $? -ne 0 ]; then
285     echo "Etc directory not found"
286     exit 1
287 fi
288
289 IFS='
290 '
291 #
292 #  Installation
293 #
294 ftokk_path="${ftok_path}k"
295
296 if [ $card_hand -lt 2 -o $card_hand -gt 8 ]; then
297     echo "card_hand ($card_hand) out of range (2 <= c <= 8)"
298     exit 1
299 fi
300
301 if [ $players_n -ne 3 -a $players_n -ne 5 ]; then
302     echo "players_n ($players_n) out of range (3|5)"
303     exit 1
304 fi
305
306 if [ "$web_only" = "FALSE" ]; then
307     if [ ! -d "$ftok_path" -a ! -d "$ftokk_path" ]; then
308         echo "ftok_path (\"$ftok_path\") not exists"
309         exit 2
310     fi
311     if [ -d "$ftok_path" -a -d "$ftokk_path" ]; then
312         echo "ftok_path (\"$ftok_path\") and ftokk_path (\"$ftokk_path\") exist, cannot continue"
313         exit 4
314     fi
315     if [ -d "$ftok_path" ]; then
316         mv "$ftok_path" "$ftokk_path"
317     fi
318     touch $ftokk_path/spy.txt >/dev/null 2>&1
319     if [ $? -ne 0 ]; then
320         echo "ftokk_path (\"$ftokk_path\") write not allowed."
321         exit 3
322     fi
323     rm $ftokk_path/spy.txt
324     
325     # create the fs subtree to enable ftok-ing
326     touch ${ftokk_path}/main
327     chmod 666 ${ftokk_path}/main
328     touch ${ftokk_path}/challenges
329     chmod 666 ${ftokk_path}/challenges
330     touch ${ftokk_path}/hardbans
331     chmod 666 ${ftokk_path}/hardbans
332     touch ${ftokk_path}/warrant
333     chmod 666 ${ftokk_path}/warrant
334     touch ${ftokk_path}/poll
335     chmod 666 ${ftokk_path}/poll
336     for i in $(seq 0 $max_players); do
337         touch ${ftokk_path}/user$i
338         chmod 666 ${ftokk_path}/user$i
339     done
340
341     if [ ! -d ${ftokk_path}/bin5 ]; then
342         mkdir ${ftokk_path}/bin5
343         chmod 777 ${ftokk_path}/bin5
344     fi
345
346     for i in $(seq 0 $((tables_n - 1))); do
347         if [ ! -d ${ftokk_path}/bin5/table$i ]; then
348             mkdir ${ftokk_path}/bin5/table$i
349         fi
350         chmod 777 ${ftokk_path}/bin5/table$i
351         touch ${ftokk_path}/bin5/table$i/table
352         chmod 666 ${ftokk_path}/bin5/table$i/table
353         for e in $(seq 0 4); do
354             touch ${ftokk_path}/bin5/table$i/user$e
355             chmod 666 ${ftokk_path}/bin5/table$i/user$e
356         done
357         # create subdirectories in proxy path
358         if [ ! -d ${proxy_path}/bin5/table$i ]; then
359             mkdir -p ${proxy_path}/bin5/table$i
360         fi
361     done
362     chmod -R 777 ${proxy_path}/bin5
363
364 fi
365 install -d ${web_path}__
366 for i in $(find web -type d | grep '/' | sed 's/^....//g'); do
367     install -d ${web_path}__/$i 
368 done
369
370 for i in $(find web -name '.htaccess' -o -name '*.php' -o -name '*.phh' -o -name '*.pho' -o -name '*.css' -o -name '*.js' -o -name '*.mp3' -o -name '*.swf' -o -name 'terms-of-service*' | sed 's/^....//g'); do
371     install -m 644 "web/$i" "${web_path}__/$i"
372 done
373 if [ "$test_add" = "TRUE" ]; then
374     for i in $(find webtest -name '.htaccess' -o -name '*.php' -o -name '*.phh' -o -name '*.pho' -o -name '*.css' -o -name '*.js' -o -name '*.mp3' -o -name '*.swf' -o -name 'terms-of-service*' | sed 's/^........//g'); do
375         install -m 644 "webtest/$i" "${web_path}__/$i"
376     done
377 fi
378
379 chmod 755 "${web_path}__/spush/brisk-spush.php"
380
381 prefix_path_len=$(echo -n "$prefix_path" | wc -c)
382
383 if [ $players_n -eq 5 ]; then
384    send_time=250
385 else
386    send_time=10
387 fi
388
389 # .js substitutions
390 sed -i "s/CARD_HAND *= *[0-9]\+/CARD_HAND = $card_hand/g" $(find ${web_path}__ -type f -name '*.js' -exec grep -l 'CARD_HAND *= *[0-9]\+' {} \;)
391 sed -i "s/PLAYERS_N *= *[0-9]\+/PLAYERS_N = $players_n/g" $(find ${web_path}__ -type f -name '*.js' -exec grep -l 'PLAYERS_N *= *[0-9]\+' {} \;)
392
393 sed -i "s/^var G_send_time *= *[0-9]\+/var G_send_time = $send_time/g" $(find ${web_path}__ -type f -name '*.js' -exec grep -l '^var G_send_time *= *[0-9]\+' {} \;)
394
395 # .ph[pho] substitutions
396 sed -i "s/define *( *'PLAYERS_N', *[0-9]\+ *)/define('PLAYERS_N', $players_n)/g" $(find ${web_path}__ -type f -name '*.ph*' -exec grep -l "define *( *'PLAYERS_N', *[0-9]\+ *)" {} \;)
397
398 sed -i "s/define *( *'BIN5_CARD_HAND', *[0-9]\+ *)/define('BIN5_CARD_HAND', $card_hand)/g" $(find ${web_path}__ -type f -name '*.ph*' -exec grep -l "define *( *'BIN5_CARD_HAND', *[0-9]\+ *)" {} \;)
399
400 sed -i "s/define *( *'BIN5_PLAYERS_N', *[0-9]\+ *)/define('BIN5_PLAYERS_N', $players_n)/g" $(find ${web_path}__ -type f -name '*.ph*' -exec grep -l "define *( *'BIN5_PLAYERS_N', *[0-9]\+ *)" {} \;)
401
402 sed -i "s@define *( *'FTOK_PATH',[^)]*)@define('FTOK_PATH', \"$ftok_path\")@g" $(find ${web_path}__ -type f -name '*.ph*' -exec grep -l "define *( *'FTOK_PATH',[^)]*)" {} \;)
403
404 sed -i "s@define *( *'SITE_PREFIX',[^)]*)@define('SITE_PREFIX', \"$prefix_path\")@g;
405 s@define *( *'SITE_PREFIX_LEN',[^)]*)@define('SITE_PREFIX_LEN', $prefix_path_len)@g" ${web_path}__/Obj/sac-a-push.phh
406
407 sed -i "s@define *( *'USOCK_PATH',[^)]*)@define('USOCK_PATH', \"$usock_path\")@g" ${web_path}__/spush/brisk-spush.phh
408
409 sed -i "s@define *( *'TABLES_N',[^)]*)@define('TABLES_N', $tables_n)@g;
410 s@define *( *'TABLES_APPR_N',[^)]*)@define('TABLES_APPR_N', $tables_appr_n)@g;
411 s@define *( *'TABLES_AUTH_N',[^)]*)@define('TABLES_AUTH_N', $tables_auth_n)@g;
412 s@define *( *'TABLES_CERT_N',[^)]*)@define('TABLES_CERT_N', $tables_cert_n)@g;
413 s@define *( *'BRISK_DEBUG',[^)]*)@define('BRISK_DEBUG', $brisk_debug)@g;
414 s@define *( *'LEGAL_PATH',[^)]*)@define('LEGAL_PATH', \"$legal_path\")@g;
415 s@define *( *'PROXY_PATH',[^)]*)@define('PROXY_PATH', \"$proxy_path\")@g;
416 s@define *( *'BRISK_CONF',[^)]*)@define('BRISK_CONF', \"$brisk_conf\")@g;" ${web_path}__/Obj/brisk.phh
417
418 sed -i "s@define *( *'BRISK_AUTH_CONF',[^)]*)@define('BRISK_AUTH_CONF', \"$brisk_auth_conf\")@g" ${web_path}__/Obj/auth.phh
419
420 sed -i "s@var \+cookiepath \+= \+\"[^\"]*\";@var cookiepath = \"$prefix_path\";@g" ${web_path}__/commons.js
421
422 sed -i "s@\( \+cookiepath *: *\)\"[^\"]*\" *,@\1 \"$prefix_path\",@g" ${web_path}__/xynt-streaming.js
423
424 document_root="$(grep DocumentRoot "${apache_conf}"  | grep -v '^[      ]*#' | awk '{ print $2 }')"
425 sed -i "s@^\(\$DOCUMENT_ROOT *= *[\"']\)[^\"']*\([\"']\)@\1$document_root\2@g" ${web_path}__/spush/*.ph*
426
427 if [ -d ../fieldify ]; then
428     pw="$PWD"
429     cd ../fieldify
430     ./INSTALL.sh -s "$pw" -w ${web_path}__
431     cd - >/dev/null 2>&1
432 fi
433 if [ -d ../brisk-img ]; then
434     cd ../brisk-img
435     ./INSTALL.sh -w ${web_path}__
436     cd - >/dev/null 2>&1
437 fi
438 if [ -d ../curl-de-sac ]; then
439     cd ../curl-de-sac
440     if [ ! -z "$conffile_in" ]; then
441         ./INSTALL.sh -f "$conffile_in" -w ${web_path}__
442     else
443         ./INSTALL.sh -w ${web_path}__
444     fi
445     cd - >/dev/null 2>&1
446 fi
447
448 # config file installation or diff
449 if [ -f "$etc_path/$brisk_conf" ]; then
450     echo "Config file $etc_path/$brisk_conf exists."
451     echo "=== Dump the diff. ==="
452     # diff -u "$etc_path/$brisk_conf" "${web_path}__""/Obj/brisk.conf-templ.pho"
453     diff -u <(cat "$etc_path/$brisk_conf" | egrep -v '^//|^#' | grep '\$[a-zA-Z_ ]\+=' | sed 's/ \+= .*/ = /g' | sort | uniq) <(cat "${web_path}__""/Obj/brisk.conf-templ.pho" | egrep -v '^//|^#' | grep '\$[a-zA-Z_ ]\+=' | sed 's/ \+= .*/ = /g' | sort | uniq )
454     echo "===   End dump.    ==="
455 else
456     echo "Config file $etc_path/$brisk_conf not exists."
457     echo "Install a template."
458     cp  "${web_path}__""/Obj/brisk.conf-templ.pho" "$etc_path/$brisk_conf"
459 fi
460
461 if [ -d ${web_path} ]; then
462     mv ${web_path} ${web_path}.old
463 fi
464
465 mv ${web_path}__ ${web_path}
466 if [ -d ${web_path}.old ]; then
467     rm -rf ${web_path}.old
468 fi
469 if [ "$web_only" = "FALSE" ]; then
470     mv "$ftokk_path" "$ftok_path"
471 fi
472 if [ -f WARNING.txt ]; then
473     echo ; echo "    ==== WARNING ===="
474     echo
475     cat WARNING.txt
476     echo
477 fi
478 exit 0