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="./bin/${app.name}"/>
  61
  62   <!-- don't use unless your Jikes is >= v1.18 -->
  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     <pathelement path="etc/extrasource"/>
  85     <fileset dir="lib">
  86       <include name="*.jar"/>
  87     </fileset>
  88     <fileset dir="lib/hibernate">
  89       <include name="*.jar"/>
  90     </fileset>
  91     <pathelement path="${tomcat.home}/lib/tomcat.jar"/>
  92   <!-- for libs shared between tomcat and webapps (tomcat 3.3.x) -->
  93         <fileset dir="${tomcat.home}">
  94                 <include name="lib/common/*.jar" />
  95         </fileset>
  96   <!-- for libs shared between webapps (tomcat 3.3.x) -->
  97         <fileset dir="${tomcat.home}">
  98                 <include name="lib/apps/*.jar" />
  99         </fileset>
 100   <!-- for libs shared between tomcat and webapps (tomcat 4.x.x) -->
 101         <fileset dir="${tomcat.home}">
 102                 <include name="common/lib/*.jar" />
 103         </fileset>
 104   <!-- for libs shared between webapps (tomcat 4.0.x) -->
 105         <fileset dir="${tomcat.home}">
 106                 <include name="lib/*.jar" />
 107         </fileset>
 108   <!-- for libs shared between webapps (tomcat 4.1.x) -->
 109         <fileset dir="${tomcat.home}">
 110                 <include name="shared/lib/*.jar" />
 111         </fileset>
 112         <fileset dir="${tomcat.home}">
 113                 <include name="common/endorsed/*.jar" />
 114         </fileset>
 115   </path>
 116
 117
 118
 119 <!-- The "prepare" target is used to construct the deployment home
 120      directory structure (if necessary), and to copy in static files
 121      as required.  In the example below, Ant is instructed to create
 122      the deployment directory, copy the contents of the "web/" source
 123      hierarchy, and set up the WEB-INF subdirectory appropriately.
 124 -->
 125
 126   <target name="prepare">
 127     <mkdir  dir="${deploy.home}"/>
 128     <mkdir  dir="${deploy.webinf}"/>
 129     <mkdir  dir="${deploy.classes}"/>
 130     <mkdir  dir="${deploy.webinf}/log"/>
 131
 132     <copy todir="${deploy.home}">
 133       <fileset dir="web"/>
 134     </copy>
 135
 136     <copy todir="${deploy.webinf}/etc">
 137       <fileset dir="etc" excludes="bundles/** hibernate.cfg.xml web.xml"/>
 138     </copy>
 139     <copy todir="${deploy.classes}/bundles">
 140         <fileset dir="etc/bundles"/>
 141     </copy>
 142     <copy todir="${deploy.webinf}" file="etc/web.xml"/>
 143
 144     <copy todir="${deploy.webinf}/templates">
 145       <fileset dir="templates"/>
 146     </copy>
 147
 148     <copy todir="${deploy.webinf}" file="source/default.properties" />
 149
 150     <copy todir="${deploy.classes}/bundles">
 151       <fileset dir="bundles"/>
 152     </copy>
 153
 154     <copy todir="${deploy.classes}" file="etc/hibernate.cfg.xml"/>
 155
 156     <copy todir="${deploy.home}/WEB-INF/lib">
 157       <fileset dir="lib">
 158         <exclude name="ant.jar"/>
 159         <exclude name="xerces.jar"/>
 160       </fileset>
 161       <fileset dir="lib/hibernate">
 162       </fileset>
 163     </copy>
 164   </target>
 165
 166
 167
 168 <!-- The "clean" target removes the deployment home directory structure,
 169      so that the next time the "compile" target is requested, it will need
 170      to compile everything from scratch.
 171 -->
 172
 173
 174   <target name="clean">
 175     <delete dir="${deploy.classes}"/>
 176     <mkdir dir="${deploy.classes}"/>
 177   </target>
 178
 179
 180
 181 <!-- The "mrproper" target removes the entire deploy dir - including all
 182         built pages and images.
 183 -->
 184
 185   <target name="mrproper">
 186     <delete dir="${deploy.home}"/>
 187   </target>
 188
 189   <!-- drop out if $TOMCAT_HOME is not set>-->
 190   <target name="testtomcat" unless="tomcat.present">
 191     <fail message="the $$TOMCAT_HOME environment variable is not set or is set to the wrong path. Please set it first. giving up!"/>
 192   </target>
 193
 194 <!-- The "compile" target is used to compile (or recompile) the Java classes
 195      that make up this web application.  The recommended source code directory
 196      structure makes this very easy because the <javac> task automatically
 197      works its way down a source code hierarchy and compiles any class that
 198      has not yet been compiled, or where the source file is newer than the
 199      class file.
 200
 201      Feel free to adjust the compilation option parameters (debug,
 202      optimize, and deprecation) to suit your requirements.  It is also
 203      possible to base them on properties, so that you can adjust this
 204      behavior at runtime.
 205
 206      The "compile" task depends on the "prepare" task, so the deployment
 207      home directory structure will be created if needed the first time.
 208 -->
 209
 210   <target name="compile" depends="prepare">
 211     <!-- check to see if $TOMCAT_HOME was set to something useful.. -->
 212     <available file="${tomcat.home}/conf" property="tomcat.present"/>
 213     <antcall target="testtomcat"/>
 214
 215     <!--<antcall target="clean"/>-->
 216     <dependset>
 217       <srcfileset
 218         dir="source"
 219         includes="**/*.java"/>
 220 <!-- ML: now why can't this be added?
 221       <srcfileset
 222         dir="etc/extrasource"
 223         includes="**/*.java"/> -->
 224       <srcfileset
 225         dir="lib"
 226         includes="*.jar"/>
 227       <targetfileset
 228         dir="${deploy.classes}"
 229         includes="**/*.class"/>
 230     </dependset>
 231     <javac destdir="${deploy.classes}"
 232            debug="on" optimize="off" deprecation="on">
 233       <src path="source"/>
 234       <src path="etc/extrasource"/>
 235       <classpath refid="project.class.path"/>
 236     </javac>
 237   </target>
 238
 239
 240
 241   <target name="perms">
 242     <exec executable="./perms.sh"/>
 243   </target>
 244
 245
 246 <!-- The "javadoc" target is used to create the Javadoc API documentation
 247      for the Java classes in this web application.  It is assumed that
 248      this documentation is included in the deployed application, so the
 249      example below generates the Javadoc HTML files in a subdirectory under
 250      the deployment home directory.  Feel free to customize the options for
 251      the JavaDoc task, after consulting the Ant documentation.
 252 -->
 253
 254   <target name="javadoc" depends="prepare">
 255     <javadoc packagenames="mir.*, mircoders.*"
 256              sourcefiles="source/${app.name}.java,source/Open${app.name}.java"
 257              sourcepath="source"
 258              destdir="${javadoc.home}">
 259           <classpath refid="project.class.path"/>
 260         </javadoc>
 261   </target>
 262
 263
 264 <!-- The "all" target rebuilds everything by executing the "clean"
 265      target first, which forces the "compile" target to compile all
 266      source code instead of just the files that have been changed.
 267 -->
 268
 269   <target name="all" depends="clean,prepare,compile,javadoc"/>
 270
 271
 272 <!-- The "dist" target builds the distribution Web ARchive (WAR) file
 273      for this application, suitable for distribution to sites that wish
 274      to install your application.  It also creates a JAR file containing
 275      the source code for this application, if you wish to distribute
 276      that separately.
 277 -->
 278   <target name="dist" depends="prepare,compile">
 279     <jar jarfile="${dist.home}/mirbase.jar"
 280          includes="mir/**"
 281          basedir="${deploy.classes}"/>
 282     <jar jarfile="${dist.home}/${dist.src}"
 283          basedir="./source"/>
 284     <jar jarfile="${dist.home}/${dist.war}"
 285          basedir="${deploy.home}"
 286          excludes="${dist.war}"/>
 287   </target>
 288
 289   <target name="rundbtest" depends="compile">
 290         <java classname="mir.core.test.Test" classpathref="project.class.path"/>
 291   </target>
 292
 293 </project>