JAL-3009 news reader thread should be in background. TODO: patch newsreader so it...
[jalview.git] / build.xml
1 <?xml version="1.0"?>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
4  * Copyright (C) $$Year-Rel$$ The Jalview Authors
5  * 
6  * This file is part of Jalview.
7  * 
8  * Jalview is free software: you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License 
10  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
18  * The Jalview Authors are detailed in the 'AUTHORS' file.
19 -->
20 <project name="jalviewX" default="usage" basedir="."
21  xmlns:if="ant:if"
22     xmlns:unless="ant:unless">
23   <target name="help" depends="usage" />
24   <target name="usage" depends="init">
25     <echo message="~~~Jalview Ant build.xml Usage~~~~" />
26     <echo message="Targets include:" />
27     <echo message="usage - default target, displays this message" />
28     <echo message="buildindices - generates JavaHelpSearch from the help files" />
29     <echo message="build - compiles all necessary files for Application" />
30     <echo message="makedist - compiles and places all necessary jar files into directory dist" />
31     <echo message="makefulldist - signs all jar files and builds jnlp file for full distribution" />
32     <echo message="              this needs a keystore and key."/>
33     <echo message="              Add -Dtimestamp to timestamp signed jars"/>
34     <echo message="              -Djalview.keyalg and -Djalview.keydig are SHA1/SHA1withRSA"/>
35     <echo message="              See docs/building.html for more information." />
36     <echo message="compileApplet - compiles all necessary files for Applet" />
37     <echo message="makeApplet - compiles, then packages and obfuscates the Applet" />
38     <echo message="testng - run jalview's tests via testNG. Default group is '${testng-groups}'" />
39     <echo message="      you can specify particular test groups as a list via -Dtestng-groups=" />
40     <echo message="See docs/building.html and the comments in build file for other targets." />
41     <echo message="note: compile and makeApplet optionally compile/obfuscate applet against a different Java version by specifying -Djava118.home=PathtoJDK/lib which is the lib directory in the JDK install that contains rt.jar " />
42     <echo message="Useful -D flags: -Ddonotobfuscate will prevent applet obfuscation" />
43   </target>
44
45
46   <!-- utils is a class path to additional utilities needed for
47     building docs, jars and webstart stuff -->
48   <!--
49         Userdefined build property defaults
50
51         wsdl.server list (plus namespace mapping info ???)  - also want
52                 ... to make this a dynamically generatable property
53         WebStart Location
54         Build location - provide a temporary root for speed
55         jarsigner keystore and info
56         Jakarta and axis classpath ?
57         Default argument for starting Jalview (if it exists).
58
59 -->
60
61   <target name="init">
62     <path id="axis.classpath">
63       <!-->
64       <fileset dir="/usr/local/axis/lib">
65         <include name="**/*.jar" />
66       </fileset>
67       <fileset dir="/usr/local/jakarta-tomcat-5/webapps/axis/WEB-INF/lib">
68         <include name="**/*.jar"/>
69         <include name="*.jar"/>
70       </fileset> -->
71       </path>
72
73     <!-- Jalview Version String displayed by application on startup and used to check for updates -->
74     <property name="JALVIEW_VERSION" value="DEVELOPMENT" />
75
76     <property name="INSTALLATION" value="Source" />
77
78     <!-- 2.4 (VAMSAS)" -->
79     <!-- Include debugging information in javac true or false -->
80     <property name="javac.debug" value="true" />
81
82     <!-- JarSigner Key Store for Webstart Distribution -->
83     <property name="jalview.keystore" value="./keys/.keystore" />
84     <!-- Keystore Password -->
85     <property name="jalview.keystore.pass" value="alignmentisfun" />
86     <!-- Key Name -->
87     <property name="jalview.key" value="jalview" />
88     <!-- Key Password -->
89     <property name="jalview.key.pass" value="alignmentisfun" />
90     <!-- time stamp server URL -->
91     <property name="jalview.tsaurl" value="" />
92     <!-- locally valid proxy for signing with external time server -->
93     <property name="proxyPort" value="80"/>
94     <property name="proxyHost" value="sqid"/>
95     <!-- key sign/digest algorithms -->
96     <property name="jalview.keyalg" value="SHA1withRSA" description="key algorithm for signing"/>
97     <property name="jalview.keydig" value="SHA1" description="algorithm for jar digest"/>
98
99     <!-- default TestNG groups to run -->
100     <property name="testng-groups" value="Functional" />
101     <!-- Java 9 JVM args -->
102     <condition property="java9">
103       <equals arg1="${ant.java.version}" arg2="9"/>
104     </condition>
105
106     <!-- Don't change anything below here unless you know what you are doing! -->
107     <!-- Url path for WebStart in JNLP file -->
108     <property name="WebStartLocation" value="http://www.jalview.org/webstart" />
109     <!-- Webstart Image - looked for in resources/images -->
110     <property name="WebStartImage" value="JalviewLogo_big.png" />
111     <!-- J2SE version needed for webstart launch -->
112     <!-- Anne's version needs 1.7 - should rebuild VARNA to java 1.6 for release -->
113     <property name="j2sev" value="1.7+" />
114     <!-- Java Compilation settings - source and target javac version -->
115     <property name="javac.source" value="1.8" />
116     <property name="javac.target" value="1.8" />
117
118     <!-- Permissions for running Java applets and applications. -->
119     <!-- Defaults are those suitable for deploying jalview webstart www.jalview.org -->
120     <property name="application.codebase" value="*.jalview.org" />
121     <!-- and allowing the applet to be deployed from any URL -->
122     <!-- note - if you want to make sure LiveConnect works without any warnings, please rebuild and sign your applet jar with your own domain included in the codebase/allowable-codebase properties -->
123     <property name="applet.codebase" value="*.jalview.org *.dundee.ac.uk *" />
124     <property name="applet.caller-codebase" value="${applet.codebase}" />
125
126     <!-- build directory configuration -->
127     <property name="libDir" value="lib" />
128     <property name="resourceDir" value="resources" />
129     <property name="helpDir" value="help" />
130     <property name="docDir" value="doc" />
131     <property name="sourceDir" value="src" />
132     <property name="schemaDir" value="schemas" />
133     <property name="outputDir" value="classes" />
134     <property name="packageDir" value="dist" />
135     <property name="outputJar" value="jalview.jar" />
136     <!-- Jalview Applet JMol Jar Dependency -->
137     <property name="jmolJar" value="JmolApplet-14.6.4_2016.10.26.jar" />
138     <property name="varnaJar" value="VARNAv3-93.jar" />
139     <property name="jsoup" value="jsoup-1.8.1.jar" />
140     <property name="jsonSimple" value="json_simple-1.1.jar" />
141     <property name="javaJson" value="java-json.jar" />
142     <property name="jalviewLiteJar" value="jalviewApplet.jar" />
143     <property name="reportDir" value="test-reports" />
144     <property name="testDir" value="test" />
145     <property name="testOutputDir" value="tests" />
146     <!-- switch to indicate if we should obfuscate jalviewLite -->
147     <!-- <property name="donotobfuscate" value="true"/> -->
148     <!-- switch to exclude associations from generated jnlp files -->
149     <!-- <property name="nojnlpfileassocs" value="true"/> -->
150
151     <!-- Jalview Web Service Clients - see the comments in 'buildextclients' for details -->
152     <property name="wsdl.File" value="http://www.compbio.dundee.ac.uk/JalviewWS/services/jpred?wsdl" />
153     <property name="wsdl.Files" value="http://www.compbio.dundee.ac.uk/JalviewWS/services/vamsas?wsdlFiles" />
154     <property name="wsdl.MsaWS" value="http://www.compbio.dundee.ac.uk/JalviewWS/services/MuscleWS?wsdl" />
155     <property name="wsdl.MsaWS2" value="http://www.compbio.dundee.ac.uk/JalviewWS/services/ClustalWS?wsdl" />
156     <property name="WSInterf" value="MsaWS" />
157     <property name="wsdl.Namespace" value="vamsas" />
158     <property name="wsdl.ClientNS" value="ext.vamsas" />
159     <!-- the class path for building the application -->
160     <path id="build.classpath">
161       <fileset dir="utils">
162         <include name="*.jar" />
163         <include name="**/*.jar" />
164       </fileset>
165       <fileset dir="${libDir}">
166         <include name="*.jar" />
167         <include name="**/*.jar" />
168       </fileset>
169       <fileset dir="${java.home}/lib">
170         <include name="plugin.jar" />
171       </fileset>
172       <fileset dir="appletlib">
173         <!-- the JmolApplet includes the JmolApplet console and the application javac seems to always try and build all packages 
174                                 -->
175         <include name="${jmolJar}" />
176         <include name="${varnaJar}" />
177       </fileset>
178     </path>
179     <path id="test.classpath">
180       <pathelement path="${outputDir}" />
181       <path refid="build.classpath" />
182     </path>
183     <property name="source.dist.name" value="${basedir}/jalview-src.tar.gz" />
184     <!-- The Location of the java 1.1.8 jdk -->
185     <property name="java118.home" value="${java.home}" />
186     <!-- jre for 1.4 version -->
187     <property name="applet.jre.tools" value="${java118.home}/lib/rt.jar" />
188
189     <!-- the classpath for building the 1.1 applet -->
190     <path id="jalviewlite.deps">
191       <fileset dir="${java118.home}">
192         <include name="lib/rt.jar" />
193       </fileset>
194       <fileset dir="${java.home}/lib">
195         <include name="plugin.jar" />
196       </fileset>
197       <pathelement location="appletlib/${jmolJar}" />
198       <pathelement location="lib/${varnaJar}" />
199       <pathelement location="appletlib/${jsoup}" />
200       <pathelement location="appletlib/${jsonSimple}" />
201       <pathelement location="appletlib/${javaJson}" />
202
203     </path>
204     <!-- default location for outputting javadoc -->
205     <property name="javadocDir" value="${packageDir}/javadoc" />
206   </target>
207
208
209   <taskdef classpath="utils/roxes-ant-tasks-1.2-2004-01-30.jar" resource="com/roxes/tools/ant/taskdefs.properties" />
210   <target name="buildPropertiesFile" depends="init">
211     <tstamp prefix="build">
212       <format property="date" pattern="dd MMMM yyyy" />
213     </tstamp>
214     <exec executable="/usr/bin/git" outputproperty="git.commit" failifexecutionfails="false">
215       <arg value="rev-parse" />
216       <arg value="--short" />
217       <arg value="HEAD" />
218     </exec>
219     <exec executable="/usr/bin/git" outputproperty="git.branch" failifexecutionfails="false">
220       <arg value="rev-parse" />
221       <arg value="--abbrev-ref" />
222       <arg value="HEAD" />
223     </exec>
224     <properties file="${outputDir}/.build_properties">
225       <header>
226           ---Jalview Build Details---
227         </header>
228       <property name="VERSION" value="${JALVIEW_VERSION}" />
229       <property name="INSTALLATION" value="${INSTALLATION} git-commit:${git.commit} [${git.branch}]" />
230       <property name="BUILD_DATE" value="${build.date}" />
231     </properties>
232   </target>
233
234
235   <target name="clean" depends="init">
236     <!-- not efficient yet. -->
237     <delete dir="${outputDir}" includes="*,**/*" />
238   </target>
239
240   <target name="distclean" depends="init, clean">
241
242     <echo message="REMOVING ALL BACKUP/AUTOSAVES!" />
243     <delete>
244       <fileset dir=".">
245         <include name="${outputJar}" />
246         <include name="#*#" />
247         <include name="#*.*#" />
248         <include name="**/#*#" />
249         <include name="**/#*.*#" />
250         <include name="*~" />
251         <include name="*.*~" />
252         <include name="**/*~" />
253         <include name="**/*.*~" />
254       </fileset>
255     </delete>
256   </target>
257
258   <target name="prepare" depends="init">
259     <mkdir dir="${outputDir}" />
260     <copy todir="${outputDir}">
261       <fileset dir=".">
262         <include name="${docDir}/**/*.*" />
263         <include name="${helpDir}/**/*.*" />
264         <include name="${libDir}/*.jar" />
265       </fileset>
266       <fileset dir="${resourceDir}">
267         <include name="**/*.*" />
268       </fileset>
269     </copy>
270   </target>
271
272   <target name="build" depends="prepare">
273     <!-- not efficient yet. -->
274     <javac source="${javac.source}" target="${javac.target}" srcdir="${sourceDir}" destdir="${outputDir}" debug="${javac.debug}" classpathref="build.classpath">
275       <exclude name="jalview/*applet*" />
276       <exclude name="jalview/appletgui/**" />
277       <exclude name="com/stevesoft/**" />
278     </javac>
279   </target>
280
281
282   <target name="testclean" depends="init">
283     <delete dir="${testOutputDir}" includes="*,**/*" />
284   </target>
285
286   <target name="prepareTests" depends="init,testclean">
287     <mkdir dir="${testOutputDir}" />
288   </target>
289
290   <target name="buildTests" depends="build,buildindices,prepareTests">
291     <javac source="${javac.source}" target="${javac.target}" srcdir="${testDir}" destdir="${testOutputDir}" debug="${javac.debug}" classpathref="test.classpath" includeantruntime="false">
292     </javac>
293   </target>
294
295   <taskdef resource="testngtasks" classpath="utils/testnglibs/testng.jar" />
296
297   <target name="testng" depends="buildTests">
298     <testng outputDir="${reportDir}" haltOnFailure="false" groups="${testng-groups}" mode="testng"
299       verbose="2">
300       <classpath>
301         <pathelement location="${testOutputDir}" />
302         <path refid="test.classpath" />
303       </classpath>
304       <jvmarg value="--add-modules=java.se.ee" if:set="java9"/>
305       <jvmarg value="--illegal-access=warn" if:set="java9"/>
306       <classfileset dir="${testOutputDir}" includes="**/*.class" />
307     </testng>
308   </target>
309
310   <target name="buildindices" depends="init, prepare" unless="help.uptodate">
311     <replace value="${JALVIEW_VERSION}">
312       <replacetoken><![CDATA[$$Version-Rel$$]]></replacetoken>
313       <fileset dir="${outputDir}/${helpDir}">
314         <include name="help.jhm" />
315       </fileset>
316     </replace>
317
318     <java classname="com.sun.java.help.search.Indexer" classpathref="build.classpath" fork="true" dir="${outputDir}/${helpDir}">
319       <arg line="html" />
320     </java>
321   </target>
322
323   <target name="preparejnlp" depends="makedist">
324     <copy todir="${packageDir}">
325       <fileset dir="${resourceDir}/images">
326         <include name="${WebStartImage}" />
327       </fileset>
328     </copy>
329
330     <taskdef classpathref="build.classpath" resource="com/roxes/tools/ant/taskdefs.properties" />
331
332     <!-- create a dummy jar which will eventually contain the jnlp template -->
333     <jar destfile="${packageDir}/jalview_jnlp_vm.jar" index="true">
334       <fileset dir="${packageDir}">
335         <include name="jalview.jar" />
336       </fileset>
337     </jar>
338
339     <mkdir dir="${packageDir}/JNLP-INF" />
340     <antcall target="writejnlpf">
341       <param name="jnlpFile" value="${packageDir}/JNLP-INF/APPLICATION-TEMPLATE.JNLP" />
342       <param name="inih" value="*" />
343       <param name="maxh" value="*" />
344     </antcall>
345
346     <jar destfile="${packageDir}/jalview_jnlp_vm.jar" index="true">
347       <fileset dir="${packageDir}">
348         <include name="JNLP-INF/APPLICATION-TEMPLATE.JNLP" />
349       </fileset>
350     </jar>
351
352     <antcall target="writejnlpf">
353       <param name="jnlpFile" value="${packageDir}/jalview.jnlp" />
354       <param name="inih" value="10M" />
355       <param name="maxh" value="256M" />
356     </antcall>
357
358     <antcall target="writejnlpf">
359       <param name="jnlpFile" value="${packageDir}/jalview_1G.jnlp" />
360       <param name="inih" value="128M" />
361       <param name="maxh" value="512M" />
362     </antcall>
363
364     <antcall target="writejnlpf">
365       <param name="jnlpFile" value="${packageDir}/jalview_2G.jnlp" />
366       <param name="inih" value="256M" />
367       <param name="maxh" value="1024M" />
368     </antcall>
369
370     <!-- finally, need to postprocess to add in associations at end of 'information' element 
371                         
372                         <xslt in="${packageDir}/jalview_noa_1G.jnlp" out="${packageDir}/jalview_1G.jnlp">
373                 
374                 </xslt>
375                         
376                         
377                         -->
378     <!--
379                                 <association mime-type="application-x/ext-file" extensions="fa"/>
380         <association mime-type="application-x/ext-file" extensions="fasta"/>
381         <association mime-type="application-x/ext-file" extensions="mfa"/>
382         <association mime-type="application-x/ext-file" extensions="fastq"/>
383         <association mime-type="application-x/ext-file" extensions="blc"/>
384         <association mime-type="application-x/ext-file" extensions="msf"/>
385         <association mime-type="application-x/ext-file" extensions="pfam"/>
386         <association mime-type="application-x/ext-file" extensions="aln"/>
387         <association mime-type="application-x/ext-file" extensions="pir"/>
388         <association mime-type="application-x/ext-file" extensions="amsa"/>
389         <association mime-type="application-x/ext-file" extensions="stk"/>
390         <association mime-type="application-x/ext-file" extensions="jar"/>-->
391   </target>
392
393   <target name="-jarsignwithtsa" depends="makedist,preparejnlp" if="timestamp">
394     <signjar storepass="${jalview.keystore.pass}" keypass="${jalview.key.pass}" keystore="${jalview.keystore}" alias="${jalview.key}" lazy="false" verbose="false" sigalg="${jalview.keyalg}" digestalg="${jalview.keydig}"
395       tsaproxyhost="${proxyHost}" tsaproxyport="${proxyPort}" tsaurl="${jalview.tsaurl}">
396       <fileset dir="${packageDir}">
397         <include name="*.jar" />
398       </fileset>
399     </signjar>
400   </target>
401   <target name="-jarsignnotsa" depends="makedist,preparejnlp" unless="timestamp">
402     <signjar storepass="${jalview.keystore.pass}" keypass="${jalview.key.pass}" keystore="${jalview.keystore}" alias="${jalview.key}" lazy="false" verbose="false" sigalg="${jalview.keyalg}" digestalg="${jalview.keydig}">
403       <fileset dir="${packageDir}">
404         <include name="*.jar" />
405       </fileset>
406     </signjar>
407   </target>
408
409   <target name="makefulldist" depends="makedist,preparejnlp,-jarsignwithtsa,-jarsignnotsa">
410     <!-- and sign the jars -->
411     <!-- the default keystore details might need to be edited here -->
412   </target>
413
414   <target name="runenv" depends="init">
415     <path id="run.classpath">
416       <pathelement location="${outputDir}" />
417       <fileset dir="${outputDir}">
418         <include name="${libDir}/*.jar" />
419       </fileset>
420     </path>
421     <pathconvert targetos="unix" refid="run.classpath" property="run.classpath" />
422
423     <echo>java -classpath ${run.classpath} jalview.bin.Jalview
424       </echo>
425   </target>
426
427   <target name="-generatejnlpf">
428     <presetdef name="jnlpf">
429       <jnlp codebase="${WebStartLocation}">
430         <information>
431           <title>Jalview</title>
432           <vendor>The Barton Group</vendor>
433           <homepage href="http://www.jalview.org" />
434           <description>Jalview Multiple Alignment Editor</description>
435           <description kind="short">Jalview</description>
436           <icon href="${WebStartImage}" />
437           <offline_allowed />
438         </information>
439         <resources>
440           <j2se version="1.8+" />
441           <jar main="true" href="jalview.jar"/>
442           <fileset dir="${packageDir}">
443             <exclude name="jalview.jar" />
444             <include name="*.jar" />
445             <include name="*_*.jar" />
446             <exclude name="*quaqua*.jar" />
447           </fileset>
448           <property name="jalview.version" value="${JALVIEW_VERSION}" />
449         </resources>
450         <resources os="Mac OS X">
451           <fileset dir="${packageDir}">
452                  <include name="quaqua-filechooser-only-8.0.jar"/>
453             <include name="*quaqua64*.jnilib.jar" />
454           </fileset>
455         </resources>
456
457         <application_desc main_class="jalview.bin.Jalview">
458         </application_desc>
459         <security>
460           <all_permissions />
461         </security>
462       </jnlp>
463     </presetdef>
464
465     <jnlpf toFile="${jnlpFile}" />
466     <!-- add the add-modules j2se attribute for java 9 -->
467     <replace file="${jnlpFile}" value="j2se version=&quot;1.8+&quot; initial-heap-size=&quot;${inih}&quot; max-heap-size=&quot;${maxh}&quot; java-vm-args=&quot;--add-modules=java.se.ee --illegal-access=warn&quot;">
468           <replacetoken>j2se version="1.8+"</replacetoken>
469            
470         </replace>
471   </target>
472
473   <target name="-dofakejnlpfileassoc" depends="-generatejnlpf" if="nojnlpfileassocs">
474     <echo message="Not adding JNLP File Associations" />
475   </target>
476
477   <target name="-dojnlpfileassoc" depends="-generatejnlpf" unless="nojnlpfileassocs">
478     <replace file="${jnlpFile}">
479       <replacetoken>
480         <![CDATA[</information>]]></replacetoken>
481       <replacevalue>
482         <![CDATA[
483           <association mime-type="application-x/ext-file" extensions="fa" />
484         <association mime-type="application-x/ext-file" extensions="fasta" />
485         <association mime-type="application-x/ext-file" extensions="mfa" />
486         <association mime-type="application-x/ext-file" extensions="fastq" />
487         <association mime-type="application-x/ext-file" extensions="blc" />
488         <association mime-type="application-x/ext-file" extensions="msf" />
489         <association mime-type="application-x/ext-file" extensions="pfam" />
490         <association mime-type="application-x/ext-file" extensions="aln"/>
491         <association mime-type="application-x/ext-file" extensions="pir"/>
492         <association mime-type="application-x/ext-file" extensions="amsa"/>
493         <association mime-type="application-x/ext-file" extensions="stk"/>
494         <association mime-type="application-x/ext-file" extensions="jvp"/>
495       </information>]]></replacevalue>
496   </replace>
497   <echo message="Added file associations to JNLP file" />
498 </target>
499 <target name="writejnlpf" depends="-dojnlpfileassoc,-dofakejnlpfileassoc">
500 </target>
501
502 <target name="buildextclients" depends="init">
503   <input message="Building external client source from WSDLs - Do you really want to do this ? (Yy/Nn)" validargs="Y,y,n,N" defaultvalue="N" addproperty="doextbuild.response" />
504   <condition property="dontextbuild">
505     <equals arg1="n" arg2="${doextbuild.response}" />
506   </condition>
507   <condition property="dontextbuild">
508     <equals arg1="N" arg2="${doextbuild.response}" />
509   </condition>
510   <fail if="dontextbuild">
511         Build External Client Code process aborted by user. Jalview source is unchanged.
512       </fail>
513   <!-- Currently, this doesn't happen automatically.
514      1. Run WSDL2Java as below, which generates an ext.vamsas +
515      vamsas.<datapackages> fileset.
516      2. refactor ext.vamsas.SpecificserviceWS* to
517      ext.vamsas.ServiceclassWS* that implements the ServiceclassWSI interface.
518      3. Update the jalview.ws.*WServices classes to reflect the
519      interface type, and all locations of this wsdl type that Jalview
520      might be using.
521
522 -->
523   <path id="axisbuild">
524     <path refid="build.classpath" />
525   </path>
526   <taskdef resource="axis-tasks.properties" classpathref="axisbuild" />
527   <move todir="./bak">
528     <fileset dir="${sourceDir}" id="client">
529       <include name="${wsdl.ClientNS}/*.*" />
530     </fileset>
531   </move>
532
533   <axis-wsdl2java output="${sourceDir}" verbose="true" url="${wsdl.MsaWS2}" serverside="false" deployscope="Request" debug="false" helpergen="true" all="true">
534     <mappingSet>
535       <mapping namespace="${wsdl.Namespace}" package="${wsdl.ClientNS}" />
536       <mapping namespace="http://dataTypes.vamsas" package="${wsdl.ClientNS}" />
537     </mappingSet>
538   </axis-wsdl2java>
539 </target>
540
541 <target name="makedist" depends="build, buildPropertiesFile, linkcheck, buildindices">
542   <!-- make the package jar if not already existing -->
543   <mkdir dir="${packageDir}" />
544   <!-- clean dir if it already existed -->
545   <delete>
546     <fileset dir="${packageDir}">
547       <include name="*.jar" />
548     </fileset>
549   </delete>
550   <jar destfile="${packageDir}/${outputJar}" index="true">
551     <manifest>
552       <attribute name="Main-Class" value="jalview.bin.Jalview" />
553       <attribute name="Permissions" value="all-permissions" />
554       <attribute name="Application-Name" value="Jalview Desktop" />
555       <attribute name="Codebase" value="${application.codebase}" />
556     </manifest>
557     <fileset dir="${outputDir}/">
558       <exclude name="cache*/**" />
559       <exclude name="*.jar" />
560       <exclude name="*.jar.*" />
561       <exclude name="**/*.jar" />
562       <exclude name="**/*.jar.*" />
563     </fileset>
564   </jar>
565
566   <copy toDir="${packageDir}" flatten="true">
567     <fileset dir="${outputDir}">
568       <include name="*.jar" />
569       <include name="**/*.jar" />
570     </fileset>
571   </copy>
572 </target>
573
574
575 <!-- jalopy code reformatter -->
576 <target name="sourcescrub" depends="init,build">
577   <jalopy destdir="jsrc" classpathref="run.classpath" convention="jalview-jalopy.xml">
578     <fileset dir="${sourceDir}">
579       <include name="*.java" />
580       <include name="**/*.java" />
581       <include name="**/**/*.java" />
582     </fileset>
583   </jalopy>
584 </target>
585
586
587
588 <!-- Compile, package and obfuscate Jalview Applet -->
589 <target name="makeApplet" depends="obfuscate" description="assemble the final jalviewLite applet jar with or without obfuscation" />
590
591 <target name="compileApplet" depends="init,clean">
592   <mkdir dir="${outputDir}" />
593   <javac source="${javac.source}" target="${javac.target}" srcdir="${sourceDir}" destdir="${outputDir}" debug="${javac.debug}" classpathref="jalviewlite.deps" includes="jalview/appletgui/**" excludes="ext/**,gui/**,jbgui/**,MCview/**,org/**,vamsas/**,jalview/ext/rbvi/**,jalview/ext/paradise/**,jalview/ext/ensembl/**,jalview/ext/so/**" />
594 </target>
595
596 <target name="packageApplet" depends="compileApplet, buildPropertiesFile">
597   <copy file="${resourceDir}/images/link.gif" toFile="${outputDir}/images/link.gif" />
598   <copy todir="${outputDir}/lang">
599     <fileset dir="${resourceDir}/lang">
600       <include name="**.*" />
601     </fileset>
602   </copy>
603   <jar destfile="in.jar" index="true">
604     <manifest>
605       <attribute name="Main-Class" value="jalview.bin.JalviewLite" />
606       <attribute name="Application-Name" value="JalviewLite" />
607       <attribute name="Codebase" value="${applet.codebase}" />
608     </manifest>
609     <fileset dir="${outputDir}">
610       <include name="com/**" />
611       <include name="MCview/**" />
612       <include name="jalview/**" />
613       <include name=".build_properties" />
614       <include name="images/link.gif" />
615       <include name="lang/**" />
616     </fileset>
617   </jar>
618 </target>
619 <target name="obfuscate" depends="-obfuscatefake,-obfuscatereally">
620 </target>
621 <target name="-obfuscatefake" depends="packageApplet" if="donotobfuscate">
622   <copy file="in.jar" tofile="${jalviewLiteJar}" overwrite="true" />
623   <delete file="in.jar" />
624 </target>
625 <target name="-obfuscatereally" unless="donotobfuscate">
626
627   <path id="obfuscateDeps.path">
628     <pathelement location="${applet.jre.tools}" />
629     <pathelement location="appletlib/${jmolJar}" />
630     <pathelement location="lib/${varnaJar}" />
631     <pathelement location="appletlib/${jsoup}" />
632     <pathelement location="appletlib/${jsonSimple}" />
633     <pathelement location="appletlib/${javaJson}" />
634     <fileset dir="${java.home}/lib">
635       <include name="plugin.jar" />
636     </fileset>
637   </path>
638   <taskdef resource="proguard/ant/task.properties" classpath="utils/proguard_5.3.3.jar" />
639
640   <proguard verbose="true" >
641     <injar file="in.jar" />
642     <outjar file="${jalviewLiteJar}" />
643     <libraryjar refid="obfuscateDeps.path" />
644     <dontwarn />
645     <keep access="public" type="class" name="jalview.bin.JalviewLite">
646       <field access="public" />
647       <method access="public" />
648       <constructor access="public" />
649     </keep>
650     <keep access="public" type="class" name="jalview.appletgui.AlignFrame">
651       <field access="public" />
652       <method access="public" />
653       <constructor access="public" />
654     </keep>
655
656     <keep name="jalview.json.binding**">
657       <constructor/>
658       <method name="*"/>
659     </keep>
660
661     <keep access="public" type="class" name="MCview.PDBfile">
662       <field access="public" />
663       <method access="public" />
664       <constructor access="public" />
665     </keep>
666
667     <keep access="public" type="class" name="jalview.ws.jws1.Annotate3D">
668       <field access="public" />
669       <method access="public" />
670       <constructor access="public" />
671     </keep>
672
673     <keep access="public" type="class" name="jalview.ext.jmol.JmolParser">
674       <field access="public" />
675       <method access="public" />
676       <constructor access="public" />
677     </keep>
678
679
680     <!--      -libraryjars "${obfuscateDeps}"
681       -injars      in.jar
682       -outjars     jalviewApplet.jar
683       -keep public class jalview.bin.JalviewLite
684        { public * ; } -->
685   </proguard>
686   <delete file="in.jar" />
687 </target>
688
689 <target name="castorbinding" depends="init" description="Generate Java bindings to supported Jalview XML models.">
690   <taskdef name="castor-srcgen" classname="org.castor.anttask.CastorCodeGenTask" classpathref="build.classpath" />
691   <delete>
692     <fileset dir="${sourceDir}/jalview/schemabinding/version2">
693       <include name="*.java" />
694       <include name="descriptors/*.java" />
695     </fileset>
696   </delete>
697   <castor-srcgen file="${schemaDir}/vamsas.xsd" todir="${sourceDir}" package="jalview.schemabinding.version2" warnings="false" nodesc="false" verbose="true" properties="${schemaDir}/jalview.properties" />
698   <castor-srcgen file="${schemaDir}/JalviewUserColours.xsd" todir="${sourceDir}" package="jalview.schemabinding.version2" warnings="false" nodesc="false" verbose="true" properties="${schemaDir}/jalview.properties" />
699   <castor-srcgen file="${schemaDir}/JalviewWsParamSet.xsd" todir="${sourceDir}" package="jalview.schemabinding.version2" warnings="false" nodesc="false" verbose="true" properties="${schemaDir}/jalview.properties" />
700   <castor-srcgen file="${schemaDir}/jalview.xsd" todir="${sourceDir}" package="jalview.schemabinding.version2" warnings="false" nodesc="false" verbose="true" properties="${schemaDir}/jalview.properties" />
701   <!-- 
702                 now build the jalview.binding package with the old schema set
703                 -->
704   <delete>
705     <fileset dir="${sourceDir}/jalview/binding/">
706       <include name="**" />
707     </fileset>
708   </delete>
709   <castor-srcgen file="${schemaDir}/vamsasJvV1.xsd" todir="${sourceDir}" package="jalview.binding" warnings="false" nodesc="true" verbose="true" properties="${schemaDir}/jalview.nodesc.properties" />
710   <castor-srcgen file="${schemaDir}/JalviewUserColours.xsd" todir="${sourceDir}" package="jalview.binding" warnings="false" nodesc="true" verbose="true" properties="${schemaDir}/jalview.nodesc.properties" />
711   <castor-srcgen file="${schemaDir}/jalviewJvV1.xsd" todir="${sourceDir}" package="jalview.binding" warnings="false" nodesc="true" verbose="true" properties="${schemaDir}/jalview.nodesc.properties" />
712 </target>
713 <target name="sourcedist" description="create jalview source distribution" depends="init">
714   <delete file="${source.dist.name}" />
715   <!-- temporary copy of source to update timestamps -->
716   <copy todir="_sourcedist">
717     <fileset dir=".">
718       <exclude name=".*" />
719       <exclude name="**/.*" />
720       <exclude name="*.class" />
721       <exclude name="**/*.class" />
722       <include name="LICENSE" />
723       <include name="README" />
724       <include name="build.xml" />
725       <include name="jalview-jalopy.xml" />
726       <include name="JalviewApplet.jpx" />
727       <include name="JalviewX.jpx" />
728       <include name="nbbuild.xml" />
729       <include name="nbproject/genfiles.properties" />
730       <include name="nbproject/project.properties" />
731       <include name="nbproject/project.xml" />
732       <include name="${sourceDir}/*.java" />
733       <include name="${sourceDir}/**/*.java" />
734       <include name="${sourceDir}/**/*.cdr" />
735       <include name="${libDir}/**/*" />
736       <include name="${resourceDir}/**/*" />
737       <include name="${helpDir}/**/*" />
738       <include name="appletlib/${jmolJar}" />
739       <include name="appletlib/${jsonSimple}" />
740       <include name="appletlib/${javaJson}" />
741       <exclude name="**/*locales" />
742       <exclude name="*locales/**" />
743       <exclude name="utils/InstallAnywhere/**Build.iap_xml" />
744       <exclude name="utils/InstallAnywhere/**Build*/**" />
745       <exclude name="utils/InstallAnywhere/**Build*/**" />
746       <exclude name="utils/InstallAnywhere/.build*.*/**" />
747       <exclude name="utils/InstallAnywhere/**locale*" />
748       <exclude name="utils/InstallAnywhere/**locale*/**" />
749       <exclude name="utils/InstallAnywhere/**locale*/**" />
750       <include name="${schemaDir}/**/*" />
751       <include name="utils/**/*" />
752       <include name="${docDir}/**/*" />
753       <include name="examples/**/*" />
754     </fileset>
755   </copy>
756
757   <tstamp prefix="build">
758     <format property="year" pattern="yyyy" />
759   </tstamp>
760   <!-- each replacetoken CDATA body must be on one line - 
761        otherwise the pattern doesn't match -->
762   <replace value="${JALVIEW_VERSION}">
763     <replacetoken><![CDATA[$$Version-Rel$$]]></replacetoken>
764     <fileset dir="_sourcedist">
765       <include name="**/*" />
766     </fileset>
767   </replace>
768   <replace dir="_sourcedist" value="${build.year}">
769     <replacetoken><![CDATA[$$Year-Rel$$]]></replacetoken>
770     <fileset dir="_sourcedist">
771       <include name="**/*" />
772     </fileset>
773   </replace>
774
775   <tar destfile="${source.dist.name}" compression="gzip">
776     <tarfileset dir="_sourcedist/" prefix="jalview" preserveLeadingSlashes="true">
777     </tarfileset>
778   </tar>
779
780   <delete dir="_sourcedist" />
781 </target>
782 <target name="prepubapplet_1" depends="makeApplet">
783   <copy todir="${packageDir}/examples">
784     <fileset dir="examples">
785       <include name="**/*" />
786       <include name="javascript/*" />
787       <include name="jmol/*" />
788     </fileset>
789     <fileset dir=".">
790       <include name="${jalviewLiteJar}" />
791     </fileset>
792     <fileset dir="appletlib">
793       <include name="**/*" />
794     </fileset>
795   </copy>
796   <jar update="true" index="true" jarfile="${packageDir}/examples/${jalviewLiteJar}" />
797   <jar update="true" index="true" jarfile="${packageDir}/examples/${javaJson}" />
798   <jar update="true" index="true" jarfile="${packageDir}/examples/${jsonSimple}" />
799   <jar update="true" index="true" jarfile="${packageDir}/examples/${jmolJar}">
800     <manifest>
801       <attribute name="Application-Name" value="Jmol (bundled with JalviewLite)" />
802       <!--          <attribute name="Permissions" value="sandbox" /> -->
803       <!--<attribute name="Trusted-Lib" value="true" /> -->
804       <attribute name="Codebase" value="${applet.codebase}" />
805       <attribute name="Caller-Allowable-Codebase" value="${applet.caller-codebase}" />
806     </manifest>
807   </jar>
808
809   <presetdef name="ap_applet.jar">
810     <!-- build a signed applet with 'all-permissions' - 
811                           Needs 'param name="permissions' value="all-permissions"' in applet tag
812                           JalviewLite+JmolApplet linked sequence/structure fails
813                           Mixed code warnings are raised
814                           -->
815     <jar update="true" index="true">
816       <manifest>
817         <attribute name="Application-Name" value="JalviewLite" />
818         <attribute name="Permissions" value="all-permissions" />
819         <attribute name="Codebase" value="${applet.codebase}" />
820         <attribute name="Caller-Allowable-Codebase" value="${applet.caller-codebase}" />
821         <attribute name="Application-Library-Allowable-Codebase" value="${applet.codebase}" />
822       </manifest>
823     </jar>
824   </presetdef>
825   <presetdef name="applet.jar">
826     <!-- build signed applet with sandbox permissions -
827                           Needs 'param name="permissions' value="sandbox"' in applet tag
828                          Preserves Pre-Java 1.7_u45 behavior once 'permissions' parameter added to applet tag 
829                         -->
830
831     <jar update="true" index="true">
832       <manifest>
833         <attribute name="Application-Name" value="JalviewLite" />
834         <attribute name="Permissions" value="sandbox" />
835         <attribute name="Codebase" value="${applet.codebase}" />
836         <attribute name="Caller-Allowable-Codebase" value="${applet.caller-codebase}" />
837         <attribute name="Application-Library-Allowable-Codebase" value="${applet.codebase}" />
838       </manifest>
839     </jar>
840   </presetdef>
841   <presetdef name="tl_applet.jar">
842     <!-- build signed applet with trusted library/trusted permissions -
843                                 Needs 'param name="permissions' value="all-permissions"' in applet tag
844                                j1.7_45:
845                                No mixed code warnings raised 
846                                Jmol/JalviewLite sequence/structure example doesn't link structures
847                                Raises dialog asking user to allow page to control applet via LiveConnect javascript
848                                
849                               -->
850
851     <jar update="true" index="true">
852       <manifest>
853         <attribute name="Application-Name" value="JalviewLite" />
854         <attribute name="Permissions" value="all-permissions" />
855         <attribute name="Codebase" value="${applet.codebase}" />
856         <attribute name="Trusted-Only" value="true" />
857         <attribute name="Trusted-Library" value="true" />
858       </manifest>
859     </jar>
860   </presetdef>
861   <presetdef name="to_applet.jar">
862     <!-- not fully test variant (yet) -->
863     <jar update="true" index="true">
864       <manifest>
865         <attribute name="Application-Name" value="JalviewLite" />
866         <attribute name="Permissions" value="all-permissions" />
867         <attribute name="Codebase" value="${applet.codebase}" />
868         <attribute name="Trusted-Only" value="true" />
869       </manifest>
870     </jar>
871   </presetdef>
872   <!-- create differently privileged artefacts -->
873   <copy file="${packageDir}/examples/${jalviewLiteJar}" tofile="${packageDir}/examples/u_${jalviewLiteJar}" />
874   <copy file="${packageDir}/examples/${jmolJar}" tofile="${packageDir}/examples/u_${jmolJar}" overwrite="true" />
875   <copy file="${packageDir}/examples/${javaJson}" tofile="${packageDir}/examples/u_${javaJson}" overwrite="true" />
876   <copy file="${packageDir}/examples/${jsonSimple}" tofile="${packageDir}/examples/u_${jsonSimple}" overwrite="true" />
877   <copy file="${packageDir}/examples/${jalviewLiteJar}" tofile="${packageDir}/examples/ap_${jalviewLiteJar}" />
878   <copy file="${packageDir}/examples/${jmolJar}" tofile="${packageDir}/examples/ap_${jmolJar}" />
879   <copy file="${packageDir}/examples/${javaJson}" tofile="${packageDir}/examples/ap_${javaJson}" />
880   <copy file="${packageDir}/examples/${jsonSimple}" tofile="${packageDir}/examples/ap_${jsonSimple}" />
881   <ap_applet.jar jarfile="${packageDir}/examples/ap_${jalviewLiteJar}" />
882   <ap_applet.jar jarfile="${packageDir}/examples/ap_${jmolJar}" />
883   <ap_applet.jar jarfile="${packageDir}/examples/ap_${javaJson}" />
884   <ap_applet.jar jarfile="${packageDir}/examples/ap_${jsonSimple}" />
885   <copy file="${packageDir}/examples/${jalviewLiteJar}" tofile="${packageDir}/examples/tl_${jalviewLiteJar}" />
886   <copy file="${packageDir}/examples/${jmolJar}" tofile="${packageDir}/examples/tl_${jmolJar}" />
887   <copy file="${packageDir}/examples/${javaJson}" tofile="${packageDir}/examples/tl_${javaJson}" />
888   <copy file="${packageDir}/examples/${jsonSimple}" tofile="${packageDir}/examples/tl_${jsonSimple}" />
889   <tl_applet.jar jarfile="${packageDir}/examples/tl_${jalviewLiteJar}" />
890   <tl_applet.jar jarfile="${packageDir}/examples/tl_${jmolJar}" />
891   <tl_applet.jar jarfile="${packageDir}/examples/tl_${javaJson}" />
892   <tl_applet.jar jarfile="${packageDir}/examples/tl_${jsonSimple}" />
893   <copy file="${packageDir}/examples/${jalviewLiteJar}" tofile="${packageDir}/examples/to_${jalviewLiteJar}" />
894   <copy file="${packageDir}/examples/${jmolJar}" tofile="${packageDir}/examples/to_${jmolJar}" />
895   <copy file="${packageDir}/examples/${javaJson}" tofile="${packageDir}/examples/to_${javaJson}" />
896   <copy file="${packageDir}/examples/${jsonSimple}" tofile="${packageDir}/examples/to_${jsonSimple}" />
897   <to_applet.jar jarfile="${packageDir}/examples/to_${jalviewLiteJar}" />
898   <to_applet.jar jarfile="${packageDir}/examples/to_${jmolJar}" />
899   <to_applet.jar jarfile="${packageDir}/examples/to_${javaJson}" />
900   <to_applet.jar jarfile="${packageDir}/examples/to_${jsonSimple}" />
901   <!-- finally, create manifest for original jars -->
902   <applet.jar jarfile="${packageDir}/examples/${jalviewLiteJar}" />
903   <applet.jar jarfile="${packageDir}/examples/${jmolJar}" />
904   <applet.jar jarfile="${packageDir}/examples/${javaJson}" />
905   <applet.jar jarfile="${packageDir}/examples/${jsonSimple}" />
906
907   <!-- todo - write examples/downloads for alternate versions of the applet 
908     probably don't need to do this now since we don't have alternate versions anymore !-->
909 </target>
910 <target name="-signapplet" depends="prepubapplet_1">
911   <fileset id="signappletjarset" dir="${packageDir}/examples">
912     <exclude name="u_*.jar" />
913     <include name="${jalviewLiteJar}" />
914     <include name="${jmolJar}" />
915     <include name="${javaJson}" />
916     <include name="${jsonSimple}" />
917     <include name="to_${jalviewLiteJar}" />
918     <include name="to_${jmolJar}" />
919     <include name="to_${javaJson}" />
920     <include name="to_${jsonSimple}" />
921     <include name="tl_${jalviewLiteJar}" />
922     <include name="tl_${jmolJar}" />
923     <include name="tl_${javaJson}" />
924     <include name="tl_${jsonSimple}" />
925     <include name="ap_${jalviewLiteJar}" />
926     <include name="ap_${jmolJar}" />
927     <include name="ap_${javaJson}" />
928     <include name="ap_${jsonSimple}" />
929   </fileset>
930 </target>
931 <target name="-signappletnotsa" unless="timestamp" depends="-signapplet">
932   <signjar storepass="${jalview.keystore.pass}" keypass="${jalview.key.pass}" keystore="${jalview.keystore}" alias="${jalview.key}" lazy="false" verbose="false">
933     <fileset refid="signappletjarset" />
934   </signjar>
935 </target>
936
937 <target name="-signapplettsa" if="timestamp" depends="-signapplet">
938   <signjar storepass="${jalview.keystore.pass}" keypass="${jalview.key.pass}" keystore="${jalview.keystore}" alias="${jalview.key}" lazy="false" verbose="false" tsaproxyhost="${proxyHost}" tsaproxyport="${proxyPort}" tsaurl="${jalview.tsaurl}">
939     <fileset refid="signappletjarset" />
940   </signjar>
941 </target>
942
943 <target name="signApplet" description="internal target to sign applet" depends="-signappletnotsa,-signapplettsa" />
944
945 <target name="pubapplet" description="installs the jalviewLite applet and dependent jars into an applet examples directory built under ${outputDir}" depends="makeApplet, signApplet">
946
947   <!-- bizarre bug causes JmolApplet to always get signed, even if excluded from above. so copy explicitly -->
948   <copy file="appletlib/${jmolJar}" tofile="${packageDir}/examples/u_${jmolJar}" overwrite="true" />
949   <copy file="appletlib/${jsonSimple}" tofile="${packageDir}/examples/u_${jsonSimple}" overwrite="true" />
950   <copy file="appletlib/${javaJson}" tofile="${packageDir}/examples/u_${javaJson}" overwrite="true" />
951   <!-- finally, replace any launchApp servlet tags with a version specification -->
952   <replace value="http://www.jalview.org/services/launchApp?version=${JALVIEW_VERSION}&quot;">
953     <replacetoken>
954       <![CDATA[http://www.jalview.org/services/launchApp"]]>
955     </replacetoken>
956     <fileset dir="${packageDir}/examples">
957       <include name="**/*.html" />
958     </fileset>
959   </replace>
960   <replace value="http://www.jalview.org/services/launchApp?version=${JALVIEW_VERSION}'">
961     <replacetoken>
962       <![CDATA[http://www.jalview.org/services/launchApp']]>
963     </replacetoken>
964     <fileset dir="${packageDir}/examples">
965       <include name="**/*.html" />
966     </fileset>
967   </replace>
968
969 </target>
970 <target name="sourcedoc" description="Create jalview source documentation pages" depends="init">
971   <javadoc destdir="${javadocDir}">
972     <packageset dir="${sourceDir}" includes="jalview/*,MCView/*">
973     </packageset>
974   </javadoc>
975 </target>
976 <target name="linkcheck" depends="init,prepare">
977   <javac srcdir="utils" destdir="utils" includes="HelpLinksChecker.java"/>
978   <java fork="true" dir="${helpDir}" classpath="utils" classname="HelpLinksChecker" failonerror="true">
979     <arg file="${helpDir}"/>
980     <arg value="-nointernet"/>
981   </java>
982 </target>
983 </project>