-
Notifications
You must be signed in to change notification settings - Fork 181
/
ibcstart.sh
546 lines (470 loc) · 17.5 KB
/
ibcstart.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
#!/bin/bash
# Note that this command file is a 'service file' intended to be called from
# higher level command files. There should be no reason for the end user to modify
# it in any way. So PLEASE DON'T CHANGE IT UNLESS YOU KNOW WHAT YOU'RE DOING!
showUsage () {
echo
echo "Runs IBC, thus loading TWS or the IB Gateway"
echo
echo "Usage:"
echo
echo "ibcstart twsVersion [-g \| --gateway] [--tws-path=twsPath]"
echo " [--tws-settings-path=twsSettingsPath] [--ibc-path=ibcPath]"
echo " [--ibc-ini=ibcIni] [--java-path=javaPath]"
echo " [--user=userid] [--pw=password]"
echo " [--fix-user=fixuserid] [--fix-pw=fixpassword]"
echo " [--mode=tradingMode]"
echo " [--on2fatimeout=2fatimeoutaction]"
echo
echo " twsVersion The major version number for TWS"
echo
echo " -g or --gateway Indicates that the IB Gateway is to be loaded rather"
echo " than TWS"
echo
echo " twsPath Path to the TWS installation folder. Defaults to"
echo " ~/Jts on Linux, ~/Applications on OS X"
echo
echo " twsSettingsPath Path to the TWS settings folder. Defaults to"
echo " the twsPath argument"
echo
echo " ibcPath Path to the IBC installation folder."
echo " Defaults to /opt/ibc"
echo
echo " ibcIni The location and filename of the IBC "
echo " configuration file. Defaults to "
echo " ~/ibc/config.ini"
echo
echo " javaPath Path to the folder containing the java executable to"
echo " be used to run IBC. Defaults to the java"
echo " executable included in the TWS installation; failing "
echo " that, to the Oracle Java installation"
echo
echo " userid IB account user id"
echo
echo " password IB account password"
echo
echo " fixuserid FIX account user id (only if -g or --gateway)"
echo
echo " fixpassword FIX account password (only if -g or --gateway)"
echo
echo " tradingMode Indicates whether the live account or the paper "
echo " trading account will be used. Allowed values are:"
echo
echo " live"
echo " paper"
echo
echo " These values are not case-sensitive."
echo
echo " 2fatimeoutaction Indicates what to do if IBC exits due to second factor"
echo " authentication timeout. Allowed values are:"
echo
echo " restart"
echo " exit"
echo
}
if [[ "$1" = "" || "$1" = "-?" || "$1" = "-h" || "$1" = "--HELP" ]]; then
showUsage
exit 0
fi
error_exit() {
error_number=$1
error_message=$2
error_message1=$3
error_message2=$4
>&2 echo
>&2 echo =========================== An error has occurred =============================
>&2 echo
>&2 echo
>&2 echo
>&2 echo -e "Error: ${error_message}"
if [[ -n "${error_message1}" ]]; then
>&2 echo -e " ${error_message1}"
fi
if [[ -n "${error_message2}" ]]; then
>&2 echo -e " ${error_message2}"
fi
>&2 exit "${error_number}"
}
# Some constants
E_NO_JAVA=1
E_NO_TWS_VERSION=2
E_INVALID_ARG=3
E_TWS_VERSION_NOT_INSTALLED=4
E_IBC_PATH_NOT_EXIST=5
E_IBC_INI_NOT_EXIST=6
E_TWS_VMOPTIONS_NOT_FOUND=7
E_UNKNOWN_OPERATING_SYSTEM=8
# errorlevel set by IBC if second factor authentication dialog times out and
# ExitAfterSecondFactorAuthenticationTimeout setting is true
let E_2FA_DIALOG_TIMED_OUT=$((1111 % 256))
# errorlevel set by IBC if login dialog is not displayed within the time
# specified in the LoginDialogDisplayTimeout setting
E_LOGIN_DIALOG_DISPLAY_TIMEOUT=$((1112 % 256))
ENTRY_POINT_TWS=ibcalpha.ibc.IbcTws
ENTRY_POINT_GATEWAY=ibcalpha.ibc.IbcGateway
OS_LINUX=Linux
OS_OSX='OS X'
entry_point=$ENTRY_POINT_TWS
program=TWS
if [[ $OSTYPE = [lL]inux* ]]; then
os=$OS_LINUX
elif [[ $(uname) = [dD]arwin* ]]; then
os=$OS_OSX
else
error_exit $E_UNKNOWN_OPERATING_SYSTEM "Can't detect operating system"
fi
shopt -s nocasematch
for arg
do
if [[ "$arg" = "-g" ]]; then
entry_point=$ENTRY_POINT_GATEWAY
program=Gateway
elif [[ "$arg" = "--gateway" ]]; then
entry_point=$ENTRY_POINT_GATEWAY
program=Gateway
elif [[ "${arg:0:11}" = "--tws-path=" ]]; then
tws_path=${arg:11}
elif [[ "${arg:0:20}" = "--tws-settings-path=" ]]; then
tws_settings_path=${arg:20}
elif [[ "${arg:0:11}" = "--ibc-path=" ]]; then
ibc_path=${arg:11}
elif [[ "${arg:0:10}" = "--ibc-ini=" ]]; then
ibc_ini=${arg:10}
elif [[ "${arg:0:12}" = "--java-path=" ]]; then
java_path=${arg:12}
elif [[ "${arg:0:7}" = "--user=" ]]; then
ib_user_id=${arg:7}
elif [[ "${arg:0:5}" = "--pw=" ]]; then
ib_password=${arg:5}
elif [[ "${arg:0:11}" = "--fix-user=" ]]; then
fix_user_id=${arg:11}
elif [[ "${arg:0:9}" = "--fix-pw=" ]]; then
fix_password=${arg:9}
elif [[ "${arg:0:7}" = "--mode=" ]]; then
mode=${arg:7}
elif [[ "${arg:0:15}" = "--on2fatimeout=" ]]; then
twofa_to_action=${arg:15}
elif [[ "${arg:0:1}" = "-" ]]; then
error_exit $E_INVALID_ARG "Invalid parameter '${arg}'"
elif [[ "$tws_version" = "" ]]; then
tws_version=$arg
else
error_exit $E_INVALID_ARG "Invalid parameter '${arg}'"
fi
done
if [[ -n "${fix_user_id}" || -n "${fix_password}" ]]; then
if [[ ! "${program}" = "GATEWAY" ]]; then
error_exit ${E_INVALID_ARG} "FIX user id and FIX password are only valid for the Gateway"
fi
fi
mode_upper=$(echo ${mode} | tr '[:lower:]' '[:upper:]')
if [[ -n "${mode_upper}" && ! "${mode_upper}" = "LIVE" && ! "${mode_upper}" = "PAPER" ]]; then
error_exit ${E_INVALID_ARG} "Trading mode set to ${mode} but must be either 'live' or 'paper' (case-insensitive)"
fi
twofa_to_action_upper=$(echo ${twofa_to_action} | tr '[:lower:]' '[:upper:]')
if [[ -n "${twofa_to_action_upper}" && ! "${twofa_to_action_upper}" = "RESTART" && ! "${twofa_to_action_upper}" = "EXIT" ]]; then
error_exit ${E_INVALID_ARG} "2FA timeout action set to ${twofa_to_action} but must be either 'restart' or 'exit' (case-insensitive)"
fi
echo
echo -e "================================================================================"
echo
echo -e "Starting IBC version ${IBC_VRSN} on $(date +"%Y-%m-%d") at $(date +%T)"
echo
echo -e "Operating system: $(uname -a)"
echo
# log the arguments
echo Arguments:
echo
echo -e "TWS version = ${tws_version}"
echo -e "Program = ${program}"
echo -e "Entry point = ${entry_point}"
echo -e "--tws-path = ${tws_path}"
echo -e "--tws-settings-path = ${tws_settings_path}"
echo -e "--ibc-path = ${ibc_path}"
echo -e "--ibc-ini = ${ibc_ini}"
echo -e "--mode = ${mode}"
echo -e "--java-path = ${java_path}"
if [[ -z "${ib_user_id}" && -z "${ib_password}" ]]; then
echo -e "--user ="
echo -e "--pw ="
else
echo -e "--user = ***"
echo -e "--pw = ***"
fi
if [[ "${entry_point}" = "${ENTRY_POINT_GATEWAY}" ]]; then
if [[ -z "${fix_user_id}" || -z "${fix_password}" ]]; then
echo -e "--fix-user ="
echo -e "--fix-pw ="
else
echo -e "--fix-user = ***"
echo -e "--fix-pw = ***"
fi
fi
echo
#======================== Check everything ready to proceed ================
if [ "$tws_version" = "" ]; then
error_exit $E_NO_TWS_VERSION "TWS major version number has not been supplied"
fi
if [ "$os" = "$OS_LINUX" ]; then
if [ "$tws_path" = "" ]; then tws_path=~/Jts ;fi
if [ "$tws_settings_path" = "" ]; then tws_settings_path="${tws_path}" ;fi
tws_program_path="${tws_path}/${tws_version}"
gateway_program_path="${tws_path}/ibgateway/${tws_version}"
else
if [ "$tws_path" = "" ]; then tws_path=~/Applications ;fi
if [ "$tws_settings_path" = "" ]; then tws_settings_path=~/Jts ;fi
tws_program_path="${tws_path}/Trader Workstation ${tws_version}"
gateway_program_path="${tws_path}/IB Gateway ${tws_version}"
fi
if [ "$ibc_path" = "" ]; then ibc_path=/opt/ibc ;fi
if [ "$ibc_ini" = "" ]; then ibc_ini=~/ibc/config.ini ;fi
if [[ "${program}" = "TWS" ]] ; then
program_path="${tws_program_path}"
alt_program_path="${gateway_program_path}"
vmoptions_source="${program_path}/tws.vmoptions"
alt_vmoptions_source="${alt_program_path}/ibgateway.vmoptions"
else
program_path="${gateway_program_path}"
alt_program_path="${tws_program_path}"
vmoptions_source="${program_path}/ibgateway.vmoptions"
alt_vmoptions_source="${alt_program_path}/tws.vmoptions"
fi
if [[ ! -e "${program_path}/jars" ]]; then
program_path="${alt_program_path}"
vmoptions_source="${alt_vmoptions_source}"
fi
jars="${program_path}/jars"
install4j="${program_path}/.install4j"
if [[ ! -e "$jars" ]]; then
error_exit $E_TWS_VERSION_NOT_INSTALLED "Offline TWS/Gateway version $tws_version is not installed: can't find jars folder" \
"Make sure you install the offline version of TWS/Gateway" \
"IBC does not work with the auto-updating TWS/Gateway"
fi
if [[ ! -e "$ibc_path" ]]; then
error_exit $E_IBC_PATH_NOT_EXIST "IBC path: $ibc_path does not exist"
fi
if [[ ! -e "$ibc_ini" ]]; then
error_exit $E_IBC_INI_NOT_EXIST "IBC configuration file: $ibc_ini does not exist"
fi
if [[ ! -e "$vmoptions_source" ]]; then
error_exit $E_TWS_VMOPTIONS_NOT_FOUND "Neither tws.vmoptions nor ibgateway.vmoptions could be found"
fi
if [[ -n "$java_path" ]]; then
if [[ ! -e "$java_path/java" ]]; then
error_exit $E_NO_JAVA "Java installaton at $java_path/java does not exist"
fi
fi
echo =================================
echo Generating the classpath
for jar in "${jars}"/*.jar; do
if [[ -n "${ibc_classpath}" ]]; then
ibc_classpath="${ibc_classpath}:"
fi
ibc_classpath="${ibc_classpath}${jar}"
done
ibc_classpath="${ibc_classpath}:$install4j/i4jruntime.jar:${ibc_path}/IBC.jar"
echo -e "Classpath=$ibc_classpath"
echo
#======================== Generate the JAVA VM options =====================
echo Generating the JAVA VM options
declare -a vm_options
index=0
if [[ "$os" = "$OS_LINUX" ]]; then
while read line; do
if [[ -n ${line} && ! "${line:0:1}" = "#" && ! "${line:0:2}" = "-D" ]]; then
vm_options[$index]="$line"
((index++))
fi
done <<< $(cat ${vmoptions_source})
elif [[ "$os" = "$OS_OSX" ]]; then
while read line; do
if [[ -n ${line} && ! "${line:0:1}" = "#" && ! "${line:0:2}" = "-D" ]]; then
vm_options[$index]="$line"
((index++))
fi
done < <( cat "$vmoptions_source" )
fi
java_vm_options=${vm_options[*]}
java_vm_options="$java_vm_options -Dtwslaunch.autoupdate.serviceImpl=com.ib.tws.twslaunch.install4j.Install4jAutoUpdateService"
java_vm_options="$java_vm_options -Dchannel=latest"
java_vm_options="$java_vm_options -Dexe4j.isInstall4j=true"
java_vm_options="$java_vm_options -Dinstall4jType=standalone"
java_vm_options="$java_vm_options -DjtsConfigDir=${tws_settings_path}"
ibc_session_id=$(mktemp -u XXXXXXXX)
java_vm_options="$java_vm_options -Dibcsessionid=$ibc_session_id"
function find_auto_restart {
local autorestart_path=""
local f=""
restarted_needed=
for i in $(find $tws_settings_path -type f -name "autorestart"); do
local x=${i/$tws_settings_path/}
local y=$(echo $x | xargs dirname)/.
local e=$(echo "$y" | cut -d/ -f3)
if [[ "$e" = "." ]]; then
if [[ -z $f ]]; then
f="$i"
echo "autorestart file found at $f"
autorestart_path=$(echo "$y" | cut -d/ -f2)
else
autorestart_path=
echo "WARNING: deleting extra autorestart file found at $i"
rm $i
echo "WARNING: deleting first autorestart file found"
rm $f
fi
fi
done
if [[ -z $autorestart_path ]]; then
if [[ -n $f ]]; then
echo "*******************************************************************************"
echo "WARNING: More than one autorestart file was found. IBC can't determine which is"
echo " the right one, so they've all been deleted. Full authentication will"
echo " be required."
echo
echo " If you have two or more TWS/Gateway instances with the same setting"
echo " for TWS_SETTINGS_PATH, you should ensure that they are configured with"
echo " different autorestart times, to avoid creation of multiple autorestart"
echo " files."
echo "*******************************************************************************"
echo
restarted_needed=yes
else
echo "autorestart file not found"
echo
restarted_needed=
fi
else
echo "AUTORESTART_OPTION is -Drestart=${autorestart_path}"
autorestart_option=" -Drestart=${autorestart_path}"
restarted_needed=yes
fi
}
find_auto_restart
echo -e "Java VM Options=$java_vm_options$autorestart_option"
echo
#======================== Determine the location of java executable ========
echo Determining the location of java executable
# preferably use java supplied with TWS installation
# Read a path from config file. If it contains a java executable,
# return the path to the executable. Return an empty string otherwise.
function read_from_config {
path=$1
if [[ -e "$path" ]]; then
read java_path_from_config < "$path"
if [[ -e "$java_path_from_config/bin/java" ]]; then
echo -e "$java_path_from_config/bin"
else
>&2 echo -e "Could not find $java_path_from_config/bin/java"
echo ""
fi
else
echo ""
fi
}
if [[ "$os" = "$OS_LINUX" ]]; then
if [[ ! -n "$java_path" ]]; then
java_path=$(read_from_config "$install4j/pref_jre.cfg")
fi
if [[ ! -n "$java_path" ]]; then
java_path=$(read_from_config "$install4j/inst_jre.cfg")
fi
elif [[ "$os" = "$OS_OSX" ]]; then
java_path="$install4j/jre.bundle/Contents/Home/jre/bin"
if [[ ! -e "$java_path/java" ]]; then
java_path="$install4j/jre.bundle/Contents/Home/bin"
fi
fi
# alternatively use installed java, if it's from oracle (openJDK causes problems with TWS)
if [[ ! -n "$java_path" ]]; then
if type -p java > /dev/null; then
echo Found java executable in PATH
system_java=java
elif [[ -n "$JAVA_HOME" ]] && [[ -x "$JAVA_HOME/bin/java" ]]; then
echo Found java executable in JAVA_HOME
system_java="$JAVA_HOME/bin/java"
fi
if [[ "$system_java" ]]; then
if [[ $($system_java -XshowSettings:properties -version 2>&1) = *"Java(TM) SE Runtime Environment"* ]]; then
java_path=$(dirname $(which $system_java))
else
>&2 echo "System java $system_java is not from Oracle, won't use it"
fi
fi
fi
if [[ -z "$java_path" ]]; then
error_exit $E_NO_JAVA "Can\'t find suitable Java installation"
elif [[ ! -e "$java_path/java" ]]; then
error_exit $E_NO_JAVA "No java executable found in supplied path $java_path"
fi
echo Location of java executable=$java_path
echo
#======================== Start IBC ===============================
if [[ -n $fix_user_id || -n $fix_password ]]; then got_fix_credentials=1; fi
if [[ -n $ib_user_id || -n $ib_password ]]; then got_api_credentials=1; fi
if [[ -n $got_fix_credentials && -n $got_api_credentials ]]; then
hidden_credentials="*** *** *** ***"
elif [[ -n $got_fix_credentials ]]; then
hidden_credentials="*** ***"
elif [[ -n $got_api_credentials ]]; then
hidden_credentials="*** ***"
fi
# prevent other Java tools interfering with IBC
JAVA_TOOL_OPTIONS=
pushd "$tws_settings_path" > /dev/null
echo "Renaming IB's TWS or Gateway start script to prevent restart without IBC"
if [[ "$os" = "$OS_LINUX" ]]; then
if [[ -e "${program_path}/tws" ]]; then mv "${program_path}/tws" "${program_path}/tws1"; fi
if [[ -e "${program_path}/ibgateway" ]]; then mv "${program_path}/ibgateway" "${program_path}/ibgateway1"; fi
elif [[ "$os" = "$OS_OSX" ]]; then
if [[ -e "${program_path}/Trader Workstation ${tws_version}.app" ]]; then mv "${program_path}/Trader Workstation ${tws_version}.app" "${program_path}/Trader Workstation ${tws_version}-1.app"; fi
if [[ -e "${program_path}/IB Gateway ${tws_version}.app" ]]; then mv "${program_path}/IB Gateway ${tws_version}.app" "${program_path}/IB Gateway ${tws_version}-1.app"; fi
fi
echo
while :
do
echo "Starting $program with this command:"
echo -e "\"$java_path/java\" -cp \"$ibc_classpath\" $java_vm_options$autorestart_option $entry_point \"$ibc_ini\" $hidden_credentials ${mode}"
echo
# forward signals (see https://veithen.github.io/2014/11/16/sigterm-propagation.html)
trap 'kill -TERM $PID' TERM INT
if [[ -n $got_fix_credentials && -n $got_api_credentials ]]; then
"$java_path/java" -cp "$ibc_classpath" $java_vm_options$autorestart_option $entry_point "$ibc_ini" "$fix_user_id" "$fix_password" "$ib_user_id" "$ib_password" ${mode} &
elif [[ -n $got_fix_credentials ]]; then
"$java_path/java" -cp "$ibc_classpath" $java_vm_options$autorestart_option $entry_point "$ibc_ini" "$fix_user_id" "$fix_password" ${mode} &
elif [[ -n $got_api_credentials ]]; then
"$java_path/java" -cp "$ibc_classpath" $java_vm_options$autorestart_option $entry_point "$ibc_ini" "$ib_user_id" "$ib_password" ${mode} &
else
"$java_path/java" -cp "$ibc_classpath" $java_vm_options$autorestart_option $entry_point "$ibc_ini" ${mode} &
fi
PID=$!
wait $PID
trap - TERM INT
wait $PID
exit_code=$(($? % 256))
echo "IBC returned exit status $exit_code"
if [[ $exit_code -eq $E_LOGIN_DIALOG_DISPLAY_TIMEOUT ]]; then
:
elif [[ -e "$tws-settings-path/COLDRESTART$ibc_session_id" ]]; then
rm "$tws-settings-path/COLDRESTART$ibc_session_id"
autorestart_option=
echo "IBC will cold-restart shortly"
else
find_auto_restart
if [[ -n $restarted_needed ]]; then
restarted_needed=
# restart using the TWS/Gateway-generated autorestart file
:
elif [[ $exit_code -ne $E_2FA_DIALOG_TIMED_OUT ]]; then
break;
elif [[ ${twofa_to_action_upper} != "RESTART" ]]; then
break;
fi
fi
# wait a few seconds before restarting
echo IBC will restart shortly
echo sleep 2
done
echo "$program finished"
echo
popd > /dev/null
exit $exit_code