source: main/trunk/greenstone3/build.xml@ 36760

Last change on this file since 36760 was 36760, checked in by davidb, 19 months ago

To run the ant 'install' target to compile everything up without having sourced gs3-devel.sh (i.e., we rely on the newer where interall build.xml does this), then we need to pass on the env.JAVA_HOME property explicitly to exec commands that make use of it
File size: 213.3 KB
Line 
1<?xml version="1.0"?>
2<!-- ======================================================================
3 Greenstone3 build and install script
4
5 kjdon, anu, davidb
6 ====================================================================== -->
7<project name="greenstone3" default="usage" basedir=".">
8 <echo>OS : ${os.name}</echo>
9 <!--
10 <echo>os.arch: ${os.arch}</echo>
11 <echo>os.version: ${os.version}</echo>
12 -->
13
14 <antversion property="ant.version.running"/>
15 <property name="ant.version.minimum" value="1.8.2"/>
16 <fail message="Minimum of Ant v${ant.version.minimum} required to operate Greenstone3 (detected version ${ant.version.running})">
17 <condition>
18 <not><antversion atleast="${ant.version.minimum}"/></not>
19 </condition>
20 </fail>
21
22
23 <!-- ============ classpath =================== -->
24 <path id="project.classpath">
25 <fileset dir="lib/java">
26 <include name="**/*.jar"/>
27 </fileset>
28 </path>
29
30 <!-- ============ self defined tasks =================== -->
31 <taskdef name="mysetproxy" classname="org.greenstone.anttasks.MySetProxy" classpathref="project.classpath"/>
32 <taskdef name="getuserandpassword" classname="org.greenstone.anttasks.MyGetUserAndPassword" classpathref="project.classpath"/>
33 <taskdef name="rsr" classname="org.greenstone.anttasks.RegexSearchReplace" classpathref="project.classpath"/>
34 <!--<taskdef name="svn" classname="org.tigris.subversion.svnant.SvnTask" classpathref="project.classpath"/>-->
35 <taskdef name="if" classname="ise.antelope.tasks.IfTask" classpathref="project.classpath"/>
36 <taskdef name="for" classname="net.sf.antcontrib.logic.ForTask" classpathref="project.classpath"/>
37 <taskdef name="foreach" classname="net.sf.antcontrib.logic.ForEach" classpathref="project.classpath"/>
38 <taskdef name="stringutil" classname="ise.antelope.tasks.StringUtilTask" classpathref="project.classpath"/>
39
40 <!-- ===================== Property Definitions =========================== -->
41
42 <!--
43
44 Each of the following properties are used in the build script.
45 Values for these properties are set by the first place they are
46 defined, from the following list:
47
48 * Definitions on the "ant" command line (ant -Dfoo=bar compile).
49
50 * Definitions from a "build.properties" file in the top level
51 source directory of this application.
52
53 * Definitions from a "build.properties" file in the user's
54 home directory.
55
56 * Default definitions in this build.xml file.
57
58 You will note below that property values can be composed based on the
59 contents of previously defined properties. This is a powerful technique
60 that helps you minimize the number of changes required when your development
61 environment is modified. Note that property composition is allowed within
62 "build.properties" files as well as in the "build.xml" script.
63
64 -->
65
66 <!-- Developer property. Set value=true if you want test https certificates issued
67 (as there's a limit on how many real certificates you can be issued per week).
68 If not testing can either uncomment this property or set value=false.
69 BEWARE: iff test.mode is true (so https.testing gets set to minus-minus-staging)
70 AND the default protocol is https (server.protocols contains https first), the
71 check-tomcat-running target and any other targets running an ant http condition
72 to test the default GS DL URL (which will be over https) won't work.
73 This is because the testing certificate is not trusted by clients, in this case
74 the ant http condition. (Clients that are browsers can be set to temporarily
75 trust the testing certificate, but don't know how to make ant do that, maybe it
76 needs to be done at Java level.)
77 Ant socket conditions to the URL will work because socket tests don't use
78 the protocol, just the host and port.
79 -->
80 <property name="https.test.mode" value="false"/>
81 <property name="sudo.or.not" value="/bin/bash"/><!-- by default, we don't run even special commands with sudo -->
82
83 <property name="os.linux" value="Linux"/>
84 <property name="os.mac" value="Mac OS X"/>
85 <property name="os.solaris" value="SunOS"/>
86 <property name="os.unix" value="${os.linux},${os.mac},${os.solaris}"/>
87 <property name="os.windows" value="Windows 95,Windows 98,Windows 2000,Windows 2003,Windows XP,Windows NT,Windows ME,Windows Vista,Windows 7,Windows Server 2008,Windows Server 2008 R2,Windows 8,Windows 10,Windows 11"/> <!-- check this!!!-->
88
89 <!-- this is true for linux and macs -->
90 <condition property="current.os.isunix">
91 <os family="unix"/>
92 </condition>
93
94 <condition property="current.os.isunixnotmac">
95 <and>
96 <os family="unix"/>
97 <not>
98 <os family="mac"/>
99 </not>
100 </and>
101 </condition>
102
103 <condition property="current.os.ismac">
104 <os family="mac"/>
105 </condition>
106
107 <condition property="current.os.iswindows">
108 <os family="windows"/>
109 </condition>
110
111 <!-- create build.properties if it has not been created yet -->
112 <if>
113 <bool><not><available file="build.properties"/></not></bool>
114 <copy file="build.properties.svn" tofile="build.properties"/>
115 <property name="first.run" value="true"/>
116 </if>
117
118 <!-- create the packages dir if it has not been created yet -->
119 <mkdir dir="packages"/>
120
121 <!--the first three properties have to be put on the top to be used by build.properties-->
122 <property name="gs2build.home" value="${basedir}${file.separator}gs2build"/>
123 <property name="src.packages.home" value="${basedir}/src/packages"/>
124 <property name="flax.svn.root" value="https://svn.greenstone.org/flax"/>
125
126 <property name="solr-ext.home" value="${basedir}/ext/solr"/>
127 <property name="webswing-ext.home" value="${basedir}/ext/webswing"/>
128
129 <property file="build.properties"/>
130 <if>
131 <bool><available file="${user.home}/build.properties"/></bool>
132 <property file="${user.home}/build.properties"/>
133 </if>
134
135 <!-- on windows, we have downloaded wget into bin/windows, but its not on the path, so specify full path when calling it -->
136 <if>
137 <bool><isset property="current.os.iswindows"/></bool>
138 <property name="wget" value="${basedir}/bin/windows/wget.exe"/>
139 <else>
140 <property name="wget" value="wget"/>
141 </else>
142 </if>
143
144 <!-- Check for whether tomcat is to allow symlinks or not. This should always be false
145 for Windows. And ideally also for any other OS with a case insensitive filesystem, but
146 we can only detect Windows and override user assigned true value for Windows to false. -->
147 <condition property="tomcat.allowLinking" value="false" else="${tomcat.user.allowLinking}">
148 <and>
149 <istrue value="${tomcat.user.allowLinking}"/>
150 <isset property="current.os.iswindows"/>
151 </and>
152 </condition>
153 <if>
154 <bool>
155 <and>
156 <isset property="tomcat.user.allowLinking"/>
157 <istrue value="${tomcat.user.allowLinking}"/>
158 </and>
159 </bool>
160 <if><bool><isfalse value="${tomcat.allowLinking}"/></bool>
161 <echo>NOTE:
162 Although the tomcat.user.allowLinking property was set to true,
163 overriding this to use false instead for security reasons,
164 since the Windows OS has a case insensitive filesystem.
165 </echo>
166 <else>
167 <echo>WARNING:
168 tomcat.user.allowLinking property was set to true.
169 The tomcat server will be set to use this.
170 But if you're on an operating system where the filesystem is case INsensitive,
171 then ensure tomcat.user.allowLinking's value is set to false for security reasons.
172 </echo>
173 </else>
174 </if>
175 </if>
176
177 <if>
178 <bool><not><matches string="${server.protocols}" pattern="^\s*(https?|http\s*,\s*https|https\s*,\s*http)\s*$"/></not></bool>
179 <fail>@@@@
180 In file build.properties: invalid value for server.protocols.
181 It must contain http or https, or both (in order of preference) separated by commas.
182 </fail>
183 </if>
184
185 <property name="server.default.servlet" value="${greenstone.default.servlet}"/>
186 <!--
187 * "valid ports range from 1024–49151" is probably about user assignable ports.
188 But 80 is a valid port for running web servers including GS
189 and in future the range may become greater, so don't restrict the port range to 1024-49151.
190 https://stackoverflow.com/questions/113224/what-is-the-largest-tcp-ip-network-port-number-allowable-for-ipv4
191 -->
192 <if>
193 <bool>
194 <not><matches string="${localhost.port.http}" pattern="^\d{2,}\s*$"/></not>
195 </bool>
196 <fail>...
197 ********* ERROR: localhost.port.http in file build.properties is set to an invalid port number.
198 If port 80 is not possible, user assignable ports range from 1024–49151.
199 But don't choose any port already in use by another application.
200 Try setting to localhost.port.http=8383
201 </fail>
202 </if>
203
204 <!-- if server.protocols contains https, ensure its port number is valid -->
205 <if>
206 <bool>
207 <and>
208 <matches string="${server.protocols}" pattern="https"/>
209 <not><matches string="${tomcat.port.https}" pattern="^\d{2,}\s*$"/></not>
210 </and>
211 </bool>
212 <fail>...
213 ********* ERROR: in file build.properties, server.protocols includes https but
214 tomcat.port.https is set to an invalid port number.
215 If port 443 is not possible, user assignable ports range from 1024–49151.
216 But don't choose any port already in use by another application.
217 Try setting tomcat.port.https=8443
218 </fail>
219 </if>
220
221 <!--
222 Bail if https is enabled but the keystore password (keystore.pass property) is not set.
223 However, keystore.pass has no default value and is therefore not set as a rule.
224 So don't bail when 'ant' is run for the first time to create build.props from build.props.svn.
225 But do bail if running ant.prepare and https enabled and password not set.
226 (Maybe put this entire section before the first target: so we only bail after all non-targets
227 are executed so that any other first ever initialisation is completed?)
228 -->
229 <if>
230 <bool>
231 <and>
232 <matches string="${server.protocols}" pattern="https"/>
233 <or>
234 <not><isset property="keystore.pass"/></not>
235 <matches string="${keystore.pass}" pattern="^\s*$"/>
236 </or>
237 </and>
238 </bool>
239 <if>
240 <bool><isset property="first.run"/></bool>
241 <echo>IMPORTANT: In file build.properties, when property server.protocols includes https,
242 as now, the keystore.pass property must be set to a non-empty value.
243 Either set server.protocols to http by itself, if you don't want support for https,
244 or set keystore.pass if you do want https support.</echo>
245 <else>
246 <fail>...
247 ********* ERROR: server.protocols contains https in file build.properties, but the keystore.pass
248 property required for obtaining/renewing the https certificate is not set or is set to the empty
249 string. Choose a password for keystore.pass and set it in build.properties before proceeding.
250 </fail>
251 </else>
252 </if>
253 </if>
254
255 <!-- Set the keystore file name for linux versus windows. Ultimately unused/inactive if HTTPS
256 isn't enabled and no certificate obtained. We don't yet have https certification on mac -->
257 <condition property="keystore.file" value="fullchain_and_prvtkey.pfx" else="fullchain_and_prvtkey.p12">
258 <istrue value="${current.os.iswindows}"/>
259 </condition>
260
261 <!-- Originally, https redirectPort when using regular http port 8383
262 was always fixed at 8443. Now we use redirectPort=tomcat.port.https.
263 -->
264 <property name="https.redirect.port" value="${tomcat.port.https}"/>
265
266 <!-- The default protocol to be used is the FIRST in the comma separated list for server.protocols
267 The default public tomcat port depends on the default server protocol
268 -->
269 <if>
270 <bool><matches string="${server.protocols}" pattern="^https"/></bool>
271 <property name="default.server.protocol" value="https"/>
272 <property name="default.tomcat.port" value="${tomcat.port.https}"/>
273 <else>
274 <property name="default.server.protocol" value="http"/>
275 <property name="default.tomcat.port" value="${localhost.port.http}"/>
276 </else>
277 </if>
278
279
280 <!-- For setting filter tokens.
281 Used to set up server.xml when configuring tomcat -->
282 <property name="comment.start" value="&lt;!--" />
283 <property name="comment.end" value="--&gt;" />
284
285 <!--
286 If https is enabled, regardless of whether it is the default protocol,
287 there's some more work to do:
288 -
289 - if https is not enabled, comment out its Connecter element in server.xml
290 -->
291 <if>
292 <bool><matches string="${server.protocols}" pattern="https"/></bool>
293 <property name="https.comment.out.start" value=""/>
294 <property name="https.comment.out.end" value=""/>
295
296 <else>
297 <property name="https.comment.out.start" value="${comment.start}"/>
298 <property name="https.comment.out.end" value="${comment.end}"/>
299 </else>
300 </if>
301
302 <!-- if server.protocols doesn't contain http, then http is only to be locally available,
303 e.g. for solr servlet on 127.0.0.1
304 In that case, see https://serverfault.com/questions/218666/how-to-configure-tomcat-to-only-listen-to-127-0-0-1
305 -->
306 <condition property="restrict.http.to.local" value="false" else="true">
307 <matches string="${server.protocols}" pattern="http($|\s+|,)"/>
308 </condition>
309
310 <condition property="http.address.restriction" value="address=&quot;127.0.0.1&quot;" else="">
311 <istrue value="${restrict.http.to.local}"/>
312 </condition>
313
314 <!-- No certificates for localhost: https://letsencrypt.org/docs/certificates-for-localhost/
315 But 'localhost' (or actually, 127.0.0.1) needed for solr: solr servlet not accessible to outside world
316 -->
317 <condition property="local.http.url" value="http://${localhost.server.http}" else="http://${localhost.server.http}:${localhost.port.http}">
318 <equals arg1="${localhost.port.http}" arg2="80" trim="true"/>
319 </condition>
320
321 <!-- On linux, if testing https certification, pass in minus-minus-staging. If not testing on linux, nothing extra to pass in.
322 On windows or mac, if testing https certification, nothing extra to pass in. If not testing on windows or mac, pass in minus-minus-live.
323 -->
324 <if><bool><istrue value="${current.os.isunixnotmac}"/></bool>
325 <condition property="https.testing" value="" else="--staging">
326 <isfalse value="${https.test.mode}"/>
327 </condition>
328 </if>
329 <if><bool><or><istrue value="${current.os.iswindows}"/><istrue value="${current.os.ismac}"/></or></bool>
330 <condition property="https.testing" value="--live" else="">
331 <isfalse value="${https.test.mode}"/>
332 </condition>
333 <!-- Set bitness of windows OS, so we can use it for the zeroSSL executable.
334 The Java system property os.arch will return x86 for 32 bit and AMD64 (or x64) for 64 bit OS.
335 See https://stackoverflow.com/questions/20856694/how-to-find-the-os-bit-type -->
336 <condition property="os.bitness" value="64" else="32">
337 <matches string="${os.arch}" pattern="64"/>
338 </condition>
339 </if>
340
341 <condition property="googlesignin.enabled" value="true" else="false">
342 <isset property="tomcat.googlesigninJDBCRealm.clientid"/>
343 </condition>
344
345 <!-- now we've read in properties, apply defaults -->
346 <property name="disable.collection.building" value="false"/>
347 <property name="oai.servlets" value="oaiserver"/> <!-- in case user has old version of build.properties-->
348 <property name="greenstone.default.servlet" value="/library"/>
349
350 <!-- get the filesets defining components and executables -->
351 <import file="resources/xml/components.xml"/>
352 <import file="resources/xml/executables.xml"/>
353
354 <!-- version properties for external packages -->
355 <!-- for Java versions < 1.4, we print out the message that Java is too old.
356 For Java 1.4, we use Tomcat 5.5, for Java5 and higher, we use Tomcat 8.x-->
357 <condition property="tomcat.version" value="apache-tomcat-5.5.25" else="apache-tomcat-8.5.51">
358 <equals arg1="1.4" arg2="${java.specification.version}"/>
359 </condition>
360 <condition property="tomcat.version.major" value="5" else="8">
361 <equals arg1="1.4" arg2="${java.specification.version}"/>
362 </condition>
363 <condition property="privileged.attribute" value="privileged='true'" else="">
364 <equals arg1="8" arg2="${tomcat.version.major}"/>
365 </condition>
366
367 <!-- external access to the GS3 pages or not
368 https://tomcat.apache.org/tomcat-7.0-doc/config/valve.html -->
369 <condition property="allowed.IPs"
370 value=".*"
371 else="(127\.0\.0\.1|::1|0:0:0:0:0:0:0:1)">
372 <matches pattern="^(1|true|yes)$" string="${server.external.access}"/>
373 </condition>
374
375 <property name="axis.zip.version" value="axis-bin-1_4.zip"/>
376 <property name="axis.dir.version" value="axis-1_4"/>
377
378 <!-- these properties used for unzip-windows-packages -->
379 <property name="sqlite.targz.version" value="sqlite-autoconf-3070602.tar.gz"/>
380 <property name="expat.targz.version" value="expat-1.95.8.tar.gz"/>
381 <property name="jdbm.targz.version" value="gs-jdbm-1.0.tar.gz"/>
382
383 <property name="build.home" value="${basedir}/build"/>
384 <property name="src.home" value="${basedir}/src/java"/>
385 <property name="jarsupport.home" value="${basedir}/src/jar-support"/>
386
387 <if><bool><istrue value="${gsdl3home.isreadonly}"/></bool>
388 <property name="readonly-packages.home" value="${basedir}/packages"/>
389 <property name="packages.home" value="${gsdl3.writablehome}/packages"/>
390 <!--
391 To run solr from a read-only location (like a DVD-ROM), its locktype needs to be "single",
392 else solr tries to write out a lock file to the collection's index folder which is read-only.
393
394 https://cwiki.apache.org/confluence/display/solr/IndexConfig+in+SolrConfig
395 says that the "single" locktype is "for special situations of a read-only index directory, or ...."
396
397 See also http://wiki.apache.org/lucene-java/AvailableLockFactories
398 And look for the documentation on "locktype" in solr collection's etc/conf/solrconfig.xml
399 for further information on the different locktypes.
400
401 To set the locktype property from the commandline (it's a property to the server web), pass in
402 "-Dsolr.lock.type=..." to the web server, as explained in
403 http://lucene.472066.n3.nabble.com/Where-can-we-set-the-parameters-in-Solr-Config-td4183706.html
404 -->
405 <property name="readonly.catalina.opts" value="-Dsolr.lock.type=single"/>
406 <else>
407 <property name="packages.home" value="${basedir}/packages"/>
408 <property name="readonly.catalina.opts" value=""/>
409 </else>
410 </if>
411
412 <!-- this may be set in build.properties, e.g. if you move the web dir to
413 tomcats webapps directory -->
414 <property name="web.home" value="${basedir}/web"/>
415 <property name="web.writablehome" value="${gsdl3.writablehome}"/>
416
417 <!-- The following are useful in Java-based config files (.properties,.json,.xml)
418 where the 'Unix style' (really URL style of slash, even in a file://...) is used -->
419 <pathconvert targetos="unix" property="web.home.unix">
420 <path path="${web.home}"/>
421 </pathconvert>
422 <pathconvert targetos="unix" property="web.writablehome.unix">
423 <path path="${web.writablehome}"/>
424 </pathconvert>
425
426 <!-- If using a dispersed GS3 web folder, then the user web would not contain everything in the
427 default GS3 web (it won't contain a CGI or lib folder inside WEB-INF, for instance) -->
428 <if>
429 <bool><available file="${web.home}/WEB-INF/cgi" type="dir"/></bool>
430 <property name="full.web.dir" value="${web.home}"/>
431 <else>
432 <property name="full.web.dir" value="${basedir}/web"/>
433 </else>
434 </if>
435
436 <!-- jar files needed by applets go here -->
437 <property name="web.applet" value="${web.home}/applet"/>
438
439 <!-- jar files needed by the servlet (and extra ones) go here -->
440 <property name="web.lib" value="${web.home}/WEB-INF/lib"/>
441 <property name="web.writablelib" value="${web.writablehome}/WEB-INF/lib"/>
442 <!-- other files needed by the servlet go here -->
443 <property name="web.classes" value="${web.home}/WEB-INF/classes"/>
444 <property name="web.writableclasses" value="${web.writablehome}/WEB-INF/classes"/>
445
446 <if>
447 <bool><istrue value="${gsdl3home.isreadonly}"/></bool>
448 <echo>Greenstone3 home directory is read-only</echo>
449 <echo> => Writable area is: ${gsdl3.writablehome}</echo>
450
451 <condition property="gsdl3.writablehome.already-exists">
452 <available file="${gsdl3.writablehome}" type="dir"/>
453 </condition>
454
455 <if>
456 <bool><not><istrue value="${gsdl3.writablehome.already-exists}"/></not></bool>
457
458 <!-- set up writable area -->
459 <echo>No previous Greenstone home writable area detected</echo>
460 <echo> => Setting up area</echo>
461 <mkdir dir="${gsdl3.writablehome}"/>
462 <mkdir dir="${gsdl3.writablehome}/packages"/>
463 <mkdir dir="${gsdl3.writablehome}/logs"/>
464 <mkdir dir="${gsdl3.writablehome}/ext/solr"/>
465
466 <chmod perm="a+rwx" dir="${gsdl3.writablehome}"/>
467 <chmod perm="a+rwx" dir="${gsdl3.writablehome}/packages"/>
468 <chmod perm="a+rwx" dir="${gsdl3.writablehome}/logs"/>
469 <chmod perm="a+rwx" dir="${gsdl3.writablehome}/ext/solr"/>
470
471 <!-- copy over packages tomcat folder -->
472
473 <if>
474 <bool><istrue value="${current.os.iswindows}"/></bool>
475 <copy todir="${gsdl3.writablehome}/packages/tomcat"
476 preservelastmodified="true"
477 failonerror="true" >
478 <fileset dir="${readonly-packages.home}/tomcat" includes="**"/>
479 </copy>
480
481 <else>
482 <!-- else assume Unix -->
483 <!-- Can't go through the OS-independent <copy> task as it fails to preserve exec permissions -->
484 <echo>Copying to ${gsdl3.writablehome}/packages/tomcat</echo>
485 <exec executable="cp" output="/dev/null" spawn="false">
486 <arg value="-r"/>
487 <arg value="${readonly-packages.home}/tomcat"/>
488 <arg value="${gsdl3.writablehome}/packages/."/>
489 </exec>
490
491 <!-- the packages folder in tmp only has read permissions at this stage, it needs more permissions to work when running GS3 off a disc -->
492 <chmod perm="a+rwx" file="${gsdl3.writablehome}/packages/**" />
493
494 </else>
495 </if>
496
497 <echo> => Copying Greenstone's web/WEB-INF to writable area</echo>
498 <copy todir="${gsdl3.writablehome}/WEB-INF"
499 preservelastmodified="true"
500 failonerror="true" >
501 <fileset dir="${full.web.dir}/WEB-INF" includes="**"/>
502 </copy>
503
504 <copy todir="${gsdl3.writablehome}"
505 preservelastmodified="true"
506 failonerror="true" >
507 <fileset dir="${web.home}" includes="index.html"/>
508 </copy>
509
510 </if>
511 </if>
512
513
514 <!--- flax: the WordNet home -->
515 <property name="wn.home" value="${web.home}/WEB-INF/classes/flax/WordNet"/>
516
517 <!-- jni libraries and java wrappers go here -->
518 <property name="lib.jni" value="${basedir}/lib/jni"/>
519
520 <!-- other jar files needed for installation (but not runtime) go here -->
521 <property name="lib.java" value="${basedir}/lib/java"/>
522
523 <property name="javadocs" value="${basedir}/docs/javadoc"/>
524
525 <property name="app.name" value="greenstone3"/>
526 <property name="app.path" value="/${greenstone.context}"/>
527
528 <property name="admin.dir" value="${basedir}/admin"/>
529
530 <!-- defaults - set these on the command line or in build.properties or
531 they will take these default values-->
532 <property name="app.version" value="trunk"/>
533 <property name="branch.path" value="trunk"/>
534 <property name="branch.revision" value="HEAD"/>
535
536 <!--constants -->
537 <property name="svn.root" value="https://svn.greenstone.org"/>
538 <property name="gsorg.root" value="https://www.greenstone.org"/>
539 <!--<property name="gsorg.root" value="http://community.nzdl.org"/>-->
540
541 <!-- catalina home is set to tomcat basedir if already installed, otherwise
542 use greenstone's tomcat -->
543 <condition property="catalina.home" value="${tomcat.installed.path}" else="${packages.home}/tomcat">
544 <and>
545 <isset property="tomcat.installed.path"/>
546 <not>
547 <equals arg1="" arg2="${tomcat.installed.path}"/>
548 </not>
549 </and>
550 </condition>
551
552
553 <!-- is there a better way to do this?? what about solaris?? -->
554 <condition property="os.bin.dir" value="${cross.os}">
555 <istrue value="${compile.cross}"/>
556 </condition>
557 <condition property="os.bin.dir" value="windows">
558 <os family="windows"/>
559 </condition>
560 <condition property="os.bin.dir" value="darwin">
561 <os family="mac"/>
562 </condition>
563 <condition property="os.bin.dir" value="linux">
564 <and>
565 <os family="unix"/>
566 <not>
567 <os family="mac"/>
568 </not>
569 </and>
570 </condition>
571
572
573 <condition property="collection.building.disabled">
574 <and>
575 <isset property="disable.collection.building"/>
576 <istrue value="${disable.collection.building}"/>
577 </and>
578 </condition>
579
580 <condition property="collection.building.enabled">
581 <not>
582 <istrue value="${disable.collection.building}"/>
583 </not>
584 </condition>
585
586 <condition property="collection.building.enabled.windows">
587 <and>
588 <istrue value="${collection.building.enabled}"/>
589 <isset property="current.os.iswindows"/>
590 </and>
591 </condition>
592
593 <condition property="collection.building.enabled.unix">
594 <and>
595 <istrue value="${collection.building.enabled}"/>
596 <isset property="current.os.isunix"/>
597 </and>
598 </condition>
599
600 <condition property="static.arg" value="LDFLAGS=-static" else=" ">
601 <isset property="compile.static"/>
602 </condition>
603
604 <condition property="opt.cross.build"
605 value="--build=${cross.build}" else=" ">
606 <isset property="cross.build"/>
607 </condition>
608
609
610 <condition property="cross.configure.args"
611 value="--host=${cross.host} ${opt.cross.build} CPP=${cross.host}-cpp CC=${cross.host}-gcc CXX=${cross.host}-g++ LD=${cross.host}-ld AR=${cross.host}-ar RANLIB=${cross.host}-ranlib STRIP=${cross.host}-strip ${cross.configure.extraargs} crossOS=${cross.os}" else=" ">
612 <istrue value="${compile.cross}"/>
613 </condition>
614
615 <!-- if we're told to work with gnome-lib, or if there's a gnome-lib-minimal that the user
616 has placed in gs2build/ext, then compile gs2build after sourcing gnome-lib environment.
617 But don't do anything with gnomelib on windows.
618 -->
619 <condition property="opt.gnomelibext.arg"
620 value="--enable-gnome-lib-ext" else=" ">
621 <and>
622 <istrue value="${current.os.isunix}"/>
623 <or>
624 <available file="${gs2build.home}/ext/gnome-lib-minimal" type="dir"/>
625 <istrue value="${use.gnomelib.ext}"/>
626 <istrue value="${checkout.gnomelib.ext}"/>
627 </or>
628 </and>
629 </condition>
630
631 <condition property="opt.wvware.arg" value=" " else="--disable-wvware ">
632 <istrue value="${with.wvware}"/>
633 </condition>
634
635 <condition property="gs2.opt.args" value="${opt.gnomelibext.arg} ${opt.wvware.arg}" else="${opt.gnomelibext.arg} ${opt.wvware.arg} --disable-mg --disable-mgpp --disable-accentfold --disable-gdbm --disable-sqlite">
636 <istrue value="${with.jni}"/>
637 </condition>
638 <condition property="gs2.compile.target" value="with-jni" else="without-jni">
639 <istrue value="${with.jni}"/>
640 </condition>
641 <condition property="gs2.install.target" value="install-with-jni" else="install-without-jni">
642 <istrue value="${with.jni}"/>
643 </condition>
644 <condition property="gs2.windows.enablejni" value="1" else="0">
645 <istrue value="${with.jni}"/>
646 </condition>
647 <condition property="gs2.windows.enablemg" value="1" else="0">
648 <istrue value="${with.jni}"/>
649 </condition>
650 <condition property="gs2.windows.enablemgpp" value="1" else="0">
651 <istrue value="${with.jni}"/>
652 </condition>
653 <!-- Should accent folding not also be set here ?? -->
654 <condition property="gs2.windows.usegdbm" value="1" else="0">
655 <istrue value="${with.jni}"/>
656 </condition>
657 <condition property="gs2.windows.usesqlite" value="1" else="0">
658 <istrue value="${with.jni}"/>
659 </condition>
660
661 <!-- where is search4j tool -->
662 <condition property="search4j.exec" value="bin/search4j.exe" else="bin/search4j">
663 <isset property="current.os.iswindows"/>
664 </condition>
665
666
667 <!-- ============= Base dirs for each package and component ============ -->
668 <property name="src.gsdl3.home" value="${src.home}/org/greenstone/gsdl3"/>
669 <property name="anttasks.home" value="${src.home}/org/greenstone/anttasks"/>
670 <property name="gli.home" value="${basedir}/gli"/>
671 <property name="javagdbm.home" value="${src.packages.home}/javagdbm"/>
672
673 <condition property="common.src.home" value="${basedir}/common-src" else="${gs2build.home}${file.separator}common-src">
674 <istrue value="${disable.collection.building}"/>
675 </condition>
676 <condition property="common.src.binhome" value="${basedir}" else="${gs2build.home}">
677 <istrue value="${disable.collection.building}"/>
678 </condition>
679
680 <property name="build.src.home" value="${gs2build.home}/build-src"/>
681 <property name="gdbm.home" value="${common.src.home}/packages/gdbm"/>
682 <property name="mg.home" value="${common.src.home}/indexers/mg"/>
683 <property name="mgpp.home" value="${common.src.home}/indexers/mgpp"/>
684 <property name="lucene.home" value="${common.src.home}/indexers/lucene-gs"/>
685
686 <!-- ==================== Compilation Control Options ==================== -->
687
688 <!--
689
690 These properties control option settings on the Javac compiler when it
691 is invoked using the <javac> task.
692
693 compile.debug Should compilation include the debug option?
694
695 compile.deprecation Should compilation include the deprecation option?
696
697 compile.optimize Should compilation include the optimize option?
698
699 -->
700
701 <property name="compile.debug" value="true"/>
702 <property name="compile.deprecation" value="true"/>
703 <property name="compile.optimize" value="true"/>
704 <property name="compile.encoding" value="UTF8"/>
705 <property name="compile.includeantruntime" value="false"/> <!-- to get rid of annoying 'ant' warning -->
706
707 <!--
708
709 Rather than relying on the CLASSPATH environment variable, Ant includes
710 features that makes it easy to dynamically construct the classpath you
711 need for each compilation. The example below constructs the compile
712 classpath to include the servlet.jar file, as well as the other components
713 that Tomcat makes available to web applications automatically, plus anything
714 that you explicitly added.
715
716 -->
717
718 <!-- All elements that Tomcat 5 exposes to applications -->
719 <path id="tomcat5">
720 <pathelement location="${catalina.home}/common/classes"/>
721 <fileset dir="${catalina.home}/common/endorsed">
722 <include name="*.jar"/>
723 </fileset>
724 <fileset dir="${catalina.home}/common/lib">
725 <include name="*.jar"/>
726 </fileset>
727 <!-- seems to be empty, but will leave in just in case some people make use of this to customise their install: -->
728 <pathelement location="${catalina.home}/shared/classes"/>
729 <fileset dir="${catalina.home}/shared/lib">
730 <include name="*.jar"/>
731 </fileset>
732 </path>
733
734 <!-- All elements that Tomcat 7 exposes to applications -->
735 <path id="tomcat8">
736 <fileset dir="${catalina.home}/lib">
737 <include name="*.jar"/>
738 </fileset>
739 </path>
740
741 <path id="compile.classpath">
742 <!-- Include all jar files and libraries in our jni lib directory -->
743 <pathelement location="${lib.jni}"/>
744 <fileset dir="${lib.jni}">
745 <include name="*.jar"/>
746 </fileset>
747 <!-- Include all jar files in our web lib directory -->
748 <pathelement location="${web.lib}"/>
749 <fileset dir="${web.lib}">
750 <include name="*.jar"/>
751 </fileset>
752
753 <pathelement location="${lib.java}"/>
754 <fileset dir="${lib.java}">
755 <include name="*.jar"/>
756 </fileset>
757
758 <!-- include the jar files from the source packages -->
759 <!-- mg and mgpp get installed into lib/jni but they may not be there yet
760 so we add them in by name -->
761 <!-- *** is there any way to make this optional, based on ${with.jni}? -->
762 <pathelement location="${lib.jni}/mg.jar"/>
763 <pathelement location="${lib.jni}/mgpp.jar"/>
764
765 <!-- Include all elements that Tomcat exposes to applications -->
766 <path refid="tomcat${tomcat.version.major}"/>
767
768 </path>
769
770 <path id="derby.server.classpath">
771 <pathelement location="${web.writablelib}/derbynet.jar"/>
772 <pathelement location="${web.writablelib}/derby.jar"/>
773 </path>
774
775
776
777 <target name="test-setup" depends="needs-gs3-setup">
778 <echo>ant.version = ${ant.version}</echo>
779 <echo>java.version = ${java.specification.version} (specification version)</echo>
780 <echo></echo>
781 <echo>is unix : ${current.os.isunix}</echo>
782 <echo>is mac : ${current.os.ismac}</echo>
783 <echo>is unixnotmac : ${current.os.isunixnotmac}</echo>
784 <echo>is windows : ${current.os.iswindows}</echo>
785 <echo>os.unix : ${os.unix}</echo>
786 <echo>env.PATH : ${env.PATH}</echo>
787 <!-- Windows can be case sensitive about env.PATH, preferring env.Path. See https://ant.apache.org/manual/Tasks/property.html -->
788 <echo>env.Path : ${env.Path}</echo>
789 </target>
790
791 <target name="needs-gs3-setup">
792
793 <exec os="${os.unix}" executable="bash" dir="${basedir}" failonerror="true" output="${basedir}/gs3-setupenv.properties">
794 <arg value="-c" />
795 <arg value=". ./gs3-setup.sh >/dev/null 2>gs3-setupenv.errors ; env" />
796 </exec>
797 <exec osfamily="windows" executable="cmd" dir="${basedir}" failonerror="true" output="${basedir}/gs3-setupenv.properties">
798 <arg value="/c" />
799 <arg value=".\gs3-setup.bat >nul 2>gs3-setupenv.errors &amp;&amp; set"/>
800 </exec>
801
802 <!-- Need to escape any backslashes (typically happens on Windows with file/dir paths) so can be parsed in correctly by
803 property file read, otherwise can trigger errors such as Malformed \uXXXX -->
804 <rsr verbosity="1" file="gs3-setupenv.properties" pattern="\\" replacement="\\\\" />
805
806 <!-- acts as a replacement for <property environment="env"/> -->
807 <property file="${basedir}/gs3-setupenv.properties" prefix="env"/>
808
809 <!-- Delete the error output file if it is empty -->
810 <delete>
811 <fileset dir="${basedir}" includes="gs3-setupenv.errors">
812 <size value="0" when="equal"/>
813 </fileset>
814 </delete>
815
816 <!-- has the gs3-setup been sourced successfully -->
817 <condition property="gs3-setup-not-done">
818 <not>
819 <isset property="env.GSDL3HOME"/>
820 </not>
821 </condition>
822
823 <fail if="gs3-setup-not-done" message="Failed to run 'gs3-setup' (Windows) or '. ./gs3-setup.sh' (Unix) before starting the Greenstone server."/>
824 </target>
825
826 <target name="needs-gs3-devel">
827
828 <if>
829 <!-- only need to source gs3-devel if not already done so -->
830 <bool><not><isset property="gs3-devel-done"/></not></bool>
831
832 <exec os="${os.unix}" executable="bash" dir="${basedir}" failonerror="true" output="${basedir}/gs3-develenv.properties">
833 <arg value="-c" />
834 <arg value=". ./gs3-devel.sh >/dev/null 2>gs3-develenv.errors ; env" />
835 </exec>
836 <exec osfamily="windows" executable="cmd" dir="${basedir}" failonerror="true" output="${basedir}/gs3-develenv.properties">
837 <arg value="/c" />
838 <arg value=".\gs3-devel.bat >nul 2>gs3-develenv.errors &amp;&amp; set" />
839 </exec>
840
841 <!-- Need to escape any backslashes (typically happens on Windows with file/dir paths) so can be parsed in correctly by
842 property file read, otherwise can trigger errors such as Malformed \uXXXX -->
843 <rsr verbosity="1" file="gs3-develenv.properties" pattern="\\" replacement="\\\\" />
844
845 <!-- acts as a replacement for <property environment="env"/> -->
846 <property file="${basedir}/gs3-develenv.properties" prefix="env"/>
847
848 <!-- Delete the error output file if it is empty -->
849 <delete>
850 <fileset dir="${basedir}" includes="gs3-develenv.errors">
851 <size value="0" when="equal"/>
852 </fileset>
853 </delete>
854
855 <!-- has the gs3-setup been sourced successfully -->
856 <condition property="gs3-devel-done">
857 <isset property="env.GSDL3HOME"/>
858 </condition>
859
860 <if>
861 <bool><isset property="env.JAVACFLAGS"/></bool>
862 <property name="compile.javac.flags" value="${env.JAVACFLAGS}"/>
863 <else>
864 <property name="compile.javac.flags" value=""/>
865 </else>
866 </if>
867 </if>
868
869 </target>
870
871 <target name="envbased-devel-props" depends="needs-gs3-devel" if="current.os.iswindows">
872 <if>
873 <bool><isset property="env.VisualStudioVersion"/></bool>
874 <property name="visualstudio.majorversion" value="${env.VisualStudioVersion}"/>
875 <else>
876 <!-- possible that earlier versions of VS don't set this, so default to VS13 to trigger iconv-PRE-VS14.zip -->
877 <property name="visualstudio.majorversion" value="13"/>
878 </else>
879 </if>
880 </target>
881
882 <target name="envbased-localtomcat-path" depends="needs-gs3-setup">
883 <if><bool><isset property="env.PATH"/></bool>
884 <path id="local.tomcat.path">
885 <pathelement location="${basedir}/bin/script"/>
886 <pathelement location="${basedir}/bin"/>
887 <pathelement location="${lib.jni}"/>
888 <pathelement path="${env.PATH}"/>
889 <pathelement path="${wn.home}/bin"/>
890 </path>
891 <!-- Windows can be case sensitive about env.PATH, preferring env.Path. See https://ant.apache.org/manual/Tasks/property.html -->
892 <else><if><bool><isset property="env.Path"/></bool>
893 <path id="local.tomcat.path">
894 <pathelement location="${basedir}/bin/script"/>
895 <pathelement location="${basedir}/bin"/>
896 <pathelement location="${lib.jni}"/>
897 <pathelement path="${env.Path}"/>
898 <pathelement path="${wn.home}/bin"/>
899 </path>
900 <!-- else print error about no path set -->
901 <else>
902 <echo>No env.PATH (or env.Path) set. Unable to set local.tomcat.path property</echo>
903 </else></if></else>
904 </if>
905
906 <path id="local.tomcat.classpath">
907 <!-- explicitly include the jni java wrappers in the classpath -->
908 <pathelement location="${lib.jni}"/>
909 <fileset dir="${lib.jni}">
910 <include name="*.jar"/>
911 </fileset>
912
913 <pathelement location="${web.writablelib}"/>
914 <fileset dir="${web.writablelib}">
915 <include name="derbyclient.jar"/> <!--<include name="derby.jar"/>-->
916 </fileset>
917 </path>
918
919 </target>
920
921 <target name="envbased-gnomelib-allargs-prop" depends="needs-gs3-devel">
922
923 <!-- If building a release then we want to adjust environment variables so that the support library can be seen during compilation -->
924 <if>
925 <bool><isset property="use.gnomelib.ext"/></bool>
926 <property name="gnome-lib-dir" value="${basedir}/ext/gnome-lib-minimal/${os.bin.dir}"/>
927
928 <if><bool><isset property="env.CFLAGS"/></bool>
929 <property name="cflags.arg" value="CFLAGS=&quot;-I${gnome-lib-dir}/include -I${gnome-lib-dir}/include/libxml2 ${env.CFLAGS}&quot;"/>
930 <else>
931 <property name="cflags.arg" value="CFLAGS=&quot;-I${gnome-lib-dir}/include -I${gnome-lib-dir}/include/libxml2&quot;"/>
932 </else>
933 </if>
934
935 <if><bool><isset property="env.CPPFLAGS"/></bool>
936 <property name="cppflags.arg" value="CPPFLAGS=&quot;-I${gnome-lib-dir}/include -I${gnome-lib-dir}/include/libxml2 ${env.CPPFLAGS}&quot;"/>
937 <else>
938 <property name="cppflags.arg" value="CPPFLAGS=&quot;-I${gnome-lib-dir}/include -I${gnome-lib-dir}/include/libxml2&quot;"/>
939 </else>
940 </if>
941
942 <if><bool><isset property="env.CXXFLAGS"/></bool>
943 <property name="cxxflags.arg" value="CXXFLAGS=&quot;-I${gnome-lib-dir}/include -I${gnome-lib-dir}/include/libxml2 ${env.CXXFLAGS}&quot;"/>
944 <else>
945 <property name="cxxflags.arg" value="CXXFLAGS=&quot;-I${gnome-lib-dir}/include -I${gnome-lib-dir}/include/libxml2&quot;"/>
946 </else>
947 </if>
948
949 <!--https://groups.google.com/forum/#!topic/openkinect/m-hfXeYwKtU
950 compiling up libwv on ElCapitan needs -framework CoreFoundation -->
951 <if><bool><isset property="env.LDFLAGS"/></bool>
952 <property name="ldflags.arg" value="LDFLAGS=&quot;-L${gnome-lib-dir}/lib ${env.LDFLAGS}&quot;"/>
953 <else>
954 <property name="ldflags.arg" value="LDFLAGS=&quot;-L${gnome-lib-dir}/lib&quot;"/>
955 </else>
956 </if>
957
958 <if><bool><isset property="env.PATH"/></bool>
959 <property name="path.arg" value="PATH=&quot;${gnome-lib-dir}/bin:${env.PATH}&quot;"/>
960 <else>
961 <property name="path.arg" value="PATH=&quot;${gnome-lib-dir}/bin&quot;"/>
962 </else>
963 </if>
964
965 <if><bool><isset property="env.PKG_CONFIG_PATH"/></bool>
966 <property name="pcpath.arg" value="PKG_CONFIG_PATH=&quot;${gnome-lib-dir}/lib/pkgconfig:${env.PKG_CONFIG_PATH}&quot;"/>
967 <else>
968 <property name="pcpath.arg" value="PKG_CONFIG_PATH=&quot;${gnome-lib-dir}/lib/pkgconfig&quot;"/>
969 </else>
970 </if>
971
972 <if><bool><equals arg1="${os.bin.dir}" arg2="darwin"/></bool>
973 <!--<if><bool><isset property="env.DYLD_LIBRARY_PATH"/></bool>
974 <property name="ldlpath.arg" value="DYLD_LIBRARY_PATH=&quot;${gnome-lib-dir}/lib:${env.DYLD_LIBRARY_PATH}&quot;"/>
975 <else>
976 <property name="ldlpath.arg" value="DYLD_LIBRARY_PATH=&quot;${gnome-lib-dir}/lib&quot;"/>
977 </else>
978 </if>
979 -->
980 <property name="ldlpath.arg" value="DYLD_LIBRARY_PATH=&quot;${env.DYLD_LIBRARY_PATH}&quot;"/>
981 <else>
982 <if><bool><isset property="env.LD_LIBRARY_PATH"/></bool>
983 <property name="ldlpath.arg" value="LD_LIBRARY_PATH=&quot;${gnome-lib-dir}/lib:${env.LD_LIBRARY_PATH}&quot;"/>
984 <else>
985 <property name="ldlpath.arg" value="LD_LIBRARY_PATH=&quot;${gnome-lib-dir}/lib&quot;"/>
986 </else>
987 </if>
988 </else>
989 </if>
990
991
992 <else>
993 <if><bool><isset property="env.CFLAGS"/></bool>
994 <property name="cflags.arg" value="CFLAGS=&quot;${env.CFLAGS}&quot;"/>
995 <else>
996 <property name="cflags.arg" value=" "/>
997 </else>
998 </if>
999
1000 <if><bool><isset property="env.CPPFLAGS"/></bool>
1001 <property name="cppflags.arg" value="CPPFLAGS=&quot;${env.CPPFLAGS}&quot;"/>
1002 <else>
1003 <property name="cppflags.arg" value=" "/>
1004 </else>
1005 </if>
1006
1007 <if><bool><isset property="env.CXXFLAGS"/></bool>
1008 <property name="cxxflags.arg" value="CXXFLAGS=&quot;${env.CXXFLAGS}&quot;"/>
1009 <else>
1010 <property name="cxxflags.arg" value=" "/>
1011 </else>
1012 </if>
1013
1014 <if><bool><isset property="env.LDFLAGS"/></bool>
1015 <property name="ldflags.arg" value="LDFLAGS=&quot;${env.LDFLAGS}&quot;"/>
1016 <else>
1017 <property name="ldflags.arg" value=" "/>
1018 </else>
1019 </if>
1020
1021 <if><bool><isset property="env.PATH"/></bool>
1022 <property name="path.arg" value="PATH=&quot;${env.PATH}&quot;"/>
1023 <else>
1024 <property name="path.arg" value=" "/>
1025 </else>
1026 </if>
1027
1028 <if><bool><isset property="env.PKG_CONFIG_PATH"/></bool>
1029 <property name="pcpath.arg" value="PKG_CONFIG_PATH=&quot;${env.PKG_CONFIG_PATH}&quot;"/>
1030 <else>
1031 <property name="pcpath.arg" value=" "/>
1032 </else>
1033 </if>
1034
1035 <if><bool><equals arg1="${os.bin.dir}" arg2="darwin"/></bool>
1036 <if><bool><isset property="env.DYLD_LIBRARY_PATH"/></bool>
1037 <property name="ldlpath.arg" value="DYLD_LIBRARY_PATH=&quot;${env.DYLD_LIBRARY_PATH}&quot;"/>
1038 <else>
1039 <property name="ldlpath.arg" value=" "/>
1040 </else>
1041 </if>
1042 <else>
1043 <if><bool><isset property="env.LD_LIBRARY_PATH"/></bool>
1044 <property name="ldlpath.arg" value="LD_LIBRARY_PATH=&quot;${env.LD_LIBRARY_PATH}&quot;"/>
1045 <else>
1046 <property name="ldlpath.arg" value=" "/>
1047 </else>
1048 </if>
1049 </else>
1050 </if>
1051 </else>
1052 </if>
1053 <property name="allargs" value="${cflags.arg} ${cxxflags.arg} ${cppflags.arg} ${ldflags.arg} ${path.arg} ${ldlpath.arg} ${pcpath.arg}"/>
1054 </target>
1055
1056 <!-- Appends the current env to the file environment.txt. For debugging env vars used by the release-kit. -->
1057 <target name="write-env" description="Writes out the environment that this build.xml is executed in to file environment.txt. For debugging.">
1058 <echo message="*****************ENVIRONMENT OUTPUT:****************${line.separator}" file="environment.txt" append="true" />
1059
1060 <if><bool><istrue value="${current.os.iswindows}"/></bool>
1061 <exec executable="cmd" dir="${basedir}" failonerror="false" output="environment.txt" append="true">
1062 <arg value="/c" />
1063 <arg value="set" />
1064 </exec>
1065 <else>
1066 <exec executable="env" dir="${basedir}" failonerror="false" output="environment.txt" append="true" />
1067 </else>
1068 </if>
1069
1070 <echo message="${line.separator}" file="environment.txt" append="true" />
1071 </target>
1072
1073
1074 <!-- ==================== Primary and Global Targets ============================= -->
1075
1076 <target name="prepare" depends="accept-properties,init,copy-dot-svn-files,prepare-core,prepare-packages,prepare-wget-for-windows,prepare-common-src,prepare-collection-building,prepare-tomcat,prepare-axis,prepare-web,prepare-collections, prepare-flax,prepare-binaries"
1077 description="Use this when you first checkout the code: 'ant prepare install'. This will do some additional subversion checkouts and downloads, so you need to be online to run this.">
1078
1079 <!-- make sure .sh files are executable -->
1080 <chmod dir="${basedir}" perm="ugo+rx"
1081 includes="*.sh"/>
1082 <chmod dir="${basedir}/bin/script" perm="ugo+rx"
1083 includes="*.sh,*.pl"/>
1084 <echo>To compile up and install up Greenstone3, enter:</echo>
1085 <echo> ant install</echo>
1086 </target>
1087
1088 <!-- install-common-src and install-collection-building are mutually exclusive and either one or the other will be done depending on whether collection building is enabled or not -->
1089 <!--before configuring build-src, make sure that gnome-lib is compiled up-->
1090 <target name="install" depends="init,compile-imagemagick,compile-gnome-lib,install-common-src,install-collection-building,install-runtime,install-solr-ext,install-webswing-ext,setup-for-eclipse"
1091 description="Install Greenstone 3. Use this when you first checkout the code: 'ant prepare new-install'.">
1092 <echo>After successful installation, you can turn on https support on Windows and Linux</echo>
1093 <echo>by editing build.properties and running 'ant setup-https-cert'</echo>
1094 <echo>(requires system admin rights)</echo>
1095 </target>
1096
1097 <target name="install-common-src" depends="init"
1098 description="Install (configure, compile, install) only the common-src package (shared code from Greenstone 2). " >
1099 <antcall target="configure-common-src">
1100 <param name="set.ld.path" value="true"/>
1101 </antcall>
1102 <antcall target="compile-common-src">
1103 <param name="set.ld.path" value="true"/>
1104 </antcall>
1105 <antcall target="install-auxiliary-jar-files"/>
1106 <antcall target="install-jni-files"/>
1107 </target>
1108
1109 <target name="install-collection-building" depends="init" if="collection.building.enabled"
1110 description="Install (configure, compile, install) the Greenstone 2 collection building package." >
1111 <antcall target="configure-collection-building"/>
1112 <antcall target="tweak-makefiles" />
1113 <antcall target="compile-collection-building"/>
1114 </target>
1115
1116
1117 <target name="install-runtime" depends="init,configure,configure-packages,configure-core,compile-web,compile-packages,compile-core,compile-classpath-jars"
1118 description="Install (configure, compile, install) the runtime system. Needs either common-src or collection-building to have been installed first." />
1119
1120 <target name="svnupdate" depends="init,svnupdate-packages,svnupdate-core,svnupdate-common-src,svnupdate-collection-building,svnupdate-web"
1121 description="Do a `svn update` for all sources. Doesn't recompile the code. You need to be online to run this."/>
1122
1123 <target name="configure" depends="init,configure-tomcat,configure-web"
1124 description="Configure the installation (not the C++ code). Includes setting up config files. Should be re-run if you change the build.properties file, including if you change the port number."/>
1125
1126 <target name="clean" depends="init,clean-packages,clean-core,clean-common-src,clean-collection-building,clean-classpath-jars"
1127 description="Remove all old compiled code. Includes runtime and collection-building if necessary"/>
1128
1129 <target name="distclean" depends="init,distclean-packages,clean-core,distclean-common-src,distclean-collection-building,clean-classpath-jars"
1130 description="Remove all compiled code and also any Makefiles etc generated during configure-c++. Includes runtime and collection-building as necessary"/>
1131
1132 <target name="update" depends="init,svnupdate,clean,install"
1133 description="Update (thru Subversion) all the source (including common-src or collection-building, and runtime), then clean, and re-install. To do this without any SVN updates, run it like 'ant -Dnosvn.mode=yes update'"/>
1134
1135
1136 <target name="perl-for-building" depends="init">
1137 <!-- uses perl.path if set in build.properties, otherwise try for
1138 environment variable PERLPATH, and failing that assumes 'perl'
1139 is on environment PATH -->
1140 <!-- if, outside build.properties, we only set perl.path if we have gs2build/build-src (collection building), then we won't set perl.path in a (flax) binary, since it doesn't have build-src -->
1141 <if><bool><available file="${gs2build.home}"/></bool>
1142
1143 <if><bool><not><isset property="perl.path"/></not></bool>
1144
1145 <if>
1146 <bool>
1147 <and>
1148 <isset property="env.PERLPATH"/>
1149 <not><equals arg1="${env.PERLPATH}" arg2=""/></not>
1150 </and>
1151 </bool>
1152 <!-- set perlpath to env.PERLPATH.
1153 This is the path to perl\bin that's found by findperl.bat when the server is launched
1154 through GLI instead of the console.
1155 For windows, this env.PERLPATH is the bin folder and needs a backslash at end, since it
1156 will appear suffixed with "perl.exe" in the perl setting in packages\tomcat\config\web.xml.
1157 This web.xml's path to perl is then used to find perl when running the perl scripts in the
1158 cgi folder, so without a slash appended at this point it becomes "binperl" in web.xml, and
1159 things will break when GLI launches the server on Windows and the online GS3 metadata editor
1160 is used to save user-edited metadata. -->
1161 <if><bool><istrue value="${current.os.iswindows}"/></bool>
1162 <property name="perl.path" value="${env.PERLPATH}\"/>
1163 <else>
1164 <property name="perl.path" value="${env.PERLPATH}"/>
1165 </else>
1166 </if>
1167
1168 <else>
1169 <echo>
1170 Using PATH environment variable to locate Perl.
1171 </echo>
1172 <exec executable="which" os="${os.unix}" spawn="false" outputproperty="full.perl.path">
1173 <arg value="perl" />
1174 </exec>
1175
1176 <exec executable="${gs2build.home}/bin/windows/which" osfamily="windows" spawn="false" outputproperty="full.perl.path">
1177 <arg value="perl" />
1178 </exec>
1179
1180 <stringutil string="${full.perl.path}" property="partial.perl.path">
1181 <replace regex="\/[^\/]*$" replacement="/" />
1182 </stringutil>
1183 <stringutil string="${partial.perl.path}" property="perl.path">
1184 <replace regex="\\[^\\]*$" replacement="\\" />
1185 </stringutil>
1186 <if><bool><istrue value="${current.os.isunix}"/></bool>
1187 <if><bool><not><equals arg1="${full.perl.path}" arg2="/usr/bin/perl"/></not></bool>
1188 <echo>
1189 Non-standard location of Perl found: ${full.perl.path}
1190 Set the environment variable PERLPATH or the perl.path property in
1191 build.properties to explicitly control the version of Perl used.
1192 </echo>
1193 </if>
1194 </if>
1195 </else>
1196 </if>
1197 </if>
1198
1199 <!-- full.perl.path is for pretty-printing only, e.g. used in target "start" -->
1200 <if><bool><isset property="perl.path"/></bool>
1201 <property name="full.perl.path" value="${perl.path}${file.separator}perl"/>
1202 <else>
1203 <property name="full.perl.path" value="perl (will use the enviroment variable PATH to find this executable)"/>
1204 </else>
1205 </if>
1206
1207 <!-- gs2build not available, perl.path -->
1208 <else>
1209 <property name="perl.path" value=""/>
1210 </else>
1211 </if>
1212 <stringutil string="${perl.path}" property="escaped.perl.path">
1213 <replace regex="\\" replacement="\\\\" />
1214 </stringutil>
1215 </target>
1216
1217 <target name="get-default-servlet-url">
1218 <echo>${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}${server.default.servlet}</echo>
1219 </target>
1220
1221 <!-- returns the base local URL, something like HTTP://127.0.0.1:<HTTPport>
1222 or some sane equivalent for 127.0.0.1 -->
1223 <target name="get-local-base-http-url">
1224 <echo>${local.http.url}</echo>
1225 </target>
1226 <!-- Returns something like HTTP://127.0.0.1:<HTTPport>/greenstone3/library -->
1227 <target name="get-local-http-servlet-url">
1228 <echo>${local.http.url}${app.path}${server.default.servlet}</echo>
1229 </target>
1230
1231 <!-- solr should only be accessible locally, which therefore also means only over http.
1232 Note that for http, 127.0.0.1 is safer than localhost (as localhost can be mapped to something
1233 other than 127.0.0.1). See also https://letsencrypt.org/docs/certificates-for-localhost/ -->
1234 <target name="get-solr-servlet-url">
1235 <!--<echo>${default.server.protocol}://${tomcat.server}:${default.tomcat.port}/${solr.context}</echo>-->
1236 <echo>${local.http.url}/${solr.context}</echo>
1237 </target>
1238
1239 <target name="check-derbyserver-running">
1240 <condition property="derby.isrunning" value="true" else="false">
1241 <!--<socket server="jdbc:derby://${derby.server}" port="${derby.server.port}"/>-->
1242 <socket server="${derby.server}" port="${derby.server.port}"/><!-- like telnet machine port -->
1243 </condition>
1244 <echo>Derby is running: ${derby.isrunning}</echo>
1245 </target>
1246
1247 <!-- Need a copy of the check-derby-running target with a distinct property, because ant restart runs
1248 both stop and start, which stop and start derby respectively. Both need check the derby socket.
1249 Because each property can be set only once during an invocation with ant, ant restart will need
1250 two check-derbyserver properties, one for each derby check. -->
1251 <target name="check-derbyserver-started">
1252 <condition property="derby.isstarted" value="true" else="false">
1253 <socket server="${derby.server}" port="${derby.server.port}"/>
1254 </condition>
1255 <echo>Derby is running: ${derby.isstarted}</echo>
1256 </target>
1257
1258
1259 <!-- Unused -->
1260 <target name="start-derby-java" depends="check-derbyserver-running">
1261 <if><bool><not><istrue value="${derby.isrunning}"/></not></bool>
1262 <echo>Launching derby on ${derby.server}:${derby.server.port}...</echo>
1263 <java classname="org.apache.derby.drda.NetworkServerControl" fork="true" spawn="true" clonevm="true">
1264 <arg value="start"/>
1265 <classpath refid="derby.server.classpath"/>
1266 </java>
1267 <else>
1268 <echo>Derby server ALREADY RUNNING on ${derby.server}:${derby.server.port}</echo>
1269 </else>
1270 </if>
1271 </target>
1272
1273 <target name="start-derby" depends="check-derbyserver-started">
1274 <if><bool><not><istrue value="${derby.isstarted}"/></not></bool>
1275 <echo>About to launch derby on ${derby.server}:${derby.server.port}</echo>
1276 <antcall target="force-start-derby"/>
1277 <else>
1278 <echo>Derby networked server ALREADY RUNNING on ${derby.server}:${derby.server.port}</echo>
1279 </else>
1280 </if>
1281 </target>
1282
1283 <!-- Using derby 10.1.2.1
1284 See db-derby-10.1.2.1-bin/docs/html/adminguide/index.html -->
1285 <target name="force-start-derby">
1286 <property name="derby.server.classpath.prop" refid="derby.server.classpath" />
1287 <!-- During the installer, launching java directly fails on systems that don't have java installed.
1288 Forcing force-start-derby to always use packages/jre/bin/java is wrong too: as gs3-setup does
1289 a lot of work of determining the correct JRE_HOME/JAVA_HOME (not necessarily the GS3 bundled JRE)
1290 and we want to be consistent in using the same java throughout. Solution:
1291 Refer to the JRE used in executing this ant file, which for installers will always be the bundled one.
1292 https://stackoverflow.com/questions/17571595/env-java-home-not-found-ant -->
1293 <exec executable="${java.home}/bin/java" spawn="true"><!-- failonerror="true"-->
1294 <env key="CLASSPATH" path="${derby.server.classpath.prop}"/>
1295 <arg value="org.apache.derby.drda.NetworkServerControl"/>
1296 <arg value="start"/>
1297 <arg value="-p"/>
1298 <arg value="${derby.server.port}"/>
1299 </exec>
1300
1301 </target>
1302
1303 <target name="force-stop-derby">
1304 <java classname="org.apache.derby.drda.NetworkServerControl">
1305 <arg value="shutdown"/>
1306 <arg value="-p"/>
1307 <arg value="${derby.server.port}"/>
1308 <classpath refid="derby.server.classpath"/>
1309 </java>
1310 </target>
1311
1312 <target name="stop-derby" description="Shutdown derby server only if running" depends="check-derbyserver-running"><!-- if="${derby.isrunning}" checks if true or false only from ant 1.8 on -->
1313 <if><bool><istrue value="${derby.isrunning}"/></bool>
1314 <!--<echo>Derby is |${derby.isrunning}| running</echo>-->
1315 <antcall target="force-stop-derby"/>
1316 <else>
1317 <echo>Derby is not running</echo>
1318 </else>
1319 </if>
1320 </target>
1321
1322 <target name="start" depends="needs-gs3-setup,init,configure-tomcat,configure-web,configure-solr-ext,configure-webswing-ext,start-derby,start-tomcat"
1323 description="Startup the Tomcat server." >
1324 <echo>${app.name} (${app.version}) server running using Apache Tomcat and Java</echo>
1325 <echo>Tomcat: ${catalina.home}</echo>
1326 <echo>Java : ${java.home}</echo>
1327 <if><bool><available file="${build.src.home}"/></bool>
1328 <echo>Perl : ${full.perl.path}</echo>
1329 </if>
1330 <if><bool><isset property="install.flax"/></bool>
1331 <property name="url" value="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/flax"/>
1332 <else>
1333 <property name="url" value="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/"/>
1334 </else>
1335 </if>
1336 <echo>URL : ${url}</echo>
1337 <!-- assuming that index.html is not needed here -->
1338
1339 <!--Now write out the url with /oaiserver suffix as the baseURL property in OAIConfig.xml-->
1340 <antcall target="init-oaiconfigs">
1341 <param name="url" value="${url}"/>
1342 </antcall>
1343
1344 <!--Now write out the url with /gs-cantaloupe suffix as the baseURL property in IIIFConfig.xml-->
1345 <available file="${basedir}/resources/iiif/IIIFConfig.xml.in" property="iiifconfig.present"/>
1346 <antcall target="init-iiifconfig">
1347 <param name="url" value="${url}"/>
1348 </antcall>
1349
1350 </target>
1351
1352 <target name="status" depends="check-derbyserver-running,verbose-check-tomcat-running">
1353 </target>
1354
1355 <available file="${basedir}/resources/oai/OAIConfig.xml.in" property="oaiconfig.present"/>
1356
1357 <target name="init-oaiconfigs" if="oaiconfig.present">
1358 <echo>Generating new oaiconfigs for servlets ${oai.servlets} </echo>
1359 <foreach list="${oai.servlets}" delimiter="," target="init-oaiconfig" param="servlet_name"/>
1360 </target>
1361
1362 <target name="init-oaiconfig">
1363 <if><bool><not><available file="${basedir}/resources/oai/OAIConfig-${servlet_name}.xml.in"/></not></bool>
1364 <echo>Copying file ${basedir}/resources/oai/OAIConfig.xml.in to ${basedir}/resources/oai/OAIConfig-${servlet_name}.xml.in</echo>
1365 <echo>This file (OAIConfig-${servlet_name}.xml.in) will not be regenerated again, so you may edit it to customise settings for this servlet. To have it regenerated, delete the file.</echo>
1366 <copy file="${basedir}/resources/oai/OAIConfig.xml.in" tofile="${basedir}/resources/oai/OAIConfig-${servlet_name}.xml.in"/>
1367 </if>
1368 <echo>Copying ${basedir}/resources/oai/OAIConfig-${servlet_name}.xml.in to ${web.writableclasses}/OAIConfig-${servlet_name}.xml and setting baseURL to ${url}${servlet_name}</echo>
1369 <copy file="${basedir}/resources/oai/OAIConfig-${servlet_name}.xml.in" tofile="${web.writableclasses}/OAIConfig-${servlet_name}.xml"/>
1370 <rsr verbosity="1" file="${web.writableclasses}/OAIConfig-${servlet_name}.xml" pattern="&lt;baseURL&gt;.*&lt;/baseURL&gt;" replacement="&lt;baseURL&gt;${url}${servlet_name}&lt;/baseURL&gt;" />
1371 </target>
1372
1373 <target name="init-iiifconfig" if="iiifconfig.present">
1374 <echo>Writing out baseURL ${url}gs-cantaloupe to ${web.writableclasses}/IIIFConfig.xml</echo>
1375 <copy file="${basedir}/resources/iiif/IIIFConfig.xml.in" tofile="${web.writableclasses}/IIIFConfig.xml"/>
1376 <rsr verbosity="1" file="${web.writableclasses}/IIIFConfig.xml" pattern="&lt;baseURL&gt;.*&lt;/baseURL&gt;" replacement="&lt;baseURL&gt;${url}gs-cantaloupe&lt;/baseURL&gt;" />
1377 </target>
1378
1379 <target name="stop" depends="init,stop-tomcat,stop-derby"
1380 description="Shutdown the Tomcat server."/>
1381
1382 <target name="restart" description="Shutdown and restart Tomcat" depends="init,stop,start"/>
1383
1384 <!-- =========== Help targets =================================== -->
1385
1386 <property name="install-command" value="ant [options] prepare install"/>
1387
1388 <target name="usage" description="Print a help message">
1389 <echo message=" Execute 'ant -projecthelp' for a list of targets."/>
1390 <echo message=" Execute 'ant -help' for Ant help."/>
1391 <echo>
1392 To install Greenstone3, run '${install-command}'.
1393 There are properties defined in build.properties. The install
1394 process will ask you if these properties are set correctly.
1395 To avoid this prompt, use the '-Dproperties.accepted=yes'
1396 option.
1397 To log the output, use the '-logfile build.log' option.
1398 The README.txt file has more information about the ant targets
1399 and install process.
1400 </echo>
1401 </target>
1402
1403 <target name="help" depends="usage" description="Print a help message"/>
1404
1405 <target name="debug" depends="init" description="Display all the currently used properties">
1406 <echoproperties/>
1407 </target>
1408
1409 <!-- ====== initialization and setup targets ================== -->
1410
1411 <target name="accept-properties" unless="properties.accepted">
1412 <input addproperty="properties.ok" validargs="y,n">The following properties (among others) are being used from a build.properties file found in this directory:
1413 server.protocols=${server.protocols}
1414 tomcat.server=${tomcat.server}
1415 tomcat.port.https=${tomcat.port.https}
1416 localhost.port.http=${localhost.port.http}
1417
1418 default.server.protocol=${default.server.protocol}
1419 default.tomcat.port=${default.tomcat.port}
1420 Local base HTTP URL used by Greenstone: ${local.http.url}
1421
1422 tomcat.installed.path=${tomcat.installed.path} (this is the location of Tomcat's base dir if it is already installed)
1423 proxy.host=${proxy.host}
1424 proxy.port=${proxy.port}
1425 disable.collection.building=${disable.collection.building}
1426 If these are not acceptable, please change them and rerun this target. Continue [y/n]?
1427 </input>
1428 <condition property="do.abort">
1429 <equals arg1="n" arg2="${properties.ok}"/>
1430 </condition>
1431 <fail if="do.abort">Build aborted by user. Please change your properties settings and re-run the target</fail>
1432 </target>
1433
1434 <!-- this sets up some initial properties -->
1435 <target name="init">
1436
1437 <condition property="java.too.old">
1438 <or>
1439 <equals arg1="1.1" arg2="${java.specification.version}"/>
1440 <equals arg1="1.2" arg2="${java.specification.version}"/>
1441 <equals arg1="1.3" arg2="${java.specification.version}"/>
1442 <equals arg1="1.4" arg2="${java.specification.version}"/>
1443 <equals arg1="1.5" arg2="${java.specification.version}"/>
1444 <equals arg1="1.6" arg2="${java.specification.version}"/>
1445 <equals arg1="1.7" arg2="${java.specification.version}"/>
1446 </or>
1447 </condition>
1448 <fail if="java.too.old" message="You need Java 1.8 or greater to run Greenstone 3"/>
1449
1450 <available file="${basedir}/gli" property="gli.present"/>
1451 <available file="${basedir}/common-src" property="common.src.present"/>
1452 <available file="${basedir}/gs2build" property="gs2build.present"/>
1453 <available file="${gnome-lib-dir}" property="gnome-lib.present"/>
1454
1455 <condition property="tomcat.islocal">
1456 <or>
1457 <not><isset property="tomcat.installed.path"/></not>
1458 <equals arg1="" arg2="${tomcat.installed.path}"/>
1459 </or>
1460 </condition>
1461
1462 <condition property="proxy.present">
1463 <and>
1464 <isset property="proxy.host"/>
1465 <not><equals arg1="" arg2="${proxy.host}"/></not>
1466 </and>
1467 </condition>
1468
1469 <!--
1470 the next block checks if the bundled tomcat is present in the 'packages' directory,
1471 and checks for the lethal combination of tomcat 8 and java 1.4. Test for
1472 tomcat6 is based on the presence of a file inserted by greenstone into the tomcat6
1473 download, as there is no other surefire way to check tomcat version under java 1.4
1474 -->
1475 <condition property="packages.tomcat.ispresent" value="true" else="false">
1476 <available file="packages/tomcat"/>
1477 </condition>
1478 <condition property="packages.tomcat.istomcat8" value="true" else="false">
1479 <available file="packages/tomcat/tomcat8.txt"/>
1480 </condition>
1481 <if>
1482 <bool>
1483 <and>
1484 <istrue value="${packages.tomcat.ispresent}"/>
1485 <istrue value="${packages.tomcat.istomcat8}"/>
1486 <equals arg1="1.4" arg2="${java.specification.version}"/>
1487 </and>
1488 </bool>
1489 <fail>Your Java (version 1.4) is too old to work with the bundled Apache Tomcat (version 6). Please upgrade to Java version 1.5 or greater. Alternatively, you may remove the bundled Apache Tomcat from the 'packages' folder and then run 'ant prepare-tomcat'.</fail>
1490 </if>
1491
1492 </target>
1493
1494 <target name="setup-proxy" depends="init" if="proxy.present">
1495 <condition property="ask.user">
1496 <or>
1497 <equals arg1="" arg2="${proxy.user}"/>
1498 <equals arg1="" arg2="${proxy.password}"/>
1499 </or>
1500 </condition>
1501
1502 <getuserandpassword message="Using proxy: ${proxy.host}:${proxy.port}" if="ask.user" username="${proxy.user}" userproperty="proxy.username" pwordproperty="proxy.password"/>
1503 <mysetproxy proxyhost="${proxy.host}" proxyport="${proxy.port}" proxyuser="${proxy.username}" proxypassword="${proxy.password}"/>
1504 </target>
1505
1506 <target name="copy-dot-svn-files" depends="init"
1507 description="Copies all resources .svn files to .in versions - which are used during configure to generate the runtime versions." >
1508 <if>
1509 <bool><available file="${basedir}/resources/tomcat/greenstone3.xml.in"/></bool>
1510 <copy file="${basedir}/resources/tomcat/greenstone3.xml.in" tofile="${basedir}/resources/tomcat/greenstone3.xml.in.backup" overwrite="true"/>
1511 </if>
1512 <copy file="${basedir}/resources/tomcat/greenstone3.xml.svn" tofile="${basedir}/resources/tomcat/greenstone3.xml.in" overwrite="true"/>
1513
1514 <if>
1515 <bool><available file="${basedir}/resources/tomcat/server_tomcat5.xml.in"/></bool>
1516 <copy file="${basedir}/resources/tomcat/server_tomcat5.xml.in" tofile="${basedir}/resources/tomcat/server_tomcat5.xml.in.backup" overwrite="true"/>
1517 </if>
1518 <copy file="${basedir}/resources/tomcat/server_tomcat5.xml.svn" tofile="${basedir}/resources/tomcat/server_tomcat5.xml.in" overwrite="true"/>
1519
1520 <if>
1521 <bool><available file="${basedir}/resources/tomcat/server_tomcat7.xml.in"/></bool>
1522 <copy file="${basedir}/resources/tomcat/server_tomcat7.xml.in" tofile="${basedir}/resources/tomcat/server_tomcat7.xml.in.backup" overwrite="true"/>
1523 </if>
1524 <copy file="${basedir}/resources/tomcat/server_tomcat8.xml.svn" tofile="${basedir}/resources/tomcat/server_tomcat8.xml.in" overwrite="true"/>
1525
1526 <if>
1527 <bool><available file="${basedir}/resources/tomcat/server_tomcat8.xml.in"/></bool>
1528 <copy file="${basedir}/resources/tomcat/server_tomcat8.xml.in" tofile="${basedir}/resources/tomcat/server_tomcat8.xml.in.backup" overwrite="true"/>
1529 </if>
1530 <copy file="${basedir}/resources/tomcat/server_tomcat8.xml.svn" tofile="${basedir}/resources/tomcat/server_tomcat8.xml.in" overwrite="true"/>
1531
1532 <if>
1533 <bool><available file="${basedir}/resources/tomcat/web8.xml.in"/></bool>
1534 <copy file="${basedir}/resources/tomcat/web8.xml.in" tofile="${basedir}/resources/tomcat/web8.xml.in.backup" overwrite="true"/>
1535 </if>
1536 <copy file="${basedir}/resources/tomcat/web8.xml.svn" tofile="${basedir}/resources/tomcat/web8.xml.in" overwrite="true"/>
1537
1538 <if>
1539 <bool><available file="${basedir}/resources/oai/OAIConfig.xml.in"/></bool>
1540 <copy file="${basedir}/resources/oai/OAIConfig.xml.in" tofile="${basedir}/resources/oai/OAIConfig.xml.in.backup" overwrite="true"/>
1541 </if>
1542 <copy file="${basedir}/resources/oai/OAIConfig.xml.svn" tofile="${basedir}/resources/oai/OAIConfig.xml.in" overwrite="true"/>
1543
1544 <if>
1545 <bool><available file="${basedir}/resources/iiif/IIIFConfig.xml.in"/></bool>
1546 <copy file="${basedir}/resources/iiif/IIIFConfig.xml.in" tofile="${basedir}/resources/iiif/IIIFConfig.xml.in.backup" overwrite="true"/>
1547 </if>
1548 <copy file="${basedir}/resources/iiif/IIIFConfig.xml.svn" tofile="${basedir}/resources/iiif/IIIFConfig.xml.in" overwrite="true"/>
1549
1550 <if>
1551 <bool><available file="${basedir}/resources/iiif/cantaloupe.properties.in"/></bool>
1552 <copy file="${basedir}/resources/iiif/cantaloupe.properties.in" tofile="${basedir}/resources/iiif/cantaloupe.properties.in.backup" overwrite="true"/>
1553 </if>
1554 <copy file="${basedir}/resources/iiif/cantaloupe.properties.svn" tofile="${basedir}/resources/iiif/cantaloupe.properties.in" overwrite="true"/>
1555
1556 <if>
1557 <bool><available file="${basedir}/resources/cgi/gsdl3site.cfg.in"/></bool>
1558 <copy file="${basedir}/resources/cgi/gsdl3site.cfg.in" tofile="${basedir}/resources/cgi/gsdl3site.cfg.in.backup" overwrite="true"/>
1559 </if>
1560 <copy file="${basedir}/resources/cgi/gsdl3site.cfg.svn" tofile="${basedir}/resources/cgi/gsdl3site.cfg.in" overwrite="true"/>
1561
1562 <if>
1563 <bool><available file="${basedir}/resources/web/global.properties.in"/></bool>
1564 <copy file="${basedir}/resources/web/global.properties.in" tofile="${basedir}/resources/web/global.properties.in.backup" overwrite="true"/>
1565 </if>
1566 <copy file="${basedir}/resources/web/global.properties.svn" tofile="${basedir}/resources/web/global.properties.in" overwrite="true"/>
1567
1568 <if>
1569 <bool><available file="${basedir}/resources/web/log4j.properties.in"/></bool>
1570 <copy file="${basedir}/resources/web/log4j.properties.in" tofile="${basedir}/resources/web/log4j.properties.in.backup" overwrite="true"/>
1571 </if>
1572 <copy file="${basedir}/resources/web/log4j.properties.svn" tofile="${basedir}/resources/web/log4j.properties.in" overwrite="true"/>
1573
1574</target>
1575
1576 <!-- ========== Web app Targets ================================ -->
1577
1578 <target name="prepare-web" depends="init">
1579 <mkdir dir="${web.writablehome}/applet"/>
1580 <mkdir dir="${web.writablehome}/logs"/>
1581 <mkdir dir="${web.writablehome}/logs/tmp"/>
1582 </target>
1583
1584 <!-- if we are using java 1.5+, we need the xalan.jar file in web/WEB-INF/lib, but if we are using java 1.4, we can't have it there.
1585 The test for whether we need it assumes we won't be trying to compile GS3 against Java versions less than 1.4. -->
1586 <target name="configure-java-version" depends="init"
1587 description="Activates or deactivates some jar libraries as needed depending on your java version">
1588
1589 <available property="have.xalan.jar" file="${web.lib}/xalan.jar"/>
1590 <condition property="need.xalan.jar">
1591 <or>
1592 <not><equals arg1="1.4" arg2="${java.specification.version}"/></not>
1593 </or>
1594 </condition>
1595
1596 <!-- if they have xalan.jar but dont need it -->
1597 <if>
1598 <bool>
1599 <and>
1600 <isset property="have.xalan.jar"/>
1601 <not><isset property="need.xalan.jar"/></not>
1602 </and>
1603 </bool>
1604 <antcall target="deactivate-xalan-jar"/>
1605 </if>
1606
1607 <!-- if they need xalan.jar but dont have it -->
1608 <if>
1609 <bool>
1610 <and>
1611 <not><isset property="have.xalan.jar"/></not>
1612 <isset property="need.xalan.jar"/>
1613 </and>
1614 </bool>
1615 <antcall target="activate-xalan-jar"/>
1616 </if>
1617
1618 </target>
1619
1620 <target name="activate-xalan-jar">
1621 <echo>activating xalan.jar</echo>
1622 <copy file="${web.lib}/xalan.jar.tmp" tofile="${web.lib}/xalan.jar"/>
1623 <if>
1624 <bool>
1625 <and>
1626 <isset property="current.os.ismac"/>
1627 <available file="${catalina.home}/common/endorsed" type="dir"/>
1628 </and>
1629 </bool>
1630 <copy file="${web.lib}/xalan.jar.tmp" tofile="${catalina.home}/common/endorsed/xalan.jar"/>
1631 </if>
1632 </target>
1633
1634 <target name="deactivate-xalan-jar">
1635 <echo>deactivating xalan.jar</echo>
1636 <delete file="${web.lib}/xalan.jar"/>
1637 <!-- should we be deleting common/endorsed/xalan.jar on mac?? -->
1638 </target>
1639
1640
1641 <target name="prepare-collections" depends="init"
1642 description="Unpack all the collections from their svn zipped versions">
1643 <property name="collect.dir" value="${web.home}/sites/localsite/collect"/>
1644 <property name="index-and-archives.zip" value="index-and-archives.zip"/>
1645
1646 <echo message="Installing collections ..."/>
1647 <!-- collections requiring jni -->
1648 <echo message="checkpt NEXT"/>
1649 <if>
1650 <bool>
1651 <istrue value="${with.jni}"/>
1652 </bool>
1653 <antcall target="gs2mgdemo-install"/>
1654 </if>
1655 <echo message="checkpt 1"/>
1656 <if>
1657 <bool>
1658 <istrue value="${with.jni}"/>
1659 </bool>
1660 <antcall target="gs2mgppdemo-install"/>
1661 </if>
1662 <!-- pure java ones -->
1663 <echo message="checkpt 1"/>
1664 <antcall target="gberg-install"/>
1665 <echo message="checkpt 1"/>
1666 <antcall target="lucene-jdbm-demo-install"/>
1667 </target>
1668
1669 <target name="gs2mgdemo-prepare" if="collect.dir">
1670 <property name="gs2mgdemo.dir" value="${collect.dir}/gs2mgdemo"/>
1671
1672 <condition property="gs2mgdemo.present">
1673 <and>
1674 <available file="${gs2mgdemo.dir}/${index-and-archives.zip}"/>
1675 </and>
1676 </condition>
1677 </target>
1678
1679 <target name="gs2mgdemo-install" if="gs2mgdemo.present" depends="gs2mgdemo-prepare">
1680 <unzip dest="${gs2mgdemo.dir}" src="${gs2mgdemo.dir}/${index-and-archives.zip}" />
1681 <echo>collection gs2mgdemo installed</echo>
1682 </target>
1683
1684 <target name="gs2mgppdemo-prepare" if="collect.dir">
1685 <property name="gs2mgppdemo.dir" value="${collect.dir}/gs2mgppdemo"/>
1686
1687 <condition property="gs2mgppdemo.present">
1688 <and>
1689 <available file="${gs2mgppdemo.dir}/${index-and-archives.zip}"/>
1690 </and>
1691 </condition>
1692 </target>
1693
1694 <target name="gs2mgppdemo-install" if="gs2mgppdemo.present" depends="gs2mgppdemo-prepare">
1695 <unzip dest="${gs2mgppdemo.dir}" src="${gs2mgppdemo.dir}/${index-and-archives.zip}" />
1696 <echo>collection gs2mgppdemo installed</echo>
1697 </target>
1698
1699 <target name="gberg-prepare" if="collect.dir">
1700 <property name="gberg.dir" value="${collect.dir}/gberg"/>
1701 <available file="${gberg.dir}/index/index.zip" property="gberg.present"/>
1702 </target>
1703
1704 <target name="gberg-install" if="gberg.present" depends="gberg-prepare">
1705 <unzip dest="${gberg.dir}/index" src="${gberg.dir}/index/index.zip"/>
1706 <echo>collection gberg installed</echo>
1707 </target>
1708
1709 <target name="lucene-jdbm-demo-prepare" if="collect.dir">
1710 <property name="lucene-jdbm-demo.dir" value="${collect.dir}/lucene-jdbm-demo"/>
1711 <available file="${lucene-jdbm-demo.dir}/${index-and-archives.zip}" property="lucene-jdbm-demo.present"/>
1712 </target>
1713
1714 <target name="lucene-jdbm-demo-install" if="lucene-jdbm-demo.present" depends="lucene-jdbm-demo-prepare">
1715 <unzip dest="${lucene-jdbm-demo.dir}" src="${lucene-jdbm-demo.dir}/${index-and-archives.zip}"/>
1716 <echo>collection lucene-jdbm-demo installed</echo>
1717 </target>
1718
1719
1720 <target name="install-solr-ext" depends="init" >
1721 <exec executable="ant.bat" osfamily="windows" dir="${solr-ext.home}" spawn="false" failonerror="true">
1722 <arg value="add-service"/>
1723 </exec>
1724 <exec executable="ant" os="${os.unix}" dir="${solr-ext.home}" spawn="false" failonerror="true">
1725 <arg value="add-service"/>
1726 </exec>
1727 <antcall target="solr-jdbm-demo-install"/>
1728 </target>
1729
1730 <target name="solr-jdbm-demo-prepare" if="collect.dir">
1731 <property name="solr-jdbm-demo.dir" value="${collect.dir}/solr-jdbm-demo"/>
1732 <available file="${solr-jdbm-demo.dir}/${index.zip}" property="solr-jdbm-demo.present"/>
1733 </target>
1734
1735 <target name="solr-jdbm-demo-install" if="solr-jdbm-demo.present" depends="solr-jdbm-demo-prepare">
1736 <unzip dest="${solr-jdbm-demo.dir}" src="${solr-jdbm-demo.dir}/${index.zip}"/>
1737 <echo>collection solr-jdbm-demo installed</echo>
1738 </target>
1739
1740 <target name="install-webswing-ext" depends="init" >
1741 <exec executable="ant.bat" osfamily="windows" dir="${webswing-ext.home}" spawn="false" failonerror="true">
1742 <arg value="-Dweb.home=${web.home}"/>
1743 <arg value="-Dweb.writablehome=${web.writablehome}"/>
1744 <arg value="add-extension"/>
1745 </exec>
1746 <exec executable="ant" os="${os.unix}" dir="${webswing-ext.home}" spawn="false" failonerror="true">
1747 <arg value="-Dweb.home=${web.home}"/>
1748 <arg value="-Dweb.writablehome=${web.writablehome}"/>
1749 <arg value="add-extension"/>
1750 </exec>
1751 </target>
1752
1753 <!-- Until 64 bit Linux and Mac (Lion) machines can generate a working IsisGdl,
1754 use the ones generated on a 32 bit Linux and Mac (Leopard), respectively
1755 -->
1756 <target name="get-isisgdl" if="${current.os.isunix}">
1757 <exec executable="uname" dir="${basedir}" failonerror="false"
1758 outputproperty="uname.val">
1759 <arg value="-m"/>
1760 </exec>
1761
1762 <if>
1763 <!-- as the syntax below copies the IsidGdl binary into the gs2build directory
1764 only want to run the commend if collection.building.enabled -->
1765 <bool>
1766 <and>
1767 <istrue value="${collection.building.enabled}" />
1768 <equals arg1="${uname.val}" arg2="x86_64"/>
1769 </and>
1770 </bool>
1771 <echo>Bitness: ${uname.val}</echo>
1772 <if><bool><contains string="${os.bin.dir}" substring="darwin" casesensitive="false"/></bool>
1773 <exec executable="uname" dir="${basedir}" failonerror="false"
1774 outputproperty="darwin.kernel.version">
1775 <arg value="-r"/>
1776 </exec>
1777
1778 <echo>darwin kernel version: ${darwin.kernel.version}</echo>
1779 <!-- up to high sierra/kernel (version 17.x) us IsisGdl.macleopard
1780 From Mojave onwards, we can use the Mojave generated IsisGdl.mac64mojave -->
1781 <if>
1782 <bool><matches string="${darwin.kernel.version}" pattern="^([0-9]|1[0-7])\."/></bool>
1783 <property name="mac.isisgdl.suffix" value="macleopard"/>
1784 <else>
1785 <property name="mac.isisgdl.suffix" value="mac64mojave"/>
1786 </else>
1787 </if>
1788
1789
1790 <!--<get src="${gsorg.root}/caveat-emptor/IsisGdl.macleopard"
1791 dest="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl"/>-->
1792 <exec executable="wget" failonerror="true">
1793 <arg value="-P"/>
1794 <arg value="${basedir}/gs2build/bin/${os.bin.dir}"/>
1795 <arg value="--no-check-certificate"/>
1796 <arg value="${gsorg.root}/caveat-emptor/IsisGdl.${mac.isisgdl.suffix}"/>
1797 </exec>
1798 <move file="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl.${mac.isisgdl.suffix}"
1799 tofile="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl"/>
1800 </if>
1801 <if><bool><contains string="${os.bin.dir}" substring="linux" casesensitive="false"/></bool>
1802 <!--<get src="${gsorg.root}/caveat-emptor/IsisGdl.bin32"
1803 dest="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl"/>-->
1804 <exec executable="wget" failonerror="true">
1805 <arg value="-P"/>
1806 <arg value="${basedir}/gs2build/bin/${os.bin.dir}"/>
1807 <arg value="--no-check-certificate"/>
1808 <arg value="${gsorg.root}/caveat-emptor/IsisGdl.bin32"/>
1809 </exec>
1810 <move file="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl.bin32"
1811 tofile="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl"/>
1812 </if>
1813 <chmod file="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl" perm="755"/>
1814 </if>
1815 </target>
1816
1817 <target name="set-perl-shebangs" depends="perl-for-building">
1818 <if>
1819 <bool>
1820 <and><isset property="perl.path"/>
1821 <not><equals arg1="${perl.path}" arg2=""/></not>
1822 </and>
1823 </bool>
1824
1825 <if><bool><istrue value="${current.os.iswindows}"/></bool>
1826 <property name="perl.exec" value="${perl.path}perl.exe"/>
1827 <else>
1828 <property name="perl.exec" value="${perl.path}perl"/>
1829 </else>
1830 </if>
1831
1832 <!--<echo>**** PERLPATH: ${perl.path}</echo>-->
1833 <echo>Setting perl shebangs to Perl Exec: ${perl.exec}</echo>
1834
1835 <!-- set the shebangs in the cgi files to point to the correct perlpath -->
1836 <if>
1837 <bool><not><equals arg1="${web.home}" arg2="${web.writablehome}"></equals></not></bool>
1838 <mkdir dir="${web.writablehome}"/>
1839 <copy file="${full.web.dir}/WEB-INF/cgi/gliserver.pl" tofile="${web.writablehome}/WEB-INF/cgi/gliserver.pl" overwrite="true"/>
1840 <copy file="${full.web.dir}/WEB-INF/cgi/metadata-server.pl" tofile="${web.writablehome}/WEB-INF/cgi/metadata-server.pl" overwrite="true"/>
1841 <copy file="${full.web.dir}/WEB-INF/cgi/checksum.pl" tofile="${web.writablehome}/WEB-INF/cgi/checksum.pl" overwrite="true"/>
1842 </if>
1843
1844 <rsr verbosity="1" file="${web.writablehome}/WEB-INF/cgi/gliserver.pl" pattern="^#!.*" replacement="#!${perl.exec} -w" lines="1"/>
1845 <rsr verbosity="1" file="${web.writablehome}/WEB-INF/cgi/metadata-server.pl" pattern="^#!.*" replacement="#!${perl.exec} -w" lines="1"/>
1846 <rsr verbosity="1" file="${web.writablehome}/WEB-INF/cgi/checksum.pl" pattern="^#!.*" replacement="#!${perl.exec} -w" lines="1"/>
1847 <else>
1848 <echo>WARNING: perl.path is empty. Unable to set the shebangs in the perl files in ${web.writablehome}/WEB-INF/cgi</echo>
1849 </else>
1850 </if>
1851 </target>
1852
1853 <target name="configure-web" depends="init,perl-for-building"
1854 description="Configure only the web app config files">
1855 <!-- we want a unix path in the global.properties file -->
1856 <pathconvert targetos="unix" property="src.gsdl3.home.unix">
1857 <path path="${web.home}"/>
1858 </pathconvert>
1859 <pathconvert targetos="unix" property="src.gsdl3.writablehome.unix">
1860 <path path="${web.writablehome}"/>
1861 </pathconvert>
1862
1863 <antcall target="set-perl-shebangs" inheritAll="true" />
1864
1865 <filter token="gsdlhome" value="${gs2build.home}"/>
1866 <filter token="gsdlhomequoted" value="&quot;${gs2build.home}&quot;"/>
1867 <filter token="gsdl3srchome" value="${basedir}"/>
1868 <filter token="gsdl3srchomequoted" value="&quot;${basedir}&quot;"/>
1869 <filter token="gsdl3home" value="${src.gsdl3.home.unix}"/>
1870 <filter token="gsdl3homequoted" value="&quot;${src.gsdl3.home.unix}&quot;"/>
1871 <filter token="gsdl3writablehome" value="${src.gsdl3.writablehome.unix}"/>
1872 <filter token="gsdl3version" value="${app.version}"/>
1873 <filter token="server.protocols" value="${server.protocols}"/>
1874 <filter token="default.server.protocol" value="${default.server.protocol}"/>
1875 <filter token="tomcat.server" value="${tomcat.server}"/>
1876 <filter token="default.tomcat.port" value="${default.tomcat.port}"/>
1877 <filter token="localhost.server.http" value="${localhost.server.http}"/>
1878 <filter token="localhost.port.http" value="${localhost.port.http}"/>
1879 <filter token="tomcat.port.https" value="${tomcat.port.https}"/>
1880 <filter token="restrict.http.to.local" value="${restrict.http.to.local}"/>
1881 <filter token="greenstone.context" value="${greenstone.context}"/>
1882 <filter token="solr.context" value="${solr.context}"/>
1883 <filter token="derbyserver" value="${derby.server}"/>
1884 <filter token="derbyserver.port" value="${derby.server.port}"/>
1885 <filter token="perlpath" value="${escaped.perl.path}"/>
1886 <filter token="defaultservletpath" value="${greenstone.default.servlet}"/>
1887 <filter token="disable.collection.building" value="${disable.collection.building}"/>
1888 <copy file="${basedir}/resources/cgi/gsdl3site.cfg.in" tofile="${web.writablehome}/WEB-INF/cgi/gsdl3site.cfg" filtering="true" overwrite="true"/>
1889 <copy file="${basedir}/resources/web/global.properties.in" tofile="${web.writableclasses}/global.properties" filtering="true" overwrite="true"/>
1890 <copy file="${basedir}/resources/web/log4j.properties.in" tofile="${web.writableclasses}/log4j.properties" filtering="true" overwrite="true"/>
1891 <if>
1892 <bool><istrue value="${gsdl3home.isreadonly}"/></bool>
1893 <!-- uncomment the writablehome properties -->
1894 <rsr verbosity="1" file="${web.writableclasses}/global.properties" pattern="^#gsdl3\.(writable{1})?home" replacement="gsdl3.$1home" />
1895 </if>
1896 <chmod file="${web.writableclasses}/global.properties" perm="664"/>
1897 <chmod file="${web.writableclasses}/log4j.properties" perm="664"/>
1898
1899 <copy file="${basedir}/resources/iiif/cantaloupe.properties.in" tofile="${basedir}/cantaloupe.properties" filtering="true" overwrite="true"/>
1900 <chmod file="${basedir}/cantaloupe.properties" perm="664"/>
1901 </target>
1902
1903 <target name="compile-web" depends="needs-gs3-devel,init">
1904 <javac srcdir="${web.classes}"
1905 destdir="${web.classes}"
1906 includeantruntime="${compile.includeantruntime}"
1907 debug="${compile.debug}"
1908 deprecation="${compile.deprecation}"
1909 optimize="${compile.optimize}"
1910 encoding="${compile.encoding}">
1911 <compilerarg line="${compile.javac.flags}"/>
1912 <classpath><path refid="compile.classpath"/></classpath>
1913 </javac>
1914 </target>
1915
1916 <target name="compile-classpath-jars" depends="needs-gs3-devel,init">
1917 <if><bool><available file="admin/cp.mf"/></bool>
1918 <jar destfile="admin/cp.jar" manifest="admin/cp.mf"/>
1919 </if>
1920 <if><bool><available file="${lib.java}/cp.mf"/></bool>
1921 <jar destfile="${lib.java}/cp.jar" manifest="${lib.java}/cp.mf"/>
1922 </if>
1923 <if><bool><available file="${lib.jni}/cp.mf"/></bool>
1924 <jar destfile="${lib.jni}/cp.jar" manifest="${lib.jni}/cp.mf"/>
1925 </if>
1926 <if><bool><available file="${web.lib}/cp.mf"/></bool>
1927 <jar destfile="${web.lib}/cp.jar" manifest="${web.lib}/cp.mf"/>
1928 </if>
1929 <jar destfile="cp.jar">
1930 <manifest>
1931 <attribute name="Class-Path" value="server.jar admin/cp.jar lib/java/cp.jar lib/jni/cp.jar web/WEB-INF/lib/cp.jar"/>
1932 </manifest>
1933 </jar>
1934 </target>
1935
1936 <target name="clean-classpath-jars" depends="init">
1937 <delete file="admin/cp.jar"/>
1938 <delete file="${lib.java}/cp.jar"/>
1939 <delete file="${lib.jni}/cp.jar"/>
1940 <delete file="${web.lib}/cp.jar"/>
1941 <delete file="cp.jar"/>
1942 </target>
1943
1944
1945 <target name="svnupdate-web" unless="nosvn.mode">
1946 <exec executable="svn">
1947 <arg value="update"/>
1948 <arg value="${web.writablehome}"/>
1949 <arg value="-r"/><arg value="${branch.revision}"/>
1950 </exec>
1951 </target>
1952
1953 <target name="update-web" depends="init,svnupdate-web,configure-web"
1954 description="update only the web stuff (config files)"/>
1955
1956 <!-- ============ Targets concerned with https certification ================ -->
1957
1958 <target name="setup-https-cert-info">
1959 <echo>
1960 *********************************************************************
1961 NOTE TO OBTAINING A TLS (SSL) CERTIFICATE FOR HTTPS
1962 *********************************************************************
1963 A signed certificate is needed for your GS server to serve pages over https.
1964 This target will attempt to obtain a certificate for you from the official and free Certificate Authority Lets Encrypt.
1965 However, a certificate can only be obtained if you have admin/sudo permissions on this machine that you are installing Greenstone on.
1966
1967 Note that:
1968 * if you already have a certificate, then you probably do not want to be running this target but the 'ant renew-existing-https-cert' target instead, to renew your existing certificate.
1969 * if you run this target when you already have a generated certificate, the existing certificate will remain unchanged and the script will terminate with a message alerting you to this fact.
1970 </echo>
1971 </target>
1972
1973
1974 <target name="https-conditions-set">
1975 <input addproperty="https.conditions.ok" validargs="y,n">
1976 To run this target, ensure you have:
1977 * (if on unix) sudo permissions. Enter the sudo password if prompted.
1978 * (if on windows) sufficient privileges to run the included tomcat on port 80.
1979 * nothing running on port 80 when you run this target
1980 * edited the build.properties file with
1981 - tomcat.server set to the/a domain name of your server
1982 - server.protocols comma-separated list set to contain at least 'https' if not also http (the first in this list will be the default protocol)
1983 - tomcat.port.https set to a valid port number not yet in use
1984 - keystore.pass set to a password for the certification process
1985 * read the Lets Encrypt Subscriber Agreement at https://letsencrypt.org/repository/
1986 If any of the above is not possible, quit this target. Continue [y/n]?
1987 </input>
1988
1989 <condition property="quit.https.setup">
1990 <equals arg1="n" arg2="${https.conditions.ok}"/>
1991 </condition>
1992
1993 <fail if="quit.https.setup">https certification step aborted by user. Please edit build.properties to set server.protocol=http and comment out tomcat.port.https.</fail>
1994 </target>
1995
1996
1997 <target name="setup-https-cert" depends="setup-https-cert-info,https-conditions-set">
1998 <if><bool><not><matches string="${server.protocols}" pattern="https"/></not></bool>
1999 <fail>To setup https certification, the server.protocols property in file build.properties must contain 'https'</fail>
2000 </if>
2001
2002 <input addproperty="https.cert.email">Enter an email that Let's Encrypt, the certification authority, can send any important notifications to</input>
2003 <input addproperty="https.other.domains">Besides tomcat.server=${tomcat.server}, enter a comma separated list of additional domains to support, if any</input>
2004 <input addproperty="https.cert.agree" validargs="y,n">You've read the Let's Encrypt Subscriber Agreement at https://letsencrypt.org/repository/ and agree</input>
2005 <if>
2006 <bool><equals arg1="y" arg2="${https.cert.agree}"/></bool>
2007
2008 <condition property="https.cert.domains" value="${tomcat.server},${https.other.domains}" else="${tomcat.server}">
2009 <and>
2010 <isset property="https.other.domains" />
2011 <not><matches string="${https.other.domains}" pattern="^\s*$"/></not>
2012 </and>
2013 </condition>
2014
2015 <input addproperty="https.do.cert" validargs="y,n">
2016 You've agreed to the Let's Encrypt TOS with
2017 - email: ${https.cert.email}
2018 - domains: ${https.cert.domains}
2019 Looks okay? [y/n]
2020 </input>
2021 </if>
2022
2023 <if><bool><equals arg1="n" arg2="${https.do.cert}"/></bool>
2024 <echo>Not proceeding with https certification for the Greenstone 3 web server</echo>
2025 <else>
2026 <echo>Proceeding...</echo>
2027 <if><bool><istrue value="${current.os.iswindows}"/></bool>
2028 <antcall target="setup-https-cert-windows">
2029 <param name="https.cert.renewal" value=""/><!-- for cert issuance, there are none of the additional parameters specific to cert renewal -->
2030 </antcall>
2031 </if>
2032 <if><bool><istrue value="${current.os.isunixnotmac}"/></bool>
2033 <antcall target="setup-https-cert-linux"/>
2034 </if>
2035 <if><bool><istrue value="${current.os.ismac}"/></bool>
2036 <antcall target="setup-https-cert-mac"/>
2037 </if>
2038 </else>
2039 </if>
2040
2041 </target>
2042
2043
2044 <target name="setup-https-cert-windows">
2045
2046 <echo>********** The included tomcat will be stopped, then restarted on port 80 and stopped again</echo>
2047
2048 <!-- create folder packages\tomcat\webapps\ROOT\.well-known\acme-challenge -->
2049 <mkdir dir="${packages.home}/tomcat/webapps/ROOT/.well-known/acme-challenge"/>
2050 <mkdir dir="${packages.home}/tomcat/conf/https_cert"/>
2051
2052 <!--
2053 For Windows, Greenstone can generate the account and domain keys with the openSSL we compiled up ourselves
2054 and put on SVN (at GS3/bin/windows/openssl) rather than let ZeroSSL generate these keys for the user.
2055 Letting Greenstone generate the keys may be considered more trustworthy by the user than letting a 3rd
2056 party do so. See https://zerossl.com/usage.html#First_time_run_and_regular_use for OpenSSL commands
2057 If we don't generate the keys ourselves with our OpenSSL, then ZeroSSL will do so automatically in the
2058 call to le64/32.exe further below, as it's passed in the flag generate-missing.
2059 -->
2060 <!-- We generate the account key named "privkey.key" in ${packages.home}\tomcat\conf\https_cert -->
2061 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
2062 <arg value="/c" />
2063 <arg value="openssl.exe" />
2064 <arg value="genrsa" />
2065 <arg value="-out" /><arg value="${packages.home}\tomcat\conf\https_cert\privkey.key" /><arg value="4096" />
2066 </exec>
2067
2068 <!-- Also generate the domain key (for csr-key parameter to zeroSSL's le.exe)
2069 ${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key
2070 Using 2048 instead of 4096 bits for this. See https://zerossl.com/usage.html#First_time_run_and_regular_use
2071 -->
2072 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
2073 <arg value="/c" />
2074 <arg value="openssl.exe" />
2075 <arg value="genrsa" />
2076 <arg value="-out" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key" /><arg value="2048" />
2077 </exec>
2078
2079 <!-- stop the included tomcat (also stopping derby and solr) -->
2080 <antcall target="stop" />
2081
2082 <!-- rerun tomcat on port 80
2083 See https://ant.apache.org/manual/Tasks/antcall.html -->
2084 <antcall target="start">
2085 <param name="localhost.port.http" value="80"/>
2086 <param name="default.tomcat.port" value="80"/>
2087 <param name="local.http.url" value="http://${localhost.server.http}"/><!-- For port 80 over http, leave out port number in URL -->
2088 <param name="http.address.restriction" value=""/><!-- don't prevent public access over http of port 80 -->
2089 <param name="https.comment.out.start" value="${comment.start}"/>
2090 <param name="https.comment.out.end" value="${comment.end}"/>
2091 </antcall>
2092
2093 <!-- get the certificate: use zerossl for windows
2094 Download from https://github.com/do-know/Crypt-LE/releases,
2095 For licence see https://github.com/do-know/Crypt-LE/
2096 Usage instructions at https://zerossl.com/usage.html
2097
2098 le64 ==key "${packages.home}\tomcat\conf\https_cert\privkey.key" ==csr "${packages.home}\tomcat\conf\https_cert\${tomcat.server}.csr" ==csr-key "${packages.home}s\tomcat\conf\https_cert\${tomcat.server}.key" ==crt "${packages.home}\tomcat\conf\https_cert\${tomcat.server}.crt" ==domains "${https.cert.domains}" ==path "${packages.home}\tomcat\webapps\ROOT\.well-known\acme-challenge" ==generate-missing ==unlink ==live -export-pfx "${keystore.pass}"
2099
2100 which generates a .pfx file with the same name as the PEM certificate (.crt param below)
2101 .pfx vs .p12: https://stackoverflow.com/questions/6819079/convert-pfx-format-to-p12
2102
2103 In this case "fullchain_and_prvtkey.pfx" is generated, which is the windows value of ${keystore.file} property
2104
2105 Helpful for debugging: https://stackoverflow.com/questions/10302489/ant-script-have-exec-tag-dump-out-entire-command-line
2106 -->
2107 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}" spawn="false">
2108 <arg value="/c" />
2109 <arg value="le${os.bitness}" />
2110 <arg value="--key" /><arg value="${packages.home}\tomcat\conf\https_cert\privkey.key" />
2111 <arg value="--csr" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.csr" />
2112 <arg value="--csr-key" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key" />
2113 <!--<arg value="==crt" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.crt" />-->
2114 <arg value="--crt" /><arg value="${packages.home}\tomcat\conf\https_cert\fullchain_and_prvtkey.crt" />
2115 <arg value="--domains" /><arg value="${https.cert.domains}" />
2116 <arg value="--path" /><arg value="${packages.home}\tomcat\webapps\ROOT\.well-known\acme-challenge" />
2117 <arg value="--generate-missing" />
2118 <arg value="--unlink" />
2119 <arg line="${https.testing}" /><!-- minus-minus-live if not testing, empty if testing. https://stackoverflow.com/questions/11840284/pass-arguments-to-apache-ant-exec-task-based-on-the-variables-value -->
2120 <!--<arg value="==export-pfx" /><arg value="${keystore.pass}" />
2121 <arg value="==tag-pfx" /><arg value="greenstone3-tomcat" />--><!--Convert the certificate (that contains the full chain AND private key) to pfx format hereafter using OpenSSL instead-->
2122 <arg line="${https.cert.renewal}" /><!-- renew command on windows/mac appends min-min-renew XX, where if the day the renewal is run is XX days within expiry, the certificate will get renewed. -->
2123 </exec>
2124
2125 <!-- stop the tomcat running on port 80 -->
2126 <antcall target="stop">
2127 <param name="localhost.port.http" value="80"/>
2128 <param name="default.tomcat.port" value="80"/>
2129 <param name="local.http.url" value="http://${localhost.server.http}"/><!-- For port 80 over http, leave out port number in URL -->
2130 <param name="http.address.restriction" value=""/>
2131 <param name="https.comment.out.start" value="${comment.start}"/>
2132 <param name="https.comment.out.end" value="${comment.end}"/>
2133 </antcall>
2134
2135 <!-- Use OpenSSL instead of ZeroSSL to convert the certificate to the .pfx format that tomcat likes, using this cmd:
2136 GS3/bin/windows/openssl/bin/openssl.exe pkcs12 -inkey domain.key -in domain.crt -passin pass:pwd -passout pass:pwd -export -out ${keystore.file}
2137 GS3/bin/windows/openssl/bin/openssl.exe pkcs12 -inkey domain.key -in domain.crt -password pass:pwd -export -out ${keystore.file}
2138 where on windows, keystore.file = fullchain_and_prvtkey.pfx
2139 -->
2140 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
2141 <arg value="/c" />
2142 <arg value="openssl.exe" />
2143 <arg value="pkcs12" />
2144 <arg value="-inkey" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key" />
2145 <arg value="-in" /><arg value="${packages.home}\tomcat\conf\https_cert\fullchain_and_prvtkey.crt" />
2146 <arg value="-export" />
2147 <arg value="-out" /><arg value="${packages.home}\tomcat\conf\https_cert\${keystore.file}" />
2148 <arg value="-name"/><arg value="greenstone3-tomcat"/><!-- See https://stackoverflow.com/questions/808669/convert-a-cert-pem-certificate-to-a-pfx-certificate -->
2149 <arg value="-password"/><arg value="pass:${keystore.pass}"/>
2150 </exec>
2151
2152 </target>
2153
2154
2155 <!-- On Mac as on Linux, we need sudo permissions to setup https certification.
2156 But unlike on Linux, on Mac we only need to sudo when running tomcat on port 80
2157 and when stopping tomcat running on port 80. But we don't need to sudo on a Mac when calling le.pl.
2158 This also means all the files in https_cert have the correct (user, not root) permissions.
2159 -->
2160 <target name="setup-https-cert-mac">
2161
2162 <echo>********** The included tomcat will be stopped, then restarted on port 80 and stopped again</echo>
2163
2164 <!-- create folder packages\tomcat\webapps\ROOT\.well-known\acme-challenge -->
2165 <mkdir dir="${packages.home}/tomcat/webapps/ROOT/.well-known/acme-challenge"/>
2166 <mkdir dir="${packages.home}/tomcat/conf/https_cert"/>
2167
2168 <!--
2169 See comments under setup-https-cert-WINDOWS
2170 -->
2171 <!-- We generate the account key named "privkey.key" in ${packages.home}\tomcat\conf\https_cert -->
2172 <if><bool><not><available file="${packages.home}/tomcat/conf/https_cert/privkey.key"/></not></bool>
2173 <exec executable="openssl" osfamily="mac" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
2174 <arg value="genrsa" />
2175 <arg value="-out" /><arg value="${packages.home}/tomcat/conf/https_cert/privkey.key" /><arg value="4096" />
2176 </exec>
2177 </if>
2178
2179 <!-- Also generate the domain key (for csr-key parameter to zeroSSL's le.pl)
2180 ${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key
2181 Using 2048 instead of 4096 bits for this. See https://zerossl.com/usage.html#First_time_run_and_regular_use
2182 -->
2183 <if><bool><not><available file="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.key"/></not></bool>
2184 <exec executable="openssl" osfamily="mac" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
2185 <arg value="genrsa" />
2186 <arg value="-out" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.key" /><arg value="2048" />
2187 </exec>
2188 </if>
2189
2190 <!-- stop the included tomcat (also stopping derby and solr) -->
2191 <antcall target="stop" />
2192
2193 <!-- rerun tomcat on port 80
2194 See https://ant.apache.org/manual/Tasks/antcall.html -->
2195 <antcall target="start">
2196 <param name="sudo.or.not" value="/usr/bin/sudo" />
2197 <param name="localhost.port.http" value="80"/>
2198 <param name="default.tomcat.port" value="80"/>
2199 <param name="local.http.url" value="http://${localhost.server.http}"/><!-- For port 80 over http, leave out port number in URL -->
2200 <param name="http.address.restriction" value=""/><!-- don't prevent public access over http of port 80 -->
2201 <param name="https.comment.out.start" value="${comment.start}"/>
2202 <param name="https.comment.out.end" value="${comment.end}"/>
2203 </antcall>
2204
2205 <!-- get the certificate: use zerossl's le.pl compiled up for Mac.
2206 For further notes, see under setup-https-cert-WINDOWS
2207 -->
2208
2209 <exec executable="perl" osfamily="mac" dir="${gs2build.home}/perllib/cpan/Crypt/LE/bin" spawn="false">
2210 <env key="PERL5LIB" value="${gs2build.home}/perllib/cpan${path.separator}${gs2build.home}/perllib/cpan/perl-5.18"/>
2211 <arg value="-S" />
2212 <arg value="${gs2build.home}/perllib/cpan/Crypt/LE/bin/le.pl" />
2213 <arg value="--key" /><arg value="${packages.home}/tomcat/conf/https_cert/privkey.key" />
2214 <arg value="--csr" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.csr" />
2215 <arg value="--csr-key" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.key" />
2216 <!--<arg value="==crt" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.crt" />-->
2217 <arg value="--crt" /><arg value="${packages.home}/tomcat/conf/https_cert/fullchain_and_prvtkey.crt" />
2218 <arg value="--domains" /><arg value="${https.cert.domains}" />
2219 <arg value="--path" /><arg value="${packages.home}/tomcat/webapps/ROOT/.well-known/acme-challenge" />
2220 <arg value="--generate-missing" />
2221 <arg value="--unlink" />
2222 <arg line="${https.testing}" /><!-- minus-minus-live if not testing, empty if testing. https://stackoverflow.com/questions/11840284/pass-arguments-to-apache-ant-exec-task-based-on-the-variables-value -->
2223 <!--<arg value="==export-pfx" /><arg value="${keystore.pass}" />
2224 <arg value="==tag-pfx" /><arg value="greenstone3-tomcat" />--><!-- not sure if this generates a keystore filename with ext .p12 or .pfx for Macs -->
2225 <arg line="${https.cert.renewal}" /><!-- renew command on windows/mac appends min-min-renew XX, where if the day the renewal is run is XX days within expiry, the certificate will get renewed. -->
2226 </exec>
2227
2228 <!-- stop the tomcat running on port 80 -->
2229 <antcall target="stop">
2230 <param name="sudo.or.not" value="/usr/bin/sudo" />
2231 <param name="localhost.port.http" value="80"/>
2232 <param name="default.tomcat.port" value="80"/>
2233 <param name="local.http.url" value="http://${localhost.server.http}"/>
2234 <param name="http.address.restriction" value=""/>
2235 <param name="https.comment.out.start" value="${comment.start}"/>
2236 <param name="https.comment.out.end" value="${comment.end}"/>
2237 </antcall>
2238
2239 <!-- Use OpenSSL instead of ZeroSSL to convert the certificate to the .pfx format that tomcat likes, using this cmd:
2240 GS3/bin/windows/openssl/bin/openssl.exe pkcs12 -inkey domain.key -in domain.crt -passin pass:pwd -passout pass:pwd -export -out ${keystore.file}
2241 GS3/bin/windows/openssl/bin/openssl.exe pkcs12 -inkey domain.key -in domain.crt -password pass:pwd -export -out ${keystore.file}
2242 where on windows, keystore.file = fullchain_and_prvtkey.pfx
2243 -->
2244 <exec executable="openssl" osfamily="mac" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
2245 <arg value="pkcs12" />
2246 <arg value="-inkey" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.key" />
2247 <arg value="-in" /><arg value="${packages.home}/tomcat/conf/https_cert/fullchain_and_prvtkey.crt" />
2248 <arg value="-export" />
2249 <arg value="-out" /><arg value="${packages.home}/tomcat/conf/https_cert/${keystore.file}" />
2250 <arg value="-name"/><arg value="greenstone3-tomcat"/><!-- See https://stackoverflow.com/questions/808669/convert-a-cert-pem-certificate-to-a-pfx-certificate -->
2251 <arg value="-password"/><arg value="pass:${keystore.pass}"/>
2252 </exec>
2253
2254 </target>
2255
2256
2257
2258 <target name="setup-https-cert-linux">
2259 <!-- Running as
2260 ./certbot-auto certonly ==standalone ==preferred-challenges http ==email EMAIL -d DOMAINS
2261 expects input from stdin to accept (A) ToS and say Yes (Y) to sharing email.
2262 We can run in non-interactive mode as the user has at this stage already agreed
2263 to LetsEncrypt's Terms of Service and provided an email address.
2264 -->
2265 <exec executable="/bin/bash" dir="${basedir}/bin/${os.bin.dir}" failonerror="true">
2266 <arg value="./certbot-auto"/>
2267 <arg value="certonly"/>
2268 <arg line="${https.testing}"/><!-- https://stackoverflow.com/questions/11840284/pass-arguments-to-apache-ant-exec-task-based-on-the-variables-value -->
2269 <arg value="--standalone"/>
2270 <arg value="--non-interactive"/>
2271 <arg value="--agree-tos"/>
2272 <arg value="--preferred-challenges"/><arg value="http"/>
2273 <arg value="--email"/><arg value="${https.cert.email}"/>
2274 <arg value="--domains"/><arg value="${https.cert.domains}"/>
2275 </exec>
2276
2277 <!-- sudo openssl pkcs12 -export -out /tmp/DOMAIN_fullchain_and_key.p12 \
2278 -in /etc/letsencrypt/live/DOMAIN/fullchain.pem \
2279 -inkey /etc/letsencrypt/live/DOMAIN/privkey.pem \
2280 -name tomcat
2281 Must run as sudo because only admin has access to the pem files that admin
2282 generated in /etc/letsencrypt
2283 See https://computingforgeeks.com/tomcat-7-with-letsencrypt-ssl-certificate/
2284 but also https://community.letsencrypt.org/t/using-lets-encrypt-with-tomcat/41082
2285 which bypasses the step to generate the java keystore jks file
2286 and uses openssl to generate a pfx file instead of a p12 file
2287 -->
2288
2289 <exec executable="sudo" dir="/tmp" failonerror="true">
2290 <arg value="${basedir}/bin/${os.bin.dir}/openssl/bin/openssl"/>
2291 <arg value="pkcs12"/>
2292 <arg value="-export"/>
2293 <arg value="-out"/><arg value="/tmp/${tomcat.server}_fullchain_and_key.p12"/>
2294 <arg value="-in"/><arg value="/etc/letsencrypt/live/${tomcat.server}/fullchain.pem"/>
2295 <arg value="-inkey"/><arg value="/etc/letsencrypt/live/${tomcat.server}/privkey.pem"/>
2296 <arg value="-name"/><arg value="greenstone3-tomcat"/>
2297 <arg value="-password"/><arg value="pass:${keystore.pass}"/>
2298 </exec>
2299
2300 <!-- Finally, mkdir ${packages.home}/tomcat/conf/https_cert
2301 and copy the file /tmp/${tomcat.server}_fullchain_and_key.p12 into it
2302 and rename to a slightly shorter and simpler name,
2303 see https://stackoverflow.com/questions/8971187/ant-renaming-while-copying-file
2304 The file in tmp has root permissions. But copying it from tmp into
2305 the local account will give the copy local account permissions.
2306 Then sudo to remove the original copy in /tmp
2307 -->
2308 <mkdir dir="${packages.home}/tomcat/conf/https_cert"/>
2309 <!--<copy file="/tmp/${tomcat.server}_fullchain_and_key.p12" todir="${packages.home}/tomcat/conf/https_cert"/>-->
2310 <copy todir="${packages.home}/tomcat/conf/https_cert">
2311 <fileset file="/tmp/${tomcat.server}_fullchain_and_key.p12"/>
2312 <globmapper from="${tomcat.server}_fullchain_and_key.p12" to="${keystore.file}"/>
2313 </copy>
2314
2315 <exec executable="sudo" dir="/tmp" failonerror="true">
2316 <arg line="rm -f /tmp/${tomcat.server}_fullchain_and_key.p12" />
2317 </exec>
2318
2319 </target>
2320
2321
2322 <!-- Revoke the certificate and remove it, including folders.
2323 See https://certbot.eff.org/docs/using.html#revoking-certificates
2324 which also states "if a certificate is a test certificate obtained via the
2325 ==staging or ==test-cert flag, that flag must be passed to the revoke subcommand."
2326 -->
2327 <target name="remove-https-cert">
2328 <echo>
2329 NOTE: If you're on Linux, you need to have sudo permissions to execute this target.
2330 Enter the sudo password if prompted.
2331 </echo>
2332 <!--
2333 On linux, we use certbot-auto.
2334 It says at https://github.com/certbot/certbot/issues/1741
2335 "you shouldn't run letsencrypt-auto [now called certbot-auto] as superuser,
2336 because the program will invoke sudo when it needs to automatically."
2337 We need to send Y(es) as inputstring to confirm that the
2338 /etc/letsencrypt/live/${tomcat.server} folder can be deleted.
2339 Note osfamily="unix" is separate from osfamily="mac", which comes out handy here as we haven't set up certbot-auto for mac (yet).
2340 -->
2341 <exec executable="./certbot-auto" os="${os.linux},${os.solaris}" dir="${basedir}/bin/${os.bin.dir}" failonerror="true" inputstring="Y">
2342 <arg value="revoke"/>
2343 <arg line="${https.testing}"/>
2344 <arg value="--cert-path"/><arg value="/etc/letsencrypt/live/${tomcat.server}/cert.pem"/>
2345 </exec>
2346 <!-- The above command already deletes the folder when Y(es) was passed in. Explicitly deleting:
2347 <exec executable="./certbot-auto" dir="${basedir}/bin/${os.bin.dir}" failonerror="true">
2348 <arg value="delete"/>
2349 <arg value="==cert-name"/><arg value="${tomcat.server}"/>
2350 </exec>
2351 -->
2352
2353 <!-- On Windows and Mac, we use zeroSSl. For the revoke command, see https://zerossl.com/usage.html#Certificate_revocation -->
2354 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}" spawn="false">
2355 <arg value="/c" />
2356 <arg value="le${os.bitness}" />
2357 <arg value="--key" /><arg value="${packages.home}\tomcat\conf\https_cert\privkey.key" />
2358 <arg value="--crt" /><arg value="${packages.home}\tomcat\conf\https_cert\fullchain_and_prvtkey.crt"/>
2359 <arg value="--revoke"/>
2360 <arg line="${https.testing}"/>
2361 </exec>
2362
2363 <!-- On Mac, we use the le.pl we compiled up (Crypt::LE) and which needs to have PERL5LIB set correctly to run -->
2364 <exec executable="perl" osfamily="mac" dir="${gs2build.home}/perllib/cpan/Crypt/LE/bin" spawn="false">
2365 <env key="PERL5LIB" value="${gs2build.home}/perllib/cpan${path.separator}${gs2build.home}/perllib/cpan/perl-5.18"/>
2366 <arg value="-S" />
2367 <arg value="${gs2build.home}/perllib/cpan/Crypt/LE/bin/le.pl" />
2368 <arg value="--key" /><arg value="${packages.home}/tomcat/conf/https_cert/privkey.key" />
2369 <arg value="--crt" /><arg value="${packages.home}/tomcat/conf/https_cert/fullchain_and_prvtkey.crt"/>
2370 <arg value="--revoke"/>
2371 <arg line="${https.testing}"/>
2372 </exec>
2373
2374 <!-- And remove the https_cert folder -->
2375 <delete dir="${packages.home}/tomcat/conf/https_cert"/>
2376 </target>
2377
2378
2379 <!-- Renewing existing https certificate
2380 Linux:
2381 https://certbot.eff.org/docs/using.html#renewing-certificates
2382 ./path/to/GS3/bin/linux/certbot-auto renew ==quiet ==no-self-upgrade
2383 Windows: reuse Windows issuance target
2384 see https://zerossl.com/usage.html#Certificate_renewal
2385 -->
2386 <target name="renew-existing-https-cert">
2387 <echo>
2388 NOTE: To run this target,
2389 * ensure nothing is running on port 80
2390 * if you're on Linux or Mac, you need to have sudo permissions. Enter the sudo password if prompted.
2391
2392 If you want your cronjob to renew a certificate, you can add pre and post hooks
2393 refer to https://certbot.eff.org/docs/using.html#renewing-certificates
2394 For more information run:
2395 ./path/to/GS3/bin/linux/certbot-auto --help renew
2396 </echo>
2397 <exec executable="./certbot-auto" os="${os.linux},${os.solaris}" dir="${basedir}/bin/${os.bin.dir}" failonerror="true">
2398 <arg value="renew"/>
2399 <arg value="--quiet"/>
2400 <arg value="--no-self-upgrade"/>
2401 </exec>
2402
2403 <!-- For renewal on Windows or Mac, we use ZeroSSL as intermediary between GS3 and Let's Encrypt.
2404 And when using ZeroSSL we need to re-run the original (issuance) command and append "min-min-renew XX" to it,
2405 where if it's within XX days of expiry, the certificate will get renewed.
2406 See https://zerossl.com/usage.html#Certificate_renewal -->
2407 <if><bool><or>
2408 <istrue value="${current.os.iswindows}"/>
2409 <istrue value="${current.os.ismac}"/>
2410 </or></bool>
2411
2412 <input addproperty="https.other.domains">Enter a comma separated list of additional domains besides tomcat.server=${tomcat.server} that you registered on issuance, if any</input>
2413 <condition property="https.cert.domains" value="${tomcat.server},${https.other.domains}" else="${tomcat.server}">
2414 <and>
2415 <isset property="https.other.domains" />
2416 <not><matches string="${https.other.domains}" pattern="^\s*$"/></not>
2417 </and>
2418 </condition>
2419 <if><bool><istrue value="${current.os.iswindows}"/></bool>
2420 <antcall target="setup-https-cert-windows">
2421 <param name="https.cert.renewal" value="--renew 10"/>
2422 </antcall>
2423 <else>
2424 <antcall target="setup-https-cert-mac">
2425 <param name="https.cert.renewal" value="--renew 10"/>
2426 </antcall>
2427 </else>
2428 </if>
2429 </if>
2430 </target>
2431
2432 <!-- ======================= Tomcat Targets ========================== -->
2433
2434 <!-- this target downloads and installs Tomcat -->
2435 <!-- we download tomcat (version 7 for Java 1.5 and later, version 5 for Java 1.4 plus the 1.4 compatibility package). -->
2436 <target name="prepare-tomcat" depends="init,setup-proxy" if="tomcat.islocal"
2437 description="downloads the appropriate version of Tomcat (Tomcat 5 if using Java 1.4, Tomcat 7 if using Java 1.5 or higher). If you want to change which version of Java you are using between 1.4 and 1.5/7 then you need to run prepare-tomcat">
2438 <echo>Checking for existence of: ${packages.home}/tomcat/.flagfile</echo>
2439 <if>
2440 <bool>
2441 <not><available file="${packages.home}/tomcat/.flagfile"/></not>
2442 </bool>
2443
2444 <!-- check that packages dir is there -->
2445 <mkdir dir="${packages.home}"/>
2446 <!--
2447 <get src="${gsorg.root}/gs3files/${tomcat.version}.zip"
2448 dest="${packages.home}/${tomcat.version}.zip"
2449 usetimestamp="true"/>
2450 -->
2451 <if>
2452 <bool>
2453 <os family="mac" />
2454 </bool>
2455 <exec executable="curl" failonerror="true">
2456 <arg value="-o"/>
2457 <arg value="${packages.home}/${tomcat.version}.zip"/>
2458 <arg value="${gsorg.root}/gs3files/${tomcat.version}.zip"/>
2459 </exec>
2460 <else>
2461 <exec executable="${wget}" failonerror="true">
2462 <arg value="-P"/><!-- specifying output dir, also: minus-minus-directory-prefix -->
2463 <arg value="${packages.home}"/>
2464 <arg value="--no-check-certificate"/>
2465 <arg value="${gsorg.root}/gs3files/${tomcat.version}.zip"/>
2466 </exec>
2467 </else>
2468 </if>
2469
2470 <unzip src="${packages.home}/${tomcat.version}.zip"
2471 dest="${packages.home}"/>
2472
2473 <!-- If we are using Java 1.4, we'd be using tomcat 5.5 in which case
2474 we would need to have the tomcat compat package to work with Java 1.4-->
2475 <if>
2476 <bool><equals arg1="1.4" arg2="${java.specification.version}"/></bool>
2477 <!--
2478 <get src="${gsorg.root}/gs3files/${tomcat.version}-compat.zip"
2479 dest="${packages.home}/${tomcat.version}-compat.zip"
2480 usetimestamp="true"/>
2481 -->
2482
2483 <if>
2484 <bool><os family="mac" /></bool>
2485 <exec executable="curl" failonerror="true">
2486 <arg value="-o"/>
2487 <arg value="${packages.home}/${tomcat.version}-compat.zip"/>
2488 <arg value="${gsorg.root}/gs3files/${tomcat.version}-compat.zip"/>
2489 </exec>
2490 <else>
2491 <exec executable="${wget}" failonerror="true">
2492 <arg value="-P"/>
2493 <arg value="${packages.home}"/>
2494 <arg value="--no-check-certificate"/>
2495 <arg value="${gsorg.root}/gs3files/${tomcat.version}-compat.zip"/>
2496 </exec>
2497 </else>
2498 </if>
2499
2500 <unzip src="${packages.home}/${tomcat.version}-compat.zip"
2501 dest="${packages.home}"/>
2502 </if>
2503
2504 <!-- delete any existing tomcat -->
2505 <delete dir="${packages.home}/tomcat"/>
2506 <move todir="${packages.home}/tomcat">
2507 <fileset dir="${packages.home}/${tomcat.version}"/>
2508 </move>
2509
2510 <!-- To avoid the CGI permissions error appearing continuously in the (localhost) log,
2511 need privileged=true set in the root context.xml file too, not just greenstone context file.
2512 See http://stackoverflow.com/questions/9845936/tomcat-v7-0-load-exception-marking-servlet-ssi-as-unavailable/10305471#10305471
2513 For usage of IfTask IsLessThan: http://antelope.stage.tigris.org/nonav/docs/manual/bk03ch05s02.html -->
2514 <if><bool><not><islessthan arg1="${tomcat.version.major}" arg2="7"/></not></bool>
2515 <copy file="${basedir}/resources/tomcat/root_context.xml.in" tofile="${packages.home}/tomcat/conf/context.xml" overwrite="true" />
2516 </if>
2517
2518
2519 <!--
2520 <copy file="${basedir}/resources/tomcat/setclasspath.bat"
2521 tofile="${packages.home}/tomcat/bin/setclasspath.bat"
2522 overwrite="true"/>
2523 <copy file="${basedir}/resources/tomcat/setclasspath.sh"
2524 tofile="${packages.home}/tomcat/bin/setclasspath.sh"
2525 overwrite="true"/>
2526 -->
2527 <!-- make sure we have execute permission for the .sh files -->
2528 <chmod dir="${packages.home}/tomcat/bin" perm="ugo+rx"
2529 includes="*.sh"/>
2530
2531 <echo file="${packages.home}/tomcat/.flagfile">
2532 the timestamp of this file is the time that tomcat was extracted from the zip files.
2533 it is used to figure out whether the files need to be refreshed or not in `ant prepare-tomcat`
2534 </echo>
2535
2536 <!-- this is not strictly a prepare tomcat thing, but if one changes
2537 Java, then they need to change tomcat as well, so might as well call
2538 it here -->
2539 <antcall target="configure-java-version"/>
2540 <else>
2541 <echo>Tomcat has been prepared, will not prepare</echo>
2542 <echo>Delete ${packages.home}/tomcat/.flagfile to force refresh</echo>
2543 </else>
2544
2545 </if>
2546
2547 </target>
2548
2549 <target name="configure-tomcat" depends="init,configure-tomcat-local,configure-tomcat-external"/>
2550
2551 <target name="configure-tomcat-local" depends="init,perl-for-building" if="tomcat.islocal">
2552 <!-- re-setup the server.xml file -->
2553 <copy file="${basedir}/resources/tomcat/server_tomcat${tomcat.version.major}.xml.in"
2554 tofile="${packages.home}/tomcat/conf/server.xml" overwrite="true">
2555 <filterset>
2556 <filter token="shutdown-port" value="${tomcat.shutdown.port}"/>
2557 <filter token="tomcat.ajp.port" value="${tomcat.ajp.port}"/>
2558 <filter token="https.redirect.port" value="${https.redirect.port}"/>
2559 <filter token="localhost.port.http" value="${localhost.port.http}"/>
2560 <filter token="tomcat.port.https" value="${tomcat.port.https}"/>
2561 <!-- Relative path preferred for keystore.file, in case tomcat is moved elsewhere -->
2562 <!--<filter token="keystore.file" value="conf/https_cert/${tomcat.server}.jks" />-->
2563 <!--ON UNIX: <filter token="keystore.file" value="conf/https_cert/fullchain_and_prvtkey.p12" />-->
2564 <!--ON WINDOWS: <filter token="keystore.file" value="conf/https_cert/fullchain_and_prvtkey.pfx" />-->
2565 <filter token="keystore.file" value="conf/https_cert/${keystore.file}" />
2566 <!-- tomcat Connector's keystoreType param defaults to JKS (Java keystore), see https://tomcat.apache.org/tomcat-7.0-doc/config/http.html
2567 We'll follow the instructions at https://community.letsencrypt.org/t/using-lets-encrypt-with-tomcat/41082,
2568 https://www.ssl.com/how-to/create-a-pfx-p12-certificate-file-using-openssl/
2569 and https://computingforgeeks.com/tomcat-7-with-letsencrypt-ssl-certificate/
2570 (minus the keytool step) and use the PKCS12 file generated by openssl directly,
2571 instead of an additional step to generate the java keystore file from that -->
2572 <filter token="keystore.type" value="PKCS12"/>
2573 <filter token="keystore.pass" value="${keystore.pass}"/>
2574 <!--
2575 if server.protocols doesn't contain http, then http is only to be locally available (e.g. for solr servlet on 127.0.0.1)
2576 In that case, see https://serverfault.com/questions/218666/how-to-configure-tomcat-to-only-listen-to-127-0-0-1
2577 -->
2578 <filter token="http.address.restriction" value="${http.address.restriction}"/>
2579 <filter token="https.comment.out.start" value="${https.comment.out.start}"/>
2580 <filter token="https.comment.out.end" value="${https.comment.out.end}"/>
2581 </filterset>
2582 </copy>
2583
2584 <!-- set up the solr context -->
2585
2586 <!-- First work out the IPv4 address for this machine -->
2587 <exec executable="${basedir}/bin/script/IPv4.sh" os="${os.unix}" failonerror="false" outputproperty="ipv4.val">
2588 <arg value="-format-for-tomcat-context"/>
2589 </exec>
2590 <exec executable="${basedir}/bin/script/IPv4.bat" osfamily="windows" failonerror="false" outputproperty="ipv4.val">
2591 <arg value="-format-for-tomcat-context"/>
2592 </exec>
2593
2594 <copy file="${basedir}/ext/solr/solr-tomcat-context.xml.in" tofile="${packages.home}/tomcat/conf/Catalina/localhost/solr.xml" overwrite="true">
2595 <filterset>
2596 <filter token="solr.context" value="${solr.context}"/>
2597 <filter token="gsdl3webhome" value="${web.writablehome}"/>
2598 <filter token="tomcathome" value="${basedir}/packages/tomcat"/>
2599 <filter token="IPv4" value="${ipv4.val}"/>
2600 </filterset>
2601 </copy>
2602
2603 <!-- set up the greenstone3 context, it may have a custom name specified in build.properties -->
2604 <if><bool><not><equals arg1="greenstone3" arg2="${greenstone.context}"></equals></not></bool>
2605 <copy file="${basedir}/resources/tomcat/greenstone3.xml.in" tofile="${basedir}/resources/tomcat/${greenstone.context}.xml.in" overwrite="true"/>
2606 </if>
2607 <copy file="${basedir}/resources/tomcat/${greenstone.context}.xml.in" tofile="${packages.home}/tomcat/conf/Catalina/localhost/${greenstone.context}.xml" overwrite="true">
2608 <filterset>
2609 <filter token="gsdl3webhome" value="${web.home}"/>
2610 <filter token="gsdl3webwritablehome" value="${web.writablehome}"/>
2611 <filter token="privilegedattribute" value="${privileged.attribute}"/>
2612 <filter token="allowlinking" value="${tomcat.allowLinking}"/>
2613 <filter token="allowedIPs" value="${allowed.IPs}"/>
2614 <filter token="derbyserver" value="${derby.server}"/>
2615 <filter token="derbyserverport" value="${derby.server.port}"/>
2616 <filter token="googlesigninclientid" value="${tomcat.googlesigninJDBCRealm.clientid}"/>
2617
2618 </filterset>
2619 </copy>
2620 <if>
2621 <bool>
2622 <and>
2623 <available file="${packages.home}/tomcat/conf/Catalina/localhost/greenstone3.xml"/>
2624 <not><equals arg1="greenstone3" arg2="${greenstone.context}"></equals></not>
2625 </and>
2626 </bool>
2627 <delete file="${packages.home}/tomcat/conf/Catalina/localhost/greenstone3.xml"/>
2628 </if>
2629
2630 <!-- set up the greenstone3 web.xml file -->
2631 <copy file="${basedir}/resources/tomcat/web8.xml.in" tofile="${packages.home}/tomcat/conf/web.xml" overwrite="true">
2632 <filterset>
2633 <filter token="perlpath" value="${perl.path}"/>
2634 </filterset>
2635 </copy>
2636 </target>
2637
2638 <target name="configure-tomcat-external" depends="init" unless="tomcat.islocal">
2639 <!-- re-setup the server.xml file -->
2640 <!-- need to edit the config file, or do we get the user to do this???-->
2641 </target>
2642
2643 <target name="configure-solr-ext" depends="init" >
2644 <!-- re-setup the web/ext/solr/solr.xml file -->
2645 <copy file="${web.home}/ext/solr/solr.xml.in"
2646 tofile="${gsdl3.writablehome}/ext/solr/solr.xml" filtering="true" overwrite="true">
2647 <filterset>
2648 <filter token="gsdl3.home" value="${src.gsdl3.home.unix}"/>
2649 <filter token="gsdl3.writablehome" value="${src.gsdl3.writablehome.unix}"/>
2650 </filterset>
2651 </copy>
2652 </target>
2653
2654 <target name="configure-webswing-ext" depends="init" >
2655 <exec executable="ant.bat" osfamily="windows" dir="${webswing-ext.home}" spawn="false" failonerror="true">
2656 <arg value="-Dweb.home=${web.home.unix}"/>
2657 <arg value="-Dweb.writablehome=${web.writablehome.unix}"/>
2658 <arg value="configure-extension"/>
2659 </exec>
2660 <exec executable="ant" os="${os.unix}" dir="${webswing-ext.home}" spawn="false" failonerror="true">
2661 <arg value="-Dweb.home=${web.home}"/>
2662 <arg value="-Dweb.writablehome=${web.writablehome}"/>
2663 <arg value="configure-extension"/>
2664 </exec>
2665
2666 <if>
2667 <bool><available file="${web.writablehome}/ext/webswing/etc/catalina-opts-extra.args"/></bool>
2668 <loadfile property="webswing.catalina.opts" srcfile="${web.writablehome}/ext/webswing/etc/catalina-opts-extra.args" failonerror="true"/>
2669 <else>
2670 <property name="webswing.catalina.opts" value=""/>
2671 </else>
2672 </if>
2673 </target>
2674
2675 <!-- This target runs tomcat's "bin/catalina.bat(.sh) jpda start"
2676 to allow debugging the running GS3 server in Eclipse. See the instructions at
2677 http://www.wikijava.org/wiki/Debugging_a_servlet_with_tomcat_and_Eclipse_tutorial
2678 on how to use this with eclipse
2679 -->
2680 <target name="debug-start-tomcat" description="Startup Tomcat for debugger" depends="envbased-localtomcat-path,configure-webswing-ext,init" if="tomcat.islocal">
2681 <property name="tomcat.classpath" refid="local.tomcat.classpath"/>
2682 <property name="tomcat.path" refid="local.tomcat.path"/>
2683
2684 <if><bool>
2685 <isset property="fedora.maxpermsize"/></bool>
2686 <property name="catalina.opts" value="-Djava.util.prefs.syncInterval=2000000 -DGSDL3HOME=$GSDL3HOME -DGSDLOS=$GSDLOS -DPATH=$PATH -Xmx800M -Dcantaloupe.config=&quot;${basedir}/cantaloupe.properties&quot; ${readonly.catalina.opts} ${webswing.catalina.opts} ${fedora.maxpermsize}"/>
2687 <else>
2688 <property name="catalina.opts" value="-Djava.util.prefs.syncInterval=2000000 -DGSDL3HOME=$GSDL3HOME -DGSDLOS=$GSDLOS -DPATH=$PATH -Xmx800M -Dcantaloupe.config=&quot;${basedir}/cantaloupe.properties&quot; ${webswing.catalina.opts} ${readonly.catalina.opts}"/>
2689 </else>
2690 </if>
2691
2692 <echo file="${catalina.home}/bin/setenv.bat">set CLASSPATH=${tomcat.classpath}</echo>
2693 <echo file="${catalina.home}/bin/setenv.sh">export CLASSPATH=${tomcat.classpath}</echo>
2694
2695 <exec executable="${catalina.home}/bin/catalina.sh" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">
2696 <env key="JPDA_ADDRESS" value="8000"/> <!-- for debugging Tomcat in Eclipse -->
2697 <env key="JPDA_TRANSPORT" value="dt_socket"/> <!-- for debugging Tomcat in Eclipse -->
2698 <!--<env key="GSDLOS" value="linux"/> do we need this?? -->
2699 <env key="PATH" path="${tomcat.path}"/>
2700 <!-- Based on:
2701 https://jfrog.com/knowledge-base/tomcat-takes-forever-to-start-what-can-i-do/
2702 consider controlling Tomcat to use the psuedo random number generator '/dev/urandom'
2703 raher than the default '/dev/random' which while cryptographically stronger is
2704 also slower when demand is high
2705
2706 -Djava.security.egd=file:/dev/urandom
2707 -->
2708 <env key="CATALINA_OPTS" value="${catalina.opts}"/>
2709 <env key="CATALINA_HOME" value="${catalina.home}"/>
2710 <env key="CLASSPATH" path="${tomcat.classpath}"/>
2711 <env key="LD_LIBRARY_PATH" path="${env.LD_LIBRARY_PATH}:${lib.jni}"/>
2712 <env key="DYLD_LIBRARY_PATH" path="${env.DYLD_LIBRARY_PATH}:${lib.jni}:${gdbm.home}/lib"/> <!-- for mac os --> <!-- need gdbm here these days ??-->
2713 <env key="WNHOME" path="${wn.home}"/>
2714 <env key="FEDORA_HOME" path="${fedora.home}"/>
2715
2716 <env key="_RUNJAVA" value="${env.CATALINA_START_RUNJAVA}"/>
2717 <arg value="jpda" />
2718 <arg value="start" />
2719 </exec>
2720 <exec executable="${catalina.home}/bin/catalina.bat" osfamily="windows" dir="${catalina.home}/bin" spawn="true">
2721 <env key="JPDA_ADDRESS" value="8000"/> <!-- for debugging Tomcat in Eclipse -->
2722 <env key="JPDA_TRANSPORT" value="dt_socket"/> <!-- for debugging Tomcat in Eclipse -->
2723 <env key="GSDLOS" value="windows"/>
2724 <env key="GSDL3HOME" value="${web.home}"/>
2725 <env key="Path" path="${tomcat.path}"/>
2726 <env key="PATH" path="${tomcat.path}"/>
2727 <env key="CATALINA_OPTS" value="${catalina.opts}"/>
2728 <env key="CATALINA_HOME" value="${catalina.home}"/>
2729 <env key="CLASSPATH" path="${tomcat.classpath}"/>
2730 <env key="FEDORA_HOME" path="${fedora.home}"/>
2731
2732 <arg value="jpda" />
2733 <arg value="start" />
2734 </exec>
2735 <!-- wait for the server to startup in case other targets need it running -->
2736 <waitfor maxwait="5" maxwaitunit="second">
2737 <and>
2738 <socket server="${tomcat.server}" port="${default.tomcat.port}"/>
2739 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/index.html"/>-->
2740 <http url="${local.http.url}${app.path}/index.html"/>
2741 </and>
2742 </waitfor>
2743 </target>
2744
2745 <target name="start-tomcat" description="Startup only Tomcat" depends="check-tomcat-started">
2746
2747 <if><bool><istrue value="${tomcat.isstarted}"/></bool>
2748 <echo>**************************************</echo>
2749 <echo>A WEB SERVER IS ALREADY RUNNING ON ${default.server.protocol}://${tomcat.server}:${default.tomcat.port} (${local.http.url}). NOT STARTING.</echo>
2750 <echo>**************************************</echo>
2751 <else>
2752 <antcall target="force-start-tomcat"/>
2753 </else>
2754 </if>
2755 </target>
2756
2757 <!-- Another way: http://ptrthomas.wordpress.com/2006/03/25/how-to-start-and-stop-tomcat-from-ant/ -->
2758 <target name="force-start-tomcat" description="Startup only Tomcat" depends="envbased-localtomcat-path,configure-webswing-ext,init" if="tomcat.islocal">
2759
2760 <property name="tomcat.classpath" refid="local.tomcat.classpath"/>
2761 <property name="tomcat.path" refid="local.tomcat.path"/>
2762
2763 <if><bool>
2764 <isset property="fedora.maxpermsize"/></bool>
2765 <property name="catalina.opts" value="-Djava.util.prefs.syncInterval=2000000 -DGSDL3HOME=$GSDL3HOME -DGSDLOS=$GSDLOS -DPATH=$PATH -Xmx800M -Dcantaloupe.config=&quot;${basedir}/cantaloupe.properties&quot; ${readonly.catalina.opts} ${webswing.catalina.opts} ${fedora.maxpermsize}"/>
2766 <else>
2767 <property name="catalina.opts" value="-Djava.util.prefs.syncInterval=2000000 -DGSDL3HOME=$GSDL3HOME -DGSDLOS=$GSDLOS -DPATH=$PATH -Xmx800M -Dcantaloupe.config=&quot;${basedir}/cantaloupe.properties&quot; ${readonly.catalina.opts} ${webswing.catalina.opts}"/>
2768 </else>
2769 </if>
2770
2771 <echo file="${catalina.home}/bin/setenv.bat">set CLASSPATH=${tomcat.classpath}</echo>
2772 <echo file="${catalina.home}/bin/setenv.sh">export CLASSPATH=${tomcat.classpath}</echo>
2773
2774 <!-- using osfamily instead of testing os against os.windows list of recognised windows versions
2775 so that future windows versions are included. See http://simonharrer.wordpress.com/tag/osfamily/
2776 Can't use the osfamily test for linux-type machines as a group since osfamily=unix is separate from osfamily=mac,
2777 see http://ant-contrib.sourceforge.net/tasks/tasks/osfamily.html -->
2778
2779 <exec executable="${sudo.or.not}" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">
2780 <!--<env key="JAVA_TOOL_OPTIONS" value="-Dfile.encoding=UTF-8"/>--><!-- Was needed by Windows for on e.g. Chinese locales, but added to unix for symmetry-->
2781 <env key="CATALINA_OPTS" value="${catalina.opts}"/>
2782 <env key="CATALINA_HOME" value="${catalina.home}"/>
2783 <env key="CLASSPATH" path="${tomcat.classpath}"/>
2784 <env key="PATH" path="${tomcat.path}"/>
2785
2786 <env key="LD_LIBRARY_PATH" path="${env.LD_LIBRARY_PATH}:${lib.jni}"/>
2787 <env key="DYLD_LIBRARY_PATH" path="${env.DYLD_LIBRARY_PATH}:${lib.jni}:${gdbm.home}/lib"/> <!-- for mac os --> <!-- need gdbm here these days ??-->
2788
2789 <!-- Webswing servlet needs the following enviornent variables to be set to be able to run GLI -->
2790 <env key="GSDL3SRCHOME" value="${env.GSDL3SRCHOME}"/>
2791 <env key="GSDL3HOME" value="${web.home}"/> <!-- consider changing to env.GSDL3HOME to be more consistent? -->
2792 <env key="GSDLHOME" value="${env.GSDLHOME}"/> <!-- i.e., gs2build.home -->
2793 <env key="GSDL3EXTS" value="${env.GSDL3EXTS}"/>
2794 <env key="GSDLEXTS" value="${env.GSDLEXTS}"/>
2795 <env key="GEXT_SOLR" value="${env.GEXT_SOLR}"/>
2796 <env key="GSDLOS" value="${env.GSDLOS}"/>
2797
2798 <env key="WNHOME" path="${wn.home}"/>
2799 <env key="FEDORA_HOME" path="${fedora.home}"/>
2800
2801 <env key="_RUNJAVA" value="${env.CATALINA_START_RUNJAVA}"/>
2802 <arg value="${catalina.home}/bin/startup.sh"/>
2803 </exec>
2804 <exec executable="${catalina.home}/bin/startup.bat" osfamily="windows" dir="${catalina.home}/bin" spawn="true">
2805 <!--<env key="JAVA_TOOL_OPTIONS" value="-Dfile.encoding=UTF-8"/>-->
2806 <env key="CATALINA_OPTS" value="${catalina.opts}"/>
2807 <env key="CATALINA_HOME" value="${catalina.home}"/>
2808 <env key="CLASSPATH" path="${tomcat.classpath}"/>
2809
2810 <env key="PATH" path="${tomcat.path}"/>
2811 <env key="Path" path="${tomcat.path}"/>
2812 <!-- Should the equivalent LD_LIBRARY_PATH line above for Unix, be turned into an equivalent PATH update, as this is what Windows uses? -->
2813
2814 <!-- Webswing servlet needs the following enviornent variables to be set to be able to run GLI -->
2815 <env key="GSDL3SRCHOME" value="${env.GSDL3SRCHOME}"/>
2816 <env key="GSDL3HOME" value="${web.home}"/> <!-- consider changing to env.GSDL3HOME to be more consistent? -->
2817 <env key="GSDLHOME" value="${env.GSDLHOME}"/> <!-- i.e., gs2build.home -->
2818 <env key="GSDL3EXTS" value="${env.GSDL3EXTS}"/>
2819 <env key="GSDLEXTS" value="${env.GSDLEXTS}"/>
2820 <env key="GEXT_SOLR" value="${env.GEXT_SOLR}"/>
2821 <env key="GSDLOS" value="${env.GSDLOS}"/> <!-- used to be hardwired to 'windows', but now gs3-setup.sh run, GSDLOS should be set -->
2822
2823 <env key="WNHOME" path="${wn.home}"/>
2824 <env key="FEDORA_HOME" path="${fedora.home}"/>
2825 </exec>
2826 <!-- wait for the server to startup in case other targets need it running -->
2827 <waitfor maxwait="5" maxwaitunit="second">
2828 <and>
2829 <socket server="${tomcat.server}" port="${default.tomcat.port}"/>
2830 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/index.html"/>-->
2831 <http url="${local.http.url}${app.path}/index.html"/>
2832 </and>
2833 </waitfor>
2834
2835 </target>
2836
2837 <!--ant task http: http://www.jajakarta.org/ant/ant-1.6.1/docs/ja/manual/api/org/apache/tools/ant/taskdefs/condition/Http.html-->
2838 <target name="reconfigure" description="Reconfigure the message router">
2839 <waitfor maxwait="5" maxwaitunit="second">
2840 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}${server.default.servlet}?a=s&amp;sa=c"/>-->
2841 <http url="${local.http.url}${app.path}${server.default.servlet}?a=s&amp;sa=c"/>
2842 </waitfor>
2843 </target>
2844
2845 <!--Command-line args to Ant: http://www.jguru.com/faq/view.jsp?EID=471794-->
2846 <target name="reconfigure-collection" description="Reconfigure the collection">
2847 <waitfor maxwait="5" maxwaitunit="second">
2848 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}${server.default.servlet}?a=s&amp;sa=c&amp;sc=${collection}"/>-->
2849 <http url="${local.http.url}${app.path}${server.default.servlet}?a=s&amp;sa=c&amp;sc=${collection}"/>
2850 </waitfor>
2851 </target>
2852
2853 <!-- windows: do we want to launch a webrowser?? -->
2854 <!-- shouldn't this test whether anything is running first?
2855 It's safer to always attempt to stop tomcat: that way we won't be dependent on the right time
2856 to check whether the server is stopped or still running before attempting to start again.
2857 This target, which was recently called force-stop-tomcat for a while but is back to being
2858 called stop-tomcat, now hides the Java exception output that appears whenever tomcat is already
2859 stopped as happens when stop-tomcat is called consecutively. -->
2860 <target name="force-stop-tomcat" description="Shutdown only Tomcat" depends="init" if="tomcat.islocal">
2861 <!--<exec executable="${catalina.home}/bin/shutdown.sh" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">-->
2862 <exec executable="${sudo.or.not}" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">
2863 <!--<env key="JAVA_TOOL_OPTIONS" value="-Dfile.encoding=UTF-8"/>--><!-- Was needed by Windows for on e.g. Chinese locales, but added to unix for symmetry-->
2864 <env key="FEDORA_HOME" path="${fedora.home}"/>
2865 <env key="CATALINA_HOME" value="${catalina.home}"/>
2866 <arg value="${catalina.home}/bin/shutdown.sh"/>
2867 <arg line=">/dev/null 2>&amp;1"/>
2868 </exec>
2869 <exec executable="${catalina.home}/bin/shutdown.bat" osfamily="windows" dir="${catalina.home}/bin" spawn="false">
2870 <!--<env key="JAVA_TOOL_OPTIONS" value="-Dfile.encoding=UTF-8"/>--><!-- In case on stopping tomcat, GLI may read in some XML file during cleanup for exit? -->
2871 <env key="FEDORA_HOME" path="${fedora.home}"/>
2872 <env key="CATALINA_HOME" value="${catalina.home}"/>
2873 <arg line=">nul 2>&amp;1"/>
2874 </exec>
2875 </target>
2876
2877 <!-- Can also try the "socket" condition in place of the "http" condition
2878 And also use a <waitfor> in place of <condition>, such as:
2879 <waitfor maxwait="5" maxwaitunit="second" timeoutproperty="tomcat.isstopped"><http url="..."/></waitfor>
2880 The http URL resolves to host:port/greenstone3
2881 Condition uses <http/> rather than <socket/> for testing, since if the server was stopped, the socket
2882 might still be in use for some moments. We test the URL with the http condition since it's likelier to
2883 fail sooner if the server has indeed been stopped. -->
2884 <target name="check-tomcat-running">
2885 <condition property="tomcat.isrunning">
2886 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}"/>-->
2887 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}"/>--><!-- untrusted certificates won't work, so don't test https urls-->
2888 <http url="${local.http.url}"/><!-- testing the local http url instead -->
2889 </condition>
2890 </target>
2891
2892 <!--
2893 <target name="verbose-check-tomcat-running">
2894 <condition property="tomcat.isrunning" value="true" else="false">
2895 <http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}"/>
2896 <http url="${local.http.url}"/>
2897 </condition>
2898 <echo>Tomcat is running: ${tomcat.isrunning}</echo>
2899 </target>
2900 -->
2901 <target name="verbose-check-tomcat-running" depends="check-tomcat-running">
2902 <if>
2903 <bool>
2904 <istrue value="${tomcat.isrunning}"/>
2905 </bool>
2906 <echo>Tomcat is running: ${tomcat.isrunning}</echo>
2907 <else><echo>Tomcat is running: false</echo></else><!-- tomcat.isrunning not set -->
2908 </if>
2909 </target>
2910
2911 <!-- Need a copy of the check-tomcat-running target with a distinct property, because ant restart runs
2912 both stop and start, both of which need to do tomcat checks. Each property can be set only once during
2913 an invocation with ant. So ant restart will need two properties to store each of the tomcat checks -->
2914 <target name="check-tomcat-started">
2915 <condition property="tomcat.isstarted">
2916 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}"/>-->
2917 <http url="${local.http.url}"/>
2918 </condition>
2919 </target>
2920
2921
2922
2923 <!-- stop-tomcat checks if the tomcat server is already running. If it appears to be running
2924 (regardless of whether tomcat was just starting to shut down), this target calls force-stop-tomcat
2925 to issue the shutdown command to tomcat. Then it waits for at most 15 seconds for the server to
2926 actually stop by checking the socket at which tomcat listens every second, printing a warning
2927 at the end of the max wait time of 15 seconds if tomcat was still running. -->
2928 <target name="stop-tomcat" description="Shutdown only Tomcat if running" depends="check-tomcat-running" if="tomcat.isrunning">
2929 <antcall target="force-stop-tomcat"/>
2930
2931 <property name="wait.numchecks" value="15"/>
2932 <echo>Waiting for the server to shutdown... (${wait.numchecks} seconds max)</echo>
2933 <waitfor maxwait="${wait.numchecks}" maxwaitunit="second" checkevery="1" checkeveryunit="second" timeoutproperty="tomcat.timedout">
2934 <not><socket server="${tomcat.server}" port="${default.tomcat.port}"/></not>
2935 </waitfor>
2936
2937 <if>
2938 <bool>
2939 <isset property="${tomcat.timedout}"/>
2940 </bool>
2941 <property name="tomcat.isrunning" value="true"/>
2942 <echo>WARNING: Checked the socket ${wait.numchecks} times, but port ${default.tomcat.port} is still busy.</echo>
2943 <else>
2944 <echo>Tomcat is stopped.</echo>
2945 <property name="tomcat.isrunning" value="false"/>
2946 </else>
2947 </if>
2948 </target>
2949
2950 <target name="restart-tomcat" description="Shutdown and restart only Tomcat" depends="init,stop-tomcat,force-start-tomcat"/>
2951
2952 <target name="setup-catalina-ant-tasks">
2953 <!-- Configure the custom Ant tasks for the Tomcat Manager application -->
2954 <taskdef name="deploy" classname="org.apache.catalina.ant.DeployTask"
2955 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2956 <taskdef name="list" classname="org.apache.catalina.ant.ListTask"
2957 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2958 <taskdef name="reload" classname="org.apache.catalina.ant.ReloadTask"
2959 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2960 <taskdef name="resources" classname="org.apache.catalina.ant.ResourcesTask"
2961 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2962 <taskdef name="roles" classname="org.apache.catalina.ant.RolesTask"
2963 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2964 <taskdef name="start" classname="org.apache.catalina.ant.StartTask"
2965 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2966 <taskdef name="stop" classname="org.apache.catalina.ant.StopTask"
2967 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2968 <taskdef name="undeploy" classname="org.apache.catalina.ant.UndeployTask"
2969 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2970 </target>
2971
2972 <!-- http://blog.andrewbeacock.com/2007/11/how-to-truncate-log-file-using-ubuntu.html
2973 Doing "cat </dev/null > packages/tomcat/logs/catalina.out" doesn't work as an ant target.
2974 It seems to have a problem with cat or </dev/null, with or without the < sign. -->
2975 <target name="reset-logs" description="Empties catalina.out, solr.log, greenstone.log, usage.log, server.log and contents of web/logs/tmp">
2976 <echo>Truncating catalina.out, solr.log, greenstone.log, usage.log and server.log, and emptying ${web.writablehome}/logs/tmp</echo>
2977 <exec executable="rm" os="${os.unix}" dir="${catalina.home}/logs" spawn="false">
2978 <arg value="-f"/>
2979 <arg value="catalina.out"/>
2980 </exec>
2981 <exec executable="rm" os="${os.unix}" dir="${web.writablehome}/logs" spawn="false">
2982 <arg value="-f"/>
2983 <arg value="greenstone.log"/>
2984 </exec>
2985 <exec executable="rm" os="${os.unix}" dir="${web.writablehome}/logs" spawn="false">
2986 <arg value="-f"/>
2987 <arg value="usage.log"/>
2988 </exec>
2989 <exec executable="rm" os="${os.unix}" dir="${web.writablehome}/logs" spawn="false">
2990 <arg value="-f"/>
2991 <arg value="server.log"/>
2992 </exec>
2993
2994 <exec executable="touch" os="${os.unix}" dir="${catalina.home}/logs"
2995 spawn="false">
2996 <arg value="catalina.out"/>
2997 </exec>
2998 <exec executable="touch" os="${os.unix}" dir="${web.writablehome}/logs"
2999 spawn="false">
3000 <arg value="greenstone.log"/>
3001 </exec>
3002 <exec executable="touch" os="${os.unix}" dir="${web.writablehome}/logs"
3003 spawn="false">
3004 <arg value="usage.log"/>
3005 </exec>
3006 <exec executable="touch" os="${os.unix}" dir="${web.writablehome}/logs"
3007 spawn="false">
3008 <arg value="server.log"/>
3009 </exec>
3010
3011 <exec executable="cmd" osfamily="windows" dir="${catalina.home}/logs" spawn="false">
3012 <arg line="/c echo. > catalina.out"/>
3013 </exec>
3014 <exec executable="cmd" osfamily="windows" dir="${web.writablehome}/logs" spawn="false">
3015 <arg line="/c echo. > greenstone.log"/>
3016 </exec>
3017 <exec executable="cmd" osfamily="windows" dir="${web.writablehome}/logs" spawn="false">
3018 <arg line="/c echo. > usage.log"/>
3019 </exec>
3020 <exec executable="cmd" osfamily="windows" dir="${web.writablehome}/logs" spawn="false">
3021 <arg line="/c echo. > server.log"/>
3022 </exec>
3023
3024 <!-- if ext/solr/logs/solr.log exists, truncate it -->
3025 <if><bool><available file="${solr-ext.home}/logs/solr.log" type="file"/></bool>
3026 <exec executable="rm" os="${os.unix}" dir="${solr-ext.home}/logs" spawn="false">
3027 <arg value="-f"/>
3028 <arg value="solr.log"/>
3029 </exec>
3030 <exec executable="touch" os="${os.unix}" dir="${solr-ext.home}/logs" spawn="false">
3031 <arg value="solr.log"/>
3032 </exec>
3033 <exec executable="cmd" osfamily="windows" dir="${solr-ext.home}/logs" spawn="false">
3034 <arg line="/c echo. > solr.log"/>
3035 </exec>
3036 </if>
3037
3038 <if>
3039 <bool><available file="${web.writablehome}/logs/tmp" type="dir"/></bool>
3040 <delete>
3041 <fileset dir="${web.writablehome}/logs/tmp" includes="**/*"/>
3042 </delete>
3043 </if>
3044 </target>
3045
3046 <target name="clear-tomcat-sessions" description="Clear the Tomcat Session info." depends="init">
3047 <exec executable="cmd" osfamily="windows" dir="${catalina.home}/work/Catalina/localhost/greenstone3" spawn="false">
3048 <arg line="/c echo. > SESSIONS.ser"/>
3049 </exec>
3050 <exec executable="rm" os="${os.unix}" dir="${catalina.home}/work/Catalina/localhost/greenstone3" spawn="false">
3051 <arg value="-f"/>
3052 <arg value="SESSIONS.ser"/>
3053 </exec>
3054
3055 </target>
3056 <!-- ======================= ant Targets ============================ -->
3057 <target name="prepare-ant" depends="init">
3058 <if>
3059 <bool>
3060 <not><available file="${packages.home}/ant/.flagfile"/></not>
3061 </bool>
3062 <property name="ant.download.version" value="apache-ant-1.9.13" />
3063 <!--
3064 <get src="${gsorg.root}/gs3files/${ant.download.version}-bin.zip"
3065 dest="${packages.home}/${ant.download.version}-bin.zip"
3066 usetimestamp="true"/>
3067 -->
3068 <exec executable="${wget}" failonerror="true">
3069 <arg value="-P"/>
3070 <arg value="${packages.home}"/>
3071 <arg value="--no-check-certificate"/>
3072 <arg value="${gsorg.root}/gs3files/${ant.download.version}-bin.zip"/>
3073 </exec>
3074 <unzip src="${packages.home}/${ant.download.version}-bin.zip"
3075 dest="${packages.home}"/>
3076 <move todir="${packages.home}/ant">
3077 <fileset dir="${packages.home}/${ant.download.version}"/>
3078 </move>
3079 <echo file="${packages.home}/ant/.flagfile">
3080 the timestamp of this file is the time that ant was extracted from the zip files.
3081 it is used to figure out whether the files need to be refreshed or not in `ant prepare-ant`
3082 </echo>
3083
3084 <else>
3085 <echo>Ant has been prepared, will not prepare</echo>
3086 <echo>Delete ${packages.home}/ant/.flagfile to force refresh</echo>
3087 </else>
3088
3089 </if>
3090 </target>
3091
3092 <!-- ======================= Admin Targets ============================ -->
3093
3094 <!-- This target won't work with Eclipse because the SecureInputHandler used below conflicts with it.
3095 See http://www.dcepler.net/post.cfm/hiding-password-input-in-ant
3096 But you can do: echo mypassword | ant config-admin -->
3097 <target name="config-admin" description="Reset admin password">
3098 <input addproperty="admin.password" defaultvalue="admin" message="New admin password (3-20 characters):&gt;">
3099 <handler classname="org.apache.tools.ant.input.SecureInputHandler" /> <!-- password won't be visible on screen -->
3100 </input>
3101 <!--<echo>PWD: ${admin.password}</echo>-->
3102 <antcall target="update-userdb">
3103 <param name="user.username" value="admin"/>
3104 <param name="user.password" value="${admin.password}"/>
3105 <param name="user.groups" value=""/>
3106 <param name="user.status" value=""/>
3107 <param name="user.comment" value="Password updated."/>
3108 <param name="user.email" value=""/>
3109 </antcall>
3110 </target>
3111
3112 <target name="config-user" description="Add or modify users" depends="get-user-data,update-userdb"/>
3113<!-- this is called bu config-user to ask for the new user details at the prompt -->
3114 <target name="get-user-data" >
3115 <input addproperty="user.username" message="Username:&gt;"/>
3116 <input addproperty="user.password" defaultvalue="" message="Password (3-20 characters):&gt;">
3117 <handler classname="org.apache.tools.ant.input.SecureInputHandler" /> <!-- password won't be visible on screen -->
3118 </input>
3119 <input addproperty="user.groups" defaultvalue="" message="Groups (comma-separated list, e.g. personal-collections-editor):&gt;"/>
3120 <input addproperty="user.status" defaultvalue="true" message="Enabled (true/false):&gt;"/>
3121 <input addproperty="user.comment" defaultvalue="" message="Comment:&gt;"/>
3122 <input addproperty="user.email" defaultvalue="" message="Email:&gt;"/>
3123 </target>
3124
3125 <!-- This target won't work with Eclipse because the SecureInputHandler used below conflicts with it.
3126 See http://www.dcepler.net/post.cfm/hiding-password-input-in-ant
3127 But you can do: echo mypassword | ant config-admin -->
3128 <target name="update-userdb" depends="start-derby">
3129
3130 <!--
3131 We're now using derby networked server, so stopping and starting tomcat is not necessary.
3132 For embedded derby: stop tomcat if running, since derby db is embedded
3133 and only allows connections from one jvm instance at a time
3134 See http://db.apache.org/derby/papers/DerbyTut/embedded_intro.html
3135 The ${tomcat.isrunning} property is set by the depends-target "check-tomcat-running" -->
3136
3137 <!-- Need the derby networked server to be running in order to modify the usersDB.
3138 The start-derby task will check if derby is already running (if not, ${derby.isstarted} will
3139 be false) and will only start up networked derby if it is not already running.
3140 The ${derby.isstarted} property is set by the depends-target "start-derby", since it won't
3141 set the property if called with antcall (like launching in a subshell). Have to use 'depends'.
3142 We'll check ${derby.isstarted} at the end to stop derby again if we had to start it up now.-->
3143 <!--<antcall target="start-derby"/>-->
3144
3145 <!-- wait a max of 5 seconds for the derbyserver to have started up -->
3146 <waitfor maxwait="5" maxwaitunit="second">
3147 <socket server="${derby.server}" port="${derby.server.port}"/>
3148 </waitfor>
3149
3150 <!--<echo>${admin.password}</echo>--> <!-- for testing -->
3151 <echo>gsdl3.writablehome: ${gsdl3.writablehome}</echo> <!-- for testing -->
3152 <echo>web.home: ${web.home}</echo> <!-- for testing -->
3153 <java classname="org.greenstone.gsdl3.util.ModifyUsersDB">
3154 <classpath refid="compile.classpath"/> <!--for ${web.lib}/gsdl3.jar and supporting files-->
3155 <sysproperty key="gsdl3.writablehome" value="${gsdl3.writablehome}" /> <!-- passes -D<syspropKey=syspropVal> to java class ModifyUsersDB. Available in java code as System.getProperty("syspropKey") -->
3156 <arg file="${web.home}/etc/usersDB"/>
3157 <arg value="${user.username}"/>
3158 <arg value="password=${user.password}"/>
3159 <arg value="groups=${user.groups}"/>
3160 <arg value="status=${user.status}"/>
3161 <arg value="comment=${user.comment}"/>
3162 <arg value="email=${user.email}"/>
3163 </java>
3164
3165 <!-- Need to stop networked derby again if we ran it for this target with the depends=start-derby call.
3166 The test here is for <not>derby.isstarted</not>, as the property would be the same as before
3167 derby was started, since properties are immutable within a single ant command. -->
3168 <if>
3169 <bool>
3170 <not><istrue value="${derby.isstarted}"/></not>
3171 </bool>
3172 <antcall target="force-stop-derby"/>
3173 </if>
3174
3175 </target>
3176
3177
3178 <!-- ======================= Axis Targets ============================ -->
3179
3180 <target name="prepare-axis" depends="init">
3181 <echo>Checking for existence of: ${packages.home}/axis/.flagfile</echo>
3182 <if>
3183 <bool>
3184 <not><available file="${packages.home}/axis/.flagfile"/></not>
3185 </bool>
3186
3187 <!--
3188 <get src="${gsorg.root}/gs3files/${axis.zip.version}"
3189 dest="${packages.home}/${axis.zip.version}"
3190 usetimestamp="true"/>
3191 -->
3192 <if>
3193 <bool>
3194 <os family="mac" />
3195 </bool>
3196 <exec executable="curl" failonerror="true">
3197 <arg value="-o"/>
3198 <arg value="${packages.home}/${axis.zip.version}"/>
3199 <arg value="${gsorg.root}/gs3files/${axis.zip.version}"/>
3200 </exec>
3201 <else>
3202 <exec executable="${wget}" failonerror="true">
3203 <arg value="-P"/><!-- output dir, alt: minus-minus-directory-prefix -->
3204 <arg value="${packages.home}"/>
3205 <arg value="--no-check-certificate"/>
3206 <arg value="${gsorg.root}/gs3files/${axis.zip.version}"/>
3207 </exec>
3208 </else>
3209 </if>
3210
3211 <unzip src="${packages.home}/${axis.zip.version}"
3212 dest="${packages.home}"/>
3213 <move todir="${packages.home}/axis">
3214 <fileset dir="${packages.home}/${axis.dir.version}"/>
3215 </move>
3216 <!-- install axis into greenstone web app -->
3217 <copy todir="${web.lib}">
3218 <fileset dir="${packages.home}/axis/webapps/axis/WEB-INF/lib">
3219 <include name="*.jar"/>
3220 </fileset>
3221 </copy>
3222 <copy todir="${web.home}">
3223 <fileset dir="${packages.home}/axis/webapps/axis/">
3224 <include name="*.jsp"/>
3225 <include name="*.jws"/>
3226 </fileset>
3227 </copy>
3228 <copy tofile="${web.home}/axis.html" file="${packages.home}/axis/webapps/axis/index.html"/>
3229 <copy todir="${web.classes}">
3230 <fileset dir="${packages.home}/axis/webapps/axis/WEB-INF/classes">
3231 <include name="*.properties"/>
3232 </fileset>
3233 </copy>
3234 <echo file="${packages.home}/axis/.flagfile">
3235 the timestamp of this file is the time that axis was extracted from the zip files.
3236 it is used to figure out whether the files need to be refreshed or not in `ant prepare-axis`
3237 </echo>
3238
3239 <else>
3240 <echo>Axis has been prepared, will not prepare</echo>
3241 <echo>Delete ${packages.home}/axis/.flagfile to force refresh</echo>
3242 </else>
3243
3244 </if>
3245 </target>
3246
3247 <target name="soap-deploy-site" depends="init,get-sitename,get-siteuri,get-webservices,create-deployment-files,deploy-site"
3248 description="Deploy a SOAP web service for a local Greenstone site. Tomcat must be running for this to work."/>
3249
3250 <target name="deploy-site">
3251 <java classname="org.apache.axis.client.AdminClient">
3252 <classpath refid="compile.classpath"/>
3253 <arg value="-l"/>
3254 <arg value="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/servlet/AxisServlet"/>
3255 <arg file="${basedir}/resources/soap/deploy.wsdd"/>
3256 </java>
3257 <delete file="${basedir}/resources/soap/deploy.wsdd"/> <!--clean up, no longer used-->
3258 </target>
3259
3260 <target name="soap-undeploy-site" depends="get-undeploy-service-name"
3261 description="Undeploy a SOAP web service for a local Greenstone site. Tomcat must be running for this to work.">
3262 <filter token="servicesname" value="${axis.undeploy.servicename}"/>
3263 <copy file="${basedir}/resources/soap/undeploy-site.wsdd.template"
3264 tofile="${basedir}/resources/soap/undeploy.wsdd"
3265 filtering="true"
3266 overwrite="true"/>
3267 <java classname="org.apache.axis.client.AdminClient">
3268 <classpath refid="compile.classpath"/>
3269 <arg value="-l"/>
3270 <arg value="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/servlet/AxisServlet"/>
3271 <arg file="${basedir}/resources/soap/undeploy.wsdd"/>
3272 </java>
3273 <delete file="${basedir}/resources/soap/undeploy.wsdd"/> <!--clean up, no longer used-->
3274 </target>
3275
3276 <!-- this target used to deploy the default web service SOAPServer (base.webservice.name) on the localsite server
3277 with the default servicename of localsite-->
3278 <target name="deploy-localsite" depends="init"
3279 description="Deploy the SOAP server for localsite. Will start and stop Tomcat.">
3280 <antcall target="force-start-tomcat"/>
3281 <echo>Deploying ${base.webservice.name} web services for localsite under service name: localsite</echo>
3282 <antcall target="create-deployment-files">
3283 <param name="axis.sitename" value="localsite"/>
3284 <param name="axis.servicesname" value="${base.webservice.name}"/>
3285 <param name="axis.siteuri" value="localsite"/>
3286 </antcall>
3287 <antcall target="deploy-site">
3288 <param name="axis.sitename" value="localsite"/>
3289 <param name="axis.servicesname" value="${base.webservice.name}"/>
3290 <param name="axis.siteuri" value="localsite"/>
3291 </antcall>
3292 <echo>The Greenstone server has been started up. If you do not want it running, please type: ant stop.</echo>
3293 </target>
3294
3295 <target name="get-sitename" unless="axis.sitename">
3296 <input addproperty="axis.sitename" defaultvalue="localsite">What site do you want to deploy services for?
3297Press Enter for default:localsite</input>
3298 </target>
3299
3300 <target name="get-undeploy-service-name" unless="axis.undeploy.servicename">
3301 <input addproperty="axis.undeploy.servicename" defaultvalue="localsite">Please enter the full name of the service you wish to undeploy.
3302To find out which web services you've got deployed, point your browser to ${default.server.protocol}://${tomcat.server}:${default.tomcat.port}/greenstone3/services
3303Or press Enter for undeploying the default:localsite /&gt;</input>
3304 <echo>Name of service to undeploy: ${axis.undeploy.servicename}</echo>
3305 </target>
3306
3307 <target name="get-webservices" unless="axis.servicesname">
3308 <input addproperty="axis.servicesname" defaultvalue="${base.webservice.name}">Which set of web services do you want to deploy?
3309Choose from: ${web.services.list}
3310Or press Enter for default:${base.webservice.name} /&gt;</input>
3311 <echo>${axis.servicesname}</echo>
3312 </target>
3313
3314 <target name="get-siteuri" depends="get-sitename,get-webservices" unless="axis.siteuri">
3315 <input addproperty="axis.siteuri" defaultvalue="${axis.servicesname}${axis.sitename}">What name do you want the service to have? (Press Enter for default:${axis.servicesname}${axis.sitename})</input>
3316 <echo>Site: ${axis.sitename}, services: ${axis.servicesname}, servicesname: ${axis.siteuri}</echo>
3317 </target>
3318
3319 <target name="set-soapmethod" description="Determines whether the service in the wsdd should have the style attribute set to message or the provider attribute set to java:RPC" if="axis.servicesname">
3320 <condition property="soap.method" value="provider='java:MSG' style='message' use='literal'">
3321 <equals arg1="${axis.servicesname}" arg2="${base.webservice.name}"/>
3322 </condition>
3323
3324 <!--everything else defaults to java:RPC at present-->
3325 <condition property="soap.method" value="provider='java:RPC'">
3326 <not>
3327 <equals arg1="${axis.servicesname}" arg2="${base.webservice.name}"/>
3328 </not>
3329 </condition>
3330 </target>
3331
3332 <target name="create-deployment-files" depends="set-soapmethod" if="axis.sitename">
3333 <filter token="sitename" value="${axis.sitename}"/>
3334 <filter token="siteuri" value="${axis.siteuri}"/>
3335 <filter token="servicesname" value="${axis.servicesname}"/>
3336 <filter token="soapmethod" value="${soap.method}"/>
3337 <copy file="${basedir}/resources/soap/site.wsdd.template"
3338 tofile="${basedir}/resources/soap/deploy.wsdd"
3339 filtering="true"
3340 overwrite="true"/>
3341 <!-- create the java files and compile them -->
3342 <copy file="${basedir}/resources/java/${axis.servicesname}.java.in"
3343 tofile="${src.gsdl3.home}/${axis.servicesname}${axis.sitename}.java"
3344 filtering="true"
3345 overwrite="true"/>
3346 <mkdir dir="${build.home}"/>
3347 <javac srcdir="${src.home}"
3348 destdir="${build.home}"
3349 includeantruntime="${compile.includeantruntime}"
3350 debug="${compile.debug}"
3351 deprecation="${compile.deprecation}"
3352 optimize="${compile.optimize}"
3353 encoding="${compile.encoding}">
3354 <compilerarg line="${compile.javac.flags}"/>
3355 <classpath refid="compile.classpath"/>
3356 <include name="org/greenstone/gsdl3/${axis.servicesname}${axis.sitename}.java" />
3357 </javac>
3358 <mkdir dir="${web.classes}/org/greenstone/gsdl3"/>
3359 <copy file="${build.home}/org/greenstone/gsdl3/${axis.servicesname}${axis.sitename}.class"
3360 tofile="${web.classes}/org/greenstone/gsdl3/${axis.servicesname}${axis.sitename}.class"
3361 overwrite="true" />
3362 </target>
3363
3364
3365 <!-- ====================== Core targets ============================== -->
3366 <!-- core targets refer to the core gsdl3 java src -->
3367
3368 <target name="prepare-core"/>
3369
3370 <target name="configure-core"/>
3371
3372 <target name="update-core" depends="init,svnupdate-core,clean-core,compile-core"
3373 description="Update only the Greenstone core" />
3374
3375 <target name="svnupdate-core" unless="nosvn.mode">
3376 <exec executable="svn">
3377 <arg value="update"/>
3378 <arg value="${basedir}"/>
3379 <arg value="-r"/><arg value="${branch.revision}"/>
3380 </exec>
3381 </target>
3382
3383 <target name="clean-core"
3384 description="Clean only the Greenstone core">
3385 <!-- should this delete the gsdl3.jar from web/WEB-INF?? -->
3386 <delete dir="${build.home}"/>
3387 </target>
3388
3389 <target name="compile-core" depends="needs-gs3-devel,init"
3390 description="Compile only the Greenstone core">
3391 <mkdir dir="${build.home}"/>
3392
3393 <if><bool><istrue value="${with.jni}"/></bool>
3394 <javac srcdir="${src.home}"
3395 destdir="${build.home}"
3396 includeantruntime="${compile.includeantruntime}"
3397 debug="${compile.debug}"
3398 deprecation="${compile.deprecation}"
3399 optimize="${compile.optimize}"
3400 encoding="${compile.encoding}">
3401 <compilerarg line="${compile.javac.flags}"/>
3402 <classpath>
3403 <path refid="compile.classpath"/>
3404 </classpath>
3405 </javac>
3406 <else>
3407 <property name="gsprefix" value=""/>
3408 <javac srcdir="${src.home}"
3409 destdir="${build.home}"
3410 includeantruntime="${compile.includeantruntime}"
3411 debug="${compile.debug}"
3412 deprecation="${compile.deprecation}"
3413 optimize="${compile.optimize}"
3414 encoding="${compile.encoding}">
3415 <compilerarg line="${compile.javac.flags}"/>
3416 <classpath>
3417 <path refid="compile.classpath"/>
3418 </classpath>
3419 <exclude name="org/greenstone/gsdl3/service/GS2MGPPRetrieve.java"/>
3420 <exclude name="org/greenstone/gsdl3/service/GS2MGPPSearch.java"/>
3421 <exclude name="org/greenstone/gsdl3/service/GS2MGSearch.java"/>
3422 <exclude name="org/greenstone/gsdl3/service/GS2MGRetrieve.java"/>
3423 <exclude name="org/greenstone/gsdl3/service/GoogleNgramMGPPSearch.java"/>
3424 <exclude name="org/greenstone/gsdl3/service/PhindPhraseBrowse.java"/>
3425 <exclude name="org/greenstone/gsdl3/util/GDBMWrapper.java"/>
3426 </javac>
3427 </else>
3428 </if>
3429 <jar destfile="${build.home}/gsdl3.jar">
3430 <fileset dir="${build.home}">
3431 <include name="org/greenstone/gsdl3/**"/>
3432 <include name="org/flax/**"/>
3433 <exclude name="**/Test.class"/>
3434 </fileset>
3435 <manifest>
3436 <attribute name="Built-By" value="${user.name}" />
3437 </manifest>
3438 </jar>
3439 <copy file="${build.home}/gsdl3.jar" todir="${web.lib}"/>
3440
3441 <antcall target="googlesignin-jar-with-dependencies" />
3442 <copy file="${build.home}/googlesignin-jdbcrealm.jar" todir="${catalina.home}/lib"/>
3443
3444 <jar destfile="${build.home}/gutil.jar">
3445 <fileset dir="${build.home}">
3446 <include name="org/greenstone/util/**"/>
3447 </fileset>
3448 <manifest>
3449 <attribute name="Built-By" value="${user.name}" />
3450 </manifest>
3451 </jar>
3452 <copy file="${build.home}/gutil.jar" todir="${web.lib}"/>
3453
3454 <!-- copy the localsite server in case we need it -->
3455 <copy file="${build.home}/org/greenstone/gsdl3/${base.webservice.name}localsite.class" tofile="${web.classes}/org/greenstone/gsdl3/${base.webservice.name}localsite.class" />
3456
3457 <!-- Greenstone Administrator Interface -->
3458 <jar destfile="${build.home}/GAI.jar">
3459 <fileset dir="${build.home}">
3460 <include name="org/greenstone/admin/**"/>
3461 </fileset>
3462 <manifest>
3463 <attribute name="Built-By" value="${user.name}" />
3464 </manifest>
3465 </jar>
3466 <copy file="${build.home}/GAI.jar" todir="${web.lib}"/>
3467 <copy file="${build.home}/GAI.jar" todir="${admin.dir}"/>
3468 <jar destfile="${build.home}/phind.jar">
3469 <fileset dir="${build.home}">
3470 <include name="org/greenstone/applet/phind/**"/>
3471 </fileset>
3472 <manifest>
3473 <attribute name="Built-By" value="${user.name}" />
3474 </manifest>
3475 </jar>
3476 <mkdir dir="${web.applet}"/>
3477 <copy file="${build.home}/phind.jar" todir="${web.applet}"/>
3478 <!-- phind also needs xercesImpl.jar and xml-apis.jar to be in web/applet -->
3479 <if>
3480 <bool><istrue value="${tomcat.islocal}"/></bool>
3481 <if><bool><available file="${catalina.home}/lib/xercesImpl.jar"/></bool><!-- moved for solr -->
3482 <copy file="${catalina.home}/lib/xercesImpl.jar" todir="${web.applet}"/>
3483 <copy file="${catalina.home}/lib/xml-apis.jar" todir="${web.applet}"/>
3484
3485 <else><!-- get from default GS3 web lib location-->
3486 <copy file="${web.lib}/xercesImpl.jar" todir="${web.applet}"/>
3487 <copy file="${web.lib}/xml-apis.jar" todir="${web.applet}"/>
3488 </else>
3489 </if>
3490 </if>
3491
3492
3493 <!-- skip anttasks for now
3494 <jar destfile="${build.home}/anttasks.jar">
3495 <fileset dir="${build.home}">
3496 <include name="org/greenstone/anttasks/**"/>
3497 </fileset>
3498 <manifest>
3499 <attribute name="Built-By" value="${user.name}" />
3500 </manifest>
3501 </jar>
3502 <copy file="${build.home}/anttasks.jar" todir="${basedir}/lib/java"/>-->
3503 <jar destfile="${build.home}/gsdl3test.jar">
3504 <fileset dir="${build.home}">
3505 <include name="org/greenstone/gsdl3/**/*Test.class"/>
3506 <include name="org/greenstone/testing/**"/>
3507 </fileset>
3508 <manifest>
3509 <attribute name="Built-By" value="${user.name}" />
3510 </manifest>
3511 </jar>
3512 <jar destfile="${build.home}/server.jar">
3513 <fileset dir="${build.home}">
3514 <include name="org/greenstone/server/**"/>
3515 <include name="org/greenstone/util/**"/>
3516 </fileset>
3517 <fileset file="${basedir}/resources/java/server.properties"/>
3518 <manifest>
3519 <attribute name="Built-By" value="${user.name}"/>
3520 </manifest>
3521 </jar>
3522 <copy file="${build.home}/server.jar" todir="${basedir}"/>
3523 </target>
3524
3525 <target name="googlesignin-checkforchanges" >
3526 <uptodate property="googlesignin-nochanges" targetfile="${build.home}/googlesignin-jdbcrealm.jar">
3527 <srcfiles dir="${build.home}" includes="org/greenstone/gsdl3/GoogleSigninJDBCRealm.class"/>
3528 </uptodate>
3529 </target>
3530
3531 <target name="googlesignin-jar-with-dependencies" depends="init,googlesignin-checkforchanges" unless="googlesignin-nochanges">
3532 <path id="googlesignin-jar-dependencies">
3533 <fileset dir="${web.lib}">
3534 <includesfile name="${jarsupport.home}/google-api-client-jars/jar-list.txt"/>
3535 </fileset>
3536 </path>
3537
3538 <unzip dest="${web.lib}/unjarred">
3539 <patternset>
3540 <exclude name="META-INF/*.SF"/>
3541 </patternset>
3542 <!-- fileset to include ... -->
3543 <path refid="googlesignin-jar-dependencies"/>
3544 </unzip>
3545
3546 <path id="googlesignin-unjarred">
3547 <fileset dir="${web.lib}/unjarred">
3548 </fileset>
3549 </path>
3550
3551 <jar destfile="${build.home}/googlesignin-jdbcrealm.jar">
3552 <fileset dir="${build.home}">
3553 <include name="org/greenstone/gsdl3/GoogleSigninJDBCRealm.class"/>
3554 </fileset>
3555 <fileset dir="${src.home}">
3556 <include name="org/greenstone/gsdl3/mbeans-descriptor.xml"/>
3557 </fileset>
3558 <path refid="googlesignin-unjarred" />
3559 <manifest>
3560 <attribute name="Built-By" value="${user.name}" />
3561 </manifest>
3562 </jar>
3563 <delete dir="${web.lib}/unjarred" quiet="true"/>
3564
3565 </target>
3566
3567 <!-- === Eclipse targets == -->
3568 <target name="setup-for-eclipse">
3569
3570 <filter token="gsdlhome" value="${gs2build.home}"/>
3571 <filter token="gsdl3srchome" value="${basedir}"/>
3572 <filter token="gsdl3home" value="${basedir}/web"/>
3573
3574 <if>
3575 <bool><not><available file="${basedir}/TransformingLibrary.launch"/></not></bool>
3576 <copy file="${basedir}/TransformingLibrary.launch.in" tofile="${basedir}/TransformingLibrary.launch" filtering="true" overwrite="true"/>
3577 </if>
3578<!--
3579 <if>
3580 <bool><not><available file="${basedir}/LibraryCommandline.launch"/></not></bool>
3581 <copy file="${basedir}/LibraryCommandline.launch.in" tofile="${basedir}/LibraryCommandline.launch" filtering="true" overwrite="true"/>
3582 </if>
3583-->
3584 </target>
3585
3586 <!-- ================== Packages targets ================================ -->
3587 <!-- these targets refer to the greenstone source packages - these need
3588 updating less often, so are in separate targets to the core -->
3589
3590 <target name="prepare-wget-for-windows">
3591 <exec executable="svn" osfamily="windows" dir="${basedir}/bin/windows">
3592 <arg value="export"/>
3593 <arg value="-r"/><arg value="${branch.revision}"/>
3594 <arg value="${svn.root}/main/${branch.path}/binaries/windows/bin/wget.exe"/>
3595 </exec>
3596 <exec executable="svn" osfamily="windows" dir="${basedir}/bin/windows">
3597 <arg value="export"/>
3598 <arg value="-r"/><arg value="${branch.revision}"/>
3599 <arg value="${svn.root}/main/${branch.path}/binaries/windows/bin/wgetrc"/>
3600 <arg value="wgetrc"/>
3601 </exec>
3602
3603 </target>
3604 <target name="prepare-packages" depends="init"/>
3605
3606 <target name="update-packages" depends="init,svnupdate-packages,configure-packages,clean-packages,compile-packages"
3607 description="Update only the source packages"/>
3608
3609 <target name="svnupdate-packages" unless="nosvn.mode">
3610 <exec executable="svn">
3611 <arg value="update"/>
3612 <arg value="${src.packages.home}"/>
3613 <arg value="-r"/><arg value="${branch.revision}"/>
3614 </exec>
3615 </target>
3616
3617 <target name="prepare-binaries" depends="prepare-bins-unix"/>
3618
3619 <target name="prepare-bins-unix" depends="init" if="current.os.isunix">
3620 <condition property="bitness.suffix" value="64" else="32">
3621 <matches string="${os.arch}" pattern="64"/>
3622 </condition>
3623 <condition property="os.folder.name" value="mac" else="linux"> <!-- checkout from dir: mac or linux -->
3624 <equals arg1="${os.bin.dir}" arg2="darwin" trim="true"/>
3625 </condition>
3626 <mkdir dir="${gs2build.home}/bin/${os.bin.dir}"/> <!-- mkdir darwin or linux -->
3627 <exec executable="svn" dir="${gs2build.home}/bin/${os.bin.dir}">
3628 <arg value="export"/>
3629 <arg value="-r"/><arg value="${branch.revision}"/>
3630 <arg value="${svn.root}/main/${branch.path}/binaries/${os.folder.name}/yaz/yaz-client-x${bitness.suffix}"/> <!-- checkout from dir: mac or linux -->
3631 <arg value="yaz-client"/>
3632 </exec>
3633 </target>
3634
3635 <target name="configure-packages" depends="init,configure-javagdbm"
3636 description="Configure only the packages."/>
3637
3638 <target name="configure-javagdbm" if="${with.jni}">
3639 <echo>
3640 Configuring JavaGDBM
3641 </echo>
3642
3643 <exec executable="${javagdbm.home}/configure" os="${os.unix}" dir="${javagdbm.home}" failonerror="true">
3644 <arg value="--prefix=${basedir}"/>
3645 <arg value="--libdir=${lib.jni}"/>
3646 <arg value="--with-gdbm=${gdbm.home}"/>
3647 <arg line="${cross.configure.args}"/>
3648 </exec>
3649 </target>
3650
3651 <target name="clean-packages" depends="init,clean-javagdbm" description="Clean only the packages"/>
3652
3653 <target name="clean-javagdbm" depends="init">
3654 <if><bool><available file="${javagdbm.home}/Makefile"/></bool>
3655 <exec executable="make" os="${os.unix}"
3656 dir="${javagdbm.home}" failonerror="true">
3657 <arg value="clean"/>
3658 </exec>
3659 </if>
3660 </target>
3661
3662 <target name="distclean-packages" depends="init,distclean-javagdbm" description="Distclean only the packages"/>
3663
3664 <target name="distclean-javagdbm" depends="init">
3665 <if><bool><available file="${javagdbm.home}/Makefile"/></bool>
3666 <exec executable="make" os="${os.unix}"
3667 dir="${javagdbm.home}" failonerror="true">
3668 <arg value="distclean"/>
3669 </exec>
3670 </if>
3671 </target>
3672
3673 <target name="compile-packages" description="Compile only the source packages">
3674 <!-- javagdbm -->
3675 <antcall target="compile-javagdbm"/>
3676 <!-- Search4j -->
3677 <antcall target="compile-search4j"/>
3678 </target>
3679
3680 <target name="compile-javagdbm" description="Compile JavaGDBM" if="${with.jni}">
3681
3682 <!-- unix: -->
3683 <echo>compile javagdbm</echo>
3684 <exec executable="make" os="${os.unix}" dir="${javagdbm.home}" failonerror="true">
3685 <arg value="JAVACOPTIONS=-encoding UTF8"/>
3686 <env key="JAVA_HOME" path="${env.JAVA_HOME}"/>
3687 </exec>
3688 <exec executable="make" os="${os.unix}" dir="${javagdbm.home}" failonerror="true">
3689 <arg value="install"/>
3690 </exec>
3691
3692 <!-- windows: Calling without the "compile" argument first will run winMake.bat with
3693 "all" which will then perform both the compile AND link targets in jni/win32.mak
3694 (thereby also generating gdbmjava.dll). Then we run the same command with
3695 the "install" argument to copy the gdbmjava.dll into the correct location. -->
3696 <echo>Windows: compile javagdbm</echo>
3697 <exec executable="${javagdbm.home}/winMake.bat" osfamily="windows" dir="${javagdbm.home}" failonerror="true">
3698 <env key="JAVA_HOME" path="${env.JAVA_HOME}"/>
3699 <env key="GSDL3SRCHOME" path="${basedir}"/>
3700 </exec>
3701 <exec executable="${javagdbm.home}/winMake.bat" osfamily="windows" dir="${javagdbm.home}" failonerror="true">
3702 <env key="GSDL3SRCHOME" path="${basedir}"/>
3703 <arg value="install"/>
3704 </exec>
3705
3706 <!-- install the jar file -->
3707 <echo>Install the javagdbm jar file ${javagdbm.home}/javagdbm.jar ${lib.jni}</echo>
3708 <copy file="${javagdbm.home}/javagdbm.jar" todir="${lib.jni}"/>
3709 </target>
3710
3711 <target name="compile-search4j">
3712
3713 <!-- windows -->
3714 <if><bool><istrue value="${current.os.iswindows}"/></bool>
3715 <exec executable="nmake" dir="${src.packages.home}/search4j" failonerror="true">
3716 <arg value="/f"/>
3717 <arg value="win32.mak"/>
3718 <arg value='BINDIR="${basedir}\bin"'/>
3719 <arg value='LIBDIR="${basedir}\lib"'/>
3720 </exec>
3721 <exec executable="nmake" dir="${src.packages.home}/search4j" failonerror="true">
3722 <arg value="/f"/>
3723 <arg value="win32.mak"/>
3724 <arg value="install"/>
3725 <arg value='BINDIR="${basedir}\bin"'/>
3726 <arg value='LIBDIR="${basedir}\lib"'/>
3727 </exec>
3728
3729 <!-- unix -->
3730 <else><if><bool><istrue value="${current.os.isunix}"/></bool>
3731 <exec executable="${src.packages.home}/search4j/configure" dir="${src.packages.home}/search4j" failonerror="true">
3732 <arg value="--bindir=${basedir}/bin"/>
3733 <arg value="--libdir=${basedir}/lib"/>
3734 <arg value="${static.arg}"/>
3735 <arg line="${cross.configure.args}"/>
3736 </exec>
3737 <exec executable="make" dir="${src.packages.home}/search4j" failonerror="true"/>
3738 <exec executable="make" dir="${src.packages.home}/search4j" failonerror="true">
3739 <arg value="install"/>
3740 </exec>
3741
3742 <!-- else warn -->
3743 <else>
3744 <fail>this target does not support the current os</fail>
3745
3746 </else></if></else></if>
3747
3748 </target>
3749
3750 <target name="install-auxiliary-jar-files" depends="init">
3751
3752 <if>
3753 <bool><available file="${mg.home}/mg.jar"/></bool>
3754 <copy file="${mg.home}/mg.jar" todir="${lib.jni}"/>
3755 </if>
3756
3757 <if>
3758 <bool><available file="${mgpp.home}/mgpp.jar"/></bool>
3759 <copy file="${mgpp.home}/mgpp.jar" todir="${lib.jni}"/>
3760 </if>
3761
3762 <copy file="${lucene.home}/LuceneWrapper4.jar" todir="${web.lib}"/>
3763 </target>
3764
3765 <target name="install-jni-files" depends="init" if="${with.jni}">
3766 <antcall target="install-jni-files-linux"/>
3767 <antcall target="install-jni-files-windows"/>
3768 <antcall target="install-jni-files-macos"/>
3769 </target>
3770
3771 <target name="install-jni-files-linux" depends="init" if="current.os.isunixnotmac">
3772
3773 <if>
3774
3775 <bool><equals arg1="${os.bin.dir}" arg2="windows"/></bool>
3776 <!-- cross compiling to windows -->
3777 <copy file="${mg.home}/jni/mgretrievejni.dll" todir="${lib.jni}"/>
3778 <copy file="${mg.home}/jni/mgsearchjni.dll" todir="${lib.jni}"/>
3779 <copy file="${mg.home}/jni/mgpassjni.dll" todir="${lib.jni}"/>
3780 <copy file="${mgpp.home}/jni/mgppretrievejni.dll" todir="${lib.jni}"/>
3781 <copy file="${mgpp.home}/jni/mgppsearchjni.dll" todir="${lib.jni}"/>
3782 <copy file="${mgpp.home}/jni/mgpppassjni.dll" todir="${lib.jni}"/>
3783
3784 <else>
3785 <!-- otherwise do the usual Unix copies -->
3786 <copy file="${mg.home}/jni/libmgretrievejni.so" todir="${lib.jni}"/>
3787 <copy file="${mg.home}/jni/libmgsearchjni.so" todir="${lib.jni}"/>
3788 <copy file="${mg.home}/jni/libmgpassjni.so" todir="${lib.jni}"/>
3789 <copy file="${mgpp.home}/jni/libmgppretrievejni.so" todir="${lib.jni}"/>
3790 <copy file="${mgpp.home}/jni/libmgppsearchjni.so" todir="${lib.jni}"/>
3791 <copy file="${mgpp.home}/jni/libmgpppassjni.so" todir="${lib.jni}"/>
3792 </else>
3793 </if>
3794
3795
3796 </target>
3797 <target name="install-jni-files-windows" depends="init" if="current.os.iswindows">
3798 <copy file="${mg.home}/jni/mgretrievejni.dll" todir="${lib.jni}"/>
3799 <copy file="${mg.home}/jni/mgsearchjni.dll" todir="${lib.jni}"/>
3800 <copy file="${mg.home}/jni/mgpassjni.dll" todir="${lib.jni}"/>
3801 <copy file="${mgpp.home}/jni/mgppretrievejni.dll" todir="${lib.jni}"/>
3802 <copy file="${mgpp.home}/jni/mgppsearchjni.dll" todir="${lib.jni}"/>
3803 <copy file="${mgpp.home}/jni/mgpppassjni.dll" todir="${lib.jni}"/>
3804 </target>
3805 <target name="install-jni-files-macos" depends="init" if="current.os.ismac">
3806 <copy file="${mg.home}/jni/libmgretrievejni.jnilib" todir="${lib.jni}"/>
3807 <copy file="${mg.home}/jni/libmgsearchjni.jnilib" todir="${lib.jni}"/>
3808 <copy file="${mg.home}/jni/libmgpassjni.jnilib" todir="${lib.jni}"/>
3809 <copy file="${mgpp.home}/jni/libmgppretrievejni.jnilib" todir="${lib.jni}"/>
3810 <copy file="${mgpp.home}/jni/libmgppsearchjni.jnilib" todir="${lib.jni}"/>
3811 <copy file="${mgpp.home}/jni/libmgpppassjni.jnilib" todir="${lib.jni}"/>
3812 </target>
3813
3814 <!-- ========common-src targets =================================-->
3815 <!-- these are used to get common-src (for indexers, gdbm, sqlite etc) when
3816 collection building is not enabled -->
3817
3818 <target name="update-common-src" depends="init" if="collection.building.disabled">
3819 </target>
3820
3821 <target name="svnupdate-common-src" depends="init" if="collection.building.disabled" unless="nosvn.mode">
3822 <exec executable="svn">
3823 <arg value="update"/>
3824 <arg value="${common.src.home}"/>
3825 <arg value="-r"/><arg value="${branch.revision}"/>
3826 </exec>
3827 </target>
3828
3829 <target name="prepare-common-src" depends="init" if="collection.building.disabled" unless="common.src.present">
3830 <antcall target="checkout-common-src"/>
3831 <antcall target="unzip-windows-packages"/>
3832 </target>
3833
3834 <target name="checkout-common-src" depends="init" if="collection.building.disabled" unless="nosvn.mode">
3835 <echo>checking out common-src</echo>
3836 <exec executable="svn">
3837 <arg value="checkout"/>
3838 <arg value="${svn.root}/main/${branch.path}/greenstone2/common-src"/>
3839 <arg value="common-src"/>
3840 <arg value="-r"/><arg value="${branch.revision}"/>
3841 </exec>
3842 </target>
3843
3844 <target name="configure-common-src" depends="envbased-gnomelib-allargs-prop,init">
3845<!--
3846 <echo>cross configure args: ${cross.configure.args}</echo>
3847-->
3848 <exec executable="${common.src.home}/configure" os="${os.unix}"
3849 dir="${common.src.home}" failonerror="true">
3850 <arg value="--prefix=${common.src.binhome}"/> <!-- what value to use?? -->
3851 <arg value="--bindir=${common.src.binhome}/bin/${os.bin.dir}"/> <!-- what value to use?? -->
3852 <arg line="${gs2.opt.args}"/>
3853 <arg line="${static.arg}"/>
3854 <arg line="${cross.configure.args}"/>
3855 <arg line="${allargs}"/>
3856 </exec>
3857 </target>
3858
3859 <target name="clean-common-src" depends="init">
3860 <!-- unix: -->
3861 <if><bool><available file="${common.src.home}/Makefile"/></bool>
3862 <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
3863 <arg value="clean"/>
3864 </exec>
3865 </if>
3866 <!-- windows: -->
3867 <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
3868 <arg value="/f"/>
3869 <arg value="win32.mak"/>
3870 <arg value="clean"/>
3871 <arg value="GSDLHOME=${common.src.binhome}"/>
3872 </exec>
3873 </target>
3874 <target name="distclean-common-src" depends="init">
3875 <!-- unix: -->
3876 <if><bool><available file="${common.src.home}/Makefile"/></bool>
3877 <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
3878 <arg value="distclean"/>
3879 </exec>
3880 </if>
3881 <!-- windows: distclean = clean + remove configure products (remove makefiles). But on Windows there is no removing makefiles, so we just call clean -->
3882 <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
3883 <arg value="/f"/>
3884 <arg value="win32.mak"/>
3885 <arg value="clean"/>
3886 <arg value="GSDLHOME=${common.src.binhome}"/>
3887 </exec>
3888 </target>
3889 <target name="compile-common-src" depends="needs-gs3-devel,envbased-devel-props,init">
3890 <!-- unix: -->
3891 <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
3892 <arg value="${gs2.compile.target}"/>
3893 <arg value="JAVA_HOME=${env.JAVA_HOME}"/>
3894 </exec>
3895 <!-- windows: -->
3896 <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
3897 <arg value="/f"/>
3898 <arg value="win32.mak"/>
3899 <arg value="VISUAL_STUDIO_MAJORVERSION=${visualstudio.majorversion}"/>
3900 <arg value="JAVA_HOME=${env.JAVA_HOME}"/>
3901
3902 <arg value="GSDLHOME=${common.src.binhome}"/>
3903 <arg value="ENABLE_JNI=${gs2.windows.enablejni}"/>
3904 <arg value="ENABLE_MG=${gs2.windows.enablemg}"/>
3905 <arg value="ENABLE_MGPP=${gs2.windows.enablemgpp}"/>
3906 <arg value="USE_GDBM=${gs2.windows.usegdbm}"/>
3907 <arg value="USE_SQLITE=${gs2.windows.usesqlite}"/>
3908 </exec>
3909 </target>
3910
3911 <!-- ======= collection-building targets ===========================-->
3912
3913 <target name="update-collection-building" if="collection.building.enabled"
3914 depends="init,svnupdate-collection-building,gs2build-edit-setup-bat,configure-common-src,clean-common-src,compile-common-src,clean-collection-building,configure-collection-building,compile-collection-building"
3915 description="Update (SVN update, configure, compile etc) only the collection building components"/>
3916
3917 <target name="svnupdate-collection-building" if="collection.building.enabled" depends="init,svnupdate-gs2build,svnupdate-gli" unless="nosvn.mode"
3918 description="SVN update the collection building components">
3919 </target>
3920
3921 <target name="prepare-collection-building" depends="init,prepare-gs2build,prepare-gli" if="collection.building.enabled">
3922 </target>
3923
3924 <target name="configure-collection-building" depends="init,configure-build-src" if="collection.building.enabled"
3925 description="Configure the collection building components">
3926 </target>
3927
3928 <target name="clean-collection-building" depends="init,clean-gli,clean-build-src"
3929 description="Clean only the collection building components"
3930 if="collection.building.enabled"/>
3931
3932 <target name="distclean-collection-building" depends="init,clean-build-src,distclean-build-src"
3933 description="Distclean only the collection building components"
3934 if="collection.building.enabled"/>
3935
3936 <target name="compile-collection-building" depends="needs-gs3-devel,envbased-devel-props,init,compile-build-src,compile-gli" if="collection.building.enabled"
3937 description="Compile only the collection building components">
3938 <!-- make install for common-src -->
3939 <!-- unix: -->
3940 <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
3941 <arg value="${gs2.install.target}"/>
3942 </exec>
3943
3944 <!-- windows: -->
3945 <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
3946 <arg value="/f"/>
3947 <arg value="win32.mak"/>
3948 <arg value="install"/>
3949 <arg value="VISUAL_STUDIO_MAJORVERSION=${visualstudio.majorversion}"/>
3950 <arg value="GSDLHOME=${gs2build.home}"/>
3951 <arg value="ENABLE_JNI=${gs2.windows.enablejni}"/>
3952 <arg value="ENABLE_MG=${gs2.windows.enablemg}"/>
3953 <arg value="ENABLE_MGPP=${gs2.windows.enablemgpp}"/>
3954 <arg value="USE_GDBM=${gs2.windows.usegdbm}"/>
3955 <arg value="USE_SQLITE=${gs2.windows.usesqlite}"/>
3956 <!--
3957 <arg value="ENABLE_JNI=${gs2.windows.enablejni}"/>
3958 <arg value="USE_SQLITE=0"/>--> <!-- why is this not on by default? -->
3959 </exec>
3960
3961 <!-- install gs2build indexers for windows -->
3962 <if>
3963 <bool><istrue value="${current.os.iswindows}"/></bool>
3964 <copy todir="${gs2build.home}/bin/windows">
3965 <fileset dir="${gs2build.home}/common-src/indexers/bin">
3966 <include name="*.*"/>
3967 </fileset>
3968 </copy>
3969 </if>
3970
3971 <!-- LuceneWrapper jar file not installed by default -->
3972 <mkdir dir="${gs2build.home}/bin/java"/>
3973 <copy file="${lucene.home}/LuceneWrapper4.jar" todir="${gs2build.home}/bin/java"/>
3974
3975 </target>
3976
3977 <!-- ============== gli targets ================================= -->
3978
3979 <target name="svnupdate-gli" if="collection.building.enabled" depends="init" unless="nosvn.mode">
3980
3981 <exec executable="svn">
3982 <arg value="update"/>
3983 <arg value="${gli.home}"/>
3984 <arg value="-r"/><arg value="${branch.revision}"/>
3985 </exec>
3986
3987 </target>
3988
3989 <target name="prepare-gli" depends="init" if="collection.building.enabled" unless="gli.present">
3990 <!-- checkout -->
3991 <if><bool><and><not><istrue value="${nosvn.mode}"/></not><isset property="with.gli.and.gems"/></and></bool>
3992
3993 <exec executable="svn">
3994 <arg value="checkout"/>
3995 <arg value="${svn.root}/main/${branch.path}/gli"/>
3996 <arg value="-r"/><arg value="${branch.revision}"/>
3997 </exec>
3998
3999 </if>
4000 </target>
4001
4002 <target name="clean-gli" depends="init" if="collection.building.enabled">
4003 <!-- gli -->
4004 <property name="gli.home" value="${basedir}/gli"/>
4005 <!-- linux -->
4006 <exec executable="clean.sh" os="${os.unix}" dir="${gli.home}"
4007 resolveExecutable="true" failonerror="true"/>
4008 <!-- windows -->
4009 <exec executable="clean.bat" osfamily="windows" dir="${gli.home}"
4010 resolveExecutable="true" failonerror="true"/>
4011 </target>
4012
4013 <target name="compile-gli" depends="needs-gs3-devel,init" if="collection.building.enabled">
4014 <if><bool><isset property="with.gli.and.gems"/></bool>
4015 <!-- gli -->
4016 <property name="gli.home" value="${basedir}/gli"/>
4017
4018 <!-- linux -->
4019 <exec executable="makegli.sh" os="${os.unix}" dir="${gli.home}" resolveExecutable="true" failonerror="true"/>
4020 <!--remote gli-->
4021 <exec executable="makejar.sh" os="${os.unix}" dir="${gli.home}"
4022 resolveExecutable="true" failonerror="true"/>
4023 <!-- windows -->
4024 <exec executable="makegli.bat" osfamily="windows" dir="${gli.home}" resolveExecutable="true" failonerror="true"/>
4025 <!--remote gli-->
4026 <exec executable="makejar.bat" osfamily="windows" dir="${gli.home}"
4027 resolveExecutable="true" failonerror="true"/>
4028 <copy file="${gli.home}/GLIServer.jar" todir="${gs2build.home}/bin/java" />
4029 </if>
4030 </target>
4031
4032 <target name="gli" description="Run the Greenstone Librarian Interface" depends="init" if="collection.building.enabled">
4033 <exec executable="${basedir}/gli/gli.sh" os="${os.linux},${os.solaris}" dir="${basedir}/gli" spawn="true">
4034 <env key="gsdl3path" path="${basedir}"/>
4035 <env key="gsdlpath" path="${gs2build.home}"/>
4036 </exec>
4037 <exec executable="${basedir}/gli/gli.sh" os="${os.mac}" dir="${basedir}/gli" spawn="true">
4038 <env key="gsdl3path" path="${basedir}"/>
4039 <env key="gsdlpath" path="${gs2build.home}"/>
4040 <env key="DYLD_LIBRARY_PATH" path="${env.DYLD_LIBRARY_PATH}:${gdbm.home}/lib"/>
4041 </exec>
4042 <exec executable="${basedir}/gli/gli.bat" osfamily="windows" dir="${basedir}/gli" spawn="true">
4043 <env key="GSDL3PATH" path="${basedir}"/>
4044 <env key="GSDLPATH" path="${gs2build.home}"/>
4045 </exec>
4046 <echo>Running GLI from Ant means that you don't get to see any of the terminal output. If you have problems with GLI and want to see the output, please run the script gli.sh/bat from the greenstone3/gli directory.
4047 </echo>
4048 </target>
4049
4050 <!-- ================ gs2build targets =========================== -->
4051
4052 <target name="svnupdate-gs2build" if="collection.building.enabled" depends="init" unless="nosvn.mode">
4053 <echo>svn updating gs2build</echo>
4054 <exec executable="svn">
4055 <arg value="update"/>
4056 <arg value="${gs2build.home}"/>
4057 <arg value="-r"/><arg value="${branch.revision}"/>
4058 </exec>
4059 </target>
4060
4061 <target name="prepare-gs2build" depends="init" if="collection.building.enabled" unless="gs2build.present">
4062 <antcall target="checkout-gs2build"/>
4063 <antcall target="prepare-pdfbox"/>
4064 <antcall target="prepare-imagemagick"/> <!-- has to be done before calling prepare-gnome-lib -->
4065 <antcall target="prepare-gnome-lib"/>
4066 <antcall target="unzip-windows-packages"/>
4067 <antcall target="checkout-winbin"/>
4068 <antcall target="get-windows-binaries"/>
4069 <antcall target="delete-winbin"/>
4070 </target>
4071
4072 <target name="checkout-gs2build" depends="init" if="collection.building.enabled" unless="nosvn.mode">
4073 <echo>checking out gs2build</echo>
4074 <exec executable="svn">
4075 <arg value="checkout"/>
4076 <arg value="${svn.root}/main/${branch.path}/gs2build"/>
4077 <arg value="-r"/><arg value="${branch.revision}"/>
4078 </exec>
4079 </target>
4080
4081 <!-- Gets the PDFBox extension into gs2build/ext if checkout.pdfbox.ext is set to true in build.properties
4082 (which it is by default) -->
4083 <target name="prepare-pdfbox" depends="init" if="collection.building.enabled">
4084 <if>
4085 <bool>
4086 <istrue value="${checkout.pdfbox.ext}"/>
4087 </bool>
4088
4089 <property name="pdfbox.ext.dir" value="${gs2build.home}/ext/pdf-box"/>
4090 <condition property="pdfbox.ext.present">
4091 <available file="${pdfbox.ext.dir}" type="dir" />
4092 </condition>
4093
4094 <!-- get the pdfbox tar.gz file if we don't already have it and extract it if there's no pdf-box directory in gs2build/ext-->
4095 <if>
4096 <bool>
4097 <not><istrue value="${pdfbox.ext.present}"/></not>
4098 </bool>
4099
4100 <if>
4101 <bool>
4102 <not><istrue value="${gs2build.home}/ext/pdf-box-java.tar.gz"/></not>
4103 </bool>
4104
4105 <echo>Checking out the PDFBox extension into the GSDLHOME extension area</echo>
4106 <exec executable="svn">
4107 <arg value="export"/>
4108 <arg value="${svn.root}/gs2-extensions/pdf-box/trunk/pdf-box-java.tar.gz"/>
4109 <arg value="${gs2build.home}/ext/pdf-box-java.tar.gz"/>
4110 </exec>
4111 </if>
4112
4113 <echo>Extacting the PDFBox extension into the GSDLHOME extension area</echo>
4114 <untar compression="gzip"
4115 src="${gs2build.home}/ext/pdf-box-java.tar.gz"
4116 dest="${gs2build.home}/ext"/>
4117
4118 <delete file="${gs2build.home}/ext/pdf-box-java.tar.gz"/>
4119
4120 <else>
4121 <echo>The PDFBox extension already exists at ${pdfbox.ext.dir}</echo>
4122 </else>
4123 </if>
4124
4125 <else>
4126 <echo>**** Not preparing the PDFBox extension:</echo>
4127 <echo>The property checkout.pdfbox.ext in build.properties was not set or was set to false</echo>
4128 </else>
4129 </if>
4130 </target>
4131
4132 <target name="prepare-imagemagick" depends="init" if="collection.building.enabled">
4133 <if>
4134 <bool>
4135 <istrue value="${checkout.imagemagick.ext}"/>
4136 </bool>
4137
4138 <antcall target="checkout-imagemagick"/>
4139 <!--Compilation of imagemagick now happens during ant install, still before configuring the src code, as before -->
4140
4141 <else>
4142 <echo>**** Not preparing imagemagick:</echo>
4143 <echo>property checkout.imagemagick.ext in build.properties was not set or was set to false</echo>
4144 </else>
4145 </if>
4146 </target>
4147
4148 <target name="checkout-imagemagick" depends="init" if="collection.building.enabled" unless="nosvn.mode">
4149
4150 <property name="imagemagick.src.dir" value="${gs2build.home}/ext/imagemagick"/>
4151 <condition property="imagemagick.src.present">
4152 <available file="${imagemagick.src.dir}" type="dir" />
4153 </condition>
4154
4155 <if>
4156 <bool>
4157 <not><istrue value="${imagemagick.src.present}"/></not>
4158 </bool>
4159
4160 <echo>checking out imagemagick source into the extension area</echo>
4161
4162 <exec executable="svn">
4163 <arg value="checkout"/>
4164 <arg value="${svn.root}/gs2-extensions/imagemagick/trunk/src"/>
4165 <arg value="${imagemagick.src.dir}"/>
4166 </exec>
4167
4168 <else>
4169 <echo>imagemagick source code already exists at ${imagemagick.src.dir}</echo>
4170 </else>
4171 </if>
4172 </target>
4173
4174 <!-- Compile up imagemagick src folder if: the checkout.imagemagick.ext flag is turned on, if the imagick source code exists and if hasn't already been compiled up, then compile it up. Later can check if a gs-specific binary version has been installed already, in which case compilation won't be necessary. -->
4175 <target name="compile-imagemagick" if="${checkout.imagemagick.ext}">
4176
4177 <property name="imagemagick.src.dir" value="${gs2build.home}/ext/imagemagick"/>
4178 <property name="imagemagick.compiled.dir" value="${gs2build.home}/ext/imagemagick/${os.bin.dir}"/>
4179
4180 <condition property="imagemagick.src.present.firstcheck">
4181 <available file="${imagemagick.src.dir}" type="dir" />
4182 </condition>
4183 <condition property="imagemagick.compiled.present">
4184 <available file="${imagemagick.compiled.dir}" type="dir"/>
4185 </condition>
4186 <!--<condition property="imagemagick.bin.present">
4187 <available file="${basedir}/wherever/the/imgmagick/binary/is/to/be/found" type="dir" />
4188 </condition>-->
4189
4190 <!-- imagemagick will only be checked out if the user set the checkout.imagemagick.ext in build.properties -->
4191 <if>
4192 <bool>
4193 <isfalse value="${imagemagick.src.present.firstcheck}"/>
4194 </bool>
4195 <antcall target="checkout-imagemagick"/>
4196 </if>
4197
4198 <!-- keep track of whether the imagemagick src is now indeed present. Need to know this for a subsequent test -->
4199 <condition property="imagemagick.src.present">
4200 <available file="${imagemagick.src.dir}" type="dir" />
4201 </condition>
4202
4203 <if>
4204 <bool>
4205 <and>
4206 <istrue value="${imagemagick.src.present}"/> <!-- imagemagick src code is present -->
4207 <isfalse value="${imagemagick.compiled.present}"/> <!-- imagemagick src not compiled yet, so no imagemagick/os subfolder yet -->
4208 </and>
4209 </bool>
4210 <!-- then compile it. Only necessary for mac/linux, since windows has a stable working binary of imagemagick -->
4211 <exec executable="/bin/bash" dir="${imagemagick.src.dir}" failonerror="true">
4212 <arg value="CASCADE-MAKE.sh"/>
4213 </exec>
4214 </if>
4215 </target>
4216
4217
4218 <!-- If not on windows, then compile up gnome-lib src folder if:
4219 checkout.gnomelib.ext is turned on,
4220 and if not using the binary version (gnome-lib-minimal),
4221 and if the gnome-lib src folder is not already compiled up. -->
4222 <target name="compile-gnome-lib" if="${checkout.gnomelib.ext}" unless="current.os.iswindows">
4223
4224 <!-- http://stackoverflow.com/questions/3290307/sourcing-a-shell-profile-in-an-ant-build-file
4225 TODO: CASCADE-MAKE already sources devel.bash, but we still want to source it more globally,
4226 so that the rest of the GS3 compilation process also has access to those env variables -->
4227
4228 <property name="gnome.lib.src.dir" value="${basedir}/gs2build/ext/gnome-lib"/>
4229 <property name="gnome.lib.compiled.dir" value="${basedir}/gs2build/ext/gnome-lib/${os.bin.dir}"/>
4230
4231 <condition property="gnome.src.lib.present.firstcheck" value="true" else="false">
4232 <available file="${gnome.lib.src.dir}" type="dir" />
4233 </condition>
4234 <condition property="gnome.compiled.lib.present" value="true" else="false">
4235 <available file="${gnome.lib.compiled.dir}" type="dir"/>
4236 </condition>
4237 <condition property="gnome.lib.min.present" value="true" else="false">
4238 <available file="${basedir}/gs2build/ext/gnome-lib-minimal" type="dir" />
4239 </condition>
4240
4241 <!-- Make sure to checkout gnome-lib if it was not checked out at this stage
4242 since we're instructed to do so in th pre-condition to this target -->
4243 <if>
4244 <bool>
4245 <and>
4246 <isfalse value="${gnome.lib.min.present}"/>
4247 <isfalse value="${gnome.src.lib.present.firstcheck}"/>
4248 </and>
4249 </bool>
4250 <antcall target="checkout-gnome-lib"/>
4251 </if>
4252
4253 <!-- Keep track of whether we have the gnome-lib src folder now. Need to know this for a subsequent test -->
4254 <condition property="gnome.src.lib.present" value="true" else="false">
4255 <available file="${gnome.lib.src.dir}" type="dir" />
4256 </condition>
4257
4258 <!--<echo>MIN: ${gnome.lib.min.present}
4259 SRC LIB: ${gnome.src.lib.present}
4260 COMPILED: ${gnome.compiled.lib.present}</echo>-->
4261
4262 <if>
4263 <bool>
4264 <and>
4265 <isfalse value="${gnome.lib.min.present}"/> <!-- no gnome-lib-minimal binary present -->
4266 <istrue value="${gnome.src.lib.present}"/> <!-- gnome-lib folder for compilation is present-->
4267 <isfalse value="${gnome.compiled.lib.present}"/> <!-- gnome-lib not yet compiled, so no gnome-lib/os subfolder yet -->
4268 </and>
4269 </bool>
4270
4271 <!-- then compile it. Only necessary for mac/linux, since windows doesn't need gnome lib -->
4272 <exec executable="/bin/bash" dir="${gnome.lib.src.dir}" failonerror="true">
4273 <arg value="CASCADE-MAKE.sh"/>
4274 </exec>
4275 </if>
4276 </target>
4277
4278
4279 <target name="prepare-gnome-lib" depends="init" if="collection.building.enabled" unless="gnome-lib.present">
4280 <if>
4281 <bool><istrue value="${checkout.gnomelib.ext}"/></bool>
4282 <if>
4283 <bool><istrue value="${current.os.iswindows}"/></bool>
4284
4285 <echo>Skipping prepare-gnome-lib, because compilation is on Windows which checks out binaries that do not rely on gnomelib</echo>
4286 <else>
4287 <!-- current.os.isunix -->
4288
4289 <antcall target="checkout-gnome-lib"/>
4290 <!--Compilation of gnome-lib happens during ant install, just before configuring (common-src and) build-src-->
4291
4292 </else>
4293 </if>
4294 <else>
4295 <if><bool><istrue value="${current.os.isunix}"/></bool>
4296 <!-- current.os.isunix and checkout.gnomelib.ext not turned on -->
4297 <echo>**** Not preparing gnome-lib:</echo>
4298 <echo>property checkout.gnomelib.ext in build.properties was not set or was set to false.</echo>
4299 </if>
4300 </else>
4301 </if>
4302 </target>
4303
4304
4305 <target name="checkout-gnome-lib" depends="init" if="collection.building.enabled" unless="nosvn.mode">
4306
4307 <property name="gnomelib.src.dir" value="${basedir}/gs2build/ext/gnome-lib"/>
4308 <condition property="gnome.src.present">
4309 <available file="${gnomelib.src.dir}" type="dir" />
4310 </condition>
4311
4312 <if>
4313 <bool>
4314 <not><istrue value="${gnome.src.present}"/></not>
4315 </bool>
4316
4317 <echo>checking out gnome-lib extension</echo>
4318 <exec executable="svn">
4319 <arg value="checkout"/>
4320 <arg value="${svn.root}/gs2-extensions/gnome-lib/trunk/src"/>
4321 <arg value="${gs2build.home}/ext/gnome-lib"/>
4322 </exec>
4323
4324 <else>
4325 <echo>gnomelib source code already exists at ${gnomelib.src.dir}</echo>
4326 </else>
4327 </if>
4328
4329 </target>
4330
4331 <target name="checkout-winbin" depends="init" if="current.os.iswindows"
4332 unless="nosvn.mode">
4333
4334 <exec executable="svn">
4335 <arg value="checkout"/>
4336 <arg value="${svn.root}/main/${branch.path}/binaries/windows"/>
4337 <arg value="-r"/><arg value="${branch.revision}"/>
4338 <arg value="winbin"/>
4339 </exec>
4340
4341 </target>
4342
4343 <target name="update-winbin" depends="init" if="current.os.iswindows" unless="nosvn.mode">
4344 <exec executable="svn">
4345 <arg value="update"/>
4346 <arg value="winbin"/>
4347 <arg value="-r"/><arg value="${branch.revision}"/>
4348 </exec>
4349
4350 </target>
4351
4352 <target name="get-windows-binaries" depends="init" if="collection.building.enabled.windows">
4353 <move todir="${gs2build.home}/bin/windows" failonerror="false">
4354 <fileset dir="${basedir}/winbin/bin"/>
4355 </move>
4356 </target>
4357
4358 <target name="delete-winbin" depends="init" if="collection.building.enabled.windows">
4359 <delete dir="${basedir}/winbin"/>
4360 </target>
4361
4362 <target name="unzip-windows-packages" depends="envbased-devel-props,init" if="current.os.iswindows">
4363 <unzip src="${common.src.home}/packages/windows/crypt/crypt.zip"
4364 dest="${common.src.home}/packages/windows/crypt"/>
4365 <untar compression="gzip"
4366 src="${common.src.home}/packages/sqlite/${sqlite.targz.version}"
4367 dest="${common.src.home}/packages/sqlite"/>
4368 <untar compression="gzip"
4369 src="${common.src.home}/packages/expat/${expat.targz.version}"
4370 dest="${common.src.home}/packages/expat"/>
4371 <untar compression="gzip"
4372 src="${common.src.home}/packages/jdbm/${jdbm.targz.version}"
4373 dest="${common.src.home}/packages/jdbm"/>
4374 <if>
4375 <bool>
4376 <islessthan arg1="${visualstudio.majorversion}" arg2="14"/>
4377 </bool>
4378 <echo>Unzipping Pre-VS14.0 compatible version of iconv</echo>
4379 <unzip src="${common.src.home}/indexers/packages/windows/iconv/iconv-PRE-VS14.zip"
4380 dest="${common.src.home}/indexers/packages/windows/iconv"/>
4381 <else>
4382 <echo>Unzipping VS14.0-Plus compatible version of iconv</echo>
4383 <unzip src="${common.src.home}/indexers/packages/windows/iconv/iconv-VS14-PLUS.zip"
4384 dest="${common.src.home}/indexers/packages/windows/iconv"/>
4385 </else>
4386 </if>
4387
4388 </target>
4389
4390 <target name="gs2build-edit-setup-bat" if="collection.building.enabled.windows">
4391 <!-- we want a windows path in the setup.bat file -->
4392 <pathconvert targetos="windows" property="gs2build.home.windows">
4393 <path path="${gs2build.home}"/>
4394 </pathconvert>
4395 <move file="${gs2build.home}/setup.bat" tofile="${gs2build.home}/setup-tmp.bat">
4396 <filterset>
4397 <filter token="gsdlhome" value="${gs2build.home.windows}"/>
4398 </filterset>
4399 </move>
4400 <move file="${gs2build.home}/setup-tmp.bat" tofile="${gs2build.home}/setup.bat" />
4401 </target>
4402
4403
4404 <target name="clean-build-src" depends="init" if="collection.building.enabled">
4405 <!-- unix: -->
4406 <if><bool><available file="${build.src.home}/Makefile"/></bool>
4407 <exec executable="make" os="${os.unix}" dir="${build.src.home}" failonerror="true">
4408 <arg value="clean"/>
4409 </exec>
4410 </if>
4411 <!-- windows: -->
4412 <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
4413 <arg value="/f"/>
4414 <arg value="win32.mak"/>
4415 <arg value="clean"/>
4416 <arg value="GSDLHOME=${gs2build.home}"/>
4417 </exec>
4418 </target>
4419
4420
4421 <target name="distclean-build-src" depends="init,clean-build-src" if="collection.building.enabled">
4422 <!-- unix: -->
4423 <if><bool><available file="${build.src.home}/Makefile"/></bool>
4424 <exec executable="make" os="${os.unix}" dir="${build.src.home}" failonerror="true">
4425 <arg value="distclean"/>
4426 </exec>
4427 </if>
4428 <!-- windows: distclean = clean + remove configure products (remove makefiles). But on Windows there is no removing makefiles, so we just call clean -->
4429 <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
4430 <arg value="/f"/>
4431 <arg value="win32.mak"/>
4432 <arg value="clean"/>
4433 <arg value="GSDLHOME=${gs2build.home}"/>
4434 </exec>
4435 </target>
4436
4437 <target name="configure-build-src" depends="envbased-gnomelib-allargs-prop,init" if="collection.building.enabled"
4438 description="Configure the build-src component">
4439 <exec executable="${build.src.home}/configure" os="${os.unix}"
4440 dir="${build.src.home}" failonerror="true">
4441 <arg value="--prefix=${gs2build.home}"/>
4442 <arg line="${gs2.opt.args} ${static.arg} ${cross.configure.args} ${allargs}"/>
4443 </exec>
4444 </target>
4445
4446 <!-- common-src is done separately and needs to be compiled first -->
4447 <target name="compile-build-src" depends="needs-gs3-devel,init" if="collection.building.enabled">
4448
4449 <exec executable="make" dir="${build.src.home}" os="${os.unix}" failonerror="true">
4450 <!-- <arg line="${ldlpath.arg}"/> -->
4451 <env key="LD_LIBRARY_PATH" value="${env.LD_LIBRARY_PATH}"/> <!--changed to specifying through 'env' rather than arg with ldlpath.arg -->
4452 </exec>
4453
4454 <exec executable="make" dir="${build.src.home}" os="${os.unix}" failonerror="true">
4455 <env key="GSDLOS" value="${os.bin.dir}"/>
4456 <arg value="install"/>
4457 </exec>
4458
4459 <!-- run the setup script -->
4460 <!-- <exec executable="${compile.windows.c++.setup}" osfamily="windows" failonerror="true"/>-->
4461 <!--Above does not work: even though vcvars.bat executes, the env changes it makes don't get saved. Need user to run vcvars.bat first before calling ant-->
4462 <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
4463 <arg value="/f"/>
4464 <arg value="win32.mak"/>
4465 <arg value="GSDLHOME=${gs2build.home}"/>
4466 </exec>
4467 <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
4468 <arg value="/f"/>
4469 <arg value="win32.mak"/>
4470 <arg value="install"/>
4471 <arg value="GSDLHOME=${gs2build.home}"/>
4472 </exec>
4473 </target>
4474
4475
4476 <!-- ======================== TESTING Targets ========================= -->
4477
4478 <target name="test" description="Run the (incomplete) JUnit test suite "
4479 depends="init">
4480 <mkdir dir="${basedir}/test"/>
4481 <junit printsummary="withOutAndErr"
4482 errorproperty="test.failed"
4483 failureproperty="test.failed"
4484 fork="${junit.fork}">
4485 <formatter type="plain"/>
4486 <classpath>
4487 <pathelement location="${build.home}/gsdl3test.jar"/>
4488 <path refid="compile.classpath"/>
4489 </classpath>
4490 <test name="${testcase}" if="testcase"/>
4491 <batchtest todir="${basedir}/test" unless="testcase">
4492 <fileset dir="${build.home}" includes="**/*Test.class" />
4493 </batchtest>
4494 </junit>
4495 <echo>
4496 *********************************************
4497 Test output can be found in directory 'test'
4498 *********************************************
4499 </echo>
4500 </target>
4501
4502 <!-- ======================== FLAX Targets ========================= -->
4503 <target name="prepare-flax" description="check out flax source code from another repository" if="install.flax">
4504 <echo>checking out flax ...</echo>
4505 <mkdir dir="${basedir}/src/java/org/flax"/>
4506 <mkdir dir="${basedir}/src/java/org/greenstone/gsdl3/flax"/>
4507 <mkdir dir="${basedir}/src/java/org/greenstone/gsdl3/action/flax"/>
4508 <mkdir dir="${web.home}/WEB-INF/classes/flax"/>
4509 <mkdir dir="${web.home}/interfaces/flax"/>
4510 <mkdir dir="${web.home}/sites/flax"/>
4511 <mkdir dir="${basedir}/flax-resources"/>
4512 <mkdir dir="${basedir}/flax-lib"/>
4513 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/src/java/org/flax"/>
4514 <arg value="src/java/org/flax"/></exec>
4515 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/src/java/org/greenstone/gsdl3/flax"/>
4516 <arg value="src/java/org/greenstone/gsdl3/flax"/></exec>
4517 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/src/java/org/greenstone/gsdl3/action/flax"/>
4518 <arg value="src/java/org/greenstone/gsdl3/action/flax"/></exec>
4519 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/web/WEB-INF/classes/flax"/>
4520 <arg value="${web.home}/WEB-INF/classes/flax"/></exec>
4521 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/web/interfaces/flax"/>
4522 <arg value="${web.home}/interfaces/flax"/></exec>
4523 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/web/sites/flax"/>
4524 <arg value="${web.home}/sites/flax"/></exec>
4525 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/flax-resources"/>
4526 <arg value="flax-resources"/></exec>
4527 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/lib"/>
4528 <arg value="flax-lib"/></exec>
4529 <antcall target="flax-copy-del-files" />
4530 </target>
4531
4532 <target name="flax-copy-del-files" description="copy some flax files into the appropriate greenstone3 directories and delete some unwanted greenstone stuff">
4533 <copy file="${web.home}/WEB-INF/classes/flax/flax.xml" todir="${web.home}/WEB-INF" overwrite="true" />
4534 <copy todir="${web.home}/WEB-INF/classes" overwrite="true" >
4535 <fileset dir="${web.home}/WEB-INF/classes/flax">
4536 <include name="interface_flax*.properties"/>
4537 </fileset>
4538 </copy>
4539 <copy todir="${web.home}/WEB-INF/lib">
4540 <fileset dir="${basedir}/flax-lib">
4541 <include name="*.jar"/>
4542 </fileset>
4543 </copy>
4544 <!--<delete dir="${web.home}/sites/gateway"/>
4545 <delete dir="${web.home}/sites/localsite"/>-->
4546 </target>
4547
4548 <target name="update-flax" description="update flax from repository">
4549 <echo>updating flax ...</echo>
4550 <exec executable="svn"><arg value="update"/>
4551 <arg value="src/java/org/flax"/></exec>
4552 <exec executable="svn"><arg value="update"/>
4553 <arg value="src/java/org/greenstone/gsdl3/action/flax"/></exec>
4554 <exec executable="svn"><arg value="update"/>
4555 <arg value="src/java/org/greenstone/gsdl3/flax"/></exec>
4556 <exec executable="svn"><arg value="update"/>
4557 <arg value="${web.home}/WEB-INF/classes/flax"/></exec>
4558 <exec executable="svn"><arg value="update"/>
4559 <arg value="${web.home}/interfaces/flax"/></exec>
4560 <exec executable="svn"><arg value="update"/>
4561 <arg value="${web.home}/web/sites/flax"/></exec>
4562 <exec executable="svn"><arg value="update"/>
4563 <arg value="flax-resources"/></exec>
4564 <exec executable="svn"><arg value="update"/>
4565 <arg value="flax-lib"/></exec>
4566 <antcall target="compile-core" />
4567 </target>
4568
4569 <!-- ========================End of FLAX Targets ========================= -->
4570
4571 <target name="compile-javadocs">
4572 <javadoc packagenames="org.greenstone.*"
4573 sourcepath="src/java"
4574 defaultexcludes="yes"
4575 destdir="docs/javadoc"
4576 author="true"
4577 version="true"
4578 use="true"
4579 windowtitle="Greenstone3 API">
4580 <doctitle><![CDATA[<h1>Greenstone3 API</h1>]]></doctitle>
4581 </javadoc>
4582 </target>
4583
4584<!-- ========== Some distribution targets ======================== -->
4585 <target name="remove-source">
4586 <if><bool><isset property="with.gli.and.gems"/></bool>
4587 <delete includeEmptyDirs="true">
4588 <fileset dir="." defaultexcludes="false">
4589 <patternset refid="greenstone3.source.component"/>
4590 </fileset>
4591 </delete>
4592
4593 <else>
4594 <delete includeEmptyDirs="true">
4595 <fileset dir="." defaultexcludes="false">
4596 <patternset refid="greenstone3.source.no.gli.component"/>
4597 </fileset>
4598 </delete>
4599 </else>
4600 </if>
4601 </target>
4602
4603 <target name="dist-tidy"
4604 description="'tidies-up' a greenstone3 installation for distribution."
4605 unless="${properties.keep.src}">
4606
4607 <!-- delete unneeded things -->
4608 <delete dir="${packages.home}/axis"/>
4609 <delete><fileset dir="${packages.home}" includes="*.zip"/></delete>
4610 <delete file="README-SVN.txt"/>
4611 <delete file="build.properties.svn"/>
4612
4613 <!-- delete source files -->
4614 <antcall target="remove-source"/>
4615
4616 <!-- create empty directories -->
4617 <mkdir dir="${web.writablehome}/applet"/>
4618 <mkdir dir="${web.writablehome}/logs"/>
4619 <mkdir dir="${web.writablehome}/logs/tmp"/>
4620
4621 <!-- Lines with ***** are commented out because these files are useful if we want hybrid installations -->
4622
4623 <!-- os specific tidy-ups -->
4624 <!-- linux, mac -->
4625 <if><bool><istrue value="${current.os.isunix}"/></bool>
4626 <!--*****<delete><fileset dir="." includes="*.bat"/></delete>-->
4627 <if><bool><isset property="with.gli.and.gems"/></bool>
4628 <!--*****<delete><fileset dir="gli" includes="*.bat"/></delete>-->
4629 </if>
4630 <!--*****<delete><fileset dir="gs2build" includes="*.bat"/></delete>-->
4631 <!--*****<delete><fileset dir="bin/script" includes="*.bat"/></delete>-->
4632 <delete file="${basedir}/gs2build/win32cfg.h"/>
4633 <delete file="${basedir}/gs2build/win32.mak"/>
4634 <delete dir="${basedir}/winutil"/>
4635 <delete failonerror="false"><fileset dir="${lib.jni}" includes="*.dll"/></delete>
4636
4637 <!-- windows -->
4638 <else><if><bool><istrue value="${current.os.iswindows}"/></bool>
4639 <!--*****<delete><fileset dir="." includes="*.sh,*.bash,*.csh"/></delete>-->
4640 <if><bool><isset property="with.gli.and.gems"/></bool>
4641 <!--*****<delete><fileset dir="gli" includes="*.sh,*.bash,*.csh"/></delete>-->
4642 </if>
4643 <!--*****<delete><fileset dir="gs2build" includes="*.sh,*.bash,*.csh"/></delete>-->
4644 <!--*****<delete><fileset dir="bin/script" includes="*.sh,*.bash,*.csh"/></delete>-->
4645 </if></else></if>
4646
4647 </target>
4648
4649 <!-- fix up executable permissions for binary release -->
4650 <target name="fix-execute-permissions">
4651 <echo>Setting binaries to executable</echo>
4652 <chmod perm="775">
4653 <fileset dir="."><patternset refid="greenstone3.executables"/></fileset>
4654 </chmod>
4655 </target>
4656
4657 <!-- fix up executable permissions for source code release -->
4658 <target name="fix-execute-permissions-source">
4659 <chmod perm="775">
4660 <fileset dir="."><patternset refid="greenstone3.source.executables"/></fileset>
4661 </chmod>
4662 </target>
4663
4664 <!-- for macs, set up the .app shortcuts to gsi, gli, client-gli and gems -->
4665 <target name="gen-mac-shortcuts">
4666 <exec executable="uname" dir="${basedir}" failonerror="false"
4667 outputproperty="darwin.kernel.version">
4668 <arg value="-r"/>
4669 </exec>
4670
4671 <echo>darwin kernel version: ${darwin.kernel.version}</echo>
4672
4673 <if>
4674 <bool><matches string="${darwin.kernel.version}" pattern="^([0-9]|1[0-8])\."/></bool>
4675 <property name="mac.app.bitness" value="32"/>
4676 <else>
4677 <property name="mac.app.bitness" value="64"/>
4678 </else>
4679 </if>
4680
4681 <echo>bitness for mac apps: ${mac.app.bitness}</echo>
4682
4683 <!--(recursively) copy the .app files from the MacShortcutsXbit folder of the correct bitness
4684 https://stackoverflow.com/questions/1685442/how-to-copy-a-directory-using-ant -->
4685 <copy todir="${basedir}" >
4686 <fileset dir="${basedir}/MacShortcuts${mac.app.bitness}bit" includes="**"/>
4687 </copy>
4688
4689 <if><bool><istrue value="${current.os.ismac}"/></bool>
4690 <filter token="gsdl3srchome" value="${basedir}"/>
4691 <copy file="${basedir}/gs3-server.app/Contents/document.wflow.in" tofile="${basedir}/gs3-server.app/Contents/document.wflow" filtering="true" overwrite="true"/>
4692 <copy file="${basedir}/gli.app/Contents/document.wflow.in" tofile="${basedir}/gli.app/Contents/document.wflow" filtering="true" overwrite="true"/>
4693 <copy file="${basedir}/client-gli.app/Contents/document.wflow.in" tofile="${basedir}/client-gli.app/Contents/document.wflow" filtering="true" overwrite="true"/>
4694 <copy file="${basedir}/gems.app/Contents/document.wflow.in" tofile="${basedir}/gems.app/Contents/document.wflow" filtering="true" overwrite="true"/>
4695 </if>
4696 </target>
4697
4698 <!-- ============= tweaks for making compilation static ========== -->
4699 <target name="tweak-makefiles" depends="init" if="compile.static">
4700 <antcall target="rtftohtml-add-static" />
4701 </target>
4702
4703 <target name="rtftohtml-add-static" depends="init" if="collection.building.enabled">
4704 <rsr verbosity="1" file="${gs2build.home}/build-src/packages/rtftohtml/rtftohtml_src/Makefile" pattern="-o rtftohtml(.{2})EXEEXT(.{1})" replacement="-o rtftohtml$1EXEEXT$2 -static" />
4705 </target>
4706
4707 <target name="run-collection-tests">
4708 <if><bool><not><available file="${basedir}/ext/testing" type="dir"/></not></bool>
4709 <fail>The testing extension is not available. This is required to perform the tests. It can be acquired from SVN by running the command "svn co https://svn.greenstone.org/gs3-extensions/testing/trunk/src testing" in the ext directory of your Greenstone 3 installation. </fail>
4710 </if>
4711 <for param="testjar">
4712 <path>
4713 <fileset dir="${basedir}" includes="web/sites/*/collect/*/tests/tests.jar"/>
4714 </path>
4715 <sequential>
4716 <echo>Testing @{testjar}</echo>
4717 <java classname="org.junit.runner.JUnitCore" fork="true">
4718 <!--https://stackoverflow.com/questions/38676719/selenium-using-java-the-path-to-the-driver-executable-must-be-set-by-the-webdr-->
4719 <sysproperty key="webdriver.gecko.driver" path="${basedir}/ext/testing/geckodriver"/>
4720 <arg value="gstests.TestClass"/>
4721 <jvmarg value="-DSERVERURL=${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}${server.default.servlet} "/>
4722 <classpath>
4723 <fileset dir="${basedir}/ext/testing/lib/java">
4724 <include name="*.jar"/>
4725 </fileset>
4726 <files includes="@{testjar}"/>
4727 </classpath>
4728 </java>
4729 </sequential>
4730 </for>
4731 </target>
4732
4733 <target name="build-collection-tests">
4734 <if><bool><not><available file="${basedir}/ext/testing" type="dir"/></not></bool>
4735 <fail>The testing extension is not available. This is required to perform the tests. It can be acquired from SVN by running the command "svn co https://svn.greenstone.org/gs3-extensions/testing/trunk/src testing" in the ext directory of your Greenstone 3 installation. </fail>
4736 </if>
4737 <for param="compiledir">
4738 <path>
4739 <dirset dir="${basedir}" includes="web/sites/*/collect/*/tests/src"/>
4740 </path>
4741 <sequential>
4742 <echo>Compiling @{compiledir}</echo>
4743 <if><bool><not><available file="@{compiledir}/../build" type="dir"/></not></bool>
4744 <mkdir dir="@{compiledir}/../build"/>
4745 </if>
4746 <javac srcdir="@{compiledir}"
4747 destdir="@{compiledir}/../build"
4748 includeantruntime="${compile.includeantruntime}"
4749 debug="${compile.debug}"
4750 deprecation="${compile.deprecation}"
4751 optimize="${compile.optimize}"
4752 encoding="${compile.encoding}">
4753 <compilerarg line="${compile.javac.flags}"/>
4754 <classpath>
4755 <fileset dir="${basedir}/ext/testing/lib/java">
4756 <include name="*.jar"/>
4757 </fileset>
4758 </classpath>
4759 <include name="gstests/*.java"/>
4760 </javac>
4761 <jar destfile="@{compiledir}/../tests.jar">
4762 <fileset dir="@{compiledir}/../build">
4763 <include name="gstests/**"/>
4764 </fileset>
4765 <manifest>
4766 <attribute name="Built-By" value="${user.name}" />
4767 </manifest>
4768 </jar>
4769 </sequential>
4770 </for>
4771 </target>
4772</project>
Note: See TracBrowser for help on using the repository browser.