build-common-plugin.xml

<?xml version="1.0"?>
<!DOCTYPE project>

<project name="build-common-plugin" xmlns:antelope="antlib:ise.antelope.tasks">
	<import file="build-common.xml" />

	<property name="plugins.includes.path" value="${basedir}" />

	<set-module-properties
		module.dir="${basedir}"
	/>

	<macrodef name="build-service">
		<attribute name="service.api.dir" />
		<attribute name="service.auto.namespace.tables" default="true" />
		<attribute name="service.hbm.file.name" default="portlet-hbm.xml" />
		<attribute name="service.model.hints.file.name" default="portlet-model-hints.xml" />
		<attribute name="service.props.util" default="com.liferay.util.service.ServiceProps" />
		<attribute name="service.spring.file.name" default="portlet-spring.xml" />
		<attribute name="service.sql.dir" />
		<attribute name="service.test.dir" />

		<sequential>
			<if>
				<available file="docroot" />
				<then>
					<var name="service.base.dir" value="docroot/WEB-INF" />
				</then>
				<else>
					<var name="service.base.dir" value="." />
				</else>
			</if>

			<if>
				<available file="bnd.bnd" />
				<then>
					<var name="service.osgi.module" value="true" />
					<var name="service.plugin.name" value="" />
					<var name="service.spring.namespaces" value="beans,osgi" />
				</then>
				<else>
					<var name="service.osgi.module" value="false" />
					<var name="service.plugin.name" value="${plugin.name}" />
					<var name="service.spring.namespaces" value="beans" />
				</else>
			</if>

			<mkdir dir="@{service.api.dir}" />
			<mkdir dir="@{service.sql.dir}" />

			<mkdir dir="${service.base.dir}/classes" />
			<mkdir dir="${service.base.dir}/lib" />
			<mkdir dir="${service.base.dir}/src" />

			<copy todir="${service.base.dir}/classes">
				<fileset dir="${service.base.dir}/src" excludes="**/*.java" />
			</copy>

			<path id="service.classpath">
				<path refid="lib.classpath" />
				<path refid="portal.classpath" />
				<fileset dir="${app.server.lib.portal.dir}" includes="commons-digester.jar,commons-lang.jar,easyconf.jar" />
				<fileset dir="${service.base.dir}/lib" includes="*.jar" />
				<pathelement location="${sdk.dir}/misc" />
				<pathelement location="${service.base.dir}/classes" />
			</path>

			<if>
				<os family="windows" />
				<then>
					<classpath-to-jar
						classpathref="service.classpath"
						jarfile="build-service-classpath.jar"
					/>
				</then>
			</if>

			<if>
				<not>
					<isset property="service.input.file" />
				</not>
				<then>
					<property name="service.input.file" value="${basedir}/${service.base.dir}/service.xml" />
				</then>
			</if>

			<java
				classname="com.liferay.portal.tools.servicebuilder.ServiceBuilder"
				classpathref="service.classpath"
				fork="true"
				newenvironment="true"
				outputproperty="build-service.output"
			>
				<jvmarg value="-Xms512m" />
				<jvmarg value="-Xmx1024m" />
				<jvmarg value="-Xss2048k" />
				<jvmarg value="-XX:MaxPermSize=512m" />
				<arg value="-Dexternal-properties=com/liferay/portal/tools/dependencies/portal-tools.properties" />
				<arg value="-Dorg.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger" />
				<arg value="service.api.dir=@{service.api.dir}" />
				<arg value="service.auto.namespace.tables=@{service.auto.namespace.tables}" />
				<arg value="service.bean.locator.util=com.liferay.util.bean.PortletBeanLocatorUtil" />
				<arg value="service.build.number=1" />
				<arg value="service.build.number.increment=true" />
				<arg value="service.hbm.file=${basedir}/${service.base.dir}/src/META-INF/@{service.hbm.file.name}" />
				<arg value="service.impl.dir=${basedir}/${service.base.dir}/src" />
				<arg value="service.input.file=${service.input.file}" />
				<arg value="service.model.hints.file=${basedir}/${service.base.dir}/src/META-INF/@{service.model.hints.file.name}" />
				<arg value="service.osgi.module=${service.osgi.module}" />
				<arg value="service.plugin.name=${service.plugin.name}" />
				<arg value="service.props.util=@{service.props.util}" />
				<arg value="service.remoting.file=" />
				<arg value="service.resources.dir=${basedir}/${service.base.dir}/src" />
				<arg value="service.spring.file=${basedir}/${service.base.dir}/src/META-INF/@{service.spring.file.name}" />
				<arg value="service.spring.namespaces=${service.spring.namespaces}" />
				<arg value="service.sql.dir=@{service.sql.dir}" />
				<arg value="service.sql.file=tables.sql" />
				<arg value="service.sql.indexes.file=indexes.sql" />
				<arg value="service.sql.sequences.file=sequences.sql" />
				<arg value="service.target.entity.name=${service.target.entity.name}" />
				<arg value="service.test.dir=@{service.test.dir}" />
			</java>

			<if>
				<os family="windows" />
				<then>
					<delete file="build-service-classpath.jar" />
				</then>
			</if>

			<delete file="ServiceBuilder.temp" />

			<echo>${build-service.output}</echo>

			<if>
				<contains string="${build-service.output}" substring="Error" />
				<then>
					<fail>Service Builder generated exceptions.</fail>
				</then>
			</if>
		</sequential>
	</macrodef>

	<macrodef name="classpath-to-jar">
		<attribute name="classpathref" />
		<attribute name="jarfile" />

		<sequential>

			<!--
			Windows chokes if the classpath is longer than 32 kb. But the
			workaround only works for Ant 1.8 and above. See LPS-29085.
			-->

			<if>
				<and>
					<not>
						<contains string="${ant.version}" substring="1.6" />
					</not>
					<not>
						<contains string="${ant.version}" substring="1.7" />
					</not>
				</and>
				<then>
					<manifestclasspath
						jarfile="@{jarfile}"
						maxParentLevels="99"
						property="manifest.classpath"
					>
						<classpath refid="@{classpathref}" />
					</manifestclasspath>

					<manifest file="@{jarfile}.manifest">
						<attribute name="Class-Path" value="${manifest.classpath}" />
					</manifest>

					<jar
						destfile="@{jarfile}"
						manifest="@{jarfile}.manifest"
					/>

					<delete file="@{jarfile}.manifest" />

					<var name="manifest.classpath" unset="true" />

					<path id="@{classpathref}">
						<fileset file="@{jarfile}" />
					</path>
				</then>
			</if>
		</sequential>
	</macrodef>

	<target name="all">
		<antcall target="clean" />
		<antcall target="deploy" />
	</target>

	<target name="build-client">
		<property name="client.url" value="http://localhost:8080/${plugin.name}/api/axis" />

		<echo message="Make sure the server is listening on ${client.url}." />
		<echo message="" />

		<mkdir dir="docroot/WEB-INF/client/src" />

		<java
			classname="com.liferay.portal.tools.PortalClientBuilder"
			classpathref="portal.classpath"
			failonerror="true"
			fork="true"
			newenvironment="true"
		>
			<jvmarg value="-Dexternal-properties=com/liferay/portal/tools/dependencies/portal-tools.properties" />
			<arg value="docroot/WEB-INF/server-config.wsdd" />
			<arg value="docroot/WEB-INF/client/src" />
			<arg value="docroot/WEB-INF/client/namespace-mapping.properties" />
			<arg value="${client.url}" />
		</java>

		<mkdir dir="docroot/WEB-INF/client/classes" />

		<compile-java
			javac.classpathref="portal.classpath"
			javac.destdir="docroot/WEB-INF/client/classes"
			javac.srcdir="docroot/WEB-INF/client/src"
		/>

		<zip destfile="docroot/WEB-INF/client/${plugin.name}-client.jar">
			<fileset dir="docroot/WEB-INF/client/classes" />
			<fileset dir="docroot/WEB-INF/client/src" />
		</zip>

		<delete dir="docroot/WEB-INF/client/classes" />
		<delete dir="docroot/WEB-INF/client/src" />
	</target>

	<target name="build-db">
		<java
			classname="com.liferay.portal.tools.DBBuilder"
			classpathref="portal.classpath"
			fork="true"
			maxmemory="384m"
			newenvironment="true"
		>
			<arg value="-Dexternal-properties=com/liferay/portal/tools/dependencies/portal-tools.properties" />
			<arg value="db.database.name=${database.name}" />
			<arg value="db.database.types=${database.types}" />
			<arg value="db.sql.dir=docroot/WEB-INF/sql" />
		</java>

		<delete file="velocity.log" quiet="true" />
	</target>

	<target name="build-lang">
		<if>
			<available file="docroot/WEB-INF/src/content" />
			<then>
				<antcall target="build-lang-cmd">
					<param name="lang.dir" value="docroot/WEB-INF/src/content" />
					<param name="lang.file" value="Language" />
					<param name="lang.translate" value="true" />
				</antcall>
			</then>
		</if>

		<if>
			<available file="src/content" />
			<then>
				<antcall target="build-lang-cmd">
					<param name="lang.dir" value="src/content" />
					<param name="lang.file" value="Language" />
					<param name="lang.translate" value="true" />
				</antcall>
			</then>
		</if>
	</target>

	<target name="build-lang-cmd">
		<java
			classname="com.liferay.portal.tools.LangBuilder"
			classpathref="portal.classpath"
			fork="true"
			newenvironment="true"
		>
			<jvmarg value="-Dexternal-properties=com/liferay/portal/tools/dependencies/portal-tools.properties" />
			<jvmarg value="-Dfile.encoding=UTF-8" />
			<jvmarg value="-Duser.country=US" />
			<jvmarg value="-Duser.language=en" />
			<arg value="lang.dir=${lang.dir}" />
			<arg value="lang.file=${lang.file}" />
			<arg value="lang.plugin=true" />
			<arg value="lang.translate=${lang.translate}" />
		</java>

		<copy file="${lang.dir}/${lang.file}.properties" tofile="${lang.dir}/${lang.file}_en.properties" />
	</target>

	<target name="build-service">
		<if>
			<available file="docroot" />
			<then>
				<var name="service.base.dir" value="docroot/WEB-INF" />
			</then>
			<else>
				<var name="service.base.dir" value="." />
			</else>
		</if>

		<build-service
			service.api.dir="${basedir}/${service.base.dir}/service"
			service.sql.dir="${basedir}/${service.base.dir}/sql"
			service.test.dir=""
		/>

		<mkdir dir="${service.base.dir}/service-classes" />

		<path id="service.classpath">
			<path refid="lib.classpath" />
			<fileset dir="${app.server.lib.global.dir}" includes="*.jar" />
			<fileset dir="${sdk.dir}/dependencies/aQute.bnd/lib" includes="*.jar" />
			<fileset dir="${service.base.dir}/lib" excludes="${plugin.name}-service.jar" includes="*.jar" />
		</path>

		<compile-java
			javac.classpathref="service.classpath"
			javac.destdir="${service.base.dir}/service-classes"
			javac.srcdir="${service.base.dir}/service"
		/>

		<jar
			basedir="${service.base.dir}/service-classes"
			destfile="${service.base.dir}/lib/${plugin.name}-service.jar"
		/>

		<delete dir="${service.base.dir}/service-classes" />
	</target>

	<target name="build-wsdd">
		<loop-macrodef-or-target
			module.dirs="${basedir}"
			target.name="compile"
		/>

		<path id="wsdd.classpath">
			<path refid="lib.classpath" />
			<path refid="portal.classpath" />
			<fileset dir="docroot/WEB-INF/lib" includes="*.jar" />
			<pathelement location="docroot/WEB-INF/classes" />
		</path>

		<if>
			<os family="windows" />
			<then>
				<classpath-to-jar
					classpathref="wsdd.classpath"
					jarfile="build-wsdd-classpath.jar"
				/>
			</then>
		</if>

		<java
			classname="com.liferay.portal.tools.WSDDBuilder"
			classpathref="wsdd.classpath"
			fork="true"
			maxmemory="256m"
			newenvironment="true"
			outputproperty="build-wsdd.output"
		>
			<jvmarg value="-Dexternal-properties=com/liferay/portal/tools/dependencies/portal-tools.properties" />
			<jvmarg value="-Dorg.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger" />
			<arg value="wsdd.input.file=docroot/WEB-INF/service.xml" />
			<arg value="wsdd.server.config.file=docroot/WEB-INF/server-config.wsdd" />
			<arg value="wsdd.service.namespace=Plugin" />
			<arg value="wsdd.output.path=docroot/WEB-INF/src/" />
		</java>

		<if>
			<os family="windows" />
			<then>
				<delete file="build-wsdd-classpath.jar" />
			</then>
		</if>

		<echo>${build-wsdd.output}</echo>

		<if>
			<contains string="${build-wsdd.output}" substring="IOException" />
			<then>
				<fail>WSDD Builder generated exceptions.</fail>
			</then>
		</if>
	</target>

	<target name="build-wsdl">
		<for param="wsdl.full.path">
			<path>
				<fileset dir="." includes="docroot/WEB-INF/wsdl/*.wsdl" />
			</path>
			<sequential>
				<tstamp>
					<format property="tstamp.value" pattern="yyyyMMddkkmmssSSS" />
				</tstamp>

				<mkdir dir="${tstamp.value}" />

				<taskdef classpathref="portal.classpath" resource="axis-tasks.properties" />

				<axis-wsdl2java
					output="${tstamp.value}"
					url="@{wsdl.full.path}"
				/>

				<compile-java
					javac.classpathref="plugin.classpath"
					javac.destdir="${tstamp.value}"
					javac.srcdir="${tstamp.value}"
				/>

				<antelope:stringutil string="@{wsdl.full.path}" property="wsdl.name.beginindex">
					<antelope:lastindexof string="${file.separator}" />
				</antelope:stringutil>

				<antelope:math
					datatype="int"
					operand1="${wsdl.name.beginindex}"
					operand2="1"
					operation="+"
					result="wsdl.name.beginindex"
				/>

				<antelope:stringutil string="@{wsdl.full.path}" property="wsdl.file">
					<antelope:substring beginindex="${wsdl.name.beginindex}" />
				</antelope:stringutil>

				<antelope:stringutil string="@{wsdl.full.path}" property="wsdl.name.endindex">
					<antelope:lastindexof string="." />
				</antelope:stringutil>

				<antelope:stringutil string="@{wsdl.full.path}" property="wsdl.name">
					<antelope:substring beginindex="${wsdl.name.beginindex}" endindex="${wsdl.name.endindex}" />
				</antelope:stringutil>

				<jar
					basedir="${tstamp.value}"
					jarfile="docroot/WEB-INF/lib/${wsdl.name}-ws.jar"
				/>

				<delete dir="${tstamp.value}" />
			</sequential>
		</for>
	</target>

	<target name="build-xsd">
		<tstamp>
			<format property="tstamp.value" pattern="yyyyMMddkkmmssSSS" />
		</tstamp>

		<mkdir dir="${tstamp.value}" />

		<path id="plugin-lib.classpath">
			<fileset dir="${app.server.lib.portal.dir}" includes="xbean.jar" />
			<fileset dir="docroot/WEB-INF/lib" includes="*.jar" />
			<pathelement location="docroot/WEB-INF/classes" />
		</path>

		<taskdef classname="org.apache.xmlbeans.impl.tool.XMLBean" classpathref="portal.classpath" name="xmlbean" />

		<xmlbean
			classgendir="${tstamp.value}"
			classpathref="plugin-lib.classpath"
			srcgendir="${tstamp.value}"
		>
			<fileset dir="docroot/WEB-INF/xsd" includes="**/*.*" />
		</xmlbean>

		<zip
			basedir="${tstamp.value}"
			destfile="docroot/WEB-INF/lib/${plugin.name}-xbean.jar"
		/>

		<delete dir="${tstamp.value}" />
	</target>

	<target name="compile-import-shared">
		<compile-import-shared
			module.dir="${basedir}"
		/>
	</target>

	<target name="compile-jsp">
		<antcall target="compile" />

		<if>
			<not>
				<equals arg1="${app.server.type}" arg2="tomcat" />
			</not>
			<then>
				<fail>Compiling JSPs with ${app.server.type} is not supported.</fail>
			</then>
		</if>

		<property name="jspc.classes.dir" value="classes/${app.server.type}" />

		<if>
			<and>
				<equals arg1="${app.server.type}" arg2="tomcat" />
				<equals arg1="${ant.java.version}" arg2="1.5" />
			</and>
			<then>
				<var name="jspc.java.home" value="${jdk.windows.home}" />
			</then>
			<else>
				<var name="jspc.java.home" value="${env.JAVA_HOME}" />
			</else>
		</if>

		<path id="jspc.classpath">
			<pathelement location="${jspc.java.home}/jre/lib/rt.jar" />
			<fileset dir="${app.server.lib.global.dir}" includes="*.jar" />
			<pathelement location="${app.server.lib.portal.dir}/ant.jar" />
			<pathelement location="docroot/WEB-INF/classes" />
			<fileset dir="docroot/WEB-INF/lib" includes="*.jar" />
			<pathelement location="${app.server.dir}/bin/tomcat-juli.jar" />
			<pathelement location="${app.server.dir}/lib/el-api.jar" />
			<pathelement location="${app.server.dir}/lib/jasper.jar" />
			<pathelement location="${app.server.dir}/lib/jasper-el.jar" />
			<pathelement location="${app.server.dir}/lib/jasper-jdt.jar" />
			<pathelement location="${app.server.dir}/lib/jsp-api.jar" />
			<pathelement location="${app.server.dir}/lib/servlet-api.jar" />
			<pathelement location="${app.server.dir}/lib/tomcat-api.jar" />
			<pathelement location="${app.server.dir}/lib/tomcat-util.jar" />
		</path>

		<delete dir="${jspc.classes.dir}" quiet="true" />

		<java
			classname="org.apache.jasper.JspC"
			classpathref="jspc.classpath"
			fork="true"
			jvm="${jspc.java.home}/bin/java"
			newenvironment="true"
			outputproperty="jspc.output"
		>
			<arg line="-d ${jspc.classes.dir} -webapp docroot" />
		</java>

		<echo>${jspc.output}</echo>

		<if>
			<contains string="${jspc.output}" substring="JasperException" />
			<then>
				<delete dir="${jspc.classes.dir}" quiet="true" />

				<fail>JSPs failed to compile.</fail>
			</then>
		</if>

		<javac
			classpathref="jspc.classpath"
			compiler="${javac.compiler}"
			deprecation="${javac.deprecation}"
			destdir="${jspc.classes.dir}"
			encoding="${javac.encoding}"
			errorProperty="jspc.javac.fail"
			failonerror="false"
			includeAntRuntime="false"
			nowarn="on"
			srcdir="${jspc.classes.dir}"
		/>

		<delete dir="${jspc.classes.dir}" quiet="true" />

		<if>
			<istrue value="${jspc.javac.fail}"/>
			<then>
				<fail>JSPs failed to compile.</fail>
			</then>
		</if>
	</target>

	<target name="compile-test">
		<compile-test
			module.dir="${basedir}"
		/>
	</target>

	<target name="compile-test-integration">
		<compile-test-integration
			module.dir="${basedir}"
		/>
	</target>

	<target name="compile-test-unit">
		<compile-test-unit
			module.dir="${basedir}"
		/>
	</target>

	<target name="format-wsdl">
		<for param="wsdl.full.path">
			<path>
				<fileset
					dir="."
					includes="docroot/WEB-INF/wsdl/*.wsdl,docroot/WEB-INF/wsdl/**/*.wsdl"
				/>
			</path>
			<sequential>
				<java
					classname="com.liferay.portal.tools.XMLFormatter"
					classpathref="portal.classpath"
					fork="true"
					newenvironment="true"
				>
					<jvmarg value="-Dexternal-properties=com/liferay/portal/tools/dependencies/portal-tools.properties" />
					<jvmarg value="-Dxml.formatter.file=@{wsdl.full.path}" />
					<jvmarg value="-Dxml.formatter.strip.comments=true" />
				</java>
			</sequential>
		</for>
	</target>

	<target name="format-xsd">
		<for param="xsd.full.path">
			<path>
				<fileset
					dir="."
					includes="docroot/WEB-INF/xsd/*.xsd,docroot/WEB-INF/xsd/**/*.xsd"
				/>
			</path>
			<sequential>
				<java
					classname="com.liferay.portal.tools.XMLFormatter"
					classpathref="portal.classpath"
					fork="true"
					newenvironment="true"
				>
					<jvmarg value="-Dexternal-properties=com/liferay/portal/tools/dependencies/portal-tools.properties" />
					<jvmarg value="-Dxml.formatter.file=@{xsd.full.path}" />
					<jvmarg value="-Dxml.formatter.strip.comments=true" />
				</java>
			</sequential>
		</for>
	</target>

	<target name="jar-javadoc" depends="javadoc">
		<jar-javadoc
			module.dir="${basedir}"
		/>
	</target>

	<target name="jar-source">
		<jar-source
			module.dir="${basedir}"
		/>
	</target>

	<target name="javadoc">
		<javadoc-macro
			module.dir="${basedir}"
		/>
	</target>

	<target name="merge">
		<merge
			module.dir="${basedir}"
		/>
	</target>

	<target name="merge-unzip">
		<merge-unzip
			module.dir="${basedir}"
		/>
	</target>

	<target name="patch">
		<var name="patched.file.available" value="false" />

		<for param="patched.file">
			<path>
				<fileset
					dir="${plugin.source.dir}"
					includes="${patch.destination}"
				/>
			</path>
			<sequential>
				<var name="patched.file.available" value="true" />
			</sequential>
		</for>

		<if>
			<equals arg1="${patched.file.available}" arg2="false" />
			<then>
				<get
					dest="${patch.original.lib.name}-sources.jar"
					src="${patch.original.lib.url}/${patch.original.lib.name}/${patch.original.lib.version}/${patch.original.lib.name}-${patch.original.lib.version}-sources.jar"
				/>

				<unjar
					dest="${plugin.source.dir}"
					src="${patch.original.lib.name}-sources.jar"
				>
					<mapper
						type="glob"
						from="src/java/*"
						to="*"
					/>
					<patternset includes="${patch.destination}" />
				</unjar>

				<delete file="${patch.original.lib.name}-sources.jar" />

				<if>
					<available file="${patch.source}" type="dir" />
					<then>
						<pathconvert property="patch.files">
							<path>
								<fileset dir="${patch.source}" />
							</path>
						</pathconvert>
					</then>
					<else>
						<pathconvert property="patch.files">
							<path>
								<fileset file="${patch.source}" />
							</path>
						</pathconvert>
					</else>
				</if>

				<for delimiter=":" list="${patch.files}" param="patch.file">
					<sequential>
						<echo>Applying patch @{patch.file}.</echo>

						<patch dir="${plugin.source.dir}" patchfile="@{patch.file}" strip="1" />
					</sequential>
				</for>
			</then>
		</if>

		<var name="patched.file.available" unset="true" />
	</target>

	<target name="publish-local-m2-release" depends="jar-javadoc,jar-source,war">
		<antcall target="build-common-ivy.publish">
			<param name="ivy.publish.resolver" value="local-m2" />
		</antcall>
	</target>

	<target name="publish-local-m2-snapshot" depends="jar-javadoc,jar-source,war">
		<antcall target="build-common-ivy.publish">
			<param name="ivy.publish.resolver" value="local-m2" />
			<param name="plugin.release.qualifier" value="-SNAPSHOT" />
		</antcall>
	</target>

	<target name="publish-remote-m2-release" depends="jar-javadoc,jar-source,war">
		<antcall target="build-common-ivy.publish">
			<param name="ivy.publish.resolver" value="sonatype-m2-release" />
		</antcall>
	</target>

	<target name="publish-remote-m2-snapshot" depends="jar-javadoc,jar-source,war">
		<antcall target="build-common-ivy.publish">
			<param name="ivy.publish.resolver" value="sonatype-m2-snapshot" />
			<param name="plugin.release.qualifier" value="-SNAPSHOT" />
		</antcall>
	</target>

	<target name="shrink-zip-cmd">
		<tstamp>
			<format property="tstamp.value" pattern="yyyyMMddkkmmssSSS" />
		</tstamp>

		<unzip
			dest="${tstamp.value}"
			src="${zip.file.name}"
		>
			<patternset
				excludes="${zip.excludes}"
				includes="${zip.includes}"
			/>
		</unzip>

		<zip
			basedir="${tstamp.value}"
			destfile="${zip.file.name}"
		/>

		<delete dir="${tstamp.value}" />
	</target>

	<target name="test-class">
		<test-class
			module.dir="${basedir}"
			test.class="${test.class}"
		/>
	</target>
</project>