annotate init.d/kallithea-daemon-debian @ 8769:d35d14b05b82

diff: handle some escaped characters in Git diffs There are some odd characters (like \r and \n) that the Kallithea UI doesn't allow in filenames in repos. Kallithea (through the routes module) will fail to generate URLs when browsing Files. That is a known limitation with minimal real-world impact, non-trivial to work around or fix. There are very few relevant use cases for tracking files with odd filenames. \t is valid but is hard to render in a meaningful way in the UI. And ASCII characters like \ and " are not usable on Windows and should just be avoided. Kallithea would parse Git diffs with odd characers incorrectly or fail, even before hitting the known limitation. With this change, Kallithea will parse diffs with odd filenames correctly (and then hit the limitation). Git will quote odd filenames and escape the odd characters when emitting diffs. (Mercurial does by design not allow \r and \n , and Mercurial will thus never have to quote file names in diffs.) Quotes are already handled (and ignored). With this change, Kallithea will handle \ unescaping of \\ and \", the usual letters like \r and \n and \t, and octal numbers like \033 (for ESC) . Filenames with \ and " will work perfectly (when not on Windows). Filenames with \t and ESC will work fine, but without helpful display in the UI. Filenames with \r and \n will still make the UI fail when trying to generate URLs. Thanks to stypr of Flatt Security for raising this.
author Mads Kiilerich <mads@kiilerich.com>
date Sat, 14 Nov 2020 15:41:39 +0100
parents 71bdbf129190
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
1 #!/bin/sh -e
426
17d5028e055c updated init scripts to start-stop-daemons
Marcin Kuzminski <marcin@python-works.com>
parents: 38
diff changeset
2 ########################################
1262
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
3 #### THIS IS A DEBIAN INIT.D SCRIPT ####
426
17d5028e055c updated init scripts to start-stop-daemons
Marcin Kuzminski <marcin@python-works.com>
parents: 38
diff changeset
4 ########################################
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
5
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
6 ### BEGIN INIT INFO
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
7 # Provides: kallithea
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
8 # Required-Start: $all
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
9 # Required-Stop: $all
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
10 # Default-Start: 2 3 4 5
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
11 # Default-Stop: 0 1 6
4190
99ad9d0af1a3 Rename init scripts and fix references inside them
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3225
diff changeset
12 # Short-Description: starts instance of kallithea
99ad9d0af1a3 Rename init scripts and fix references inside them
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3225
diff changeset
13 # Description: starts instance of kallithea using start-stop-daemon
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
14 ### END INIT INFO
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
15
4190
99ad9d0af1a3 Rename init scripts and fix references inside them
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3225
diff changeset
16 APP_NAME="kallithea"
3225
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
17 APP_HOMEDIR="opt"
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
18 APP_PATH="/$APP_HOMEDIR/$APP_NAME"
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
19
426
17d5028e055c updated init scripts to start-stop-daemons
Marcin Kuzminski <marcin@python-works.com>
parents: 38
diff changeset
20 CONF_NAME="production.ini"
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
21
426
17d5028e055c updated init scripts to start-stop-daemons
Marcin Kuzminski <marcin@python-works.com>
parents: 38
diff changeset
22 PID_PATH="$APP_PATH/$APP_NAME.pid"
17d5028e055c updated init scripts to start-stop-daemons
Marcin Kuzminski <marcin@python-works.com>
parents: 38
diff changeset
23 LOG_PATH="$APP_PATH/$APP_NAME.log"
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
24
3225
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
25 PYTHON_PATH="/$APP_HOMEDIR/$APP_NAME-venv"
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
26
3225
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
27 RUN_AS="root"
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
28
6554
2c3d30095d5e gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack
Mads Kiilerich <madski@unity3d.com>
parents: 6370
diff changeset
29 DAEMON="$PYTHON_PATH/bin/gearbox"
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
30
426
17d5028e055c updated init scripts to start-stop-daemons
Marcin Kuzminski <marcin@python-works.com>
parents: 38
diff changeset
31 DAEMON_OPTS="serve --daemon \
3225
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
32 --user=$RUN_AS \
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
33 --group=$RUN_AS \
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
34 --pid-file=$PID_PATH \
6554
2c3d30095d5e gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack
Mads Kiilerich <madski@unity3d.com>
parents: 6370
diff changeset
35 --log-file=$LOG_PATH -c $APP_PATH/$CONF_NAME"
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
36
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
37
1262
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
38 start() {
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
39 echo "Starting $APP_NAME"
8606
71bdbf129190 py3: drop PYTHON_EGG_CACHE and .egg-cache - that was a py2 thing
Mads Kiilerich <mads@kiilerich.com>
parents: 6554
diff changeset
40 start-stop-daemon -d $APP_PATH \
1262
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
41 --start --quiet \
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
42 --pidfile $PID_PATH \
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
43 --user $RUN_AS \
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
44 --exec $DAEMON -- $DAEMON_OPTS
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
45 }
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
46
1262
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
47 stop() {
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
48 echo "Stopping $APP_NAME"
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
49 start-stop-daemon -d $APP_PATH \
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
50 --stop --quiet \
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
51 --pidfile $PID_PATH || echo "$APP_NAME - Not running!"
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
52
1262
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
53 if [ -f $PID_PATH ]; then
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
54 rm $PID_PATH
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
55 fi
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
56 }
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
57
3225
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
58 status() {
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
59 echo -n "Checking status of $APP_NAME ... "
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
60 pid=`cat $PID_PATH`
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
61 status=`ps ax | grep $pid | grep -ve grep`
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
62 if [ "$?" -eq 0 ]; then
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
63 echo "running"
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
64 else
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
65 echo "NOT running"
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
66 fi
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
67 }
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
68
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
69 case "$1" in
3225
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
70 status)
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
71 status
f9540f9c5999 little improvements for debian init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 1262
diff changeset
72 ;;
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
73 start)
1262
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
74 start
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
75 ;;
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
76 stop)
1262
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
77 stop
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
78 ;;
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
79 restart)
426
17d5028e055c updated init scripts to start-stop-daemons
Marcin Kuzminski <marcin@python-works.com>
parents: 38
diff changeset
80 echo "Restarting $APP_NAME"
432
90512560ed4d more with init scripts !
Marcin Kuzminski <marcin@python-works.com>
parents: 431
diff changeset
81 ### stop ###
1262
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
82 stop
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
83 wait
432
90512560ed4d more with init scripts !
Marcin Kuzminski <marcin@python-works.com>
parents: 431
diff changeset
84 ### start ###
1262
238bea955b54 simplified example init.d script
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
85 start
433
aeafda5481e4 more on that neverending topic :) init scripts
Marcin Kuzminski <marcin@python-works.com>
parents: 432
diff changeset
86 ;;
12
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
87 *)
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
88 echo "Usage: $0 {start|stop|restart}"
5f30a6d558dc Added pylons manage script
Marcin Kuzminski
parents:
diff changeset
89 exit 1
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4190
diff changeset
90 esac