build.xml

   1 <project name="Mir" default="compile" basedir=".">
   2
   3
   4 <!-- What this file is all about
   5
   6      You can use this version of build.xml to use directly with ant
   7      i.e. without the build.sh script. Simply call ant and let it all
   8      happen.
   9 -->
  10
  11 <!-- Property Definitions
  12
  13      Please not that only the first couple of properties have to be defined.
  14      The rest, residing below the "no customization needed" line may be
  15      customized if you know what you are doing. Else, leave the defaults
  16      and use them to look up where ant places all the files.
  17
  18      app.name          Base name of this application, used to
  19                        construct filenames and directories.
  20
  21      deploy.home       The name of the directory into which the
  22                        deployment hierarchy will be created.
  23                        Normally, this will be the name of a
  24                        subdirectory under $TOMCAT_HOME/webapps.
  25
  26      deploy.classes    The name of the directory that will contain
  27                        the class files.
  28
  29      dist.home         The name of the base directory in which
  30                        distribution files are created.
  31
  32      dist.src          The name of the distribution JAR file
  33                        containing the application source code,
  34                        to be stored in the "dist.home" directory.
  35                        This filename should end with ".jar".
  36
  37      dist.war          The name of the Web ARchive (WAR) file
  38                        containing our deployable application.
  39                        This filename should end with ".war".
  40
  41      javadoc.home      The name of the base directory in which
  42                        the JavaDoc documentation for this application
  43                        is generated.
  44
  45      tomcat.home       The name of the base directory in which
  46                        Tomcat has been installed.  This value is
  47                        normally set automatically from the value
  48                        of the TOMCAT_HOME environment variable.
  49
  50         java.home          The location of your Java SDK.
  51
  52         java.localhome     Where your local java classes and jar files
  53                        are located.
  54
  55         tomcat.home        The location of the tomcat root directory.
  56
  57 -->
  58
  59   <property name="app.name"       value="Mir"/>
  60   <property name="deploy.home"    value="../${app.name}"/>
  61
  62   <!-- don't use unless your Jikes is >= v1.17 and you know what you are doing -->
  63   <!-- <property name="build.compiler"   value="jikes"/>-->
  64
  65
  66 <!-- No customization required after this line -->
  67
  68   <property environment="env"/>
  69   <property name="dist.home"      value="${deploy.home}"/>
  70   <property name="deploy.webinf"  value="${deploy.home}/WEB-INF"/>
  71   <property name="deploy.classes" value="${deploy.webinf}/classes"/>
  72   <property name="dist.src"       value="${app.name}.jar"/>
  73   <property name="dist.war"       value="${app.name}.war"/>
  74   <property name="javadoc.home"   value="${deploy.home}/javadoc"/>
  75   <property name="tomcat.home"    value="${env.TOMCAT_HOME}"/>
  76
  77
  78
  79   <!-- Construct the classpath -->
  80   <path id="project.class.path">
  81     <pathelement path="${deploy.home}"/>
  82     <pathelement path="${deploy.classes}"/>
  83     <pathelement path="source"/>
  84     <fileset dir="lib">
  85       <include name="*.jar"/>
  86     </fileset>
  87     <pathelement path="${tomcat.home}/lib/tomcat.jar"/>
  88   <!-- for libs shared between tomcat and webapps (tomcat 3.3.x) -->
  89         <fileset dir="${tomcat.home}">
  90                 <include name="lib/common/*.jar" />
  91         </fileset>
  92   <!-- for libs shared between webapps (tomcat 3.3.x) -->
  93         <fileset dir="${tomcat.home}">
  94                 <include name="lib/apps/*.jar" />
  95         </fileset>
  96   <!-- for libs shared between tomcat and webapps (tomcat 4.0.x) -->
  97         <fileset dir="${tomcat.home}">
  98                 <include name="common/lib/*.jar" />
  99         </fileset>
 100   <!-- for libs shared between webapps (tomcat 4.0.x) -->
 101         <fileset dir="${tomcat.home}">
 102                 <include name="lib/*.jar" />
 103         </fileset>
 104   </path>
 105
 106
 107
 108 <!-- The "prepare" target is used to construct the deployment home
 109      directory structure (if necessary), and to copy in static files
 110      as required.  In the example below, Ant is instructed to create
 111      the deployment directory, copy the contents of the "web/" source
 112      hierarchy, and set up the WEB-INF subdirectory appropriately.
 113 -->
 114
 115   <target name="prepare">
 116     <mkdir  dir="${deploy.home}"/>
 117     <mkdir  dir="${deploy.webinf}"/>
 118     <mkdir  dir="${deploy.classes}"/>
 119     <mkdir  dir="${deploy.webinf}/log"/>
 120
 121     <copy todir="${deploy.home}">
 122       <fileset dir="web"/>
 123     </copy>
 124
 125     <copy todir="${deploy.webinf}/etc">
 126       <fileset dir="etc" excludes="bundles/** web.xml"/>
 127     </copy>
 128     <copy todir="${deploy.classes}/bundles">
 129         <fileset dir="etc/bundles"/>
 130     </copy>
 131     <copy todir="${deploy.webinf}" file="etc/web.xml"/>
 132
 133     <copy todir="${deploy.webinf}/templates">
 134       <fileset dir="templates"/>
 135     </copy>
 136
 137     <copy todir="${deploy.classes}/bundles">
 138       <fileset dir="bundles"/>
 139     </copy>
 140
 141     <copy todir="${deploy.home}/WEB-INF/lib">
 142       <fileset dir="lib">
 143         <exclude name="ant.jar"/>
 144         <exclude name="xerces.jar"/>
 145         <exclude name="servlet-2.2.jar"/>
 146       </fileset>
 147     </copy>
 148   </target>
 149
 150
 151
 152 <!-- The "clean" target removes the deployment home directory structure,
 153      so that the next time the "compile" target is requested, it will need
 154      to compile everything from scratch.
 155 -->
 156
 157
 158   <target name="clean">
 159     <delete dir="${deploy.classes}"/>
 160     <mkdir dir="${deploy.classes}"/>
 161   </target>
 162
 163
 164
 165 <!-- The "mrproper" target removes the entire deploy dir - including all
 166         built pages and images.
 167 -->
 168
 169   <target name="mrproper">
 170     <delete dir="${deploy.home}"/>
 171   </target>
 172
 173   <!-- drop out if $TOMCAT_HOME is not set>-->
 174   <target name="testtomcat" unless="tomcat.present">
 175     <fail message="the $$TOMCAT_HOME environment variable is not set or is set to the wrong path. Please set it first. giving up!"/>
 176   </target>
 177
 178 <!-- The "compile" target is used to compile (or recompile) the Java classes
 179      that make up this web application.  The recommended source code directory
 180      structure makes this very easy because the <javac> task automatically
 181      works its way down a source code hierarchy and compiles any class that
 182      has not yet been compiled, or where the source file is newer than the
 183      class file.
 184
 185      Feel free to adjust the compilation option parameters (debug,
 186      optimize, and deprecation) to suit your requirements.  It is also
 187      possible to base them on properties, so that you can adjust this
 188      behavior at runtime.
 189
 190      The "compile" task depends on the "prepare" task, so the deployment
 191      home directory structure will be created if needed the first time.
 192 -->
 193
 194   <target name="compile" depends="prepare">
 195     <!-- check to see if $TOMCAT_HOME was set to something useful.. -->
 196     <available file="${tomcat.home}/conf" property="tomcat.present"/>
 197     <antcall target="testtomcat"/>
 198
 199     <!--<antcall target="clean"/>-->
 200     <dependset>
 201       <srcfileset
 202         dir="source"
 203         includes="**/*.java"/>
 204       <srcfileset
 205         dir="lib"
 206         includes="*.jar"/>
 207       <targetfileset
 208         dir="${deploy.classes}"
 209         includes="**/*.class"/>
 210     </dependset>
 211     <javac srcdir="source" destdir="${deploy.classes}"
 212            debug="on" optimize="off" deprecation="on">
 213       <classpath refid="project.class.path"/>
 214     </javac>
 215   </target>
 216
 217
 218
 219   <target name="perms">
 220     <exec executable="./perms.sh"/>
 221   </target>
 222
 223
 224 <!-- The "javadoc" target is used to create the Javadoc API documentation
 225      for the Java classes in this web application.  It is assumed that
 226      this documentation is included in the deployed application, so the
 227      example below generates the Javadoc HTML files in a subdirectory under
 228      the deployment home directory.  Feel free to customize the options for
 229      the JavaDoc task, after consulting the Ant documentation.
 230 -->
 231
 232   <target name="javadoc" depends="prepare">
 233     <javadoc packagenames="mir.*, mircoders.*"
 234              sourcefiles="source/${app.name}.java,source/Open${app.name}.java"
 235              sourcepath="source"
 236              destdir="${javadoc.home}">
 237           <classpath refid="project.class.path"/>
 238         </javadoc>
 239   </target>
 240
 241
 242 <!-- The "all" target rebuilds everything by executing the "clean"
 243      target first, which forces the "compile" target to compile all
 244      source code instead of just the files that have been changed.
 245 -->
 246
 247   <target name="all" depends="clean,prepare,compile,javadoc"/>
 248
 249
 250 <!-- The "dist" target builds the distribution Web ARchive (WAR) file
 251      for this application, suitable for distribution to sites that wish
 252      to install your application.  It also creates a JAR file containing
 253      the source code for this application, if you wish to distribute
 254      that separately.
 255 -->
 256   <target name="dist" depends="prepare,compile">
 257     <jar jarfile="${dist.home}/mirbase.jar"
 258          includes="mir/**"
 259          basedir="${deploy.classes}"/>
 260     <jar jarfile="${dist.home}/${dist.src}"
 261          basedir="./source"/>
 262     <jar jarfile="${dist.home}/${dist.war}"
 263          basedir="${deploy.home}"
 264          excludes="${dist.war}"/>
 265   </target>
 266
 267 </project>