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

Last change on this file since 37137 was 37137, checked in by davidb, 16 months ago

Revision in property name, along with changes after testing the new revproxy.protocol, revproxy.domain properties
File size: 217.2 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,unpack-cgimodule"
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-revproxy-servlet-url">
1218 <if><bool><isset property="revproxy.opt_port"/></bool>
1219 <property name="revproxy.colon_opt_port" value=":${revproxy.opt_port}"/>
1220 <else>
1221 <property name="revproxy.colon_opt_port" value=""/>
1222 </else>
1223 </if>
1224 <if><bool><isset property="revproxy.context"/></bool>
1225 <property name="revproxy.app.path" value="/${revproxy.context}"/>
1226 <else>
1227 <property name="revproxy.app.path" value="${app.path}"/>
1228 </else>
1229 </if>
1230
1231
1232 <echo>${revproxy.protocol}://${revproxy.domain}${revproxy.colon_opt_port}${revproxy.app.path}${server.default.servlet}</echo>
1233 </target>
1234
1235 <target name="get-default-servlet-url">
1236 <echo>${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}${server.default.servlet}</echo>
1237 </target>
1238
1239
1240 <!-- returns the base local URL, something like HTTP://127.0.0.1:<HTTPport>
1241 or some sane equivalent for 127.0.0.1 -->
1242 <target name="get-local-base-http-url">
1243 <echo>${local.http.url}</echo>
1244 </target>
1245 <!-- Returns something like HTTP://127.0.0.1:<HTTPport>/greenstone3/library -->
1246 <target name="get-local-http-servlet-url">
1247 <echo>${local.http.url}${app.path}${server.default.servlet}</echo>
1248 </target>
1249
1250 <target name="get-internal-servlet-url">
1251 <antcall target="get-local-http-servlet-url" />
1252 </target>
1253
1254 <target name="get-external-servlet-url">
1255 <if><bool><isset property="revproxy.domain"/></bool>
1256 <antcall target="get-revproxy-servlet-url"/>
1257 <else>
1258 <antcall target="get-default-servlet-url"/>
1259 </else>
1260 </if>
1261 </target>
1262
1263 <!-- solr should only be accessible locally, which therefore also means only over http.
1264 Note that for http, 127.0.0.1 is safer than localhost (as localhost can be mapped to something
1265 other than 127.0.0.1). See also https://letsencrypt.org/docs/certificates-for-localhost/ -->
1266 <target name="get-solr-servlet-url">
1267 <!--<echo>${default.server.protocol}://${tomcat.server}:${default.tomcat.port}/${solr.context}</echo>-->
1268 <echo>${local.http.url}/${solr.context}</echo>
1269 </target>
1270
1271 <target name="check-derbyserver-running">
1272 <condition property="derby.isrunning" value="true" else="false">
1273 <!--<socket server="jdbc:derby://${derby.server}" port="${derby.server.port}"/>-->
1274 <socket server="${derby.server}" port="${derby.server.port}"/><!-- like telnet machine port -->
1275 </condition>
1276 <echo>Derby is running: ${derby.isrunning}</echo>
1277 </target>
1278
1279 <!-- Need a copy of the check-derby-running target with a distinct property, because ant restart runs
1280 both stop and start, which stop and start derby respectively. Both need check the derby socket.
1281 Because each property can be set only once during an invocation with ant, ant restart will need
1282 two check-derbyserver properties, one for each derby check. -->
1283 <target name="check-derbyserver-started">
1284 <condition property="derby.isstarted" value="true" else="false">
1285 <socket server="${derby.server}" port="${derby.server.port}"/>
1286 </condition>
1287 <echo>Derby is running: ${derby.isstarted}</echo>
1288 </target>
1289
1290
1291 <!-- Unused -->
1292 <target name="start-derby-java" depends="check-derbyserver-running">
1293 <if><bool><not><istrue value="${derby.isrunning}"/></not></bool>
1294 <echo>Launching derby on ${derby.server}:${derby.server.port}...</echo>
1295 <java classname="org.apache.derby.drda.NetworkServerControl" fork="true" spawn="true" clonevm="true">
1296 <arg value="start"/>
1297 <classpath refid="derby.server.classpath"/>
1298 </java>
1299 <else>
1300 <echo>Derby server ALREADY RUNNING on ${derby.server}:${derby.server.port}</echo>
1301 </else>
1302 </if>
1303 </target>
1304
1305 <target name="start-derby" depends="check-derbyserver-started">
1306 <if><bool><not><istrue value="${derby.isstarted}"/></not></bool>
1307 <echo>About to launch derby on ${derby.server}:${derby.server.port}</echo>
1308 <antcall target="force-start-derby"/>
1309 <else>
1310 <echo>Derby networked server ALREADY RUNNING on ${derby.server}:${derby.server.port}</echo>
1311 </else>
1312 </if>
1313 </target>
1314
1315 <!-- Using derby 10.1.2.1
1316 See db-derby-10.1.2.1-bin/docs/html/adminguide/index.html -->
1317 <target name="force-start-derby">
1318 <property name="derby.server.classpath.prop" refid="derby.server.classpath" />
1319 <!-- During the installer, launching java directly fails on systems that don't have java installed.
1320 Forcing force-start-derby to always use packages/jre/bin/java is wrong too: as gs3-setup does
1321 a lot of work of determining the correct JRE_HOME/JAVA_HOME (not necessarily the GS3 bundled JRE)
1322 and we want to be consistent in using the same java throughout. Solution:
1323 Refer to the JRE used in executing this ant file, which for installers will always be the bundled one.
1324 https://stackoverflow.com/questions/17571595/env-java-home-not-found-ant -->
1325 <exec executable="${java.home}/bin/java" spawn="true"><!-- failonerror="true"-->
1326 <env key="CLASSPATH" path="${derby.server.classpath.prop}"/>
1327 <arg value="org.apache.derby.drda.NetworkServerControl"/>
1328 <arg value="start"/>
1329 <arg value="-p"/>
1330 <arg value="${derby.server.port}"/>
1331 </exec>
1332
1333 </target>
1334
1335 <target name="force-stop-derby">
1336 <java classname="org.apache.derby.drda.NetworkServerControl">
1337 <arg value="shutdown"/>
1338 <arg value="-p"/>
1339 <arg value="${derby.server.port}"/>
1340 <classpath refid="derby.server.classpath"/>
1341 </java>
1342 </target>
1343
1344 <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 -->
1345 <if><bool><istrue value="${derby.isrunning}"/></bool>
1346 <!--<echo>Derby is |${derby.isrunning}| running</echo>-->
1347 <antcall target="force-stop-derby"/>
1348 <else>
1349 <echo>Derby is not running</echo>
1350 </else>
1351 </if>
1352 </target>
1353
1354 <target name="start" depends="needs-gs3-setup,init,configure-tomcat,configure-web,configure-solr-ext,configure-webswing-ext,start-derby,start-tomcat"
1355 description="Startup the Tomcat server." >
1356 <echo>${app.name} (${app.version}) server running using Apache Tomcat and Java</echo>
1357 <echo>Tomcat: ${catalina.home}</echo>
1358 <echo>Java : ${java.home}</echo>
1359 <if><bool><available file="${build.src.home}"/></bool>
1360 <echo>Perl : ${full.perl.path}</echo>
1361 </if>
1362 <if><bool><isset property="install.flax"/></bool>
1363 <property name="url" value="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/flax"/>
1364 <else>
1365 <property name="url" value="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/"/>
1366 </else>
1367 </if>
1368 <echo>URL : ${url}</echo>
1369 <!-- assuming that index.html is not needed here -->
1370
1371 <!--Now write out the url with /oaiserver suffix as the baseURL property in OAIConfig.xml-->
1372 <antcall target="init-oaiconfigs">
1373 <param name="url" value="${url}"/>
1374 </antcall>
1375
1376 <!--Now write out the url with /gs-cantaloupe suffix as the baseURL property in IIIFConfig.xml-->
1377 <available file="${basedir}/resources/iiif/IIIFConfig.xml.in" property="iiifconfig.present"/>
1378 <antcall target="init-iiifconfig">
1379 <param name="url" value="${url}"/>
1380 </antcall>
1381
1382 </target>
1383
1384 <target name="status" depends="check-derbyserver-running,verbose-check-tomcat-running">
1385 </target>
1386
1387 <available file="${basedir}/resources/oai/OAIConfig.xml.in" property="oaiconfig.present"/>
1388
1389 <target name="init-oaiconfigs" if="oaiconfig.present">
1390 <echo>Generating new oaiconfigs for servlets ${oai.servlets} </echo>
1391 <foreach list="${oai.servlets}" delimiter="," target="init-oaiconfig" param="servlet_name"/>
1392 </target>
1393
1394 <target name="init-oaiconfig">
1395 <if><bool><not><available file="${basedir}/resources/oai/OAIConfig-${servlet_name}.xml.in"/></not></bool>
1396 <echo>Copying file ${basedir}/resources/oai/OAIConfig.xml.in to ${basedir}/resources/oai/OAIConfig-${servlet_name}.xml.in</echo>
1397 <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>
1398 <copy file="${basedir}/resources/oai/OAIConfig.xml.in" tofile="${basedir}/resources/oai/OAIConfig-${servlet_name}.xml.in"/>
1399 </if>
1400 <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>
1401 <copy file="${basedir}/resources/oai/OAIConfig-${servlet_name}.xml.in" tofile="${web.writableclasses}/OAIConfig-${servlet_name}.xml"/>
1402 <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;" />
1403 </target>
1404
1405 <target name="init-iiifconfig" if="iiifconfig.present">
1406 <echo>Writing out baseURL ${url}gs-cantaloupe to ${web.writableclasses}/IIIFConfig.xml</echo>
1407 <copy file="${basedir}/resources/iiif/IIIFConfig.xml.in" tofile="${web.writableclasses}/IIIFConfig.xml"/>
1408 <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;" />
1409 </target>
1410
1411 <target name="stop" depends="init,stop-tomcat,stop-derby"
1412 description="Shutdown the Tomcat server."/>
1413
1414 <target name="restart" description="Shutdown and restart Tomcat" depends="init,stop,start"/>
1415
1416 <!-- =========== Help targets =================================== -->
1417
1418 <property name="install-command" value="ant [options] prepare install"/>
1419
1420 <target name="usage" description="Print a help message">
1421 <echo message=" Execute 'ant -projecthelp' for a list of targets."/>
1422 <echo message=" Execute 'ant -help' for Ant help."/>
1423 <echo>
1424 To install Greenstone3, run '${install-command}'.
1425 There are properties defined in build.properties. The install
1426 process will ask you if these properties are set correctly.
1427 To avoid this prompt, use the '-Dproperties.accepted=yes'
1428 option.
1429 To log the output, use the '-logfile build.log' option.
1430 The README.txt file has more information about the ant targets
1431 and install process.
1432 </echo>
1433 </target>
1434
1435 <target name="help" depends="usage" description="Print a help message"/>
1436
1437 <target name="debug" depends="init" description="Display all the currently used properties">
1438 <echoproperties/>
1439 </target>
1440
1441 <!-- ====== initialization and setup targets ================== -->
1442
1443 <target name="accept-properties" unless="properties.accepted">
1444 <input addproperty="properties.ok" validargs="y,n">The following properties (among others) are being used from a build.properties file found in this directory:
1445 server.protocols=${server.protocols}
1446 tomcat.server=${tomcat.server}
1447 tomcat.port.https=${tomcat.port.https}
1448 localhost.port.http=${localhost.port.http}
1449
1450 default.server.protocol=${default.server.protocol}
1451 default.tomcat.port=${default.tomcat.port}
1452 Local base HTTP URL used by Greenstone: ${local.http.url}
1453
1454 tomcat.installed.path=${tomcat.installed.path} (this is the location of Tomcat's base dir if it is already installed)
1455 proxy.host=${proxy.host}
1456 proxy.port=${proxy.port}
1457 disable.collection.building=${disable.collection.building}
1458 If these are not acceptable, please change them and rerun this target. Continue [y/n]?
1459 </input>
1460 <condition property="do.abort">
1461 <equals arg1="n" arg2="${properties.ok}"/>
1462 </condition>
1463 <fail if="do.abort">Build aborted by user. Please change your properties settings and re-run the target</fail>
1464 </target>
1465
1466 <!-- this sets up some initial properties -->
1467 <target name="init">
1468
1469 <condition property="java.too.old">
1470 <or>
1471 <equals arg1="1.1" arg2="${java.specification.version}"/>
1472 <equals arg1="1.2" arg2="${java.specification.version}"/>
1473 <equals arg1="1.3" arg2="${java.specification.version}"/>
1474 <equals arg1="1.4" arg2="${java.specification.version}"/>
1475 <equals arg1="1.5" arg2="${java.specification.version}"/>
1476 <equals arg1="1.6" arg2="${java.specification.version}"/>
1477 <equals arg1="1.7" arg2="${java.specification.version}"/>
1478 </or>
1479 </condition>
1480 <fail if="java.too.old" message="You need Java 1.8 or greater to run Greenstone 3"/>
1481
1482 <available file="${basedir}/gli" property="gli.present"/>
1483 <available file="${basedir}/common-src" property="common.src.present"/>
1484 <available file="${basedir}/gs2build" property="gs2build.present"/>
1485 <available file="${gnome-lib-dir}" property="gnome-lib.present"/>
1486
1487 <condition property="tomcat.islocal">
1488 <or>
1489 <not><isset property="tomcat.installed.path"/></not>
1490 <equals arg1="" arg2="${tomcat.installed.path}"/>
1491 </or>
1492 </condition>
1493
1494 <condition property="proxy.present">
1495 <and>
1496 <isset property="proxy.host"/>
1497 <not><equals arg1="" arg2="${proxy.host}"/></not>
1498 </and>
1499 </condition>
1500
1501 <!--
1502 the next block checks if the bundled tomcat is present in the 'packages' directory,
1503 and checks for the lethal combination of tomcat 8 and java 1.4. Test for
1504 tomcat6 is based on the presence of a file inserted by greenstone into the tomcat6
1505 download, as there is no other surefire way to check tomcat version under java 1.4
1506 -->
1507 <condition property="packages.tomcat.ispresent" value="true" else="false">
1508 <available file="packages/tomcat"/>
1509 </condition>
1510 <condition property="packages.tomcat.istomcat8" value="true" else="false">
1511 <available file="packages/tomcat/tomcat8.txt"/>
1512 </condition>
1513 <if>
1514 <bool>
1515 <and>
1516 <istrue value="${packages.tomcat.ispresent}"/>
1517 <istrue value="${packages.tomcat.istomcat8}"/>
1518 <equals arg1="1.4" arg2="${java.specification.version}"/>
1519 </and>
1520 </bool>
1521 <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>
1522 </if>
1523
1524 </target>
1525
1526 <target name="setup-proxy" depends="init" if="proxy.present">
1527 <condition property="ask.user">
1528 <or>
1529 <equals arg1="" arg2="${proxy.user}"/>
1530 <equals arg1="" arg2="${proxy.password}"/>
1531 </or>
1532 </condition>
1533
1534 <getuserandpassword message="Using proxy: ${proxy.host}:${proxy.port}" if="ask.user" username="${proxy.user}" userproperty="proxy.username" pwordproperty="proxy.password"/>
1535 <mysetproxy proxyhost="${proxy.host}" proxyport="${proxy.port}" proxyuser="${proxy.username}" proxypassword="${proxy.password}"/>
1536 </target>
1537
1538 <target name="copy-dot-svn-files" depends="init"
1539 description="Copies all resources .svn files to .in versions - which are used during configure to generate the runtime versions." >
1540 <if>
1541 <bool><available file="${basedir}/resources/tomcat/greenstone3.xml.in"/></bool>
1542 <copy file="${basedir}/resources/tomcat/greenstone3.xml.in" tofile="${basedir}/resources/tomcat/greenstone3.xml.in.backup" overwrite="true"/>
1543 </if>
1544 <copy file="${basedir}/resources/tomcat/greenstone3.xml.svn" tofile="${basedir}/resources/tomcat/greenstone3.xml.in" overwrite="true"/>
1545
1546 <if>
1547 <bool><available file="${basedir}/resources/tomcat/server_tomcat5.xml.in"/></bool>
1548 <copy file="${basedir}/resources/tomcat/server_tomcat5.xml.in" tofile="${basedir}/resources/tomcat/server_tomcat5.xml.in.backup" overwrite="true"/>
1549 </if>
1550 <copy file="${basedir}/resources/tomcat/server_tomcat5.xml.svn" tofile="${basedir}/resources/tomcat/server_tomcat5.xml.in" overwrite="true"/>
1551
1552 <if>
1553 <bool><available file="${basedir}/resources/tomcat/server_tomcat7.xml.in"/></bool>
1554 <copy file="${basedir}/resources/tomcat/server_tomcat7.xml.in" tofile="${basedir}/resources/tomcat/server_tomcat7.xml.in.backup" overwrite="true"/>
1555 </if>
1556 <copy file="${basedir}/resources/tomcat/server_tomcat8.xml.svn" tofile="${basedir}/resources/tomcat/server_tomcat8.xml.in" overwrite="true"/>
1557
1558 <if>
1559 <bool><available file="${basedir}/resources/tomcat/server_tomcat8.xml.in"/></bool>
1560 <copy file="${basedir}/resources/tomcat/server_tomcat8.xml.in" tofile="${basedir}/resources/tomcat/server_tomcat8.xml.in.backup" overwrite="true"/>
1561 </if>
1562 <copy file="${basedir}/resources/tomcat/server_tomcat8.xml.svn" tofile="${basedir}/resources/tomcat/server_tomcat8.xml.in" overwrite="true"/>
1563
1564 <if>
1565 <bool><available file="${basedir}/resources/tomcat/web8.xml.in"/></bool>
1566 <copy file="${basedir}/resources/tomcat/web8.xml.in" tofile="${basedir}/resources/tomcat/web8.xml.in.backup" overwrite="true"/>
1567 </if>
1568 <copy file="${basedir}/resources/tomcat/web8.xml.svn" tofile="${basedir}/resources/tomcat/web8.xml.in" overwrite="true"/>
1569
1570 <if>
1571 <bool><available file="${basedir}/resources/oai/OAIConfig.xml.in"/></bool>
1572 <copy file="${basedir}/resources/oai/OAIConfig.xml.in" tofile="${basedir}/resources/oai/OAIConfig.xml.in.backup" overwrite="true"/>
1573 </if>
1574 <copy file="${basedir}/resources/oai/OAIConfig.xml.svn" tofile="${basedir}/resources/oai/OAIConfig.xml.in" overwrite="true"/>
1575
1576 <if>
1577 <bool><available file="${basedir}/resources/iiif/IIIFConfig.xml.in"/></bool>
1578 <copy file="${basedir}/resources/iiif/IIIFConfig.xml.in" tofile="${basedir}/resources/iiif/IIIFConfig.xml.in.backup" overwrite="true"/>
1579 </if>
1580 <copy file="${basedir}/resources/iiif/IIIFConfig.xml.svn" tofile="${basedir}/resources/iiif/IIIFConfig.xml.in" overwrite="true"/>
1581
1582 <if>
1583 <bool><available file="${basedir}/resources/iiif/cantaloupe.properties.in"/></bool>
1584 <copy file="${basedir}/resources/iiif/cantaloupe.properties.in" tofile="${basedir}/resources/iiif/cantaloupe.properties.in.backup" overwrite="true"/>
1585 </if>
1586 <copy file="${basedir}/resources/iiif/cantaloupe.properties.svn" tofile="${basedir}/resources/iiif/cantaloupe.properties.in" overwrite="true"/>
1587
1588 <if>
1589 <bool><available file="${basedir}/resources/cgi/gsdl3site.cfg.in"/></bool>
1590 <copy file="${basedir}/resources/cgi/gsdl3site.cfg.in" tofile="${basedir}/resources/cgi/gsdl3site.cfg.in.backup" overwrite="true"/>
1591 </if>
1592 <copy file="${basedir}/resources/cgi/gsdl3site.cfg.svn" tofile="${basedir}/resources/cgi/gsdl3site.cfg.in" overwrite="true"/>
1593
1594 <if>
1595 <bool><available file="${basedir}/resources/web/global.properties.in"/></bool>
1596 <copy file="${basedir}/resources/web/global.properties.in" tofile="${basedir}/resources/web/global.properties.in.backup" overwrite="true"/>
1597 </if>
1598 <copy file="${basedir}/resources/web/global.properties.svn" tofile="${basedir}/resources/web/global.properties.in" overwrite="true"/>
1599
1600 <if>
1601 <bool><available file="${basedir}/resources/web/log4j.properties.in"/></bool>
1602 <copy file="${basedir}/resources/web/log4j.properties.in" tofile="${basedir}/resources/web/log4j.properties.in.backup" overwrite="true"/>
1603 </if>
1604 <copy file="${basedir}/resources/web/log4j.properties.svn" tofile="${basedir}/resources/web/log4j.properties.in" overwrite="true"/>
1605
1606</target>
1607
1608 <!-- ========== Web app Targets ================================ -->
1609
1610 <target name="prepare-web" depends="init">
1611 <mkdir dir="${web.writablehome}/applet"/>
1612 <mkdir dir="${web.writablehome}/logs"/>
1613 <mkdir dir="${web.writablehome}/logs/tmp"/>
1614 </target>
1615
1616 <!-- 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.
1617 The test for whether we need it assumes we won't be trying to compile GS3 against Java versions less than 1.4. -->
1618 <target name="configure-java-version" depends="init"
1619 description="Activates or deactivates some jar libraries as needed depending on your java version">
1620
1621 <available property="have.xalan.jar" file="${web.lib}/xalan.jar"/>
1622 <condition property="need.xalan.jar">
1623 <or>
1624 <not><equals arg1="1.4" arg2="${java.specification.version}"/></not>
1625 </or>
1626 </condition>
1627
1628 <!-- if they have xalan.jar but dont need it -->
1629 <if>
1630 <bool>
1631 <and>
1632 <isset property="have.xalan.jar"/>
1633 <not><isset property="need.xalan.jar"/></not>
1634 </and>
1635 </bool>
1636 <antcall target="deactivate-xalan-jar"/>
1637 </if>
1638
1639 <!-- if they need xalan.jar but dont have it -->
1640 <if>
1641 <bool>
1642 <and>
1643 <not><isset property="have.xalan.jar"/></not>
1644 <isset property="need.xalan.jar"/>
1645 </and>
1646 </bool>
1647 <antcall target="activate-xalan-jar"/>
1648 </if>
1649
1650 </target>
1651
1652 <target name="activate-xalan-jar">
1653 <echo>activating xalan.jar</echo>
1654 <copy file="${web.lib}/xalan.jar.tmp" tofile="${web.lib}/xalan.jar"/>
1655 <if>
1656 <bool>
1657 <and>
1658 <isset property="current.os.ismac"/>
1659 <available file="${catalina.home}/common/endorsed" type="dir"/>
1660 </and>
1661 </bool>
1662 <copy file="${web.lib}/xalan.jar.tmp" tofile="${catalina.home}/common/endorsed/xalan.jar"/>
1663 </if>
1664 </target>
1665
1666 <target name="deactivate-xalan-jar">
1667 <echo>deactivating xalan.jar</echo>
1668 <delete file="${web.lib}/xalan.jar"/>
1669 <!-- should we be deleting common/endorsed/xalan.jar on mac?? -->
1670 </target>
1671
1672
1673 <target name="prepare-collections" depends="init"
1674 description="Unpack all the collections from their svn zipped versions">
1675 <property name="collect.dir" value="${web.home}/sites/localsite/collect"/>
1676 <property name="index-and-archives.zip" value="index-and-archives.zip"/>
1677
1678 <echo message="Installing collections ..."/>
1679 <!-- collections requiring jni -->
1680 <echo message="checkpt NEXT"/>
1681 <if>
1682 <bool>
1683 <istrue value="${with.jni}"/>
1684 </bool>
1685 <antcall target="gs2mgdemo-install"/>
1686 </if>
1687 <echo message="checkpt 1"/>
1688 <if>
1689 <bool>
1690 <istrue value="${with.jni}"/>
1691 </bool>
1692 <antcall target="gs2mgppdemo-install"/>
1693 </if>
1694 <!-- pure java ones -->
1695 <echo message="checkpt 1"/>
1696 <antcall target="gberg-install"/>
1697 <echo message="checkpt 1"/>
1698 <antcall target="lucene-jdbm-demo-install"/>
1699 </target>
1700
1701 <target name="gs2mgdemo-prepare" if="collect.dir">
1702 <property name="gs2mgdemo.dir" value="${collect.dir}/gs2mgdemo"/>
1703
1704 <condition property="gs2mgdemo.present">
1705 <and>
1706 <available file="${gs2mgdemo.dir}/${index-and-archives.zip}"/>
1707 </and>
1708 </condition>
1709 </target>
1710
1711 <target name="gs2mgdemo-install" if="gs2mgdemo.present" depends="gs2mgdemo-prepare">
1712 <unzip dest="${gs2mgdemo.dir}" src="${gs2mgdemo.dir}/${index-and-archives.zip}" />
1713 <echo>collection gs2mgdemo installed</echo>
1714 </target>
1715
1716 <target name="gs2mgppdemo-prepare" if="collect.dir">
1717 <property name="gs2mgppdemo.dir" value="${collect.dir}/gs2mgppdemo"/>
1718
1719 <condition property="gs2mgppdemo.present">
1720 <and>
1721 <available file="${gs2mgppdemo.dir}/${index-and-archives.zip}"/>
1722 </and>
1723 </condition>
1724 </target>
1725
1726 <target name="gs2mgppdemo-install" if="gs2mgppdemo.present" depends="gs2mgppdemo-prepare">
1727 <unzip dest="${gs2mgppdemo.dir}" src="${gs2mgppdemo.dir}/${index-and-archives.zip}" />
1728 <echo>collection gs2mgppdemo installed</echo>
1729 </target>
1730
1731 <target name="gberg-prepare" if="collect.dir">
1732 <property name="gberg.dir" value="${collect.dir}/gberg"/>
1733 <available file="${gberg.dir}/index/index.zip" property="gberg.present"/>
1734 </target>
1735
1736 <target name="gberg-install" if="gberg.present" depends="gberg-prepare">
1737 <unzip dest="${gberg.dir}/index" src="${gberg.dir}/index/index.zip"/>
1738 <echo>collection gberg installed</echo>
1739 </target>
1740
1741 <target name="lucene-jdbm-demo-prepare" if="collect.dir">
1742 <property name="lucene-jdbm-demo.dir" value="${collect.dir}/lucene-jdbm-demo"/>
1743 <available file="${lucene-jdbm-demo.dir}/${index-and-archives.zip}" property="lucene-jdbm-demo.present"/>
1744 </target>
1745
1746 <target name="lucene-jdbm-demo-install" if="lucene-jdbm-demo.present" depends="lucene-jdbm-demo-prepare">
1747 <unzip dest="${lucene-jdbm-demo.dir}" src="${lucene-jdbm-demo.dir}/${index-and-archives.zip}"/>
1748 <echo>collection lucene-jdbm-demo installed</echo>
1749 </target>
1750
1751
1752 <target name="install-solr-ext" depends="init" >
1753 <exec executable="ant.bat" osfamily="windows" dir="${solr-ext.home}" spawn="false" failonerror="true">
1754 <arg value="add-service"/>
1755 </exec>
1756 <exec executable="ant" os="${os.unix}" dir="${solr-ext.home}" spawn="false" failonerror="true">
1757 <arg value="add-service"/>
1758 </exec>
1759 <antcall target="solr-jdbm-demo-install"/>
1760 </target>
1761
1762 <target name="solr-jdbm-demo-prepare" if="collect.dir">
1763 <property name="solr-jdbm-demo.dir" value="${collect.dir}/solr-jdbm-demo"/>
1764 <available file="${solr-jdbm-demo.dir}/${index.zip}" property="solr-jdbm-demo.present"/>
1765 </target>
1766
1767 <target name="solr-jdbm-demo-install" if="solr-jdbm-demo.present" depends="solr-jdbm-demo-prepare">
1768 <unzip dest="${solr-jdbm-demo.dir}" src="${solr-jdbm-demo.dir}/${index.zip}"/>
1769 <echo>collection solr-jdbm-demo installed</echo>
1770 </target>
1771
1772 <target name="install-webswing-ext" depends="init" >
1773 <exec executable="ant.bat" osfamily="windows" dir="${webswing-ext.home}" spawn="false" failonerror="true">
1774 <arg value="-Dweb.home=${web.home}"/>
1775 <arg value="-Dweb.writablehome=${web.writablehome}"/>
1776 <arg value="add-extension"/>
1777 </exec>
1778 <exec executable="ant" os="${os.unix}" dir="${webswing-ext.home}" spawn="false" failonerror="true">
1779 <arg value="-Dweb.home=${web.home}"/>
1780 <arg value="-Dweb.writablehome=${web.writablehome}"/>
1781 <arg value="add-extension"/>
1782 </exec>
1783 </target>
1784
1785 <!-- Until 64 bit Linux and Mac (Lion) machines can generate a working IsisGdl,
1786 use the ones generated on a 32 bit Linux and Mac (Leopard), respectively
1787 -->
1788 <target name="get-isisgdl" if="${current.os.isunix}">
1789 <exec executable="uname" dir="${basedir}" failonerror="false"
1790 outputproperty="uname.val">
1791 <arg value="-m"/>
1792 </exec>
1793
1794 <if>
1795 <!-- as the syntax below copies the IsidGdl binary into the gs2build directory
1796 only want to run the commend if collection.building.enabled -->
1797 <bool>
1798 <and>
1799 <istrue value="${collection.building.enabled}" />
1800 <equals arg1="${uname.val}" arg2="x86_64"/>
1801 </and>
1802 </bool>
1803 <echo>Bitness: ${uname.val}</echo>
1804 <if><bool><contains string="${os.bin.dir}" substring="darwin" casesensitive="false"/></bool>
1805 <exec executable="uname" dir="${basedir}" failonerror="false"
1806 outputproperty="darwin.kernel.version">
1807 <arg value="-r"/>
1808 </exec>
1809
1810 <echo>darwin kernel version: ${darwin.kernel.version}</echo>
1811 <!-- up to high sierra/kernel (version 17.x) us IsisGdl.macleopard
1812 From Mojave onwards, we can use the Mojave generated IsisGdl.mac64mojave -->
1813 <if>
1814 <bool><matches string="${darwin.kernel.version}" pattern="^([0-9]|1[0-7])\."/></bool>
1815 <property name="mac.isisgdl.suffix" value="macleopard"/>
1816 <else>
1817 <property name="mac.isisgdl.suffix" value="mac64mojave"/>
1818 </else>
1819 </if>
1820
1821
1822 <!--<get src="${gsorg.root}/caveat-emptor/IsisGdl.macleopard"
1823 dest="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl"/>-->
1824 <exec executable="wget" failonerror="true">
1825 <arg value="-P"/>
1826 <arg value="${basedir}/gs2build/bin/${os.bin.dir}"/>
1827 <arg value="--no-check-certificate"/>
1828 <arg value="${gsorg.root}/caveat-emptor/IsisGdl.${mac.isisgdl.suffix}"/>
1829 </exec>
1830 <move file="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl.${mac.isisgdl.suffix}"
1831 tofile="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl"/>
1832 </if>
1833 <if><bool><contains string="${os.bin.dir}" substring="linux" casesensitive="false"/></bool>
1834 <!--<get src="${gsorg.root}/caveat-emptor/IsisGdl.bin32"
1835 dest="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl"/>-->
1836 <exec executable="wget" failonerror="true">
1837 <arg value="-P"/>
1838 <arg value="${basedir}/gs2build/bin/${os.bin.dir}"/>
1839 <arg value="--no-check-certificate"/>
1840 <arg value="${gsorg.root}/caveat-emptor/IsisGdl.bin32"/>
1841 </exec>
1842 <move file="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl.bin32"
1843 tofile="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl"/>
1844 </if>
1845 <chmod file="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl" perm="755"/>
1846 </if>
1847 </target>
1848
1849 <target name="set-perl-shebangs" depends="perl-for-building">
1850 <if>
1851 <bool>
1852 <and><isset property="perl.path"/>
1853 <not><equals arg1="${perl.path}" arg2=""/></not>
1854 </and>
1855 </bool>
1856
1857 <if><bool><istrue value="${current.os.iswindows}"/></bool>
1858 <property name="perl.exec" value="${perl.path}perl.exe"/>
1859 <else>
1860 <property name="perl.exec" value="${perl.path}perl"/>
1861 </else>
1862 </if>
1863
1864 <!--<echo>**** PERLPATH: ${perl.path}</echo>-->
1865 <echo>Setting perl shebangs to Perl Exec: ${perl.exec}</echo>
1866
1867 <!-- set the shebangs in the cgi files to point to the correct perlpath -->
1868 <if>
1869 <bool><not><equals arg1="${web.home}" arg2="${web.writablehome}"></equals></not></bool>
1870 <mkdir dir="${web.writablehome}"/>
1871 <copy file="${full.web.dir}/WEB-INF/cgi/gliserver.pl" tofile="${web.writablehome}/WEB-INF/cgi/gliserver.pl" overwrite="true"/>
1872 <copy file="${full.web.dir}/WEB-INF/cgi/metadata-server.pl" tofile="${web.writablehome}/WEB-INF/cgi/metadata-server.pl" overwrite="true"/>
1873 <copy file="${full.web.dir}/WEB-INF/cgi/checksum.pl" tofile="${web.writablehome}/WEB-INF/cgi/checksum.pl" overwrite="true"/>
1874 </if>
1875
1876 <rsr verbosity="1" file="${web.writablehome}/WEB-INF/cgi/gliserver.pl" pattern="^#!.*" replacement="#!${perl.exec} -w" lines="1"/>
1877 <rsr verbosity="1" file="${web.writablehome}/WEB-INF/cgi/metadata-server.pl" pattern="^#!.*" replacement="#!${perl.exec} -w" lines="1"/>
1878 <rsr verbosity="1" file="${web.writablehome}/WEB-INF/cgi/checksum.pl" pattern="^#!.*" replacement="#!${perl.exec} -w" lines="1"/>
1879 <else>
1880 <echo>WARNING: perl.path is empty. Unable to set the shebangs in the perl files in ${web.writablehome}/WEB-INF/cgi</echo>
1881 </else>
1882 </if>
1883 </target>
1884
1885 <target name="configure-web" depends="init,perl-for-building"
1886 description="Configure only the web app config files">
1887 <!-- we want a unix path in the global.properties file -->
1888 <pathconvert targetos="unix" property="src.gsdl3.home.unix">
1889 <path path="${web.home}"/>
1890 </pathconvert>
1891 <pathconvert targetos="unix" property="src.gsdl3.writablehome.unix">
1892 <path path="${web.writablehome}"/>
1893 </pathconvert>
1894
1895 <antcall target="set-perl-shebangs" inheritAll="true" />
1896
1897 <filter token="gsdlhome" value="${gs2build.home}"/>
1898 <filter token="gsdlhomequoted" value="&quot;${gs2build.home}&quot;"/>
1899 <filter token="gsdl3srchome" value="${basedir}"/>
1900 <filter token="gsdl3srchomequoted" value="&quot;${basedir}&quot;"/>
1901 <filter token="gsdl3home" value="${src.gsdl3.home.unix}"/>
1902 <filter token="gsdl3homequoted" value="&quot;${src.gsdl3.home.unix}&quot;"/>
1903 <filter token="gsdl3writablehome" value="${src.gsdl3.writablehome.unix}"/>
1904 <filter token="gsdl3version" value="${app.version}"/>
1905 <filter token="revproxy.protocol" value="${revproxy.protocol}"/>
1906 <filter token="revproxy.domain" value="${revproxy.domain}"/>
1907 <filter token="revproxy.opt_port" value="${revproxy.opt_port}"/>
1908 <filter token="revproxy.context" value="${revproxy.context}"/>
1909 <filter token="server.protocols" value="${server.protocols}"/>
1910 <filter token="default.server.protocol" value="${default.server.protocol}"/>
1911 <filter token="tomcat.server" value="${tomcat.server}"/>
1912 <filter token="default.tomcat.port" value="${default.tomcat.port}"/>
1913 <filter token="localhost.server.http" value="${localhost.server.http}"/>
1914 <filter token="localhost.port.http" value="${localhost.port.http}"/>
1915 <filter token="tomcat.port.https" value="${tomcat.port.https}"/>
1916 <filter token="restrict.http.to.local" value="${restrict.http.to.local}"/>
1917 <filter token="tomcat.server.IPregex" value="${tomcat.server.IPregex}"/>
1918
1919 <filter token="greenstone.context" value="${greenstone.context}"/>
1920 <filter token="solr.context" value="${solr.context}"/>
1921 <filter token="derbyserver" value="${derby.server}"/>
1922 <filter token="derbyserver.port" value="${derby.server.port}"/>
1923 <filter token="perlpath" value="${escaped.perl.path}"/>
1924 <filter token="defaultservletpath" value="${greenstone.default.servlet}"/>
1925 <filter token="disable.collection.building" value="${disable.collection.building}"/>
1926 <copy file="${basedir}/resources/cgi/gsdl3site.cfg.in" tofile="${web.writablehome}/WEB-INF/cgi/gsdl3site.cfg" filtering="true" overwrite="true"/>
1927 <copy file="${basedir}/resources/web/global.properties.in" tofile="${web.writableclasses}/global.properties" filtering="true" overwrite="true"/>
1928 <copy file="${basedir}/resources/web/log4j.properties.in" tofile="${web.writableclasses}/log4j.properties" filtering="true" overwrite="true"/>
1929 <if>
1930 <bool><istrue value="${gsdl3home.isreadonly}"/></bool>
1931 <!-- uncomment the writablehome properties -->
1932 <rsr verbosity="1" file="${web.writableclasses}/global.properties" pattern="^#gsdl3\.(writable{1})?home" replacement="gsdl3.$1home" />
1933 </if>
1934 <chmod file="${web.writableclasses}/global.properties" perm="664"/>
1935 <chmod file="${web.writableclasses}/log4j.properties" perm="664"/>
1936
1937 <copy file="${basedir}/resources/iiif/cantaloupe.properties.in" tofile="${basedir}/cantaloupe.properties" filtering="true" overwrite="true"/>
1938 <chmod file="${basedir}/cantaloupe.properties" perm="664"/>
1939 </target>
1940
1941 <target name="compile-web" depends="needs-gs3-devel,init">
1942 <javac srcdir="${web.classes}"
1943 destdir="${web.classes}"
1944 includeantruntime="${compile.includeantruntime}"
1945 debug="${compile.debug}"
1946 deprecation="${compile.deprecation}"
1947 optimize="${compile.optimize}"
1948 encoding="${compile.encoding}">
1949 <compilerarg line="${compile.javac.flags}"/>
1950 <classpath><path refid="compile.classpath"/></classpath>
1951 </javac>
1952 </target>
1953
1954 <target name="compile-classpath-jars" depends="needs-gs3-devel,init">
1955 <if><bool><available file="admin/cp.mf"/></bool>
1956 <jar destfile="admin/cp.jar" manifest="admin/cp.mf"/>
1957 </if>
1958 <if><bool><available file="${lib.java}/cp.mf"/></bool>
1959 <jar destfile="${lib.java}/cp.jar" manifest="${lib.java}/cp.mf"/>
1960 </if>
1961 <if><bool><available file="${lib.jni}/cp.mf"/></bool>
1962 <jar destfile="${lib.jni}/cp.jar" manifest="${lib.jni}/cp.mf"/>
1963 </if>
1964 <if><bool><available file="${web.lib}/cp.mf"/></bool>
1965 <jar destfile="${web.lib}/cp.jar" manifest="${web.lib}/cp.mf"/>
1966 </if>
1967 <jar destfile="cp.jar">
1968 <manifest>
1969 <attribute name="Class-Path" value="server.jar admin/cp.jar lib/java/cp.jar lib/jni/cp.jar web/WEB-INF/lib/cp.jar"/>
1970 </manifest>
1971 </jar>
1972 </target>
1973
1974 <target name="clean-classpath-jars" depends="init">
1975 <delete file="admin/cp.jar"/>
1976 <delete file="${lib.java}/cp.jar"/>
1977 <delete file="${lib.jni}/cp.jar"/>
1978 <delete file="${web.lib}/cp.jar"/>
1979 <delete file="cp.jar"/>
1980 </target>
1981
1982
1983 <target name="svnupdate-web" unless="nosvn.mode">
1984 <exec executable="svn">
1985 <arg value="update"/>
1986 <arg value="${web.writablehome}"/>
1987 <arg value="-r"/><arg value="${branch.revision}"/>
1988 </exec>
1989 </target>
1990
1991 <target name="update-web" depends="init,svnupdate-web,configure-web"
1992 description="update only the web stuff (config files)"/>
1993
1994
1995 <!--
1996 Newer versions of perl need CGI.pm placed in web/WEB-INF/cgi.
1997 We have a CGIModule.tar.gz in common-src/cgi-bin, that we can use for linux (unix) systems.
1998
1999 - from perl5.22, CGI.pm is not included, but GS3 needs it:
2000 https://stackoverflow.com/questions/45434990/why-does-this-code-have-issues-with-the-cgi-module
2001 - bash line to get perl version: https://www.unix.com/shell-programming-and-scripting/18267-version-perl-installed-my-system.html
2002 - run bash command using pipes with ant: https://stackoverflow.com/questions/1187402/ant-run-command-with-pipes
2003 - single quotes in XML use &apos; https://stackoverflow.com/questions/7388695/how-can-i-escape-double-quotes-in-ant
2004 - islessthan and isgreaterthan ant bool conditionals: https://stackoverflow.com/questions/7616159/apache-ant-less-than
2005 -->
2006 <condition property="cgimodule.exists">
2007 <and>
2008 <available file="${web.home}/WEB-INF/cgi" type="dir"/> <!--Unavailable for custom web.home-->
2009 <available file="${web.home}/WEB-INF/cgi/CGI.pm" type="file"/>
2010 <available file="${web.home}/WEB-INF/cgi/Fh.pm" type="file"/>
2011 <available file="${web.home}/WEB-INF/cgi/CGI" type="dir"/>
2012 </and>
2013 </condition>
2014
2015 <target name="unpack-cgimodule" if="current.os.isunix" unless="cgimodule.exists">
2016 <exec executable="bash" outputproperty="perl.major.version">
2017 <arg value="-c"/>
2018 <arg line='"perl -v | awk &apos;/This/ {print $4}&apos; | sed -e &apos;s/,//&apos;"'/>
2019 </exec>
2020 <exec executable="bash" outputproperty="perl.min.version">
2021 <arg value="-c"/>
2022 <arg line='"perl -v | awk &apos;/This/ {print $6}&apos; | sed -e &apos;s/,//&apos;"'/>
2023 </exec>
2024
2025 <if>
2026 <bool>
2027 <or>
2028 <isgreaterthan arg1="${perl.major.version}" arg2="5"/>
2029 <and>
2030 <equals arg1="${perl.major.version}" arg2="5" trim="true"/>
2031 <islessthan arg1="${perl.minor.version}" arg2="22"/>
2032 </and>
2033 </or>
2034 </bool>
2035 <echo message="Unpacking the CGIModule needed for your perl version: ${perl.major.version}.${perl.min.version}" />
2036
2037 <untar compression="gzip"
2038 src="${common.src.home}/cgi-bin/CGIModule.tar.gz"
2039 dest="${web.home}/WEB-INF/cgi"/>
2040 <move todir="${web.home}/WEB-INF/cgi" failonerror="false">
2041 <!-- This fileset moves *contents* of directory CGIModule into destination dir web.home -->
2042 <fileset dir="${web.home}/WEB-INF/cgi/CGIModule"/>
2043 </move>
2044 <delete dir="${web.home}/WEB-INF/cgi/CGIModule"/>
2045
2046 </if>
2047 </target>
2048
2049 <!-- ============ Targets concerned with https certification ================ -->
2050
2051 <target name="setup-https-cert-info">
2052 <echo>
2053 *********************************************************************
2054 NOTE TO OBTAINING A TLS (SSL) CERTIFICATE FOR HTTPS
2055 *********************************************************************
2056 A signed certificate is needed for your GS server to serve pages over https.
2057 This target will attempt to obtain a certificate for you from the official and free Certificate Authority Lets Encrypt.
2058 However, a certificate can only be obtained if you have admin/sudo permissions on this machine that you are installing Greenstone on.
2059
2060 Note that:
2061 * 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.
2062 * 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.
2063 </echo>
2064 </target>
2065
2066
2067 <target name="https-conditions-set">
2068 <input addproperty="https.conditions.ok" validargs="y,n">
2069 To run this target, ensure you have:
2070 * (if on unix) sudo permissions. Enter the sudo password if prompted.
2071 * (if on windows) sufficient privileges to run the included tomcat on port 80.
2072 * nothing running on port 80 when you run this target
2073 * edited the build.properties file with
2074 - tomcat.server set to the/a domain name of your server
2075 - 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)
2076 - tomcat.port.https set to a valid port number not yet in use
2077 - keystore.pass set to a password for the certification process
2078 * read the Lets Encrypt Subscriber Agreement at https://letsencrypt.org/repository/
2079 If any of the above is not possible, quit this target. Continue [y/n]?
2080 </input>
2081
2082 <condition property="quit.https.setup">
2083 <equals arg1="n" arg2="${https.conditions.ok}"/>
2084 </condition>
2085
2086 <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>
2087 </target>
2088
2089
2090 <target name="setup-https-cert" depends="setup-https-cert-info,https-conditions-set">
2091 <if><bool><not><matches string="${server.protocols}" pattern="https"/></not></bool>
2092 <fail>To setup https certification, the server.protocols property in file build.properties must contain 'https'</fail>
2093 </if>
2094
2095 <input addproperty="https.cert.email">Enter an email that Let's Encrypt, the certification authority, can send any important notifications to</input>
2096 <input addproperty="https.other.domains">Besides tomcat.server=${tomcat.server}, enter a comma separated list of additional domains to support, if any</input>
2097 <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>
2098 <if>
2099 <bool><equals arg1="y" arg2="${https.cert.agree}"/></bool>
2100
2101 <condition property="https.cert.domains" value="${tomcat.server},${https.other.domains}" else="${tomcat.server}">
2102 <and>
2103 <isset property="https.other.domains" />
2104 <not><matches string="${https.other.domains}" pattern="^\s*$"/></not>
2105 </and>
2106 </condition>
2107
2108 <input addproperty="https.do.cert" validargs="y,n">
2109 You've agreed to the Let's Encrypt TOS with
2110 - email: ${https.cert.email}
2111 - domains: ${https.cert.domains}
2112 Looks okay? [y/n]
2113 </input>
2114 </if>
2115
2116 <if><bool><equals arg1="n" arg2="${https.do.cert}"/></bool>
2117 <echo>Not proceeding with https certification for the Greenstone 3 web server</echo>
2118 <else>
2119 <echo>Proceeding...</echo>
2120 <if><bool><istrue value="${current.os.iswindows}"/></bool>
2121 <antcall target="setup-https-cert-windows">
2122 <param name="https.cert.renewal" value=""/><!-- for cert issuance, there are none of the additional parameters specific to cert renewal -->
2123 </antcall>
2124 </if>
2125 <if><bool><istrue value="${current.os.isunixnotmac}"/></bool>
2126 <antcall target="setup-https-cert-linux"/>
2127 </if>
2128 <if><bool><istrue value="${current.os.ismac}"/></bool>
2129 <antcall target="setup-https-cert-mac"/>
2130 </if>
2131 </else>
2132 </if>
2133
2134 </target>
2135
2136
2137 <target name="setup-https-cert-windows">
2138
2139 <echo>********** The included tomcat will be stopped, then restarted on port 80 and stopped again</echo>
2140
2141 <!-- create folder packages\tomcat\webapps\ROOT\.well-known\acme-challenge -->
2142 <mkdir dir="${packages.home}/tomcat/webapps/ROOT/.well-known/acme-challenge"/>
2143 <mkdir dir="${packages.home}/tomcat/conf/https_cert"/>
2144
2145 <!--
2146 For Windows, Greenstone can generate the account and domain keys with the openSSL we compiled up ourselves
2147 and put on SVN (at GS3/bin/windows/openssl) rather than let ZeroSSL generate these keys for the user.
2148 Letting Greenstone generate the keys may be considered more trustworthy by the user than letting a 3rd
2149 party do so. See https://zerossl.com/usage.html#First_time_run_and_regular_use for OpenSSL commands
2150 If we don't generate the keys ourselves with our OpenSSL, then ZeroSSL will do so automatically in the
2151 call to le64/32.exe further below, as it's passed in the flag generate-missing.
2152 -->
2153 <!-- We generate the account key named "privkey.key" in ${packages.home}\tomcat\conf\https_cert -->
2154 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
2155 <arg value="/c" />
2156 <arg value="openssl.exe" />
2157 <arg value="genrsa" />
2158 <arg value="-out" /><arg value="${packages.home}\tomcat\conf\https_cert\privkey.key" /><arg value="4096" />
2159 </exec>
2160
2161 <!-- Also generate the domain key (for csr-key parameter to zeroSSL's le.exe)
2162 ${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key
2163 Using 2048 instead of 4096 bits for this. See https://zerossl.com/usage.html#First_time_run_and_regular_use
2164 -->
2165 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
2166 <arg value="/c" />
2167 <arg value="openssl.exe" />
2168 <arg value="genrsa" />
2169 <arg value="-out" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key" /><arg value="2048" />
2170 </exec>
2171
2172 <!-- stop the included tomcat (also stopping derby and solr) -->
2173 <antcall target="stop" />
2174
2175 <!-- rerun tomcat on port 80
2176 See https://ant.apache.org/manual/Tasks/antcall.html -->
2177 <antcall target="start">
2178 <param name="localhost.port.http" value="80"/>
2179 <param name="default.tomcat.port" value="80"/>
2180 <param name="local.http.url" value="http://${localhost.server.http}"/><!-- For port 80 over http, leave out port number in URL -->
2181 <param name="http.address.restriction" value=""/><!-- don't prevent public access over http of port 80 -->
2182 <param name="https.comment.out.start" value="${comment.start}"/>
2183 <param name="https.comment.out.end" value="${comment.end}"/>
2184 </antcall>
2185
2186 <!-- get the certificate: use zerossl for windows
2187 Download from https://github.com/do-know/Crypt-LE/releases,
2188 For licence see https://github.com/do-know/Crypt-LE/
2189 Usage instructions at https://zerossl.com/usage.html
2190
2191 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}"
2192
2193 which generates a .pfx file with the same name as the PEM certificate (.crt param below)
2194 .pfx vs .p12: https://stackoverflow.com/questions/6819079/convert-pfx-format-to-p12
2195
2196 In this case "fullchain_and_prvtkey.pfx" is generated, which is the windows value of ${keystore.file} property
2197
2198 Helpful for debugging: https://stackoverflow.com/questions/10302489/ant-script-have-exec-tag-dump-out-entire-command-line
2199 -->
2200 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}" spawn="false">
2201 <arg value="/c" />
2202 <arg value="le${os.bitness}" />
2203 <arg value="--key" /><arg value="${packages.home}\tomcat\conf\https_cert\privkey.key" />
2204 <arg value="--csr" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.csr" />
2205 <arg value="--csr-key" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key" />
2206 <!--<arg value="==crt" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.crt" />-->
2207 <arg value="--crt" /><arg value="${packages.home}\tomcat\conf\https_cert\fullchain_and_prvtkey.crt" />
2208 <arg value="--domains" /><arg value="${https.cert.domains}" />
2209 <arg value="--path" /><arg value="${packages.home}\tomcat\webapps\ROOT\.well-known\acme-challenge" />
2210 <arg value="--generate-missing" />
2211 <arg value="--unlink" />
2212 <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 -->
2213 <!--<arg value="==export-pfx" /><arg value="${keystore.pass}" />
2214 <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-->
2215 <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. -->
2216 </exec>
2217
2218 <!-- stop the tomcat running on port 80 -->
2219 <antcall target="stop">
2220 <param name="localhost.port.http" value="80"/>
2221 <param name="default.tomcat.port" value="80"/>
2222 <param name="local.http.url" value="http://${localhost.server.http}"/><!-- For port 80 over http, leave out port number in URL -->
2223 <param name="http.address.restriction" value=""/>
2224 <param name="https.comment.out.start" value="${comment.start}"/>
2225 <param name="https.comment.out.end" value="${comment.end}"/>
2226 </antcall>
2227
2228 <!-- Use OpenSSL instead of ZeroSSL to convert the certificate to the .pfx format that tomcat likes, using this cmd:
2229 GS3/bin/windows/openssl/bin/openssl.exe pkcs12 -inkey domain.key -in domain.crt -passin pass:pwd -passout pass:pwd -export -out ${keystore.file}
2230 GS3/bin/windows/openssl/bin/openssl.exe pkcs12 -inkey domain.key -in domain.crt -password pass:pwd -export -out ${keystore.file}
2231 where on windows, keystore.file = fullchain_and_prvtkey.pfx
2232 -->
2233 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
2234 <arg value="/c" />
2235 <arg value="openssl.exe" />
2236 <arg value="pkcs12" />
2237 <arg value="-inkey" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key" />
2238 <arg value="-in" /><arg value="${packages.home}\tomcat\conf\https_cert\fullchain_and_prvtkey.crt" />
2239 <arg value="-export" />
2240 <arg value="-out" /><arg value="${packages.home}\tomcat\conf\https_cert\${keystore.file}" />
2241 <arg value="-name"/><arg value="greenstone3-tomcat"/><!-- See https://stackoverflow.com/questions/808669/convert-a-cert-pem-certificate-to-a-pfx-certificate -->
2242 <arg value="-password"/><arg value="pass:${keystore.pass}"/>
2243 </exec>
2244
2245 </target>
2246
2247
2248 <!-- On Mac as on Linux, we need sudo permissions to setup https certification.
2249 But unlike on Linux, on Mac we only need to sudo when running tomcat on port 80
2250 and when stopping tomcat running on port 80. But we don't need to sudo on a Mac when calling le.pl.
2251 This also means all the files in https_cert have the correct (user, not root) permissions.
2252 -->
2253 <target name="setup-https-cert-mac">
2254
2255 <echo>********** The included tomcat will be stopped, then restarted on port 80 and stopped again</echo>
2256
2257 <!-- create folder packages\tomcat\webapps\ROOT\.well-known\acme-challenge -->
2258 <mkdir dir="${packages.home}/tomcat/webapps/ROOT/.well-known/acme-challenge"/>
2259 <mkdir dir="${packages.home}/tomcat/conf/https_cert"/>
2260
2261 <!--
2262 See comments under setup-https-cert-WINDOWS
2263 -->
2264 <!-- We generate the account key named "privkey.key" in ${packages.home}\tomcat\conf\https_cert -->
2265 <if><bool><not><available file="${packages.home}/tomcat/conf/https_cert/privkey.key"/></not></bool>
2266 <exec executable="openssl" osfamily="mac" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
2267 <arg value="genrsa" />
2268 <arg value="-out" /><arg value="${packages.home}/tomcat/conf/https_cert/privkey.key" /><arg value="4096" />
2269 </exec>
2270 </if>
2271
2272 <!-- Also generate the domain key (for csr-key parameter to zeroSSL's le.pl)
2273 ${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key
2274 Using 2048 instead of 4096 bits for this. See https://zerossl.com/usage.html#First_time_run_and_regular_use
2275 -->
2276 <if><bool><not><available file="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.key"/></not></bool>
2277 <exec executable="openssl" osfamily="mac" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
2278 <arg value="genrsa" />
2279 <arg value="-out" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.key" /><arg value="2048" />
2280 </exec>
2281 </if>
2282
2283 <!-- stop the included tomcat (also stopping derby and solr) -->
2284 <antcall target="stop" />
2285
2286 <!-- rerun tomcat on port 80
2287 See https://ant.apache.org/manual/Tasks/antcall.html -->
2288 <antcall target="start">
2289 <param name="sudo.or.not" value="/usr/bin/sudo" />
2290 <param name="localhost.port.http" value="80"/>
2291 <param name="default.tomcat.port" value="80"/>
2292 <param name="local.http.url" value="http://${localhost.server.http}"/><!-- For port 80 over http, leave out port number in URL -->
2293 <param name="http.address.restriction" value=""/><!-- don't prevent public access over http of port 80 -->
2294 <param name="https.comment.out.start" value="${comment.start}"/>
2295 <param name="https.comment.out.end" value="${comment.end}"/>
2296 </antcall>
2297
2298 <!-- get the certificate: use zerossl's le.pl compiled up for Mac.
2299 For further notes, see under setup-https-cert-WINDOWS
2300 -->
2301
2302 <exec executable="perl" osfamily="mac" dir="${gs2build.home}/perllib/cpan/Crypt/LE/bin" spawn="false">
2303 <env key="PERL5LIB" value="${gs2build.home}/perllib/cpan${path.separator}${gs2build.home}/perllib/cpan/perl-5.18"/>
2304 <arg value="-S" />
2305 <arg value="${gs2build.home}/perllib/cpan/Crypt/LE/bin/le.pl" />
2306 <arg value="--key" /><arg value="${packages.home}/tomcat/conf/https_cert/privkey.key" />
2307 <arg value="--csr" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.csr" />
2308 <arg value="--csr-key" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.key" />
2309 <!--<arg value="==crt" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.crt" />-->
2310 <arg value="--crt" /><arg value="${packages.home}/tomcat/conf/https_cert/fullchain_and_prvtkey.crt" />
2311 <arg value="--domains" /><arg value="${https.cert.domains}" />
2312 <arg value="--path" /><arg value="${packages.home}/tomcat/webapps/ROOT/.well-known/acme-challenge" />
2313 <arg value="--generate-missing" />
2314 <arg value="--unlink" />
2315 <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 -->
2316 <!--<arg value="==export-pfx" /><arg value="${keystore.pass}" />
2317 <arg value="==tag-pfx" /><arg value="greenstone3-tomcat" />--><!-- not sure if this generates a keystore filename with ext .p12 or .pfx for Macs -->
2318 <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. -->
2319 </exec>
2320
2321 <!-- stop the tomcat running on port 80 -->
2322 <antcall target="stop">
2323 <param name="sudo.or.not" value="/usr/bin/sudo" />
2324 <param name="localhost.port.http" value="80"/>
2325 <param name="default.tomcat.port" value="80"/>
2326 <param name="local.http.url" value="http://${localhost.server.http}"/>
2327 <param name="http.address.restriction" value=""/>
2328 <param name="https.comment.out.start" value="${comment.start}"/>
2329 <param name="https.comment.out.end" value="${comment.end}"/>
2330 </antcall>
2331
2332 <!-- Use OpenSSL instead of ZeroSSL to convert the certificate to the .pfx format that tomcat likes, using this cmd:
2333 GS3/bin/windows/openssl/bin/openssl.exe pkcs12 -inkey domain.key -in domain.crt -passin pass:pwd -passout pass:pwd -export -out ${keystore.file}
2334 GS3/bin/windows/openssl/bin/openssl.exe pkcs12 -inkey domain.key -in domain.crt -password pass:pwd -export -out ${keystore.file}
2335 where on windows, keystore.file = fullchain_and_prvtkey.pfx
2336 -->
2337 <exec executable="openssl" osfamily="mac" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
2338 <arg value="pkcs12" />
2339 <arg value="-inkey" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.key" />
2340 <arg value="-in" /><arg value="${packages.home}/tomcat/conf/https_cert/fullchain_and_prvtkey.crt" />
2341 <arg value="-export" />
2342 <arg value="-out" /><arg value="${packages.home}/tomcat/conf/https_cert/${keystore.file}" />
2343 <arg value="-name"/><arg value="greenstone3-tomcat"/><!-- See https://stackoverflow.com/questions/808669/convert-a-cert-pem-certificate-to-a-pfx-certificate -->
2344 <arg value="-password"/><arg value="pass:${keystore.pass}"/>
2345 </exec>
2346
2347 </target>
2348
2349
2350
2351 <target name="setup-https-cert-linux">
2352 <!-- Running as
2353 ./certbot-auto certonly ==standalone ==preferred-challenges http ==email EMAIL -d DOMAINS
2354 expects input from stdin to accept (A) ToS and say Yes (Y) to sharing email.
2355 We can run in non-interactive mode as the user has at this stage already agreed
2356 to LetsEncrypt's Terms of Service and provided an email address.
2357 -->
2358 <exec executable="/bin/bash" dir="${basedir}/bin/${os.bin.dir}" failonerror="true">
2359 <arg value="./certbot-auto"/>
2360 <arg value="certonly"/>
2361 <arg line="${https.testing}"/><!-- https://stackoverflow.com/questions/11840284/pass-arguments-to-apache-ant-exec-task-based-on-the-variables-value -->
2362 <arg value="--standalone"/>
2363 <arg value="--non-interactive"/>
2364 <arg value="--agree-tos"/>
2365 <arg value="--preferred-challenges"/><arg value="http"/>
2366 <arg value="--email"/><arg value="${https.cert.email}"/>
2367 <arg value="--domains"/><arg value="${https.cert.domains}"/>
2368 </exec>
2369
2370 <!-- sudo openssl pkcs12 -export -out /tmp/DOMAIN_fullchain_and_key.p12 \
2371 -in /etc/letsencrypt/live/DOMAIN/fullchain.pem \
2372 -inkey /etc/letsencrypt/live/DOMAIN/privkey.pem \
2373 -name tomcat
2374 Must run as sudo because only admin has access to the pem files that admin
2375 generated in /etc/letsencrypt
2376 See https://computingforgeeks.com/tomcat-7-with-letsencrypt-ssl-certificate/
2377 but also https://community.letsencrypt.org/t/using-lets-encrypt-with-tomcat/41082
2378 which bypasses the step to generate the java keystore jks file
2379 and uses openssl to generate a pfx file instead of a p12 file
2380 -->
2381
2382 <exec executable="sudo" dir="/tmp" failonerror="true">
2383 <arg value="${basedir}/bin/${os.bin.dir}/openssl/bin/openssl"/>
2384 <arg value="pkcs12"/>
2385 <arg value="-export"/>
2386 <arg value="-out"/><arg value="/tmp/${tomcat.server}_fullchain_and_key.p12"/>
2387 <arg value="-in"/><arg value="/etc/letsencrypt/live/${tomcat.server}/fullchain.pem"/>
2388 <arg value="-inkey"/><arg value="/etc/letsencrypt/live/${tomcat.server}/privkey.pem"/>
2389 <arg value="-name"/><arg value="greenstone3-tomcat"/>
2390 <arg value="-password"/><arg value="pass:${keystore.pass}"/>
2391 </exec>
2392
2393 <!-- Finally, mkdir ${packages.home}/tomcat/conf/https_cert
2394 and copy the file /tmp/${tomcat.server}_fullchain_and_key.p12 into it
2395 and rename to a slightly shorter and simpler name,
2396 see https://stackoverflow.com/questions/8971187/ant-renaming-while-copying-file
2397 The file in tmp has root permissions. But copying it from tmp into
2398 the local account will give the copy local account permissions.
2399 Then sudo to remove the original copy in /tmp
2400 -->
2401 <mkdir dir="${packages.home}/tomcat/conf/https_cert"/>
2402 <!--<copy file="/tmp/${tomcat.server}_fullchain_and_key.p12" todir="${packages.home}/tomcat/conf/https_cert"/>-->
2403 <copy todir="${packages.home}/tomcat/conf/https_cert">
2404 <fileset file="/tmp/${tomcat.server}_fullchain_and_key.p12"/>
2405 <globmapper from="${tomcat.server}_fullchain_and_key.p12" to="${keystore.file}"/>
2406 </copy>
2407
2408 <exec executable="sudo" dir="/tmp" failonerror="true">
2409 <arg line="rm -f /tmp/${tomcat.server}_fullchain_and_key.p12" />
2410 </exec>
2411
2412 </target>
2413
2414
2415 <!-- Revoke the certificate and remove it, including folders.
2416 See https://certbot.eff.org/docs/using.html#revoking-certificates
2417 which also states "if a certificate is a test certificate obtained via the
2418 ==staging or ==test-cert flag, that flag must be passed to the revoke subcommand."
2419 -->
2420 <target name="remove-https-cert">
2421 <echo>
2422 NOTE: If you're on Linux, you need to have sudo permissions to execute this target.
2423 Enter the sudo password if prompted.
2424 </echo>
2425 <!--
2426 On linux, we use certbot-auto.
2427 It says at https://github.com/certbot/certbot/issues/1741
2428 "you shouldn't run letsencrypt-auto [now called certbot-auto] as superuser,
2429 because the program will invoke sudo when it needs to automatically."
2430 We need to send Y(es) as inputstring to confirm that the
2431 /etc/letsencrypt/live/${tomcat.server} folder can be deleted.
2432 Note osfamily="unix" is separate from osfamily="mac", which comes out handy here as we haven't set up certbot-auto for mac (yet).
2433 -->
2434 <exec executable="./certbot-auto" os="${os.linux},${os.solaris}" dir="${basedir}/bin/${os.bin.dir}" failonerror="true" inputstring="Y">
2435 <arg value="revoke"/>
2436 <arg line="${https.testing}"/>
2437 <arg value="--cert-path"/><arg value="/etc/letsencrypt/live/${tomcat.server}/cert.pem"/>
2438 </exec>
2439 <!-- The above command already deletes the folder when Y(es) was passed in. Explicitly deleting:
2440 <exec executable="./certbot-auto" dir="${basedir}/bin/${os.bin.dir}" failonerror="true">
2441 <arg value="delete"/>
2442 <arg value="==cert-name"/><arg value="${tomcat.server}"/>
2443 </exec>
2444 -->
2445
2446 <!-- On Windows and Mac, we use zeroSSl. For the revoke command, see https://zerossl.com/usage.html#Certificate_revocation -->
2447 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}" spawn="false">
2448 <arg value="/c" />
2449 <arg value="le${os.bitness}" />
2450 <arg value="--key" /><arg value="${packages.home}\tomcat\conf\https_cert\privkey.key" />
2451 <arg value="--crt" /><arg value="${packages.home}\tomcat\conf\https_cert\fullchain_and_prvtkey.crt"/>
2452 <arg value="--revoke"/>
2453 <arg line="${https.testing}"/>
2454 </exec>
2455
2456 <!-- On Mac, we use the le.pl we compiled up (Crypt::LE) and which needs to have PERL5LIB set correctly to run -->
2457 <exec executable="perl" osfamily="mac" dir="${gs2build.home}/perllib/cpan/Crypt/LE/bin" spawn="false">
2458 <env key="PERL5LIB" value="${gs2build.home}/perllib/cpan${path.separator}${gs2build.home}/perllib/cpan/perl-5.18"/>
2459 <arg value="-S" />
2460 <arg value="${gs2build.home}/perllib/cpan/Crypt/LE/bin/le.pl" />
2461 <arg value="--key" /><arg value="${packages.home}/tomcat/conf/https_cert/privkey.key" />
2462 <arg value="--crt" /><arg value="${packages.home}/tomcat/conf/https_cert/fullchain_and_prvtkey.crt"/>
2463 <arg value="--revoke"/>
2464 <arg line="${https.testing}"/>
2465 </exec>
2466
2467 <!-- And remove the https_cert folder -->
2468 <delete dir="${packages.home}/tomcat/conf/https_cert"/>
2469 </target>
2470
2471
2472 <!-- Renewing existing https certificate
2473 Linux:
2474 https://certbot.eff.org/docs/using.html#renewing-certificates
2475 ./path/to/GS3/bin/linux/certbot-auto renew ==quiet ==no-self-upgrade
2476 Windows: reuse Windows issuance target
2477 see https://zerossl.com/usage.html#Certificate_renewal
2478 -->
2479 <target name="renew-existing-https-cert">
2480 <echo>
2481 NOTE: To run this target,
2482 * ensure nothing is running on port 80
2483 * if you're on Linux or Mac, you need to have sudo permissions. Enter the sudo password if prompted.
2484
2485 If you want your cronjob to renew a certificate, you can add pre and post hooks
2486 refer to https://certbot.eff.org/docs/using.html#renewing-certificates
2487 For more information run:
2488 ./path/to/GS3/bin/linux/certbot-auto --help renew
2489 </echo>
2490 <exec executable="./certbot-auto" os="${os.linux},${os.solaris}" dir="${basedir}/bin/${os.bin.dir}" failonerror="true">
2491 <arg value="renew"/>
2492 <arg value="--quiet"/>
2493 <arg value="--no-self-upgrade"/>
2494 </exec>
2495
2496 <!-- For renewal on Windows or Mac, we use ZeroSSL as intermediary between GS3 and Let's Encrypt.
2497 And when using ZeroSSL we need to re-run the original (issuance) command and append "min-min-renew XX" to it,
2498 where if it's within XX days of expiry, the certificate will get renewed.
2499 See https://zerossl.com/usage.html#Certificate_renewal -->
2500 <if><bool><or>
2501 <istrue value="${current.os.iswindows}"/>
2502 <istrue value="${current.os.ismac}"/>
2503 </or></bool>
2504
2505 <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>
2506 <condition property="https.cert.domains" value="${tomcat.server},${https.other.domains}" else="${tomcat.server}">
2507 <and>
2508 <isset property="https.other.domains" />
2509 <not><matches string="${https.other.domains}" pattern="^\s*$"/></not>
2510 </and>
2511 </condition>
2512 <if><bool><istrue value="${current.os.iswindows}"/></bool>
2513 <antcall target="setup-https-cert-windows">
2514 <param name="https.cert.renewal" value="--renew 10"/>
2515 </antcall>
2516 <else>
2517 <antcall target="setup-https-cert-mac">
2518 <param name="https.cert.renewal" value="--renew 10"/>
2519 </antcall>
2520 </else>
2521 </if>
2522 </if>
2523 </target>
2524
2525 <!-- ======================= Tomcat Targets ========================== -->
2526
2527 <!-- this target downloads and installs Tomcat -->
2528 <!-- we download tomcat (version 7 for Java 1.5 and later, version 5 for Java 1.4 plus the 1.4 compatibility package). -->
2529 <target name="prepare-tomcat" depends="init,setup-proxy" if="tomcat.islocal"
2530 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">
2531 <echo>Checking for existence of: ${packages.home}/tomcat/.flagfile</echo>
2532 <if>
2533 <bool>
2534 <not><available file="${packages.home}/tomcat/.flagfile"/></not>
2535 </bool>
2536
2537 <!-- check that packages dir is there -->
2538 <mkdir dir="${packages.home}"/>
2539 <!--
2540 <get src="${gsorg.root}/gs3files/${tomcat.version}.zip"
2541 dest="${packages.home}/${tomcat.version}.zip"
2542 usetimestamp="true"/>
2543 -->
2544 <if>
2545 <bool>
2546 <os family="mac" />
2547 </bool>
2548 <exec executable="curl" failonerror="true">
2549 <arg value="-o"/>
2550 <arg value="${packages.home}/${tomcat.version}.zip"/>
2551 <arg value="${gsorg.root}/gs3files/${tomcat.version}.zip"/>
2552 </exec>
2553 <else>
2554 <exec executable="${wget}" failonerror="true">
2555 <arg value="-P"/><!-- specifying output dir, also: minus-minus-directory-prefix -->
2556 <arg value="${packages.home}"/>
2557 <arg value="--no-check-certificate"/>
2558 <arg value="${gsorg.root}/gs3files/${tomcat.version}.zip"/>
2559 </exec>
2560 </else>
2561 </if>
2562
2563 <unzip src="${packages.home}/${tomcat.version}.zip"
2564 dest="${packages.home}"/>
2565
2566 <!-- If we are using Java 1.4, we'd be using tomcat 5.5 in which case
2567 we would need to have the tomcat compat package to work with Java 1.4-->
2568 <if>
2569 <bool><equals arg1="1.4" arg2="${java.specification.version}"/></bool>
2570 <!--
2571 <get src="${gsorg.root}/gs3files/${tomcat.version}-compat.zip"
2572 dest="${packages.home}/${tomcat.version}-compat.zip"
2573 usetimestamp="true"/>
2574 -->
2575
2576 <if>
2577 <bool><os family="mac" /></bool>
2578 <exec executable="curl" failonerror="true">
2579 <arg value="-o"/>
2580 <arg value="${packages.home}/${tomcat.version}-compat.zip"/>
2581 <arg value="${gsorg.root}/gs3files/${tomcat.version}-compat.zip"/>
2582 </exec>
2583 <else>
2584 <exec executable="${wget}" failonerror="true">
2585 <arg value="-P"/>
2586 <arg value="${packages.home}"/>
2587 <arg value="--no-check-certificate"/>
2588 <arg value="${gsorg.root}/gs3files/${tomcat.version}-compat.zip"/>
2589 </exec>
2590 </else>
2591 </if>
2592
2593 <unzip src="${packages.home}/${tomcat.version}-compat.zip"
2594 dest="${packages.home}"/>
2595 </if>
2596
2597 <!-- delete any existing tomcat -->
2598 <delete dir="${packages.home}/tomcat"/>
2599 <move todir="${packages.home}/tomcat">
2600 <fileset dir="${packages.home}/${tomcat.version}"/>
2601 </move>
2602
2603 <!-- To avoid the CGI permissions error appearing continuously in the (localhost) log,
2604 need privileged=true set in the root context.xml file too, not just greenstone context file.
2605 See http://stackoverflow.com/questions/9845936/tomcat-v7-0-load-exception-marking-servlet-ssi-as-unavailable/10305471#10305471
2606 For usage of IfTask IsLessThan: http://antelope.stage.tigris.org/nonav/docs/manual/bk03ch05s02.html -->
2607 <if><bool><not><islessthan arg1="${tomcat.version.major}" arg2="7"/></not></bool>
2608 <copy file="${basedir}/resources/tomcat/root_context.xml.in" tofile="${packages.home}/tomcat/conf/context.xml" overwrite="true" />
2609 </if>
2610
2611
2612 <!--
2613 <copy file="${basedir}/resources/tomcat/setclasspath.bat"
2614 tofile="${packages.home}/tomcat/bin/setclasspath.bat"
2615 overwrite="true"/>
2616 <copy file="${basedir}/resources/tomcat/setclasspath.sh"
2617 tofile="${packages.home}/tomcat/bin/setclasspath.sh"
2618 overwrite="true"/>
2619 -->
2620 <!-- make sure we have execute permission for the .sh files -->
2621 <chmod dir="${packages.home}/tomcat/bin" perm="ugo+rx"
2622 includes="*.sh"/>
2623
2624 <echo file="${packages.home}/tomcat/.flagfile">
2625 the timestamp of this file is the time that tomcat was extracted from the zip files.
2626 it is used to figure out whether the files need to be refreshed or not in `ant prepare-tomcat`
2627 </echo>
2628
2629 <!-- this is not strictly a prepare tomcat thing, but if one changes
2630 Java, then they need to change tomcat as well, so might as well call
2631 it here -->
2632 <antcall target="configure-java-version"/>
2633 <else>
2634 <echo>Tomcat has been prepared, will not prepare</echo>
2635 <echo>Delete ${packages.home}/tomcat/.flagfile to force refresh</echo>
2636 </else>
2637
2638 </if>
2639
2640 </target>
2641
2642 <target name="configure-tomcat" depends="init,configure-tomcat-local,configure-tomcat-external"/>
2643
2644 <target name="configure-tomcat-local" depends="init,perl-for-building" if="tomcat.islocal">
2645 <!-- re-setup the server.xml file -->
2646 <copy file="${basedir}/resources/tomcat/server_tomcat${tomcat.version.major}.xml.in"
2647 tofile="${packages.home}/tomcat/conf/server.xml" overwrite="true">
2648 <filterset>
2649 <filter token="shutdown-port" value="${tomcat.shutdown.port}"/>
2650 <filter token="tomcat.ajp.port" value="${tomcat.ajp.port}"/>
2651 <filter token="https.redirect.port" value="${https.redirect.port}"/>
2652 <filter token="localhost.port.http" value="${localhost.port.http}"/>
2653 <filter token="tomcat.port.https" value="${tomcat.port.https}"/>
2654 <!-- Relative path preferred for keystore.file, in case tomcat is moved elsewhere -->
2655 <!--<filter token="keystore.file" value="conf/https_cert/${tomcat.server}.jks" />-->
2656 <!--ON UNIX: <filter token="keystore.file" value="conf/https_cert/fullchain_and_prvtkey.p12" />-->
2657 <!--ON WINDOWS: <filter token="keystore.file" value="conf/https_cert/fullchain_and_prvtkey.pfx" />-->
2658 <filter token="keystore.file" value="conf/https_cert/${keystore.file}" />
2659 <!-- tomcat Connector's keystoreType param defaults to JKS (Java keystore), see https://tomcat.apache.org/tomcat-7.0-doc/config/http.html
2660 We'll follow the instructions at https://community.letsencrypt.org/t/using-lets-encrypt-with-tomcat/41082,
2661 https://www.ssl.com/how-to/create-a-pfx-p12-certificate-file-using-openssl/
2662 and https://computingforgeeks.com/tomcat-7-with-letsencrypt-ssl-certificate/
2663 (minus the keytool step) and use the PKCS12 file generated by openssl directly,
2664 instead of an additional step to generate the java keystore file from that -->
2665 <filter token="keystore.type" value="PKCS12"/>
2666 <filter token="keystore.pass" value="${keystore.pass}"/>
2667 <!--
2668 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)
2669 In that case, see https://serverfault.com/questions/218666/how-to-configure-tomcat-to-only-listen-to-127-0-0-1
2670 -->
2671 <filter token="http.address.restriction" value="${http.address.restriction}"/>
2672 <filter token="https.comment.out.start" value="${https.comment.out.start}"/>
2673 <filter token="https.comment.out.end" value="${https.comment.out.end}"/>
2674 </filterset>
2675 </copy>
2676
2677 <!-- set up the solr context -->
2678
2679 <!-- First work out the IPv4 address for this machine -->
2680 <exec executable="${basedir}/bin/script/IPv4.sh" os="${os.unix}" failonerror="false" outputproperty="ipv4.val">
2681 <arg value="-format-for-tomcat-context"/>
2682 </exec>
2683 <exec executable="${basedir}/bin/script/IPv4.bat" osfamily="windows" failonerror="false" outputproperty="ipv4.val">
2684 <arg value="-format-for-tomcat-context"/>
2685 </exec>
2686
2687 <copy file="${basedir}/ext/solr/solr-tomcat-context.xml.in" tofile="${packages.home}/tomcat/conf/Catalina/localhost/solr.xml" overwrite="true">
2688 <filterset>
2689 <filter token="solr.context" value="${solr.context}"/>
2690 <filter token="gsdl3webhome" value="${web.writablehome}"/>
2691 <filter token="tomcathome" value="${basedir}/packages/tomcat"/>
2692 <filter token="IPv4" value="${ipv4.val}"/>
2693 </filterset>
2694 </copy>
2695
2696 <!-- set up the greenstone3 context, it may have a custom name specified in build.properties -->
2697 <if><bool><not><equals arg1="greenstone3" arg2="${greenstone.context}"></equals></not></bool>
2698 <copy file="${basedir}/resources/tomcat/greenstone3.xml.in" tofile="${basedir}/resources/tomcat/${greenstone.context}.xml.in" overwrite="true"/>
2699 </if>
2700 <copy file="${basedir}/resources/tomcat/${greenstone.context}.xml.in" tofile="${packages.home}/tomcat/conf/Catalina/localhost/${greenstone.context}.xml" overwrite="true">
2701 <filterset>
2702 <filter token="gsdl3webhome" value="${web.home}"/>
2703 <filter token="gsdl3webwritablehome" value="${web.writablehome}"/>
2704 <filter token="privilegedattribute" value="${privileged.attribute}"/>
2705 <filter token="allowlinking" value="${tomcat.allowLinking}"/>
2706 <filter token="allowedIPs" value="${allowed.IPs}"/>
2707 <filter token="derbyserver" value="${derby.server}"/>
2708 <filter token="derbyserverport" value="${derby.server.port}"/>
2709 <filter token="googlesigninclientid" value="${tomcat.googlesigninJDBCRealm.clientid}"/>
2710
2711 </filterset>
2712 </copy>
2713 <if>
2714 <bool>
2715 <and>
2716 <available file="${packages.home}/tomcat/conf/Catalina/localhost/greenstone3.xml"/>
2717 <not><equals arg1="greenstone3" arg2="${greenstone.context}"></equals></not>
2718 </and>
2719 </bool>
2720 <delete file="${packages.home}/tomcat/conf/Catalina/localhost/greenstone3.xml"/>
2721 </if>
2722
2723 <!-- set up the greenstone3 web.xml file -->
2724 <copy file="${basedir}/resources/tomcat/web8.xml.in" tofile="${packages.home}/tomcat/conf/web.xml" overwrite="true">
2725 <filterset>
2726 <filter token="perlpath" value="${perl.path}"/>
2727 </filterset>
2728 </copy>
2729 </target>
2730
2731 <target name="configure-tomcat-external" depends="init" unless="tomcat.islocal">
2732 <!-- re-setup the server.xml file -->
2733 <!-- need to edit the config file, or do we get the user to do this???-->
2734 </target>
2735
2736 <target name="configure-solr-ext" depends="init" >
2737 <!-- re-setup the web/ext/solr/solr.xml file -->
2738 <copy file="${web.home}/ext/solr/solr.xml.in"
2739 tofile="${gsdl3.writablehome}/ext/solr/solr.xml" filtering="true" overwrite="true">
2740 <filterset>
2741 <filter token="gsdl3.home" value="${src.gsdl3.home.unix}"/>
2742 <filter token="gsdl3.writablehome" value="${src.gsdl3.writablehome.unix}"/>
2743 </filterset>
2744 </copy>
2745 </target>
2746
2747 <target name="configure-webswing-ext" depends="init" >
2748 <exec executable="ant.bat" osfamily="windows" dir="${webswing-ext.home}" spawn="false" failonerror="true">
2749 <arg value="-Dweb.home=${web.home.unix}"/>
2750 <arg value="-Dweb.writablehome=${web.writablehome.unix}"/>
2751 <arg value="configure-extension"/>
2752 </exec>
2753 <exec executable="ant" os="${os.unix}" dir="${webswing-ext.home}" spawn="false" failonerror="true">
2754 <arg value="-Dweb.home=${web.home}"/>
2755 <arg value="-Dweb.writablehome=${web.writablehome}"/>
2756 <arg value="configure-extension"/>
2757 </exec>
2758
2759 <if>
2760 <bool><available file="${web.writablehome}/ext/webswing/etc/catalina-opts-extra.args"/></bool>
2761 <loadfile property="webswing.catalina.opts" srcfile="${web.writablehome}/ext/webswing/etc/catalina-opts-extra.args" failonerror="true"/>
2762 <else>
2763 <property name="webswing.catalina.opts" value=""/>
2764 </else>
2765 </if>
2766 </target>
2767
2768 <!-- This target runs tomcat's "bin/catalina.bat(.sh) jpda start"
2769 to allow debugging the running GS3 server in Eclipse. See the instructions at
2770 http://www.wikijava.org/wiki/Debugging_a_servlet_with_tomcat_and_Eclipse_tutorial
2771 on how to use this with eclipse
2772 -->
2773 <target name="debug-start-tomcat" description="Startup Tomcat for debugger" depends="envbased-localtomcat-path,configure-webswing-ext,init" if="tomcat.islocal">
2774 <property name="tomcat.classpath" refid="local.tomcat.classpath"/>
2775 <property name="tomcat.path" refid="local.tomcat.path"/>
2776
2777 <if><bool>
2778 <isset property="fedora.maxpermsize"/></bool>
2779 <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}"/>
2780 <else>
2781 <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}"/>
2782 </else>
2783 </if>
2784
2785 <echo file="${catalina.home}/bin/setenv.bat">set CLASSPATH=${tomcat.classpath}</echo>
2786 <echo file="${catalina.home}/bin/setenv.sh">export CLASSPATH=${tomcat.classpath}</echo>
2787
2788 <exec executable="${catalina.home}/bin/catalina.sh" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">
2789 <env key="JPDA_ADDRESS" value="8000"/> <!-- for debugging Tomcat in Eclipse -->
2790 <env key="JPDA_TRANSPORT" value="dt_socket"/> <!-- for debugging Tomcat in Eclipse -->
2791 <!--<env key="GSDLOS" value="linux"/> do we need this?? -->
2792 <env key="PATH" path="${tomcat.path}"/>
2793 <!-- Based on:
2794 https://jfrog.com/knowledge-base/tomcat-takes-forever-to-start-what-can-i-do/
2795 consider controlling Tomcat to use the psuedo random number generator '/dev/urandom'
2796 raher than the default '/dev/random' which while cryptographically stronger is
2797 also slower when demand is high
2798
2799 -Djava.security.egd=file:/dev/urandom
2800 -->
2801 <env key="CATALINA_OPTS" value="${catalina.opts}"/>
2802 <env key="CATALINA_HOME" value="${catalina.home}"/>
2803 <env key="CLASSPATH" path="${tomcat.classpath}"/>
2804 <env key="LD_LIBRARY_PATH" path="${env.LD_LIBRARY_PATH}:${lib.jni}"/>
2805 <env key="DYLD_LIBRARY_PATH" path="${env.DYLD_LIBRARY_PATH}:${lib.jni}:${gdbm.home}/lib"/> <!-- for mac os --> <!-- need gdbm here these days ??-->
2806 <env key="WNHOME" path="${wn.home}"/>
2807 <env key="FEDORA_HOME" path="${fedora.home}"/>
2808
2809 <env key="_RUNJAVA" value="${env.CATALINA_START_RUNJAVA}"/>
2810 <arg value="jpda" />
2811 <arg value="start" />
2812 </exec>
2813 <exec executable="${catalina.home}/bin/catalina.bat" osfamily="windows" dir="${catalina.home}/bin" spawn="true">
2814 <env key="JPDA_ADDRESS" value="8000"/> <!-- for debugging Tomcat in Eclipse -->
2815 <env key="JPDA_TRANSPORT" value="dt_socket"/> <!-- for debugging Tomcat in Eclipse -->
2816 <env key="GSDLOS" value="windows"/>
2817 <env key="GSDL3HOME" value="${web.home}"/>
2818 <env key="Path" path="${tomcat.path}"/>
2819 <env key="PATH" path="${tomcat.path}"/>
2820 <env key="CATALINA_OPTS" value="${catalina.opts}"/>
2821 <env key="CATALINA_HOME" value="${catalina.home}"/>
2822 <env key="CLASSPATH" path="${tomcat.classpath}"/>
2823 <env key="FEDORA_HOME" path="${fedora.home}"/>
2824
2825 <arg value="jpda" />
2826 <arg value="start" />
2827 </exec>
2828 <!-- wait for the server to startup in case other targets need it running -->
2829 <waitfor maxwait="5" maxwaitunit="second">
2830 <and>
2831 <socket server="${tomcat.server}" port="${default.tomcat.port}"/>
2832 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/index.html"/>-->
2833 <http url="${local.http.url}${app.path}/index.html"/>
2834 </and>
2835 </waitfor>
2836 </target>
2837
2838 <target name="start-tomcat" description="Startup only Tomcat" depends="check-tomcat-started">
2839
2840 <if><bool><istrue value="${tomcat.isstarted}"/></bool>
2841 <echo>**************************************</echo>
2842 <echo>A WEB SERVER IS ALREADY RUNNING ON ${default.server.protocol}://${tomcat.server}:${default.tomcat.port} (${local.http.url}). NOT STARTING.</echo>
2843 <echo>**************************************</echo>
2844 <else>
2845 <antcall target="force-start-tomcat"/>
2846 </else>
2847 </if>
2848 </target>
2849
2850 <!-- Another way: http://ptrthomas.wordpress.com/2006/03/25/how-to-start-and-stop-tomcat-from-ant/ -->
2851 <target name="force-start-tomcat" description="Startup only Tomcat" depends="envbased-localtomcat-path,configure-webswing-ext,init" if="tomcat.islocal">
2852
2853 <property name="tomcat.classpath" refid="local.tomcat.classpath"/>
2854 <property name="tomcat.path" refid="local.tomcat.path"/>
2855
2856 <if><bool>
2857 <isset property="fedora.maxpermsize"/></bool>
2858 <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}"/>
2859 <else>
2860 <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}"/>
2861 </else>
2862 </if>
2863
2864 <echo file="${catalina.home}/bin/setenv.bat">set CLASSPATH=${tomcat.classpath}</echo>
2865 <echo file="${catalina.home}/bin/setenv.sh">export CLASSPATH=${tomcat.classpath}</echo>
2866
2867 <!-- using osfamily instead of testing os against os.windows list of recognised windows versions
2868 so that future windows versions are included. See http://simonharrer.wordpress.com/tag/osfamily/
2869 Can't use the osfamily test for linux-type machines as a group since osfamily=unix is separate from osfamily=mac,
2870 see http://ant-contrib.sourceforge.net/tasks/tasks/osfamily.html -->
2871
2872 <exec executable="${sudo.or.not}" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">
2873 <!--<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-->
2874 <env key="CATALINA_OPTS" value="${catalina.opts}"/>
2875 <env key="CATALINA_HOME" value="${catalina.home}"/>
2876 <env key="CLASSPATH" path="${tomcat.classpath}"/>
2877 <env key="PATH" path="${tomcat.path}"/>
2878
2879 <env key="LD_LIBRARY_PATH" path="${env.LD_LIBRARY_PATH}:${lib.jni}"/>
2880 <env key="DYLD_LIBRARY_PATH" path="${env.DYLD_LIBRARY_PATH}:${lib.jni}:${gdbm.home}/lib"/> <!-- for mac os --> <!-- need gdbm here these days ??-->
2881
2882 <!-- Webswing servlet needs the following enviornent variables to be set to be able to run GLI -->
2883 <env key="GSDL3SRCHOME" value="${env.GSDL3SRCHOME}"/>
2884 <env key="GSDL3HOME" value="${web.home}"/> <!-- consider changing to env.GSDL3HOME to be more consistent? -->
2885 <env key="GSDLHOME" value="${env.GSDLHOME}"/> <!-- i.e., gs2build.home -->
2886 <env key="GSDL3EXTS" value="${env.GSDL3EXTS}"/>
2887 <env key="GSDLEXTS" value="${env.GSDLEXTS}"/>
2888 <env key="GEXT_SOLR" value="${env.GEXT_SOLR}"/>
2889 <env key="GSDLOS" value="${env.GSDLOS}"/>
2890
2891 <env key="WNHOME" path="${wn.home}"/>
2892 <env key="FEDORA_HOME" path="${fedora.home}"/>
2893
2894 <env key="_RUNJAVA" value="${env.CATALINA_START_RUNJAVA}"/>
2895 <arg value="${catalina.home}/bin/startup.sh"/>
2896 </exec>
2897 <exec executable="${catalina.home}/bin/startup.bat" osfamily="windows" dir="${catalina.home}/bin" spawn="true">
2898 <!--<env key="JAVA_TOOL_OPTIONS" value="-Dfile.encoding=UTF-8"/>-->
2899 <env key="CATALINA_OPTS" value="${catalina.opts}"/>
2900 <env key="CATALINA_HOME" value="${catalina.home}"/>
2901 <env key="CLASSPATH" path="${tomcat.classpath}"/>
2902
2903 <env key="PATH" path="${tomcat.path}"/>
2904 <env key="Path" path="${tomcat.path}"/>
2905 <!-- Should the equivalent LD_LIBRARY_PATH line above for Unix, be turned into an equivalent PATH update, as this is what Windows uses? -->
2906
2907 <!-- Webswing servlet needs the following enviornent variables to be set to be able to run GLI -->
2908 <env key="GSDL3SRCHOME" value="${env.GSDL3SRCHOME}"/>
2909 <env key="GSDL3HOME" value="${web.home}"/> <!-- consider changing to env.GSDL3HOME to be more consistent? -->
2910 <env key="GSDLHOME" value="${env.GSDLHOME}"/> <!-- i.e., gs2build.home -->
2911 <env key="GSDL3EXTS" value="${env.GSDL3EXTS}"/>
2912 <env key="GSDLEXTS" value="${env.GSDLEXTS}"/>
2913 <env key="GEXT_SOLR" value="${env.GEXT_SOLR}"/>
2914 <env key="GSDLOS" value="${env.GSDLOS}"/> <!-- used to be hardwired to 'windows', but now gs3-setup.sh run, GSDLOS should be set -->
2915
2916 <env key="WNHOME" path="${wn.home}"/>
2917 <env key="FEDORA_HOME" path="${fedora.home}"/>
2918 </exec>
2919 <!-- wait for the server to startup in case other targets need it running -->
2920 <waitfor maxwait="5" maxwaitunit="second">
2921 <and>
2922 <socket server="${tomcat.server}" port="${default.tomcat.port}"/>
2923 <!-- waiting on the following can be time-consuming, and doesn't really gain you much, so commenting out
2924 (note however it is still included in the debug-start-tomcat target above for extra debug robustness) -->
2925 <!-- <http url="${local.http.url}${app.path}/index.html"/> -->
2926 </and>
2927 </waitfor>
2928
2929 </target>
2930
2931 <!--ant task http: http://www.jajakarta.org/ant/ant-1.6.1/docs/ja/manual/api/org/apache/tools/ant/taskdefs/condition/Http.html-->
2932 <target name="reconfigure" description="Reconfigure the message router">
2933 <waitfor maxwait="5" maxwaitunit="second">
2934 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}${server.default.servlet}?a=s&amp;sa=c"/>-->
2935 <http url="${local.http.url}${app.path}${server.default.servlet}?a=s&amp;sa=c"/>
2936 </waitfor>
2937 </target>
2938
2939 <!--Command-line args to Ant: http://www.jguru.com/faq/view.jsp?EID=471794-->
2940 <target name="reconfigure-collection" description="Reconfigure the collection">
2941 <waitfor maxwait="5" maxwaitunit="second">
2942 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}${server.default.servlet}?a=s&amp;sa=c&amp;sc=${collection}"/>-->
2943 <http url="${local.http.url}${app.path}${server.default.servlet}?a=s&amp;sa=c&amp;sc=${collection}"/>
2944 </waitfor>
2945 </target>
2946
2947 <!-- windows: do we want to launch a webrowser?? -->
2948 <!-- shouldn't this test whether anything is running first?
2949 It's safer to always attempt to stop tomcat: that way we won't be dependent on the right time
2950 to check whether the server is stopped or still running before attempting to start again.
2951 This target, which was recently called force-stop-tomcat for a while but is back to being
2952 called stop-tomcat, now hides the Java exception output that appears whenever tomcat is already
2953 stopped as happens when stop-tomcat is called consecutively. -->
2954 <target name="force-stop-tomcat" description="Shutdown only Tomcat" depends="init" if="tomcat.islocal">
2955 <!--<exec executable="${catalina.home}/bin/shutdown.sh" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">-->
2956 <exec executable="${sudo.or.not}" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">
2957 <!--<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-->
2958 <env key="FEDORA_HOME" path="${fedora.home}"/>
2959 <env key="CATALINA_HOME" value="${catalina.home}"/>
2960 <arg value="${catalina.home}/bin/shutdown.sh"/>
2961 <arg line=">/dev/null 2>&amp;1"/>
2962 </exec>
2963 <exec executable="${catalina.home}/bin/shutdown.bat" osfamily="windows" dir="${catalina.home}/bin" spawn="false">
2964 <!--<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? -->
2965 <env key="FEDORA_HOME" path="${fedora.home}"/>
2966 <env key="CATALINA_HOME" value="${catalina.home}"/>
2967 <arg line=">nul 2>&amp;1"/>
2968 </exec>
2969 </target>
2970
2971 <!-- Can also try the "socket" condition in place of the "http" condition
2972 And also use a <waitfor> in place of <condition>, such as:
2973 <waitfor maxwait="5" maxwaitunit="second" timeoutproperty="tomcat.isstopped"><http url="..."/></waitfor>
2974 The http URL resolves to host:port/greenstone3
2975 Condition uses <http/> rather than <socket/> for testing, since if the server was stopped, the socket
2976 might still be in use for some moments. We test the URL with the http condition since it's likelier to
2977 fail sooner if the server has indeed been stopped. -->
2978 <target name="check-tomcat-running">
2979 <condition property="tomcat.isrunning">
2980 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}"/>-->
2981 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}"/>--><!-- untrusted certificates won't work, so don't test https urls-->
2982 <http url="${local.http.url}"/><!-- testing the local http url instead -->
2983 </condition>
2984 </target>
2985
2986 <!--
2987 <target name="verbose-check-tomcat-running">
2988 <condition property="tomcat.isrunning" value="true" else="false">
2989 <http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}"/>
2990 <http url="${local.http.url}"/>
2991 </condition>
2992 <echo>Tomcat is running: ${tomcat.isrunning}</echo>
2993 </target>
2994 -->
2995 <target name="verbose-check-tomcat-running" depends="check-tomcat-running">
2996 <if>
2997 <bool>
2998 <istrue value="${tomcat.isrunning}"/>
2999 </bool>
3000 <echo>Tomcat is running: ${tomcat.isrunning}</echo>
3001 <else><echo>Tomcat is running: false</echo></else><!-- tomcat.isrunning not set -->
3002 </if>
3003 </target>
3004
3005 <!-- Need a copy of the check-tomcat-running target with a distinct property, because ant restart runs
3006 both stop and start, both of which need to do tomcat checks. Each property can be set only once during
3007 an invocation with ant. So ant restart will need two properties to store each of the tomcat checks -->
3008 <target name="check-tomcat-started">
3009 <condition property="tomcat.isstarted">
3010 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}"/>-->
3011 <http url="${local.http.url}"/>
3012 </condition>
3013 </target>
3014
3015
3016
3017 <!-- stop-tomcat checks if the tomcat server is already running. If it appears to be running
3018 (regardless of whether tomcat was just starting to shut down), this target calls force-stop-tomcat
3019 to issue the shutdown command to tomcat. Then it waits for at most 15 seconds for the server to
3020 actually stop by checking the socket at which tomcat listens every second, printing a warning
3021 at the end of the max wait time of 15 seconds if tomcat was still running. -->
3022 <target name="stop-tomcat" description="Shutdown only Tomcat if running" depends="check-tomcat-running" if="tomcat.isrunning">
3023 <antcall target="force-stop-tomcat"/>
3024
3025 <property name="wait.numchecks" value="15"/>
3026 <echo>Waiting for the server to shutdown... (${wait.numchecks} seconds max)</echo>
3027 <waitfor maxwait="${wait.numchecks}" maxwaitunit="second" checkevery="1" checkeveryunit="second" timeoutproperty="tomcat.timedout">
3028 <not><socket server="${tomcat.server}" port="${default.tomcat.port}"/></not>
3029 </waitfor>
3030
3031 <if>
3032 <bool>
3033 <isset property="${tomcat.timedout}"/>
3034 </bool>
3035 <property name="tomcat.isrunning" value="true"/>
3036 <echo>WARNING: Checked the socket ${wait.numchecks} times, but port ${default.tomcat.port} is still busy.</echo>
3037 <else>
3038 <echo>Tomcat is stopped.</echo>
3039 <property name="tomcat.isrunning" value="false"/>
3040 </else>
3041 </if>
3042 </target>
3043
3044 <target name="restart-tomcat" description="Shutdown and restart only Tomcat" depends="init,stop-tomcat,force-start-tomcat"/>
3045
3046 <target name="setup-catalina-ant-tasks">
3047 <!-- Configure the custom Ant tasks for the Tomcat Manager application -->
3048 <taskdef name="deploy" classname="org.apache.catalina.ant.DeployTask"
3049 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
3050 <taskdef name="list" classname="org.apache.catalina.ant.ListTask"
3051 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
3052 <taskdef name="reload" classname="org.apache.catalina.ant.ReloadTask"
3053 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
3054 <taskdef name="resources" classname="org.apache.catalina.ant.ResourcesTask"
3055 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
3056 <taskdef name="roles" classname="org.apache.catalina.ant.RolesTask"
3057 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
3058 <taskdef name="start" classname="org.apache.catalina.ant.StartTask"
3059 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
3060 <taskdef name="stop" classname="org.apache.catalina.ant.StopTask"
3061 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
3062 <taskdef name="undeploy" classname="org.apache.catalina.ant.UndeployTask"
3063 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
3064 </target>
3065
3066 <!-- http://blog.andrewbeacock.com/2007/11/how-to-truncate-log-file-using-ubuntu.html
3067 Doing "cat </dev/null > packages/tomcat/logs/catalina.out" doesn't work as an ant target.
3068 It seems to have a problem with cat or </dev/null, with or without the < sign. -->
3069 <target name="reset-logs" description="Empties catalina.out, solr.log, greenstone.log, usage.log, server.log and contents of web/logs/tmp">
3070 <echo>Truncating catalina.out, solr.log, greenstone.log, usage.log and server.log, and emptying ${web.writablehome}/logs/tmp</echo>
3071 <exec executable="rm" os="${os.unix}" dir="${catalina.home}/logs" spawn="false">
3072 <arg value="-f"/>
3073 <arg value="catalina.out"/>
3074 </exec>
3075 <exec executable="rm" os="${os.unix}" dir="${web.writablehome}/logs" spawn="false">
3076 <arg value="-f"/>
3077 <arg value="greenstone.log"/>
3078 </exec>
3079 <exec executable="rm" os="${os.unix}" dir="${web.writablehome}/logs" spawn="false">
3080 <arg value="-f"/>
3081 <arg value="usage.log"/>
3082 </exec>
3083 <exec executable="rm" os="${os.unix}" dir="${web.writablehome}/logs" spawn="false">
3084 <arg value="-f"/>
3085 <arg value="server.log"/>
3086 </exec>
3087
3088 <exec executable="touch" os="${os.unix}" dir="${catalina.home}/logs"
3089 spawn="false">
3090 <arg value="catalina.out"/>
3091 </exec>
3092 <exec executable="touch" os="${os.unix}" dir="${web.writablehome}/logs"
3093 spawn="false">
3094 <arg value="greenstone.log"/>
3095 </exec>
3096 <exec executable="touch" os="${os.unix}" dir="${web.writablehome}/logs"
3097 spawn="false">
3098 <arg value="usage.log"/>
3099 </exec>
3100 <exec executable="touch" os="${os.unix}" dir="${web.writablehome}/logs"
3101 spawn="false">
3102 <arg value="server.log"/>
3103 </exec>
3104
3105 <exec executable="cmd" osfamily="windows" dir="${catalina.home}/logs" spawn="false">
3106 <arg line="/c echo. > catalina.out"/>
3107 </exec>
3108 <exec executable="cmd" osfamily="windows" dir="${web.writablehome}/logs" spawn="false">
3109 <arg line="/c echo. > greenstone.log"/>
3110 </exec>
3111 <exec executable="cmd" osfamily="windows" dir="${web.writablehome}/logs" spawn="false">
3112 <arg line="/c echo. > usage.log"/>
3113 </exec>
3114 <exec executable="cmd" osfamily="windows" dir="${web.writablehome}/logs" spawn="false">
3115 <arg line="/c echo. > server.log"/>
3116 </exec>
3117
3118 <!-- if ext/solr/logs/solr.log exists, truncate it -->
3119 <if><bool><available file="${solr-ext.home}/logs/solr.log" type="file"/></bool>
3120 <exec executable="rm" os="${os.unix}" dir="${solr-ext.home}/logs" spawn="false">
3121 <arg value="-f"/>
3122 <arg value="solr.log"/>
3123 </exec>
3124 <exec executable="touch" os="${os.unix}" dir="${solr-ext.home}/logs" spawn="false">
3125 <arg value="solr.log"/>
3126 </exec>
3127 <exec executable="cmd" osfamily="windows" dir="${solr-ext.home}/logs" spawn="false">
3128 <arg line="/c echo. > solr.log"/>
3129 </exec>
3130 </if>
3131
3132 <if>
3133 <bool><available file="${web.writablehome}/logs/tmp" type="dir"/></bool>
3134 <delete>
3135 <fileset dir="${web.writablehome}/logs/tmp" includes="**/*"/>
3136 </delete>
3137 </if>
3138 </target>
3139
3140 <target name="clear-tomcat-sessions" description="Clear the Tomcat Session info." depends="init">
3141 <exec executable="cmd" osfamily="windows" dir="${catalina.home}/work/Catalina/localhost/greenstone3" spawn="false">
3142 <arg line="/c echo. > SESSIONS.ser"/>
3143 </exec>
3144 <exec executable="rm" os="${os.unix}" dir="${catalina.home}/work/Catalina/localhost/greenstone3" spawn="false">
3145 <arg value="-f"/>
3146 <arg value="SESSIONS.ser"/>
3147 </exec>
3148
3149 </target>
3150 <!-- ======================= ant Targets ============================ -->
3151 <target name="prepare-ant" depends="init">
3152 <if>
3153 <bool>
3154 <not><available file="${packages.home}/ant/.flagfile"/></not>
3155 </bool>
3156 <property name="ant.download.version" value="apache-ant-1.9.13" />
3157 <!--
3158 <get src="${gsorg.root}/gs3files/${ant.download.version}-bin.zip"
3159 dest="${packages.home}/${ant.download.version}-bin.zip"
3160 usetimestamp="true"/>
3161 -->
3162 <exec executable="${wget}" failonerror="true">
3163 <arg value="-P"/>
3164 <arg value="${packages.home}"/>
3165 <arg value="--no-check-certificate"/>
3166 <arg value="${gsorg.root}/gs3files/${ant.download.version}-bin.zip"/>
3167 </exec>
3168 <unzip src="${packages.home}/${ant.download.version}-bin.zip"
3169 dest="${packages.home}"/>
3170 <move todir="${packages.home}/ant">
3171 <fileset dir="${packages.home}/${ant.download.version}"/>
3172 </move>
3173 <echo file="${packages.home}/ant/.flagfile">
3174 the timestamp of this file is the time that ant was extracted from the zip files.
3175 it is used to figure out whether the files need to be refreshed or not in `ant prepare-ant`
3176 </echo>
3177
3178 <else>
3179 <echo>Ant has been prepared, will not prepare</echo>
3180 <echo>Delete ${packages.home}/ant/.flagfile to force refresh</echo>
3181 </else>
3182
3183 </if>
3184 </target>
3185
3186 <!-- ======================= Admin Targets ============================ -->
3187
3188 <!-- This target won't work with Eclipse because the SecureInputHandler used below conflicts with it.
3189 See http://www.dcepler.net/post.cfm/hiding-password-input-in-ant
3190 But you can do: echo mypassword | ant config-admin -->
3191 <target name="config-admin" description="Reset admin password">
3192 <input addproperty="admin.password" defaultvalue="admin" message="New admin password (3-20 characters):&gt;">
3193 <handler classname="org.apache.tools.ant.input.SecureInputHandler" /> <!-- password won't be visible on screen -->
3194 </input>
3195 <!--<echo>PWD: ${admin.password}</echo>-->
3196 <antcall target="update-userdb">
3197 <param name="user.username" value="admin"/>
3198 <param name="user.password" value="${admin.password}"/>
3199 <param name="user.groups" value=""/>
3200 <param name="user.status" value=""/>
3201 <param name="user.comment" value="Password updated."/>
3202 <param name="user.email" value=""/>
3203 </antcall>
3204 </target>
3205
3206 <target name="config-user" description="Add or modify users" depends="get-user-data,update-userdb"/>
3207<!-- this is called bu config-user to ask for the new user details at the prompt -->
3208 <target name="get-user-data" >
3209 <input addproperty="user.username" message="Username:&gt;"/>
3210 <input addproperty="user.password" defaultvalue="" message="Password (3-20 characters):&gt;">
3211 <handler classname="org.apache.tools.ant.input.SecureInputHandler" /> <!-- password won't be visible on screen -->
3212 </input>
3213 <input addproperty="user.groups" defaultvalue="" message="Groups (comma-separated list, e.g. personal-collections-editor):&gt;"/>
3214 <input addproperty="user.status" defaultvalue="true" message="Enabled (true/false):&gt;"/>
3215 <input addproperty="user.comment" defaultvalue="" message="Comment:&gt;"/>
3216 <input addproperty="user.email" defaultvalue="" message="Email:&gt;"/>
3217 </target>
3218
3219 <!-- This target won't work with Eclipse because the SecureInputHandler used below conflicts with it.
3220 See http://www.dcepler.net/post.cfm/hiding-password-input-in-ant
3221 But you can do: echo mypassword | ant config-admin -->
3222 <target name="update-userdb" depends="start-derby">
3223
3224 <!--
3225 We're now using derby networked server, so stopping and starting tomcat is not necessary.
3226 For embedded derby: stop tomcat if running, since derby db is embedded
3227 and only allows connections from one jvm instance at a time
3228 See http://db.apache.org/derby/papers/DerbyTut/embedded_intro.html
3229 The ${tomcat.isrunning} property is set by the depends-target "check-tomcat-running" -->
3230
3231 <!-- Need the derby networked server to be running in order to modify the usersDB.
3232 The start-derby task will check if derby is already running (if not, ${derby.isstarted} will
3233 be false) and will only start up networked derby if it is not already running.
3234 The ${derby.isstarted} property is set by the depends-target "start-derby", since it won't
3235 set the property if called with antcall (like launching in a subshell). Have to use 'depends'.
3236 We'll check ${derby.isstarted} at the end to stop derby again if we had to start it up now.-->
3237 <!--<antcall target="start-derby"/>-->
3238
3239 <!-- wait a max of 5 seconds for the derbyserver to have started up -->
3240 <waitfor maxwait="5" maxwaitunit="second">
3241 <socket server="${derby.server}" port="${derby.server.port}"/>
3242 </waitfor>
3243
3244 <!--<echo>${admin.password}</echo>--> <!-- for testing -->
3245 <echo>gsdl3.writablehome: ${gsdl3.writablehome}</echo> <!-- for testing -->
3246 <echo>web.home: ${web.home}</echo> <!-- for testing -->
3247 <java classname="org.greenstone.gsdl3.util.ModifyUsersDB">
3248 <classpath refid="compile.classpath"/> <!--for ${web.lib}/gsdl3.jar and supporting files-->
3249 <sysproperty key="gsdl3.writablehome" value="${gsdl3.writablehome}" /> <!-- passes -D<syspropKey=syspropVal> to java class ModifyUsersDB. Available in java code as System.getProperty("syspropKey") -->
3250 <arg file="${web.home}/etc/usersDB"/>
3251 <arg value="${user.username}"/>
3252 <arg value="password=${user.password}"/>
3253 <arg value="groups=${user.groups}"/>
3254 <arg value="status=${user.status}"/>
3255 <arg value="comment=${user.comment}"/>
3256 <arg value="email=${user.email}"/>
3257 </java>
3258
3259 <!-- Need to stop networked derby again if we ran it for this target with the depends=start-derby call.
3260 The test here is for <not>derby.isstarted</not>, as the property would be the same as before
3261 derby was started, since properties are immutable within a single ant command. -->
3262 <if>
3263 <bool>
3264 <not><istrue value="${derby.isstarted}"/></not>
3265 </bool>
3266 <antcall target="force-stop-derby"/>
3267 </if>
3268
3269 </target>
3270
3271
3272 <!-- ======================= Axis Targets ============================ -->
3273
3274 <target name="prepare-axis" depends="init">
3275 <echo>Checking for existence of: ${packages.home}/axis/.flagfile</echo>
3276 <if>
3277 <bool>
3278 <not><available file="${packages.home}/axis/.flagfile"/></not>
3279 </bool>
3280
3281 <!--
3282 <get src="${gsorg.root}/gs3files/${axis.zip.version}"
3283 dest="${packages.home}/${axis.zip.version}"
3284 usetimestamp="true"/>
3285 -->
3286 <if>
3287 <bool>
3288 <os family="mac" />
3289 </bool>
3290 <exec executable="curl" failonerror="true">
3291 <arg value="-o"/>
3292 <arg value="${packages.home}/${axis.zip.version}"/>
3293 <arg value="${gsorg.root}/gs3files/${axis.zip.version}"/>
3294 </exec>
3295 <else>
3296 <exec executable="${wget}" failonerror="true">
3297 <arg value="-P"/><!-- output dir, alt: minus-minus-directory-prefix -->
3298 <arg value="${packages.home}"/>
3299 <arg value="--no-check-certificate"/>
3300 <arg value="${gsorg.root}/gs3files/${axis.zip.version}"/>
3301 </exec>
3302 </else>
3303 </if>
3304
3305 <unzip src="${packages.home}/${axis.zip.version}"
3306 dest="${packages.home}"/>
3307 <move todir="${packages.home}/axis">
3308 <fileset dir="${packages.home}/${axis.dir.version}"/>
3309 </move>
3310 <!-- install axis into greenstone web app -->
3311 <copy todir="${web.lib}">
3312 <fileset dir="${packages.home}/axis/webapps/axis/WEB-INF/lib">
3313 <include name="*.jar"/>
3314 </fileset>
3315 </copy>
3316 <copy todir="${web.home}">
3317 <fileset dir="${packages.home}/axis/webapps/axis/">
3318 <include name="*.jsp"/>
3319 <include name="*.jws"/>
3320 </fileset>
3321 </copy>
3322 <copy tofile="${web.home}/axis.html" file="${packages.home}/axis/webapps/axis/index.html"/>
3323 <copy todir="${web.classes}">
3324 <fileset dir="${packages.home}/axis/webapps/axis/WEB-INF/classes">
3325 <include name="*.properties"/>
3326 </fileset>
3327 </copy>
3328 <echo file="${packages.home}/axis/.flagfile">
3329 the timestamp of this file is the time that axis was extracted from the zip files.
3330 it is used to figure out whether the files need to be refreshed or not in `ant prepare-axis`
3331 </echo>
3332
3333 <else>
3334 <echo>Axis has been prepared, will not prepare</echo>
3335 <echo>Delete ${packages.home}/axis/.flagfile to force refresh</echo>
3336 </else>
3337
3338 </if>
3339 </target>
3340
3341 <target name="soap-deploy-site" depends="init,get-sitename,get-siteuri,get-webservices,create-deployment-files,deploy-site"
3342 description="Deploy a SOAP web service for a local Greenstone site. Tomcat must be running for this to work."/>
3343
3344 <target name="deploy-site">
3345 <java classname="org.apache.axis.client.AdminClient">
3346 <classpath refid="compile.classpath"/>
3347 <arg value="-l"/>
3348 <arg value="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/servlet/AxisServlet"/>
3349 <arg file="${basedir}/resources/soap/deploy.wsdd"/>
3350 </java>
3351 <delete file="${basedir}/resources/soap/deploy.wsdd"/> <!--clean up, no longer used-->
3352 </target>
3353
3354 <target name="soap-undeploy-site" depends="get-undeploy-service-name"
3355 description="Undeploy a SOAP web service for a local Greenstone site. Tomcat must be running for this to work.">
3356 <filter token="servicesname" value="${axis.undeploy.servicename}"/>
3357 <copy file="${basedir}/resources/soap/undeploy-site.wsdd.template"
3358 tofile="${basedir}/resources/soap/undeploy.wsdd"
3359 filtering="true"
3360 overwrite="true"/>
3361 <java classname="org.apache.axis.client.AdminClient">
3362 <classpath refid="compile.classpath"/>
3363 <arg value="-l"/>
3364 <arg value="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/servlet/AxisServlet"/>
3365 <arg file="${basedir}/resources/soap/undeploy.wsdd"/>
3366 </java>
3367 <delete file="${basedir}/resources/soap/undeploy.wsdd"/> <!--clean up, no longer used-->
3368 </target>
3369
3370 <!-- this target used to deploy the default web service SOAPServer (base.webservice.name) on the localsite server
3371 with the default servicename of localsite-->
3372 <target name="deploy-localsite" depends="init"
3373 description="Deploy the SOAP server for localsite. Will start and stop Tomcat.">
3374 <antcall target="force-start-tomcat"/>
3375 <echo>Deploying ${base.webservice.name} web services for localsite under service name: localsite</echo>
3376 <antcall target="create-deployment-files">
3377 <param name="axis.sitename" value="localsite"/>
3378 <param name="axis.servicesname" value="${base.webservice.name}"/>
3379 <param name="axis.siteuri" value="localsite"/>
3380 </antcall>
3381 <antcall target="deploy-site">
3382 <param name="axis.sitename" value="localsite"/>
3383 <param name="axis.servicesname" value="${base.webservice.name}"/>
3384 <param name="axis.siteuri" value="localsite"/>
3385 </antcall>
3386 <echo>The Greenstone server has been started up. If you do not want it running, please type: ant stop.</echo>
3387 </target>
3388
3389 <target name="get-sitename" unless="axis.sitename">
3390 <input addproperty="axis.sitename" defaultvalue="localsite">What site do you want to deploy services for?
3391Press Enter for default:localsite</input>
3392 </target>
3393
3394 <target name="get-undeploy-service-name" unless="axis.undeploy.servicename">
3395 <input addproperty="axis.undeploy.servicename" defaultvalue="localsite">Please enter the full name of the service you wish to undeploy.
3396To find out which web services you've got deployed, point your browser to ${default.server.protocol}://${tomcat.server}:${default.tomcat.port}/greenstone3/services
3397Or press Enter for undeploying the default:localsite /&gt;</input>
3398 <echo>Name of service to undeploy: ${axis.undeploy.servicename}</echo>
3399 </target>
3400
3401 <target name="get-webservices" unless="axis.servicesname">
3402 <input addproperty="axis.servicesname" defaultvalue="${base.webservice.name}">Which set of web services do you want to deploy?
3403Choose from: ${web.services.list}
3404Or press Enter for default:${base.webservice.name} /&gt;</input>
3405 <echo>${axis.servicesname}</echo>
3406 </target>
3407
3408 <target name="get-siteuri" depends="get-sitename,get-webservices" unless="axis.siteuri">
3409 <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>
3410 <echo>Site: ${axis.sitename}, services: ${axis.servicesname}, servicesname: ${axis.siteuri}</echo>
3411 </target>
3412
3413 <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">
3414 <condition property="soap.method" value="provider='java:MSG' style='message' use='literal'">
3415 <equals arg1="${axis.servicesname}" arg2="${base.webservice.name}"/>
3416 </condition>
3417
3418 <!--everything else defaults to java:RPC at present-->
3419 <condition property="soap.method" value="provider='java:RPC'">
3420 <not>
3421 <equals arg1="${axis.servicesname}" arg2="${base.webservice.name}"/>
3422 </not>
3423 </condition>
3424 </target>
3425
3426 <target name="create-deployment-files" depends="set-soapmethod" if="axis.sitename">
3427 <filter token="sitename" value="${axis.sitename}"/>
3428 <filter token="siteuri" value="${axis.siteuri}"/>
3429 <filter token="servicesname" value="${axis.servicesname}"/>
3430 <filter token="soapmethod" value="${soap.method}"/>
3431 <copy file="${basedir}/resources/soap/site.wsdd.template"
3432 tofile="${basedir}/resources/soap/deploy.wsdd"
3433 filtering="true"
3434 overwrite="true"/>
3435 <!-- create the java files and compile them -->
3436 <copy file="${basedir}/resources/java/${axis.servicesname}.java.in"
3437 tofile="${src.gsdl3.home}/${axis.servicesname}${axis.sitename}.java"
3438 filtering="true"
3439 overwrite="true"/>
3440 <mkdir dir="${build.home}"/>
3441 <javac srcdir="${src.home}"
3442 destdir="${build.home}"
3443 includeantruntime="${compile.includeantruntime}"
3444 debug="${compile.debug}"
3445 deprecation="${compile.deprecation}"
3446 optimize="${compile.optimize}"
3447 encoding="${compile.encoding}">
3448 <compilerarg line="${compile.javac.flags}"/>
3449 <classpath refid="compile.classpath"/>
3450 <include name="org/greenstone/gsdl3/${axis.servicesname}${axis.sitename}.java" />
3451 </javac>
3452 <mkdir dir="${web.classes}/org/greenstone/gsdl3"/>
3453 <copy file="${build.home}/org/greenstone/gsdl3/${axis.servicesname}${axis.sitename}.class"
3454 tofile="${web.classes}/org/greenstone/gsdl3/${axis.servicesname}${axis.sitename}.class"
3455 overwrite="true" />
3456 </target>
3457
3458
3459 <!-- ====================== Core targets ============================== -->
3460 <!-- core targets refer to the core gsdl3 java src -->
3461
3462 <target name="prepare-core"/>
3463
3464 <target name="configure-core"/>
3465
3466 <target name="update-core" depends="init,svnupdate-core,clean-core,compile-core"
3467 description="Update only the Greenstone core" />
3468
3469 <target name="svnupdate-core" unless="nosvn.mode">
3470 <exec executable="svn">
3471 <arg value="update"/>
3472 <arg value="${basedir}"/>
3473 <arg value="-r"/><arg value="${branch.revision}"/>
3474 </exec>
3475 </target>
3476
3477 <target name="clean-core"
3478 description="Clean only the Greenstone core">
3479 <!-- should this delete the gsdl3.jar from web/WEB-INF?? -->
3480 <delete dir="${build.home}"/>
3481 </target>
3482
3483 <target name="compile-core" depends="needs-gs3-devel,init"
3484 description="Compile only the Greenstone core">
3485 <mkdir dir="${build.home}"/>
3486
3487 <if><bool><istrue value="${with.jni}"/></bool>
3488 <javac srcdir="${src.home}"
3489 destdir="${build.home}"
3490 includeantruntime="${compile.includeantruntime}"
3491 debug="${compile.debug}"
3492 deprecation="${compile.deprecation}"
3493 optimize="${compile.optimize}"
3494 encoding="${compile.encoding}">
3495 <compilerarg line="${compile.javac.flags}"/>
3496 <classpath>
3497 <path refid="compile.classpath"/>
3498 </classpath>
3499 </javac>
3500 <else>
3501 <property name="gsprefix" value=""/>
3502 <javac srcdir="${src.home}"
3503 destdir="${build.home}"
3504 includeantruntime="${compile.includeantruntime}"
3505 debug="${compile.debug}"
3506 deprecation="${compile.deprecation}"
3507 optimize="${compile.optimize}"
3508 encoding="${compile.encoding}">
3509 <compilerarg line="${compile.javac.flags}"/>
3510 <classpath>
3511 <path refid="compile.classpath"/>
3512 </classpath>
3513 <exclude name="org/greenstone/gsdl3/service/GS2MGPPRetrieve.java"/>
3514 <exclude name="org/greenstone/gsdl3/service/GS2MGPPSearch.java"/>
3515 <exclude name="org/greenstone/gsdl3/service/GS2MGSearch.java"/>
3516 <exclude name="org/greenstone/gsdl3/service/GS2MGRetrieve.java"/>
3517 <exclude name="org/greenstone/gsdl3/service/GoogleNgramMGPPSearch.java"/>
3518 <exclude name="org/greenstone/gsdl3/service/PhindPhraseBrowse.java"/>
3519 <exclude name="org/greenstone/gsdl3/util/GDBMWrapper.java"/>
3520 </javac>
3521 </else>
3522 </if>
3523 <jar destfile="${build.home}/gsdl3.jar">
3524 <fileset dir="${build.home}">
3525 <include name="org/greenstone/gsdl3/**"/>
3526 <include name="org/flax/**"/>
3527 <exclude name="**/Test.class"/>
3528 </fileset>
3529 <manifest>
3530 <attribute name="Built-By" value="${user.name}" />
3531 </manifest>
3532 </jar>
3533 <copy file="${build.home}/gsdl3.jar" todir="${web.lib}"/>
3534
3535 <antcall target="googlesignin-jar-with-dependencies" />
3536 <copy file="${build.home}/googlesignin-jdbcrealm.jar" todir="${catalina.home}/lib"/>
3537
3538 <jar destfile="${build.home}/gutil.jar">
3539 <fileset dir="${build.home}">
3540 <include name="org/greenstone/util/**"/>
3541 </fileset>
3542 <manifest>
3543 <attribute name="Built-By" value="${user.name}" />
3544 </manifest>
3545 </jar>
3546 <copy file="${build.home}/gutil.jar" todir="${web.lib}"/>
3547
3548 <!-- copy the localsite server in case we need it -->
3549 <copy file="${build.home}/org/greenstone/gsdl3/${base.webservice.name}localsite.class" tofile="${web.classes}/org/greenstone/gsdl3/${base.webservice.name}localsite.class" />
3550
3551 <!-- Greenstone Administrator Interface -->
3552 <jar destfile="${build.home}/GAI.jar">
3553 <fileset dir="${build.home}">
3554 <include name="org/greenstone/admin/**"/>
3555 </fileset>
3556 <manifest>
3557 <attribute name="Built-By" value="${user.name}" />
3558 </manifest>
3559 </jar>
3560 <copy file="${build.home}/GAI.jar" todir="${web.lib}"/>
3561 <copy file="${build.home}/GAI.jar" todir="${admin.dir}"/>
3562 <jar destfile="${build.home}/phind.jar">
3563 <fileset dir="${build.home}">
3564 <include name="org/greenstone/applet/phind/**"/>
3565 </fileset>
3566 <manifest>
3567 <attribute name="Built-By" value="${user.name}" />
3568 </manifest>
3569 </jar>
3570 <mkdir dir="${web.applet}"/>
3571 <copy file="${build.home}/phind.jar" todir="${web.applet}"/>
3572 <!-- phind also needs xercesImpl.jar and xml-apis.jar to be in web/applet -->
3573 <if>
3574 <bool><istrue value="${tomcat.islocal}"/></bool>
3575 <if><bool><available file="${catalina.home}/lib/xercesImpl.jar"/></bool><!-- moved for solr -->
3576 <copy file="${catalina.home}/lib/xercesImpl.jar" todir="${web.applet}"/>
3577 <copy file="${catalina.home}/lib/xml-apis.jar" todir="${web.applet}"/>
3578
3579 <else><!-- get from default GS3 web lib location-->
3580 <copy file="${web.lib}/xercesImpl.jar" todir="${web.applet}"/>
3581 <copy file="${web.lib}/xml-apis.jar" todir="${web.applet}"/>
3582 </else>
3583 </if>
3584 </if>
3585
3586
3587 <!-- skip anttasks for now
3588 <jar destfile="${build.home}/anttasks.jar">
3589 <fileset dir="${build.home}">
3590 <include name="org/greenstone/anttasks/**"/>
3591 </fileset>
3592 <manifest>
3593 <attribute name="Built-By" value="${user.name}" />
3594 </manifest>
3595 </jar>
3596 <copy file="${build.home}/anttasks.jar" todir="${basedir}/lib/java"/>-->
3597 <jar destfile="${build.home}/gsdl3test.jar">
3598 <fileset dir="${build.home}">
3599 <include name="org/greenstone/gsdl3/**/*Test.class"/>
3600 <include name="org/greenstone/testing/**"/>
3601 </fileset>
3602 <manifest>
3603 <attribute name="Built-By" value="${user.name}" />
3604 </manifest>
3605 </jar>
3606 <jar destfile="${build.home}/server.jar">
3607 <fileset dir="${build.home}">
3608 <include name="org/greenstone/server/**"/>
3609 <include name="org/greenstone/util/**"/>
3610 </fileset>
3611 <fileset file="${basedir}/resources/java/server.properties"/>
3612 <manifest>
3613 <attribute name="Built-By" value="${user.name}"/>
3614 </manifest>
3615 </jar>
3616 <copy file="${build.home}/server.jar" todir="${basedir}"/>
3617 </target>
3618
3619 <target name="googlesignin-checkforchanges" >
3620 <uptodate property="googlesignin-nochanges" targetfile="${build.home}/googlesignin-jdbcrealm.jar">
3621 <srcfiles dir="${build.home}" includes="org/greenstone/gsdl3/GoogleSigninJDBCRealm.class"/>
3622 </uptodate>
3623 </target>
3624
3625 <target name="googlesignin-jar-with-dependencies" depends="init,googlesignin-checkforchanges" unless="googlesignin-nochanges">
3626 <path id="googlesignin-jar-dependencies">
3627 <fileset dir="${web.lib}">
3628 <includesfile name="${jarsupport.home}/google-api-client-jars/jar-list.txt"/>
3629 </fileset>
3630 </path>
3631
3632 <unzip dest="${web.lib}/unjarred">
3633 <patternset>
3634 <exclude name="META-INF/*.SF"/>
3635 </patternset>
3636 <!-- fileset to include ... -->
3637 <path refid="googlesignin-jar-dependencies"/>
3638 </unzip>
3639
3640 <path id="googlesignin-unjarred">
3641 <fileset dir="${web.lib}/unjarred">
3642 </fileset>
3643 </path>
3644
3645 <jar destfile="${build.home}/googlesignin-jdbcrealm.jar">
3646 <fileset dir="${build.home}">
3647 <include name="org/greenstone/gsdl3/GoogleSigninJDBCRealm.class"/>
3648 </fileset>
3649 <fileset dir="${src.home}">
3650 <include name="org/greenstone/gsdl3/mbeans-descriptor.xml"/>
3651 </fileset>
3652 <path refid="googlesignin-unjarred" />
3653 <manifest>
3654 <attribute name="Built-By" value="${user.name}" />
3655 </manifest>
3656 </jar>
3657 <delete dir="${web.lib}/unjarred" quiet="true"/>
3658
3659 </target>
3660
3661 <!-- === Eclipse targets == -->
3662 <target name="setup-for-eclipse">
3663
3664 <filter token="gsdlhome" value="${gs2build.home}"/>
3665 <filter token="gsdl3srchome" value="${basedir}"/>
3666 <filter token="gsdl3home" value="${basedir}/web"/>
3667
3668 <if>
3669 <bool><not><available file="${basedir}/TransformingLibrary.launch"/></not></bool>
3670 <copy file="${basedir}/TransformingLibrary.launch.in" tofile="${basedir}/TransformingLibrary.launch" filtering="true" overwrite="true"/>
3671 </if>
3672<!--
3673 <if>
3674 <bool><not><available file="${basedir}/LibraryCommandline.launch"/></not></bool>
3675 <copy file="${basedir}/LibraryCommandline.launch.in" tofile="${basedir}/LibraryCommandline.launch" filtering="true" overwrite="true"/>
3676 </if>
3677-->
3678 </target>
3679
3680 <!-- ================== Packages targets ================================ -->
3681 <!-- these targets refer to the greenstone source packages - these need
3682 updating less often, so are in separate targets to the core -->
3683
3684 <target name="prepare-wget-for-windows">
3685 <exec executable="svn" osfamily="windows" dir="${basedir}/bin/windows">
3686 <arg value="export"/>
3687 <arg value="-r"/><arg value="${branch.revision}"/>
3688 <arg value="${svn.root}/main/${branch.path}/binaries/windows/bin/wget.exe"/>
3689 </exec>
3690 <exec executable="svn" osfamily="windows" dir="${basedir}/bin/windows">
3691 <arg value="export"/>
3692 <arg value="-r"/><arg value="${branch.revision}"/>
3693 <arg value="${svn.root}/main/${branch.path}/binaries/windows/bin/wgetrc"/>
3694 <arg value="wgetrc"/>
3695 </exec>
3696
3697 </target>
3698 <target name="prepare-packages" depends="init"/>
3699
3700 <target name="update-packages" depends="init,svnupdate-packages,configure-packages,clean-packages,compile-packages"
3701 description="Update only the source packages"/>
3702
3703 <target name="svnupdate-packages" unless="nosvn.mode">
3704 <exec executable="svn">
3705 <arg value="update"/>
3706 <arg value="${src.packages.home}"/>
3707 <arg value="-r"/><arg value="${branch.revision}"/>
3708 </exec>
3709 </target>
3710
3711 <target name="prepare-binaries" depends="prepare-bins-unix"/>
3712
3713 <target name="prepare-bins-unix" depends="init" if="current.os.isunix">
3714 <condition property="bitness.suffix" value="64" else="32">
3715 <matches string="${os.arch}" pattern="64"/>
3716 </condition>
3717 <condition property="os.folder.name" value="mac" else="linux"> <!-- checkout from dir: mac or linux -->
3718 <equals arg1="${os.bin.dir}" arg2="darwin" trim="true"/>
3719 </condition>
3720 <mkdir dir="${gs2build.home}/bin/${os.bin.dir}"/> <!-- mkdir darwin or linux -->
3721 <exec executable="svn" dir="${gs2build.home}/bin/${os.bin.dir}">
3722 <arg value="export"/>
3723 <arg value="-r"/><arg value="${branch.revision}"/>
3724 <arg value="${svn.root}/main/${branch.path}/binaries/${os.folder.name}/yaz/yaz-client-x${bitness.suffix}"/> <!-- checkout from dir: mac or linux -->
3725 <arg value="yaz-client"/>
3726 </exec>
3727 </target>
3728
3729 <target name="configure-packages" depends="init,configure-javagdbm"
3730 description="Configure only the packages."/>
3731
3732 <target name="configure-javagdbm" if="${with.jni}">
3733 <echo>
3734 Configuring JavaGDBM
3735 </echo>
3736
3737 <exec executable="${javagdbm.home}/configure" os="${os.unix}" dir="${javagdbm.home}" failonerror="true">
3738 <arg value="--prefix=${basedir}"/>
3739 <arg value="--libdir=${lib.jni}"/>
3740 <arg value="--with-gdbm=${gdbm.home}"/>
3741 <arg line="${cross.configure.args}"/>
3742 </exec>
3743 </target>
3744
3745 <target name="clean-packages" depends="init,clean-javagdbm" description="Clean only the packages"/>
3746
3747 <target name="clean-javagdbm" depends="init">
3748 <if><bool><available file="${javagdbm.home}/Makefile"/></bool>
3749 <exec executable="make" os="${os.unix}"
3750 dir="${javagdbm.home}" failonerror="true">
3751 <arg value="clean"/>
3752 </exec>
3753 </if>
3754 </target>
3755
3756 <target name="distclean-packages" depends="init,distclean-javagdbm" description="Distclean only the packages"/>
3757
3758 <target name="distclean-javagdbm" depends="init">
3759 <if><bool><available file="${javagdbm.home}/Makefile"/></bool>
3760 <exec executable="make" os="${os.unix}"
3761 dir="${javagdbm.home}" failonerror="true">
3762 <arg value="distclean"/>
3763 </exec>
3764 </if>
3765 </target>
3766
3767 <target name="compile-packages" description="Compile only the source packages">
3768 <!-- javagdbm -->
3769 <antcall target="compile-javagdbm"/>
3770 <!-- Search4j -->
3771 <antcall target="compile-search4j"/>
3772 </target>
3773
3774 <target name="compile-javagdbm" description="Compile JavaGDBM" if="${with.jni}">
3775
3776 <!-- unix: -->
3777 <echo>compile javagdbm</echo>
3778 <exec executable="make" os="${os.unix}" dir="${javagdbm.home}" failonerror="true">
3779 <arg value="JAVACOPTIONS=-encoding UTF8"/>
3780 <env key="JAVA_HOME" path="${env.JAVA_HOME}"/>
3781 </exec>
3782 <exec executable="make" os="${os.unix}" dir="${javagdbm.home}" failonerror="true">
3783 <arg value="install"/>
3784 </exec>
3785
3786 <!-- windows: Calling without the "compile" argument first will run winMake.bat with
3787 "all" which will then perform both the compile AND link targets in jni/win32.mak
3788 (thereby also generating gdbmjava.dll). Then we run the same command with
3789 the "install" argument to copy the gdbmjava.dll into the correct location. -->
3790 <echo>Windows: compile javagdbm</echo>
3791 <exec executable="${javagdbm.home}/winMake.bat" osfamily="windows" dir="${javagdbm.home}" failonerror="true">
3792 <env key="JAVA_HOME" path="${env.JAVA_HOME}"/>
3793 <env key="GSDL3SRCHOME" path="${basedir}"/>
3794 </exec>
3795 <exec executable="${javagdbm.home}/winMake.bat" osfamily="windows" dir="${javagdbm.home}" failonerror="true">
3796 <env key="GSDL3SRCHOME" path="${basedir}"/>
3797 <arg value="install"/>
3798 </exec>
3799
3800 <!-- install the jar file -->
3801 <echo>Install the javagdbm jar file ${javagdbm.home}/javagdbm.jar ${lib.jni}</echo>
3802 <copy file="${javagdbm.home}/javagdbm.jar" todir="${lib.jni}"/>
3803 </target>
3804
3805 <target name="compile-search4j">
3806
3807 <!-- windows -->
3808 <if><bool><istrue value="${current.os.iswindows}"/></bool>
3809 <exec executable="nmake" dir="${src.packages.home}/search4j" failonerror="true">
3810 <arg value="/f"/>
3811 <arg value="win32.mak"/>
3812 <arg value='BINDIR="${basedir}\bin"'/>
3813 <arg value='LIBDIR="${basedir}\lib"'/>
3814 </exec>
3815 <exec executable="nmake" dir="${src.packages.home}/search4j" failonerror="true">
3816 <arg value="/f"/>
3817 <arg value="win32.mak"/>
3818 <arg value="install"/>
3819 <arg value='BINDIR="${basedir}\bin"'/>
3820 <arg value='LIBDIR="${basedir}\lib"'/>
3821 </exec>
3822
3823 <!-- unix -->
3824 <else><if><bool><istrue value="${current.os.isunix}"/></bool>
3825 <exec executable="${src.packages.home}/search4j/configure" dir="${src.packages.home}/search4j" failonerror="true">
3826 <arg value="--bindir=${basedir}/bin"/>
3827 <arg value="--libdir=${basedir}/lib"/>
3828 <arg value="${static.arg}"/>
3829 <arg line="${cross.configure.args}"/>
3830 </exec>
3831 <exec executable="make" dir="${src.packages.home}/search4j" failonerror="true"/>
3832 <exec executable="make" dir="${src.packages.home}/search4j" failonerror="true">
3833 <arg value="install"/>
3834 </exec>
3835
3836 <!-- else warn -->
3837 <else>
3838 <fail>this target does not support the current os</fail>
3839
3840 </else></if></else></if>
3841
3842 </target>
3843
3844 <target name="install-auxiliary-jar-files" depends="init">
3845
3846 <if>
3847 <bool><available file="${mg.home}/mg.jar"/></bool>
3848 <copy file="${mg.home}/mg.jar" todir="${lib.jni}"/>
3849 </if>
3850
3851 <if>
3852 <bool><available file="${mgpp.home}/mgpp.jar"/></bool>
3853 <copy file="${mgpp.home}/mgpp.jar" todir="${lib.jni}"/>
3854 </if>
3855
3856 <copy file="${lucene.home}/LuceneWrapper4.jar" todir="${web.lib}"/>
3857 </target>
3858
3859 <target name="install-jni-files" depends="init" if="${with.jni}">
3860 <antcall target="install-jni-files-linux"/>
3861 <antcall target="install-jni-files-windows"/>
3862 <antcall target="install-jni-files-macos"/>
3863 </target>
3864
3865 <target name="install-jni-files-linux" depends="init" if="current.os.isunixnotmac">
3866
3867 <if>
3868
3869 <bool><equals arg1="${os.bin.dir}" arg2="windows"/></bool>
3870 <!-- cross compiling to windows -->
3871 <copy file="${mg.home}/jni/mgretrievejni.dll" todir="${lib.jni}"/>
3872 <copy file="${mg.home}/jni/mgsearchjni.dll" todir="${lib.jni}"/>
3873 <copy file="${mg.home}/jni/mgpassjni.dll" todir="${lib.jni}"/>
3874 <copy file="${mgpp.home}/jni/mgppretrievejni.dll" todir="${lib.jni}"/>
3875 <copy file="${mgpp.home}/jni/mgppsearchjni.dll" todir="${lib.jni}"/>
3876 <copy file="${mgpp.home}/jni/mgpppassjni.dll" todir="${lib.jni}"/>
3877
3878 <else>
3879 <!-- otherwise do the usual Unix copies -->
3880 <copy file="${mg.home}/jni/libmgretrievejni.so" todir="${lib.jni}"/>
3881 <copy file="${mg.home}/jni/libmgsearchjni.so" todir="${lib.jni}"/>
3882 <copy file="${mg.home}/jni/libmgpassjni.so" todir="${lib.jni}"/>
3883 <copy file="${mgpp.home}/jni/libmgppretrievejni.so" todir="${lib.jni}"/>
3884 <copy file="${mgpp.home}/jni/libmgppsearchjni.so" todir="${lib.jni}"/>
3885 <copy file="${mgpp.home}/jni/libmgpppassjni.so" todir="${lib.jni}"/>
3886 </else>
3887 </if>
3888
3889
3890 </target>
3891 <target name="install-jni-files-windows" depends="init" if="current.os.iswindows">
3892 <copy file="${mg.home}/jni/mgretrievejni.dll" todir="${lib.jni}"/>
3893 <copy file="${mg.home}/jni/mgsearchjni.dll" todir="${lib.jni}"/>
3894 <copy file="${mg.home}/jni/mgpassjni.dll" todir="${lib.jni}"/>
3895 <copy file="${mgpp.home}/jni/mgppretrievejni.dll" todir="${lib.jni}"/>
3896 <copy file="${mgpp.home}/jni/mgppsearchjni.dll" todir="${lib.jni}"/>
3897 <copy file="${mgpp.home}/jni/mgpppassjni.dll" todir="${lib.jni}"/>
3898 </target>
3899 <target name="install-jni-files-macos" depends="init" if="current.os.ismac">
3900 <copy file="${mg.home}/jni/libmgretrievejni.jnilib" todir="${lib.jni}"/>
3901 <copy file="${mg.home}/jni/libmgsearchjni.jnilib" todir="${lib.jni}"/>
3902 <copy file="${mg.home}/jni/libmgpassjni.jnilib" todir="${lib.jni}"/>
3903 <copy file="${mgpp.home}/jni/libmgppretrievejni.jnilib" todir="${lib.jni}"/>
3904 <copy file="${mgpp.home}/jni/libmgppsearchjni.jnilib" todir="${lib.jni}"/>
3905 <copy file="${mgpp.home}/jni/libmgpppassjni.jnilib" todir="${lib.jni}"/>
3906 </target>
3907
3908 <!-- ========common-src targets =================================-->
3909 <!-- these are used to get common-src (for indexers, gdbm, sqlite etc) when
3910 collection building is not enabled -->
3911
3912 <target name="update-common-src" depends="init" if="collection.building.disabled">
3913 </target>
3914
3915 <target name="svnupdate-common-src" depends="init" if="collection.building.disabled" unless="nosvn.mode">
3916 <exec executable="svn">
3917 <arg value="update"/>
3918 <arg value="${common.src.home}"/>
3919 <arg value="-r"/><arg value="${branch.revision}"/>
3920 </exec>
3921 </target>
3922
3923 <target name="prepare-common-src" depends="init" if="collection.building.disabled" unless="common.src.present">
3924 <antcall target="checkout-common-src"/>
3925 <antcall target="unzip-windows-packages"/>
3926 </target>
3927
3928 <target name="checkout-common-src" depends="init" if="collection.building.disabled" unless="nosvn.mode">
3929 <echo>checking out common-src</echo>
3930 <exec executable="svn">
3931 <arg value="checkout"/>
3932 <arg value="${svn.root}/main/${branch.path}/greenstone2/common-src"/>
3933 <arg value="common-src"/>
3934 <arg value="-r"/><arg value="${branch.revision}"/>
3935 </exec>
3936 </target>
3937
3938 <target name="configure-common-src" depends="envbased-gnomelib-allargs-prop,init">
3939<!--
3940 <echo>cross configure args: ${cross.configure.args}</echo>
3941-->
3942 <exec executable="${common.src.home}/configure" os="${os.unix}"
3943 dir="${common.src.home}" failonerror="true">
3944 <arg value="--prefix=${common.src.binhome}"/> <!-- what value to use?? -->
3945 <arg value="--bindir=${common.src.binhome}/bin/${os.bin.dir}"/> <!-- what value to use?? -->
3946 <arg line="${gs2.opt.args}"/>
3947 <arg line="${static.arg}"/>
3948 <arg line="${cross.configure.args}"/>
3949 <arg line="${allargs}"/>
3950 </exec>
3951 </target>
3952
3953 <target name="clean-common-src" depends="init">
3954 <!-- unix: -->
3955 <if><bool><available file="${common.src.home}/Makefile"/></bool>
3956 <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
3957 <arg value="clean"/>
3958 </exec>
3959 </if>
3960 <!-- windows: -->
3961 <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
3962 <arg value="/f"/>
3963 <arg value="win32.mak"/>
3964 <arg value="clean"/>
3965 <arg value="GSDLHOME=${common.src.binhome}"/>
3966 </exec>
3967 </target>
3968 <target name="distclean-common-src" depends="init">
3969 <!-- unix: -->
3970 <if><bool><available file="${common.src.home}/Makefile"/></bool>
3971 <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
3972 <arg value="distclean"/>
3973 </exec>
3974 </if>
3975 <!-- windows: distclean = clean + remove configure products (remove makefiles). But on Windows there is no removing makefiles, so we just call clean -->
3976 <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
3977 <arg value="/f"/>
3978 <arg value="win32.mak"/>
3979 <arg value="clean"/>
3980 <arg value="GSDLHOME=${common.src.binhome}"/>
3981 </exec>
3982 </target>
3983 <target name="compile-common-src" depends="needs-gs3-devel,envbased-devel-props,init">
3984 <!-- unix: -->
3985 <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
3986 <arg value="${gs2.compile.target}"/>
3987 <arg value="JAVA_HOME=${env.JAVA_HOME}"/>
3988 </exec>
3989 <!-- windows: -->
3990 <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
3991 <arg value="/f"/>
3992 <arg value="win32.mak"/>
3993 <arg value="VISUAL_STUDIO_MAJORVERSION=${visualstudio.majorversion}"/>
3994 <arg value="JAVA_HOME=${env.JAVA_HOME}"/>
3995
3996 <arg value="GSDLHOME=${common.src.binhome}"/>
3997 <arg value="ENABLE_JNI=${gs2.windows.enablejni}"/>
3998 <arg value="ENABLE_MG=${gs2.windows.enablemg}"/>
3999 <arg value="ENABLE_MGPP=${gs2.windows.enablemgpp}"/>
4000 <arg value="USE_GDBM=${gs2.windows.usegdbm}"/>
4001 <arg value="USE_SQLITE=${gs2.windows.usesqlite}"/>
4002 </exec>
4003 </target>
4004
4005 <!-- ======= collection-building targets ===========================-->
4006
4007 <target name="update-collection-building" if="collection.building.enabled"
4008 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"
4009 description="Update (SVN update, configure, compile etc) only the collection building components"/>
4010
4011 <target name="svnupdate-collection-building" if="collection.building.enabled" depends="init,svnupdate-gs2build,svnupdate-gli" unless="nosvn.mode"
4012 description="SVN update the collection building components">
4013 </target>
4014
4015 <target name="prepare-collection-building" depends="init,prepare-gs2build,prepare-gli" if="collection.building.enabled">
4016 </target>
4017
4018 <target name="configure-collection-building" depends="init,configure-build-src" if="collection.building.enabled"
4019 description="Configure the collection building components">
4020 </target>
4021
4022 <target name="clean-collection-building" depends="init,clean-gli,clean-build-src"
4023 description="Clean only the collection building components"
4024 if="collection.building.enabled"/>
4025
4026 <target name="distclean-collection-building" depends="init,clean-build-src,distclean-build-src"
4027 description="Distclean only the collection building components"
4028 if="collection.building.enabled"/>
4029
4030 <target name="compile-collection-building" depends="needs-gs3-devel,envbased-devel-props,init,compile-build-src,compile-gli" if="collection.building.enabled"
4031 description="Compile only the collection building components">
4032 <!-- make install for common-src -->
4033 <!-- unix: -->
4034 <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
4035 <arg value="${gs2.install.target}"/>
4036 </exec>
4037
4038 <!-- windows: -->
4039 <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
4040 <arg value="/f"/>
4041 <arg value="win32.mak"/>
4042 <arg value="install"/>
4043 <arg value="VISUAL_STUDIO_MAJORVERSION=${visualstudio.majorversion}"/>
4044 <arg value="GSDLHOME=${gs2build.home}"/>
4045 <arg value="ENABLE_JNI=${gs2.windows.enablejni}"/>
4046 <arg value="ENABLE_MG=${gs2.windows.enablemg}"/>
4047 <arg value="ENABLE_MGPP=${gs2.windows.enablemgpp}"/>
4048 <arg value="USE_GDBM=${gs2.windows.usegdbm}"/>
4049 <arg value="USE_SQLITE=${gs2.windows.usesqlite}"/>
4050 <!--
4051 <arg value="ENABLE_JNI=${gs2.windows.enablejni}"/>
4052 <arg value="USE_SQLITE=0"/>--> <!-- why is this not on by default? -->
4053 </exec>
4054
4055 <!-- install gs2build indexers for windows -->
4056 <if>
4057 <bool><istrue value="${current.os.iswindows}"/></bool>
4058 <copy todir="${gs2build.home}/bin/windows">
4059 <fileset dir="${gs2build.home}/common-src/indexers/bin">
4060 <include name="*.*"/>
4061 </fileset>
4062 </copy>
4063 </if>
4064
4065 <!-- LuceneWrapper jar file not installed by default -->
4066 <mkdir dir="${gs2build.home}/bin/java"/>
4067 <copy file="${lucene.home}/LuceneWrapper4.jar" todir="${gs2build.home}/bin/java"/>
4068
4069 </target>
4070
4071 <!-- ============== gli targets ================================= -->
4072
4073 <target name="svnupdate-gli" if="collection.building.enabled" depends="init" unless="nosvn.mode">
4074
4075 <exec executable="svn">
4076 <arg value="update"/>
4077 <arg value="${gli.home}"/>
4078 <arg value="-r"/><arg value="${branch.revision}"/>
4079 </exec>
4080
4081 </target>
4082
4083 <target name="prepare-gli" depends="init" if="collection.building.enabled" unless="gli.present">
4084 <!-- checkout -->
4085 <if><bool><and><not><istrue value="${nosvn.mode}"/></not><isset property="with.gli.and.gems"/></and></bool>
4086
4087 <exec executable="svn">
4088 <arg value="checkout"/>
4089 <arg value="${svn.root}/main/${branch.path}/gli"/>
4090 <arg value="-r"/><arg value="${branch.revision}"/>
4091 </exec>
4092
4093 </if>
4094 </target>
4095
4096 <target name="clean-gli" depends="init" if="collection.building.enabled">
4097 <!-- gli -->
4098 <property name="gli.home" value="${basedir}/gli"/>
4099 <!-- linux -->
4100 <exec executable="clean.sh" os="${os.unix}" dir="${gli.home}"
4101 resolveExecutable="true" failonerror="true"/>
4102 <!-- windows -->
4103 <exec executable="clean.bat" osfamily="windows" dir="${gli.home}"
4104 resolveExecutable="true" failonerror="true"/>
4105 </target>
4106
4107 <target name="compile-gli" depends="needs-gs3-devel,init" if="collection.building.enabled">
4108 <if><bool><isset property="with.gli.and.gems"/></bool>
4109 <!-- gli -->
4110 <property name="gli.home" value="${basedir}/gli"/>
4111
4112 <!-- linux -->
4113 <exec executable="makegli.sh" os="${os.unix}" dir="${gli.home}" resolveExecutable="true" failonerror="true"/>
4114 <!--remote gli-->
4115 <exec executable="makejar.sh" os="${os.unix}" dir="${gli.home}"
4116 resolveExecutable="true" failonerror="true"/>
4117 <!-- windows -->
4118 <exec executable="makegli.bat" osfamily="windows" dir="${gli.home}" resolveExecutable="true" failonerror="true"/>
4119 <!--remote gli-->
4120 <exec executable="makejar.bat" osfamily="windows" dir="${gli.home}"
4121 resolveExecutable="true" failonerror="true"/>
4122 <copy file="${gli.home}/GLIServer.jar" todir="${gs2build.home}/bin/java" />
4123 </if>
4124 </target>
4125
4126 <target name="gli" description="Run the Greenstone Librarian Interface" depends="init" if="collection.building.enabled">
4127 <exec executable="${basedir}/gli/gli.sh" os="${os.linux},${os.solaris}" dir="${basedir}/gli" spawn="true">
4128 <env key="gsdl3path" path="${basedir}"/>
4129 <env key="gsdlpath" path="${gs2build.home}"/>
4130 </exec>
4131 <exec executable="${basedir}/gli/gli.sh" os="${os.mac}" dir="${basedir}/gli" spawn="true">
4132 <env key="gsdl3path" path="${basedir}"/>
4133 <env key="gsdlpath" path="${gs2build.home}"/>
4134 <env key="DYLD_LIBRARY_PATH" path="${env.DYLD_LIBRARY_PATH}:${gdbm.home}/lib"/>
4135 </exec>
4136 <exec executable="${basedir}/gli/gli.bat" osfamily="windows" dir="${basedir}/gli" spawn="true">
4137 <env key="GSDL3PATH" path="${basedir}"/>
4138 <env key="GSDLPATH" path="${gs2build.home}"/>
4139 </exec>
4140 <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.
4141 </echo>
4142 </target>
4143
4144 <!-- ================ gs2build targets =========================== -->
4145
4146 <target name="svnupdate-gs2build" if="collection.building.enabled" depends="init" unless="nosvn.mode">
4147 <echo>svn updating gs2build</echo>
4148 <exec executable="svn">
4149 <arg value="update"/>
4150 <arg value="${gs2build.home}"/>
4151 <arg value="-r"/><arg value="${branch.revision}"/>
4152 </exec>
4153 </target>
4154
4155 <target name="prepare-gs2build" depends="init" if="collection.building.enabled" unless="gs2build.present">
4156 <antcall target="checkout-gs2build"/>
4157 <antcall target="prepare-pdfbox"/>
4158 <antcall target="prepare-imagemagick"/> <!-- has to be done before calling prepare-gnome-lib -->
4159 <antcall target="prepare-gnome-lib"/>
4160 <antcall target="unzip-windows-packages"/>
4161 <antcall target="checkout-winbin"/>
4162 <antcall target="get-windows-binaries"/>
4163 <antcall target="delete-winbin"/>
4164 </target>
4165
4166 <target name="checkout-gs2build" depends="init" if="collection.building.enabled" unless="nosvn.mode">
4167 <echo>checking out gs2build</echo>
4168 <exec executable="svn">
4169 <arg value="checkout"/>
4170 <arg value="${svn.root}/main/${branch.path}/gs2build"/>
4171 <arg value="-r"/><arg value="${branch.revision}"/>
4172 </exec>
4173 </target>
4174
4175 <!-- Gets the PDFBox extension into gs2build/ext if checkout.pdfbox.ext is set to true in build.properties
4176 (which it is by default) -->
4177 <target name="prepare-pdfbox" depends="init" if="collection.building.enabled">
4178 <if>
4179 <bool>
4180 <istrue value="${checkout.pdfbox.ext}"/>
4181 </bool>
4182
4183 <property name="pdfbox.ext.dir" value="${gs2build.home}/ext/pdf-box"/>
4184 <condition property="pdfbox.ext.present">
4185 <available file="${pdfbox.ext.dir}" type="dir" />
4186 </condition>
4187
4188 <!-- 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-->
4189 <if>
4190 <bool>
4191 <not><istrue value="${pdfbox.ext.present}"/></not>
4192 </bool>
4193
4194 <if>
4195 <bool>
4196 <not><istrue value="${gs2build.home}/ext/pdf-box-java.tar.gz"/></not>
4197 </bool>
4198
4199 <echo>Checking out the PDFBox extension into the GSDLHOME extension area</echo>
4200 <exec executable="svn">
4201 <arg value="export"/>
4202 <arg value="${svn.root}/gs2-extensions/pdf-box/trunk/pdf-box-java.tar.gz"/>
4203 <arg value="${gs2build.home}/ext/pdf-box-java.tar.gz"/>
4204 </exec>
4205 </if>
4206
4207 <echo>Extacting the PDFBox extension into the GSDLHOME extension area</echo>
4208 <untar compression="gzip"
4209 src="${gs2build.home}/ext/pdf-box-java.tar.gz"
4210 dest="${gs2build.home}/ext"/>
4211
4212 <delete file="${gs2build.home}/ext/pdf-box-java.tar.gz"/>
4213
4214 <else>
4215 <echo>The PDFBox extension already exists at ${pdfbox.ext.dir}</echo>
4216 </else>
4217 </if>
4218
4219 <else>
4220 <echo>**** Not preparing the PDFBox extension:</echo>
4221 <echo>The property checkout.pdfbox.ext in build.properties was not set or was set to false</echo>
4222 </else>
4223 </if>
4224 </target>
4225
4226 <target name="prepare-imagemagick" depends="init" if="collection.building.enabled">
4227 <if>
4228 <bool>
4229 <istrue value="${checkout.imagemagick.ext}"/>
4230 </bool>
4231
4232 <antcall target="checkout-imagemagick"/>
4233 <!--Compilation of imagemagick now happens during ant install, still before configuring the src code, as before -->
4234
4235 <else>
4236 <echo>**** Not preparing imagemagick:</echo>
4237 <echo>property checkout.imagemagick.ext in build.properties was not set or was set to false</echo>
4238 </else>
4239 </if>
4240 </target>
4241
4242 <target name="checkout-imagemagick" depends="init" if="collection.building.enabled" unless="nosvn.mode">
4243
4244 <property name="imagemagick.src.dir" value="${gs2build.home}/ext/imagemagick"/>
4245 <condition property="imagemagick.src.present">
4246 <available file="${imagemagick.src.dir}" type="dir" />
4247 </condition>
4248
4249 <if>
4250 <bool>
4251 <not><istrue value="${imagemagick.src.present}"/></not>
4252 </bool>
4253
4254 <echo>checking out imagemagick source into the extension area</echo>
4255
4256 <exec executable="svn">
4257 <arg value="checkout"/>
4258 <arg value="${svn.root}/gs2-extensions/imagemagick/trunk/src"/>
4259 <arg value="${imagemagick.src.dir}"/>
4260 </exec>
4261
4262 <else>
4263 <echo>imagemagick source code already exists at ${imagemagick.src.dir}</echo>
4264 </else>
4265 </if>
4266 </target>
4267
4268 <!-- 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. -->
4269 <target name="compile-imagemagick" if="${checkout.imagemagick.ext}">
4270
4271 <property name="imagemagick.src.dir" value="${gs2build.home}/ext/imagemagick"/>
4272 <property name="imagemagick.compiled.dir" value="${gs2build.home}/ext/imagemagick/${os.bin.dir}"/>
4273
4274 <condition property="imagemagick.src.present.firstcheck">
4275 <available file="${imagemagick.src.dir}" type="dir" />
4276 </condition>
4277 <condition property="imagemagick.compiled.present">
4278 <available file="${imagemagick.compiled.dir}" type="dir"/>
4279 </condition>
4280 <!--<condition property="imagemagick.bin.present">
4281 <available file="${basedir}/wherever/the/imgmagick/binary/is/to/be/found" type="dir" />
4282 </condition>-->
4283
4284 <!-- imagemagick will only be checked out if the user set the checkout.imagemagick.ext in build.properties -->
4285 <if>
4286 <bool>
4287 <isfalse value="${imagemagick.src.present.firstcheck}"/>
4288 </bool>
4289 <antcall target="checkout-imagemagick"/>
4290 </if>
4291
4292 <!-- keep track of whether the imagemagick src is now indeed present. Need to know this for a subsequent test -->
4293 <condition property="imagemagick.src.present">
4294 <available file="${imagemagick.src.dir}" type="dir" />
4295 </condition>
4296
4297 <if>
4298 <bool>
4299 <and>
4300 <istrue value="${imagemagick.src.present}"/> <!-- imagemagick src code is present -->
4301 <isfalse value="${imagemagick.compiled.present}"/> <!-- imagemagick src not compiled yet, so no imagemagick/os subfolder yet -->
4302 </and>
4303 </bool>
4304 <!-- then compile it. Only necessary for mac/linux, since windows has a stable working binary of imagemagick -->
4305 <exec executable="/bin/bash" dir="${imagemagick.src.dir}" failonerror="true">
4306 <arg value="CASCADE-MAKE.sh"/>
4307 </exec>
4308 </if>
4309 </target>
4310
4311
4312 <!-- If not on windows, then compile up gnome-lib src folder if:
4313 checkout.gnomelib.ext is turned on,
4314 and if not using the binary version (gnome-lib-minimal),
4315 and if the gnome-lib src folder is not already compiled up. -->
4316 <target name="compile-gnome-lib" if="${checkout.gnomelib.ext}" unless="current.os.iswindows">
4317
4318 <!-- http://stackoverflow.com/questions/3290307/sourcing-a-shell-profile-in-an-ant-build-file
4319 TODO: CASCADE-MAKE already sources devel.bash, but we still want to source it more globally,
4320 so that the rest of the GS3 compilation process also has access to those env variables -->
4321
4322 <property name="gnome.lib.src.dir" value="${basedir}/gs2build/ext/gnome-lib"/>
4323 <property name="gnome.lib.compiled.dir" value="${basedir}/gs2build/ext/gnome-lib/${os.bin.dir}"/>
4324
4325 <condition property="gnome.src.lib.present.firstcheck" value="true" else="false">
4326 <available file="${gnome.lib.src.dir}" type="dir" />
4327 </condition>
4328 <condition property="gnome.compiled.lib.present" value="true" else="false">
4329 <available file="${gnome.lib.compiled.dir}" type="dir"/>
4330 </condition>
4331 <condition property="gnome.lib.min.present" value="true" else="false">
4332 <available file="${basedir}/gs2build/ext/gnome-lib-minimal" type="dir" />
4333 </condition>
4334
4335 <!-- Make sure to checkout gnome-lib if it was not checked out at this stage
4336 since we're instructed to do so in th pre-condition to this target -->
4337 <if>
4338 <bool>
4339 <and>
4340 <isfalse value="${gnome.lib.min.present}"/>
4341 <isfalse value="${gnome.src.lib.present.firstcheck}"/>
4342 </and>
4343 </bool>
4344 <antcall target="checkout-gnome-lib"/>
4345 </if>
4346
4347 <!-- Keep track of whether we have the gnome-lib src folder now. Need to know this for a subsequent test -->
4348 <condition property="gnome.src.lib.present" value="true" else="false">
4349 <available file="${gnome.lib.src.dir}" type="dir" />
4350 </condition>
4351
4352 <!--<echo>MIN: ${gnome.lib.min.present}
4353 SRC LIB: ${gnome.src.lib.present}
4354 COMPILED: ${gnome.compiled.lib.present}</echo>-->
4355
4356 <if>
4357 <bool>
4358 <and>
4359 <isfalse value="${gnome.lib.min.present}"/> <!-- no gnome-lib-minimal binary present -->
4360 <istrue value="${gnome.src.lib.present}"/> <!-- gnome-lib folder for compilation is present-->
4361 <isfalse value="${gnome.compiled.lib.present}"/> <!-- gnome-lib not yet compiled, so no gnome-lib/os subfolder yet -->
4362 </and>
4363 </bool>
4364
4365 <!-- then compile it. Only necessary for mac/linux, since windows doesn't need gnome lib -->
4366 <exec executable="/bin/bash" dir="${gnome.lib.src.dir}" failonerror="true">
4367 <arg value="CASCADE-MAKE.sh"/>
4368 </exec>
4369 </if>
4370 </target>
4371
4372
4373 <target name="prepare-gnome-lib" depends="init" if="collection.building.enabled" unless="gnome-lib.present">
4374 <if>
4375 <bool><istrue value="${checkout.gnomelib.ext}"/></bool>
4376 <if>
4377 <bool><istrue value="${current.os.iswindows}"/></bool>
4378
4379 <echo>Skipping prepare-gnome-lib, because compilation is on Windows which checks out binaries that do not rely on gnomelib</echo>
4380 <else>
4381 <!-- current.os.isunix -->
4382
4383 <antcall target="checkout-gnome-lib"/>
4384 <!--Compilation of gnome-lib happens during ant install, just before configuring (common-src and) build-src-->
4385
4386 </else>
4387 </if>
4388 <else>
4389 <if><bool><istrue value="${current.os.isunix}"/></bool>
4390 <!-- current.os.isunix and checkout.gnomelib.ext not turned on -->
4391 <echo>**** Not preparing gnome-lib:</echo>
4392 <echo>property checkout.gnomelib.ext in build.properties was not set or was set to false.</echo>
4393 </if>
4394 </else>
4395 </if>
4396 </target>
4397
4398
4399 <target name="checkout-gnome-lib" depends="init" if="collection.building.enabled" unless="nosvn.mode">
4400
4401 <property name="gnomelib.src.dir" value="${basedir}/gs2build/ext/gnome-lib"/>
4402 <condition property="gnome.src.present">
4403 <available file="${gnomelib.src.dir}" type="dir" />
4404 </condition>
4405
4406 <if>
4407 <bool>
4408 <not><istrue value="${gnome.src.present}"/></not>
4409 </bool>
4410
4411 <echo>checking out gnome-lib extension</echo>
4412 <exec executable="svn">
4413 <arg value="checkout"/>
4414 <arg value="${svn.root}/gs2-extensions/gnome-lib/trunk/src"/>
4415 <arg value="${gs2build.home}/ext/gnome-lib"/>
4416 </exec>
4417
4418 <else>
4419 <echo>gnomelib source code already exists at ${gnomelib.src.dir}</echo>
4420 </else>
4421 </if>
4422
4423 </target>
4424
4425 <target name="checkout-winbin" depends="init" if="current.os.iswindows"
4426 unless="nosvn.mode">
4427
4428 <exec executable="svn">
4429 <arg value="checkout"/>
4430 <arg value="${svn.root}/main/${branch.path}/binaries/windows"/>
4431 <arg value="-r"/><arg value="${branch.revision}"/>
4432 <arg value="winbin"/>
4433 </exec>
4434
4435 </target>
4436
4437 <target name="update-winbin" depends="init" if="current.os.iswindows" unless="nosvn.mode">
4438 <exec executable="svn">
4439 <arg value="update"/>
4440 <arg value="winbin"/>
4441 <arg value="-r"/><arg value="${branch.revision}"/>
4442 </exec>
4443
4444 </target>
4445
4446 <target name="get-windows-binaries" depends="init" if="collection.building.enabled.windows">
4447 <move todir="${gs2build.home}/bin/windows" failonerror="false">
4448 <fileset dir="${basedir}/winbin/bin"/>
4449 </move>
4450 </target>
4451
4452 <target name="delete-winbin" depends="init" if="collection.building.enabled.windows">
4453 <delete dir="${basedir}/winbin"/>
4454 </target>
4455
4456 <target name="unzip-windows-packages" depends="envbased-devel-props,init" if="current.os.iswindows">
4457 <unzip src="${common.src.home}/packages/windows/crypt/crypt.zip"
4458 dest="${common.src.home}/packages/windows/crypt"/>
4459 <untar compression="gzip"
4460 src="${common.src.home}/packages/sqlite/${sqlite.targz.version}"
4461 dest="${common.src.home}/packages/sqlite"/>
4462 <untar compression="gzip"
4463 src="${common.src.home}/packages/expat/${expat.targz.version}"
4464 dest="${common.src.home}/packages/expat"/>
4465 <untar compression="gzip"
4466 src="${common.src.home}/packages/jdbm/${jdbm.targz.version}"
4467 dest="${common.src.home}/packages/jdbm"/>
4468 <if>
4469 <bool>
4470 <islessthan arg1="${visualstudio.majorversion}" arg2="14"/>
4471 </bool>
4472 <echo>Unzipping Pre-VS14.0 compatible version of iconv</echo>
4473 <unzip src="${common.src.home}/indexers/packages/windows/iconv/iconv-PRE-VS14.zip"
4474 dest="${common.src.home}/indexers/packages/windows/iconv"/>
4475 <else>
4476 <echo>Unzipping VS14.0-Plus compatible version of iconv</echo>
4477 <unzip src="${common.src.home}/indexers/packages/windows/iconv/iconv-VS14-PLUS.zip"
4478 dest="${common.src.home}/indexers/packages/windows/iconv"/>
4479 </else>
4480 </if>
4481
4482 </target>
4483
4484 <target name="gs2build-edit-setup-bat" if="collection.building.enabled.windows">
4485 <!-- we want a windows path in the setup.bat file -->
4486 <pathconvert targetos="windows" property="gs2build.home.windows">
4487 <path path="${gs2build.home}"/>
4488 </pathconvert>
4489 <move file="${gs2build.home}/setup.bat" tofile="${gs2build.home}/setup-tmp.bat">
4490 <filterset>
4491 <filter token="gsdlhome" value="${gs2build.home.windows}"/>
4492 </filterset>
4493 </move>
4494 <move file="${gs2build.home}/setup-tmp.bat" tofile="${gs2build.home}/setup.bat" />
4495 </target>
4496
4497
4498 <target name="clean-build-src" depends="init" if="collection.building.enabled">
4499 <!-- unix: -->
4500 <if><bool><available file="${build.src.home}/Makefile"/></bool>
4501 <exec executable="make" os="${os.unix}" dir="${build.src.home}" failonerror="true">
4502 <arg value="clean"/>
4503 </exec>
4504 </if>
4505 <!-- windows: -->
4506 <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
4507 <arg value="/f"/>
4508 <arg value="win32.mak"/>
4509 <arg value="clean"/>
4510 <arg value="GSDLHOME=${gs2build.home}"/>
4511 </exec>
4512 </target>
4513
4514
4515 <target name="distclean-build-src" depends="init,clean-build-src" if="collection.building.enabled">
4516 <!-- unix: -->
4517 <if><bool><available file="${build.src.home}/Makefile"/></bool>
4518 <exec executable="make" os="${os.unix}" dir="${build.src.home}" failonerror="true">
4519 <arg value="distclean"/>
4520 </exec>
4521 </if>
4522 <!-- windows: distclean = clean + remove configure products (remove makefiles). But on Windows there is no removing makefiles, so we just call clean -->
4523 <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
4524 <arg value="/f"/>
4525 <arg value="win32.mak"/>
4526 <arg value="clean"/>
4527 <arg value="GSDLHOME=${gs2build.home}"/>
4528 </exec>
4529 </target>
4530
4531 <target name="configure-build-src" depends="envbased-gnomelib-allargs-prop,init" if="collection.building.enabled"
4532 description="Configure the build-src component">
4533 <exec executable="${build.src.home}/configure" os="${os.unix}"
4534 dir="${build.src.home}" failonerror="true">
4535 <arg value="--prefix=${gs2build.home}"/>
4536 <arg line="${gs2.opt.args} ${static.arg} ${cross.configure.args} ${allargs}"/>
4537 </exec>
4538 </target>
4539
4540 <!-- common-src is done separately and needs to be compiled first -->
4541 <target name="compile-build-src" depends="needs-gs3-devel,init" if="collection.building.enabled">
4542
4543 <exec executable="make" dir="${build.src.home}" os="${os.unix}" failonerror="true">
4544 <!-- <arg line="${ldlpath.arg}"/> -->
4545 <env key="LD_LIBRARY_PATH" value="${env.LD_LIBRARY_PATH}"/> <!--changed to specifying through 'env' rather than arg with ldlpath.arg -->
4546 </exec>
4547
4548 <exec executable="make" dir="${build.src.home}" os="${os.unix}" failonerror="true">
4549 <env key="GSDLOS" value="${os.bin.dir}"/>
4550 <arg value="install"/>
4551 </exec>
4552
4553 <!-- run the setup script -->
4554 <!-- <exec executable="${compile.windows.c++.setup}" osfamily="windows" failonerror="true"/>-->
4555 <!--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-->
4556 <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
4557 <arg value="/f"/>
4558 <arg value="win32.mak"/>
4559 <arg value="GSDLHOME=${gs2build.home}"/>
4560 </exec>
4561 <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
4562 <arg value="/f"/>
4563 <arg value="win32.mak"/>
4564 <arg value="install"/>
4565 <arg value="GSDLHOME=${gs2build.home}"/>
4566 </exec>
4567 </target>
4568
4569
4570 <!-- ======================== TESTING Targets ========================= -->
4571
4572 <target name="test" description="Run the (incomplete) JUnit test suite "
4573 depends="init">
4574 <mkdir dir="${basedir}/test"/>
4575 <junit printsummary="withOutAndErr"
4576 errorproperty="test.failed"
4577 failureproperty="test.failed"
4578 fork="${junit.fork}">
4579 <formatter type="plain"/>
4580 <classpath>
4581 <pathelement location="${build.home}/gsdl3test.jar"/>
4582 <path refid="compile.classpath"/>
4583 </classpath>
4584 <test name="${testcase}" if="testcase"/>
4585 <batchtest todir="${basedir}/test" unless="testcase">
4586 <fileset dir="${build.home}" includes="**/*Test.class" />
4587 </batchtest>
4588 </junit>
4589 <echo>
4590 *********************************************
4591 Test output can be found in directory 'test'
4592 *********************************************
4593 </echo>
4594 </target>
4595
4596 <!-- ======================== FLAX Targets ========================= -->
4597 <target name="prepare-flax" description="check out flax source code from another repository" if="install.flax">
4598 <echo>checking out flax ...</echo>
4599 <mkdir dir="${basedir}/src/java/org/flax"/>
4600 <mkdir dir="${basedir}/src/java/org/greenstone/gsdl3/flax"/>
4601 <mkdir dir="${basedir}/src/java/org/greenstone/gsdl3/action/flax"/>
4602 <mkdir dir="${web.home}/WEB-INF/classes/flax"/>
4603 <mkdir dir="${web.home}/interfaces/flax"/>
4604 <mkdir dir="${web.home}/sites/flax"/>
4605 <mkdir dir="${basedir}/flax-resources"/>
4606 <mkdir dir="${basedir}/flax-lib"/>
4607 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/src/java/org/flax"/>
4608 <arg value="src/java/org/flax"/></exec>
4609 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/src/java/org/greenstone/gsdl3/flax"/>
4610 <arg value="src/java/org/greenstone/gsdl3/flax"/></exec>
4611 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/src/java/org/greenstone/gsdl3/action/flax"/>
4612 <arg value="src/java/org/greenstone/gsdl3/action/flax"/></exec>
4613 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/web/WEB-INF/classes/flax"/>
4614 <arg value="${web.home}/WEB-INF/classes/flax"/></exec>
4615 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/web/interfaces/flax"/>
4616 <arg value="${web.home}/interfaces/flax"/></exec>
4617 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/web/sites/flax"/>
4618 <arg value="${web.home}/sites/flax"/></exec>
4619 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/flax-resources"/>
4620 <arg value="flax-resources"/></exec>
4621 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/lib"/>
4622 <arg value="flax-lib"/></exec>
4623 <antcall target="flax-copy-del-files" />
4624 </target>
4625
4626 <target name="flax-copy-del-files" description="copy some flax files into the appropriate greenstone3 directories and delete some unwanted greenstone stuff">
4627 <copy file="${web.home}/WEB-INF/classes/flax/flax.xml" todir="${web.home}/WEB-INF" overwrite="true" />
4628 <copy todir="${web.home}/WEB-INF/classes" overwrite="true" >
4629 <fileset dir="${web.home}/WEB-INF/classes/flax">
4630 <include name="interface_flax*.properties"/>
4631 </fileset>
4632 </copy>
4633 <copy todir="${web.home}/WEB-INF/lib">
4634 <fileset dir="${basedir}/flax-lib">
4635 <include name="*.jar"/>
4636 </fileset>
4637 </copy>
4638 <!--<delete dir="${web.home}/sites/gateway"/>
4639 <delete dir="${web.home}/sites/localsite"/>-->
4640 </target>
4641
4642 <target name="update-flax" description="update flax from repository">
4643 <echo>updating flax ...</echo>
4644 <exec executable="svn"><arg value="update"/>
4645 <arg value="src/java/org/flax"/></exec>
4646 <exec executable="svn"><arg value="update"/>
4647 <arg value="src/java/org/greenstone/gsdl3/action/flax"/></exec>
4648 <exec executable="svn"><arg value="update"/>
4649 <arg value="src/java/org/greenstone/gsdl3/flax"/></exec>
4650 <exec executable="svn"><arg value="update"/>
4651 <arg value="${web.home}/WEB-INF/classes/flax"/></exec>
4652 <exec executable="svn"><arg value="update"/>
4653 <arg value="${web.home}/interfaces/flax"/></exec>
4654 <exec executable="svn"><arg value="update"/>
4655 <arg value="${web.home}/web/sites/flax"/></exec>
4656 <exec executable="svn"><arg value="update"/>
4657 <arg value="flax-resources"/></exec>
4658 <exec executable="svn"><arg value="update"/>
4659 <arg value="flax-lib"/></exec>
4660 <antcall target="compile-core" />
4661 </target>
4662
4663 <!-- ========================End of FLAX Targets ========================= -->
4664
4665 <target name="compile-javadocs">
4666 <javadoc packagenames="org.greenstone.*"
4667 sourcepath="src/java"
4668 defaultexcludes="yes"
4669 destdir="docs/javadoc"
4670 author="true"
4671 version="true"
4672 use="true"
4673 windowtitle="Greenstone3 API">
4674 <doctitle><![CDATA[<h1>Greenstone3 API</h1>]]></doctitle>
4675 </javadoc>
4676 </target>
4677
4678<!-- ========== Some distribution targets ======================== -->
4679 <target name="remove-source">
4680 <if><bool><isset property="with.gli.and.gems"/></bool>
4681 <delete includeEmptyDirs="true">
4682 <fileset dir="." defaultexcludes="false">
4683 <patternset refid="greenstone3.source.component"/>
4684 </fileset>
4685 </delete>
4686
4687 <else>
4688 <delete includeEmptyDirs="true">
4689 <fileset dir="." defaultexcludes="false">
4690 <patternset refid="greenstone3.source.no.gli.component"/>
4691 </fileset>
4692 </delete>
4693 </else>
4694 </if>
4695 </target>
4696
4697 <target name="dist-tidy"
4698 description="'tidies-up' a greenstone3 installation for distribution."
4699 unless="${properties.keep.src}">
4700
4701 <!-- delete unneeded things -->
4702 <delete dir="${packages.home}/axis"/>
4703 <delete><fileset dir="${packages.home}" includes="*.zip"/></delete>
4704 <delete file="README-SVN.txt"/>
4705 <delete file="build.properties.svn"/>
4706
4707 <!-- delete source files -->
4708 <antcall target="remove-source"/>
4709
4710 <!-- create empty directories -->
4711 <mkdir dir="${web.writablehome}/applet"/>
4712 <mkdir dir="${web.writablehome}/logs"/>
4713 <mkdir dir="${web.writablehome}/logs/tmp"/>
4714
4715 <!-- Lines with ***** are commented out because these files are useful if we want hybrid installations -->
4716
4717 <!-- os specific tidy-ups -->
4718 <!-- linux, mac -->
4719 <if><bool><istrue value="${current.os.isunix}"/></bool>
4720 <!--*****<delete><fileset dir="." includes="*.bat"/></delete>-->
4721 <if><bool><isset property="with.gli.and.gems"/></bool>
4722 <!--*****<delete><fileset dir="gli" includes="*.bat"/></delete>-->
4723 </if>
4724 <!--*****<delete><fileset dir="gs2build" includes="*.bat"/></delete>-->
4725 <!--*****<delete><fileset dir="bin/script" includes="*.bat"/></delete>-->
4726 <delete file="${basedir}/gs2build/win32cfg.h"/>
4727 <delete file="${basedir}/gs2build/win32.mak"/>
4728 <delete dir="${basedir}/winutil"/>
4729 <delete failonerror="false"><fileset dir="${lib.jni}" includes="*.dll"/></delete>
4730
4731 <!-- windows -->
4732 <else><if><bool><istrue value="${current.os.iswindows}"/></bool>
4733 <!--*****<delete><fileset dir="." includes="*.sh,*.bash,*.csh"/></delete>-->
4734 <if><bool><isset property="with.gli.and.gems"/></bool>
4735 <!--*****<delete><fileset dir="gli" includes="*.sh,*.bash,*.csh"/></delete>-->
4736 </if>
4737 <!--*****<delete><fileset dir="gs2build" includes="*.sh,*.bash,*.csh"/></delete>-->
4738 <!--*****<delete><fileset dir="bin/script" includes="*.sh,*.bash,*.csh"/></delete>-->
4739 </if></else></if>
4740
4741 </target>
4742
4743 <!-- fix up executable permissions for binary release -->
4744 <target name="fix-execute-permissions">
4745 <echo>Setting binaries to executable</echo>
4746 <chmod perm="775">
4747 <fileset dir="."><patternset refid="greenstone3.executables"/></fileset>
4748 </chmod>
4749 </target>
4750
4751 <!-- fix up executable permissions for source code release -->
4752 <target name="fix-execute-permissions-source">
4753 <chmod perm="775">
4754 <fileset dir="."><patternset refid="greenstone3.source.executables"/></fileset>
4755 </chmod>
4756 </target>
4757
4758 <!-- for macs, set up the .app shortcuts to gsi, gli, client-gli and gems -->
4759 <target name="gen-mac-shortcuts">
4760 <exec executable="uname" dir="${basedir}" failonerror="false"
4761 outputproperty="darwin.kernel.version">
4762 <arg value="-r"/>
4763 </exec>
4764
4765 <echo>darwin kernel version: ${darwin.kernel.version}</echo>
4766
4767 <if>
4768 <bool><matches string="${darwin.kernel.version}" pattern="^([0-9]|1[0-8])\."/></bool>
4769 <property name="mac.app.bitness" value="32"/>
4770 <else>
4771 <property name="mac.app.bitness" value="64"/>
4772 </else>
4773 </if>
4774
4775 <echo>bitness for mac apps: ${mac.app.bitness}</echo>
4776
4777 <!--(recursively) copy the .app files from the MacShortcutsXbit folder of the correct bitness
4778 https://stackoverflow.com/questions/1685442/how-to-copy-a-directory-using-ant -->
4779 <copy todir="${basedir}" >
4780 <fileset dir="${basedir}/MacShortcuts${mac.app.bitness}bit" includes="**"/>
4781 </copy>
4782
4783 <if><bool><istrue value="${current.os.ismac}"/></bool>
4784 <filter token="gsdl3srchome" value="${basedir}"/>
4785 <copy file="${basedir}/gs3-server.app/Contents/document.wflow.in" tofile="${basedir}/gs3-server.app/Contents/document.wflow" filtering="true" overwrite="true"/>
4786 <copy file="${basedir}/gli.app/Contents/document.wflow.in" tofile="${basedir}/gli.app/Contents/document.wflow" filtering="true" overwrite="true"/>
4787 <copy file="${basedir}/client-gli.app/Contents/document.wflow.in" tofile="${basedir}/client-gli.app/Contents/document.wflow" filtering="true" overwrite="true"/>
4788 <copy file="${basedir}/gems.app/Contents/document.wflow.in" tofile="${basedir}/gems.app/Contents/document.wflow" filtering="true" overwrite="true"/>
4789 </if>
4790 </target>
4791
4792 <!-- ============= tweaks for making compilation static ========== -->
4793 <target name="tweak-makefiles" depends="init" if="compile.static">
4794 <antcall target="rtftohtml-add-static" />
4795 </target>
4796
4797 <target name="rtftohtml-add-static" depends="init" if="collection.building.enabled">
4798 <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" />
4799 </target>
4800
4801 <target name="run-collection-tests">
4802 <if><bool><not><available file="${basedir}/ext/testing" type="dir"/></not></bool>
4803 <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>
4804 </if>
4805 <for param="testjar">
4806 <path>
4807 <fileset dir="${basedir}" includes="web/sites/*/collect/*/tests/tests.jar"/>
4808 </path>
4809 <sequential>
4810 <echo>Testing @{testjar}</echo>
4811 <java classname="org.junit.runner.JUnitCore" fork="true">
4812 <!--https://stackoverflow.com/questions/38676719/selenium-using-java-the-path-to-the-driver-executable-must-be-set-by-the-webdr-->
4813 <sysproperty key="webdriver.gecko.driver" path="${basedir}/ext/testing/geckodriver"/>
4814 <arg value="gstests.TestClass"/>
4815 <jvmarg value="-DSERVERURL=${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}${server.default.servlet} "/>
4816 <classpath>
4817 <fileset dir="${basedir}/ext/testing/lib/java">
4818 <include name="*.jar"/>
4819 </fileset>
4820 <files includes="@{testjar}"/>
4821 </classpath>
4822 </java>
4823 </sequential>
4824 </for>
4825 </target>
4826
4827 <target name="build-collection-tests">
4828 <if><bool><not><available file="${basedir}/ext/testing" type="dir"/></not></bool>
4829 <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>
4830 </if>
4831 <for param="compiledir">
4832 <path>
4833 <dirset dir="${basedir}" includes="web/sites/*/collect/*/tests/src"/>
4834 </path>
4835 <sequential>
4836 <echo>Compiling @{compiledir}</echo>
4837 <if><bool><not><available file="@{compiledir}/../build" type="dir"/></not></bool>
4838 <mkdir dir="@{compiledir}/../build"/>
4839 </if>
4840 <javac srcdir="@{compiledir}"
4841 destdir="@{compiledir}/../build"
4842 includeantruntime="${compile.includeantruntime}"
4843 debug="${compile.debug}"
4844 deprecation="${compile.deprecation}"
4845 optimize="${compile.optimize}"
4846 encoding="${compile.encoding}">
4847 <compilerarg line="${compile.javac.flags}"/>
4848 <classpath>
4849 <fileset dir="${basedir}/ext/testing/lib/java">
4850 <include name="*.jar"/>
4851 </fileset>
4852 </classpath>
4853 <include name="gstests/*.java"/>
4854 </javac>
4855 <jar destfile="@{compiledir}/../tests.jar">
4856 <fileset dir="@{compiledir}/../build">
4857 <include name="gstests/**"/>
4858 </fileset>
4859 <manifest>
4860 <attribute name="Built-By" value="${user.name}" />
4861 </manifest>
4862 </jar>
4863 </sequential>
4864 </for>
4865 </target>
4866</project>
Note: See TracBrowser for help on using the repository browser.