forked from oracle/opengrok
-
Notifications
You must be signed in to change notification settings - Fork 0
/
OpenGrok
executable file
·1114 lines (978 loc) · 33.7 KB
/
OpenGrok
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
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/bin/sh
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# See LICENSE.txt included in this distribution for the specific
# language governing permissions and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at LICENSE.txt.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#
# OpenGrok Wrapper (initial setup and cron job updating)
#
# Supported Operating Systems:
# - Solaris 11 (SunOS 5.11)
# - Debian (Linux)
#
# Supported Deployment Engines:
# - Tomcat 8
# - Glassfish
# - Resin
#
# Supported Environment Variables:
# - OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages (*)
# - OPENGROK_STANDARD_ENV Run Time Shell Environment (Shell Script)
# - OPENGROK_CONFIGURATION User Configuration (Shell Script)
#
# Supported Environment Variables for configuring the default setup:
# - OPENGROK_DISTRIBUTION_BASE Base Directory of the OpenGrok Distribution
# - OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area
# - OPENGROK_SRC_ROOT directory with files to be indexed
# - OPENGROK_DATA_ROOT directory where index and cache files are generated
# - OPENGROK_CTAGS Full path to Exuberant or Universal CTags binary
# - OPENGROK_CTAGS_OPTIONS_FILE Full path to file with extra command line
# options for CTags program (for its --options
# switch), default is DATA_ROOT/etc/ctags.config
# - OPENGROK_MANDOC Full path to mandoc(1) binary
# - JAVA_HOME Full Path to Java Installation Root
# - JAVA Full Path to java binary (to enable 64bit JDK)
# - JAVA_OPTS Java options (e.g. for JVM memory increase
# or enabling server JDK)
# JAVA_OPTS=-Xmx2048m is the default!
# - OPENGROK_APP_SERVER Application Server ("Tomcat", "Glassfish" or "Resin")
# - OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory
# - OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory
# - OPENGROK_WAR_TARGET_RESIN Resin Specific WAR Target Directory
# - OPENGROK_WAR_TARGET Fallback WAR Target Directory
# - OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps)
# - OPENGROK_GLASSFISH_BASE Base Directory for Glassfish
# (contains domains)
# - OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name
# - OPENGROK_RESIN_BASE Base Directory for Resin (contains webapps)
# - OPENGROK_VERBOSE Enable Verbose Mode in opengrok.jar (*)
# - OPENGROK_PROGRESS Shows progress in %(percentage) of working
# through project, it's good to have Verbose
# Mode enabled too, cost of this is one more
# traversal of the project before indexing it(*)
# - OPENGROK_RENAMED_FILES_HISTORY If set to "on", get full history of
# renamed files for SCMs that support it (Git,
# Mercurial).
# The default is off.
# When set to on, the indexing is slower,
# especially in the presence of
# lots of renamed files in the repository.
# - OPENGROK_GENERATE_HISTORY Influence history cache generation
# Following values are recognized:
# on - enabled (default)
# off - disabled for indexing and UI
# dirbased - indexing enabled only for repos
# which can fetch history for
# directory
# local - for local repos only
# uionly - enabled for UI only
# - OPENGROK_ENABLE_PROJECTS Enable projects (set it to true or false)
# Every directory in SRC_ROOT is
# considered a separate project
# - OPENGROK_IGNORE_PATTERNS Set ignored patterns for indexer to skip.
# OPENGROK_IGNORE_PATTERNS="-i dummy"
# OPENGROK_IGNORE_PATTERNS="-i f:dummy"
# OPENGROK_IGNORE_PATTERNS="-i d:dummy"
# Multiple entries can be joined together:
# "-i dummy -i d:tmp -i f:dummy"
# - OPENGROK_SCAN_REPOS Disable Scan for repositories (*)
# - OPENGROK_SCAN_DEPTH how deep should scanning for repos go
# (by default 3 directories from SRC_ROOT)
# - OPENGROK_WEBAPP_CFGADDR Web app address to send configuration to
# (use "none" to avoid sending it to web app)
# - OPENGROK_WEBAPP_CONTEXT Context URL of the OpenGrok webapp
# (by default /source)
# - FULL reindex is needed once this is used
# (old already indexed files won't be refreshed)
# - OPENGROK_WPREFIX Disable wildcard prefix search query
# support (*)
# - OPENGROK_TAG Enable parsing of revision tags into the History
# view
# - OPENGROK_READ_XML_CONFIGURATION file with read only configuration
# - temporary workaround for bug # 327
# - OPENGROK_FLUSH_RAM_BUFFER_SIZE="-m 16" - set RAM buffer size for flushing,
# default is 16MB per thread, you might try to
# increase it to 256MB, but do increase JVM to
# 4/8/16GB ! Lucene defaults to 8 threads.
# Increase JVM memory as noted using JAVA_OPTS
# - OPENGROK_LOGGER_CONFIG_PATH Set path to custom logging.properties file.
# - OPENGROK_SUBVERSION_USERNAME name of the user that should be used for
# fetching the history from subversion
# - OPENGROK_SUBVERSION_PASSWORD password of the user that should be used for
# fetching the history from subversion
#
# - OPENGROK_PROFILER Pause to await user input for profiling.
#
# Notes:
# (*) Any Non-Empty String will enable these options
#
#
# Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
# Portions Copyright (c) 2017-2018, Chris Fraire <cfraire@me.com>.
#
#
# Print usage to stdout and exit.
#
Usage()
{
progname=`basename $0`
exec >&2
echo ""
echo "Usage: ${progname} <bootstrap|deploy|update|updateQuietly|updateDesc|usage|help>"
echo " ${progname} index [<directory>]"
echo " ${progname} indexpart <directory_1> [<directory_2> ..]"
echo " ${progname} clearHistory <src_root> <repository_name>"
echo ""
echo " The \"indexpart\" assumes that it will be run with configuration"
echo " pointed to via the OPENGROK_READ_XML_CONFIGURATION environment"
echo " variable."
echo ""
echo " Optional environment variables:"
echo " OPENGROK_CONFIGURATION - location of your configuration"
echo " e.g. $ OPENGROK_CONFIGURATION=/var/opengrok/myog.conf ${0} ... "
echo ""
echo " See the code for more information on configuration options /" \
"variables"
echo ""
exit 1
}
#
# Runtime Configuration
#
if [ -x "/bin/uname" ]; then
OS_NAME="`/bin/uname -s`"
OS_VERSION="`/bin/uname -r`"
elif [ -x "/usr/bin/uname" ]; then
OS_NAME="`/usr/bin/uname -s`"
OS_VERSION="`/usr/bin/uname -r`"
else
echo "Cannot determine operating system version"
exit 1
fi
SCRIPT_DIRECTORY=`dirname "${0}"`
export SCRIPT_DIRECTORY=`cd "${SCRIPT_DIRECTORY}"; pwd -P`
#
# Default Instance Configuration
#
DefaultInstanceConfiguration()
{
# Use the built-in defaults. This section can be copied to its own
# file and tailored to your local requirements. Then simply set
# OPENGROK_CONFIGURATION=/path/to/your/configuration, before using
# this wrapper. It will save you hand editing in your settings
# on each new release. A sample cron(1M) entry might look like:
# 15 0 * * * OPENGROK_CONFIGURATION=/pkgs/etc/OpenGrok.sh /pkgs/sbin/OpenGrok updateQuietly
# Note: It is not really possible to ever provided defaults for
# these values which will run in every UNIX-like environment.
# So I have provided a set which are functional for a given
# environment on which you can based you own configuration.
# This has been updated to support more environment variables and
# operating systems, if you have any reasonably generic
# improvements please feel free to submit a patch.
OPENGROK_INSTANCE_BASE="${OPENGROK_INSTANCE_BASE:-/var/opengrok}"
LOGGER_CONFIG_FILE="logging.properties"
if [ -z "${OPENGROK_DISTRIBUTION_BASE}" ]
then
if [ -d "${SCRIPT_DIRECTORY}/dist" -a \
-f "${SCRIPT_DIRECTORY}/dist/opengrok.jar" -a \
-f "${SCRIPT_DIRECTORY}/dist/source.war" \
]
then
# Handle Developer Build Environments
OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/dist"
LOGGER_CONF_SOURCE="${SCRIPT_DIRECTORY}/${LOGGER_CONFIG_FILE}"
else
# Handle Binary Distributions
OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/../lib"
LOGGER_CONF_SOURCE="${OPENGROK_DISTRIBUTION_BASE}/../doc/"
fi
fi
# REQUIRED: Source Code/Repository Root
# (your source code or the root of all repositories)
if [ -n "${OPENGROK_SRC_ROOT}" ]; then
SRC_ROOT="${OPENGROK_SRC_ROOT}"
else
SRC_ROOT="${OPENGROK_INSTANCE_BASE}/src"
fi
# REQUIRED: OpenGrok Generate Data Root
# (for Lucene index and hypertext cross-references)
# This area is rebuilt by "update" / "updateQuietly"
if [ -n "${OPENGROK_DATA_ROOT}" ]; then
DATA_ROOT="${OPENGROK_DATA_ROOT}"
else
DATA_ROOT="${OPENGROK_INSTANCE_BASE}/data"
fi
# OPTIONAL: User Provided Source Path to Description Mapping
# (Tab Separated Value)
# (The user maintained source of the generated EftarFile file)
PATH_DESC="${OPENGROK_INSTANCE_BASE}/etc/paths.tsv"
# REQUIRED: XML Configuration
# (the configuration used by Web/GUI interfaces)
XML_CONFIGURATION="${OPENGROK_INSTANCE_BASE}/etc/configuration.xml"
# OPTIONAL: read only XML config, if it exists, it will be read
READ_XML_CONFIGURATION="${OPENGROK_READ_XML_CONFIGURATION:-}"
if [ -f "${READ_XML_CONFIGURATION}" ] ; then
READ_XML_CONF="-R ${READ_XML_CONFIGURATION}"
fi
# REQUIRED: Logger Configuration
if [ -n "${OPENGROK_LOGGER_CONFIG_PATH}" ]; then
if [ ! -f "${OPENGROK_LOGGER_CONFIG_PATH}" ]; then
echo "File ${OPENGROK_LOGGER_CONFIG_PATH} does not exist"
exit 1
fi
LOGGER_CONFIG_PATH=${OPENGROK_LOGGER_CONFIG_PATH}
else
LOGGER_CONFIG_PATH="${OPENGROK_INSTANCE_BASE}/${LOGGER_CONFIG_FILE}"
fi
LOGGER_PROPERTIES="-Djava.util.logging.config.file=${LOGGER_CONFIG_PATH}"
# REQUIRED: Java Archive of OpenGrok (Installation Location)
OPENGROK_JAR="${OPENGROK_DISTRIBUTION_BASE}/opengrok.jar"
# REQUIRED(deploy): Web Archive of OpenGrok (Distribution Location)
# (user building from source code will find this and other key
# files in the "dist" directory after the build is completed)
OPENGROK_DIST_WAR="${OPENGROK_DISTRIBUTION_BASE}/source.war"
# REQUIRED: Exuberant or Universal CTags
OPENGROK_CTAGS="${OPENGROK_CTAGS:-`FindCtags`}"
# OPTIONAL: supply extra command line options to CTags program
if [ -n "${OPENGROK_CTAGS_OPTIONS_FILE}" ]; then
CTAGS_OPTIONS_FILE="${OPENGROK_CTAGS_OPTIONS_FILE}"
elif [ -r "${OPENGROK_INSTANCE_BASE}/etc/ctags.config" ]; then
CTAGS_OPTIONS_FILE="${OPENGROK_INSTANCE_BASE}/etc/ctags.config"
fi
# REQUIRED: Java Home
JAVA_HOME="${JAVA_HOME:-`FindJavaHome`}"
export JAVA_HOME
# REQUIRED: Java Virtual Machine
JAVA="${JAVA:-$JAVA_HOME/bin/java}"
# DEVELOPMENT: Debug option, if enabled current indexer will listen on the
# port 8010 until a debugger connects
#JAVA_DEBUG="-agentlib:jdwp=transport=dt_socket"
#JAVA_DEBUG="$JAVA_DEBUG,server=y,address=8010,suspend=y"
# OPTIONAL: Ignore these patterns as names of files or directories
#OPENGROK_IGNORE_PATTERNS="-i dummy"
# To ignore skipping just the history cache creation for a particular
# directory and all of it's subdirectories, touch an empty
# .opengrok_skip_history file at the root of that directory
# OPTIONAL: Enable Projects
# (Every directory in SRC_ROOT is considered a separate project)
OPENGROK_ENABLE_PROJECTS="${OPENGROK_ENABLE_PROJECTS:-true}"
case $OPENGROK_ENABLE_PROJECTS in
true) ENABLE_PROJECTS="-P" ;;
false) ENABLE_PROJECTS="" ;;
*) ENABLE_PROJECTS="-P" ;;
esac
# OPTIONAL: Scanning Options (for Mercurial repositories)
SCAN_FOR_REPOSITORY="-S"
if [ -n "${OPENGROK_SCAN_REPOS}" ]
then
SCAN_FOR_REPOSITORY=""
fi
# OPTIONAL: Disable remote repository support (CVS or SVN) [on by default]
GENERATE_HISTORY="-r on"
if [ -n "${OPENGROK_GENERATE_HISTORY}" ]
then
GENERATE_HISTORY="-r ${OPENGROK_GENERATE_HISTORY}"
fi
if [ "$OPENGROK_GENERATE_HISTORY" != "off" ]
then
GENERATE_HISTORY="${GENERATE_HISTORY} -H"
fi
if [ "$OPENGROK_RENAMED_FILES_HISTORY" != "on" ]
then
RENAMED_FILES_HISTORY="--renamedHistory off"
else
RENAMED_FILES_HISTORY="--renamedHistory on"
fi
# OPTIONAL: override depth of scanning for repositories
if [ -n "${OPENGROK_SCAN_DEPTH}" ]
then
SCAN_DEPTH="--depth ${OPENGROK_SCAN_DEPTH}"
fi
# OPTIONAL: Allow Leading Wildcard Searches
# (default: on)
LEADING_WILDCARD="--leadingWildCards on"
if [ -n "${OPENGROK_WPREFIX}" ]
then
LEADING_WILDCARD=""
fi
# OPTIONAL: Web Site Look & Feel
# (Options: default)
# Note the quoting requirements)
#SKIN='--style default'
# OPTIONAL: Configuration Address (host:port)
# (conf/web.xml default is localhost:2424)
WEBAPP_CONFIG=""
if [ -n "${OPENGROK_WEBAPP_CFGADDR}" ]; then
WEBAPP_CONFIG_ADDRESS=${OPENGROK_WEBAPP_CFGADDR}
if [ "${OPENGROK_WEBAPP_CFGADDR}" = "none" ]; then
WEBAPP_CONFIG_ADDRESS=""
fi
else
WEBAPP_CONFIG_ADDRESS="localhost:2424"
fi
if [ -n "${WEBAPP_CONFIG_ADDRESS}" ]; then
WEBAPP_CONFIG="-U ${WEBAPP_CONFIG_ADDRESS}"
fi
# OPTIONAL: Context URL of the OpenGrok webapp
# (default is /source)
WEBAPP_CONTEXT=""
if [ -n "${OPENGROK_WEBAPP_CONTEXT}" ]; then
WEBAPP_CONTEXT="-w ${OPENGROK_WEBAPP_CONTEXT}"
fi
# OPTIONAL: JVM Options
JAVA_OPTS="${JAVA_OPTS:--Xmx2048m}"
# OPTIONAL: Full Path to History Utilities
BK="`Which bk`"
HG="`Which hg`"
CVS="`Which cvs`"
SVN="`Which svn`"
SCCS="`Which sccs`"
CLEARCASE="`Which cleartool`"
GIT="`Which git`"
P4="`Which p4`"
MTN="`Which mtn`"
BZR="`Which bzr`"
# OPTIONAL: Override Built-in Properties
# Assumption: We should not set properties to the empty string
PROPERTIES="\
${BK:+-Dorg.opensolaris.opengrok.history.BitKeeper=$BK} \
${HG:+-Dorg.opensolaris.opengrok.history.Mercurial=$HG} \
${CVS:+-Dorg.opensolaris.opengrok.history.cvs=$CVS} \
${SVN:+-Dorg.opensolaris.opengrok.history.Subversion=$SVN} \
${SCCS:+-Dorg.opensolaris.opengrok.history.SCCS=$SCCS} \
${CLEARCASE:+-Dorg.opensolaris.opengrok.history.ClearCase=$CLEARCASE} \
${GIT:+-Dorg.opensolaris.opengrok.history.git=$GIT} \
${P4:+-Dorg.opensolaris.opengrok.history.Perforce=$P4} \
${MTN:+-Dorg.opensolaris.opengrok.history.Monotone=$MTN} \
${BZR:+-Dorg.opensolaris.opengrok.history.Bazaar=$BZR} \
"
# OPTIONAL: Show revision tags in History view.
# Turn this off if you want to increase indexing performance a bit
# (default: off)
if [ -n "${OPENGROK_TAG}" ]
then
HISTORY_TAGS="-G"
fi
# DELIVERED: An update program for EftarFile
# Usage: <class> inputFile [inputFile ...] outputFile
# EftarFile == An Extremely Fast Tagged Attribute Read-only File System
EFTAR_UPDATE="org.opensolaris.opengrok.web.EftarFile"
# HARDCODED: Generated EftarFile (See web/*.jsp)
EFTAR_OUTPUT_FILE="${DATA_ROOT}/index/dtags.eftar"
# Be Quiet? (set indirectly by command line arguments in the main program)
#QUIET=""
# or alternatively, Be Verbose!
#VERBOSE="-v"
if [ -n "${OPENGROK_VERBOSE}" ]
then
VERBOSE="-v"
QUIET=""
fi
if [ -n "${OPENGROK_PROGRESS}" ]
then
PROGRESS="--progress"
fi
}
#
# Helper Functions - Logging
#
# In general, non-interactive use like cron jobs and automated
# installation environments should not generate unnecessary
# progress information or warnings, as usage and configuration
# will have generally been debugged prior to automation.
#
Progress()
{
if [ -z "${OPENGROK_NON_INTERACTIVE}" ]
then
echo "${@}"
fi
}
Warning()
{
if [ -z "${OPENGROK_NON_INTERACTIVE}" ]
then
echo "WARNING: ${@}" 1>&2
fi
}
Error()
{
echo "ERROR: ${@}" 1>&2
}
FatalError()
{
exec >&2
echo ""
echo "FATAL ERROR: ${@} - Aborting!"
echo ""
${DO} exit 2
}
#
# Helper Functions - Autodetection of Runtime Environment
#
Which()
{
path="`which ${1} 2>/dev/null`"
if [ -x "${path}" ]
then
echo "${path}"
fi
}
LocateBinary() {
for f in $@
do
file=`which "$f" 2>/dev/null | grep -v '^no '`
if test -n "$file" -a -x "$file"
then
echo $file
return 0
fi
done
echo ""
return 1
}
FindCtags()
{
#
# Search for Exuberant ctags intelligently, skipping
# over other ctags implementations.
#
binary=""
found=0
for program in ctags-exuberant exctags ctags; do
for path in `echo $PATH | tr ':' '\n'`; do
if [ -x "$path/$program" ]; then
binary="$path/$program"
# Verify that this tool is or is based on Exuberant Ctags.
$binary --version 2>&1 | grep "Exuberant Ctags" > /dev/null
if [ $? -eq 0 ]; then
found=1
break
fi
fi
done
if [ $found -eq 1 ]; then
break;
fi
done
if [ $found -ne 1 ]; then
Error "Unable to determine Exuberant/Universal CTags command name" \
"for ${OS_NAME} ${OS_VERSION}"
return
fi
echo ${binary}
}
FindJavaHome()
{
javaHome=""
case "${OS_NAME}:${OS_VERSION}" in
SunOS:5.10) javaHome="/usr/jdk/instances/jdk1.7.0" ;;
SunOS:5.11) javaHome="/usr/jdk/latest" ;;
SunOS:5.12) javaHome="/usr/jdk/latest" ;;
Darwin:*) javaHome=`/usr/libexec/java_home` ;;
Linux:*)
if [ -f /etc/alternatives/java ]
then
javaHome=`ls -l /etc/alternatives/java | cut -f 2 -d \> `
javaHome=`dirname $javaHome`
javaHome=`dirname $javaHome`
fi
;;
esac
if [ -z "${javaHome}" ]
then
Error "Unable to determine Java 7 Home" \
"for ${OS_NAME} ${OS_VERSION}"
return
fi
if [ ! -d "${javaHome}" ]
then
Error "Missing Java Home ${javaHome}"
return
fi
echo "${javaHome}"
}
FindApplicationServerType()
{
# Use this function to determine which environment the deploy the
# web application function into. Some users (especially
# developers) will have many deployment environments or will wish
# to specify directly the application server to deploy to.
# Either use the environment variable OPENGROK_APP_SERVER or
# reimplement this function in your configuration file (as
# specified by OPENGROK_CONFIGURATION)
if [ -n "${OPENGROK_APP_SERVER}" ]
then
echo "${OPENGROK_APP_SERVER}"
return
fi
# This implementation favours Tomcat, but needs a lot of work,
# especially if Glassfish is preferred or it is under the control
# of SMF (Service Management Facility)
# Maybe a better implementation would be to call Application
# Server specific WAR Directory and see if they exist.
if [ -d "/var/tomcat8/webapps" \
-o -d "/var/lib/tomcat8/webapps" \
]
then
echo "Tomcat"
return
fi
if [ -x "/etc/init.d/appserv" -a -d "/var/appserver/domains" ]
then
echo "Glassfish"
return
fi
if [ -d "/etc/resin" -o -d "/usr/local/share/resin" ]
then
echo "Resin"
return
fi
# Assume Tomcat
echo "Tomcat"
}
DetermineWarDirectoryTomcat()
{
if [ -n "${OPENGROK_WAR_TARGET_TOMCAT}" ]
then
echo "${OPENGROK_WAR_TARGET_TOMCAT}"
return
elif [ -n "${OPENGROK_WAR_TARGET}" ]
then
echo "${OPENGROK_WAR_TARGET}"
return
fi
for prefix in \
${OPENGROK_TOMCAT_BASE} \
/var/lib/tomcat8 \
/var/tomcat8
do
if [ -d "${prefix}/webapps" ]
then
echo "${prefix}/webapps"
return
fi
done
}
DetermineWarDirectoryGlassfish()
{
if [ -n "${OPENGROK_WAR_TARGET_GLASSFISH}" ]
then
echo "${OPENGROK_WAR_TARGET_GLASSFISH}"
return
elif [ -n "${OPENGROK_WAR_TARGET}" ]
then
echo "${OPENGROK_WAR_TARGET}"
return
fi
for prefix in \
${OPENGROK_GLASSFISH_BASE} \
/var/appserver
do
if [ -d "${prefix}/domains" ]
then
if [ -z "${domainDirectory}" ]
then
domainDirectory="${prefix}/domains"
fi
fi
done
if [ -z "${domainDirectory}" ]
then
return
fi
# User Specified Domain
if [ -n "${OPENGROK_GLASSFISH_DOMAIN}" ]
then
directory="${domainDirectory}/${OPENGROK_GLASSFISH_DOMAIN}/autodeploy"
if [ ! -d "${directory}" ]
then
FatalError "Missing Specified Glassfish Domain " \
"${OPENGROK_GLASSFISH_DOMAIN}"
fi
echo "${directory}"
return
fi
# Arbitrary Domain Selection
firstDomain=`ls -1 ${domainDirectory} | head -1`
if [ -z "${firstDomain}" ]
then
FatalError "Failed to dynamically determine Glassfish Domain from " \
"${domainDirectory}"
fi
echo "${domainDirectory}/${firstDomain}/autodeploy"
}
DetermineWarDirectoryResin()
{
if [ -n "${OPENGROK_WAR_TARGET_RESIN}" ]
then
echo "${OPENGROK_WAR_TARGET_RESIN}"
return
elif [ -n "${OPENGROK_WAR_TARGET}" ]
then
echo "${OPENGROK_WAR_TARGET}"
return
fi
for prefix in \
${OPENGROK_RESIN_BASE} \
/var/resin \
/opt/resin
do
if [ -d "${prefix}/webapps" ]
then
echo "${prefix}/webapps"
return
fi
done
}
#
# Implementation
#
# The variable "DO" can usefully be set to "echo" to aid in script debugging
#
LoadStandardEnvironment()
{
# Setup a standard execution environment (if required)
cronexec="/pkgs/sbin/CronExecutionEnvironment.sh"
OPENGROK_STANDARD_ENV="${OPENGROK_STANDARD_ENV:-$cronexec}"
if [ -f "${OPENGROK_STANDARD_ENV}" ]
then
Progress "Loading ${OPENGROK_STANDARD_ENV} ..."
. "${OPENGROK_STANDARD_ENV}"
fi
}
#
# Load custom configuration and then fill remaining stuff with defaults.
#
LoadInstanceConfiguration()
{
#
# Note: As all functions have been defined by the time this routine
# is called, your configuration can, if desired, override functions
# in addition to setting the variables mentioned in the function
# DefaultInstanceConfiguration(), this maybe useful to override
# functionality used to determine the default deployment environment
# find dependencies or validate the configuration, for example.
#
if [ -n "${OPENGROK_CONFIGURATION}" -a -f "${OPENGROK_CONFIGURATION}" ]
then
# Load the Local OpenGrok Configuration Environment
Progress "Loading ${OPENGROK_CONFIGURATION} ..."
. "${OPENGROK_CONFIGURATION}"
fi
Progress "Loading the default instance configuration ..."
DefaultInstanceConfiguration
}
ValidateConfiguration()
{
if [ ! -x "${OPENGROK_CTAGS}" ]
then
FatalError "Missing Dependent Application - Exuberant/Universal CTags"
fi
if [ ! -d "${SRC_ROOT}" ]
then
FatalError "OpenGrok Source Path ${SRC_ROOT} doesn't exist"
fi
if [ -n "${QUIET}" -a -n "${VERBOSE}" ]
then
Warning "Both Quiet and Verbose Mode Enabled - Choosing Verbose"
QUIET=""
VERBOSE="-v"
fi
}
CreateRuntimeRequirements()
{
if [ ! -d "${DATA_ROOT}" ]
then
Warning "OpenGrok generated data path ${DATA_ROOT} doesn't exist"
Progress " Attempting to create generated data directory ... "
${DO} mkdir -p "${DATA_ROOT}"
fi
if [ ! -d "${DATA_ROOT}" ]
then
FatalError "OpenGrok data path ${DATA_ROOT} doesn't exist"
fi
if [ ! -d "${OPENGROK_INSTANCE_BASE}/etc" ]
then
Warning "OpenGrok generated etc path ${OPENGROK_INSTANCE_BASE}/etc " \
"doesn't exist"
Progress " Attempting to create generated etc directory ... "
${DO} mkdir -p "${OPENGROK_INSTANCE_BASE}/etc"
fi
if [ ! -d "${OPENGROK_INSTANCE_BASE}/etc" ]
then
FatalError "OpenGrok etc path ${OPENGROK_INSTANCE_BASE}/etc " \
"doesn't exist"
fi
if [ -n "${LOGGER_CONFIG_PATH}" -a ! -f "${LOGGER_CONFIG_PATH}" ]
then
Progress " Creating default ${LOGGER_CONFIG_PATH} ... "
if [ ! -f "${LOGGER_CONF_SOURCE}" ]
then
Warning "Can't find distribution logging configuration" \
"(${LOGGER_CONF_SOURCE}) to install as default" \
"logging configuration (${LOGGER_CONFIG_PATH})"
else
filename="opengrok%g.%u.log"
fullpath="${OPENGROK_INSTANCE_BASE}/log/opengrok%g.%u.log"
${DO} grep -v java.util.logging.FileHandler.pattern \
"${LOGGER_CONF_SOURCE}" > "${LOGGER_CONFIG_PATH}"
${DO} grep java.util.logging.FileHandler.pattern \
"${LOGGER_CONF_SOURCE}" | \
sed "s|$filename|$fullpath|g" >> "${LOGGER_CONFIG_PATH}"
if [ ! -d ${OPENGROK_INSTANCE_BASE}/log ]
then
${DO} mkdir ${OPENGROK_INSTANCE_BASE}/log
fi
fi
fi
}
MinimalInvocation()
{
${DO} ${JAVA} ${JAVA_OPTS} ${PROPERTIES} \
${JAVA_DEBUG} \
${LOGGER_PROPERTIES} \
-jar "${OPENGROK_JAR}" \
${VERBOSE} ${QUIET} \
"${@}"
}
CommonInvocation()
{
MinimalInvocation \
${OPENGROK_IGNORE_PATTERNS} \
${HISTORY_TAGS} \
${GENERATE_HISTORY} \
${RENAMED_FILES_HISTORY} \
${SCAN_DEPTH} \
${PROGRESS} \
${OPENGROK_CTAGS:+-c} ${OPENGROK_CTAGS} \
${OPENGROK_MANDOC:+--mandoc} ${OPENGROK_MANDOC} \
${CTAGS_OPTIONS_FILE:+-o} ${CTAGS_OPTIONS_FILE} \
${OPENGROK_FLUSH_RAM_BUFFER_SIZE} ${SKIN} ${LEADING_WILDCARD} \
${READ_XML_CONF} \
${WEBAPP_CONFIG} \
${WEBAPP_CONTEXT} \
${OPENGROK_PROFILER:+--profiler} \
"${@}"
}
StdInvocation()
{
CommonInvocation \
-W ${XML_CONFIGURATION} \
${SCAN_FOR_REPOSITORY} \
${ENABLE_PROJECTS} \
-s "${SRC_ROOT}" \
-d "${DATA_ROOT}" \
"${@}"
}
UpdateGeneratedData()
{
StdInvocation
}
UpdateDataPartial()
{
extra_args=""
for arg in "$@"; do
if [ -n "$extra_args" ]; then
extra_args="$extra_args -H $arg"
else
extra_args="-H $arg"
fi
done
CommonInvocation $extra_args "$@"
}
UpdateDescriptionCache()
{
# OPTIONAL : Update the EftarFile data
if [ -n "${PATH_DESC}" -a -s "${PATH_DESC}" ]
then
${DO} ${JAVA} -classpath "${OPENGROK_JAR}" \
${EFTAR_UPDATE} "${PATH_DESC}" "${EFTAR_OUTPUT_FILE}"
fi
}
OpenGrokUsage()
{
echo "Options for opengrok.jar:" 1>&2
${DO} ${JAVA} ${JAVA_OPTS} -jar "${OPENGROK_JAR}" '-?'
}
DeployWar()
{
applicationServer="`FindApplicationServerType`"
case "${applicationServer}" in
Tomcat) warTarget="`DetermineWarDirectoryTomcat`" ;;
Glassfish) warTarget="`DetermineWarDirectoryGlassfish`" ;;
Resin) warTarget="`DetermineWarDirectoryResin`" ;;
*) FatalError "Unsupported Application Server ${applicationServer}" ;;
esac
if [ -z "${warTarget}" ]
then
FatalError "Unable to determine Deployment Directory for " \
"${applicationServer}"
fi
if [ ! -f "${OPENGROK_DIST_WAR}" ]
then
FatalError "Missing Web Application Archive ${OPENGROK_DIST_WAR}"
fi
if [ ! -d "${warTarget}" ]
then
FatalError "Missing Deployment Directory ${warTarget}"
fi
Progress "Installing ${OPENGROK_DIST_WAR} to ${warTarget} ..."
${DO} cp -p "${OPENGROK_DIST_WAR}" "${warTarget}/"
if [ $? != 0 ]
then
FatalError "Web Application Installation FAILED"
fi
# If user does not use default OPENGROK_INSTANCE_BASE or default
# WEBAPP_CONFIG_ADDRESS, then attempt to extract WEB-INF/web.xml from
# source.war using jar or zip utility, update the hardcoded values and
# then update source.war with the new WEB-INF/web.xml
if [ "${OPENGROK_INSTANCE_BASE}" != '/var/opengrok' ] || [ "${WEBAPP_CONFIG_ADDRESS}" != 'localhost:2424' ]
then
EXTRACT_COMMAND=""
COMPRESS_COMMAND=""
if [ -n "`Which jar`" ]
then
EXTRACT_COMMAND="jar -xf"
COMPRESS_COMMAND="jar -uf"
elif [ -n "`Which zip`" ] && [ -n "`Which unzip`" ]
then
EXTRACT_COMMAND="unzip"
COMPRESS_COMMAND="zip -rf"
fi
if [ -n "${EXTRACT_COMMAND}" ]
then
cd "${warTarget}"
eval "${EXTRACT_COMMAND} ${warTarget}/source.war WEB-INF/web.xml"
if [ "${OPENGROK_INSTANCE_BASE}" != '/var/opengrok' ]
then
sed -e 's:/var/opengrok/etc/configuration.xml:'"$XML_CONFIGURATION"':g' \
"${warTarget}/WEB-INF/web.xml" \
> "${warTarget}/WEB-INF/web.xml.tmp"
mv "${warTarget}/WEB-INF/web.xml.tmp" \
"${warTarget}/WEB-INF/web.xml"
fi
if [ "${WEBAPP_CONFIG_ADDRESS}" != 'localhost:2424' ]
then
sed -e 's/localhost:2424/'"$WEBAPP_CONFIG_ADDRESS"'/g' \
"${warTarget}/WEB-INF/web.xml" \
> "${warTarget}/WEB-INF/web.xml.tmp"
mv "${warTarget}/WEB-INF/web.xml.tmp" \
"${warTarget}/WEB-INF/web.xml"
fi
eval "${COMPRESS_COMMAND} ${warTarget}/source.war WEB-INF/web.xml"
rm -rf "${warTarget}/WEB-INF"
fi
fi